PACIO Advance Healthcare Directive Interoperability Implementation Guide
2.0.0 - STU 2 – Ballot United States of America flag

PACIO Advance Healthcare 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.0.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

Extension: ADIDocumentationAbsentReason - Detailed Descriptions

Page standards status: Trial-use

Definitions for the adi-documentation-absent-reason extension.

See the documentation on how to interpret the contents of this table

0. Extension
Definition

The Advance Directive Absent Reason Extension specifies why an advance directive document does not exist or was not completed. This differs from dataAbsentReason which is completed when a field has no value. Rather, the USCoreObservationADIDocumentationProfile from which this IG's ADI-DocumentationObservation profile derives from has a Yes/No answer and hence cannot use dataAbsentReason due to the FHIR obs-6 invariant which states that the element will have a value only if Observation.value[x] is missing.


Optional Extension Element - found in all resources.

ShortAdvance Directive Absent ReasonOptional Extensions Element
Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..0*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. Extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-documentation-absent-reason"
}
<url value="http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-documentation-absent-reason"/>
6. Extension.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control10..1
BindingThe codes SHALL be taken from For codes, see DataAbsentReason
(required to http://hl7.org/fhir/ValueSet/data-absent-reason)
TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

See the documentation on how to interpret the contents of this table

0. Extension
Definition

The Advance Directive Absent Reason Extension specifies why an advance directive document does not exist or was not completed. This differs from dataAbsentReason which is completed when a field has no value. Rather, the USCoreObservationADIDocumentationProfile from which this IG's ADI-DocumentationObservation profile derives from has a Yes/No answer and hence cannot use dataAbsentReason due to the FHIR obs-6 invariant which states that the element will have a value only if Observation.value[x] is missing.

ShortAdvance Directive Absent Reason
2. Extension.extension
Control0..0
4. Extension.url
Fixed Value
{
  "url" : "http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-documentation-absent-reason"
}
<url value="http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-documentation-absent-reason"/>
6. Extension.value[x]
Control1..?
BindingThe codes SHALL be taken from DataAbsentReason
(required to http://hl7.org/fhir/ValueSet/data-absent-reason)
TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Must Supporttrue

See the documentation on how to interpret the contents of this table

0. Extension
Definition

The Advance Directive Absent Reason Extension specifies why an advance directive document does not exist or was not completed. This differs from dataAbsentReason which is completed when a field has no value. Rather, the USCoreObservationADIDocumentationProfile from which this IG's ADI-DocumentationObservation profile derives from has a Yes/No answer and hence cannot use dataAbsentReason due to the FHIR obs-6 invariant which states that the element will have a value only if Observation.value[x] is missing.

ShortAdvance Directive Absent Reason
Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. Extension.extension
Definition

An Extension

ShortExtension
Control0..0
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
6. Extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-documentation-absent-reason"
}
<url value="http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-documentation-absent-reason"/>
8. Extension.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control1..1
BindingThe codes SHALL be taken from DataAbsentReason
(required to http://hl7.org/fhir/ValueSet/data-absent-reason)
TypeCodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))