PACIO Advance Directive Interoperability Implementation Guide
2.1.0 - STU 2
PACIO Advance Directive Interoperability Implementation Guide
2.1.0 - STU 2
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
| Official URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-Witness | Version: 2.1.0 | |||
| Active as of 2024-12-30 | Computable Name: ADIWitness | |||
This profile represents a person participating as a witness for a person's advance directives.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  RelatedPerson |
0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
 text |
1..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| active |
?!SΣ | 0..1 | boolean | Whether this related person's record is in active use ele-1: All FHIR elements must have a @value or children |
 patient |
SΣ | 1..1 | Reference(US Core Patient Profile) | The patient this person is related to ele-1: All FHIR elements must have a @value or children |
  Slices for relationship |
SΣ | 1..* | CodeableConcept | The nature of the relationship Slice: Unordered, Open by pattern:$this Binding: PatientRelationshipType (extensible) ele-1: All FHIR elements must have a @value or children |
   relationship:witness |
SΣ | 1..1 | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. ele-1: All FHIR elements must have a @value or children 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/v3-ParticipationType | |
 code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: WIT | |
| name |
SΣ | 1..1 | HumanName | A name associated with the person ele-1: All FHIR elements must have a @value or children |
| telecom |
SΣ | 1..* | ContactPoint | A contact detail for the person ele-1: All FHIR elements must have a @value or children |
| address |
SΣ | 0..* | Address | Address where the related person can be contacted or visited ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| RelatedPerson.relationship | extensible | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptypefrom the FHIR Standard | |
| RelatedPerson.relationship:witness | preferred | Pattern: WIThttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptypefrom the FHIR Standard |
This structure is derived from RelatedPerson
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson |
RelatedPerson | |||
 text |
1..1 | Narrative | Text summary of the resource, for human interpretation | |
| active |
S | 0..1 | boolean | Whether this related person's record is in active use |
| patient |
S | 1..1 | Reference(US Core Patient Profile) | The patient this person is related to |
| Slices for relationship |
S | 1..* | CodeableConcept | The nature of the relationship Slice: Unordered, Open by pattern:$this Binding: PatientRelationshipType (extensible) |
| relationship:witness |
S | 1..1 | CodeableConcept | The nature of the relationship 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/v3-ParticipationType | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: WIT | |
| name |
S | 1..1 | HumanName | A name associated with the person |
| telecom |
S | 1..* | ContactPoint | A contact detail for the person |
| address |
S | 0..* | Address | Address where the related person can be contacted or visited |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| RelatedPerson.relationship | extensible | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptypefrom the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson |
0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |||||
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
1..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 | ||||
| identifier |
Σ | 0..* | Identifier | A human identifier for this person | ||||
| active |
?!SΣ | 0..1 | boolean | Whether this related person's record is in active use | ||||
| patient |
SΣ | 1..1 | Reference(US Core Patient Profile) | The patient this person is related to | ||||
| Slices for relationship |
SΣ | 1..* | CodeableConcept | The nature of the relationship Slice: Unordered, Open by pattern:$this Binding: PatientRelationshipType (extensible) | ||||
| relationship:witness |
SΣ | 1..1 | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. 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/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: WIT | |||||
| 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 | |||||
| name |
SΣ | 1..1 | HumanName | A name associated with the person | ||||
| telecom |
SΣ | 1..* | ContactPoint | A contact detail for the person | ||||
| gender |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate |
Σ | 0..1 | date | The date on which the related person was born | ||||
| address |
SΣ | 0..* | Address | Address where the related person can be contacted or visited | ||||
| photo |
0..* | Attachment | Image of the person | |||||
| period |
0..1 | Period | Period of time that this relationship is considered valid | |||||
 communication |
0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||
| 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 | ||||
| language |
1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
| preferred |
0..1 | boolean | Language preference indicator | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| RelatedPerson.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| RelatedPerson.relationship | extensible | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptypefrom the FHIR Standard | ||||
| RelatedPerson.relationship:witness | preferred | Pattern: WIThttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptypefrom the FHIR Standard | ||||
| RelatedPerson.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| RelatedPerson.communication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
|
This structure is derived from RelatedPerson
Summary
Mandatory: 5 elements
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson |
0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| text |
1..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| active |
?!SΣ | 0..1 | boolean | Whether this related person's record is in active use ele-1: All FHIR elements must have a @value or children |
| patient |
SΣ | 1..1 | Reference(US Core Patient Profile) | The patient this person is related to ele-1: All FHIR elements must have a @value or children |
| Slices for relationship |
SΣ | 1..* | CodeableConcept | The nature of the relationship Slice: Unordered, Open by pattern:$this Binding: PatientRelationshipType (extensible) ele-1: All FHIR elements must have a @value or children |
| relationship:witness |
SΣ | 1..1 | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. ele-1: All FHIR elements must have a @value or children 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/v3-ParticipationType | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: WIT | |
| name |
SΣ | 1..1 | HumanName | A name associated with the person ele-1: All FHIR elements must have a @value or children |
| telecom |
SΣ | 1..* | ContactPoint | A contact detail for the person ele-1: All FHIR elements must have a @value or children |
| address |
SΣ | 0..* | Address | Address where the related person can be contacted or visited ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| RelatedPerson.relationship | extensible | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptypefrom the FHIR Standard | |
| RelatedPerson.relationship:witness | preferred | Pattern: WIThttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptypefrom the FHIR Standard |
Differential View
This structure is derived from RelatedPerson
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson |
RelatedPerson | |||
| text |
1..1 | Narrative | Text summary of the resource, for human interpretation | |
| active |
S | 0..1 | boolean | Whether this related person's record is in active use |
| patient |
S | 1..1 | Reference(US Core Patient Profile) | The patient this person is related to |
| Slices for relationship |
S | 1..* | CodeableConcept | The nature of the relationship Slice: Unordered, Open by pattern:$this Binding: PatientRelationshipType (extensible) |
| relationship:witness |
S | 1..1 | CodeableConcept | The nature of the relationship 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/v3-ParticipationType | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: WIT | |
| name |
S | 1..1 | HumanName | A name associated with the person |
| telecom |
S | 1..* | ContactPoint | A contact detail for the person |
| address |
S | 0..* | Address | Address where the related person can be contacted or visited |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| RelatedPerson.relationship | extensible | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptypefrom the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson |
0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |||||
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
1..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 | ||||
| identifier |
Σ | 0..* | Identifier | A human identifier for this person | ||||
| active |
?!SΣ | 0..1 | boolean | Whether this related person's record is in active use | ||||
| patient |
SΣ | 1..1 | Reference(US Core Patient Profile) | The patient this person is related to | ||||
| Slices for relationship |
SΣ | 1..* | CodeableConcept | The nature of the relationship Slice: Unordered, Open by pattern:$this Binding: PatientRelationshipType (extensible) | ||||
| relationship:witness |
SΣ | 1..1 | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. 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/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: WIT | |||||
| 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 | |||||
| name |
SΣ | 1..1 | HumanName | A name associated with the person | ||||
| telecom |
SΣ | 1..* | ContactPoint | A contact detail for the person | ||||
| gender |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate |
Σ | 0..1 | date | The date on which the related person was born | ||||
| address |
SΣ | 0..* | Address | Address where the related person can be contacted or visited | ||||
| photo |
0..* | Attachment | Image of the person | |||||
| period |
0..1 | Period | Period of time that this relationship is considered valid | |||||
| communication |
0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||
| 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 | ||||
| language |
1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
| preferred |
0..1 | boolean | Language preference indicator | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| RelatedPerson.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| RelatedPerson.relationship | extensible | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptypefrom the FHIR Standard | ||||
| RelatedPerson.relationship:witness | preferred | Pattern: WIThttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptypefrom the FHIR Standard | ||||
| RelatedPerson.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| RelatedPerson.communication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
|
This structure is derived from RelatedPerson
Summary
Mandatory: 5 elements
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ HL7 International / Patient Empowerment. Package hl7.fhir.us.pacio-adi#2.1.0 based on FHIR 4.0.1. Generated 2024-12-30
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change