PACIO Advance Directive Interoperability Implementation Guide
0.0.1 - STU1
PACIO Advance Directive Interoperability Implementation Guide
0.0.1 - STU1
PACIO Advance Directive Interoperability Implementation Guide - Local Development build (v0.0.1). See the Directory of published versions
| Defining URL: | http://hl7.org/fhir/us/pacio-adi/StructureDefinition/PADI-Provenance |
| Version: | 0.0.1 |
| Name: | PADIProvenance |
| Title: | PACIO ADI Provenance |
| Status: | Active as of 2021-06-04T15:56:50-07:00 |
| Definition: | [TODO] Advance Directive Interoperability Provanance baed on US Core |
| Publisher: | HL7 Patient Empowerment Working Group |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/pacio-adi/StructureDefinition/PADI-Provenance
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreProvenance
This structure is derived from USCoreProvenance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Provenance | 0..* | USCoreProvenance | US Core Provenance | |
  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 | 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 | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: assembler | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Provenance | 0..* | USCoreProvenance | US Core Provenance | |
 id | Σ | 0..1 | string | 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 |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| 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) | The Resource this Provenance record supports |
  occurred[x] | 0..1 | When the activity occurred | ||
 occurredPeriod | Period | |||
| occurredDateTime | dateTime | |||
| recorded | SΣ | 1..1 | instant | 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. | |
 agent | S | 1..* | (Slice Definition) | Actor involved Slice: Unordered, Open by pattern:type |
 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 | 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 Practitioner Profile | US Core Patient Profile | US Core Organization Profile) | Who participated |
 onBehalfOf | SI | 0..1 | Reference(US Core Organization Profile) | Who the agent is representing provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device |
| agent:ProvenanceAuthor | S | 0..* | BackboneElement | 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 | 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..1 | BackboneElement | 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 | 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 | 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. |
| 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 | 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 | 0..1 | string | Version of the system - if relevant | |
| 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 Practitioner Profile | US Core Patient Profile | US Core Organization Profile) | Who participated |
| onBehalfOf | SI | 0..1 | Reference(US Core Organization Profile) | Who the agent is representing provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device |
| 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 | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Provenance | 0..* | USCoreProvenance | US Core Provenance | |
| target | Σ | 1..* | Reference(Resource) | The Resource this Provenance record supports |
| recorded | Σ | 1..1 | instant | Timestamp when the activity was recorded / updated |
| agent | 1..* | (Slice Definition) | Actor involved Slice: Unordered, Open by pattern:type | |
| agent:All Slices | Content/Rules for all slices | |||
| type | Σ | 0..1 | CodeableConcept | How the agent participated Binding: US Core Provenance Participant Type Codes (extensible) |
| who | Σ | 1..1 | Reference(US Core Practitioner Profile | US Core Patient Profile | US Core Organization Profile) | Who participated |
| onBehalfOf | I | 0..1 | Reference(US Core Organization Profile) | Who the agent is representing provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device |
| agent:ProvenanceAuthor | 0..* | BackboneElement | Actor involved | |
| type | Σ | 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: 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 | |
| agent:ProvenanceTransmitter | 0..1 | BackboneElement | Actor involved | |
| type | Σ | 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: 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 | |
| agent:assembler | 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 | 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 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: assembler | |
| who | Σ | 1..1 | Reference(US Core Practitioner Profile | US Core Patient Profile | US Core Organization Profile) | Who participated |
| onBehalfOf | I | 0..1 | Reference(US Core Organization Profile) | Who the agent is representing provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device |
| Documentation for this format | ||||
This structure is derived from USCoreProvenance
Differential View
This structure is derived from USCoreProvenance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Provenance | 0..* | USCoreProvenance | US Core Provenance | |
| 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 | 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 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: assembler | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Provenance | 0..* | USCoreProvenance | US Core Provenance | |
| id | Σ | 0..1 | string | 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 |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| 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) | The Resource this Provenance record supports |
| occurred[x] | 0..1 | When the activity occurred | ||
| occurredPeriod | Period | |||
| occurredDateTime | dateTime | |||
| recorded | SΣ | 1..1 | instant | 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. | |
| agent | S | 1..* | (Slice Definition) | Actor involved Slice: Unordered, Open by pattern:type |
| 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 | 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 Practitioner Profile | US Core Patient Profile | US Core Organization Profile) | Who participated |
| onBehalfOf | SI | 0..1 | Reference(US Core Organization Profile) | Who the agent is representing provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device |
| agent:ProvenanceAuthor | S | 0..* | BackboneElement | 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 | 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..1 | BackboneElement | 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 | 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 | 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. |
| 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 | 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 | 0..1 | string | Version of the system - if relevant | |
| 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 Practitioner Profile | US Core Patient Profile | US Core Organization Profile) | Who participated |
| onBehalfOf | SI | 0..1 | Reference(US Core Organization Profile) | Who the agent is representing provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device |
| 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 | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet / Code |
| Provenance.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Provenance.reason | extensible | PurposeOfUse |
| Provenance.activity | extensible | ProvenanceActivityType |
| Provenance.agent.type | extensible | USCoreProvenancePaticipantTypeCodes |
| Provenance.agent.role | example | SecurityRoleType |
| Provenance.agent:ProvenanceAuthor.type | extensible | Pattern: author |
| Provenance.agent:ProvenanceAuthor.role | example | SecurityRoleType |
| Provenance.agent:ProvenanceTransmitter.type | extensible | Pattern: transmitter |
| Provenance.agent:ProvenanceTransmitter.role | example | SecurityRoleType |
| Provenance.agent:assembler.type | extensible | Pattern: assembler |
| Provenance.agent:assembler.role | example | SecurityRoleType |
| Provenance.entity.role | required | ProvenanceEntityRole |
| Id | Path | Details | Requirements |
| provenance-1 | Provenance.agent.onBehalfOf | onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device : (($this.agent.who.resolve() is Practitioner) or ($this.agent.who.resolve() is Device)) implies exists() | |
| provenance-1 | Provenance.agent:assembler.onBehalfOf | onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device : (($this.agent.who.resolve() is Practitioner) or ($this.agent.who.resolve() is Device)) implies exists() |
IG © 2021+ HL7 Patient Empowerment Working Group. Package hl7.fhir.us.pacio-adi#0.0.1 based on FHIR 4.0.1. Generated 2021-06-04
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change