PACIO Advance Healthcare Directive Interoperability Implementation Guide
2.0.0 - STU 2 – Ballot United States of America flag

PACIO Advance Healthcare Directive Interoperability Implementation Guide, published by HL7 International / Patient Empowerment. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-pacio-adi/ and changes regularly. See the Directory of published versions

Resource Profile: ADI Provenance

Official URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-Provenance Version: 2.0.0
Standards status: Trial-use Computable Name: ADIProvenance
Other Identifiers: OID:2.16.840.1.113883.4.642.40.68.42.34

Information-sharing provenance for use in 2 scenarios: 1) finding out who retrieved the ADI information when captured and 2) who fetched and sent the provenance information associated with advance directive interoperability data.

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: doco
Provenance 0..* USCoreProvenance US Core Provenance
Provenance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Provenance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Provenance.target This element must be supported. This element is included in summaries. 1..* Reference(ADI PMO Composition) The Resource this Provenance record supports
Provenance.target.reference This element must be supported. This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Provenance.recorded This element must be supported. This element is included in summaries. 1..1 instant Timestamp when the activity was recorded / updated
Provenance.Slices for agent This element must be supported. C 1..* BackboneElement Actor involved
Slice: Unordered, Open by value:type
Constraints: provenance-1

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Provenance.Slices for agent.agent:All Slices Content/Rules for all slices
Provenance.Slices for agent.agent:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.Slices for agent.agent:All Slices.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (1.0.1) (extensible)
Provenance.Slices for agent.agent:All Slices.role 0..* CodeableConcept What the agents role was
Binding: Hl7VSDegreeLicenseCertificate (3.0.0) (extensible)
Provenance.Slices for agent.agent:All Slices.who This element must be supported. This element is included in summaries. 1..1 Reference(US Core Organization Profile This type must be supported. | US Core Practitioner Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | US Core Device Profile) Who participated
Provenance.Slices for agent.agent:All Slices.onBehalfOf This element must be supported. 0..1 Reference(US Core Organization Profile) Who the agent is representing
Provenance.Slices for agent.agent:ProvenanceAuthor This element must be supported. 0..* BackboneElement Actor involved
Provenance.Slices for agent.agent:ProvenanceAuthor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.Slices for agent.agent:ProvenanceAuthor.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (1.0.1) (extensible)
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
      "code" : "author"
    }
  ]
}
Provenance.Slices for agent.agent:ProvenanceAuthor.role 0..* CodeableConcept What the agents role was
Binding: Hl7VSDegreeLicenseCertificate (3.0.0) (extensible)
Provenance.Slices for agent.agent:ProvenanceAuthor.who This element must be supported. This element is included in summaries. 1..1 Reference(US Core Organization Profile This type must be supported. | US Core Practitioner Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | US Core Device Profile) Who participated
Provenance.Slices for agent.agent:ProvenanceAuthor.onBehalfOf This element must be supported. 0..1 Reference(US Core Organization Profile) Who the agent is representing
Provenance.Slices for agent.agent:ProvenanceTransmitter This element must be supported. 0..* BackboneElement Actor involved
Provenance.Slices for agent.agent:ProvenanceTransmitter.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.Slices for agent.agent:ProvenanceTransmitter.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (1.0.1) (extensible)
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
      "code" : "transmitter"
    }
  ]
}
Provenance.Slices for agent.agent:ProvenanceTransmitter.role 0..* CodeableConcept What the agents role was
Binding: Hl7VSDegreeLicenseCertificate (3.0.0) (extensible)
Provenance.Slices for agent.agent:ProvenanceTransmitter.who This element must be supported. This element is included in summaries. 1..1 Reference(US Core Organization Profile This type must be supported. | US Core Practitioner Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | US Core Device Profile) Who participated
Provenance.Slices for agent.agent:ProvenanceTransmitter.onBehalfOf This element must be supported. 0..1 Reference(US Core Organization Profile) Who the agent is representing
Provenance.Slices for agent.agent:ProvenanceAssembler This element must be supported. 0..1 BackboneElement Indicates the name of the system used to assemble the person's original advance care planning information into a document for exchange.
Provenance.Slices for agent.agent:ProvenanceAssembler.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.Slices for agent.agent:ProvenanceAssembler.type This element is included in summaries. 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
      "version" : "1.1.0|1.0.0",
      "code" : "assembler"
    }
  ]
}
Provenance.Slices for agent.agent:ProvenanceAssembler.who This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who participated
Provenance.Slices for agent.agent:ProvenanceAssembler.onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
Provenance.signature This element must be supported. 0..1 Signature Signature on target

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Provenance.agent.type Base extensible Provenance participant type 📍1.0.1 THO v7.4
Provenance.agent.role Base extensible hl7VS-degreeLicenseCertificate 📍3.0.0 THO v7.4
Provenance.agent:ProvenanceAuthor.​type Base extensible Provenance participant type 📍1.0.1 THO v7.4
Provenance.agent:ProvenanceAuthor.​role Base extensible hl7VS-degreeLicenseCertificate 📍3.0.0 THO v7.4
Provenance.agent:ProvenanceTransmitter.​type Base extensible Provenance participant type 📍1.0.1 THO v7.4
Provenance.agent:ProvenanceTransmitter.​role Base extensible hl7VS-degreeLicenseCertificate 📍3.0.0 THO v7.4
Provenance.agent:ProvenanceAssembler.​type Base extensible Provenance participant type 📍4.0.1 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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Provenance If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Provenance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Provenance A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
provenance-1 error Provenance.agent onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device who.exists((resolve() is Practitioner) or (resolve() is Device)) implies onBehalfOf.exists()

This structure is derived from USCoreProvenance

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Provenance 0..* USCoreProvenance US Core Provenance
Provenance.target 1..* Reference(ADI PMO Composition) The Resource this Provenance record supports
Provenance.agent 1..* BackboneElement Actor involved
Provenance.agent.role 0..* CodeableConcept What the agents role was
Binding: Hl7VSDegreeLicenseCertificate (3.0.0) (extensible)
Provenance.Slices for agent Content/Rules for all slices
Provenance.Slices for agent.agent:ProvenanceAuthor 0..* BackboneElement Actor involved
Provenance.Slices for agent.agent:ProvenanceAuthor.role 0..* CodeableConcept What the agents role was
Binding: Hl7VSDegreeLicenseCertificate (3.0.0) (extensible)
Provenance.Slices for agent.agent:ProvenanceTransmitter 0..* BackboneElement Actor involved
Provenance.Slices for agent.agent:ProvenanceTransmitter.role 0..* CodeableConcept What the agents role was
Binding: Hl7VSDegreeLicenseCertificate (3.0.0) (extensible)
Provenance.Slices for agent.agent:ProvenanceAssembler This element must be supported. 0..1 BackboneElement Indicates the name of the system used to assemble the person's original advance care planning information into a document for exchange.
Provenance.Slices for agent.agent:ProvenanceAssembler.type 1..1 CodeableConcept How the agent participated
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
      "version" : "1.1.0|1.0.0",
      "code" : "assembler"
    }
  ]
}

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Provenance.agent.role Base extensible hl7VS-degreeLicenseCertificate 📍3.0.0 THO v7.4
Provenance.agent:ProvenanceAuthor.​role Base extensible hl7VS-degreeLicenseCertificate 📍3.0.0 THO v7.4
Provenance.agent:ProvenanceTransmitter.​role Base extensible hl7VS-degreeLicenseCertificate 📍3.0.0 THO v7.4
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Provenance 0..* USCoreProvenance US Core Provenance
Provenance.id This element is included in summaries. 0..1 id Logical id of this artifact
Provenance.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Provenance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Provenance.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Provenance.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
Provenance.contained 0..* Resource Contained, inline Resources
Provenance.extension 0..* Extension Additional content defined by implementations
Provenance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Provenance.target This element must be supported. This element is included in summaries. 1..* Reference(ADI PMO Composition) The Resource this Provenance record supports
Provenance.target.id 0..1 string Unique id for inter-element referencing
Provenance.target.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Provenance.target.reference This element must be supported. This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Provenance.target.type This element is included in summaries. 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).
Provenance.target.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
Provenance.target.display This element is included in summaries. 0..1 string Text alternative for the resource
Provenance.occurred[x] 0..1 When the activity occurred
Provenance.occurred[x].occurredPeriod Period
Provenance.occurred[x].occurredDateTime dateTime
Provenance.recorded This element must be supported. This element is included in summaries. 1..1 instant Timestamp when the activity was recorded / updated
Provenance.policy 0..* uri Policy or plan the activity was defined by
Provenance.location 0..1 Reference(Location) Where the activity occurred, if relevant
Provenance.reason 0..* CodeableConcept Reason the activity is occurring
Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
Provenance.activity 0..1 CodeableConcept Activity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.
Provenance.Slices for agent This element must be supported. C 1..* BackboneElement Actor involved
Slice: Unordered, Open by value:type
Constraints: provenance-1

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Provenance.Slices for agent.agent:All Slices Content/Rules for all slices
Provenance.Slices for agent.agent:All Slices.id 0..1 string Unique id for inter-element referencing
Provenance.Slices for agent.agent:All Slices.extension 0..* Extension Additional content defined by implementations
Provenance.Slices for agent.agent:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.Slices for agent.agent:All Slices.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (1.0.1) (extensible)
Provenance.Slices for agent.agent:All Slices.role 0..* CodeableConcept What the agents role was
Binding: Hl7VSDegreeLicenseCertificate (3.0.0) (extensible)
Provenance.Slices for agent.agent:All Slices.who This element must be supported. This element is included in summaries. 1..1 Reference(US Core Organization Profile This type must be supported. | US Core Practitioner Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | US Core Device Profile) Who participated
Provenance.Slices for agent.agent:All Slices.onBehalfOf This element must be supported. 0..1 Reference(US Core Organization Profile) Who the agent is representing
Provenance.Slices for agent.agent:ProvenanceAuthor This element must be supported. 0..* BackboneElement Actor involved
Provenance.Slices for agent.agent:ProvenanceAuthor.id 0..1 string Unique id for inter-element referencing
Provenance.Slices for agent.agent:ProvenanceAuthor.extension 0..* Extension Additional content defined by implementations
Provenance.Slices for agent.agent:ProvenanceAuthor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.Slices for agent.agent:ProvenanceAuthor.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (1.0.1) (extensible)
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
      "code" : "author"
    }
  ]
}
Provenance.Slices for agent.agent:ProvenanceAuthor.role 0..* CodeableConcept What the agents role was
Binding: Hl7VSDegreeLicenseCertificate (3.0.0) (extensible)
Provenance.Slices for agent.agent:ProvenanceAuthor.who This element must be supported. This element is included in summaries. 1..1 Reference(US Core Organization Profile This type must be supported. | US Core Practitioner Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | US Core Device Profile) Who participated
Provenance.Slices for agent.agent:ProvenanceAuthor.onBehalfOf This element must be supported. 0..1 Reference(US Core Organization Profile) Who the agent is representing
Provenance.Slices for agent.agent:ProvenanceTransmitter This element must be supported. 0..* BackboneElement Actor involved
Provenance.Slices for agent.agent:ProvenanceTransmitter.id 0..1 string Unique id for inter-element referencing
Provenance.Slices for agent.agent:ProvenanceTransmitter.extension 0..* Extension Additional content defined by implementations
Provenance.Slices for agent.agent:ProvenanceTransmitter.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.Slices for agent.agent:ProvenanceTransmitter.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (1.0.1) (extensible)
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
      "code" : "transmitter"
    }
  ]
}
Provenance.Slices for agent.agent:ProvenanceTransmitter.role 0..* CodeableConcept What the agents role was
Binding: Hl7VSDegreeLicenseCertificate (3.0.0) (extensible)
Provenance.Slices for agent.agent:ProvenanceTransmitter.who This element must be supported. This element is included in summaries. 1..1 Reference(US Core Organization Profile This type must be supported. | US Core Practitioner Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | US Core Device Profile) Who participated
Provenance.Slices for agent.agent:ProvenanceTransmitter.onBehalfOf This element must be supported. 0..1 Reference(US Core Organization Profile) Who the agent is representing
Provenance.Slices for agent.agent:ProvenanceAssembler This element must be supported. 0..1 BackboneElement Indicates the name of the system used to assemble the person's original advance care planning information into a document for exchange.
Provenance.Slices for agent.agent:ProvenanceAssembler.id 0..1 string Unique id for inter-element referencing
Provenance.Slices for agent.agent:ProvenanceAssembler.extension 0..* Extension Additional content defined by implementations
Provenance.Slices for agent.agent:ProvenanceAssembler.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.Slices for agent.agent:ProvenanceAssembler.type This element is included in summaries. 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
      "version" : "1.1.0|1.0.0",
      "code" : "assembler"
    }
  ]
}
Provenance.Slices for agent.agent:ProvenanceAssembler.role 0..* CodeableConcept What the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
Provenance.Slices for agent.agent:ProvenanceAssembler.who This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who participated
Provenance.Slices for agent.agent:ProvenanceAssembler.onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
Provenance.entity 0..* BackboneElement An entity used in this activity
Provenance.entity.id 0..1 string Unique id for inter-element referencing
Provenance.entity.extension 0..* Extension Additional content defined by implementations
Provenance.entity.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.entity.role This element is included in summaries. 1..1 code derivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.
Provenance.entity.what This element is included in summaries. 1..1 Reference(Resource) Identity of entity
Provenance.entity.agent 0..* See agent (Provenance) Entity is attributed to this agent
Provenance.signature This element must be supported. 0..1 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 FHIR Std.
Provenance.target.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Provenance.reason Base extensible PurposeOfUse 📍3.1.0 THO v7.4
Provenance.activity Base extensible Provenance activity type 📍4.0.1 FHIR Std.
Provenance.agent.type Base extensible Provenance participant type 📍1.0.1 THO v7.4
Provenance.agent.role Base extensible hl7VS-degreeLicenseCertificate 📍3.0.0 THO v7.4
Provenance.agent:ProvenanceAuthor.​type Base extensible Provenance participant type 📍1.0.1 THO v7.4
Provenance.agent:ProvenanceAuthor.​role Base extensible hl7VS-degreeLicenseCertificate 📍3.0.0 THO v7.4
Provenance.agent:ProvenanceTransmitter.​type Base extensible Provenance participant type 📍1.0.1 THO v7.4
Provenance.agent:ProvenanceTransmitter.​role Base extensible hl7VS-degreeLicenseCertificate 📍3.0.0 THO v7.4
Provenance.agent:ProvenanceAssembler.​type Base extensible Provenance participant type 📍4.0.1 FHIR Std.
Provenance.agent:ProvenanceAssembler.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
Provenance.entity.role Base required ProvenanceEntityRole 📍4.0.1 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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Provenance If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Provenance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Provenance A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
provenance-1 error Provenance.agent onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device who.exists((resolve() is Practitioner) or (resolve() is Device)) implies onBehalfOf.exists()

