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 Person-Authored Preference Care Plan

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

The Preference Care Plan is a means for an individual to express their goals and preferences under certain circumstances that may be pertinent when planning his or her care.

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
CarePlan C 0..* USCoreCarePlanProfile Healthcare plan for patient or group
Constraints: goal-or-supportingInfo-required
CarePlan.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
CarePlan.text This element must be supported. 0..1 Narrative Text summary of the resource, for human interpretation
This profile constrains the narrative content by fixing the status codes to generated and additional
This profile does not constrain the narrative in regard to language specific sections
This profile does not constrain the narrative in regard to traceability to data elements
CarePlan.text.status This element must be supported. 1..1 code generated | additional
Binding: US Core Narrative Status (required): Constrained value set of narrative statuses.
CarePlan.text.div This element must be supported. C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
CarePlan.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CarePlan.Slices for extension.extension:GoalOrderByDescendingPriority 0..1 CodeableConcept Goal Order by Descending Priority
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-goal-order-by-descending-priority-extension
Binding: Hl7VSYesNoIndicator (3.0.0) (extensible)
CarePlan.Slices for extension.extension:ADIConditionCodeExtension 0..* CodeableConcept ADI Care Plan Condition Codes
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-condition-code-extension
Binding: US Core Condition Codes (extensible)
CarePlan.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
CarePlan.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
Required Pattern: active (extensions allowed)
CarePlan.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan
Required Pattern: proposal (extensions allowed)
CarePlan.Slices for category This element must be supported. This element is included in summaries. 1..* CodeableConcept Type of plan
Slice: Unordered, Open by value:$this
Binding: CarePlanCategory (preferred)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CarePlan.Slices for category.category:advance_care_planning This element must be supported. This element is included in summaries. 1..1 CodeableConcept Type of plan
Binding: CarePlanCategory (preferred)

Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "81378-2",
      "display" : "Goals, preferences, and priorities under certain health conditions Narrative - Reported"
    }
  ]
}
CarePlan.title This element must be supported. This element is included in summaries. 1..1 string Human-friendly name for the care plan
CarePlan.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile This type must be supported. ) Who the care plan is for
CarePlan.addresses This element must be supported. This element is included in summaries. 0..* Reference(US Core Condition Problems and Health Concerns Profile) The future potential health scenario or condition in which this ADI preference care plan is relevant (use display only for potential conditions the patient does not currently have)
CarePlan.supportingInfo This element must be supported. 0..* Reference(ADI Person-Authored Care Experience Preference) Observations of a patient's preferences for the scope of this care plan.
CarePlan.goal This element must be supported. 0..* Reference(ADI Personal Goal) Patient's goals for the scope of this care plan.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CarePlan.text.status Base required US Core Narrative Status 📦9.0.0 US Core v9.0
CarePlan.status Base required RequestStatus 📦4.0.1 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📦4.0.1 FHIR Std.
CarePlan.category Base preferred Care Plan Category 📦4.0.1 FHIR Std.
CarePlan.category:advance_care_planning Base preferred Care Plan Category 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error CarePlan If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CarePlan 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 CarePlan 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 CarePlan If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CarePlan 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()
goal-or-supportingInfo-required error CarePlan Either goal or supportingInfo must exist, ie. goal and supportingInfo cannot both be blank, ie. if goal does not exist then supportingInfo must exist. goal.empty() implies supportingInfo.exists()
txt-1 error CarePlan.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error CarePlan.text.div The narrative SHALL have some non-whitespace content htmlChecks()

This structure is derived from USCoreCarePlanProfile

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CarePlan C 0..* USCoreCarePlanProfile Healthcare plan for patient or group
Constraints: goal-or-supportingInfo-required
CarePlan.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CarePlan.Slices for extension.extension:GoalOrderByDescendingPriority 0..1 CodeableConcept Goal Order by Descending Priority
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-goal-order-by-descending-priority-extension
Binding: Hl7VSYesNoIndicator (3.0.0) (extensible)
CarePlan.Slices for extension.extension:ADIConditionCodeExtension 0..* CodeableConcept ADI Care Plan Condition Codes
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-condition-code-extension
Binding: US Core Condition Codes (extensible)
CarePlan.status 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Required Pattern: active (extensions allowed)
CarePlan.intent 1..1 code proposal | plan | order | option
Required Pattern: proposal (extensions allowed)
CarePlan.Slices for category.category:advance_care_planning This element must be supported. 1..1 CodeableConcept Type of plan
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "81378-2",
      "display" : "Goals, preferences, and priorities under certain health conditions Narrative - Reported"
    }
  ]
}
CarePlan.title This element must be supported. 1..1 string Human-friendly name for the care plan
CarePlan.subject 1..1 Reference(US Core Patient Profile) Who the care plan is for
CarePlan.addresses This element must be supported. 0..* Reference(US Core Condition Problems and Health Concerns Profile) The future potential health scenario or condition in which this ADI preference care plan is relevant (use display only for potential conditions the patient does not currently have)
CarePlan.supportingInfo This element must be supported. 0..* Reference(ADI Person-Authored Care Experience Preference) Observations of a patient's preferences for the scope of this care plan.
CarePlan.goal This element must be supported. 0..* Reference(ADI Personal Goal) Patient's goals for the scope of this care plan.
CarePlan.activity
CarePlan.activity.reference 0..1 Reference(US Core ServiceRequest Profile) Activity details defined in specific resource

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
goal-or-supportingInfo-required error CarePlan Either goal or supportingInfo must exist, ie. goal and supportingInfo cannot both be blank, ie. if goal does not exist then supportingInfo must exist. goal.empty() implies supportingInfo.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
CarePlan C 0..* USCoreCarePlanProfile Healthcare plan for patient or group
Constraints: goal-or-supportingInfo-required
CarePlan.id This element is included in summaries. 0..1 id Logical id of this artifact
CarePlan.meta This element is included in summaries. 0..1 Meta Metadata about the resource
CarePlan.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
CarePlan.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
CarePlan.text This element must be supported. 0..1 Narrative Text summary of the resource, for human interpretation
This profile constrains the narrative content by fixing the status codes to generated and additional
This profile does not constrain the narrative in regard to language specific sections
This profile does not constrain the narrative in regard to traceability to data elements
CarePlan.text.id 0..1 string Unique id for inter-element referencing
CarePlan.text.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
CarePlan.text.status This element must be supported. 1..1 code generated | additional
Binding: US Core Narrative Status (required): Constrained value set of narrative statuses.
CarePlan.text.div This element must be supported. C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
CarePlan.contained 0..* Resource Contained, inline Resources
CarePlan.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CarePlan.Slices for extension.extension:GoalOrderByDescendingPriority 0..1 CodeableConcept Goal Order by Descending Priority
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-goal-order-by-descending-priority-extension
Binding: Hl7VSYesNoIndicator (3.0.0) (extensible)
CarePlan.Slices for extension.extension:ADIConditionCodeExtension 0..* CodeableConcept ADI Care Plan Condition Codes
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-condition-code-extension
Binding: US Core Condition Codes (extensible)
CarePlan.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
CarePlan.identifier This element is included in summaries. 0..* Identifier External Ids for this plan
CarePlan.instantiatesCanonical This element is included in summaries. 0..* canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) Instantiates FHIR protocol or definition
CarePlan.instantiatesUri This element is included in summaries. 0..* uri Instantiates external protocol or definition
CarePlan.basedOn This element is included in summaries. 0..* Reference(CarePlan) Fulfills CarePlan
CarePlan.replaces This element is included in summaries. 0..* Reference(CarePlan) CarePlan replaced by this CarePlan
CarePlan.partOf This element is included in summaries. 0..* Reference(CarePlan) Part of referenced CarePlan
CarePlan.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
Required Pattern: active (extensions allowed)
CarePlan.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan
Required Pattern: proposal (extensions allowed)
CarePlan.Slices for category This element must be supported. This element is included in summaries. 1..* CodeableConcept Type of plan
Slice: Unordered, Open by value:$this
Binding: CarePlanCategory (preferred)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CarePlan.Slices for category.category:advance_care_planning This element must be supported. This element is included in summaries. 1..1 CodeableConcept Type of plan
Binding: CarePlanCategory (preferred)

Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "81378-2",
      "display" : "Goals, preferences, and priorities under certain health conditions Narrative - Reported"
    }
  ]
}
CarePlan.title This element must be supported. This element is included in summaries. 1..1 string Human-friendly name for the care plan
CarePlan.description This element is included in summaries. 0..1 string Summary of nature of plan
CarePlan.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile This type must be supported. ) Who the care plan is for
CarePlan.encounter This element is included in summaries. 0..1 Reference(Encounter) Encounter created as part of
CarePlan.period This element is included in summaries. 0..1 Period Time period plan covers
CarePlan.created This element is included in summaries. 0..1 dateTime Date record was first recorded
CarePlan.author This element is included in summaries. 0..1 Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who is the designated responsible party
CarePlan.contributor 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile | US Core Device Profile) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Who provided the content of the care plan
CarePlan.careTeam 0..* Reference(CareTeam) Who's involved in plan?
CarePlan.addresses This element must be supported. This element is included in summaries. 0..* Reference(US Core Condition Problems and Health Concerns Profile) The future potential health scenario or condition in which this ADI preference care plan is relevant (use display only for potential conditions the patient does not currently have)
CarePlan.supportingInfo This element must be supported. 0..* Reference(ADI Person-Authored Care Experience Preference) Observations of a patient's preferences for the scope of this care plan.
CarePlan.goal This element must be supported. 0..* Reference(ADI Personal Goal) Patient's goals for the scope of this care plan.
CarePlan.activity C 0..* BackboneElement Action to occur as part of plan
Constraints: cpl-3
CarePlan.activity.id 0..1 string Unique id for inter-element referencing
CarePlan.activity.extension 0..* Extension Additional content defined by implementations
CarePlan.activity.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
CarePlan.activity.outcomeCodeableConcept 0..* CodeableConcept Results of the activity
Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.
CarePlan.activity.outcomeReference 0..* Reference(Resource) Appointment, Encounter, Procedure, etc.
CarePlan.activity.progress 0..* Annotation Comments about the activity status/progress
CarePlan.activity.reference C 0..1 Reference(US Core ServiceRequest Profile) Activity details defined in specific resource
CarePlan.activity.detail C 0..1 BackboneElement In-line definition of activity
CarePlan.activity.detail.id 0..1 string Unique id for inter-element referencing
CarePlan.activity.detail.extension 0..* Extension Additional content defined by implementations
CarePlan.activity.detail.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
CarePlan.activity.detail.kind 0..1 code Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.
CarePlan.activity.detail.instantiatesCanonical 0..* canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) Instantiates FHIR protocol or definition
CarePlan.activity.detail.instantiatesUri 0..* uri Instantiates external protocol or definition
CarePlan.activity.detail.code 0..1 CodeableConcept Detail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
CarePlan.activity.detail.reasonCode 0..* CodeableConcept Why activity should be done or why activity was prohibited
Binding: SNOMEDCTClinicalFindings (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc.
CarePlan.activity.detail.reasonReference 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why activity is needed
CarePlan.activity.detail.goal 0..* Reference(Goal) Goals this activity relates to
CarePlan.activity.detail.status This element is a modifier element. 1..1 code not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.
CarePlan.activity.detail.statusReason 0..1 CodeableConcept Reason for current status
CarePlan.activity.detail.doNotPerform This element is a modifier element. 0..1 boolean If true, activity is prohibiting action
CarePlan.activity.detail.scheduled[x] 0..1 When activity is to occur
CarePlan.activity.detail.scheduled[x].scheduledTiming Timing
CarePlan.activity.detail.scheduled[x].scheduledPeriod Period
CarePlan.activity.detail.scheduled[x].scheduledString string
CarePlan.activity.detail.location 0..1 Reference(Location) Where it should happen
CarePlan.activity.detail.performer 0..* Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) Who will be responsible?
CarePlan.activity.detail.product[x] 0..1 What is to be administered/supplied
Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity.
CarePlan.activity.detail.product[x].productCodeableConcept CodeableConcept
CarePlan.activity.detail.product[x].productReference Reference(Medication | Substance)
CarePlan.activity.detail.dailyAmount C 0..1 SimpleQuantity(4.0.1) How to consume/day?
Constraints: sqty-1
CarePlan.activity.detail.quantity C 0..1 SimpleQuantity(4.0.1) How much to administer/supply/consume
Constraints: sqty-1
CarePlan.activity.detail.description 0..1 string Extra info describing activity to perform
CarePlan.note 0..* Annotation Comments about the plan

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CarePlan.language Base preferred Common Languages 📍4.0.1 FHIR Std.
CarePlan.text.status Base required US Core Narrative Status 📦9.0.0 US Core v9.0
CarePlan.status Base required RequestStatus 📦4.0.1 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📦4.0.1 FHIR Std.
CarePlan.category Base preferred Care Plan Category 📦4.0.1 FHIR Std.
CarePlan.category:advance_care_planning Base preferred Care Plan Category 📦4.0.1 FHIR Std.
CarePlan.activity.outcomeCodeableConcept Base example Care Plan Activity Outcome 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​kind Base required Care Plan Activity Kind 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​reasonCode Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​status Base required CarePlanActivityStatus 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​product[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpl-3 error CarePlan.activity Provide a reference or detail, not both detail.empty() or reference.empty()
dom-2 error CarePlan If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CarePlan 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 CarePlan 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 CarePlan If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CarePlan 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()
goal-or-supportingInfo-required error CarePlan Either goal or supportingInfo must exist, ie. goal and supportingInfo cannot both be blank, ie. if goal does not exist then supportingInfo must exist. goal.empty() implies supportingInfo.exists()
sqty-1 error CarePlan.activity.detail.dailyAmount, CarePlan.activity.detail.quantity The comparator is not used on a SimpleQuantity comparator.empty()
txt-1 error CarePlan.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error CarePlan.text.div The narrative SHALL have some non-whitespace content htmlChecks()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CarePlan C 0..* USCoreCarePlanProfile Healthcare plan for patient or group
Constraints: goal-or-supportingInfo-required
CarePlan.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
CarePlan.text This element must be supported. 0..1 Narrative Text summary of the resource, for human interpretation
This profile constrains the narrative content by fixing the status codes to generated and additional
This profile does not constrain the narrative in regard to language specific sections
This profile does not constrain the narrative in regard to traceability to data elements
CarePlan.text.status This element must be supported. 1..1 code generated | additional
Binding: US Core Narrative Status (required): Constrained value set of narrative statuses.
CarePlan.text.div This element must be supported. C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
CarePlan.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CarePlan.Slices for extension.extension:GoalOrderByDescendingPriority 0..1 CodeableConcept Goal Order by Descending Priority
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-goal-order-by-descending-priority-extension
Binding: Hl7VSYesNoIndicator (3.0.0) (extensible)
CarePlan.Slices for extension.extension:ADIConditionCodeExtension 0..* CodeableConcept ADI Care Plan Condition Codes
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-condition-code-extension
Binding: US Core Condition Codes (extensible)
CarePlan.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
CarePlan.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
Required Pattern: active (extensions allowed)
CarePlan.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan
Required Pattern: proposal (extensions allowed)
CarePlan.Slices for category This element must be supported. This element is included in summaries. 1..* CodeableConcept Type of plan
Slice: Unordered, Open by value:$this
Binding: CarePlanCategory (preferred)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CarePlan.Slices for category.category:advance_care_planning This element must be supported. This element is included in summaries. 1..1 CodeableConcept Type of plan
Binding: CarePlanCategory (preferred)

Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "81378-2",
      "display" : "Goals, preferences, and priorities under certain health conditions Narrative - Reported"
    }
  ]
}
CarePlan.title This element must be supported. This element is included in summaries. 1..1 string Human-friendly name for the care plan
CarePlan.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile This type must be supported. ) Who the care plan is for
CarePlan.addresses This element must be supported. This element is included in summaries. 0..* Reference(US Core Condition Problems and Health Concerns Profile) The future potential health scenario or condition in which this ADI preference care plan is relevant (use display only for potential conditions the patient does not currently have)
CarePlan.supportingInfo This element must be supported. 0..* Reference(ADI Person-Authored Care Experience Preference) Observations of a patient's preferences for the scope of this care plan.
CarePlan.goal This element must be supported. 0..* Reference(ADI Personal Goal) Patient's goals for the scope of this care plan.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CarePlan.text.status Base required US Core Narrative Status 📦9.0.0 US Core v9.0
CarePlan.status Base required RequestStatus 📦4.0.1 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📦4.0.1 FHIR Std.
CarePlan.category Base preferred Care Plan Category 📦4.0.1 FHIR Std.
CarePlan.category:advance_care_planning Base preferred Care Plan Category 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error CarePlan If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CarePlan 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 CarePlan 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 CarePlan If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CarePlan 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()
goal-or-supportingInfo-required error CarePlan Either goal or supportingInfo must exist, ie. goal and supportingInfo cannot both be blank, ie. if goal does not exist then supportingInfo must exist. goal.empty() implies supportingInfo.exists()
txt-1 error CarePlan.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error CarePlan.text.div The narrative SHALL have some non-whitespace content htmlChecks()

Differential View

This structure is derived from USCoreCarePlanProfile

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CarePlan C 0..* USCoreCarePlanProfile Healthcare plan for patient or group
Constraints: goal-or-supportingInfo-required
CarePlan.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CarePlan.Slices for extension.extension:GoalOrderByDescendingPriority 0..1 CodeableConcept Goal Order by Descending Priority
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-goal-order-by-descending-priority-extension
Binding: Hl7VSYesNoIndicator (3.0.0) (extensible)
CarePlan.Slices for extension.extension:ADIConditionCodeExtension 0..* CodeableConcept ADI Care Plan Condition Codes
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-condition-code-extension
Binding: US Core Condition Codes (extensible)
CarePlan.status 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Required Pattern: active (extensions allowed)
CarePlan.intent 1..1 code proposal | plan | order | option
Required Pattern: proposal (extensions allowed)
CarePlan.Slices for category 1..* CodeableConcept Type of plan
Slice: Unordered, Open by value:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CarePlan.Slices for category.category:advance_care_planning This element must be supported. 1..1 CodeableConcept Type of plan
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "81378-2",
      "display" : "Goals, preferences, and priorities under certain health conditions Narrative - Reported"
    }
  ]
}
CarePlan.title This element must be supported. 1..1 string Human-friendly name for the care plan
CarePlan.subject 1..1 Reference(US Core Patient Profile) Who the care plan is for
CarePlan.addresses This element must be supported. 0..* Reference(US Core Condition Problems and Health Concerns Profile) The future potential health scenario or condition in which this ADI preference care plan is relevant (use display only for potential conditions the patient does not currently have)
CarePlan.supportingInfo This element must be supported. 0..* Reference(ADI Person-Authored Care Experience Preference) Observations of a patient's preferences for the scope of this care plan.
CarePlan.goal This element must be supported. 0..* Reference(ADI Personal Goal) Patient's goals for the scope of this care plan.
CarePlan.activity
CarePlan.activity.reference 0..1 Reference(US Core ServiceRequest Profile) Activity details defined in specific resource

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
goal-or-supportingInfo-required error CarePlan Either goal or supportingInfo must exist, ie. goal and supportingInfo cannot both be blank, ie. if goal does not exist then supportingInfo must exist. goal.empty() implies supportingInfo.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CarePlan C 0..* USCoreCarePlanProfile Healthcare plan for patient or group
Constraints: goal-or-supportingInfo-required
CarePlan.id This element is included in summaries. 0..1 id Logical id of this artifact
CarePlan.meta This element is included in summaries. 0..1 Meta Metadata about the resource
CarePlan.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
CarePlan.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
CarePlan.text This element must be supported. 0..1 Narrative Text summary of the resource, for human interpretation
This profile constrains the narrative content by fixing the status codes to generated and additional
This profile does not constrain the narrative in regard to language specific sections
This profile does not constrain the narrative in regard to traceability to data elements
CarePlan.text.id 0..1 string Unique id for inter-element referencing
CarePlan.text.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
CarePlan.text.status This element must be supported. 1..1 code generated | additional
Binding: US Core Narrative Status (required): Constrained value set of narrative statuses.
CarePlan.text.div This element must be supported. C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
CarePlan.contained 0..* Resource Contained, inline Resources
CarePlan.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CarePlan.Slices for extension.extension:GoalOrderByDescendingPriority 0..1 CodeableConcept Goal Order by Descending Priority
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-goal-order-by-descending-priority-extension
Binding: Hl7VSYesNoIndicator (3.0.0) (extensible)
CarePlan.Slices for extension.extension:ADIConditionCodeExtension 0..* CodeableConcept ADI Care Plan Condition Codes
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-condition-code-extension
Binding: US Core Condition Codes (extensible)
CarePlan.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
CarePlan.identifier This element is included in summaries. 0..* Identifier External Ids for this plan
CarePlan.instantiatesCanonical This element is included in summaries. 0..* canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) Instantiates FHIR protocol or definition
CarePlan.instantiatesUri This element is included in summaries. 0..* uri Instantiates external protocol or definition
CarePlan.basedOn This element is included in summaries. 0..* Reference(CarePlan) Fulfills CarePlan
CarePlan.replaces This element is included in summaries. 0..* Reference(CarePlan) CarePlan replaced by this CarePlan
CarePlan.partOf This element is included in summaries. 0..* Reference(CarePlan) Part of referenced CarePlan
CarePlan.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
Required Pattern: active (extensions allowed)
CarePlan.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan
Required Pattern: proposal (extensions allowed)
CarePlan.Slices for category This element must be supported. This element is included in summaries. 1..* CodeableConcept Type of plan
Slice: Unordered, Open by value:$this
Binding: CarePlanCategory (preferred)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CarePlan.Slices for category.category:advance_care_planning This element must be supported. This element is included in summaries. 1..1 CodeableConcept Type of plan
Binding: CarePlanCategory (preferred)

Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "81378-2",
      "display" : "Goals, preferences, and priorities under certain health conditions Narrative - Reported"
    }
  ]
}
CarePlan.title This element must be supported. This element is included in summaries. 1..1 string Human-friendly name for the care plan
CarePlan.description This element is included in summaries. 0..1 string Summary of nature of plan
CarePlan.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile This type must be supported. ) Who the care plan is for
CarePlan.encounter This element is included in summaries. 0..1 Reference(Encounter) Encounter created as part of
CarePlan.period This element is included in summaries. 0..1 Period Time period plan covers
CarePlan.created This element is included in summaries. 0..1 dateTime Date record was first recorded
CarePlan.author This element is included in summaries. 0..1 Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who is the designated responsible party
CarePlan.contributor 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile | US Core Device Profile) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Who provided the content of the care plan
CarePlan.careTeam 0..* Reference(CareTeam) Who's involved in plan?
CarePlan.addresses This element must be supported. This element is included in summaries. 0..* Reference(US Core Condition Problems and Health Concerns Profile) The future potential health scenario or condition in which this ADI preference care plan is relevant (use display only for potential conditions the patient does not currently have)
CarePlan.supportingInfo This element must be supported. 0..* Reference(ADI Person-Authored Care Experience Preference) Observations of a patient's preferences for the scope of this care plan.
CarePlan.goal This element must be supported. 0..* Reference(ADI Personal Goal) Patient's goals for the scope of this care plan.
CarePlan.activity C 0..* BackboneElement Action to occur as part of plan
Constraints: cpl-3
CarePlan.activity.id 0..1 string Unique id for inter-element referencing
CarePlan.activity.extension 0..* Extension Additional content defined by implementations
CarePlan.activity.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
CarePlan.activity.outcomeCodeableConcept 0..* CodeableConcept Results of the activity
Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.
CarePlan.activity.outcomeReference 0..* Reference(Resource) Appointment, Encounter, Procedure, etc.
CarePlan.activity.progress 0..* Annotation Comments about the activity status/progress
CarePlan.activity.reference C 0..1 Reference(US Core ServiceRequest Profile) Activity details defined in specific resource
CarePlan.activity.detail C 0..1 BackboneElement In-line definition of activity
CarePlan.activity.detail.id 0..1 string Unique id for inter-element referencing
CarePlan.activity.detail.extension 0..* Extension Additional content defined by implementations
CarePlan.activity.detail.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
CarePlan.activity.detail.kind 0..1 code Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.
CarePlan.activity.detail.instantiatesCanonical 0..* canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) Instantiates FHIR protocol or definition
CarePlan.activity.detail.instantiatesUri 0..* uri Instantiates external protocol or definition
CarePlan.activity.detail.code 0..1 CodeableConcept Detail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
CarePlan.activity.detail.reasonCode 0..* CodeableConcept Why activity should be done or why activity was prohibited
Binding: SNOMEDCTClinicalFindings (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc.
CarePlan.activity.detail.reasonReference 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why activity is needed
CarePlan.activity.detail.goal 0..* Reference(Goal) Goals this activity relates to
CarePlan.activity.detail.status This element is a modifier element. 1..1 code not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.
CarePlan.activity.detail.statusReason 0..1 CodeableConcept Reason for current status
CarePlan.activity.detail.doNotPerform This element is a modifier element. 0..1 boolean If true, activity is prohibiting action
CarePlan.activity.detail.scheduled[x] 0..1 When activity is to occur
CarePlan.activity.detail.scheduled[x].scheduledTiming Timing
CarePlan.activity.detail.scheduled[x].scheduledPeriod Period
CarePlan.activity.detail.scheduled[x].scheduledString string
CarePlan.activity.detail.location 0..1 Reference(Location) Where it should happen
CarePlan.activity.detail.performer 0..* Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) Who will be responsible?
CarePlan.activity.detail.product[x] 0..1 What is to be administered/supplied
Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity.
CarePlan.activity.detail.product[x].productCodeableConcept CodeableConcept
CarePlan.activity.detail.product[x].productReference Reference(Medication | Substance)
CarePlan.activity.detail.dailyAmount C 0..1 SimpleQuantity(4.0.1) How to consume/day?
Constraints: sqty-1
CarePlan.activity.detail.quantity C 0..1 SimpleQuantity(4.0.1) How much to administer/supply/consume
Constraints: sqty-1
CarePlan.activity.detail.description 0..1 string Extra info describing activity to perform
CarePlan.note 0..* Annotation Comments about the plan

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CarePlan.language Base preferred Common Languages 📍4.0.1 FHIR Std.
CarePlan.text.status Base required US Core Narrative Status 📦9.0.0 US Core v9.0
CarePlan.status Base required RequestStatus 📦4.0.1 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📦4.0.1 FHIR Std.
CarePlan.category Base preferred Care Plan Category 📦4.0.1 FHIR Std.
CarePlan.category:advance_care_planning Base preferred Care Plan Category 📦4.0.1 FHIR Std.
CarePlan.activity.outcomeCodeableConcept Base example Care Plan Activity Outcome 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​kind Base required Care Plan Activity Kind 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​reasonCode Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​status Base required CarePlanActivityStatus 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​product[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpl-3 error CarePlan.activity Provide a reference or detail, not both detail.empty() or reference.empty()
dom-2 error CarePlan If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CarePlan 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 CarePlan 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 CarePlan If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CarePlan 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()
goal-or-supportingInfo-required error CarePlan Either goal or supportingInfo must exist, ie. goal and supportingInfo cannot both be blank, ie. if goal does not exist then supportingInfo must exist. goal.empty() implies supportingInfo.exists()
sqty-1 error CarePlan.activity.detail.dailyAmount, CarePlan.activity.detail.quantity The comparator is not used on a SimpleQuantity comparator.empty()
txt-1 error CarePlan.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error CarePlan.text.div The narrative SHALL have some non-whitespace content htmlChecks()

 

Other representations of profile: CSV, Excel, Schematron