Kenya Core Implementation Guide
1.0.0 - release
Kenya Core Implementation Guide, published by Digital Health Agency (DHA), Kenya. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IntelliSOFT-Consulting/Kenya-core-FHIR-IG/ and changes regularly. See the Directory of published versions
| Official URL: https://fhir.dha.go.ke/ig/core/StructureDefinition/kenya-core-provenance | Version: 1.0.0 | |||
| Active as of 2026-08-11 | Computable Name: KenyaCoreProvenance | |||
Kenya Core profile for Provenance, used to track the origin, authorship, and handling of clinical and administrative resources exchanged within Kenya FHIR implementation guides.
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 | id | Logical id of this artifact |
![]() ![]() |
SΣ | 1..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://fhir.dha.go.ke/ig/core/StructureDefinition/kenya-core-provenance|1.0.0 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..* | Reference(Resource) | Resource(s) this provenance record describes |
![]() ![]() |
S | 0..1 | When the activity occurred | |
![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
dateTime | |||
![]() ![]() |
SΣ | 1..1 | instant | When the activity was recorded / updated |
![]() ![]() |
S | 0..* | uri | Policy or plan the activity was defined by |
![]() ![]() |
S | 0..1 | Reference(Kenya Core Location Profile) | Where the activity occurred |
![]() ![]() |
S | 0..* | CodeableConcept | Reason the activity took place Binding: PurposeOfUse (extensible): The reason the activity took place. |
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept |
![]() ![]() |
S | 0..1 | CodeableConcept | Activity that occurred, e.g. create, update, verify Binding: ProvenanceActivityType (extensible) |
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept |
![]() ![]() |
S | 1..* | BackboneElement | Actor involved |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible) |
![]() ![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (extensible) |
![]() ![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(KenyaCore Practitioner Profile | KenyaCore PractitionerRole Profile | KenyaCore Organization Profile | KenyaCore Patient Profile | Kenya Core Device Profile) | Who the agent is |
![]() ![]() ![]() |
S | 0..1 | Reference(KenyaCore Organization Profile) | Organization the agent acted on behalf of |
![]() ![]() |
S | 0..* | BackboneElement | An entity used in 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) | Identity of the source entity |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.reason | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.3 |
| Provenance.activity | Base | extensible | Provenance activity type | 📦4.0.1 | FHIR Std. |
| Provenance.agent.type | Base | extensible | Provenance participant type | 📦4.0.1 | FHIR Std. |
| Provenance.agent.role | Base | extensible | 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Provenance | Who, What, When for a set of resources | |
![]() ![]() |
S | 1..1 | id | Logical id of this artifact |
![]() ![]() |
S | 1..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://fhir.dha.go.ke/ig/core/StructureDefinition/kenya-core-provenance|1.0.0 | |
![]() ![]() |
S | 1..* | Reference(Resource) | Resource(s) this provenance record describes |
![]() ![]() |
S | 0..1 | Period, dateTime | When the activity occurred |
![]() ![]() |
S | 1..1 | instant | When the activity was recorded / updated |
![]() ![]() |
S | 0..* | uri | Policy or plan the activity was defined by |
![]() ![]() |
S | 0..1 | Reference(Kenya Core Location Profile) | Where the activity occurred |
![]() ![]() |
S | 0..* | CodeableConcept | Reason the activity took place |
![]() ![]() ![]() |
S | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() |
S | 0..1 | string | Plain text representation of the concept |
![]() ![]() |
S | 0..1 | CodeableConcept | Activity that occurred, e.g. create, update, verify Binding: ProvenanceActivityType (extensible) |
![]() ![]() ![]() |
S | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() |
S | 0..1 | string | Plain text representation of the concept |
![]() ![]() |
S | 1..* | BackboneElement | Actor involved |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible) |
![]() ![]() ![]() ![]() |
S | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (extensible) |
![]() ![]() ![]() ![]() |
S | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
S | 1..1 | Reference(KenyaCore Practitioner Profile | KenyaCore PractitionerRole Profile | KenyaCore Organization Profile | KenyaCore Patient Profile | Kenya Core Device Profile) | Who the agent is |
![]() ![]() ![]() |
S | 0..1 | Reference(KenyaCore Organization Profile) | Organization the agent acted on behalf of |
![]() ![]() |
S | 0..* | BackboneElement | An entity used in this activity |
![]() ![]() ![]() |
S | 1..1 | code | derivation | revision | quotation | source | removal |
![]() ![]() ![]() |
S | 1..1 | Reference(Resource) | Identity of the source entity |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.activity | Base | extensible | Provenance activity type | 📦4.0.1 | FHIR Std. |
| Provenance.agent.type | Base | extensible | Provenance participant type | 📦4.0.1 | FHIR Std. |
| Provenance.agent.role | Base | extensible | SecurityRoleType | 📦4.0.1 | FHIR Std. |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Provenance | Who, What, When for a set of resources | |||||
![]() ![]() |
SΣ | 1..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 | ||||
![]() ![]() ![]() |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://fhir.dha.go.ke/ig/core/StructureDefinition/kenya-core-provenance|1.0.0 | ||||
![]() ![]() ![]() |
Σ | 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(Resource) | Resource(s) this provenance record describes | ||||
![]() ![]() |
S | 0..1 | When the activity occurred | |||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() |
SΣ | 1..1 | instant | When the activity was recorded / updated | ||||
![]() ![]() |
S | 0..* | uri | Policy or plan the activity was defined by | ||||
![]() ![]() |
S | 0..1 | Reference(Kenya Core Location Profile) | Where the activity occurred | ||||
![]() ![]() |
S | 0..* | CodeableConcept | Reason the activity took place Binding: PurposeOfUse (extensible): The reason the activity took place. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
S | 0..1 | CodeableConcept | Activity that occurred, e.g. create, update, verify Binding: ProvenanceActivityType (extensible) | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
S | 1..* | BackboneElement | Actor involved | ||||
![]() ![]() ![]() |
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 | How the agent participated Binding: ProvenanceParticipantType (extensible) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
S | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (extensible) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(KenyaCore Practitioner Profile | KenyaCore PractitionerRole Profile | KenyaCore Organization Profile | KenyaCore Patient Profile | Kenya Core Device Profile) | Who the agent is | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(KenyaCore Organization Profile) | Organization the agent acted on behalf of | ||||
![]() ![]() |
S | 0..* | BackboneElement | An entity used in 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) | Identity of the source entity | ||||
![]() ![]() ![]() |
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.3 |
| Provenance.activity | Base | extensible | Provenance activity type | 📦4.0.1 | FHIR Std. |
| Provenance.agent.type | Base | extensible | Provenance participant type | 📦4.0.1 | FHIR Std. |
| Provenance.agent.role | Base | extensible | 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
Summary
Mandatory: 3 elements(12 nested mandatory elements)
Must-Support: 37 elements
Structures
This structure refers to these other structures:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Provenance | Who, What, When for a set of resources | |
![]() ![]() |
SΣ | 1..1 | id | Logical id of this artifact |
![]() ![]() |
SΣ | 1..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://fhir.dha.go.ke/ig/core/StructureDefinition/kenya-core-provenance|1.0.0 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..* | Reference(Resource) | Resource(s) this provenance record describes |
![]() ![]() |
S | 0..1 | When the activity occurred | |
![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
dateTime | |||
![]() ![]() |
SΣ | 1..1 | instant | When the activity was recorded / updated |
![]() ![]() |
S | 0..* | uri | Policy or plan the activity was defined by |
![]() ![]() |
S | 0..1 | Reference(Kenya Core Location Profile) | Where the activity occurred |
![]() ![]() |
S | 0..* | CodeableConcept | Reason the activity took place Binding: PurposeOfUse (extensible): The reason the activity took place. |
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept |
![]() ![]() |
S | 0..1 | CodeableConcept | Activity that occurred, e.g. create, update, verify Binding: ProvenanceActivityType (extensible) |
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept |
![]() ![]() |
S | 1..* | BackboneElement | Actor involved |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible) |
![]() ![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (extensible) |
![]() ![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(KenyaCore Practitioner Profile | KenyaCore PractitionerRole Profile | KenyaCore Organization Profile | KenyaCore Patient Profile | Kenya Core Device Profile) | Who the agent is |
![]() ![]() ![]() |
S | 0..1 | Reference(KenyaCore Organization Profile) | Organization the agent acted on behalf of |
![]() ![]() |
S | 0..* | BackboneElement | An entity used in 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) | Identity of the source entity |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.reason | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.3 |
| Provenance.activity | Base | extensible | Provenance activity type | 📦4.0.1 | FHIR Std. |
| Provenance.agent.type | Base | extensible | Provenance participant type | 📦4.0.1 | FHIR Std. |
| Provenance.agent.role | Base | extensible | 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()
|
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 | id | Logical id of this artifact |
![]() ![]() |
S | 1..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://fhir.dha.go.ke/ig/core/StructureDefinition/kenya-core-provenance|1.0.0 | |
![]() ![]() |
S | 1..* | Reference(Resource) | Resource(s) this provenance record describes |
![]() ![]() |
S | 0..1 | Period, dateTime | When the activity occurred |
![]() ![]() |
S | 1..1 | instant | When the activity was recorded / updated |
![]() ![]() |
S | 0..* | uri | Policy or plan the activity was defined by |
![]() ![]() |
S | 0..1 | Reference(Kenya Core Location Profile) | Where the activity occurred |
![]() ![]() |
S | 0..* | CodeableConcept | Reason the activity took place |
![]() ![]() ![]() |
S | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() |
S | 0..1 | string | Plain text representation of the concept |
![]() ![]() |
S | 0..1 | CodeableConcept | Activity that occurred, e.g. create, update, verify Binding: ProvenanceActivityType (extensible) |
![]() ![]() ![]() |
S | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() |
S | 0..1 | string | Plain text representation of the concept |
![]() ![]() |
S | 1..* | BackboneElement | Actor involved |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible) |
![]() ![]() ![]() ![]() |
S | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (extensible) |
![]() ![]() ![]() ![]() |
S | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
S | 1..1 | Reference(KenyaCore Practitioner Profile | KenyaCore PractitionerRole Profile | KenyaCore Organization Profile | KenyaCore Patient Profile | Kenya Core Device Profile) | Who the agent is |
![]() ![]() ![]() |
S | 0..1 | Reference(KenyaCore Organization Profile) | Organization the agent acted on behalf of |
![]() ![]() |
S | 0..* | BackboneElement | An entity used in this activity |
![]() ![]() ![]() |
S | 1..1 | code | derivation | revision | quotation | source | removal |
![]() ![]() ![]() |
S | 1..1 | Reference(Resource) | Identity of the source entity |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.activity | Base | extensible | Provenance activity type | 📦4.0.1 | FHIR Std. |
| Provenance.agent.type | Base | extensible | Provenance participant type | 📦4.0.1 | FHIR Std. |
| Provenance.agent.role | Base | extensible | SecurityRoleType | 📦4.0.1 | FHIR Std. |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Provenance | Who, What, When for a set of resources | |||||
![]() ![]() |
SΣ | 1..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 | ||||
![]() ![]() ![]() |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://fhir.dha.go.ke/ig/core/StructureDefinition/kenya-core-provenance|1.0.0 | ||||
![]() ![]() ![]() |
Σ | 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(Resource) | Resource(s) this provenance record describes | ||||
![]() ![]() |
S | 0..1 | When the activity occurred | |||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() |
SΣ | 1..1 | instant | When the activity was recorded / updated | ||||
![]() ![]() |
S | 0..* | uri | Policy or plan the activity was defined by | ||||
![]() ![]() |
S | 0..1 | Reference(Kenya Core Location Profile) | Where the activity occurred | ||||
![]() ![]() |
S | 0..* | CodeableConcept | Reason the activity took place Binding: PurposeOfUse (extensible): The reason the activity took place. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
S | 0..1 | CodeableConcept | Activity that occurred, e.g. create, update, verify Binding: ProvenanceActivityType (extensible) | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
S | 1..* | BackboneElement | Actor involved | ||||
![]() ![]() ![]() |
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 | How the agent participated Binding: ProvenanceParticipantType (extensible) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
S | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (extensible) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(KenyaCore Practitioner Profile | KenyaCore PractitionerRole Profile | KenyaCore Organization Profile | KenyaCore Patient Profile | Kenya Core Device Profile) | Who the agent is | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(KenyaCore Organization Profile) | Organization the agent acted on behalf of | ||||
![]() ![]() |
S | 0..* | BackboneElement | An entity used in 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) | Identity of the source entity | ||||
![]() ![]() ![]() |
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.3 |
| Provenance.activity | Base | extensible | Provenance activity type | 📦4.0.1 | FHIR Std. |
| Provenance.agent.type | Base | extensible | Provenance participant type | 📦4.0.1 | FHIR Std. |
| Provenance.agent.role | Base | extensible | 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
Summary
Mandatory: 3 elements(12 nested mandatory elements)
Must-Support: 37 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron