Electronic Long-Term Services and Supports (eLTSS) Release 1 - US Realm

This page is part of the electronic Long-Term Services and Supports Implementation Guide (v1.0.0: STU 1) based on FHIR R4. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

StructureDefinition: CarePlan_eltss

The official URL for this profile is: 

http://hl7.org/fhir/us/eltss/StructureDefinition/CarePlan-eltss

Formal Views of Profile Content

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

This structure is derived from USCoreCarePlanProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*eLTSS Healthcare plan for patient or group
... instantiatesCanonical 0..*canonical(PlanDefinition | Questionnaire_eltss | Measure | ActivityDefinition | OperationDefinition)
... basedOn 0..*Reference(CarePlan_eltss)
... replaces 0..*Reference(CarePlan_eltss)
... partOf 0..*Reference(CarePlan_eltss)Emergency Backup Plan
... subject 1..1Reference(Patient_eltss)CarePlan Subject
... period S0..1PeriodPlan Effective Date
... author 0..1Reference(Patient_eltss | Practitioner_eltss | US Core PractitionerRole Profile | RelatedPerson | US Core Organization Profile | US Core CareTeam Profile)Support Planner
... contributor 0..*Reference(Patient_eltss | Practitioner_eltss | US Core PractitionerRole Profile | RelatedPerson | US Core Organization Profile | US Core CareTeam Profile)
... addresses S0..*Reference(Condition_eltss)Assessed Need
... supportingInfo 0..*Reference(Resource)
... goal 0..*Reference(Goal_eltss)
... activity 0..*BackboneElementAction to occur as part of a plan
.... reference 0..1Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest_eltss | VisionPrescription | RequestGroup)
.... detail 0..1BackboneElementPlan Step or Action
..... instantiatesCanonical 0..*canonical(PlanDefinition | Questionnaire_eltss | Measure | ActivityDefinition | OperationDefinition)
..... reasonReference 0..*Reference(Condition_eltss | Observation_eltss | MedicationStatement | NutritionOrder)
..... goal 0..*Reference(Goal_eltss)
..... location 0..1Reference(Location_eltss)
..... performer 0..*Reference(Practitioner_eltss | US Core PractitionerRole Profile | RelatedPerson | Patient_eltss | US Core Organization Profile | US Core CareTeam Profile | HealthcareService | US Core Device Profile)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan I0..*eLTSS Healthcare plan for patient or group
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text S1..1NarrativeText summary of the resource, for human interpretation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... status S1..1codegenerated | extensions | additional | empty
Binding: US Core Narrative Status (required)
.... div I1..1xhtmlLimited 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..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this plan
... instantiatesCanonical Σ0..*canonical(PlanDefinition | Questionnaire_eltss | Measure | ActivityDefinition | OperationDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(CarePlan_eltss)Fulfills CarePlan
... replaces Σ0..*Reference(CarePlan_eltss)CarePlan replaced by this CarePlan
... partOf Σ0..*Reference(CarePlan_eltss)Emergency Backup Plan
... status ?!SΣ1..1codedraft | active | suspended | completed | entered-in-error | cancelled | unknown
Binding: RequestStatus (required)
... intent ?!SΣ1..1codeproposal | plan | order | option
Binding: CarePlanIntent (required)
... category SΣ1..*(Slice Definition)Type of plan
Slice: Unordered, Open by pattern:$this
Binding: CarePlanCategory (example)
.... category:assessplan SΣ1..1CodeableConceptType of plan
Binding: CarePlanCategory (example)

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/careplan-category
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: assess-plan
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
... title Σ0..1stringHuman-friendly name for the care plan
... description Σ0..1stringSummary of nature of plan
... subject SΣ1..1Reference(Patient_eltss)CarePlan Subject
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... period SΣ0..1PeriodPlan Effective Date
... created Σ0..1dateTimeDate record was first recorded
... author Σ0..1Reference(Patient_eltss | Practitioner_eltss | US Core PractitionerRole Profile | RelatedPerson | US Core Organization Profile | US Core CareTeam Profile)Support Planner
... contributor 0..*Reference(Patient_eltss | Practitioner_eltss | US Core PractitionerRole Profile | RelatedPerson | 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 0..*Reference(Resource)Information considered as part of plan
... goal 0..*Reference(Goal_eltss)Desired outcome of plan
... activity I0..*BackboneElementAction to occur as part of a plan
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... outcomeCodeableConcept 0..*CodeableConceptResults of the activity
Binding: CarePlanActivityOutcome (example)
.... outcomeReference 0..*Reference(Resource)Appointment, Encounter, Procedure, etc.
.... progress 0..*AnnotationComments about the activity status/progress
.... reference I0..1Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest_eltss | VisionPrescription | RequestGroup)Activity details defined in specific resource
.... detail I0..1BackboneElementPlan Step or Action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind 0..1codeKind of resource
Binding: CarePlanActivityKind (required)
..... instantiatesCanonical 0..*canonical(PlanDefinition | Questionnaire_eltss | Measure | ActivityDefinition | OperationDefinition)Instantiates FHIR protocol or definition
..... instantiatesUri 0..*uriInstantiates external protocol or definition
..... code 0..1CodeableConceptDetail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example)
..... reasonCode 0..*CodeableConceptWhy activity should be done or why activity was prohibited
Binding: SNOMEDCTClinicalFindings (example)
..... reasonReference 0..*Reference(Condition_eltss | Observation_eltss | MedicationStatement | NutritionOrder)Why activity is needed
..... goal 0..*Reference(Goal_eltss)Goals this activity relates to
..... status ?!1..1codenot-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required)
..... statusReason 0..1CodeableConceptReason for current status
..... doNotPerform ?!0..1booleanIf true, activity is prohibiting action
..... scheduled[x] 0..1When activity is to occur
...... scheduledTimingTiming
...... scheduledPeriodPeriod
...... scheduledStringstring
..... location 0..1Reference(Location_eltss)Where it should happen
..... performer 0..*Reference(Practitioner_eltss | US Core PractitionerRole Profile | RelatedPerson | Patient_eltss | US Core Organization Profile | US Core CareTeam Profile | HealthcareService | US Core Device Profile)Who will be responsible?
..... product[x] 0..1What is to be administered/supplied
Binding: SNOMEDCTMedicationCodes (example)
...... productCodeableConceptCodeableConcept
...... productReferenceReference(Medication | Substance)
..... dailyAmount 0..1SimpleQuantityHow to consume/day?
..... quantity 0..1SimpleQuantityHow much to administer/supply/consume
..... description 0..1stringExtra info describing activity to perform
... note 0..*AnnotationComments about the plan

doco Documentation for this format

Differential View

This structure is derived from USCoreCarePlanProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*eLTSS Healthcare plan for patient or group
... instantiatesCanonical 0..*canonical(PlanDefinition | Questionnaire_eltss | Measure | ActivityDefinition | OperationDefinition)
... basedOn 0..*Reference(CarePlan_eltss)
... replaces 0..*Reference(CarePlan_eltss)
... partOf 0..*Reference(CarePlan_eltss)Emergency Backup Plan
... subject 1..1Reference(Patient_eltss)CarePlan Subject
... period S0..1PeriodPlan Effective Date
... author 0..1Reference(Patient_eltss | Practitioner_eltss | US Core PractitionerRole Profile | RelatedPerson | US Core Organization Profile | US Core CareTeam Profile)Support Planner
... contributor 0..*Reference(Patient_eltss | Practitioner_eltss | US Core PractitionerRole Profile | RelatedPerson | US Core Organization Profile | US Core CareTeam Profile)
... addresses S0..*Reference(Condition_eltss)Assessed Need
... supportingInfo 0..*Reference(Resource)
... goal 0..*Reference(Goal_eltss)
... activity 0..*BackboneElementAction to occur as part of a plan
.... reference 0..1Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest_eltss | VisionPrescription | RequestGroup)
.... detail 0..1BackboneElementPlan Step or Action
..... instantiatesCanonical 0..*canonical(PlanDefinition | Questionnaire_eltss | Measure | ActivityDefinition | OperationDefinition)
..... reasonReference 0..*Reference(Condition_eltss | Observation_eltss | MedicationStatement | NutritionOrder)
..... goal 0..*Reference(Goal_eltss)
..... location 0..1Reference(Location_eltss)
..... performer 0..*Reference(Practitioner_eltss | US Core PractitionerRole Profile | RelatedPerson | Patient_eltss | US Core Organization Profile | US Core CareTeam Profile | HealthcareService | US Core Device Profile)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan I0..*eLTSS Healthcare plan for patient or group
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text S1..1NarrativeText summary of the resource, for human interpretation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... status S1..1codegenerated | extensions | additional | empty
Binding: US Core Narrative Status (required)
.... div I1..1xhtmlLimited 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..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this plan
... instantiatesCanonical Σ0..*canonical(PlanDefinition | Questionnaire_eltss | Measure | ActivityDefinition | OperationDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(CarePlan_eltss)Fulfills CarePlan
... replaces Σ0..*Reference(CarePlan_eltss)CarePlan replaced by this CarePlan
... partOf Σ0..*Reference(CarePlan_eltss)Emergency Backup Plan
... status ?!SΣ1..1codedraft | active | suspended | completed | entered-in-error | cancelled | unknown
Binding: RequestStatus (required)
... intent ?!SΣ1..1codeproposal | plan | order | option
Binding: CarePlanIntent (required)
... category SΣ1..*(Slice Definition)Type of plan
Slice: Unordered, Open by pattern:$this
Binding: CarePlanCategory (example)
.... category:assessplan SΣ1..1CodeableConceptType of plan
Binding: CarePlanCategory (example)

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/careplan-category
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: assess-plan
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
... title Σ0..1stringHuman-friendly name for the care plan
... description Σ0..1stringSummary of nature of plan
... subject SΣ1..1Reference(Patient_eltss)CarePlan Subject
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... period SΣ0..1PeriodPlan Effective Date
... created Σ0..1dateTimeDate record was first recorded
... author Σ0..1Reference(Patient_eltss | Practitioner_eltss | US Core PractitionerRole Profile | RelatedPerson | US Core Organization Profile | US Core CareTeam Profile)Support Planner
... contributor 0..*Reference(Patient_eltss | Practitioner_eltss | US Core PractitionerRole Profile | RelatedPerson | 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 0..*Reference(Resource)Information considered as part of plan
... goal 0..*Reference(Goal_eltss)Desired outcome of plan
... activity I0..*BackboneElementAction to occur as part of a plan
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... outcomeCodeableConcept 0..*CodeableConceptResults of the activity
Binding: CarePlanActivityOutcome (example)
.... outcomeReference 0..*Reference(Resource)Appointment, Encounter, Procedure, etc.
.... progress 0..*AnnotationComments about the activity status/progress
.... reference I0..1Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest_eltss | VisionPrescription | RequestGroup)Activity details defined in specific resource
.... detail I0..1BackboneElementPlan Step or Action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind 0..1codeKind of resource
Binding: CarePlanActivityKind (required)
..... instantiatesCanonical 0..*canonical(PlanDefinition | Questionnaire_eltss | Measure | ActivityDefinition | OperationDefinition)Instantiates FHIR protocol or definition
..... instantiatesUri 0..*uriInstantiates external protocol or definition
..... code 0..1CodeableConceptDetail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example)
..... reasonCode 0..*CodeableConceptWhy activity should be done or why activity was prohibited
Binding: SNOMEDCTClinicalFindings (example)
..... reasonReference 0..*Reference(Condition_eltss | Observation_eltss | MedicationStatement | NutritionOrder)Why activity is needed
..... goal 0..*Reference(Goal_eltss)Goals this activity relates to
..... status ?!1..1codenot-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required)
..... statusReason 0..1CodeableConceptReason for current status
..... doNotPerform ?!0..1booleanIf true, activity is prohibiting action
..... scheduled[x] 0..1When activity is to occur
...... scheduledTimingTiming
...... scheduledPeriodPeriod
...... scheduledStringstring
..... location 0..1Reference(Location_eltss)Where it should happen
..... performer 0..*Reference(Practitioner_eltss | US Core PractitionerRole Profile | RelatedPerson | Patient_eltss | US Core Organization Profile | US Core CareTeam Profile | HealthcareService | US Core Device Profile)Who will be responsible?
..... product[x] 0..1What is to be administered/supplied
Binding: SNOMEDCTMedicationCodes (example)
...... productCodeableConceptCodeableConcept
...... productReferenceReference(Medication | Substance)
..... dailyAmount 0..1SimpleQuantityHow to consume/day?
..... quantity 0..1SimpleQuantityHow much to administer/supply/consume
..... description 0..1stringExtra info describing activity to perform
... note 0..*AnnotationComments about the plan

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
CarePlan.languagepreferredCommonLanguages
Max Binding: AllLanguages
CarePlan.text.statusrequiredNarrativeStatus
CarePlan.statusrequiredRequestStatus
CarePlan.intentrequiredCarePlanIntent
CarePlan.categoryexampleCarePlanCategory
CarePlan.category:assessplanexamplePattern: assess-plan
CarePlan.activity.outcomeCodeableConceptexampleCarePlanActivityOutcome
CarePlan.activity.detail.kindrequiredCarePlanActivityKind
CarePlan.activity.detail.codeexampleProcedureCodes(SNOMEDCT)
CarePlan.activity.detail.reasonCodeexampleSNOMEDCTClinicalFindings
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus
CarePlan.activity.detail.product[x]exampleSNOMEDCTMedicationCodes

Constraints

IdPathDetailsRequirements
dom-2CarePlanIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4CarePlanIf 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-3CarePlanIf 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-6CarePlanA resource should have narrative for robust management
: text.div.exists()
dom-5CarePlanIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
txt-1CarePlan.text.divThe 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-2CarePlan.text.divThe narrative SHALL have some non-whitespace content
: htmlChecks()
ele-1CarePlan.activityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
cpl-3CarePlan.activityProvide a reference or detail, not both
: detail.empty() or reference.empty()
ele-1CarePlan.activity.detailAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())