This structure is derived from USCoreProvenance

Summary

Mandatory: 0 element(1 nested mandatory element)
Must-Support: 2 elements

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Provenance 0..* USCoreProvenance US Core Provenance
Provenance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Provenance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Provenance.target This element must be supported. This element is included in summaries. 1..* Reference(ADI PMO Composition) The Resource this Provenance record supports
Provenance.target.reference This element must be supported. This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Provenance.recorded This element must be supported. This element is included in summaries. 1..1 instant Timestamp when the activity was recorded / updated
Provenance.Slices for agent This element must be supported. C 1..* BackboneElement Actor involved
Slice: Unordered, Open by value:type
Constraints: provenance-1

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Provenance.Slices for agent.agent:All Slices Content/Rules for all slices
Provenance.Slices for agent.agent:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.Slices for agent.agent:All Slices.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (1.0.1) (extensible)
Provenance.Slices for agent.agent:All Slices.role 0..* CodeableConcept What the agents role was
Binding: Hl7VSDegreeLicenseCertificate (3.0.0) (extensible)
Provenance.Slices for agent.agent:All Slices.who This element must be supported. This element is included in summaries. 1..1 Reference(US Core Organization Profile This type must be supported. | US Core Practitioner Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | US Core Device Profile) Who participated
Provenance.Slices for agent.agent:All Slices.onBehalfOf This element must be supported. 0..1 Reference(US Core Organization Profile) Who the agent is representing
Provenance.Slices for agent.agent:ProvenanceAuthor This element must be supported. 0..* BackboneElement Actor involved
Provenance.Slices for agent.agent:ProvenanceAuthor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.Slices for agent.agent:ProvenanceAuthor.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (1.0.1) (extensible)
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
      "code" : "author"
    }
  ]
}
Provenance.Slices for agent.agent:ProvenanceAuthor.role 0..* CodeableConcept What the agents role was
Binding: Hl7VSDegreeLicenseCertificate (3.0.0) (extensible)
Provenance.Slices for agent.agent:ProvenanceAuthor.who This element must be supported. This element is included in summaries. 1..1 Reference(US Core Organization Profile This type must be supported. | US Core Practitioner Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | US Core Device Profile) Who participated
Provenance.Slices for agent.agent:ProvenanceAuthor.onBehalfOf This element must be supported. 0..1 Reference(US Core Organization Profile) Who the agent is representing
Provenance.Slices for agent.agent:ProvenanceTransmitter This element must be supported. 0..* BackboneElement Actor involved
Provenance.Slices for agent.agent:ProvenanceTransmitter.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.Slices for agent.agent:ProvenanceTransmitter.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (1.0.1) (extensible)
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
      "code" : "transmitter"
    }
  ]
}
Provenance.Slices for agent.agent:ProvenanceTransmitter.role 0..* CodeableConcept What the agents role was
Binding: Hl7VSDegreeLicenseCertificate (3.0.0) (extensible)
Provenance.Slices for agent.agent:ProvenanceTransmitter.who This element must be supported. This element is included in summaries. 1..1 Reference(US Core Organization Profile This type must be supported. | US Core Practitioner Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | US Core Device Profile) Who participated
Provenance.Slices for agent.agent:ProvenanceTransmitter.onBehalfOf This element must be supported. 0..1 Reference(US Core Organization Profile) Who the agent is representing
Provenance.Slices for agent.agent:ProvenanceAssembler This element must be supported. 0..1 BackboneElement Indicates the name of the system used to assemble the person's original advance care planning information into a document for exchange.
Provenance.Slices for agent.agent:ProvenanceAssembler.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.Slices for agent.agent:ProvenanceAssembler.type This element is included in summaries. 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
      "version" : "1.1.0|1.0.0",
      "code" : "assembler"
    }
  ]
}
Provenance.Slices for agent.agent:ProvenanceAssembler.who This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who participated
Provenance.Slices for agent.agent:ProvenanceAssembler.onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
Provenance.signature This element must be supported. 0..1 Signature Signature on target

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Provenance.agent.type Base extensible Provenance participant type 📍1.0.1 THO v7.4
Provenance.agent.role Base extensible hl7VS-degreeLicenseCertificate 📍3.0.0 THO v7.4
Provenance.agent:ProvenanceAuthor.​type Base extensible Provenance participant type 📍1.0.1 THO v7.4
Provenance.agent:ProvenanceAuthor.​role Base extensible hl7VS-degreeLicenseCertificate 📍3.0.0 THO v7.4
Provenance.agent:ProvenanceTransmitter.​type Base extensible Provenance participant type 📍1.0.1 THO v7.4
Provenance.agent:ProvenanceTransmitter.​role Base extensible hl7VS-degreeLicenseCertificate 📍3.0.0 THO v7.4
Provenance.agent:ProvenanceAssembler.​type Base extensible Provenance participant type 📍4.0.1 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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Provenance If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Provenance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Provenance A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
provenance-1 error Provenance.agent onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device who.exists((resolve() is Practitioner) or (resolve() is Device)) implies onBehalfOf.exists()

