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

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

Resource Profile: Profile_R5_Provenance_R3

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_R3

This cross-version profile allows R5 Provenance content to be represented via FHIR STU3 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 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
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR STU3(0.1.0) | CarePlan | Cross-version Profile for R5.DeviceRequest for use in FHIR STU3(0.1.0) | DeviceRequest | Cross-version Profile for R5.ImmunizationRecommendation for use in FHIR STU3(0.1.0) | ImmunizationRecommendation | Cross-version Profile for R5.MedicationRequest for use in FHIR STU3(0.1.0) | MedicationRequest | Cross-version Profile for R5.NutritionOrder for use in FHIR STU3(0.1.0) | NutritionOrder | Cross-version Profile for R5.ServiceRequest for use in FHIR STU3(0.1.0) | ReferralRequest | Cross-version Profile for R5.Task for use in FHIR STU3(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 STU3(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 STU3(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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:target 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: target additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... recorded Σ 1..1 instant When the activity was recorded / updated
... agent 1..* BackboneElement Actor involved
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... who[x] Σ 1..1 Who participated
..... who[x]All Types Content/Rules for all Types
...... Slices for extension Content/Rules for all slices
....... extension:alternateReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: The agent that participated in the event
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... whoUri uri
..... whoReference Reference(Practitioner | RelatedPerson | Patient | Device | Organization)

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
dom-1 error Provenance If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Provenance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* Provenance 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 STU3(0.1.0) | CarePlan | Cross-version Profile for R5.DeviceRequest for use in FHIR STU3(0.1.0) | DeviceRequest | Cross-version Profile for R5.ImmunizationRecommendation for use in FHIR STU3(0.1.0) | ImmunizationRecommendation | Cross-version Profile for R5.MedicationRequest for use in FHIR STU3(0.1.0) | MedicationRequest | Cross-version Profile for R5.NutritionOrder for use in FHIR STU3(0.1.0) | NutritionOrder | Cross-version Profile for R5.ServiceRequest for use in FHIR STU3(0.1.0) | ReferralRequest | Cross-version Profile for R5.Task for use in FHIR STU3(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 STU3(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 STU3(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
... target
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:target 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: target additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... period
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:occurred 0..1 dateTime R5: occurred additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.occurred
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:location 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: location additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... reason
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:authorization 0..* (Complex) R5: Authorization (purposeOfUse) related to the event additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.authorization
... activity
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:activity 0..1 CodeableConcept R5: activity additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.activity
Binding: R5ProvenanceActivityTypeForR3 (0.1.0) (example): The activity that took place.
... agent
.... whoReference
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:alternateReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: The agent that participated in the event
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... onBehalfOfReference
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:alternateReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: The agent that delegated
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... entity
.... 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: R5ProvenanceEntityRoleForR3 (0.1.0) (required): How an entity was used in an activity.
.... whatReference
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:alternateReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: what additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* Provenance 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
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR STU3(0.1.0) | CarePlan | Cross-version Profile for R5.DeviceRequest for use in FHIR STU3(0.1.0) | DeviceRequest | Cross-version Profile for R5.ImmunizationRecommendation for use in FHIR STU3(0.1.0) | ImmunizationRecommendation | Cross-version Profile for R5.MedicationRequest for use in FHIR STU3(0.1.0) | MedicationRequest | Cross-version Profile for R5.NutritionOrder for use in FHIR STU3(0.1.0) | NutritionOrder | Cross-version Profile for R5.ServiceRequest for use in FHIR STU3(0.1.0) | ReferralRequest | Cross-version Profile for R5.Task for use in FHIR STU3(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 STU3(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 STU3(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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... target Σ 1..* Reference(Resource) Target Reference(s) (usually version specific)
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:target 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: target additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... period 0..1 Period When the activity occurred
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:occurred 0..1 dateTime R5: occurred additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.occurred
.... start ΣC 0..1 dateTime Starting time with inclusive boundary
.... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... 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
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:location 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: location additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... reason 0..* Coding ​Reason the activity is occurring
Binding: PurposeOfUse|2014-03-26 (extensible): The reason the activity took place.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:authorization 0..* (Complex) R5: Authorization (purposeOfUse) related to the event additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.authorization
.... system Σ 0..1 uri Identity of the terminology system
.... version Σ 0..1 string Version of the system - if relevant
.... code Σ 0..1 code Symbol in syntax defined by the system
.... display Σ 0..1 string Representation defined by the system
.... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... activity 0..1 Coding Activity that occurred
Binding: ProvenanceActivityType . (extensible): The activity that took place.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:activity 0..1 CodeableConcept R5: activity additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.activity
Binding: R5ProvenanceActivityTypeForR3 (0.1.0) (example): The activity that took place.
.... system Σ 0..1 uri Identity of the terminology system
.... version Σ 0..1 string Version of the system - if relevant
.... code Σ 0..1 code Symbol in syntax defined by the system
.... display Σ 0..1 string Representation defined by the system
.... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... agent 1..* BackboneElement Actor involved
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... role Σ 0..* CodeableConcept What the agents role was
Binding: SecurityRoleType . (extensible): The role that a provenance agent played with respect to the activity.
.... who[x] Σ 1..1 Who participated
..... who[x]All Types Content/Rules for all Types
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:alternateReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: The agent that participated in the event
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... whoUri uri
..... whoReference Reference(Practitioner | RelatedPerson | Patient | Device | Organization)
.... onBehalfOf[x] 0..1 Who the agent is representing
..... onBehalfOf[x]All Types Content/Rules for all Types
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:alternateReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: The agent that delegated
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... onBehalfOfUri uri
..... onBehalfOfReference Reference(Practitioner | RelatedPerson | Patient | Device | Organization)
.... relatedAgentType 0..1 CodeableConcept ​Type of relationship between agents
Binding: RoleLinkType|2016-11-11 (example): Type of relationship between two provenance agents.
... entity 0..* BackboneElement An entity used in this activity
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... 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
...... extension:role 0..1 code R5: revision | quotation | source | instantiates | removal
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.entity.role
Binding: R5ProvenanceEntityRoleForR3 (0.1.0) (required): How an entity was used in an activity.
..... value 0..1 code Primitive value for code
.... what[x] Σ 1..1 Identity of entity
..... what[x]All Types Content/Rules for all Types
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:alternateReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: what additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... whatUri uri
..... whatReference Reference(Resource)
..... whatIdentifier Identifier
.... 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 extensible Common Languages . 📍3.0.2 tx.fhir.org
Provenance.reason Base extensible PurposeOfUse 📍2014-03-26 FHIR Std.
Provenance.activity Base extensible ProvenanceActivityType . 📍1.1.0 tx.fhir.org
Provenance.agent.role Base extensible SecurityRoleType . 📍1.8.0 tx.fhir.org
Provenance.agent.relatedAgentType Base example v3 Code System RoleLinkType 📍2016-11-11 FHIR Std.
Provenance.entity.role Base required ProvenanceEntityRole . 📍3.0.2 tx.fhir.org

Constraints

Id Grade Path(s) Description Expression
dom-1 error Provenance If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* Provenance 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
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR STU3(0.1.0) | CarePlan | Cross-version Profile for R5.DeviceRequest for use in FHIR STU3(0.1.0) | DeviceRequest | Cross-version Profile for R5.ImmunizationRecommendation for use in FHIR STU3(0.1.0) | ImmunizationRecommendation | Cross-version Profile for R5.MedicationRequest for use in FHIR STU3(0.1.0) | MedicationRequest | Cross-version Profile for R5.NutritionOrder for use in FHIR STU3(0.1.0) | NutritionOrder | Cross-version Profile for R5.ServiceRequest for use in FHIR STU3(0.1.0) | ReferralRequest | Cross-version Profile for R5.Task for use in FHIR STU3(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 STU3(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 STU3(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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:target 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: target additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... recorded Σ 1..1 instant When the activity was recorded / updated
... agent 1..* BackboneElement Actor involved
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... who[x] Σ 1..1 Who participated
..... who[x]All Types Content/Rules for all Types
...... Slices for extension Content/Rules for all slices
....... extension:alternateReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: The agent that participated in the event
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... whoUri uri
..... whoReference Reference(Practitioner | RelatedPerson | Patient | Device | Organization)

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
dom-1 error Provenance If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Provenance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* Provenance 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 STU3(0.1.0) | CarePlan | Cross-version Profile for R5.DeviceRequest for use in FHIR STU3(0.1.0) | DeviceRequest | Cross-version Profile for R5.ImmunizationRecommendation for use in FHIR STU3(0.1.0) | ImmunizationRecommendation | Cross-version Profile for R5.MedicationRequest for use in FHIR STU3(0.1.0) | MedicationRequest | Cross-version Profile for R5.NutritionOrder for use in FHIR STU3(0.1.0) | NutritionOrder | Cross-version Profile for R5.ServiceRequest for use in FHIR STU3(0.1.0) | ReferralRequest | Cross-version Profile for R5.Task for use in FHIR STU3(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 STU3(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 STU3(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
... target
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:target 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: target additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... period
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:occurred 0..1 dateTime R5: occurred additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.occurred
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:location 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: location additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... reason
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:authorization 0..* (Complex) R5: Authorization (purposeOfUse) related to the event additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.authorization
... activity
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:activity 0..1 CodeableConcept R5: activity additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.activity
Binding: R5ProvenanceActivityTypeForR3 (0.1.0) (example): The activity that took place.
... agent
.... whoReference
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:alternateReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: The agent that participated in the event
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... onBehalfOfReference
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:alternateReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: The agent that delegated
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... entity
.... 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: R5ProvenanceEntityRoleForR3 (0.1.0) (required): How an entity was used in an activity.
.... whatReference
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:alternateReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: what additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* Provenance 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
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR STU3(0.1.0) | CarePlan | Cross-version Profile for R5.DeviceRequest for use in FHIR STU3(0.1.0) | DeviceRequest | Cross-version Profile for R5.ImmunizationRecommendation for use in FHIR STU3(0.1.0) | ImmunizationRecommendation | Cross-version Profile for R5.MedicationRequest for use in FHIR STU3(0.1.0) | MedicationRequest | Cross-version Profile for R5.NutritionOrder for use in FHIR STU3(0.1.0) | NutritionOrder | Cross-version Profile for R5.ServiceRequest for use in FHIR STU3(0.1.0) | ReferralRequest | Cross-version Profile for R5.Task for use in FHIR STU3(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 STU3(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 STU3(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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... target Σ 1..* Reference(Resource) Target Reference(s) (usually version specific)
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:target 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: target additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... period 0..1 Period When the activity occurred
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:occurred 0..1 dateTime R5: occurred additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.occurred
.... start ΣC 0..1 dateTime Starting time with inclusive boundary
.... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... 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
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:location 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: location additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... reason 0..* Coding ​Reason the activity is occurring
Binding: PurposeOfUse|2014-03-26 (extensible): The reason the activity took place.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:authorization 0..* (Complex) R5: Authorization (purposeOfUse) related to the event additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.authorization
.... system Σ 0..1 uri Identity of the terminology system
.... version Σ 0..1 string Version of the system - if relevant
.... code Σ 0..1 code Symbol in syntax defined by the system
.... display Σ 0..1 string Representation defined by the system
.... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... activity 0..1 Coding Activity that occurred
Binding: ProvenanceActivityType . (extensible): The activity that took place.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:activity 0..1 CodeableConcept R5: activity additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.activity
Binding: R5ProvenanceActivityTypeForR3 (0.1.0) (example): The activity that took place.
.... system Σ 0..1 uri Identity of the terminology system
.... version Σ 0..1 string Version of the system - if relevant
.... code Σ 0..1 code Symbol in syntax defined by the system
.... display Σ 0..1 string Representation defined by the system
.... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... agent 1..* BackboneElement Actor involved
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... role Σ 0..* CodeableConcept What the agents role was
Binding: SecurityRoleType . (extensible): The role that a provenance agent played with respect to the activity.
.... who[x] Σ 1..1 Who participated
..... who[x]All Types Content/Rules for all Types
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:alternateReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: The agent that participated in the event
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... whoUri uri
..... whoReference Reference(Practitioner | RelatedPerson | Patient | Device | Organization)
.... onBehalfOf[x] 0..1 Who the agent is representing
..... onBehalfOf[x]All Types Content/Rules for all Types
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:alternateReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: The agent that delegated
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... onBehalfOfUri uri
..... onBehalfOfReference Reference(Practitioner | RelatedPerson | Patient | Device | Organization)
.... relatedAgentType 0..1 CodeableConcept ​Type of relationship between agents
Binding: RoleLinkType|2016-11-11 (example): Type of relationship between two provenance agents.
... entity 0..* BackboneElement An entity used in this activity
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... 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
...... extension:role 0..1 code R5: revision | quotation | source | instantiates | removal
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Provenance.entity.role
Binding: R5ProvenanceEntityRoleForR3 (0.1.0) (required): How an entity was used in an activity.
..... value 0..1 code Primitive value for code
.... what[x] Σ 1..1 Identity of entity
..... what[x]All Types Content/Rules for all Types
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:alternateReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: what additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... whatUri uri
..... whatReference Reference(Resource)
..... whatIdentifier Identifier
.... 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 extensible Common Languages . 📍3.0.2 tx.fhir.org
Provenance.reason Base extensible PurposeOfUse 📍2014-03-26 FHIR Std.
Provenance.activity Base extensible ProvenanceActivityType . 📍1.1.0 tx.fhir.org
Provenance.agent.role Base extensible SecurityRoleType . 📍1.8.0 tx.fhir.org
Provenance.agent.relatedAgentType Base example v3 Code System RoleLinkType 📍2016-11-11 FHIR Std.
Provenance.entity.role Base required ProvenanceEntityRole . 📍3.0.2 tx.fhir.org

Constraints

Id Grade Path(s) Description Expression
dom-1 error Provenance If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron