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

Resource Profile: ADI Personal Priorities Organizer

Official URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-PersonalPrioritiesOrganizer Version: 2.0.0
Standards status: Trial-use Computable Name: ADIPersonalPrioritiesOrganizer
Other Identifiers: OID:2.16.840.1.113883.4.642.40.68.42.32

Personal Priorities Organizer is used to represent a set of personal goals, preferences or care experiences in a preferred ranked order.

The ADI Personal Priorities organizer represents the patient’s ranked preferences for their stated personal goals of care, which is related to 8.12.1. A patient may rank avoiding prolonged dependence on machines higher than being able to die at home, which can impact the medical team’s recommendations as to which interventions and associated known outcomes would most closely result in the highest ranked priorities of the patient.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
List C 0..* List A list is a curated collection of resources
Constraints: lst-1, lst-2, lst-3
List.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
List.text This element must be supported. 1..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
List.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
List.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code current | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.
List.mode This element is a modifier element. This element is included in summaries. 1..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.
List.title This element is included in summaries. 1..1 string Descriptive name for the list
Example General: Dr. Jane's Patients
List.code This element is included in summaries. 1..1 CodeableConcept What the purpose of this list is
Binding: ExampleUseCodesForList (example): What the purpose of a list is.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "81340-2"
    }
  ]
}
List.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile) If all resources have the same subject
List.orderedBy This element must be supported. 1..1 CodeableConcept What order the list has
Binding: ListOrderCodes (preferred): What order applies to the items in a list.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/list-order",
      "code" : "priority"
    }
  ]
}

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
List.status Base required ListStatus 📍4.0.1 FHIR Std.
List.mode Base required ListMode 📍4.0.1 FHIR Std.
List.code Base example Example Use Codes for List 📍4.0.1 FHIR Std.
List.orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error List If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error List 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error List If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error List If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice List A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
lst-1 error List A list can only have an emptyReason if it is empty emptyReason.empty() or entry.empty()
lst-2 error List The deleted flag can only be used if the mode of the list is "changes" mode = 'changes' or entry.deleted.empty()
lst-3 error List An entry date can only be used if the mode of the list is "working" mode = 'working' or entry.date.empty()

This structure is derived from List

NameFlagsCard.TypeDescription & Constraints    Filter: doco
List 0..* List A list is a curated collection of resources
List.text This element must be supported. 1..1 Narrative Text summary of the resource, for human interpretation
List.status This element must be supported. 1..1 code current | retired | entered-in-error
List.title 1..1 string Descriptive name for the list
List.subject This element must be supported. 1..1 Reference(US Core Patient Profile) If all resources have the same subject
List.orderedBy This element must be supported. 1..1 CodeableConcept What order the list has
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/list-order",
      "code" : "priority"
    }
  ]
}
List.entry
List.entry.item 1..1 Reference(ADI Personal Goal | ADI Person Authored Personal Intervention Preference | ADI Person-Authored Care Experience Preference) Actual entry

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
List C 0..* List A list is a curated collection of resources
Constraints: lst-1, lst-2, lst-3
List.id This element is included in summaries. 0..1 id Logical id of this artifact
List.meta This element is included in summaries. 0..1 Meta Metadata about the resource
List.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
List.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
List.text This element must be supported. 1..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
List.contained 0..* Resource Contained, inline Resources
List.extension 0..* Extension Additional content defined by implementations
List.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
List.identifier 0..* Identifier Business identifier
List.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code current | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.
List.mode This element is a modifier element. This element is included in summaries. 1..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.
List.title This element is included in summaries. 1..1 string Descriptive name for the list
Example General: Dr. Jane's Patients
List.code This element is included in summaries. 1..1 CodeableConcept What the purpose of this list is
Binding: ExampleUseCodesForList (example): What the purpose of a list is.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "81340-2"
    }
  ]
}
List.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile) If all resources have the same subject
List.encounter 0..1 Reference(Encounter) Context in which list created
List.date This element is included in summaries. 0..1 dateTime When the list was prepared
List.source This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Patient | Device) Who and/or what defined the list contents (aka Author)
List.orderedBy This element must be supported. 1..1 CodeableConcept What order the list has
Binding: ListOrderCodes (preferred): What order applies to the items in a list.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/list-order",
      "code" : "priority"
    }
  ]
}
List.note 0..* Annotation Comments about the list
List.entry C 0..* BackboneElement Entries in the list
List.entry.id 0..1 string Unique id for inter-element referencing
List.entry.extension 0..* Extension Additional content defined by implementations
List.entry.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
List.entry.flag 0..1 CodeableConcept Status/Workflow information about this item
Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.
List.entry.deleted This element is a modifier element. C 0..1 boolean If this item is actually marked as deleted
List.entry.date 0..1 dateTime When item added to list
List.entry.item 1..1 Reference(ADI Personal Goal | ADI Person Authored Personal Intervention Preference | ADI Person-Authored Care Experience Preference) Actual entry
List.emptyReason C 0..1 CodeableConcept Why list is empty
Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
List.language Base preferred Common Languages 📍4.0.1 FHIR Std.
List.status Base required ListStatus 📍4.0.1 FHIR Std.
List.mode Base required ListMode 📍4.0.1 FHIR Std.
List.code Base example Example Use Codes for List 📍4.0.1 FHIR Std.
List.orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
List.entry.flag Base example Patient Medicine Change Types 📍4.0.1 FHIR Std.
List.emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error List If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error List 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error List If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error List If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice List A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
lst-1 error List A list can only have an emptyReason if it is empty emptyReason.empty() or entry.empty()
lst-2 error List The deleted flag can only be used if the mode of the list is "changes" mode = 'changes' or entry.deleted.empty()
lst-3 error List An entry date can only be used if the mode of the list is "working" mode = 'working' or entry.date.empty()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
List C 0..* List A list is a curated collection of resources
Constraints: lst-1, lst-2, lst-3
List.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
List.text This element must be supported. 1..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
List.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
List.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code current | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.
List.mode This element is a modifier element. This element is included in summaries. 1..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.
List.title This element is included in summaries. 1..1 string Descriptive name for the list
Example General: Dr. Jane's Patients
List.code This element is included in summaries. 1..1 CodeableConcept What the purpose of this list is
Binding: ExampleUseCodesForList (example): What the purpose of a list is.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "81340-2"
    }
  ]
}
List.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile) If all resources have the same subject
List.orderedBy This element must be supported. 1..1 CodeableConcept What order the list has
Binding: ListOrderCodes (preferred): What order applies to the items in a list.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/list-order",
      "code" : "priority"
    }
  ]
}

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
List.status Base required ListStatus 📍4.0.1 FHIR Std.
List.mode Base required ListMode 📍4.0.1 FHIR Std.
List.code Base example Example Use Codes for List 📍4.0.1 FHIR Std.
List.orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error List If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error List 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error List If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error List If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice List A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
lst-1 error List A list can only have an emptyReason if it is empty emptyReason.empty() or entry.empty()
lst-2 error List The deleted flag can only be used if the mode of the list is "changes" mode = 'changes' or entry.deleted.empty()
lst-3 error List An entry date can only be used if the mode of the list is "working" mode = 'working' or entry.date.empty()

Differential View

This structure is derived from List

NameFlagsCard.TypeDescription & Constraints    Filter: doco
List 0..* List A list is a curated collection of resources
List.text This element must be supported. 1..1 Narrative Text summary of the resource, for human interpretation
List.status This element must be supported. 1..1 code current | retired | entered-in-error
List.title 1..1 string Descriptive name for the list
List.code 1..1 CodeableConcept What the purpose of this list is
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "81340-2"
    }
  ]
}
List.subject This element must be supported. 1..1 Reference(US Core Patient Profile) If all resources have the same subject
List.orderedBy This element must be supported. 1..1 CodeableConcept What order the list has
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/list-order",
      "code" : "priority"
    }
  ]
}
List.entry
List.entry.item 1..1 Reference(ADI Personal Goal | ADI Person Authored Personal Intervention Preference | ADI Person-Authored Care Experience Preference) Actual entry

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
List C 0..* List A list is a curated collection of resources
Constraints: lst-1, lst-2, lst-3
List.id This element is included in summaries. 0..1 id Logical id of this artifact
List.meta This element is included in summaries. 0..1 Meta Metadata about the resource
List.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
List.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
List.text This element must be supported. 1..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
List.contained 0..* Resource Contained, inline Resources
List.extension 0..* Extension Additional content defined by implementations
List.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
List.identifier 0..* Identifier Business identifier
List.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code current | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.
List.mode This element is a modifier element. This element is included in summaries. 1..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.
List.title This element is included in summaries. 1..1 string Descriptive name for the list
Example General: Dr. Jane's Patients
List.code This element is included in summaries. 1..1 CodeableConcept What the purpose of this list is
Binding: ExampleUseCodesForList (example): What the purpose of a list is.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "81340-2"
    }
  ]
}
List.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile) If all resources have the same subject
List.encounter 0..1 Reference(Encounter) Context in which list created
List.date This element is included in summaries. 0..1 dateTime When the list was prepared
List.source This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Patient | Device) Who and/or what defined the list contents (aka Author)
List.orderedBy This element must be supported. 1..1 CodeableConcept What order the list has
Binding: ListOrderCodes (preferred): What order applies to the items in a list.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/list-order",
      "code" : "priority"
    }
  ]
}
List.note 0..* Annotation Comments about the list
List.entry C 0..* BackboneElement Entries in the list
List.entry.id 0..1 string Unique id for inter-element referencing
List.entry.extension 0..* Extension Additional content defined by implementations
List.entry.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
List.entry.flag 0..1 CodeableConcept Status/Workflow information about this item
Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.
List.entry.deleted This element is a modifier element. C 0..1 boolean If this item is actually marked as deleted
List.entry.date 0..1 dateTime When item added to list
List.entry.item 1..1 Reference(ADI Personal Goal | ADI Person Authored Personal Intervention Preference | ADI Person-Authored Care Experience Preference) Actual entry
List.emptyReason C 0..1 CodeableConcept Why list is empty
Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
List.language Base preferred Common Languages 📍4.0.1 FHIR Std.
List.status Base required ListStatus 📍4.0.1 FHIR Std.
List.mode Base required ListMode 📍4.0.1 FHIR Std.
List.code Base example Example Use Codes for List 📍4.0.1 FHIR Std.
List.orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
List.entry.flag Base example Patient Medicine Change Types 📍4.0.1 FHIR Std.
List.emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error List If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error List 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error List If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error List If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice List A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
lst-1 error List A list can only have an emptyReason if it is empty emptyReason.empty() or entry.empty()
lst-2 error List The deleted flag can only be used if the mode of the list is "changes" mode = 'changes' or entry.deleted.empty()
lst-3 error List An entry date can only be used if the mode of the list is "working" mode = 'working' or entry.date.empty()

 

Other representations of profile: CSV, Excel, Schematron