Differential View

This structure is derived from USCoreProvenance

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Provenance 0..* USCoreProvenance US Core Provenance
Provenance.target 1..* Reference(ADI PMO Composition) The Resource this Provenance record supports
Provenance.agent 1..* BackboneElement Actor involved
Provenance.agent.role 0..* CodeableConcept What the agents role was
Binding: Hl7VSDegreeLicenseCertificate (3.0.0) (extensible)
Provenance.Slices for agent Content/Rules for all slices
Provenance.Slices for agent.agent:ProvenanceAuthor 0..* BackboneElement Actor involved
Provenance.Slices for agent.agent:ProvenanceAuthor.role 0..* CodeableConcept What the agents role was
Binding: Hl7VSDegreeLicenseCertificate (3.0.0) (extensible)
Provenance.Slices for agent.agent:ProvenanceTransmitter 0..* BackboneElement Actor involved
Provenance.Slices for agent.agent:ProvenanceTransmitter.role 0..* CodeableConcept What the agents role was
Binding: Hl7VSDegreeLicenseCertificate (3.0.0) (extensible)
Provenance.Slices for agent.agent:ProvenanceAssembler This element must be supported. 0..1 BackboneElement Indicates the name of the system used to assemble the person's original advance care planning information into a document for exchange.
Provenance.Slices for agent.agent:ProvenanceAssembler.type 1..1 CodeableConcept How the agent participated
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
      "version" : "1.1.0|1.0.0",
      "code" : "assembler"
    }
  ]
}
Provenance.signature This element must be supported. 0..1 Signature Signature on target

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Provenance.agent.role Base extensible hl7VS-degreeLicenseCertificate 📍3.0.0 THO v7.4
Provenance.agent:ProvenanceAuthor.​role Base extensible hl7VS-degreeLicenseCertificate 📍3.0.0 THO v7.4
Provenance.agent:ProvenanceTransmitter.​role Base extensible hl7VS-degreeLicenseCertificate 📍3.0.0 THO v7.4

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Provenance 0..* USCoreProvenance US Core Provenance
Provenance.id This element is included in summaries. 0..1 id Logical id of this artifact
Provenance.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Provenance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Provenance.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Provenance.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
Provenance.contained 0..* Resource Contained, inline Resources
Provenance.extension 0..* Extension Additional content defined by implementations
Provenance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Provenance.target This element must be supported. This element is included in summaries. 1..* Reference(ADI PMO Composition) The Resource this Provenance record supports
Provenance.target.id 0..1 string Unique id for inter-element referencing
Provenance.target.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Provenance.target.reference This element must be supported. This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Provenance.target.type This element is included in summaries. 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).
Provenance.target.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
Provenance.target.display This element is included in summaries. 0..1 string Text alternative for the resource
Provenance.occurred[x] 0..1 When the activity occurred
Provenance.occurred[x].occurredPeriod Period
Provenance.occurred[x].occurredDateTime dateTime
Provenance.recorded This element must be supported. This element is included in summaries. 1..1 instant Timestamp when the activity was recorded / updated
Provenance.policy 0..* uri Policy or plan the activity was defined by
Provenance.location 0..1 Reference(Location) Where the activity occurred, if relevant
Provenance.reason 0..* CodeableConcept Reason the activity is occurring
Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
Provenance.activity 0..1 CodeableConcept Activity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.
Provenance.Slices for agent This element must be supported. C 1..* BackboneElement Actor involved
Slice: Unordered, Open by value:type
Constraints: provenance-1

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Provenance.Slices for agent.agent:All Slices Content/Rules for all slices
Provenance.Slices for agent.agent:All Slices.id 0..1 string Unique id for inter-element referencing
Provenance.Slices for agent.agent:All Slices.extension 0..* Extension Additional content defined by implementations
Provenance.Slices for agent.agent:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.Slices for agent.agent:All Slices.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (1.0.1) (extensible)
Provenance.Slices for agent.agent:All Slices.role 0..* CodeableConcept What the agents role was
Binding: Hl7VSDegreeLicenseCertificate (3.0.0) (extensible)
Provenance.Slices for agent.agent:All Slices.who This element must be supported. This element is included in summaries. 1..1 Reference(US Core Organization Profile This type must be supported. | US Core Practitioner Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | US Core Device Profile) Who participated
Provenance.Slices for agent.agent:All Slices.onBehalfOf This element must be supported. 0..1 Reference(US Core Organization Profile) Who the agent is representing
Provenance.Slices for agent.agent:ProvenanceAuthor This element must be supported. 0..* BackboneElement Actor involved
Provenance.Slices for agent.agent:ProvenanceAuthor.id 0..1 string Unique id for inter-element referencing
Provenance.Slices for agent.agent:ProvenanceAuthor.extension 0..* Extension Additional content defined by implementations
Provenance.Slices for agent.agent:ProvenanceAuthor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.Slices for agent.agent:ProvenanceAuthor.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (1.0.1) (extensible)
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
      "code" : "author"
    }
  ]
}
Provenance.Slices for agent.agent:ProvenanceAuthor.role 0..* CodeableConcept What the agents role was
Binding: Hl7VSDegreeLicenseCertificate (3.0.0) (extensible)
Provenance.Slices for agent.agent:ProvenanceAuthor.who This element must be supported. This element is included in summaries. 1..1 Reference(US Core Organization Profile This type must be supported. | US Core Practitioner Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | US Core Device Profile) Who participated
Provenance.Slices for agent.agent:ProvenanceAuthor.onBehalfOf This element must be supported. 0..1 Reference(US Core Organization Profile) Who the agent is representing
Provenance.Slices for agent.agent:ProvenanceTransmitter This element must be supported. 0..* BackboneElement Actor involved
Provenance.Slices for agent.agent:ProvenanceTransmitter.id 0..1 string Unique id for inter-element referencing
Provenance.Slices for agent.agent:ProvenanceTransmitter.extension 0..* Extension Additional content defined by implementations
Provenance.Slices for agent.agent:ProvenanceTransmitter.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.Slices for agent.agent:ProvenanceTransmitter.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (1.0.1) (extensible)
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
      "code" : "transmitter"
    }
  ]
}
Provenance.Slices for agent.agent:ProvenanceTransmitter.role 0..* CodeableConcept What the agents role was
Binding: Hl7VSDegreeLicenseCertificate (3.0.0) (extensible)
Provenance.Slices for agent.agent:ProvenanceTransmitter.who This element must be supported. This element is included in summaries. 1..1 Reference(US Core Organization Profile This type must be supported. | US Core Practitioner Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | US Core Device Profile) Who participated
Provenance.Slices for agent.agent:ProvenanceTransmitter.onBehalfOf This element must be supported. 0..1 Reference(US Core Organization Profile) Who the agent is representing
Provenance.Slices for agent.agent:ProvenanceAssembler This element must be supported. 0..1 BackboneElement Indicates the name of the system used to assemble the person's original advance care planning information into a document for exchange.
Provenance.Slices for agent.agent:ProvenanceAssembler.id 0..1 string Unique id for inter-element referencing
Provenance.Slices for agent.agent:ProvenanceAssembler.extension 0..* Extension Additional content defined by implementations
Provenance.Slices for agent.agent:ProvenanceAssembler.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.Slices for agent.agent:ProvenanceAssembler.type This element is included in summaries. 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
      "version" : "1.1.0|1.0.0",
      "code" : "assembler"
    }
  ]
}
Provenance.Slices for agent.agent:ProvenanceAssembler.role 0..* CodeableConcept What the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
Provenance.Slices for agent.agent:ProvenanceAssembler.who This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who participated
Provenance.Slices for agent.agent:ProvenanceAssembler.onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
Provenance.entity 0..* BackboneElement An entity used in this activity
Provenance.entity.id 0..1 string Unique id for inter-element referencing
Provenance.entity.extension 0..* Extension Additional content defined by implementations
Provenance.entity.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.entity.role This element is included in summaries. 1..1 code derivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.
Provenance.entity.what This element is included in summaries. 1..1 Reference(Resource) Identity of entity
Provenance.entity.agent 0..* See agent (Provenance) Entity is attributed to this agent
Provenance.signature This element must be supported. 0..1 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 FHIR Std.
Provenance.target.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Provenance.reason Base extensible PurposeOfUse 📍3.1.0 THO v7.4
Provenance.activity Base extensible Provenance activity type 📍4.0.1 FHIR Std.
Provenance.agent.type Base extensible Provenance participant type 📍1.0.1 THO v7.4
Provenance.agent.role Base extensible hl7VS-degreeLicenseCertificate 📍3.0.0 THO v7.4
Provenance.agent:ProvenanceAuthor.​type Base extensible Provenance participant type 📍1.0.1 THO v7.4
Provenance.agent:ProvenanceAuthor.​role Base extensible hl7VS-degreeLicenseCertificate 📍3.0.0 THO v7.4
Provenance.agent:ProvenanceTransmitter.​type Base extensible Provenance participant type 📍1.0.1 THO v7.4
Provenance.agent:ProvenanceTransmitter.​role Base extensible hl7VS-degreeLicenseCertificate 📍3.0.0 THO v7.4
Provenance.agent:ProvenanceAssembler.​type Base extensible Provenance participant type 📍4.0.1 FHIR Std.
Provenance.agent:ProvenanceAssembler.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
Provenance.entity.role Base required ProvenanceEntityRole 📍4.0.1 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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Provenance If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Provenance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Provenance A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
provenance-1 error Provenance.agent onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device who.exists((resolve() is Practitioner) or (resolve() is Device)) implies onBehalfOf.exists()

This structure is derived from USCoreProvenance

Summary

Mandatory: 0 element(1 nested mandatory element)
Must-Support: 2 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron