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

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

Resource Profile: Profile_R3_Provenance_R4B

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

This cross-version profile allows STU3 Provenance content to be represented via FHIR R4B Provenance resources.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

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.3.0) Who, What, When for a set of resources
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... target Σ 1..* Reference(Resource) Target Reference(s) (usually version specific)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:target 0..1 Reference(Resource) STU3: target additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
... agent 1..* BackboneElement Actor involved
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:relatedAgentType 0..1 CodeableConcept STU3: Type of relationship between agents (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.agent.relatedAgentType
Binding: R3V3RoleLinkTypeForR4B (0.1.0) (example): Type of relationship between two provenance agents.
Constraints: ext-1
.... 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 1..1 uri STU3: who additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.agent.who
Constraints: ext-1
...... extension:whoAlternateReference 0..1 Reference(Resource) STU3: who additional types
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.exists() and ('#'+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(uri) = '#').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.modifierExtension, Provenance.target, Provenance.target.extension, Provenance.target.extension:target, Provenance.recorded, Provenance.agent, Provenance.agent.extension, Provenance.agent.extension:relatedAgentType, Provenance.agent.modifierExtension, Provenance.agent.who, Provenance.agent.who.extension, Provenance.agent.who.extension:who, Provenance.agent.who.extension:whoAlternateReference All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Provenance.modifierExtension, Provenance.target.extension, Provenance.target.extension:target, Provenance.agent.extension, Provenance.agent.extension:relatedAgentType, Provenance.agent.modifierExtension, Provenance.agent.who.extension, Provenance.agent.who.extension:who, Provenance.agent.who.extension:whoAlternateReference 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.3.0) Who, What, When for a set of resources
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.text
... target
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:target 0..* Reference(Resource) STU3: target additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:location 0..1 Reference(Resource) STU3: location additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... agent
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:relatedAgentType 0..1 CodeableConcept STU3: Type of relationship between agents (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.agent.relatedAgentType
Binding: R3V3RoleLinkTypeForR4B (0.1.0) (example): Type of relationship between two provenance agents.
.... who
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:who 0..1 uri STU3: who additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.agent.who
...... extension:whoAlternateReference 0..1 Reference(Resource) STU3: who additional types
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 uri STU3: onBehalfOf additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.agent.onBehalfOf
...... extension:onBehalfOfAlternateReference 0..1 Reference(Resource) STU3: onBehalfOf additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... entity
.... what
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:what 0..1 uri, Identifier STU3: what additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.entity.what
...... extension:whatAlternateReference 0..1 Reference(Resource) STU3: what additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... signature
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:signature 0..* Signature STU3: signature additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.signature

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* Provenance(4.3.0) 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... target Σ 1..* Reference(Resource) Target Reference(s) (usually version specific)
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:target 0..1 Reference(Resource) STU3: target additional types
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)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... occurred[x] 0..1 When the activity occurred
.... occurredPeriod Period
.... occurredDateTime dateTime
... recorded Σ 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 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:location 0..1 Reference(Resource) STU3: location additional types
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)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... reason 0..* CodeableConcept Reason the activity is occurring
Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
... 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
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:relatedAgentType 0..1 CodeableConcept STU3: Type of relationship between agents (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.agent.relatedAgentType
Binding: R3V3RoleLinkTypeForR4B (0.1.0) (example): Type of relationship between two provenance agents.
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 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:who 1..1 uri STU3: who additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.agent.who
Constraints: ext-1
...... extension:whoAlternateReference 0..1 Reference(Resource) STU3: who additional types
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)
..... 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 id 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 uri STU3: onBehalfOf additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.agent.onBehalfOf
Constraints: ext-1
...... extension:onBehalfOfAlternateReference 0..1 Reference(Resource) STU3: onBehalfOf additional types
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)
..... 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.
.... what Σ 1..1 Reference(Resource) Identity of entity
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:what 1..1 uri, Identifier STU3: what additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.entity.what
Constraints: ext-1
...... extension:whatAlternateReference 0..1 Reference(Resource) STU3: what additional types
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)
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... agent 0..* See agent (Provenance) Entity is attributed to this agent
... signature 0..* Signature Signature on target
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:signature 0..* Signature STU3: signature additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.signature
Constraints: ext-1
.... type Σ 1..* Coding Indication of the reason the entity signed the object(s)
Binding: SignatureTypeCodes (preferred)
.... when Σ 1..1 instant When the signature was created
.... who Σ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who signed
.... onBehalfOf Σ 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) The party represented
.... targetFormat 0..1 code The technical format of the signed resources
Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
.... sigFormat 0..1 code The technical format of the signature
Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
.... data 0..1 base64Binary The actual signature content (XML DigSig. JWS, picture, etc.)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Provenance.meta.security Base extensible SecurityLabels 📍4.3.0 FHIR Std.
Provenance.meta.tag Base example Common Tags 📍4.3.0 FHIR Std.
Provenance.language Base preferred Common Languages 📍4.3.0 FHIR Std.
Provenance.text.status Base required NarrativeStatus 📍4.3.0 FHIR Std.
Provenance.target.type Base extensible ResourceType 📍4.3.0 FHIR Std.
Provenance.location.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
Provenance.reason Base extensible PurposeOfUse 📍3.1.0 THO v7.1
Provenance.activity Base extensible ProvenanceActivityType 📍4.3.0 FHIR Std.
Provenance.agent.type Base extensible ProvenanceParticipantType 📍4.3.0 FHIR Std.
Provenance.agent.role Base example SecurityRoleType 📍4.3.0 FHIR Std.
Provenance.agent.who.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
Provenance.agent.onBehalfOf.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
Provenance.entity.role Base required ProvenanceEntityRole 📍4.3.0 FHIR Std.
Provenance.entity.what.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
Provenance.signature.​type Base preferred Signature Type Codes 📍4.3.0 FHIR Std.
Provenance.signature.​targetFormat Base required MimeType 📍4.3.0 FHIR Std.
Provenance.signature.​sigFormat Base required MimeType 📍4.3.0 FHIR Std.

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.exists() and ('#'+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(uri) = '#').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()
dom-r4b warning Provenance.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error Provenance.meta, Provenance.meta.extension, Provenance.meta.extension:meta, Provenance.meta.versionId, Provenance.meta.lastUpdated, Provenance.meta.source, Provenance.meta.profile, Provenance.meta.security, Provenance.meta.tag, Provenance.implicitRules, Provenance.language, Provenance.text, Provenance.text.extension, Provenance.text.extension:text, Provenance.text.status, Provenance.text.div, Provenance.extension, Provenance.modifierExtension, Provenance.target, Provenance.target.extension, Provenance.target.extension:target, Provenance.target.reference, Provenance.target.type, Provenance.target.identifier, Provenance.target.display, Provenance.occurred[x], Provenance.recorded, Provenance.policy, Provenance.location, Provenance.location.extension, Provenance.location.extension:location, Provenance.location.reference, Provenance.location.type, Provenance.location.identifier, Provenance.location.display, Provenance.reason, Provenance.activity, Provenance.agent, Provenance.agent.extension, Provenance.agent.extension:relatedAgentType, Provenance.agent.modifierExtension, Provenance.agent.type, Provenance.agent.role, Provenance.agent.who, Provenance.agent.who.extension, Provenance.agent.who.extension:who, Provenance.agent.who.extension:whoAlternateReference, 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.extension:onBehalfOfAlternateReference, 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.what, Provenance.entity.what.extension, Provenance.entity.what.extension:what, Provenance.entity.what.extension:whatAlternateReference, Provenance.entity.what.reference, Provenance.entity.what.type, Provenance.entity.what.identifier, Provenance.entity.what.display, Provenance.entity.agent, Provenance.signature, Provenance.signature.extension, Provenance.signature.extension:signature, Provenance.signature.type, Provenance.signature.when, Provenance.signature.who, Provenance.signature.onBehalfOf, Provenance.signature.targetFormat, Provenance.signature.sigFormat, Provenance.signature.data All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Provenance.meta.extension, Provenance.meta.extension:meta, Provenance.text.extension, Provenance.text.extension:text, Provenance.extension, Provenance.modifierExtension, Provenance.target.extension, Provenance.target.extension:target, Provenance.location.extension, Provenance.location.extension:location, Provenance.agent.extension, Provenance.agent.extension:relatedAgentType, Provenance.agent.modifierExtension, Provenance.agent.who.extension, Provenance.agent.who.extension:who, Provenance.agent.who.extension:whoAlternateReference, Provenance.agent.onBehalfOf.extension, Provenance.agent.onBehalfOf.extension:onBehalfOf, Provenance.agent.onBehalfOf.extension:onBehalfOfAlternateReference, Provenance.entity.extension, Provenance.entity.modifierExtension, Provenance.entity.what.extension, Provenance.entity.what.extension:what, Provenance.entity.what.extension:whatAlternateReference, Provenance.signature.extension, Provenance.signature.extension:signature Must have either extensions or value[x], not both extension.exists() != value.exists()
txt-1 error Provenance.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Provenance.text.div The narrative SHALL have some non-whitespace content htmlChecks()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* Provenance(4.3.0) Who, What, When for a set of resources
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... target Σ 1..* Reference(Resource) Target Reference(s) (usually version specific)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:target 0..1 Reference(Resource) STU3: target additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
... agent 1..* BackboneElement Actor involved
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:relatedAgentType 0..1 CodeableConcept STU3: Type of relationship between agents (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.agent.relatedAgentType
Binding: R3V3RoleLinkTypeForR4B (0.1.0) (example): Type of relationship between two provenance agents.
Constraints: ext-1
.... 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 1..1 uri STU3: who additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.agent.who
Constraints: ext-1
...... extension:whoAlternateReference 0..1 Reference(Resource) STU3: who additional types
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.exists() and ('#'+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(uri) = '#').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.modifierExtension, Provenance.target, Provenance.target.extension, Provenance.target.extension:target, Provenance.recorded, Provenance.agent, Provenance.agent.extension, Provenance.agent.extension:relatedAgentType, Provenance.agent.modifierExtension, Provenance.agent.who, Provenance.agent.who.extension, Provenance.agent.who.extension:who, Provenance.agent.who.extension:whoAlternateReference All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Provenance.modifierExtension, Provenance.target.extension, Provenance.target.extension:target, Provenance.agent.extension, Provenance.agent.extension:relatedAgentType, Provenance.agent.modifierExtension, Provenance.agent.who.extension, Provenance.agent.who.extension:who, Provenance.agent.who.extension:whoAlternateReference 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.3.0) Who, What, When for a set of resources
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.text
... target
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:target 0..* Reference(Resource) STU3: target additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:location 0..1 Reference(Resource) STU3: location additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... agent
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:relatedAgentType 0..1 CodeableConcept STU3: Type of relationship between agents (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.agent.relatedAgentType
Binding: R3V3RoleLinkTypeForR4B (0.1.0) (example): Type of relationship between two provenance agents.
.... who
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:who 0..1 uri STU3: who additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.agent.who
...... extension:whoAlternateReference 0..1 Reference(Resource) STU3: who additional types
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 uri STU3: onBehalfOf additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.agent.onBehalfOf
...... extension:onBehalfOfAlternateReference 0..1 Reference(Resource) STU3: onBehalfOf additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... entity
.... what
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:what 0..1 uri, Identifier STU3: what additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.entity.what
...... extension:whatAlternateReference 0..1 Reference(Resource) STU3: what additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... signature
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:signature 0..* Signature STU3: signature additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.signature

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* Provenance(4.3.0) 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... target Σ 1..* Reference(Resource) Target Reference(s) (usually version specific)
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:target 0..1 Reference(Resource) STU3: target additional types
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)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... occurred[x] 0..1 When the activity occurred
.... occurredPeriod Period
.... occurredDateTime dateTime
... recorded Σ 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 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:location 0..1 Reference(Resource) STU3: location additional types
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)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... reason 0..* CodeableConcept Reason the activity is occurring
Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
... 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
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:relatedAgentType 0..1 CodeableConcept STU3: Type of relationship between agents (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.agent.relatedAgentType
Binding: R3V3RoleLinkTypeForR4B (0.1.0) (example): Type of relationship between two provenance agents.
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 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:who 1..1 uri STU3: who additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.agent.who
Constraints: ext-1
...... extension:whoAlternateReference 0..1 Reference(Resource) STU3: who additional types
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)
..... 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 id 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 uri STU3: onBehalfOf additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.agent.onBehalfOf
Constraints: ext-1
...... extension:onBehalfOfAlternateReference 0..1 Reference(Resource) STU3: onBehalfOf additional types
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)
..... 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.
.... what Σ 1..1 Reference(Resource) Identity of entity
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:what 1..1 uri, Identifier STU3: what additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.entity.what
Constraints: ext-1
...... extension:whatAlternateReference 0..1 Reference(Resource) STU3: what additional types
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)
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... agent 0..* See agent (Provenance) Entity is attributed to this agent
... signature 0..* Signature Signature on target
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:signature 0..* Signature STU3: signature additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Provenance.signature
Constraints: ext-1
.... type Σ 1..* Coding Indication of the reason the entity signed the object(s)
Binding: SignatureTypeCodes (preferred)
.... when Σ 1..1 instant When the signature was created
.... who Σ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who signed
.... onBehalfOf Σ 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) The party represented
.... targetFormat 0..1 code The technical format of the signed resources
Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
.... sigFormat 0..1 code The technical format of the signature
Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
.... data 0..1 base64Binary The actual signature content (XML DigSig. JWS, picture, etc.)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Provenance.meta.security Base extensible SecurityLabels 📍4.3.0 FHIR Std.
Provenance.meta.tag Base example Common Tags 📍4.3.0 FHIR Std.
Provenance.language Base preferred Common Languages 📍4.3.0 FHIR Std.
Provenance.text.status Base required NarrativeStatus 📍4.3.0 FHIR Std.
Provenance.target.type Base extensible ResourceType 📍4.3.0 FHIR Std.
Provenance.location.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
Provenance.reason Base extensible PurposeOfUse 📍3.1.0 THO v7.1
Provenance.activity Base extensible ProvenanceActivityType 📍4.3.0 FHIR Std.
Provenance.agent.type Base extensible ProvenanceParticipantType 📍4.3.0 FHIR Std.
Provenance.agent.role Base example SecurityRoleType 📍4.3.0 FHIR Std.
Provenance.agent.who.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
Provenance.agent.onBehalfOf.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
Provenance.entity.role Base required ProvenanceEntityRole 📍4.3.0 FHIR Std.
Provenance.entity.what.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
Provenance.signature.​type Base preferred Signature Type Codes 📍4.3.0 FHIR Std.
Provenance.signature.​targetFormat Base required MimeType 📍4.3.0 FHIR Std.
Provenance.signature.​sigFormat Base required MimeType 📍4.3.0 FHIR Std.

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.exists() and ('#'+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(uri) = '#').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()
dom-r4b warning Provenance.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error Provenance.meta, Provenance.meta.extension, Provenance.meta.extension:meta, Provenance.meta.versionId, Provenance.meta.lastUpdated, Provenance.meta.source, Provenance.meta.profile, Provenance.meta.security, Provenance.meta.tag, Provenance.implicitRules, Provenance.language, Provenance.text, Provenance.text.extension, Provenance.text.extension:text, Provenance.text.status, Provenance.text.div, Provenance.extension, Provenance.modifierExtension, Provenance.target, Provenance.target.extension, Provenance.target.extension:target, Provenance.target.reference, Provenance.target.type, Provenance.target.identifier, Provenance.target.display, Provenance.occurred[x], Provenance.recorded, Provenance.policy, Provenance.location, Provenance.location.extension, Provenance.location.extension:location, Provenance.location.reference, Provenance.location.type, Provenance.location.identifier, Provenance.location.display, Provenance.reason, Provenance.activity, Provenance.agent, Provenance.agent.extension, Provenance.agent.extension:relatedAgentType, Provenance.agent.modifierExtension, Provenance.agent.type, Provenance.agent.role, Provenance.agent.who, Provenance.agent.who.extension, Provenance.agent.who.extension:who, Provenance.agent.who.extension:whoAlternateReference, 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.extension:onBehalfOfAlternateReference, 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.what, Provenance.entity.what.extension, Provenance.entity.what.extension:what, Provenance.entity.what.extension:whatAlternateReference, Provenance.entity.what.reference, Provenance.entity.what.type, Provenance.entity.what.identifier, Provenance.entity.what.display, Provenance.entity.agent, Provenance.signature, Provenance.signature.extension, Provenance.signature.extension:signature, Provenance.signature.type, Provenance.signature.when, Provenance.signature.who, Provenance.signature.onBehalfOf, Provenance.signature.targetFormat, Provenance.signature.sigFormat, Provenance.signature.data All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Provenance.meta.extension, Provenance.meta.extension:meta, Provenance.text.extension, Provenance.text.extension:text, Provenance.extension, Provenance.modifierExtension, Provenance.target.extension, Provenance.target.extension:target, Provenance.location.extension, Provenance.location.extension:location, Provenance.agent.extension, Provenance.agent.extension:relatedAgentType, Provenance.agent.modifierExtension, Provenance.agent.who.extension, Provenance.agent.who.extension:who, Provenance.agent.who.extension:whoAlternateReference, Provenance.agent.onBehalfOf.extension, Provenance.agent.onBehalfOf.extension:onBehalfOf, Provenance.agent.onBehalfOf.extension:onBehalfOfAlternateReference, Provenance.entity.extension, Provenance.entity.modifierExtension, Provenance.entity.what.extension, Provenance.entity.what.extension:what, Provenance.entity.what.extension:whatAlternateReference, Provenance.signature.extension, Provenance.signature.extension:signature Must have either extensions or value[x], not both extension.exists() != value.exists()
txt-1 error Provenance.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Provenance.text.div The narrative SHALL have some non-whitespace content htmlChecks()

 

Other representations of profile: CSV, Excel, Schematron