Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R5_Provenance_R4

Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-Provenance Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R5_Provenance_R4

This cross-version profile allows R5 Provenance content to be represented via FHIR R4 Provenance resources.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* Provenance(4.0.1) Who, What, When for a set of resources
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR R4(0.1.0) | CarePlan | Cross-version Profile for R5.DeviceRequest for use in FHIR R4(0.1.0) | DeviceRequest | Cross-version Profile for R5.ImmunizationRecommendation for use in FHIR R4(0.1.0) | ImmunizationRecommendation | Cross-version Profile for R5.MedicationRequest for use in FHIR R4(0.1.0) | MedicationRequest | Cross-version Profile for R5.NutritionOrder for use in FHIR R4(0.1.0) | NutritionOrder | Cross-version Profile for R5.ServiceRequest for use in FHIR R4(0.1.0) | ServiceRequest | Cross-version Profile for R5.Task for use in FHIR R4(0.1.0) | Task) R5: Workflow authorization within which this event occurred (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.basedOn
Constraints: ext-1
.... extension:patient 0..1 Reference(Cross-version Profile for R5.Patient for use in FHIR R4(0.1.0) | Patient) R5: The patient is the subject of the data created/updated (.target) by the activity (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.patient
Constraints: ext-1
.... extension:encounter 0..1 Reference(Cross-version Profile for R5.Encounter for use in FHIR R4(0.1.0) | Encounter) R5: Encounter within which this event occurred or which the event is tightly associated (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.encounter
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... recorded Σ 1..1 instant When the activity was recorded / updated
... agent 1..* BackboneElement Actor involved
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... who Σ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who participated
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:who 0..1 Reference(Resource) R5: The agent that participated in the event
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1

doco Documentation for this format

Constraints

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 Provenance.implicitRules, Provenance.extension, Provenance.extension:basedOn, Provenance.extension:patient, Provenance.extension:encounter, Provenance.modifierExtension, Provenance.target, Provenance.recorded, Provenance.agent, Provenance.agent.modifierExtension, Provenance.agent.who, Provenance.agent.who.extension, Provenance.agent.who.extension:who All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Provenance.extension, Provenance.extension:basedOn, Provenance.extension:patient, Provenance.extension:encounter, Provenance.modifierExtension, Provenance.agent.modifierExtension, Provenance.agent.who.extension, Provenance.agent.who.extension:who Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Provenance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* Provenance(4.0.1) Who, What, When for a set of resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR R4(0.1.0) | CarePlan | Cross-version Profile for R5.DeviceRequest for use in FHIR R4(0.1.0) | DeviceRequest | Cross-version Profile for R5.ImmunizationRecommendation for use in FHIR R4(0.1.0) | ImmunizationRecommendation | Cross-version Profile for R5.MedicationRequest for use in FHIR R4(0.1.0) | MedicationRequest | Cross-version Profile for R5.NutritionOrder for use in FHIR R4(0.1.0) | NutritionOrder | Cross-version Profile for R5.ServiceRequest for use in FHIR R4(0.1.0) | ServiceRequest | Cross-version Profile for R5.Task for use in FHIR R4(0.1.0) | Task) R5: Workflow authorization within which this event occurred (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.basedOn
.... extension:patient 0..1 Reference(Cross-version Profile for R5.Patient for use in FHIR R4(0.1.0) | Patient) R5: The patient is the subject of the data created/updated (.target) by the activity (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.patient
.... extension:encounter 0..1 Reference(Cross-version Profile for R5.Encounter for use in FHIR R4(0.1.0) | Encounter) R5: Encounter within which this event occurred or which the event is tightly associated (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.encounter
... reason
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:authorization 0..* Reference() R5: Authorization (purposeOfUse) related to the event additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.authorization
... agent
.... who
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:who 0..1 Reference(Resource) R5: The agent that participated in the event
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... onBehalfOf
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:onBehalfOf 0..1 Reference(Resource) R5: The agent that delegated
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... role
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:role 0..1 code R5: revision | quotation | source | instantiates | removal
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.entity.role
Binding: R5ProvenanceEntityRoleForR4 (0.1.0) (required): How an entity was used in an activity.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* Provenance(4.0.1) 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
... 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 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR R4(0.1.0) | CarePlan | Cross-version Profile for R5.DeviceRequest for use in FHIR R4(0.1.0) | DeviceRequest | Cross-version Profile for R5.ImmunizationRecommendation for use in FHIR R4(0.1.0) | ImmunizationRecommendation | Cross-version Profile for R5.MedicationRequest for use in FHIR R4(0.1.0) | MedicationRequest | Cross-version Profile for R5.NutritionOrder for use in FHIR R4(0.1.0) | NutritionOrder | Cross-version Profile for R5.ServiceRequest for use in FHIR R4(0.1.0) | ServiceRequest | Cross-version Profile for R5.Task for use in FHIR R4(0.1.0) | Task) R5: Workflow authorization within which this event occurred (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.basedOn
Constraints: ext-1
.... extension:patient 0..1 Reference(Cross-version Profile for R5.Patient for use in FHIR R4(0.1.0) | Patient) R5: The patient is the subject of the data created/updated (.target) by the activity (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.patient
Constraints: ext-1
.... extension:encounter 0..1 Reference(Cross-version Profile for R5.Encounter for use in FHIR R4(0.1.0) | Encounter) R5: Encounter within which this event occurred or which the event is tightly associated (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.encounter
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... target Σ 1..* Reference(Resource) Target Reference(s) (usually version specific)
... occurred[x] 0..1 When the activity occurred
.... occurredPeriod Period
.... occurredDateTime dateTime
... recorded Σ 1..1 instant 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 (3.1.0) (extensible): The reason the activity took place.
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:authorization 0..* Reference() R5: Authorization (purposeOfUse) related to the event additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.authorization
Constraints: ext-1
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... activity 0..1 CodeableConcept Activity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.
... agent 1..* BackboneElement Actor involved
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... type Σ 0..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.
.... 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
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:who 0..1 Reference(Resource) R5: The agent that participated in the event
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference Σ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
.... onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:onBehalfOf 0..1 Reference(Resource) R5: The agent that delegated
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference Σ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
... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... role Σ 1..1 code derivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole . (required): How an entity was used in an activity.
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:role 0..1 code R5: revision | quotation | source | instantiates | removal
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.entity.role
Binding: R5ProvenanceEntityRoleForR4 (0.1.0) (required): How an entity was used in an activity.
Constraints: ext-1
..... value 0..1 string Primitive value for code
.... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Provenance.language Base preferred Common Languages . 📍4.0.1 tx.fhir.org
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.who.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
Provenance.agent.onBehalfOf.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
Provenance.entity.role Base required ProvenanceEntityRole . 📍4.0.1 tx.fhir.org

Constraints

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 Provenance.meta, Provenance.implicitRules, Provenance.language, Provenance.text, Provenance.extension, Provenance.extension:basedOn, Provenance.extension:patient, Provenance.extension:encounter, Provenance.modifierExtension, Provenance.target, Provenance.occurred[x], Provenance.recorded, Provenance.policy, Provenance.location, Provenance.reason, Provenance.reason.extension, Provenance.reason.extension:authorization, Provenance.reason.coding, Provenance.reason.text, Provenance.activity, Provenance.agent, Provenance.agent.extension, Provenance.agent.modifierExtension, Provenance.agent.type, Provenance.agent.role, Provenance.agent.who, Provenance.agent.who.extension, Provenance.agent.who.extension:who, Provenance.agent.who.reference, Provenance.agent.who.type, Provenance.agent.who.identifier, Provenance.agent.who.display, Provenance.agent.onBehalfOf, Provenance.agent.onBehalfOf.extension, Provenance.agent.onBehalfOf.extension:onBehalfOf, Provenance.agent.onBehalfOf.reference, Provenance.agent.onBehalfOf.type, Provenance.agent.onBehalfOf.identifier, Provenance.agent.onBehalfOf.display, Provenance.entity, Provenance.entity.extension, Provenance.entity.modifierExtension, Provenance.entity.role, Provenance.entity.role.extension, Provenance.entity.role.extension:role, Provenance.entity.what, Provenance.entity.agent, Provenance.signature All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Provenance.extension, Provenance.extension:basedOn, Provenance.extension:patient, Provenance.extension:encounter, Provenance.modifierExtension, Provenance.reason.extension, Provenance.reason.extension:authorization, Provenance.agent.extension, Provenance.agent.modifierExtension, Provenance.agent.who.extension, Provenance.agent.who.extension:who, Provenance.agent.onBehalfOf.extension, Provenance.agent.onBehalfOf.extension:onBehalfOf, Provenance.entity.extension, Provenance.entity.modifierExtension, Provenance.entity.role.extension, Provenance.entity.role.extension:role Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* Provenance(4.0.1) Who, What, When for a set of resources
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR R4(0.1.0) | CarePlan | Cross-version Profile for R5.DeviceRequest for use in FHIR R4(0.1.0) | DeviceRequest | Cross-version Profile for R5.ImmunizationRecommendation for use in FHIR R4(0.1.0) | ImmunizationRecommendation | Cross-version Profile for R5.MedicationRequest for use in FHIR R4(0.1.0) | MedicationRequest | Cross-version Profile for R5.NutritionOrder for use in FHIR R4(0.1.0) | NutritionOrder | Cross-version Profile for R5.ServiceRequest for use in FHIR R4(0.1.0) | ServiceRequest | Cross-version Profile for R5.Task for use in FHIR R4(0.1.0) | Task) R5: Workflow authorization within which this event occurred (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.basedOn
Constraints: ext-1
.... extension:patient 0..1 Reference(Cross-version Profile for R5.Patient for use in FHIR R4(0.1.0) | Patient) R5: The patient is the subject of the data created/updated (.target) by the activity (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.patient
Constraints: ext-1
.... extension:encounter 0..1 Reference(Cross-version Profile for R5.Encounter for use in FHIR R4(0.1.0) | Encounter) R5: Encounter within which this event occurred or which the event is tightly associated (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.encounter
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... recorded Σ 1..1 instant When the activity was recorded / updated
... agent 1..* BackboneElement Actor involved
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... who Σ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who participated
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:who 0..1 Reference(Resource) R5: The agent that participated in the event
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1

doco Documentation for this format

Constraints

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 Provenance.implicitRules, Provenance.extension, Provenance.extension:basedOn, Provenance.extension:patient, Provenance.extension:encounter, Provenance.modifierExtension, Provenance.target, Provenance.recorded, Provenance.agent, Provenance.agent.modifierExtension, Provenance.agent.who, Provenance.agent.who.extension, Provenance.agent.who.extension:who All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Provenance.extension, Provenance.extension:basedOn, Provenance.extension:patient, Provenance.extension:encounter, Provenance.modifierExtension, Provenance.agent.modifierExtension, Provenance.agent.who.extension, Provenance.agent.who.extension:who Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Provenance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* Provenance(4.0.1) Who, What, When for a set of resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR R4(0.1.0) | CarePlan | Cross-version Profile for R5.DeviceRequest for use in FHIR R4(0.1.0) | DeviceRequest | Cross-version Profile for R5.ImmunizationRecommendation for use in FHIR R4(0.1.0) | ImmunizationRecommendation | Cross-version Profile for R5.MedicationRequest for use in FHIR R4(0.1.0) | MedicationRequest | Cross-version Profile for R5.NutritionOrder for use in FHIR R4(0.1.0) | NutritionOrder | Cross-version Profile for R5.ServiceRequest for use in FHIR R4(0.1.0) | ServiceRequest | Cross-version Profile for R5.Task for use in FHIR R4(0.1.0) | Task) R5: Workflow authorization within which this event occurred (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.basedOn
.... extension:patient 0..1 Reference(Cross-version Profile for R5.Patient for use in FHIR R4(0.1.0) | Patient) R5: The patient is the subject of the data created/updated (.target) by the activity (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.patient
.... extension:encounter 0..1 Reference(Cross-version Profile for R5.Encounter for use in FHIR R4(0.1.0) | Encounter) R5: Encounter within which this event occurred or which the event is tightly associated (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.encounter
... reason
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:authorization 0..* Reference() R5: Authorization (purposeOfUse) related to the event additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.authorization
... agent
.... who
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:who 0..1 Reference(Resource) R5: The agent that participated in the event
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... onBehalfOf
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:onBehalfOf 0..1 Reference(Resource) R5: The agent that delegated
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... role
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:role 0..1 code R5: revision | quotation | source | instantiates | removal
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.entity.role
Binding: R5ProvenanceEntityRoleForR4 (0.1.0) (required): How an entity was used in an activity.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* Provenance(4.0.1) 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
... 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 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR R4(0.1.0) | CarePlan | Cross-version Profile for R5.DeviceRequest for use in FHIR R4(0.1.0) | DeviceRequest | Cross-version Profile for R5.ImmunizationRecommendation for use in FHIR R4(0.1.0) | ImmunizationRecommendation | Cross-version Profile for R5.MedicationRequest for use in FHIR R4(0.1.0) | MedicationRequest | Cross-version Profile for R5.NutritionOrder for use in FHIR R4(0.1.0) | NutritionOrder | Cross-version Profile for R5.ServiceRequest for use in FHIR R4(0.1.0) | ServiceRequest | Cross-version Profile for R5.Task for use in FHIR R4(0.1.0) | Task) R5: Workflow authorization within which this event occurred (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.basedOn
Constraints: ext-1
.... extension:patient 0..1 Reference(Cross-version Profile for R5.Patient for use in FHIR R4(0.1.0) | Patient) R5: The patient is the subject of the data created/updated (.target) by the activity (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.patient
Constraints: ext-1
.... extension:encounter 0..1 Reference(Cross-version Profile for R5.Encounter for use in FHIR R4(0.1.0) | Encounter) R5: Encounter within which this event occurred or which the event is tightly associated (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.encounter
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... target Σ 1..* Reference(Resource) Target Reference(s) (usually version specific)
... occurred[x] 0..1 When the activity occurred
.... occurredPeriod Period
.... occurredDateTime dateTime
... recorded Σ 1..1 instant 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 (3.1.0) (extensible): The reason the activity took place.
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:authorization 0..* Reference() R5: Authorization (purposeOfUse) related to the event additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.authorization
Constraints: ext-1
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... activity 0..1 CodeableConcept Activity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.
... agent 1..* BackboneElement Actor involved
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... type Σ 0..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.
.... 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
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:who 0..1 Reference(Resource) R5: The agent that participated in the event
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference Σ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
.... onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:onBehalfOf 0..1 Reference(Resource) R5: The agent that delegated
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference Σ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
... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... role Σ 1..1 code derivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole . (required): How an entity was used in an activity.
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:role 0..1 code R5: revision | quotation | source | instantiates | removal
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.entity.role
Binding: R5ProvenanceEntityRoleForR4 (0.1.0) (required): How an entity was used in an activity.
Constraints: ext-1
..... value 0..1 string Primitive value for code
.... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Provenance.language Base preferred Common Languages . 📍4.0.1 tx.fhir.org
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.who.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
Provenance.agent.onBehalfOf.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
Provenance.entity.role Base required ProvenanceEntityRole . 📍4.0.1 tx.fhir.org

Constraints

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 Provenance.meta, Provenance.implicitRules, Provenance.language, Provenance.text, Provenance.extension, Provenance.extension:basedOn, Provenance.extension:patient, Provenance.extension:encounter, Provenance.modifierExtension, Provenance.target, Provenance.occurred[x], Provenance.recorded, Provenance.policy, Provenance.location, Provenance.reason, Provenance.reason.extension, Provenance.reason.extension:authorization, Provenance.reason.coding, Provenance.reason.text, Provenance.activity, Provenance.agent, Provenance.agent.extension, Provenance.agent.modifierExtension, Provenance.agent.type, Provenance.agent.role, Provenance.agent.who, Provenance.agent.who.extension, Provenance.agent.who.extension:who, Provenance.agent.who.reference, Provenance.agent.who.type, Provenance.agent.who.identifier, Provenance.agent.who.display, Provenance.agent.onBehalfOf, Provenance.agent.onBehalfOf.extension, Provenance.agent.onBehalfOf.extension:onBehalfOf, Provenance.agent.onBehalfOf.reference, Provenance.agent.onBehalfOf.type, Provenance.agent.onBehalfOf.identifier, Provenance.agent.onBehalfOf.display, Provenance.entity, Provenance.entity.extension, Provenance.entity.modifierExtension, Provenance.entity.role, Provenance.entity.role.extension, Provenance.entity.role.extension:role, Provenance.entity.what, Provenance.entity.agent, Provenance.signature All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Provenance.extension, Provenance.extension:basedOn, Provenance.extension:patient, Provenance.extension:encounter, Provenance.modifierExtension, Provenance.reason.extension, Provenance.reason.extension:authorization, Provenance.agent.extension, Provenance.agent.modifierExtension, Provenance.agent.who.extension, Provenance.agent.who.extension:who, Provenance.agent.onBehalfOf.extension, Provenance.agent.onBehalfOf.extension:onBehalfOf, Provenance.entity.extension, Provenance.entity.modifierExtension, Provenance.entity.role.extension, Provenance.entity.role.extension:role Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron