This page is part of the electronic Long-Term Services and Supports Implementation Guide (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/us/eltss/StructureDefinition/careplan-eltss
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from US Core CarePlan Profile
This structure is derived from US Core CarePlan Profile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | |||
contained | 0..* | Reference(DocumentReference) | Risk Management Plan | |
partOf | 0..* | Reference(CarePlan) | Emergency Backup Plan | |
subject | 1..1 | Reference(US Core Patient Profile) | CarePlan Subject | |
period | S | 0..1 | Period | Plan Effective Date |
author | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Support Planner | |
addresses | S | 0..* | Reference(Condition) | Assessed Need |
activity | 0..* | BackboneElement | ||
detail | 0..1 | BackboneElement | Step or Action | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | I | 0..* | US Core CarePlan Profile | |
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) Max Binding: AllLanguages | |
text | S | 1..1 | Narrative | 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 | generated | extensions | additional | empty Binding: Narrative Status (required) |
div | I | 1..1 | xhtml | 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..* | Reference(DocumentReference) | Risk Management Plan | |
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) | Fulfills CarePlan |
replaces | Σ | 0..* | Reference(CarePlan) | CarePlan replaced by this CarePlan |
partOf | Σ | 0..* | Reference(CarePlan) | Emergency Backup Plan |
status | ?!SΣ | 1..1 | code | draft | active | suspended | completed | entered-in-error | cancelled | unknown Binding: RequestStatus (required) |
intent | ?!SΣ | 1..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required) |
category | SΣI | 1..* | CodeableConcept | Type of plan Binding: CarePlanCategory (example) us-core-1: Must have a category of 'assess-plan' and a code system 'http://hl7.org/fhir/us/core/CodeSystem/careplan-category' |
title | Σ | 0..1 | string | Human-friendly name for the care plan |
description | Σ | 0..1 | string | Summary of nature of plan |
subject | Σ | 1..1 | Reference(US Core Patient Profile) | CarePlan Subject |
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of |
period | SΣ | 0..1 | Period | Plan Effective Date |
created | Σ | 0..1 | dateTime | Date record was first recorded |
author | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Support Planner |
contributor | 0..* | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who provided the content of the care plan | |
careTeam | 0..* | Reference(CareTeam) | Who's involved in plan? | |
addresses | SΣ | 0..* | Reference(Condition) | Assessed Need |
supportingInfo | 0..* | Reference(Resource) | Information considered as part of plan | |
goal | 0..* | Reference(Goal) | Desired outcome of plan | |
activity | I | 0..* | BackboneElement | Action to occur as part of plan |
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) | |
outcomeReference | 0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |
progress | 0..* | Annotation | Comments about the activity status/progress | |
reference | I | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource |
detail | I | 0..1 | BackboneElement | Step or Action |
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 |
kind | 0..1 | code | Kind of resource Binding: CarePlanActivityKind (required) | |
instantiatesCanonical | 0..* | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | |
instantiatesUri | 0..* | uri | Instantiates external protocol or definition | |
code | 0..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example) | |
reasonCode | 0..* | CodeableConcept | Why activity should be done or why activity was prohibited Binding: SNOMEDCTClinicalFindings (example) | |
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why activity is needed | |
goal | 0..* | Reference(Goal) | Goals this activity relates to | |
status | ?! | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error Binding: CarePlanActivityStatus (required) |
statusReason | 0..1 | CodeableConcept | Reason for current status | |
doNotPerform | ?! | 0..1 | boolean | If true, activity is prohibiting action |
scheduled[x] | 0..1 | Timing, Period, string | When activity is to occur | |
location | 0..1 | Reference(Location) | Where it should happen | |
performer | 0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | Who will be responsible? | |
product[x] | 0..1 | CodeableConcept, Reference(Medication | Substance) | What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example) | |
dailyAmount | 0..1 | SimpleQuantity | How to consume/day? | |
quantity | 0..1 | SimpleQuantity | How much to administer/supply/consume | |
description | 0..1 | string | Extra info describing activity to perform | |
note | 0..* | Annotation | Comments about the plan | |
Documentation for this format |
This structure is derived from US Core CarePlan Profile
Differential View
This structure is derived from US Core CarePlan Profile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | |||
contained | 0..* | Reference(DocumentReference) | Risk Management Plan | |
partOf | 0..* | Reference(CarePlan) | Emergency Backup Plan | |
subject | 1..1 | Reference(US Core Patient Profile) | CarePlan Subject | |
period | S | 0..1 | Period | Plan Effective Date |
author | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Support Planner | |
addresses | S | 0..* | Reference(Condition) | Assessed Need |
activity | 0..* | BackboneElement | ||
detail | 0..1 | BackboneElement | Step or Action | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | I | 0..* | US Core CarePlan Profile | |
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) Max Binding: AllLanguages | |
text | S | 1..1 | Narrative | 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 | generated | extensions | additional | empty Binding: Narrative Status (required) |
div | I | 1..1 | xhtml | 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..* | Reference(DocumentReference) | Risk Management Plan | |
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) | Fulfills CarePlan |
replaces | Σ | 0..* | Reference(CarePlan) | CarePlan replaced by this CarePlan |
partOf | Σ | 0..* | Reference(CarePlan) | Emergency Backup Plan |
status | ?!SΣ | 1..1 | code | draft | active | suspended | completed | entered-in-error | cancelled | unknown Binding: RequestStatus (required) |
intent | ?!SΣ | 1..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required) |
category | SΣI | 1..* | CodeableConcept | Type of plan Binding: CarePlanCategory (example) us-core-1: Must have a category of 'assess-plan' and a code system 'http://hl7.org/fhir/us/core/CodeSystem/careplan-category' |
title | Σ | 0..1 | string | Human-friendly name for the care plan |
description | Σ | 0..1 | string | Summary of nature of plan |
subject | Σ | 1..1 | Reference(US Core Patient Profile) | CarePlan Subject |
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of |
period | SΣ | 0..1 | Period | Plan Effective Date |
created | Σ | 0..1 | dateTime | Date record was first recorded |
author | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Support Planner |
contributor | 0..* | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who provided the content of the care plan | |
careTeam | 0..* | Reference(CareTeam) | Who's involved in plan? | |
addresses | SΣ | 0..* | Reference(Condition) | Assessed Need |
supportingInfo | 0..* | Reference(Resource) | Information considered as part of plan | |
goal | 0..* | Reference(Goal) | Desired outcome of plan | |
activity | I | 0..* | BackboneElement | Action to occur as part of plan |
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) | |
outcomeReference | 0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |
progress | 0..* | Annotation | Comments about the activity status/progress | |
reference | I | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource |
detail | I | 0..1 | BackboneElement | Step or Action |
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 |
kind | 0..1 | code | Kind of resource Binding: CarePlanActivityKind (required) | |
instantiatesCanonical | 0..* | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | |
instantiatesUri | 0..* | uri | Instantiates external protocol or definition | |
code | 0..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example) | |
reasonCode | 0..* | CodeableConcept | Why activity should be done or why activity was prohibited Binding: SNOMEDCTClinicalFindings (example) | |
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why activity is needed | |
goal | 0..* | Reference(Goal) | Goals this activity relates to | |
status | ?! | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error Binding: CarePlanActivityStatus (required) |
statusReason | 0..1 | CodeableConcept | Reason for current status | |
doNotPerform | ?! | 0..1 | boolean | If true, activity is prohibiting action |
scheduled[x] | 0..1 | Timing, Period, string | When activity is to occur | |
location | 0..1 | Reference(Location) | Where it should happen | |
performer | 0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | Who will be responsible? | |
product[x] | 0..1 | CodeableConcept, Reference(Medication | Substance) | What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example) | |
dailyAmount | 0..1 | SimpleQuantity | How to consume/day? | |
quantity | 0..1 | SimpleQuantity | How much to administer/supply/consume | |
description | 0..1 | string | Extra info describing activity to perform | |
note | 0..* | Annotation | Comments about the plan | |
Documentation for this format |
Other representations of profile: Schematron
Path | Conformance | ValueSet |
CarePlan.text.status | required | Narrative_Status |
CarePlan.status | required | RequestStatus |
CarePlan.intent | required | CarePlanIntent |
CarePlan.category | example | CarePlanCategory |
Id | Path | Details | Requirements |
dom-2 | CarePlan | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-4 | 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-3 | 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-6 | CarePlan | A resource should have narrative for robust management : text.div.exists() | |
dom-5 | CarePlan | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
txt-1 | 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 | CarePlan.text.div | The narrative SHALL have some non-whitespace content : htmlChecks() | |
us-core-1 | CarePlan.category | Must have a category of 'assess-plan' and a code system 'http://hl7.org/fhir/us/core/CodeSystem/careplan-category' : where(coding.system='http://hl7.org/fhir/us/core/CodeSystem/careplan-category' and coding.code='assess-plan').exists() | |
ele-1 | CarePlan.activity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
cpl-3 | CarePlan.activity | Provide a reference or detail, not both : detail.empty() or reference.empty() | |
ele-1 | CarePlan.activity.detail | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |