Kenya ePrescription FHIR Implementation Guide
0.1.0 - ci-build
KE
Kenya ePrescription FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/ke-provenance | Version: 0.1.0 | |||
| Draft as of 2026-05-18 | Computable Name: KEProvenance | |||
Copyright/Legal: Copyright 2025+ Digital Health Agency, Kenya. This content is licensed under Creative Commons Attribution 4.0 International (CC-BY-4.0). Terminology content from the Kenya Pharmacy and Poisons Board (PPB) via Open Concept Lab (OCL) is subject to separate terms. |
||||
Profile on Provenance for the Kenya eRx Implementation Guide. Captures who created or modified a prescription, dispense, or administration record, when it occurred, and which system was involved.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Provenance | Who, What, When for a set of resources | |
![]() ![]() |
SΣ | 1..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
SΣ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to. |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..* | Reference(MedicationRequest | MedicationDispense | MedicationAdministration | MedicationStatement) | The prescription, dispense, or administration record this provenance describes |
![]() ![]() |
S | 0..1 | When the activity occurred (period or dateTime) | |
![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
dateTime | |||
![]() ![]() |
SΣ | 1..1 | instant | When this provenance record was created |
![]() ![]() |
S | 0..* | uri | Policy or rules that govern the activity |
![]() ![]() |
S | 0..1 | Reference(Location) | Where the activity was performed |
![]() ![]() |
S | 0..* | CodeableConcept | Reason the activity was performed (e.g. new prescription, amendment) Binding: PurposeOfUse (extensible): The reason the activity took place. |
![]() ![]() |
S | 1..1 | CodeableConcept | Type of data operation: CREATE, UPDATE, DELETE, READ, APPEND Binding: v3 Code System DataOperation (required) |
![]() ![]() |
S | 1..* | BackboneElement | At least one actor (prescriber, pharmacist, or system) must be identified |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Role of this agent (author, verifier, enterer) Binding: ProvenanceParticipantType (required) |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient) | Person or organisation responsible for the activity |
![]() ![]() ![]() |
S | 0..1 | Reference(Organization) | Organisation on whose behalf the agent acted |
![]() ![]() |
S | 0..* | BackboneElement | Previous version or source document for this activity |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SΣ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Resource) | Reference to the prior resource version or source |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.reason | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.1 |
| Provenance.activity | Base | required | v3 Code System DataOperation | 📦2018-08-12 | FHIR Std. |
| Provenance.agent.type | Base | required | Provenance participant type | 📦4.0.1 | FHIR Std. |
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Provenance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Provenance | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Provenance
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Provenance | Who, What, When for a set of resources | |
![]() ![]() |
S | 1..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
S | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to. |
![]() ![]() |
S | 1..* | Reference(MedicationRequest | MedicationDispense | MedicationAdministration | MedicationStatement) | The prescription, dispense, or administration record this provenance describes |
![]() ![]() |
S | 0..1 | Period, dateTime | When the activity occurred (period or dateTime) |
![]() ![]() |
S | 1..1 | instant | When this provenance record was created |
![]() ![]() |
S | 0..* | uri | Policy or rules that govern the activity |
![]() ![]() |
S | 0..1 | Reference(Location) | Where the activity was performed |
![]() ![]() |
S | 0..* | CodeableConcept | Reason the activity was performed (e.g. new prescription, amendment) |
![]() ![]() |
S | 1..1 | CodeableConcept | Type of data operation: CREATE, UPDATE, DELETE, READ, APPEND Binding: v3 Code System DataOperation (required) |
![]() ![]() |
S | 1..* | BackboneElement | At least one actor (prescriber, pharmacist, or system) must be identified |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Role of this agent (author, verifier, enterer) Binding: ProvenanceParticipantType (required) |
![]() ![]() ![]() |
S | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient) | Person or organisation responsible for the activity |
![]() ![]() ![]() |
S | 0..1 | Reference(Organization) | Organisation on whose behalf the agent acted |
![]() ![]() |
S | 0..* | BackboneElement | Previous version or source document for this activity |
![]() ![]() ![]() |
S | 1..1 | code | derivation | revision | quotation | source | removal |
![]() ![]() ![]() |
S | 1..1 | Reference(Resource) | Reference to the prior resource version or source |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.activity | Base | required | v3 Code System DataOperation | 📦2018-08-12 | FHIR Std. |
| Provenance.agent.type | Base | required | Provenance participant type | 📦4.0.1 | FHIR Std. |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Provenance | Who, What, When for a set of resources | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
SΣ | 1..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
SΣ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to. | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..* | Reference(MedicationRequest | MedicationDispense | MedicationAdministration | MedicationStatement) | The prescription, dispense, or administration record this provenance describes | ||||
![]() ![]() |
S | 0..1 | When the activity occurred (period or dateTime) | |||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() |
SΣ | 1..1 | instant | When this provenance record was created | ||||
![]() ![]() |
S | 0..* | uri | Policy or rules that govern the activity | ||||
![]() ![]() |
S | 0..1 | Reference(Location) | Where the activity was performed | ||||
![]() ![]() |
S | 0..* | CodeableConcept | Reason the activity was performed (e.g. new prescription, amendment) Binding: PurposeOfUse (extensible): The reason the activity took place. | ||||
![]() ![]() |
S | 1..1 | CodeableConcept | Type of data operation: CREATE, UPDATE, DELETE, READ, APPEND Binding: v3 Code System DataOperation (required) | ||||
![]() ![]() |
S | 1..* | BackboneElement | At least one actor (prescriber, pharmacist, or system) must be identified | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Role of this agent (author, verifier, enterer) Binding: ProvenanceParticipantType (required) | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient) | Person or organisation responsible for the activity | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(Organization) | Organisation on whose behalf the agent acted | ||||
![]() ![]() |
S | 0..* | BackboneElement | Previous version or source document for this activity | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
SΣ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Resource) | Reference to the prior resource version or source | ||||
![]() ![]() ![]() |
0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
![]() ![]() |
0..* | Signature | Signature on target | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Provenance.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Provenance.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Provenance.reason | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.1 |
| Provenance.activity | Base | required | v3 Code System DataOperation | 📦2018-08-12 | FHIR Std. |
| Provenance.agent.type | Base | required | Provenance participant type | 📦4.0.1 | FHIR Std. |
| Provenance.agent.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Provenance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Provenance | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Provenance
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Provenance | Who, What, When for a set of resources | |
![]() ![]() |
SΣ | 1..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
SΣ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to. |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..* | Reference(MedicationRequest | MedicationDispense | MedicationAdministration | MedicationStatement) | The prescription, dispense, or administration record this provenance describes |
![]() ![]() |
S | 0..1 | When the activity occurred (period or dateTime) | |
![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
dateTime | |||
![]() ![]() |
SΣ | 1..1 | instant | When this provenance record was created |
![]() ![]() |
S | 0..* | uri | Policy or rules that govern the activity |
![]() ![]() |
S | 0..1 | Reference(Location) | Where the activity was performed |
![]() ![]() |
S | 0..* | CodeableConcept | Reason the activity was performed (e.g. new prescription, amendment) Binding: PurposeOfUse (extensible): The reason the activity took place. |
![]() ![]() |
S | 1..1 | CodeableConcept | Type of data operation: CREATE, UPDATE, DELETE, READ, APPEND Binding: v3 Code System DataOperation (required) |
![]() ![]() |
S | 1..* | BackboneElement | At least one actor (prescriber, pharmacist, or system) must be identified |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Role of this agent (author, verifier, enterer) Binding: ProvenanceParticipantType (required) |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient) | Person or organisation responsible for the activity |
![]() ![]() ![]() |
S | 0..1 | Reference(Organization) | Organisation on whose behalf the agent acted |
![]() ![]() |
S | 0..* | BackboneElement | Previous version or source document for this activity |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SΣ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Resource) | Reference to the prior resource version or source |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.reason | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.1 |
| Provenance.activity | Base | required | v3 Code System DataOperation | 📦2018-08-12 | FHIR Std. |
| Provenance.agent.type | Base | required | Provenance participant type | 📦4.0.1 | FHIR Std. |
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Provenance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Provenance | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Provenance
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Provenance | Who, What, When for a set of resources | |
![]() ![]() |
S | 1..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
S | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to. |
![]() ![]() |
S | 1..* | Reference(MedicationRequest | MedicationDispense | MedicationAdministration | MedicationStatement) | The prescription, dispense, or administration record this provenance describes |
![]() ![]() |
S | 0..1 | Period, dateTime | When the activity occurred (period or dateTime) |
![]() ![]() |
S | 1..1 | instant | When this provenance record was created |
![]() ![]() |
S | 0..* | uri | Policy or rules that govern the activity |
![]() ![]() |
S | 0..1 | Reference(Location) | Where the activity was performed |
![]() ![]() |
S | 0..* | CodeableConcept | Reason the activity was performed (e.g. new prescription, amendment) |
![]() ![]() |
S | 1..1 | CodeableConcept | Type of data operation: CREATE, UPDATE, DELETE, READ, APPEND Binding: v3 Code System DataOperation (required) |
![]() ![]() |
S | 1..* | BackboneElement | At least one actor (prescriber, pharmacist, or system) must be identified |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Role of this agent (author, verifier, enterer) Binding: ProvenanceParticipantType (required) |
![]() ![]() ![]() |
S | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient) | Person or organisation responsible for the activity |
![]() ![]() ![]() |
S | 0..1 | Reference(Organization) | Organisation on whose behalf the agent acted |
![]() ![]() |
S | 0..* | BackboneElement | Previous version or source document for this activity |
![]() ![]() ![]() |
S | 1..1 | code | derivation | revision | quotation | source | removal |
![]() ![]() ![]() |
S | 1..1 | Reference(Resource) | Reference to the prior resource version or source |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.activity | Base | required | v3 Code System DataOperation | 📦2018-08-12 | FHIR Std. |
| Provenance.agent.type | Base | required | Provenance participant type | 📦4.0.1 | FHIR Std. |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Provenance | Who, What, When for a set of resources | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
SΣ | 1..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
SΣ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to. | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..* | Reference(MedicationRequest | MedicationDispense | MedicationAdministration | MedicationStatement) | The prescription, dispense, or administration record this provenance describes | ||||
![]() ![]() |
S | 0..1 | When the activity occurred (period or dateTime) | |||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() |
SΣ | 1..1 | instant | When this provenance record was created | ||||
![]() ![]() |
S | 0..* | uri | Policy or rules that govern the activity | ||||
![]() ![]() |
S | 0..1 | Reference(Location) | Where the activity was performed | ||||
![]() ![]() |
S | 0..* | CodeableConcept | Reason the activity was performed (e.g. new prescription, amendment) Binding: PurposeOfUse (extensible): The reason the activity took place. | ||||
![]() ![]() |
S | 1..1 | CodeableConcept | Type of data operation: CREATE, UPDATE, DELETE, READ, APPEND Binding: v3 Code System DataOperation (required) | ||||
![]() ![]() |
S | 1..* | BackboneElement | At least one actor (prescriber, pharmacist, or system) must be identified | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Role of this agent (author, verifier, enterer) Binding: ProvenanceParticipantType (required) | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient) | Person or organisation responsible for the activity | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(Organization) | Organisation on whose behalf the agent acted | ||||
![]() ![]() |
S | 0..* | BackboneElement | Previous version or source document for this activity | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
SΣ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Resource) | Reference to the prior resource version or source | ||||
![]() ![]() ![]() |
0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
![]() ![]() |
0..* | Signature | Signature on target | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Provenance.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Provenance.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Provenance.reason | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.1 |
| Provenance.activity | Base | required | v3 Code System DataOperation | 📦2018-08-12 | FHIR Std. |
| Provenance.agent.type | Base | required | Provenance participant type | 📦4.0.1 | FHIR Std. |
| Provenance.agent.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Provenance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Provenance | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Provenance
Other representations of profile: CSV, Excel, Schematron