PH eReferral Implementation Guide
0.1.0 - ci-build
PH eReferral Implementation Guide
0.1.0 - ci-build
PH eReferral Implementation Guide, published by SILab CoP IG Accelerator (eReferral). This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/jldalisay95/ph-ereferral-jld/ and changes regularly. See the Directory of published versions
| Official URL: urn://example.com/ph-ereferral/fhir/StructureDefinition/ereferral-provenance | Version: 0.1.0 | ||||
| Draft as of 2026-04-29 | Computable Name: ERefProvenance | ||||
Profile for tracking audit trail of eReferral actions including signatures and timestamps in the Philippine eReferral context.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Provenance |
0..* | PHCoreProvenance | Who, What, When for a set of resources | |||||||||||||
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
  target |
SΣ | 1..* | Reference(EReferral ServiceRequest) | The Resource(s) this Provenance record supports | ||||||||||||
  reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||||
| recorded |
SΣ | 1..1 | instant | Timestamp when the activity was recorded / updated | ||||||||||||
 reason |
SO | 0..* | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| activity |
SO | 0..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
 Slices for agent |
C | 1..* | BackboneElement | Actor(s) involved Slice: Unordered, Open by value:type Constraints: provenance-1 | ||||||||||||
  agent:All Slices |
Content/Rules for all slices | |||||||||||||||
  modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
| type |
SΣ | 0..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation (author, transmitter, etc.) | ||||||||||||
| role |
SO | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| who |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | ||||||||||||
 onBehalfOf |
S | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | ||||||||||||
 agent:ProvenanceAuthor |
S | 0..* | BackboneElement | Author organization or individual responsible for the information | ||||||||||||
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
 type |
SΣ | 1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation (author, transmitter, etc.) Required Pattern: At least the following | ||||||||||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
 coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type | |||||||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: author | |||||||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||||
| role |
S | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| who |
SΣ | 1..1 | Reference(PH Core Practitioner | PH Core PractitionerRole | PH Core Organization | PH Core Patient | PH Core RelatedPerson | Device) | Who participated | ||||||||||||
 onBehalfOf |
S | 0..1 | Reference(PH Core Organization) | Who the agent is representing | ||||||||||||
 agent:ProvenanceTransmitter |
S | 0..* | BackboneElement | Transmitter that provided the information | ||||||||||||
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
| type |
SΣ | 1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation (author, transmitter, etc.) Required Pattern: At least the following | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type | |||||||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: transmitter | |||||||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||||
| role |
S | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| who |
SΣ | 1..1 | Reference(PH Core Practitioner | PH Core PractitionerRole | PH Core Organization | PH Core Patient | PH Core RelatedPerson | Device) | Who participated | ||||||||||||
| onBehalfOf |
S | 0..1 | Reference(PH Core Organization) | Who the agent is representing | ||||||||||||
 signature |
S | 0..* | Signature | Signature on target | ||||||||||||
| type |
Σ | 1..* | Coding | Indication of the reason the entity signed the object(s) Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object. | ||||||||||||
| when |
Σ | 1..1 | instant | When the signature was created | ||||||||||||
| who |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who signed | ||||||||||||
| data |
1..1 | base64Binary | The actual signature content (XML DigSig. JWS, picture, etc.) | |||||||||||||
| Documentation for this format | ||||||||||||||||
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| Provenance |
|||
| reason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| activity |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Slices for agent |
|||
| agent:All Slices |
|||
| role |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| agent:ProvenanceAuthor |
|||
 role |
|||
| coding |
|
|
|
| text |
|
|
|
| agent:ProvenanceTransmitter |
|||
| role |
|||
| coding |
|
|
|
| text |
|
|
|
| Documentation for this format | |||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.reason | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.1 |
| 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 | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.agent:ProvenanceAuthor.type | Base | extensible | Provenance participant type | 📦4.0.1 | FHIR Std. |
| Provenance.agent:ProvenanceAuthor.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.agent:ProvenanceTransmitter.type | Base | extensible | Provenance participant type | 📦4.0.1 | FHIR Std. |
| Provenance.agent:ProvenanceTransmitter.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.signature.type | Base | preferred | Signature Type Codes | 📍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()
|
| provenance-1 | error | Provenance.agent | onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device |
who.exists((resolve() is Practitioner) or (resolve() is Device)) implies onBehalfOf.exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Provenance |
0..* | PHCoreProvenance | Who, What, When for a set of resources | |
| target |
1..* | Reference(EReferral ServiceRequest) | The Resource(s) this Provenance record supports | |
| signature |
S | 0..* | Signature | Signature on target |
| data |
1..1 | base64Binary | The actual signature content (XML DigSig. JWS, picture, etc.) | |
| Documentation for this format | ||||
| Name |
|---|
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Provenance |
0..* | PHCoreProvenance | Who, What, When for a set of resources | |||||||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||
| text |
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 | |||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
| target |
SΣ | 1..* | Reference(EReferral ServiceRequest) | The Resource(s) this Provenance record supports | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||||||||||
 occurred[x] |
0..1 | When the activity occurred | ||||||||||||||
| occurredPeriod |
Period | |||||||||||||||
| occurredDateTime |
dateTime | |||||||||||||||
| recorded |
SΣ | 1..1 | instant | Timestamp when the activity was recorded / updated | ||||||||||||
| policy |
0..* | uri | Policy or plan the activity was defined by | |||||||||||||
| location |
0..1 | Reference(PH Core Location) | Where the activity occurred, if relevant | |||||||||||||
| reason |
SO | 0..* | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| activity |
SO | 0..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| Slices for agent |
C | 1..* | BackboneElement | Actor(s) involved Slice: Unordered, Open by value:type Constraints: provenance-1 | ||||||||||||
| agent:All Slices |
Content/Rules for all slices | |||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
| type |
SΣ | 0..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation (author, transmitter, etc.) | ||||||||||||
| role |
SO | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| who |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | ||||||||||||
| onBehalfOf |
S | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | ||||||||||||
| agent:ProvenanceAuthor |
S | 0..* | BackboneElement | Author organization or individual responsible for the information | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
| type |
SΣ | 1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation (author, transmitter, etc.) Required Pattern: At least the following | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type | |||||||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: author | |||||||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||||
| role |
S | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| who |
SΣ | 1..1 | Reference(PH Core Practitioner | PH Core PractitionerRole | PH Core Organization | PH Core Patient | PH Core RelatedPerson | Device) | Who participated | ||||||||||||
| onBehalfOf |
S | 0..1 | Reference(PH Core Organization) | Who the agent is representing | ||||||||||||
| agent:ProvenanceTransmitter |
S | 0..* | BackboneElement | Transmitter that provided the information | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
| type |
SΣ | 1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation (author, transmitter, etc.) Required Pattern: At least the following | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type | |||||||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: transmitter | |||||||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||||
| role |
S | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| who |
SΣ | 1..1 | Reference(PH Core Practitioner | PH Core PractitionerRole | PH Core Organization | PH Core Patient | PH Core RelatedPerson | Device) | Who participated | ||||||||||||
| onBehalfOf |
S | 0..1 | Reference(PH Core Organization) | Who the agent is representing | ||||||||||||
| entity |
0..* | BackboneElement | An entity used in this activity | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
| role |
Σ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. | ||||||||||||
| what |
Σ | 1..1 | Reference(Resource) | Identity of entity | ||||||||||||
| agent |
0..* | See agent (Provenance) | Entity is attributed to this agent | |||||||||||||
| signature |
S | 0..* | Signature | Signature on target | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| type |
Σ | 1..* | Coding | Indication of the reason the entity signed the object(s) Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object. | ||||||||||||
| when |
Σ | 1..1 | instant | When the signature was created | ||||||||||||
| who |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who signed | ||||||||||||
| onBehalfOf |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | The party represented | ||||||||||||
| targetFormat |
0..1 | code | The technical format of the signed resources Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | |||||||||||||
| sigFormat |
0..1 | code | The technical format of the signature Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | |||||||||||||
| data |
1..1 | base64Binary | The actual signature content (XML DigSig. JWS, picture, etc.) | |||||||||||||
| Documentation for this format | ||||||||||||||||
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| Provenance |
|||
| reason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| activity |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Slices for agent |
|||
| agent:All Slices |
|||
| role |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| agent:ProvenanceAuthor |
|||
| role |
|||
| coding |
|
|
|
| text |
|
|
|
| agent:ProvenanceTransmitter |
|||
| role |
|||
| coding |
|
|
|
| text |
|
|
|
| Documentation for this format | |||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Provenance.target.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Provenance.reason | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.1 |
| 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 | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.agent:ProvenanceAuthor.type | Base | extensible | Provenance participant type | 📦4.0.1 | FHIR Std. |
| Provenance.agent:ProvenanceAuthor.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.agent:ProvenanceTransmitter.type | Base | extensible | Provenance participant type | 📦4.0.1 | FHIR Std. |
| Provenance.agent:ProvenanceTransmitter.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. |
| Provenance.signature.type | Base | preferred | Signature Type Codes | 📍4.0.1 | FHIR Std. |
| Provenance.signature.targetFormat | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Provenance.signature.sigFormat | Base | required | MimeType | 📍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()
|
| provenance-1 | error | Provenance.agent | onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device |
who.exists((resolve() is Practitioner) or (resolve() is Device)) implies onBehalfOf.exists()
|
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| Provenance |
|||
| reason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| activity |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Slices for agent |
|||
| agent:All Slices |
|||
| role |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| agent:ProvenanceAuthor |
|||
| role |
|||
| coding |
|
|
|
| text |
|
|
|
| agent:ProvenanceTransmitter |
|||
| role |
|||
| coding |
|
|
|
| text |
|
|
|
| Documentation for this format | |||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Provenance |
0..* | PHCoreProvenance | Who, What, When for a set of resources | |||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
| target |
SΣ | 1..* | Reference(EReferral ServiceRequest) | The Resource(s) this Provenance record supports | ||||||||||||
| reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||||
| recorded |
SΣ | 1..1 | instant | Timestamp when the activity was recorded / updated | ||||||||||||
| reason |
SO | 0..* | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| activity |
SO | 0..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| Slices for agent |
C | 1..* | BackboneElement | Actor(s) involved Slice: Unordered, Open by value:type Constraints: provenance-1 | ||||||||||||
| agent:All Slices |
Content/Rules for all slices | |||||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
| type |
SΣ | 0..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation (author, transmitter, etc.) | ||||||||||||
| role |
SO | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| who |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | ||||||||||||
| onBehalfOf |
S | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | ||||||||||||
| agent:ProvenanceAuthor |
S | 0..* | BackboneElement | Author organization or individual responsible for the information | ||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
| type |
SΣ | 1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation (author, transmitter, etc.) Required Pattern: At least the following | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type | |||||||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: author | |||||||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||||
| role |
S | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| who |
SΣ | 1..1 | Reference(PH Core Practitioner | PH Core PractitionerRole | PH Core Organization | PH Core Patient | PH Core RelatedPerson | Device) | Who participated | ||||||||||||
| onBehalfOf |
S | 0..1 | Reference(PH Core Organization) | Who the agent is representing | ||||||||||||
| agent:ProvenanceTransmitter |
S | 0..* | BackboneElement | Transmitter that provided the information | ||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
| type |
SΣ | 1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation (author, transmitter, etc.) Required Pattern: At least the following | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type | |||||||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: transmitter | |||||||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||||
| role |
S | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| who |
SΣ | 1..1 | Reference(PH Core Practitioner | PH Core PractitionerRole | PH Core Organization | PH Core Patient | PH Core RelatedPerson | Device) | Who participated | ||||||||||||
| onBehalfOf |
S | 0..1 | Reference(PH Core Organization) | Who the agent is representing | ||||||||||||
| signature |
S | 0..* | Signature | Signature on target | ||||||||||||
| type |
Σ | 1..* | Coding | Indication of the reason the entity signed the object(s) Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object. | ||||||||||||
| when |
Σ | 1..1 | instant | When the signature was created | ||||||||||||
| who |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who signed | ||||||||||||
| data |
1..1 | base64Binary | The actual signature content (XML DigSig. JWS, picture, etc.) | |||||||||||||
| Documentation for this format | ||||||||||||||||
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| Provenance |
|||
| reason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| activity |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Slices for agent |
|||
| agent:All Slices |
|||
| role |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| agent:ProvenanceAuthor |
|||
| role |
|||
| coding |
|
|
|
| text |
|
|
|
| agent:ProvenanceTransmitter |
|||
| role |
|||
| coding |
|
|
|
| text |
|
|
|
| Documentation for this format | |||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.reason | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.1 |
| 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 | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.agent:ProvenanceAuthor.type | Base | extensible | Provenance participant type | 📦4.0.1 | FHIR Std. |
| Provenance.agent:ProvenanceAuthor.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.agent:ProvenanceTransmitter.type | Base | extensible | Provenance participant type | 📦4.0.1 | FHIR Std. |
| Provenance.agent:ProvenanceTransmitter.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.signature.type | Base | preferred | Signature Type Codes | 📍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()
|
| provenance-1 | error | Provenance.agent | onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device |
who.exists((resolve() is Practitioner) or (resolve() is Device)) implies onBehalfOf.exists()
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Provenance |
0..* | PHCoreProvenance | Who, What, When for a set of resources | |
| target |
1..* | Reference(EReferral ServiceRequest) | The Resource(s) this Provenance record supports | |
| signature |
S | 0..* | Signature | Signature on target |
| data |
1..1 | base64Binary | The actual signature content (XML DigSig. JWS, picture, etc.) | |
| Documentation for this format | ||||
| Name |
|---|
| Documentation for this format |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Provenance |
0..* | PHCoreProvenance | Who, What, When for a set of resources | |||||||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||
| text |
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 | |||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
| target |
SΣ | 1..* | Reference(EReferral ServiceRequest) | The Resource(s) this Provenance record supports | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||||||||||
| occurred[x] |
0..1 | When the activity occurred | ||||||||||||||
| occurredPeriod |
Period | |||||||||||||||
| occurredDateTime |
dateTime | |||||||||||||||
| recorded |
SΣ | 1..1 | instant | Timestamp when the activity was recorded / updated | ||||||||||||
| policy |
0..* | uri | Policy or plan the activity was defined by | |||||||||||||
| location |
0..1 | Reference(PH Core Location) | Where the activity occurred, if relevant | |||||||||||||
| reason |
SO | 0..* | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| activity |
SO | 0..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| Slices for agent |
C | 1..* | BackboneElement | Actor(s) involved Slice: Unordered, Open by value:type Constraints: provenance-1 | ||||||||||||
| agent:All Slices |
Content/Rules for all slices | |||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
| type |
SΣ | 0..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation (author, transmitter, etc.) | ||||||||||||
| role |
SO | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| who |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | ||||||||||||
| onBehalfOf |
S | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | ||||||||||||
| agent:ProvenanceAuthor |
S | 0..* | BackboneElement | Author organization or individual responsible for the information | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
| type |
SΣ | 1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation (author, transmitter, etc.) Required Pattern: At least the following | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type | |||||||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: author | |||||||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||||
| role |
S | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| who |
SΣ | 1..1 | Reference(PH Core Practitioner | PH Core PractitionerRole | PH Core Organization | PH Core Patient | PH Core RelatedPerson | Device) | Who participated | ||||||||||||
| onBehalfOf |
S | 0..1 | Reference(PH Core Organization) | Who the agent is representing | ||||||||||||
| agent:ProvenanceTransmitter |
S | 0..* | BackboneElement | Transmitter that provided the information | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
| type |
SΣ | 1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation (author, transmitter, etc.) Required Pattern: At least the following | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type | |||||||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: transmitter | |||||||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||||
| role |
S | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| who |
SΣ | 1..1 | Reference(PH Core Practitioner | PH Core PractitionerRole | PH Core Organization | PH Core Patient | PH Core RelatedPerson | Device) | Who participated | ||||||||||||
| onBehalfOf |
S | 0..1 | Reference(PH Core Organization) | Who the agent is representing | ||||||||||||
| entity |
0..* | BackboneElement | An entity used in this activity | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
| role |
Σ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. | ||||||||||||
| what |
Σ | 1..1 | Reference(Resource) | Identity of entity | ||||||||||||
| agent |
0..* | See agent (Provenance) | Entity is attributed to this agent | |||||||||||||
| signature |
S | 0..* | Signature | Signature on target | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| type |
Σ | 1..* | Coding | Indication of the reason the entity signed the object(s) Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object. | ||||||||||||
| when |
Σ | 1..1 | instant | When the signature was created | ||||||||||||
| who |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who signed | ||||||||||||
| onBehalfOf |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | The party represented | ||||||||||||
| targetFormat |
0..1 | code | The technical format of the signed resources Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | |||||||||||||
| sigFormat |
0..1 | code | The technical format of the signature Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | |||||||||||||
| data |
1..1 | base64Binary | The actual signature content (XML DigSig. JWS, picture, etc.) | |||||||||||||
| Documentation for this format | ||||||||||||||||
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| Provenance |
|||
| reason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| activity |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Slices for agent |
|||
| agent:All Slices |
|||
| role |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| agent:ProvenanceAuthor |
|||
| role |
|||
| coding |
|
|
|
| text |
|
|
|
| agent:ProvenanceTransmitter |
|||
| role |
|||
| coding |
|
|
|
| text |
|
|
|
| Documentation for this format | |||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Provenance.target.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Provenance.reason | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.1 |
| 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 | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.agent:ProvenanceAuthor.type | Base | extensible | Provenance participant type | 📦4.0.1 | FHIR Std. |
| Provenance.agent:ProvenanceAuthor.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.agent:ProvenanceTransmitter.type | Base | extensible | Provenance participant type | 📦4.0.1 | FHIR Std. |
| Provenance.agent:ProvenanceTransmitter.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std. |
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. |
| Provenance.signature.type | Base | preferred | Signature Type Codes | 📍4.0.1 | FHIR Std. |
| Provenance.signature.targetFormat | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Provenance.signature.sigFormat | Base | required | MimeType | 📍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()
|
| provenance-1 | error | Provenance.agent | onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device |
who.exists((resolve() is Practitioner) or (resolve() is Device)) implies onBehalfOf.exists()
|
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| Provenance |
|||
| reason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| activity |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Slices for agent |
|||
| agent:All Slices |
|||
| role |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| agent:ProvenanceAuthor |
|||
| role |
|||
| coding |
|
|
|
| text |
|
|
|
| agent:ProvenanceTransmitter |
|||
| role |
|||
| coding |
|
|
|
| text |
|
|
|
| Documentation for this format | |||
Other representations of profile: CSV, Excel, Schematron
