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.1.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
Official URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-PreferenceCarePlan | Version: 2.1.0 | |||
Active as of 2025-07-08 | Computable Name: ADIPreferenceCarePlan |
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.
The ADI PtAuthored Care Plan represents the patient’s goals for treatment based on circumstances or situations that provide context for the goals documented. A patient could document their goal of care in a situation such as a terminal condition that will result in their death in a relatively short period of time as being to extend their life for as long as possible, or allow their natural death to occur, or allow limited treatments to occur for a certain period of time before they are stopped. In a different situation, such as permanent and severe brain damage from which they are not expected to recover, that their goal of care options may be the same but their documented selection is different. Various forms and jurisdictions include circumstances or situations that are relatively consistent but still vary somewhat, so this Resource allows the basic structure of a context or circumstance or situation to be defined, against which the identification of a goal is documented, and against which in some existing forms further identification of the patient’s preference for interventions is captured. To enable the patient’s own preferred plan of care to merge with the care team’s clinical plan of care results in a jointly-authored and patient-centered plan of care that is informed by the person receiving care and the care team responsible for delivering that care.
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | USCoreCarePlanProfile | Healthcare plan for patient or group Constraints: goal-or-supportingInfo-required |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
S | 0..1 | Narrative | (USCDI) 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 |
![]() ![]() ![]() ![]() |
S | 1..1 | code | (USCDI) generated | extensions | additional | empty Binding: US Core Narrative Status (required): Constrained value set of narrative statuses. |
![]() ![]() ![]() ![]() |
SC | 1..1 | xhtml | (USCDI) Limited xhtml content Constraints: txt-1, txt-2 |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
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: hl7VS-yes-no-Indicator (extensible) | |
![]() ![]() ![]() ![]() |
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) | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | (USCDI) 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 |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | (USCDI) proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan Required Pattern: proposal |
![]() ![]() ![]() |
SΣ | 2..* | CodeableConcept | (USCDI) Type of plan Slice: Unordered, Open by pattern:$this Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | (USCDI) Type of plan Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/careplan-category | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: assess-plan | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | (USCDI) Type of plan Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 81378-2 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Goals, preferences, and priorities under certain health conditions [Reported] | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() |
SΣ | 1..1 | string | Human-friendly name for the care plan |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile) | (USCDI) Who the care plan is for |
![]() ![]() ![]() |
SΣ | 0..* | Reference(Condition) | 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) |
![]() ![]() ![]() |
S | 0..* | Reference(ADI PtAuthored Care Experience Preference) | Observations of a patient's preferences for the scope of this care plan. |
![]() ![]() ![]() |
S | 0..* | Reference(ADI Personal Goal) | Patient's goals for the scope of this care plan. |
![]() |
Path | Conformance | ValueSet / Code | URI |
CarePlan.text.status | required | NarrativeStatushttp://hl7.org/fhir/us/core/ValueSet/us-core-narrative-status | |
CarePlan.status | required | Pattern Value: activehttp://hl7.org/fhir/ValueSet/request-status From the FHIR Standard | |
CarePlan.intent | required | Pattern Value: proposalhttp://hl7.org/fhir/ValueSet/care-plan-intent From the FHIR Standard | |
CarePlan.category | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-category From the FHIR Standard | |
CarePlan.category:AssessPlan | example | Pattern Value: assess-planhttp://hl7.org/fhir/ValueSet/care-plan-category From the FHIR Standard | |
CarePlan.category:advance_care_planning | example | Pattern Value: LOINC Code 81378-2("Goals, preferences, and priorities under certain health conditions [Reported]")http://hl7.org/fhir/ValueSet/care-plan-category From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | USCoreCarePlanProfile | Healthcare plan for patient or group Constraints: goal-or-supportingInfo-required |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
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: hl7VS-yes-no-Indicator (extensible) | |
![]() ![]() ![]() ![]() |
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) | |
![]() ![]() ![]() |
1..1 | code | (USCDI) draft | active | on-hold | revoked | completed | entered-in-error | unknown Required Pattern: active | |
![]() ![]() ![]() |
1..1 | code | (USCDI) proposal | plan | order | option Required Pattern: proposal | |
![]() ![]() ![]() |
2..* | CodeableConcept | (USCDI) Type of plan Slice: Unordered, Open by pattern:$this | |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | (USCDI) Type of plan Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 81378-2 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Goals, preferences, and priorities under certain health conditions [Reported] | |
![]() ![]() ![]() |
S | 1..1 | string | Human-friendly name for the care plan |
![]() ![]() ![]() |
S | 0..* | Reference(Condition) | 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) |
![]() ![]() ![]() |
S | 0..* | Reference(ADI PtAuthored Care Experience Preference) | Observations of a patient's preferences for the scope of this care plan. |
![]() ![]() ![]() |
S | 0..* | Reference(ADI Personal Goal) | Patient's goals for the scope of this care plan. |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | Reference(US Core ServiceRequest Profile) | Activity details defined in specific resource | |
![]() |
Id | Grade | Path(s) | Details | Requirements |
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() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | USCoreCarePlanProfile | Healthcare plan for patient or group Constraints: goal-or-supportingInfo-required | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
S | 0..1 | Narrative | (USCDI) 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 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | code | (USCDI) generated | extensions | additional | empty Binding: US Core Narrative Status (required): Constrained value set of narrative statuses. | ||||
![]() ![]() ![]() ![]() |
SC | 1..1 | xhtml | (USCDI) Limited xhtml content Constraints: txt-1, txt-2 | ||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
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: hl7VS-yes-no-Indicator (extensible) | |||||
![]() ![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | External Ids for this plan | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiates FHIR protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(CarePlan) | Fulfills CarePlan | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(CarePlan) | CarePlan replaced by this CarePlan | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(CarePlan) | Part of referenced CarePlan | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | (USCDI) 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 | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | (USCDI) proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan Required Pattern: proposal | ||||
![]() ![]() ![]() |
SΣ | 2..* | CodeableConcept | (USCDI) Type of plan Slice: Unordered, Open by pattern:$this Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | (USCDI) Type of plan Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/careplan-category | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: assess-plan | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | (USCDI) Type of plan Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 81378-2 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Goals, preferences, and priorities under certain health conditions [Reported] | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Human-friendly name for the care plan | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Summary of nature of plan | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile) | (USCDI) Who the care plan is for | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period plan covers | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date record was first recorded | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who is the designated responsible party | ||||
![]() ![]() ![]() |
0..* | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who provided the content of the care plan | |||||
![]() ![]() ![]() |
0..* | Reference(CareTeam) | Who's involved in plan? | |||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(Condition) | 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) | ||||
![]() ![]() ![]() |
S | 0..* | Reference(ADI PtAuthored Care Experience Preference) | Observations of a patient's preferences for the scope of this care plan. | ||||
![]() ![]() ![]() |
S | 0..* | Reference(ADI Personal Goal) | Patient's goals for the scope of this care plan. | ||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | Action to occur as part of plan Constraints: cpl-3 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |||||
![]() ![]() ![]() ![]() |
0..* | Annotation | Comments about the activity status/progress | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | Reference(US Core ServiceRequest Profile) | Activity details defined in specific resource | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | In-line definition of activity | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | uri | Instantiates external protocol or definition | |||||
![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why activity is needed | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Reference(Goal) | Goals this activity relates to | |||||
![]() ![]() ![]() ![]() ![]() |
?! | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Reason for current status | |||||
![]() ![]() ![]() ![]() ![]() |
?! | 0..1 | boolean | If true, activity is prohibiting action | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | When activity is to occur | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Timing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Location) | Where it should happen | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | Who will be responsible? | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Medication | Substance) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | How to consume/day? | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | How much to administer/supply/consume | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Extra info describing activity to perform | |||||
![]() ![]() ![]() |
0..* | Annotation | Comments about the plan | |||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
CarePlan.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
CarePlan.text.status | required | NarrativeStatushttp://hl7.org/fhir/us/core/ValueSet/us-core-narrative-status | ||||
CarePlan.status | required | Pattern Value: activehttp://hl7.org/fhir/ValueSet/request-status From the FHIR Standard | ||||
CarePlan.intent | required | Pattern Value: proposalhttp://hl7.org/fhir/ValueSet/care-plan-intent From the FHIR Standard | ||||
CarePlan.category | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-category From the FHIR Standard | ||||
CarePlan.category:AssessPlan | example | Pattern Value: assess-planhttp://hl7.org/fhir/ValueSet/care-plan-category From the FHIR Standard | ||||
CarePlan.category:advance_care_planning | example | Pattern Value: LOINC Code 81378-2("Goals, preferences, and priorities under certain health conditions [Reported]")http://hl7.org/fhir/ValueSet/care-plan-category From the FHIR Standard | ||||
CarePlan.activity.outcomeCodeableConcept | example | CarePlanActivityOutcomehttp://hl7.org/fhir/ValueSet/care-plan-activity-outcome From the FHIR Standard | ||||
CarePlan.activity.detail.kind | required | CarePlanActivityKindhttp://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1 From the FHIR Standard | ||||
CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code From the FHIR Standard | ||||
CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings From the FHIR Standard | ||||
CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1 From the FHIR Standard | ||||
CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() | |
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
Summary
Mandatory: 2 elements
Must-Support: 5 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | USCoreCarePlanProfile | Healthcare plan for patient or group Constraints: goal-or-supportingInfo-required |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
S | 0..1 | Narrative | (USCDI) 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 |
![]() ![]() ![]() ![]() |
S | 1..1 | code | (USCDI) generated | extensions | additional | empty Binding: US Core Narrative Status (required): Constrained value set of narrative statuses. |
![]() ![]() ![]() ![]() |
SC | 1..1 | xhtml | (USCDI) Limited xhtml content Constraints: txt-1, txt-2 |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
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: hl7VS-yes-no-Indicator (extensible) | |
![]() ![]() ![]() ![]() |
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) | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | (USCDI) 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 |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | (USCDI) proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan Required Pattern: proposal |
![]() ![]() ![]() |
SΣ | 2..* | CodeableConcept | (USCDI) Type of plan Slice: Unordered, Open by pattern:$this Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | (USCDI) Type of plan Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/careplan-category | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: assess-plan | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | (USCDI) Type of plan Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 81378-2 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Goals, preferences, and priorities under certain health conditions [Reported] | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() |
SΣ | 1..1 | string | Human-friendly name for the care plan |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile) | (USCDI) Who the care plan is for |
![]() ![]() ![]() |
SΣ | 0..* | Reference(Condition) | 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) |
![]() ![]() ![]() |
S | 0..* | Reference(ADI PtAuthored Care Experience Preference) | Observations of a patient's preferences for the scope of this care plan. |
![]() ![]() ![]() |
S | 0..* | Reference(ADI Personal Goal) | Patient's goals for the scope of this care plan. |
![]() |
Path | Conformance | ValueSet / Code | URI |
CarePlan.text.status | required | NarrativeStatushttp://hl7.org/fhir/us/core/ValueSet/us-core-narrative-status | |
CarePlan.status | required | Pattern Value: activehttp://hl7.org/fhir/ValueSet/request-status From the FHIR Standard | |
CarePlan.intent | required | Pattern Value: proposalhttp://hl7.org/fhir/ValueSet/care-plan-intent From the FHIR Standard | |
CarePlan.category | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-category From the FHIR Standard | |
CarePlan.category:AssessPlan | example | Pattern Value: assess-planhttp://hl7.org/fhir/ValueSet/care-plan-category From the FHIR Standard | |
CarePlan.category:advance_care_planning | example | Pattern Value: LOINC Code 81378-2("Goals, preferences, and priorities under certain health conditions [Reported]")http://hl7.org/fhir/ValueSet/care-plan-category From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | USCoreCarePlanProfile | Healthcare plan for patient or group Constraints: goal-or-supportingInfo-required |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
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: hl7VS-yes-no-Indicator (extensible) | |
![]() ![]() ![]() ![]() |
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) | |
![]() ![]() ![]() |
1..1 | code | (USCDI) draft | active | on-hold | revoked | completed | entered-in-error | unknown Required Pattern: active | |
![]() ![]() ![]() |
1..1 | code | (USCDI) proposal | plan | order | option Required Pattern: proposal | |
![]() ![]() ![]() |
2..* | CodeableConcept | (USCDI) Type of plan Slice: Unordered, Open by pattern:$this | |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | (USCDI) Type of plan Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 81378-2 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Goals, preferences, and priorities under certain health conditions [Reported] | |
![]() ![]() ![]() |
S | 1..1 | string | Human-friendly name for the care plan |
![]() ![]() ![]() |
S | 0..* | Reference(Condition) | 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) |
![]() ![]() ![]() |
S | 0..* | Reference(ADI PtAuthored Care Experience Preference) | Observations of a patient's preferences for the scope of this care plan. |
![]() ![]() ![]() |
S | 0..* | Reference(ADI Personal Goal) | Patient's goals for the scope of this care plan. |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | Reference(US Core ServiceRequest Profile) | Activity details defined in specific resource | |
![]() |
Id | Grade | Path(s) | Details | Requirements |
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
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | USCoreCarePlanProfile | Healthcare plan for patient or group Constraints: goal-or-supportingInfo-required | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
S | 0..1 | Narrative | (USCDI) 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 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | code | (USCDI) generated | extensions | additional | empty Binding: US Core Narrative Status (required): Constrained value set of narrative statuses. | ||||
![]() ![]() ![]() ![]() |
SC | 1..1 | xhtml | (USCDI) Limited xhtml content Constraints: txt-1, txt-2 | ||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
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: hl7VS-yes-no-Indicator (extensible) | |||||
![]() ![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | External Ids for this plan | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiates FHIR protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(CarePlan) | Fulfills CarePlan | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(CarePlan) | CarePlan replaced by this CarePlan | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(CarePlan) | Part of referenced CarePlan | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | (USCDI) 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 | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | (USCDI) proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan Required Pattern: proposal | ||||
![]() ![]() ![]() |
SΣ | 2..* | CodeableConcept | (USCDI) Type of plan Slice: Unordered, Open by pattern:$this Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | (USCDI) Type of plan Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/careplan-category | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: assess-plan | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | (USCDI) Type of plan Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 81378-2 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Goals, preferences, and priorities under certain health conditions [Reported] | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Human-friendly name for the care plan | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Summary of nature of plan | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile) | (USCDI) Who the care plan is for | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period plan covers | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date record was first recorded | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who is the designated responsible party | ||||
![]() ![]() ![]() |
0..* | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who provided the content of the care plan | |||||
![]() ![]() ![]() |
0..* | Reference(CareTeam) | Who's involved in plan? | |||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(Condition) | 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) | ||||
![]() ![]() ![]() |
S | 0..* | Reference(ADI PtAuthored Care Experience Preference) | Observations of a patient's preferences for the scope of this care plan. | ||||
![]() ![]() ![]() |
S | 0..* | Reference(ADI Personal Goal) | Patient's goals for the scope of this care plan. | ||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | Action to occur as part of plan Constraints: cpl-3 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |||||
![]() ![]() ![]() ![]() |
0..* | Annotation | Comments about the activity status/progress | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | Reference(US Core ServiceRequest Profile) | Activity details defined in specific resource | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | In-line definition of activity | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | uri | Instantiates external protocol or definition | |||||
![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why activity is needed | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Reference(Goal) | Goals this activity relates to | |||||
![]() ![]() ![]() ![]() ![]() |
?! | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Reason for current status | |||||
![]() ![]() ![]() ![]() ![]() |
?! | 0..1 | boolean | If true, activity is prohibiting action | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | When activity is to occur | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Timing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Location) | Where it should happen | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | Who will be responsible? | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Medication | Substance) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | How to consume/day? | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | How much to administer/supply/consume | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Extra info describing activity to perform | |||||
![]() ![]() ![]() |
0..* | Annotation | Comments about the plan | |||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
CarePlan.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
CarePlan.text.status | required | NarrativeStatushttp://hl7.org/fhir/us/core/ValueSet/us-core-narrative-status | ||||
CarePlan.status | required | Pattern Value: activehttp://hl7.org/fhir/ValueSet/request-status From the FHIR Standard | ||||
CarePlan.intent | required | Pattern Value: proposalhttp://hl7.org/fhir/ValueSet/care-plan-intent From the FHIR Standard | ||||
CarePlan.category | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-category From the FHIR Standard | ||||
CarePlan.category:AssessPlan | example | Pattern Value: assess-planhttp://hl7.org/fhir/ValueSet/care-plan-category From the FHIR Standard | ||||
CarePlan.category:advance_care_planning | example | Pattern Value: LOINC Code 81378-2("Goals, preferences, and priorities under certain health conditions [Reported]")http://hl7.org/fhir/ValueSet/care-plan-category From the FHIR Standard | ||||
CarePlan.activity.outcomeCodeableConcept | example | CarePlanActivityOutcomehttp://hl7.org/fhir/ValueSet/care-plan-activity-outcome From the FHIR Standard | ||||
CarePlan.activity.detail.kind | required | CarePlanActivityKindhttp://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1 From the FHIR Standard | ||||
CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code From the FHIR Standard | ||||
CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings From the FHIR Standard | ||||
CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1 From the FHIR Standard | ||||
CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() | |
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
Summary
Mandatory: 2 elements
Must-Support: 5 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron