HL7 Belgium FHIR specifications
0.1 - QA review

This page is part of the HL7 Belgium FHIR Specifications (v2020May: QA Preview) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

StructureDefinition: BECarePlan

This is the profile for Care Plan in a home care setting. A Care Plan contains the activities planned and/or performed by a care team to deliver care for a particular patient, usually targeting a specific goal or condition - or a set thereof.

The official URL for this profile is: 

https://www.hl7belgium.org/fhir/StructureDefinition/be-homecare-plan

Formal Views of Profile Content

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

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*CarePlanHealthcare plan for patient or group
... identifier S0..*IdentifierExternal Ids for this plan
... instantiatesCanonical S0..*canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition)The protocol or definition that is instantiated by this care plan
... instantiatesUri S0..*uriExternal protocol or definition that is instantiated by this care plan
... replaces S0..*Reference(BECarePlan)CarePlan replaced by this CarePlan
... partOf S0..*Reference(BECarePlan)Part of referenced CarePlan
... status S1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
... intent S1..1codeproposal | plan | order | option
... category S0..*CodeableConceptType of plan
... title S0..1stringHuman-friendly name for the care plan
... description S0..1stringSummary of nature of plan
... subject S1..1Reference(BePatient)Who the care plan is for
... encounter S0..1Reference(Encounter)Encounter created as part of
... period S0..1PeriodTime period plan covers
... created 0..1dateTimeDate record was first recorded
... author S0..1Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization | BECareTeam)Who is the designated responsible party
... contributor 0..*Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization | BECareTeam)Who provided the content of the care plan
... careTeam S0..*Reference(BECareTeam)Who's involved in plan?
... goal S0..*Reference(Goal)Desired outcome of plan
... activity S0..*BackboneElementAction to occur as part of plan
.... outcomeCodeableConcept S0..*CodeableConceptResults of the activity
.... progress S0..*AnnotationComments about the activity status/progress
.... detail
..... kind S0..1codeAppointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
..... instantiatesCanonical S0..*canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition)Instantiates FHIR protocol or definition
..... instantiatesUri S0..*uriInstantiates external protocol or definition
..... code S0..1CodeableConceptDetail type of activity
..... status S1..1codenot-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
..... statusReason S0..1CodeableConceptReason for current status
..... doNotPerform S0..1booleanIf true, activity is prohibiting action
..... scheduled[x] S0..1Timing, Period, stringWhen activity is to occur
..... location S0..1Reference(Location)Where it should happen
..... performer S0..*Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization | BECareTeam)Who will be responsible?
..... description S0..1stringExtra info describing activity to perform

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan I0..*CarePlanHealthcare plan for patient or group
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*IdentifierExternal Ids for this plan
... instantiatesCanonical SΣI0..*canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition)The protocol or definition that is instantiated by this care plan
... instantiatesUri SΣI0..*uriExternal protocol or definition that is instantiated by this care plan
... basedOn SΣI0..*Reference(BECarePlan)Fulfills CarePlan
... replaces SΣI0..*Reference(BECarePlan)CarePlan replaced by this CarePlan
... partOf SΣI0..*Reference(BECarePlan)Part of referenced CarePlan
... status ?!SΣI1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... intent ?!SΣI1..1codeproposal | plan | order | option
Binding: CarePlanIntent (required)
... category SΣI0..*CodeableConceptType of plan
Binding: CarePlanCategory (example)
... title SΣI0..1stringHuman-friendly name for the care plan
... description SΣI0..1stringSummary of nature of plan
... subject SΣI1..1Reference(BePatient)Who the care plan is for
... encounter SΣI0..1Reference(Encounter)Encounter created as part of
... period SΣI0..1PeriodTime period plan covers
... created ΣI0..1dateTimeDate record was first recorded
... author SΣI0..1Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization | BECareTeam)Who is the designated responsible party
... contributor I0..*Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization | BECareTeam)Who provided the content of the care plan
... careTeam SI0..*Reference(BECareTeam)Who's involved in plan?
... addresses ΣI0..*Reference(Condition)Health issues this plan addresses
... supportingInfo I0..*Reference(Resource)Information considered as part of plan
... goal SI0..*Reference(Goal)Desired outcome of plan
... activity SI0..*BackboneElementAction to occur as part of plan
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... outcomeCodeableConcept SI0..*CodeableConceptResults of the activity
Binding: CarePlanActivityOutcome (example)
.... outcomeReference I0..*Reference(Resource)Appointment, Encounter, Procedure, etc.
.... progress SI0..*AnnotationComments about the activity status/progress
.... reference I0..1Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup)Activity details defined in specific resource
.... detail I0..1BackboneElementIn-line definition of activity
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind SI0..1codeAppointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required)
..... instantiatesCanonical SI0..*canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition)Instantiates FHIR protocol or definition
..... instantiatesUri SI0..*uriInstantiates external protocol or definition
..... code SI0..1CodeableConceptDetail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example)
..... reasonCode I0..*CodeableConceptWhy activity should be done or why activity was prohibited
Binding: SNOMEDCTClinicalFindings (example)
..... reasonReference I0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why activity is needed
..... goal I0..*Reference(Goal)Goals this activity relates to
..... status ?!SI1..1codenot-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required)
..... statusReason SI0..1CodeableConceptReason for current status
..... doNotPerform ?!SI0..1booleanIf true, activity is prohibiting action
..... scheduled[x] SI0..1When activity is to occur
...... scheduledTimingTiming
...... scheduledPeriodPeriod
...... scheduledStringstring
..... location SI0..1Reference(Location)Where it should happen
..... performer SI0..*Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization | BECareTeam)Who will be responsible?
..... product[x] I0..1What is to be administered/supplied
Binding: SNOMEDCTMedicationCodes (example)
...... productCodeableConceptCodeableConcept
...... productReferenceReference(Medication | Substance)
..... dailyAmount I0..1SimpleQuantityHow to consume/day?
..... quantity I0..1SimpleQuantityHow much to administer/supply/consume
..... description SI0..1stringExtra info describing activity to perform
... note I0..*AnnotationComments about the plan

doco Documentation for this format

Differential View

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*CarePlanHealthcare plan for patient or group
... identifier S0..*IdentifierExternal Ids for this plan
... instantiatesCanonical S0..*canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition)The protocol or definition that is instantiated by this care plan
... instantiatesUri S0..*uriExternal protocol or definition that is instantiated by this care plan
... replaces S0..*Reference(BECarePlan)CarePlan replaced by this CarePlan
... partOf S0..*Reference(BECarePlan)Part of referenced CarePlan
... status S1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
... intent S1..1codeproposal | plan | order | option
... category S0..*CodeableConceptType of plan
... title S0..1stringHuman-friendly name for the care plan
... description S0..1stringSummary of nature of plan
... subject S1..1Reference(BePatient)Who the care plan is for
... encounter S0..1Reference(Encounter)Encounter created as part of
... period S0..1PeriodTime period plan covers
... created 0..1dateTimeDate record was first recorded
... author S0..1Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization | BECareTeam)Who is the designated responsible party
... contributor 0..*Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization | BECareTeam)Who provided the content of the care plan
... careTeam S0..*Reference(BECareTeam)Who's involved in plan?
... goal S0..*Reference(Goal)Desired outcome of plan
... activity S0..*BackboneElementAction to occur as part of plan
.... outcomeCodeableConcept S0..*CodeableConceptResults of the activity
.... progress S0..*AnnotationComments about the activity status/progress
.... detail
..... kind S0..1codeAppointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
..... instantiatesCanonical S0..*canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition)Instantiates FHIR protocol or definition
..... instantiatesUri S0..*uriInstantiates external protocol or definition
..... code S0..1CodeableConceptDetail type of activity
..... status S1..1codenot-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
..... statusReason S0..1CodeableConceptReason for current status
..... doNotPerform S0..1booleanIf true, activity is prohibiting action
..... scheduled[x] S0..1Timing, Period, stringWhen activity is to occur
..... location S0..1Reference(Location)Where it should happen
..... performer S0..*Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization | BECareTeam)Who will be responsible?
..... description S0..1stringExtra info describing activity to perform

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan I0..*CarePlanHealthcare plan for patient or group
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*IdentifierExternal Ids for this plan
... instantiatesCanonical SΣI0..*canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition)The protocol or definition that is instantiated by this care plan
... instantiatesUri SΣI0..*uriExternal protocol or definition that is instantiated by this care plan
... basedOn SΣI0..*Reference(BECarePlan)Fulfills CarePlan
... replaces SΣI0..*Reference(BECarePlan)CarePlan replaced by this CarePlan
... partOf SΣI0..*Reference(BECarePlan)Part of referenced CarePlan
... status ?!SΣI1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... intent ?!SΣI1..1codeproposal | plan | order | option
Binding: CarePlanIntent (required)
... category SΣI0..*CodeableConceptType of plan
Binding: CarePlanCategory (example)
... title SΣI0..1stringHuman-friendly name for the care plan
... description SΣI0..1stringSummary of nature of plan
... subject SΣI1..1Reference(BePatient)Who the care plan is for
... encounter SΣI0..1Reference(Encounter)Encounter created as part of
... period SΣI0..1PeriodTime period plan covers
... created ΣI0..1dateTimeDate record was first recorded
... author SΣI0..1Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization | BECareTeam)Who is the designated responsible party
... contributor I0..*Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization | BECareTeam)Who provided the content of the care plan
... careTeam SI0..*Reference(BECareTeam)Who's involved in plan?
... addresses ΣI0..*Reference(Condition)Health issues this plan addresses
... supportingInfo I0..*Reference(Resource)Information considered as part of plan
... goal SI0..*Reference(Goal)Desired outcome of plan
... activity SI0..*BackboneElementAction to occur as part of plan
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... outcomeCodeableConcept SI0..*CodeableConceptResults of the activity
Binding: CarePlanActivityOutcome (example)
.... outcomeReference I0..*Reference(Resource)Appointment, Encounter, Procedure, etc.
.... progress SI0..*AnnotationComments about the activity status/progress
.... reference I0..1Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup)Activity details defined in specific resource
.... detail I0..1BackboneElementIn-line definition of activity
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind SI0..1codeAppointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required)
..... instantiatesCanonical SI0..*canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition)Instantiates FHIR protocol or definition
..... instantiatesUri SI0..*uriInstantiates external protocol or definition
..... code SI0..1CodeableConceptDetail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example)
..... reasonCode I0..*CodeableConceptWhy activity should be done or why activity was prohibited
Binding: SNOMEDCTClinicalFindings (example)
..... reasonReference I0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why activity is needed
..... goal I0..*Reference(Goal)Goals this activity relates to
..... status ?!SI1..1codenot-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required)
..... statusReason SI0..1CodeableConceptReason for current status
..... doNotPerform ?!SI0..1booleanIf true, activity is prohibiting action
..... scheduled[x] SI0..1When activity is to occur
...... scheduledTimingTiming
...... scheduledPeriodPeriod
...... scheduledStringstring
..... location SI0..1Reference(Location)Where it should happen
..... performer SI0..*Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization | BECareTeam)Who will be responsible?
..... product[x] I0..1What is to be administered/supplied
Binding: SNOMEDCTMedicationCodes (example)
...... productCodeableConceptCodeableConcept
...... productReferenceReference(Medication | Substance)
..... dailyAmount I0..1SimpleQuantityHow to consume/day?
..... quantity I0..1SimpleQuantityHow much to administer/supply/consume
..... description SI0..1stringExtra info describing activity to perform
... note I0..*AnnotationComments about the plan

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
CarePlan.languagepreferredCommonLanguages
Max Binding: AllLanguages
CarePlan.statusrequiredRequestStatus
CarePlan.intentrequiredCarePlanIntent
CarePlan.categoryexampleCarePlanCategory
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

Constraints

IdPathDetailsRequirements