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-HealthcareAgent |
Version: | 0.0.1 |
Name: | PADIHealthcareAgent |
Title: | ADI Healthcare Agent |
Status: | Active as of 2021-06-04T15:56:50-07:00 |
Definition: | This profile represents a person's appointment of a healthcare agent. |
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-HealthcareAgent
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from RelatedPerson
Summary
Mandatory: 7 elements (2 nested mandatory elements)
Must-Support: 3 elements
Slices
This structure defines the following Slices:
This structure is derived from RelatedPerson
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 | |
text | 1..1 | Narrative | Text summary of the resource, for human interpretation | |
relationship | S | 1..* | (Slice Definition) | The nature of the relationship Slice: Unordered, Open by pattern:$this Binding: Healthcare Agent Relationships (extensible) |
relationship:heatlhcare_agent_or_proxy_role | S | 1..1 | CodeableConcept | The nature of the relationship Binding: Healthcare Agent or Proxy Choices (required) |
coding | 1..1 | Coding | Code defined by a terminology system | |
display | 1..1 | string | Representation defined by the system | |
relationship:personal_and_legal_relationship_role | S | 0..1 | CodeableConcept | The nature of the relationship Binding: Personal And Legal Relationship Role Type (required) |
coding | 1..1 | Coding | Code defined by a terminology system | |
display | 1..1 | string | Representation defined by the system | |
name | 1..1 | HumanName | A name associated with the person | |
telecom | 1..* | ContactPoint | A contact detail for the person | |
Documentation for this format |
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 | 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 | 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 | ?!Σ | 0..1 | boolean | Whether this related person's record is in active use |
patient | Σ | 1..1 | Reference(Patient) | The patient this person is related to |
relationship | SΣ | 1..* | (Slice Definition) | The nature of the relationship Slice: Unordered, Open by pattern:$this Binding: Healthcare Agent Relationships (extensible) |
relationship:heatlhcare_agent_or_proxy_role | SΣ | 1..1 | CodeableConcept | The nature of the relationship Binding: Healthcare Agent or Proxy Choices (required) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..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 |
relationship:personal_and_legal_relationship_role | SΣ | 0..1 | CodeableConcept | The nature of the relationship Binding: Personal And Legal Relationship Role Type (required) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..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 | Σ | 1..1 | HumanName | A name associated with the person |
telecom | Σ | 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 | Σ | 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) Max Binding: AllLanguages: A human language. | |
preferred | 0..1 | boolean | Language preference indicator | |
Documentation for this format |
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 | |
relationship | Σ | 1..* | (Slice Definition) | The nature of the relationship Slice: Unordered, Open by pattern:$this Binding: Healthcare Agent Relationships (extensible) |
relationship:heatlhcare_agent_or_proxy_role | Σ | 1..1 | CodeableConcept | The nature of the relationship Binding: Healthcare Agent or Proxy Choices (required) |
relationship:personal_and_legal_relationship_role | Σ | 0..1 | CodeableConcept | The nature of the relationship Binding: Personal And Legal Relationship Role Type (required) |
Documentation for this format |
This structure is derived from RelatedPerson
Summary
Mandatory: 7 elements (2 nested mandatory elements)
Must-Support: 3 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from RelatedPerson
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 | |
text | 1..1 | Narrative | Text summary of the resource, for human interpretation | |
relationship | S | 1..* | (Slice Definition) | The nature of the relationship Slice: Unordered, Open by pattern:$this Binding: Healthcare Agent Relationships (extensible) |
relationship:heatlhcare_agent_or_proxy_role | S | 1..1 | CodeableConcept | The nature of the relationship Binding: Healthcare Agent or Proxy Choices (required) |
coding | 1..1 | Coding | Code defined by a terminology system | |
display | 1..1 | string | Representation defined by the system | |
relationship:personal_and_legal_relationship_role | S | 0..1 | CodeableConcept | The nature of the relationship Binding: Personal And Legal Relationship Role Type (required) |
coding | 1..1 | Coding | Code defined by a terminology system | |
display | 1..1 | string | Representation defined by the system | |
name | 1..1 | HumanName | A name associated with the person | |
telecom | 1..* | ContactPoint | A contact detail for the person | |
Documentation for this format |
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 | 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 | 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 | ?!Σ | 0..1 | boolean | Whether this related person's record is in active use |
patient | Σ | 1..1 | Reference(Patient) | The patient this person is related to |
relationship | SΣ | 1..* | (Slice Definition) | The nature of the relationship Slice: Unordered, Open by pattern:$this Binding: Healthcare Agent Relationships (extensible) |
relationship:heatlhcare_agent_or_proxy_role | SΣ | 1..1 | CodeableConcept | The nature of the relationship Binding: Healthcare Agent or Proxy Choices (required) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..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 |
relationship:personal_and_legal_relationship_role | SΣ | 0..1 | CodeableConcept | The nature of the relationship Binding: Personal And Legal Relationship Role Type (required) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..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 | Σ | 1..1 | HumanName | A name associated with the person |
telecom | Σ | 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 | Σ | 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) Max Binding: AllLanguages: A human language. | |
preferred | 0..1 | boolean | Language preference indicator | |
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
RelatedPerson.language | preferred | CommonLanguages Max Binding: AllLanguages |
RelatedPerson.relationship | extensible | PADIHealthcareAgentRelationshipVS |
RelatedPerson.relationship:heatlhcare_agent_or_proxy_role | required | PADIHealthcareAgentOrProxyChoicesVS |
RelatedPerson.relationship:personal_and_legal_relationship_role | required | PADIPersonalAndLegalRelationshipRoleTypeVS |
RelatedPerson.gender | required | AdministrativeGender |
RelatedPerson.communication.language | preferred | CommonLanguages Max Binding: AllLanguages |