haau3 FHIR Implementation Guide (HFIG)
1.0.0 - ci-build
haau3 FHIR Implementation Guide (HFIG)
1.0.0 - ci-build
haau3 FHIR Implementation Guide (HFIG) - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://haau3.com/fhir/StructureDefinition/haau3-reconciled-medication-additions-provenance | Version: 1.0.0 | |||
| Draft as of 2026-10-14 | Computable Name: Haau3ReconciledMedicationAdditionsProvenance | |||
What haau3 added to one reconciled medication entry: data no source record stated, such as the RxNorm clinical drug coding, or the RxNorm name used as the entry's text when no source named the medication in words. Each target is the entry, narrowed to one added element by the targetElement extension (the element's id) or the targetPath extension (a simple FHIRPath). haau3 is the author, the activity is append, and the rule-set version and RxNorm release are those the entry was reconciled against. Present only when haau3 added something to the entry.
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:  |
|---|---|---|---|---|
  Provenance |
0..* | USCoreProvenance(6.1.0) | US Core Provenance | |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
  Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   extension:rulesetVersion |
1..1 | string | MedList Rule-set Version URL: https://haau3.com/fhir/StructureDefinition/medlist-ruleset-version | |
 extension:rxnormRelease |
1..1 | string | MedList RxNorm Release URL: https://haau3.com/fhir/StructureDefinition/medlist-rxnorm-release | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 target |
1..* | Reference(haau3 Reconciled MedicationRequest) | (USCDI) The Resource this Provenance record supports | |
 Slices for extension |
Content/Rules for all slices | |||
| extension:targetElement |
0..1 | uri | The id of the element haau3 added, such as its RxNorm clinical drug coding URL: http://hl7.org/fhir/StructureDefinition/targetElement | |
| extension:targetPath |
0..1 | string | A simple FHIRPath to the element haau3 added, such as MedicationRequest.medicationCodeableConcept.text URL: http://hl7.org/fhir/StructureDefinition/targetPath | |
 reference |
C | 0..1 | string | (USCDI) Literal reference, Relative, internal or absolute URL |
| occurred[x] |
1..1 | dateTime | When the activity occurred | |
| recorded |
1..1 | instant | (USCDI) Timestamp when the activity was recorded / updated | |
 activity |
1..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place. 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/v3-DataOperation | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: APPEND | |
| 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 | |
 Slices for agent |
C | 1..* | BackboneElement | (USCDI) Actor involved Slice: Unordered, Open by pattern:type Constraints: provenance-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them |
   agent:All Slices |
Content/Rules for all slices | |||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| type |
0..1 | CodeableConcept | (USCDI) How the agent participated Binding: US Core Provenance Participant Type Codes (extensible) | |
| who |
1..1 | Reference(US Core Organization Profile | US Core Practitioner Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | Device) | (USCDI) Who participated | |
| onBehalfOf |
0..1 | Reference(US Core Organization Profile) | (USCDI) Who the agent is representing | |
| agent:ProvenanceAuthor |
1..1 | BackboneElement | (USCDI) Actor involved | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
 type |
1..1 | CodeableConcept | (USCDI) How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. 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 | |
| who |
1..1 | Reference(US Core Organization Profile(6.1.0)) | Who participated | |
 onBehalfOf |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |
 agent:ProvenanceTransmitter |
