Electronic Long-Term Services and Supports (eLTSS) Release 1 - US Realm, published by HL7 International / Human and Social Services. 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/eLTSS/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/eltss/StructureDefinition/CarePlan-eltss | Version: 2.0.0 | |||
Standards status: Trial-use | Maturity Level: 2 | Computable Name: CarePlan_eltss |
CarePlan for eLTSS
The following aids in finding the location of eLTSS data elements. See R4 FHIR Mapping page for complete guidance, here we are providing a subset of fields for convenience. The CarePlan Resource links to all eLTSS data elements, while specific elements are provided below the implementer should review all the guidance on R4 FHIR Mapping page. This is especially important for ServiceRequest related items, Person Centered Planning concepts such as “Person Setting Choice Options,” risk assessments, signatures and financial data.
eLTSS Grouping | eLTSS Data Element Name | Data Element Definition (includes examples, expected list of values and usage note where applicable) | FHIR R4 Resource Element(s) | FHIR R4 Resource Element Cardinality (with US Core Constraints) | Additional Mapping Details |
---|---|---|---|---|---|
Goals & Strengths | Step or Action | A planned measurable step or action that needs to be taken to accomplish a goal identified by the person. |
CarePlan → activity → reference(Resource) → note → text → extension(pertainsToGoal) |
CarePlan ...activity 0..* ......reference(Resource) 0..1 .........note 0..* ............text 1 .........extension(pertainsToGoal) |
1) CarePlan includes activity → reference, which can be a reference to ServiceRequest, Task or other Resource. 2) ServiceRequest would be used when the Step or Action is a task under a service. If the Step or Action is an informal support or an activity being undertaken by the patient/care recipient, the Task Resource, similar to a Patient Task used in the Gravity SDOH IG, can be used. 3) activity → reference(Resource) is linked to the Goal the step or action addresses through the pertainsToGoal Extension in the referenced activity. 4) activity → reference(Resource) includes a performer, author, participant with type or other data element that can be used to reference who is responsible for performing the step or action, such as to indicate that the person or a related person is responsible. 5) text is where the Step or Action text would be provided. 6) text is required by FHIR if note is provided. 7) Note that a stated goal may lead directly to a service, and not necessarily to an explicit Step or Action. For example, a person's goal could be to attend church regularly, and this would be achieved through a transportation service. |
Goals & Strengths | Strength | A favorable attribute of oneself, his/her support network, environment and/or elements of his/her life. | CarePlan → supportingInfo(Observation) Observation → valueString Observation → code → coding → code Observation → code → coding → system |
CarePlan ...supportingInfo(Observation) 0..* ......valueString 0..1 ......code 1 ........coding 0..* ..........code 0..1 ............system 0..1 |
1) Will use CarePlan → supportingInfo to reference the Observation containing the Strength. 2) code is required by FHIR, and is a CodeableConcept where coding → code can be set to "Strength" with the corresponding NEW code → system "http://hl7.org/us/eLTSS/CodeSystem/eltss-observation-code". 3) valueString is where the Strength text would be provided. |
Person Centered Planning | Assessed Need | The clinical and/or community-based necessity or desire as identified through an assessment that should be addressed by a service. | CarePlan → addresses(Condition) Condition → code → text Condition → category |
CarePlan ...addresses(Condition) 0..* ......code 1 .........text 0..1 ......category 1..* |
1) Will use CarePlan → addresses to reference the Condition(s) for the care plan being developed. 2) code is required by US Core and is a CodeableConcept which per US Core is bound to the extensible Problem Value Set. That value set is based on SNOMED-CT and includes very specific values that do not line up with assessed needs. Per US Core's documentation on extensible CodeableConcepts, the CodeableConcept's text element can be used "if no suitable codes exist", so we can use the text element for the assessed need. Additionally, the Gravity SDOH FHIR IG has a value set of SDOH conditions. 3) Each assessed need should go into a separate Condition element so each can potentially be linked to a service(s) that addresses it. 4) Category is required by US Core and is a CodeableConcept which per US Core is bound to the extensible US Core Condition Category Codes value set (http://hl7.org/fhir/ValueSet/condition-category) which has values: problem-list-item, encounter-diagnosis and health-concern. The additional 'assessed-need' code can be used to relate that the Condition instance is about the clinical and/or community-based necessity or desire, as identified through an assessment, that should be addressed by a service. Consider also using the US Core 6.1.0 screening-assessment categories https://www.hl7.org/fhir/us/core/ValueSet-us-core-screening-assessment-condition-category.html. 5) An "assessed need" condition can refer to another condition via the condition-dueTo extension. |
Person Centered Planning | Plan Monitor Name | The name of the person responsible for monitoring the plan. | CarePlan → encounter (Encounter) Encounter → episodeOfCare(EpisodeOfCare) EpisodeOfCare → careManager(Practitioner) Practitioner → name → family Practitioner → name → given Practitioner → name → text |
CarePlan ...encounter(Encounter) 0..1 ...... episodeOfCare(EpisodeOfCare)0..1 .........careManager(Practitioner) 0..1 ............name 0..* ...............family 0-1 ................given 0-* ................text 0-1 |
1) Will use CarePlan → encounter to reference the EpisodeOfCare that defines the plan monitor (care manager) for the plan. 2) EpisodeOfCare → careManager references the Practitioner who is monitoring the plan. 3) given is used for both first name & MI, so need more than one. 4) family is a string with the person's surname. 5) text is a string that contains the full name of the person. 6) The values for Plan Monitor Name and Plan Monitor Printed Name would include the same information. |
Person Centered Planning | Plan Monitor Phone Number | The primary phone number (and extension when applicable) of the plan monitor. | CarePlan → encounter (Encounter) Encounter → episodeOfCare(EpisodeOfCare) EpisodeOfCare → careManager(Practitioner) Practitioner → telecom → system Practitioner → telecom → value |
CarePlan ...encounter(Encounter) 0..1 ...... episodeOfCare(EpisodeOfCare)0..1 .........careManager(Practitioner) 0..1 ............telecom 0..* ...............system 0..1 ................value 0..1 |
1) Will use CarePlan → encounter to reference the EpisodeOfCare that defines the plan monitor (care manager) for the plan. 2) EpisodeOfCare → careManager references the Practitioner who is monitoring the plan. 3) telecom is of type ContactPoint (https://www.hl7.org/fhir/datatypes.html#contactpoint) which contains elements to populate for the phone number. 4) system is required if value is provided, and can be: phone, fax, email, pager, url, sms, other. 5) Per FHIR, phone # should be formatted according to ITU-T E.123, so "(555) 675 5745" or "+22 555 675 5745". |
Person Centered Planning | Preference | Presents the person's personal thoughts about something he or she feels is relevant to his or her life experience and may be pertinent when planning. | CarePlan → supportingInfo(Observation) Observation → valueString Observation → code → coding → code Observation → code → coding → system |
CarePlan ...supportingInfo(Observation) 0..* ......valueString 0..1 ......code 1 .........coding 0..* ............code 0..1 ............system 0..1 |
1) Will use CarePlan → supportingInfo to reference the Observation containing the Preference. 2) code is required by FHIR and is a CodeableConcept where coding → code can be set to "Preference" with the corresponding NEW code -> system "http://hl7.org/us/eLTSS/CodeSystem/eltss-observation-code". 3) valueString is where the Preference text would be provided. |
Plan Information | Plan Effective Date | The date upon which the plan goes into effect. Start date is required, end date is optional. |
CarePlan → period → start CarePlan → period → end |
CarePlan 0..* ...period 0..1 ......start 1 ......end 0..1 |
1) period includes a start and an end element, which are both dateTime formats which can be date, date-time or partial date (e.g. just year or year + month). 2) start is required by eLTSS. |
Service Provider Information | Support Planner Name | The name of the person (e.g., Case Manager, Care Coordinator, Plan Coordinator) who helped develop the plan. | CarePlan → author(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization | CareTeam) Practitioner | Patient | RelatedPerson → name → family Practitioner | Patient | RelatedPerson → name → given Practitioner | Patient | RelatedPerson → name → text Organization | CareTeam → name |
CarePlan ...author(Patient | Practitioner | RelatedPerson ) 0..1 ......name 0..* .........family 0..1 .........given 0..* .........text 0..1 CarePlan …author(Organization | CareTeam ) 0..1 ......name 0..1 |
1) Will use CarePlan → author to reference a Practitioner, PractitionerRole, RelatedPerson, Organization, CareTeam or Patient (in self-directed plans) who is the primary author of the care plan being developed. 2) Practitioner, Organization, CareTeam, RelatedPerson and Patient all include name. 3) PractitionerRole should be used when the Organization for whom the Practitioner works for is also needed. 4) given is used for both first name & MI, so need more than one. 5) family is a string with the person's surname. 6) text is a string that contains the full name of the person. 7) The values for Support Planner Name and Support Planner Printed Name would include the same information. |
Service Provider Information | Support Planner Phone Number | The primary phone number (and extension when applicable) of the support planner. | CarePlan → author(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization | CareTeam ) Patient | Practitioner | PractitionerRole | RelatedPerson | Organization | CareTeam → telecom → system Patient | Practitioner | PractitionerRole | RelatedPerson | Organization | CareTeam → telecom → value |
CarePlan ...author(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization | CareTeam ) 0..1 ......telecom 0..* .........system 0..1 .........value 0..1 |
1) Will use CarePlan → author to reference a Practitioner, PractitionerRole, RelatedPerson, Organization, CareTeam or Patient (in self-directed plan) who is the primary author of the care plan being developed. 2) Practitioner, PractitionerRole, RelatedPerson, Organization, CareTeam and Patient all include telecom. 3) PractitionerRole should be used when the Organization for whom the Practitioner works for is also needed. 4) telecom is of type ContactPoint which contains elements to populate for the phone number. 5) system is required if value is provided, and can be: phone, fax, email, pager, url, sms, other. 6) Per FHIR, phone # should be formatted according to ITU-T E.123, so "(555) 675 5745" or "+22 555 675 5745". |
Data Requirements Not Specific to eLTSS Dataset Data Elements This section documents data elements that are mandatory per FHIR XML schemas or US Core requirements, but that do not align with individual eLTSS Dataset data elements. |
||||
---|---|---|---|---|
FHIR Data Element Name Requirement Source |
Data Element Definition | FHIR R4 Resource Element(s) | FHIR R4 Resource Element Cardinality (with US Core Constraints) | Additional Mapping Details |
CarePlan Status FHIR US Core |
Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. | CarePlan → status | CarePlan ...status 1 |
1) status is required by both FHIR and US Core, and must use the RequestStatus value set (http://hl7.org/fhir/valueset-request-status.html). Possible values are: draft, active, suspended, completed, entered-in-error, cancelled, and unknown. |
CarePlan Intent FHIR US Core |
Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain. | CarePlan → intent | CarePlan ...intent 1 |
1) intent is required by both FHIR and US Core, and must use the CarePlanIntent value set (http://hl7.org/fhir/valueset-care-plan-intent.html). Possible values are: proposal, plan, order, and option. |
CarePlan Narrative Summary US Core |
Text summary of the resource, for human interpretation. The narrative is an XHTML fragment with a flag to indicate its relationship to the data. | CarePlan → text → status CarePlan → text → div |
CarePlan ...text 1 ......status 1 ......div 1 |
1) text is required by US Core. 2) status is required by FHIR and must use the NarrativeStatus value set (http://hl7.org/fhir/us/core/2019Jan/ValueSet-us-core-narrative-status.html). Possible values are: generated, additional. 3) div is required by FHIR and contains limited xhtml content that contains only the basic html formatting elements and attributes. |
CarePlan Category US Core |
Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc. | CarePlan → category → coding → system CarePlan → category → coding → code |
CarePlan ...category 1..* ......coding 1..* .........system 1 .........code 1 |
1) Per US Core, one category must appear, and must include system with the value "http://hl7.org/fhir/us/core/CodeSystem/careplan-category" and code with the value "assess-plan". 2) US Core does not restrict the number of additional category elements that may appear. |
CarePlan Activity Status FHIR |
Identifies what progress is being made for the specific activity. | CarePlan → activity → reference(Resource) → status and CarePlan→ activity → progress |
CarePlan ...activity ......reference(Resource) .........status 1 and CarePlan ...activity ......progress |
1) status is required by FHIR in Resources Reference by CarePlan.activity.reference. Possible values are: not-started, scheduled, in-progress, on-hold, completed, cancelled, stopped, unknown, and entered-in-error. 2) There is also CarePlan.activity.progress to add a free-text description of the progress, or note. CarePlan.activity.progress is an Annotation data type in FHIR, this means it can be dated and contain the identification of the person who uttered the text. This might be used, for example, when the status stays in the same state, i.e. 'in-progress,' but where there is a evolution of that progress. |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreCarePlanProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | USCoreCarePlanProfile | eLTSS Healthcare plan for patient or group | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
text | S | 0..1 | Narrative | (USCDI) Text summary of the resource, for human interpretation |
status | S | 1..1 | code | (USCDI) generated | extensions | additional | empty Binding: US Core Narrative Status (required): Constrained value set of narrative statuses. |
div | SC | 1..1 | xhtml | (USCDI) Limited xhtml content txt-1: 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 txt-2: The narrative SHALL have some non-whitespace content |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
basedOn | Σ | 0..* | Reference(CarePlan_eltss) | Fulfills CarePlan |
replaces | Σ | 0..* | Reference(CarePlan_eltss) | CarePlan replaced by this CarePlan |
partOf | SΣ | 0..* | Reference(CarePlan_eltss) | Emergency Backup Plan |
status | ?!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. |
intent | ?!SΣ | 1..1 | code | (USCDI) proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan |
Slices for category | SΣ | 1..* | 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. |
category:AssessPlan | 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 |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/careplan-category | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: assess-plan | |
subject | SΣ | 1..1 | Reference(Patient_eltss) | CarePlan Subject |
encounter | SΣ | 0..1 | Reference(Encounter) | Encounter created as part of |
period | SΣ | 0..1 | Period | Plan Effective Date |
start | SΣC | 1..1 | dateTime | Starting time with inclusive boundary |
end | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
author | SΣ | 0..1 | Reference(Practitioner_eltss | eLTSS PractitionerRole Profile) | Support Planner |
contributor | 0..* | Reference(Patient_eltss | Practitioner_eltss | eLTSS PractitionerRole Profile | eLTSS RelatedPerson Profile | US Core Organization Profile | US Core CareTeam Profile) | Who provided the content of the care plan | |
addresses | SΣ | 0..* | Reference(Condition_eltss) | Assessed Need |
supportingInfo | S | 0..* | Reference(Resource) | Information considered as part of plan |
goal | S | 0..* | Reference(Goal_eltss) | Desired outcome of plan |
activity | SC | 0..* | BackboneElement | Action to occur as part of a plan cpl-3: Provide a reference or detail, not both |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
reference | SC | 0..1 | Reference(Appointment | Task | ServiceRequest_eltss) | Activity details defined in specific resource |
note | S | 0..* | Annotation | Comments about the plan |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
CarePlan.text.status | required | NarrativeStatushttp://hl7.org/fhir/us/core/ValueSet/us-core-narrative-status | |
CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status from the FHIR Standard | |
CarePlan.intent | required | CarePlanIntenthttp://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: assess-planhttp://hl7.org/fhir/ValueSet/care-plan-category 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 |
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() | |
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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
CarePlan | 0..* | USCoreCarePlanProfile | eLTSS Healthcare plan for patient or group | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | S | 0..1 | Narrative | (USCDI) Text summary of the resource, for human interpretation | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
status | S | 1..1 | code | (USCDI) generated | extensions | additional | empty Binding: US Core Narrative Status (required): Constrained value set of narrative statuses. | ||||
div | SC | 1..1 | xhtml | (USCDI) Limited xhtml content txt-1: 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 txt-2: The narrative SHALL have some non-whitespace content | ||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | External Ids for this plan | ||||
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
basedOn | Σ | 0..* | Reference(CarePlan_eltss) | Fulfills CarePlan | ||||
replaces | Σ | 0..* | Reference(CarePlan_eltss) | CarePlan replaced by this CarePlan | ||||
partOf | SΣ | 0..* | Reference(CarePlan_eltss) | Emergency Backup Plan | ||||
status | ?!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. | ||||
intent | ?!SΣ | 1..1 | code | (USCDI) proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan | ||||
Slices for category | SΣ | 1..* | 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. | ||||
category:AssessPlan | 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 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/careplan-category | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: assess-plan | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
title | Σ | 0..1 | string | Human-friendly name for the care plan | ||||
description | Σ | 0..1 | string | Summary of nature of plan | ||||
subject | SΣ | 1..1 | Reference(Patient_eltss) | CarePlan Subject | ||||
encounter | SΣ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
period | SΣ | 0..1 | Period | Plan Effective Date | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | SΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
end | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
created | Σ | 0..1 | dateTime | Date record was first recorded | ||||
author | SΣ | 0..1 | Reference(Patient_eltss | Practitioner_eltss S | eLTSS PractitionerRole Profile S | eLTSS RelatedPerson Profile | US Core Organization Profile | US Core CareTeam Profile) | Support Planner | ||||
contributor | 0..* | Reference(Patient_eltss | Practitioner_eltss | eLTSS PractitionerRole Profile | eLTSS RelatedPerson Profile | US Core Organization Profile | US Core CareTeam Profile) | Who provided the content of the care plan | |||||
careTeam | 0..* | Reference(CareTeam) | Who's involved in plan? | |||||
addresses | SΣ | 0..* | Reference(Condition_eltss) | Assessed Need | ||||
supportingInfo | S | 0..* | Reference(Resource) | Information considered as part of plan | ||||
goal | S | 0..* | Reference(Goal_eltss) | Desired outcome of plan | ||||
activity | SC | 0..* | BackboneElement | Action to occur as part of a plan cpl-3: Provide a reference or detail, not both | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
outcomeCodeableConcept | 0..* | CodeableConcept | Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. | |||||
outcomeReference | 0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |||||
progress | 0..* | Annotation | Comments about the activity status/progress | |||||
reference | SC | 0..1 | Reference(Appointment S | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task S | ServiceRequest_eltss S | VisionPrescription | RequestGroup) | Activity details defined in specific resource | ||||
note | S | 0..* | Annotation | Comments about the plan | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
CarePlan.language | preferred | CommonLanguages
http://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 | RequestStatushttp://hl7.org/fhir/ValueSet/request-status from the FHIR Standard | ||||
CarePlan.intent | required | CarePlanIntenthttp://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: assess-planhttp://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() | |
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: 0 element(1 nested mandatory element)
Must-Support: 12 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Maturity: 2
Differential View
This structure is derived from USCoreCarePlanProfile
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | USCoreCarePlanProfile | eLTSS Healthcare plan for patient or group | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
text | S | 0..1 | Narrative | (USCDI) Text summary of the resource, for human interpretation |
status | S | 1..1 | code | (USCDI) generated | extensions | additional | empty Binding: US Core Narrative Status (required): Constrained value set of narrative statuses. |
div | SC | 1..1 | xhtml | (USCDI) Limited xhtml content txt-1: 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 txt-2: The narrative SHALL have some non-whitespace content |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
basedOn | Σ | 0..* | Reference(CarePlan_eltss) | Fulfills CarePlan |
replaces | Σ | 0..* | Reference(CarePlan_eltss) | CarePlan replaced by this CarePlan |
partOf | SΣ | 0..* | Reference(CarePlan_eltss) | Emergency Backup Plan |
status | ?!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. |
intent | ?!SΣ | 1..1 | code | (USCDI) proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan |
Slices for category | SΣ | 1..* | 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. |
category:AssessPlan | 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 |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/careplan-category | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: assess-plan | |
subject | SΣ | 1..1 | Reference(Patient_eltss) | CarePlan Subject |
encounter | SΣ | 0..1 | Reference(Encounter) | Encounter created as part of |
period | SΣ | 0..1 | Period | Plan Effective Date |
start | SΣC | 1..1 | dateTime | Starting time with inclusive boundary |
end | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
author | SΣ | 0..1 | Reference(Practitioner_eltss | eLTSS PractitionerRole Profile) | Support Planner |
contributor | 0..* | Reference(Patient_eltss | Practitioner_eltss | eLTSS PractitionerRole Profile | eLTSS RelatedPerson Profile | US Core Organization Profile | US Core CareTeam Profile) | Who provided the content of the care plan | |
addresses | SΣ | 0..* | Reference(Condition_eltss) | Assessed Need |
supportingInfo | S | 0..* | Reference(Resource) | Information considered as part of plan |
goal | S | 0..* | Reference(Goal_eltss) | Desired outcome of plan |
activity | SC | 0..* | BackboneElement | Action to occur as part of a plan cpl-3: Provide a reference or detail, not both |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
reference | SC | 0..1 | Reference(Appointment | Task | ServiceRequest_eltss) | Activity details defined in specific resource |
note | S | 0..* | Annotation | Comments about the plan |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
CarePlan.text.status | required | NarrativeStatushttp://hl7.org/fhir/us/core/ValueSet/us-core-narrative-status | |
CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status from the FHIR Standard | |
CarePlan.intent | required | CarePlanIntenthttp://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: assess-planhttp://hl7.org/fhir/ValueSet/care-plan-category 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 |
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() | |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
CarePlan | 0..* | USCoreCarePlanProfile | eLTSS Healthcare plan for patient or group | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | S | 0..1 | Narrative | (USCDI) Text summary of the resource, for human interpretation | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
status | S | 1..1 | code | (USCDI) generated | extensions | additional | empty Binding: US Core Narrative Status (required): Constrained value set of narrative statuses. | ||||
div | SC | 1..1 | xhtml | (USCDI) Limited xhtml content txt-1: 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 txt-2: The narrative SHALL have some non-whitespace content | ||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | External Ids for this plan | ||||
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
basedOn | Σ | 0..* | Reference(CarePlan_eltss) | Fulfills CarePlan | ||||
replaces | Σ | 0..* | Reference(CarePlan_eltss) | CarePlan replaced by this CarePlan | ||||
partOf | SΣ | 0..* | Reference(CarePlan_eltss) | Emergency Backup Plan | ||||
status | ?!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. | ||||
intent | ?!SΣ | 1..1 | code | (USCDI) proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan | ||||
Slices for category | SΣ | 1..* | 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. | ||||
category:AssessPlan | 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 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/careplan-category | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: assess-plan | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
title | Σ | 0..1 | string | Human-friendly name for the care plan | ||||
description | Σ | 0..1 | string | Summary of nature of plan | ||||
subject | SΣ | 1..1 | Reference(Patient_eltss) | CarePlan Subject | ||||
encounter | SΣ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
period | SΣ | 0..1 | Period | Plan Effective Date | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | SΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
end | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
created | Σ | 0..1 | dateTime | Date record was first recorded | ||||
author | SΣ | 0..1 | Reference(Patient_eltss | Practitioner_eltss S | eLTSS PractitionerRole Profile S | eLTSS RelatedPerson Profile | US Core Organization Profile | US Core CareTeam Profile) | Support Planner | ||||
contributor | 0..* | Reference(Patient_eltss | Practitioner_eltss | eLTSS PractitionerRole Profile | eLTSS RelatedPerson Profile | US Core Organization Profile | US Core CareTeam Profile) | Who provided the content of the care plan | |||||
careTeam | 0..* | Reference(CareTeam) | Who's involved in plan? | |||||
addresses | SΣ | 0..* | Reference(Condition_eltss) | Assessed Need | ||||
supportingInfo | S | 0..* | Reference(Resource) | Information considered as part of plan | ||||
goal | S | 0..* | Reference(Goal_eltss) | Desired outcome of plan | ||||
activity | SC | 0..* | BackboneElement | Action to occur as part of a plan cpl-3: Provide a reference or detail, not both | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
outcomeCodeableConcept | 0..* | CodeableConcept | Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. | |||||
outcomeReference | 0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |||||
progress | 0..* | Annotation | Comments about the activity status/progress | |||||
reference | SC | 0..1 | Reference(Appointment S | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task S | ServiceRequest_eltss S | VisionPrescription | RequestGroup) | Activity details defined in specific resource | ||||
note | S | 0..* | Annotation | Comments about the plan | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
CarePlan.language | preferred | CommonLanguages
http://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 | RequestStatushttp://hl7.org/fhir/ValueSet/request-status from the FHIR Standard | ||||
CarePlan.intent | required | CarePlanIntenthttp://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: assess-planhttp://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() | |
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: 0 element(1 nested mandatory element)
Must-Support: 12 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron