| Left: | ADI Document Reference (http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-DocumentReference) |
| Right: | ADI Document Reference (http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-DocumentReference) |
| Error | StructureDefinition.version | Values for version differ: '2.0.0-ballot' vs '2.0.0' |
| Information | StructureDefinition.date | Values for date differ: '2025-08-04T21:33:15+00:00' vs '2026-09-10T04:53:18+00:00' |
| Information | DocumentReference.language | Example/preferred bindings differ at DocumentReference.language using binding from ADIDocumentReference |
| Information | StructureDefinition.short | Values for short differ: 'Contained, inline Resources' vs 'Used to communicate the DocumentReference for a superseded document referenced in DocumentReference.relatesTo.target.' |
| Information | StructureDefinition.short | Values for short differ: 'Other identifiers for the document' vs 'Contains a specialized identifier for the setId used to identify a specific logical document.' |
| Information | StructureDefinition.short | Values for short differ: 'Who/what authenticated the document' vs 'The attester or authenticator of the advance directive.' |
| Information | StructureDefinition.comment | Values for comment differ: 'Represents a participant within the author institution who has legally authenticated or attested the document. Legal authentication implies that a document has been signed manually or electronically by the legal Authenticator.' vs 'This role is equivalent to the Composition.attester.party element.' |
| Warning | DocumentReference.authenticator | Elements differ in definition for mustSupport: 'true' vs 'false' |
| Information | StructureDefinition.short | Values for short differ: 'Human-readable description' vs 'the associated document title(s) in the description is a best practice that improves searchability.' |
| Information | DocumentReference.content.attachment.language | Example/preferred bindings differ at DocumentReference.content.attachment.language using binding from ADIDocumentReference |
| Information | StructureDefinition.short | Values for short differ: 'Context of the document content' vs 'An encounter where the associated document was considered relevant.' |
| Information | StructureDefinition.short | Values for short differ: 'Time of service that is being documented' vs 'the span of time that is relevant for the advance healthcare document' |
| Name | Value | Comments | |
|---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/us/core/StructureDefinition/us-core-adi-documentreference | ||
copyright | |||
date | 2025-08-04T21:33:15+00:00 | 2026-09-10T04:53:18+00:00 |
|
description | This profile defines constraints that represent the information needed to register an advance directive information document on a FHIR server. | This profile defines constraints that represent the information needed to register an advance healthcare directive document on a FHIR server. |
|
experimental | |||
fhirVersion | 4.0.1 | ||
jurisdiction | |||
![]() jurisdiction[0] | urn:iso:std:iso:3166#US | ||
kind | resource | ||
name | ADIDocumentReference | ||
publisher | HL7 International / Patient Empowerment | ||
purpose | |||
status | active | ||
title | ADI Document Reference | ||
type | DocumentReference | ||
url | http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-DocumentReference | ||
version | 2.0.0-ballot | 2.0.0 |
|
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments![]() | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() | 0..* | USCoreADIDocumentReferenceProfile | A reference to a document | 0..* | USCoreADIDocumentReferenceProfile | A reference to a document | |||||||||||
![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
![]() ![]() | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
|
| ||||||||||
![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Used to communicate the DocumentReference for a superseded document referenced in DocumentReference.relatesTo.target. | |||||||||||
![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
![]() ![]() | Σ | 0..1 | Identifier | Master Version Specific Identifier | Σ | 0..1 | Identifier | Master Version Specific Identifier | |||||||||
![]() ![]() | SΣ | 0..* | Identifier | Other identifiers for the document | SΣ | 0..* | Identifier | Contains a specialized identifier for the setId used to identify a specific logical document. | |||||||||
![]() ![]() | ?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: ?? (required) | ?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: ?? (required) | |||||||||
![]() ![]() | Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: ?? (required) | Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: ?? (required) | |||||||||
![]() ![]() | SΣ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: ?? (extensible): Advance Directives Content Type | SΣ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: ?? (extensible) | |||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing |
| |||||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| |||||||||||||
![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this |
| ||||||||||||
![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept |
| ||||||||||||
![]() ![]() | SΣ | 1..* | CodeableConcept | Categorization of document Slice: Unordered, Open by value:$this Binding: ?? (extensible) | SΣ | 1..* | CodeableConcept | Categorization of document Slice: Unordered, Open by value:$this Binding: ?? (extensible) | |||||||||
![]() ![]() | SΣ | 1..1 | Reference(US Core Patient Profile S) | Who/what is the subject of the document | SΣ | 1..1 | Reference(US Core Patient Profile) | Who/what is the subject of the document | |||||||||
![]() ![]() | SΣ | 1..1 | instant | When this document reference was created | SΣ | 1..1 | instant | When this document reference was created | |||||||||
![]() ![]() | SΣ | 0..* | Reference(US Core PractitionerRole Profile | US Core Organization Profile | US Core Patient Profile) | Who and/or what authored the document | SΣ | 0..* | Reference(US Core PractitionerRole Profile | US Core Organization Profile | US Core Patient Profile) | Who and/or what authored the document | |||||||||
![]() ![]() | S | 0..1 | Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core PractitionerRole Profile) | Who/what authenticated the document | 0..1 | Reference(US Core Practitioner Profile | US Core Organization Profile | ADI Practitioner Role) | The attester or authenticator of the advance directive. |
| |||||||||
![]() ![]() | S | 0..1 | Reference(US Core Organization Profile) | Organization which maintains the document | S | 0..1 | Reference(US Core Organization Profile) | Organization which maintains the document | |||||||||
![]() ![]() | Σ | 0..* | BackboneElement | Relationships to other documents | Σ | 0..* | BackboneElement | Relationships to other documents | |||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: ?? (required): The type of relationship between documents. | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: ?? (required): The type of relationship between documents. | |||||||||
![]() ![]() ![]() | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | |||||||||
![]() ![]() | Σ | 0..1 | string | Human-readable description | Σ | 0..1 | string | the associated document title(s) in the description is a best practice that improves searchability. | |||||||||
![]() ![]() | Σ | 0..* | CodeableConcept | Document security-tags Binding: ?? (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | Σ | 0..* | CodeableConcept | Document security-tags Binding: ?? (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||||||
![]() ![]() | SΣ | 1..* | BackboneElement | Document referenced | SΣ | 1..* | BackboneElement | Document referenced | |||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() | SΣC | 1..1 | Attachment | Where to access the document | SΣC | 1..1 | Attachment | Where to access the document | |||||||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() | SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: ?? (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: ?? (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | |||||||||
![]() ![]() ![]() ![]() | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: ?? (preferred): A human language.
Example General: en-AU | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: ?? (preferred): A human language.
Example General: en-AU |
| ||||||||
![]() ![]() ![]() ![]() | SC | 0..1 | base64Binary | Data inline, base64ed | SC | 0..1 | base64Binary | Data inline, base64ed | |||||||||
![]() ![]() ![]() ![]() | SΣC | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | SΣC | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | |||||||||
![]() ![]() ![]() ![]() | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | |||||||||
![]() ![]() ![]() ![]() | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | |||||||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | |||||||||
![]() ![]() ![]() ![]() | SΣ | 1..1 | dateTime | Date attachment was first created | SΣ | 1..1 | dateTime | Date attachment was first created | |||||||||
![]() ![]() ![]() | SΣ | 0..1 | Coding | Format/content rules for the document Binding: ?? (extensible) | SΣ | 0..1 | Coding | Format/content rules for the document Binding: ?? (extensible) | |||||||||
![]() ![]() | SΣ | 0..1 | BackboneElement | Clinical context of document | SΣ | 0..1 | BackboneElement | Clinical context of document | |||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() | S | 0..* | Reference(US Core Encounter Profile) | Context of the document content | S | 0..* | Reference(US Core Encounter Profile) | An encounter where the associated document was considered relevant. | |||||||||
![]() ![]() ![]() | 0..* | CodeableConcept | Main clinical acts documented Binding: ?? (example): This list of codes represents the main clinical acts being documented. | 0..* | CodeableConcept | Main clinical acts documented Binding: ?? (example): This list of codes represents the main clinical acts being documented. | |||||||||||
![]() ![]() ![]() | SΣ | 0..1 | Period | Time of service that is being documented | SΣ | 0..1 | Period | the span of time that is relevant for the advance healthcare document | |||||||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: ?? (example): XDS Facility Type. | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: ?? (example): XDS Facility Type. | |||||||||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: ?? (example): Additional details about where the content was created (e.g. clinical specialty). | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: ?? (example): Additional details about where the content was created (e.g. clinical specialty). | |||||||||||
![]() ![]() ![]() | 0..1 | Reference(Patient) | Patient demographics from source | 0..1 | Reference(Patient) | Patient demographics from source | |||||||||||
![]() ![]() ![]() | 0..* | Reference(Resource) | Related identifiers or resources | 0..* | Reference(Resource) | Related identifiers or resources | |||||||||||
Documentation for this format | |||||||||||||||||