0..* | BackboneElement | (USCDI) Actor involved | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| type |
1..1 | CodeableConcept | (USCDI) How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. 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://hl7.org/fhir/us/core/CodeSystem/us-core-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 | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| onBehalfOf |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |
| 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 | US Core Provenance Participant Type Codes | 📦6.1.0 | US Core v6.1 |
| Provenance.agent:ProvenanceAuthor.type | Base | extensible | Provenance participant type | 📦4.0.1 | FHIR Std. |
| Provenance.agent:ProvenanceTransmitter.type | Base | extensible | Provenance participant type | 📦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()
|
This structure is derived from USCoreProvenance
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Provenance |
0..* | USCoreProvenance(6.1.0) | US Core Provenance | |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:rulesetVersion |
1..1 | string | MedList Rule-set Version URL: https://haau3.com/fhir/StructureDefinition/medlist-ruleset-version | |
| extension:rxnormRelease |
1..1 | string | MedList RxNorm Release URL: https://haau3.com/fhir/StructureDefinition/medlist-rxnorm-release | |
| target |
1..* | Reference(haau3 Reconciled MedicationRequest) | (USCDI) The Resource this Provenance record supports | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:targetElement |
0..1 | uri | The id of the element haau3 added, such as its RxNorm clinical drug coding URL: http://hl7.org/fhir/StructureDefinition/targetElement | |
| extension:targetPath |
0..1 | string | A simple FHIRPath to the element haau3 added, such as MedicationRequest.medicationCodeableConcept.text URL: http://hl7.org/fhir/StructureDefinition/targetPath | |
| occurred[x] |
1..1 | dateTime | When the activity occurred | |
| recorded |
1..1 | instant | (USCDI) Timestamp when the activity was recorded / updated | |
| activity |
1..1 | CodeableConcept | Activity that occurred Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-DataOperation | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: APPEND | |
| Slices for agent |
Content/Rules for all slices | |||
| agent:ProvenanceAuthor |
1..1 | BackboneElement | (USCDI) Actor involved | |
| who |
1..1 | Reference(US Core Organization Profile(6.1.0)) | Who participated | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Provenance |
0..* | USCoreProvenance(6.1.0) | US Core Provenance | |||||
| 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 | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:rulesetVersion |
1..1 | string | MedList Rule-set Version URL: https://haau3.com/fhir/StructureDefinition/medlist-ruleset-version | |||||
| extension:rxnormRelease |
1..1 | string | MedList RxNorm Release URL: https://haau3.com/fhir/StructureDefinition/medlist-rxnorm-release | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| target |
1..* | Reference(haau3 Reconciled MedicationRequest) | (USCDI) The Resource this Provenance record supports | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:targetElement |
0..1 | uri | The id of the element haau3 added, such as its RxNorm clinical drug coding URL: http://hl7.org/fhir/StructureDefinition/targetElement | |||||
| extension:targetPath |
0..1 | string | A simple FHIRPath to the element haau3 added, such as MedicationRequest.medicationCodeableConcept.text URL: http://hl7.org/fhir/StructureDefinition/targetPath | |||||
| reference |
C | 0..1 | string | (USCDI) 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] |
1..1 | dateTime | When the activity occurred | |||||
| recorded |
1..1 | instant | (USCDI) Timestamp when the activity was recorded / updated | |||||
| policy |
0..* | uri | Policy or plan the activity was defined by | |||||
| location |
0..1 | Reference(Location) | Where the activity occurred, if relevant | |||||
| reason |
0..* | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place. | |||||
| activity |
1..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place. 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/v3-DataOperation | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: APPEND | |||||
| 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 | |||||
| Slices for agent |
C | 1..* | BackboneElement | (USCDI) Actor involved Slice: Unordered, Open by pattern:type Constraints: provenance-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||
| 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 |
0..1 | CodeableConcept | (USCDI) How the agent participated Binding: US Core Provenance Participant Type Codes (extensible) | |||||
| role |
0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
| who |
1..1 | Reference(US Core Organization Profile | US Core Practitioner Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | Device) | (USCDI) Who participated | |||||
| onBehalfOf |
0..1 | Reference(US Core Organization Profile) | (USCDI) Who the agent is representing | |||||
| agent:ProvenanceAuthor |
1..1 | BackboneElement | (USCDI) Actor involved | |||||
| 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 |
1..1 | CodeableConcept | (USCDI) How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. 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 |
0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
| who |
1..1 | Reference(US Core Organization Profile(6.1.0)) | Who participated | |||||
| onBehalfOf |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |||||
| agent:ProvenanceTransmitter |
0..* | BackboneElement | (USCDI) Actor involved | |||||
| 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 |
1..1 | CodeableConcept | (USCDI) How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. 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://hl7.org/fhir/us/core/CodeSystem/us-core-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 |
0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |||||
| onBehalfOf |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | 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 |
0..* | Signature | Signature on target | |||||
| 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.4 |
| Provenance.activity | Base | extensible | Provenance activity type | 📦4.0.1 | FHIR Std. |
| Provenance.agent.type | Base | extensible | US Core Provenance Participant Type Codes | 📦6.1.0 | US Core v6.1 |
| 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. |
| 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()
|
This structure is derived from USCoreProvenance
Summary
Mandatory: 5 elements
Must-Support: 6 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Provenance |
0..* | USCoreProvenance(6.1.0) | US Core Provenance | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:rulesetVersion |
1..1 | string | MedList Rule-set Version URL: https://haau3.com/fhir/StructureDefinition/medlist-ruleset-version | |
| extension:rxnormRelease |
1..1 | string | MedList RxNorm Release URL: https://haau3.com/fhir/StructureDefinition/medlist-rxnorm-release | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| target |
1..* | Reference(haau3 Reconciled MedicationRequest) | (USCDI) The Resource this Provenance record supports | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:targetElement |
0..1 | uri | The id of the element haau3 added, such as its RxNorm clinical drug coding URL: http://hl7.org/fhir/StructureDefinition/targetElement | |
| extension:targetPath |
0..1 | string | A simple FHIRPath to the element haau3 added, such as MedicationRequest.medicationCodeableConcept.text URL: http://hl7.org/fhir/StructureDefinition/targetPath | |
| reference |
C | 0..1 | string | (USCDI) Literal reference, Relative, internal or absolute URL |
| occurred[x] |
1..1 | dateTime | When the activity occurred | |
| recorded |
1..1 | instant | (USCDI) Timestamp when the activity was recorded / updated | |
| activity |
1..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place. 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/v3-DataOperation | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: APPEND | |
| 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 | |
| Slices for agent |
C | 1..* | BackboneElement | (USCDI) Actor involved Slice: Unordered, Open by pattern:type Constraints: provenance-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them |
| agent:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| type |
0..1 | CodeableConcept | (USCDI) How the agent participated Binding: US Core Provenance Participant Type Codes (extensible) | |
| who |
1..1 | Reference(US Core Organization Profile | US Core Practitioner Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | Device) | (USCDI) Who participated | |
| onBehalfOf |
0..1 | Reference(US Core Organization Profile) | (USCDI) Who the agent is representing | |
| agent:ProvenanceAuthor |
1..1 | BackboneElement | (USCDI) Actor involved | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| type |
1..1 | CodeableConcept | (USCDI) How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. 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 | |
| who |
1..1 | Reference(US Core Organization Profile(6.1.0)) | Who participated | |
| onBehalfOf |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |
| agent:ProvenanceTransmitter |
0..* | BackboneElement | (USCDI) Actor involved | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| type |
1..1 | CodeableConcept | (USCDI) How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. 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://hl7.org/fhir/us/core/CodeSystem/us-core-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 | |
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
| onBehalfOf |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |
| 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 | US Core Provenance Participant Type Codes | 📦6.1.0 | US Core v6.1 |
| Provenance.agent:ProvenanceAuthor.type | Base | extensible | Provenance participant type | 📦4.0.1 | FHIR Std. |
| Provenance.agent:ProvenanceTransmitter.type | Base | extensible | Provenance participant type | 📦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
This structure is derived from USCoreProvenance
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Provenance |
0..* | USCoreProvenance(6.1.0) | US Core Provenance | |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:rulesetVersion |
1..1 | string | MedList Rule-set Version URL: https://haau3.com/fhir/StructureDefinition/medlist-ruleset-version | |
| extension:rxnormRelease |
1..1 | string | MedList RxNorm Release URL: https://haau3.com/fhir/StructureDefinition/medlist-rxnorm-release | |
| target |
1..* | Reference(haau3 Reconciled MedicationRequest) | (USCDI) The Resource this Provenance record supports | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:targetElement |
0..1 | uri | The id of the element haau3 added, such as its RxNorm clinical drug coding URL: http://hl7.org/fhir/StructureDefinition/targetElement | |
| extension:targetPath |
0..1 | string | A simple FHIRPath to the element haau3 added, such as MedicationRequest.medicationCodeableConcept.text URL: http://hl7.org/fhir/StructureDefinition/targetPath | |
| occurred[x] |
1..1 | dateTime | When the activity occurred | |
| recorded |
1..1 | instant | (USCDI) Timestamp when the activity was recorded / updated | |
| activity |
1..1 | CodeableConcept | Activity that occurred Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-DataOperation | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: APPEND | |
| Slices for agent |
Content/Rules for all slices | |||
| agent:ProvenanceAuthor |
1..1 | BackboneElement | (USCDI) Actor involved | |
| who |
1..1 | Reference(US Core Organization Profile(6.1.0)) | Who participated | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Provenance |
0..* | USCoreProvenance(6.1.0) | US Core Provenance | |||||
| 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 | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:rulesetVersion |
1..1 | string | MedList Rule-set Version URL: https://haau3.com/fhir/StructureDefinition/medlist-ruleset-version | |||||
| extension:rxnormRelease |
1..1 | string | MedList RxNorm Release URL: https://haau3.com/fhir/StructureDefinition/medlist-rxnorm-release | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| target |
1..* | Reference(haau3 Reconciled MedicationRequest) | (USCDI) The Resource this Provenance record supports | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:targetElement |
0..1 | uri | The id of the element haau3 added, such as its RxNorm clinical drug coding URL: http://hl7.org/fhir/StructureDefinition/targetElement | |||||
| extension:targetPath |
0..1 | string | A simple FHIRPath to the element haau3 added, such as MedicationRequest.medicationCodeableConcept.text URL: http://hl7.org/fhir/StructureDefinition/targetPath | |||||
| reference |
C | 0..1 | string | (USCDI) 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] |
1..1 | dateTime | When the activity occurred | |||||
| recorded |
1..1 | instant | (USCDI) Timestamp when the activity was recorded / updated | |||||
| policy |
0..* | uri | Policy or plan the activity was defined by | |||||
| location |
0..1 | Reference(Location) | Where the activity occurred, if relevant | |||||
| reason |
0..* | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place. | |||||
| activity |
1..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place. 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/v3-DataOperation | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: APPEND | |||||
| 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 | |||||
| Slices for agent |
C | 1..* | BackboneElement | (USCDI) Actor involved Slice: Unordered, Open by pattern:type Constraints: provenance-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||
| 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 |
0..1 | CodeableConcept | (USCDI) How the agent participated Binding: US Core Provenance Participant Type Codes (extensible) | |||||
| role |
0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
| who |
1..1 | Reference(US Core Organization Profile | US Core Practitioner Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | Device) | (USCDI) Who participated | |||||
| onBehalfOf |
0..1 | Reference(US Core Organization Profile) | (USCDI) Who the agent is representing | |||||
| agent:ProvenanceAuthor |
1..1 | BackboneElement | (USCDI) Actor involved | |||||
| 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 |
1..1 | CodeableConcept | (USCDI) How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. 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 |
0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
| who |
1..1 | Reference(US Core Organization Profile(6.1.0)) | Who participated | |||||
| onBehalfOf |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |||||
| agent:ProvenanceTransmitter |
0..* | BackboneElement | (USCDI) Actor involved | |||||
| 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 |
1..1 | CodeableConcept | (USCDI) How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. 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://hl7.org/fhir/us/core/CodeSystem/us-core-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 |
0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
| who |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |||||
| onBehalfOf |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | 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 |
0..* | Signature | Signature on target | |||||
| 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.4 |
| Provenance.activity | Base | extensible | Provenance activity type | 📦4.0.1 | FHIR Std. |
| Provenance.agent.type | Base | extensible | US Core Provenance Participant Type Codes | 📦6.1.0 | US Core v6.1 |
| 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. |
| 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()
|
This structure is derived from USCoreProvenance
Summary
Mandatory: 5 elements
Must-Support: 6 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron