PACIO Advance Directive Interoperability Implementation Guide
2.1.0 - STU 2 United States of America flag

PACIO Advance 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.1.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.1.0
Active as of 2024-07-17 Computable Name: ADIProvenance

Advance Directive Interoperability Provenance based on US Core to capture, search and fetch provenance information associated with advance directive interoperability data.

Usage:

Formal Views of Profile Content

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

This structure is derived from USCoreProvenance

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..* USCoreProvenance US Core Provenance
... Slices for agent Content/Rules for all slices
.... agent:assembler S 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.
..... type 1..1 CodeableConcept (USCDI) How the agent participated
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
....... version 1..1 string Version of the system - if relevant
Fixed Value: 1.0.0
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: assembler

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..* USCoreProvenance US Core Provenance
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... target SΣ 1..* Reference(Resource) (USCDI) The Resource this Provenance record supports
.... reference SΣC 0..1 string (USCDI) Literal reference, Relative, internal or absolute URL
... Slices for agent SC 1..* BackboneElement (USCDI) Actor involved
Slice: Unordered, Open by pattern:type
provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
.... agent:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type SΣ 0..1 CodeableConcept (USCDI) How the agent participated
Binding: US Core Provenance Participant Type Codes (extensible)
..... who SΣ 1..1 Reference(US Core Organization Profile) (USCDI) Who participated
..... onBehalfOf S 0..1 Reference(US Core Organization Profile) (USCDI) Who the agent is representing
.... agent:ProvenanceAuthor S 0..* BackboneElement (USCDI) Actor involved
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type SΣ 1..1 CodeableConcept (USCDI) How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: author
..... who Σ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who participated
.... agent:ProvenanceTransmitter S 0..* BackboneElement (USCDI) Actor involved
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type SΣ 1..1 CodeableConcept (USCDI) How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: transmitter
..... who Σ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who participated
.... agent:assembler SC 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-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type SΣ 1..1 CodeableConcept (USCDI) How the agent participated
Binding: US Core Provenance Participant Type Codes (extensible)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
....... version 1..1 string Version of the system - if relevant
Fixed Value: 1.0.0
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: assembler
..... who SΣ 1..1 Reference(US Core Organization Profile) (USCDI) Who participated
..... onBehalfOf S 0..1 Reference(US Core Organization Profile) (USCDI) Who the agent is representing

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Provenance.agent.typeextensibleUSCoreProvenancePaticipantTypeCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type
Provenance.agent:ProvenanceAuthor.typeextensiblePattern: author
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.agent:ProvenanceTransmitter.typeextensiblePattern: transmitter
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.agent:assembler.typeextensiblePattern: assembler
http://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type

Constraints

IdGradePath(s)DetailsRequirements
provenance-1errorProvenance.agentonBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
: who.exists((resolve() is Practitioner) or (resolve() is Device)) implies onBehalfOf.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..* USCoreProvenance US Core Provenance
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... target SΣ 1..* Reference(Resource) (USCDI) The Resource this Provenance record supports
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 0..1 string (USCDI) Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... occurred[x] 0..1 When the activity occurred
.... occurredPeriod Period
.... occurredDateTime dateTime
... recorded SΣ 1..1 instant (USCDI) Timestamp when the activity was recorded / updated
... policy 0..* uri Policy or plan the activity was defined by
... location 0..1 Reference(Location) Where the activity occurred, if relevant
... reason 0..* CodeableConcept Reason the activity is occurring
Binding: PurposeOfUse (extensible): The reason the activity took place.


... activity 0..1 CodeableConcept Activity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.

... Slices for agent SC 1..* BackboneElement (USCDI) Actor involved
Slice: Unordered, Open by pattern:type
provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
.... agent:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type SΣ 0..1 CodeableConcept (USCDI) How the agent participated
Binding: US Core Provenance Participant Type Codes (extensible)
..... role 0..* CodeableConcept What the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


..... who SΣ 1..1 Reference(US Core Organization Profile S | US Core Practitioner Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | Device) (USCDI) Who participated
..... onBehalfOf S 0..1 Reference(US Core Organization Profile) (USCDI) Who the agent is representing
.... agent:ProvenanceAuthor S 0..* BackboneElement (USCDI) Actor involved
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type SΣ 1..1 CodeableConcept (USCDI) How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: author
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... 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
..... onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
.... agent:ProvenanceTransmitter S 0..* BackboneElement (USCDI) Actor involved
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type SΣ 1..1 CodeableConcept (USCDI) How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: transmitter
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... 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
..... onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
.... agent:assembler SC 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-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type SΣ 1..1 CodeableConcept (USCDI) How the agent participated
Binding: US Core Provenance Participant Type Codes (extensible)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
....... version 1..1 string Version of the system - if relevant
Fixed Value: 1.0.0
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: assembler
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... role 0..* CodeableConcept What the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


..... who SΣ 1..1 Reference(US Core Organization Profile S | US Core Practitioner Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | Device) (USCDI) Who participated
..... onBehalfOf S 0..1 Reference(US Core Organization Profile) (USCDI) Who the agent is representing
... 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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
.... agent 0..* See agent (Provenance) Entity is attributed to this agent
... signature 0..* Signature Signature on target

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Provenance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Provenance.target.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Provenance.reasonextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Provenance.activityextensibleProvenanceActivityType
http://hl7.org/fhir/ValueSet/provenance-activity-type
from the FHIR Standard
Provenance.agent.typeextensibleUSCoreProvenancePaticipantTypeCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type
Provenance.agent.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Provenance.agent:ProvenanceAuthor.typeextensiblePattern: author
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.agent:ProvenanceAuthor.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Provenance.agent:ProvenanceTransmitter.typeextensiblePattern: transmitter
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.agent:ProvenanceTransmitter.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Provenance.agent:assembler.typeextensiblePattern: assembler
http://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type
Provenance.agent:assembler.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Provenance.entity.rolerequiredProvenanceEntityRole
http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
provenance-1errorProvenance.agentonBehalfOf 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: 1 element

Differential View

This structure is derived from USCoreProvenance

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..* USCoreProvenance US Core Provenance
... Slices for agent Content/Rules for all slices
.... agent:assembler S 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.
..... type 1..1 CodeableConcept (USCDI) How the agent participated
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
....... version 1..1 string Version of the system - if relevant
Fixed Value: 1.0.0
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: assembler

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..* USCoreProvenance US Core Provenance
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... target SΣ 1..* Reference(Resource) (USCDI) The Resource this Provenance record supports
.... reference SΣC 0..1 string (USCDI) Literal reference, Relative, internal or absolute URL
... Slices for agent SC 1..* BackboneElement (USCDI) Actor involved
Slice: Unordered, Open by pattern:type
provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
.... agent:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type SΣ 0..1 CodeableConcept (USCDI) How the agent participated
Binding: US Core Provenance Participant Type Codes (extensible)
..... who SΣ 1..1 Reference(US Core Organization Profile) (USCDI) Who participated
..... onBehalfOf S 0..1 Reference(US Core Organization Profile) (USCDI) Who the agent is representing
.... agent:ProvenanceAuthor S 0..* BackboneElement (USCDI) Actor involved
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type SΣ 1..1 CodeableConcept (USCDI) How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: author
..... who Σ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who participated
.... agent:ProvenanceTransmitter S 0..* BackboneElement (USCDI) Actor involved
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type SΣ 1..1 CodeableConcept (USCDI) How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: transmitter
..... who Σ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who participated
.... agent:assembler SC 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-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type SΣ 1..1 CodeableConcept (USCDI) How the agent participated
Binding: US Core Provenance Participant Type Codes (extensible)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
....... version 1..1 string Version of the system - if relevant
Fixed Value: 1.0.0
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: assembler
..... who SΣ 1..1 Reference(US Core Organization Profile) (USCDI) Who participated
..... onBehalfOf S 0..1 Reference(US Core Organization Profile) (USCDI) Who the agent is representing

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Provenance.agent.typeextensibleUSCoreProvenancePaticipantTypeCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type
Provenance.agent:ProvenanceAuthor.typeextensiblePattern: author
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.agent:ProvenanceTransmitter.typeextensiblePattern: transmitter
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.agent:assembler.typeextensiblePattern: assembler
http://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type

Constraints

IdGradePath(s)DetailsRequirements
provenance-1errorProvenance.agentonBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
: who.exists((resolve() is Practitioner) or (resolve() is Device)) implies onBehalfOf.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..* USCoreProvenance US Core Provenance
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... target SΣ 1..* Reference(Resource) (USCDI) The Resource this Provenance record supports
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 0..1 string (USCDI) Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... occurred[x] 0..1 When the activity occurred
.... occurredPeriod Period
.... occurredDateTime dateTime
... recorded SΣ 1..1 instant (USCDI) Timestamp when the activity was recorded / updated
... policy 0..* uri Policy or plan the activity was defined by
... location 0..1 Reference(Location) Where the activity occurred, if relevant
... reason 0..* CodeableConcept Reason the activity is occurring
Binding: PurposeOfUse (extensible): The reason the activity took place.


... activity 0..1 CodeableConcept Activity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.

... Slices for agent SC 1..* BackboneElement (USCDI) Actor involved
Slice: Unordered, Open by pattern:type
provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
.... agent:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type SΣ 0..1 CodeableConcept (USCDI) How the agent participated
Binding: US Core Provenance Participant Type Codes (extensible)
..... role 0..* CodeableConcept What the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


..... who SΣ 1..1 Reference(US Core Organization Profile S | US Core Practitioner Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | Device) (USCDI) Who participated
..... onBehalfOf S 0..1 Reference(US Core Organization Profile) (USCDI) Who the agent is representing
.... agent:ProvenanceAuthor S 0..* BackboneElement (USCDI) Actor involved
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type SΣ 1..1 CodeableConcept (USCDI) How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: author
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... 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
..... onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
.... agent:ProvenanceTransmitter S 0..* BackboneElement (USCDI) Actor involved
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type SΣ 1..1 CodeableConcept (USCDI) How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: transmitter
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... 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
..... onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
.... agent:assembler SC 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-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type SΣ 1..1 CodeableConcept (USCDI) How the agent participated
Binding: US Core Provenance Participant Type Codes (extensible)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
....... version 1..1 string Version of the system - if relevant
Fixed Value: 1.0.0
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: assembler
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... role 0..* CodeableConcept What the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


..... who SΣ 1..1 Reference(US Core Organization Profile S | US Core Practitioner Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | Device) (USCDI) Who participated
..... onBehalfOf S 0..1 Reference(US Core Organization Profile) (USCDI) Who the agent is representing
... 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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
.... agent 0..* See agent (Provenance) Entity is attributed to this agent
... signature 0..* Signature Signature on target

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Provenance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Provenance.target.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Provenance.reasonextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Provenance.activityextensibleProvenanceActivityType
http://hl7.org/fhir/ValueSet/provenance-activity-type
from the FHIR Standard
Provenance.agent.typeextensibleUSCoreProvenancePaticipantTypeCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type
Provenance.agent.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Provenance.agent:ProvenanceAuthor.typeextensiblePattern: author
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.agent:ProvenanceAuthor.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Provenance.agent:ProvenanceTransmitter.typeextensiblePattern: transmitter
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.agent:ProvenanceTransmitter.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Provenance.agent:assembler.typeextensiblePattern: assembler
http://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type
Provenance.agent:assembler.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Provenance.entity.rolerequiredProvenanceEntityRole
http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
provenance-1errorProvenance.agentonBehalfOf 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: 1 element

 

Other representations of profile: CSV, Excel, Schematron