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-provenance | Version: 1.0.0 | |||
| Draft as of 2026-11-12 | Computable Name: Haau3ReconciledMedicationProvenance | |||
Where one reconciled medication entry came from: the source records it was built from, haau3 as the software that assembled it, when it was produced and the date it was evaluated as of, and the rule-set version and RxNorm release it was reconciled against. What haau3 added to the entry, if anything, is named by a second Provenance, a haau3 Reconciled Medication Additions Provenance.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | USCoreProvenance(6.1.0) | US Core Provenance | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
1..1 | string | MedList Rule-set Version URL: https://haau3.com/fhir/StructureDefinition/medlist-ruleset-version | |
![]() ![]() ![]() |
1..1 | string | MedList RxNorm Release URL: https://haau3.com/fhir/StructureDefinition/medlist-rxnorm-release | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
1..1 | Reference(haau3 Reconciled MedicationRequest) | (USCDI) The Resource this Provenance record supports | |
![]() ![]() ![]() |
C | 0..1 | string | (USCDI) Literal reference, Relative, internal or absolute URL |
![]() ![]() |
1..1 | dateTime | When the activity occurred | |
![]() ![]() |
1..1 | instant | (USCDI) Timestamp when the activity was recorded / updated | |
![]() ![]() |
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 |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | (USCDI) How the agent participated Binding: US Core Provenance Participant Type Codes (extensible) | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
0..1 | Reference(US Core Organization Profile) | (USCDI) Who the agent is representing | |
![]() ![]() ![]() |
0..* | BackboneElement | (USCDI) Actor involved | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
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: | |
![]() ![]() ![]() ![]() |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |
![]() ![]() ![]() |
0..* | BackboneElement | (USCDI) Actor involved | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
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: | |
![]() ![]() ![]() ![]() |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |
![]() ![]() ![]() |
1..1 | BackboneElement | Actor involved | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. Required Pattern: | |
![]() ![]() ![]() ![]() |
1..1 | Reference(US Core Organization Profile(6.1.0)) | Who participated | |
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |
![]() ![]() |
1..* | BackboneElement | An entity used in this activity | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. Fixed Value: source (no extensions allowed) | |
![]() ![]() ![]() |
1..1 | Reference(MedicationRequest | MedicationStatement | MedicationDispense | MedicationAdministration) | Identity of entity | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| 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. |
| Provenance.agent:assembler.type | Base | extensible | Provenance participant type | 📍4.0.1 | FHIR Std. |
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Provenance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Provenance | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| 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: ![]() |
|---|---|---|---|---|
![]() |
USCoreProvenance(6.1.0) | |||
![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
1..1 | string | MedList Rule-set Version URL: https://haau3.com/fhir/StructureDefinition/medlist-ruleset-version | |
![]() ![]() ![]() |
1..1 | string | MedList RxNorm Release URL: https://haau3.com/fhir/StructureDefinition/medlist-rxnorm-release | |
![]() ![]() |
1..1 | Reference(haau3 Reconciled MedicationRequest) | (USCDI) The Resource this Provenance record supports | |
![]() ![]() |
1..1 | dateTime | When the activity occurred | |
![]() ![]() |
1..1 | instant | (USCDI) Timestamp when the activity was recorded / updated | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
1..1 | BackboneElement | Actor involved | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | How the agent participated Required Pattern: | |
![]() ![]() ![]() ![]() |
1..1 | Reference(US Core Organization Profile(6.1.0)) | Who participated | |
![]() ![]() |
1..* | BackboneElement | An entity used in this activity | |
![]() ![]() ![]() |
1..1 | code | derivation | revision | quotation | source | removal Fixed Value: source (no extensions allowed) | |
![]() ![]() ![]() |
1..1 | Reference(MedicationRequest | MedicationStatement | MedicationDispense | MedicationAdministration) | Identity of entity | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | USCoreProvenance(6.1.0) | US Core Provenance | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
1..1 | string | MedList Rule-set Version URL: https://haau3.com/fhir/StructureDefinition/medlist-ruleset-version | |||||
![]() ![]() ![]() |
1..1 | string | MedList RxNorm Release URL: https://haau3.com/fhir/StructureDefinition/medlist-rxnorm-release | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
1..1 | Reference(haau3 Reconciled MedicationRequest) | (USCDI) The Resource this Provenance record supports | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 0..1 | string | (USCDI) Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
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). | |||||
![]() ![]() ![]() |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
![]() ![]() ![]() |
0..1 | string | Text alternative for the resource | |||||
![]() ![]() |
1..1 | dateTime | When the activity occurred | |||||
![]() ![]() |
1..1 | instant | (USCDI) Timestamp when the activity was recorded / updated | |||||
![]() ![]() |
0..* | uri | Policy or plan the activity was defined by | |||||
![]() ![]() |
0..1 | Reference(Location) | Where the activity occurred, if relevant | |||||
![]() ![]() |
0..* | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place. | |||||
![]() ![]() |
0..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place. | |||||
![]() ![]() |
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 | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | (USCDI) How the agent participated Binding: US Core Provenance Participant Type Codes (extensible) | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(US Core Organization Profile) | (USCDI) Who the agent is representing | |||||
![]() ![]() ![]() |
0..* | BackboneElement | (USCDI) Actor involved | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
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: | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |||||
![]() ![]() ![]() |
0..* | BackboneElement | (USCDI) Actor involved | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
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: | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |||||
![]() ![]() ![]() |
1..1 | BackboneElement | Actor involved | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. Required Pattern: | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(US Core Organization Profile(6.1.0)) | Who participated | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |||||
![]() ![]() |
1..* | BackboneElement | An entity used in this activity | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. Fixed Value: source (no extensions allowed) | |||||
![]() ![]() ![]() |
1..1 | Reference(MedicationRequest | MedicationStatement | MedicationDispense | MedicationAdministration) | Identity of entity | |||||
![]() ![]() ![]() |
0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
![]() ![]() |
0..* | Signature | Signature on target | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.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.5 |
| 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.agent:assembler.type | Base | extensible | Provenance participant type | 📍4.0.1 | FHIR Std. |
| Provenance.agent:assembler.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: 6 elements
Must-Support: 5 elements
Fixed: 1 element
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: ![]() |
|---|---|---|---|---|
![]() |
0..* | USCoreProvenance(6.1.0) | US Core Provenance | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
1..1 | string | MedList Rule-set Version URL: https://haau3.com/fhir/StructureDefinition/medlist-ruleset-version | |
![]() ![]() ![]() |
1..1 | string | MedList RxNorm Release URL: https://haau3.com/fhir/StructureDefinition/medlist-rxnorm-release | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
1..1 | Reference(haau3 Reconciled MedicationRequest) | (USCDI) The Resource this Provenance record supports | |
![]() ![]() ![]() |
C | 0..1 | string | (USCDI) Literal reference, Relative, internal or absolute URL |
![]() ![]() |
1..1 | dateTime | When the activity occurred | |
![]() ![]() |
1..1 | instant | (USCDI) Timestamp when the activity was recorded / updated | |
![]() ![]() |
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 |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | (USCDI) How the agent participated Binding: US Core Provenance Participant Type Codes (extensible) | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
0..1 | Reference(US Core Organization Profile) | (USCDI) Who the agent is representing | |
![]() ![]() ![]() |
0..* | BackboneElement | (USCDI) Actor involved | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
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: | |
![]() ![]() ![]() ![]() |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |
![]() ![]() ![]() |
0..* | BackboneElement | (USCDI) Actor involved | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
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: | |
![]() ![]() ![]() ![]() |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |
![]() ![]() ![]() |
1..1 | BackboneElement | Actor involved | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. Required Pattern: | |
![]() ![]() ![]() ![]() |
1..1 | Reference(US Core Organization Profile(6.1.0)) | Who participated | |
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |
![]() ![]() |
1..* | BackboneElement | An entity used in this activity | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. Fixed Value: source (no extensions allowed) | |
![]() ![]() ![]() |
1..1 | Reference(MedicationRequest | MedicationStatement | MedicationDispense | MedicationAdministration) | Identity of entity | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| 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. |
| Provenance.agent:assembler.type | Base | extensible | Provenance participant type | 📍4.0.1 | FHIR Std. |
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Provenance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Provenance | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| 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: ![]() |
|---|---|---|---|---|
![]() |
USCoreProvenance(6.1.0) | |||
![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
1..1 | string | MedList Rule-set Version URL: https://haau3.com/fhir/StructureDefinition/medlist-ruleset-version | |
![]() ![]() ![]() |
1..1 | string | MedList RxNorm Release URL: https://haau3.com/fhir/StructureDefinition/medlist-rxnorm-release | |
![]() ![]() |
1..1 | Reference(haau3 Reconciled MedicationRequest) | (USCDI) The Resource this Provenance record supports | |
![]() ![]() |
1..1 | dateTime | When the activity occurred | |
![]() ![]() |
1..1 | instant | (USCDI) Timestamp when the activity was recorded / updated | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
1..1 | BackboneElement | Actor involved | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | How the agent participated Required Pattern: | |
![]() ![]() ![]() ![]() |
1..1 | Reference(US Core Organization Profile(6.1.0)) | Who participated | |
![]() ![]() |
1..* | BackboneElement | An entity used in this activity | |
![]() ![]() ![]() |
1..1 | code | derivation | revision | quotation | source | removal Fixed Value: source (no extensions allowed) | |
![]() ![]() ![]() |
1..1 | Reference(MedicationRequest | MedicationStatement | MedicationDispense | MedicationAdministration) | Identity of entity | |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | USCoreProvenance(6.1.0) | US Core Provenance | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
1..1 | string | MedList Rule-set Version URL: https://haau3.com/fhir/StructureDefinition/medlist-ruleset-version | |||||
![]() ![]() ![]() |
1..1 | string | MedList RxNorm Release URL: https://haau3.com/fhir/StructureDefinition/medlist-rxnorm-release | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
1..1 | Reference(haau3 Reconciled MedicationRequest) | (USCDI) The Resource this Provenance record supports | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 0..1 | string | (USCDI) Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
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). | |||||
![]() ![]() ![]() |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
![]() ![]() ![]() |
0..1 | string | Text alternative for the resource | |||||
![]() ![]() |
1..1 | dateTime | When the activity occurred | |||||
![]() ![]() |
1..1 | instant | (USCDI) Timestamp when the activity was recorded / updated | |||||
![]() ![]() |
0..* | uri | Policy or plan the activity was defined by | |||||
![]() ![]() |
0..1 | Reference(Location) | Where the activity occurred, if relevant | |||||
![]() ![]() |
0..* | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place. | |||||
![]() ![]() |
0..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place. | |||||
![]() ![]() |
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 | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | (USCDI) How the agent participated Binding: US Core Provenance Participant Type Codes (extensible) | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(US Core Organization Profile) | (USCDI) Who the agent is representing | |||||
![]() ![]() ![]() |
0..* | BackboneElement | (USCDI) Actor involved | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
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: | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |||||
![]() ![]() ![]() |
0..* | BackboneElement | (USCDI) Actor involved | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
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: | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |||||
![]() ![]() ![]() |
1..1 | BackboneElement | Actor involved | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. Required Pattern: | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(US Core Organization Profile(6.1.0)) | Who participated | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |||||
![]() ![]() |
1..* | BackboneElement | An entity used in this activity | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. Fixed Value: source (no extensions allowed) | |||||
![]() ![]() ![]() |
1..1 | Reference(MedicationRequest | MedicationStatement | MedicationDispense | MedicationAdministration) | Identity of entity | |||||
![]() ![]() ![]() |
0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
![]() ![]() |
0..* | Signature | Signature on target | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.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.5 |
| 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.agent:assembler.type | Base | extensible | Provenance participant type | 📍4.0.1 | FHIR Std. |
| Provenance.agent:assembler.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: 6 elements
Must-Support: 5 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron