This page is part of the Belgium eHealth FHIR Core specifications (v1.2.2: Trial Use) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Defining URL: | https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-homecare-plan |
Version: | 1.2.2 |
Name: | BeHomeCarePlan |
Title: | BeHomecare Plan |
Status: | Active as of 2021-01-18T09:02:46+00:00 |
Definition: | 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. |
Publisher: | eHealth |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-homecare-plan
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CarePlan
Summary
Must-Support: 32 elements
Structures
This structure refers to these other structures:
This structure is derived from CarePlan
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |
identifier | S | 0..* | Identifier | External Ids for this plan |
instantiatesCanonical | S | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | The protocol or definition that is instantiated by this care plan |
instantiatesUri | S | 0..* | uri | The protocol or definition that is instantiated by this care plan |
basedOn | S | 0..* | Reference(BeHomecare Plan) | Fulfills CarePlan |
replaces | S | 0..* | Reference(BeHomecare Plan) | CarePlan replaced by this CarePlan |
partOf | S | 0..* | Reference(BeHomecare Plan) | Part of referenced CarePlan |
status | S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
intent | S | 1..1 | code | proposal | plan | order | option |
category | S | 0..* | CodeableConcept | Type of plan |
title | S | 0..1 | string | Human-friendly name for the care plan |
description | S | 0..1 | string | Summary of nature of plan |
subject | S | 1..1 | Reference(BePatient) | Who the care plan is for |
encounter | S | 0..1 | Reference(Encounter) | Encounter created as part of |
period | S | 0..1 | Period | Time period plan covers |
created | 0..1 | dateTime | Date record was first recorded | |
author | S | 0..1 | Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization | BeHomecare Team) | Who is the designated responsible party |
contributor | S | 0..* | Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization | BeHomecare Team) | Who provided the content of the care plan |
careTeam | S | 0..* | Reference(BeHomecare Team) | Who's involved in plan? |
goal | S | 0..* | Reference(Goal) | Desired outcome of plan |
activity | S | 0..* | BackboneElement | Action to occur as part of plan |
outcomeCodeableConcept | S | 0..* | CodeableConcept | Results of the activity |
progress | S | 0..* | Annotation | Comments about the activity status/progress |
detail | ||||
kind | S | 0..1 | code | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription |
instantiatesCanonical | S | 0..* | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition |
instantiatesUri | S | 0..* | uri | Instantiates external protocol or definition |
code | S | 0..1 | CodeableConcept | Detail type of activity |
status | S | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error |
statusReason | S | 0..1 | CodeableConcept | Reason for current status |
doNotPerform | S | 0..1 | boolean | If true, activity is prohibiting action |
scheduled[x] | S | 0..1 | Timing, Period, string | When activity is to occur |
location | S | 0..1 | Reference(Location) | Where it should happen |
performer | S | 0..* | Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization | BeHomecare Team) | Who will be responsible? |
description | S | 0..1 | string | Extra info describing activity to perform |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |
id | Σ | 0..1 | string | 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: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..* | Identifier | External Ids for this plan |
instantiatesCanonical | SΣ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | The protocol or definition that is instantiated by this care plan |
instantiatesUri | SΣ | 0..* | uri | The protocol or definition that is instantiated by this care plan |
basedOn | SΣ | 0..* | Reference(BeHomecare Plan) | Fulfills CarePlan |
replaces | SΣ | 0..* | Reference(BeHomecare Plan) | CarePlan replaced by this CarePlan |
partOf | SΣ | 0..* | Reference(BeHomecare Plan) | Part of referenced CarePlan |
status | ?!SΣ | 1..1 | code | 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 | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. |
category | SΣ | 0..* | CodeableConcept | 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. |
title | SΣ | 0..1 | string | Human-friendly name for the care plan |
description | SΣ | 0..1 | string | Summary of nature of plan |
subject | SΣ | 1..1 | Reference(BePatient) | Who the care plan is for |
encounter | SΣ | 0..1 | Reference(Encounter) | Encounter created as part of |
period | SΣ | 0..1 | Period | Time period plan covers |
created | Σ | 0..1 | dateTime | Date record was first recorded |
author | SΣ | 0..1 | Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization | BeHomecare Team) | Who is the designated responsible party |
contributor | S | 0..* | Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization | BeHomecare Team) | Who provided the content of the care plan |
careTeam | S | 0..* | Reference(BeHomecare Team) | Who's involved in plan? |
addresses | Σ | 0..* | Reference(Condition) | Health issues this plan addresses |
supportingInfo | 0..* | Reference(Resource) | Information considered as part of plan | |
goal | S | 0..* | Reference(Goal) | Desired outcome of plan |
activity | SI | 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 | S | 0..* | CodeableConcept | Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. |
outcomeReference | 0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |
progress | S | 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 | In-line definition of activity |
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 | S | 0..1 | code | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. |
instantiatesCanonical | S | 0..* | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition |
instantiatesUri | S | 0..* | uri | Instantiates external protocol or definition |
code | S | 0..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. |
reasonCode | 0..* | CodeableConcept | Why activity should be done or why activity was prohibited Binding: SNOMEDCTClinicalFindings (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc. | |
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why activity is needed | |
goal | 0..* | Reference(Goal) | Goals this activity relates to | |
status | ?!S | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle. |
statusReason | S | 0..1 | CodeableConcept | Reason for current status |
doNotPerform | ?!S | 0..1 | boolean | If true, activity is prohibiting action |
scheduled[x] | S | 0..1 | When activity is to occur | |
scheduledTiming | Timing | |||
scheduledPeriod | Period | |||
scheduledString | string | |||
location | S | 0..1 | Reference(Location) | Where it should happen |
performer | S | 0..* | Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization | BeHomecare Team) | Who will be responsible? |
product[x] | 0..1 | What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||
productCodeableConcept | CodeableConcept | |||
productReference | Reference(Medication | Substance) | |||
dailyAmount | 0..1 | SimpleQuantity | How to consume/day? | |
quantity | 0..1 | SimpleQuantity | How much to administer/supply/consume | |
description | S | 0..1 | string | Extra info describing activity to perform |
note | 0..* | Annotation | Comments about the plan | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |
identifier | Σ | 0..* | Identifier | External Ids for this plan |
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | The protocol or definition that is instantiated by this care plan |
instantiatesUri | Σ | 0..* | uri | The protocol or definition that is instantiated by this care plan |
basedOn | Σ | 0..* | Reference(BeHomecare Plan) | Fulfills CarePlan |
replaces | Σ | 0..* | Reference(BeHomecare Plan) | CarePlan replaced by this CarePlan |
partOf | Σ | 0..* | Reference(BeHomecare Plan) | Part of referenced CarePlan |
status | ?!Σ | 1..1 | code | 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 | ?!Σ | 1..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. |
category | Σ | 0..* | CodeableConcept | 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. |
title | Σ | 0..1 | string | Human-friendly name for the care plan |
description | Σ | 0..1 | string | Summary of nature of plan |
subject | Σ | 1..1 | Reference(BePatient) | Who the care plan is for |
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of |
period | Σ | 0..1 | Period | Time period plan covers |
author | Σ | 0..1 | Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization | BeHomecare Team) | Who is the designated responsible party |
contributor | 0..* | Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization | BeHomecare Team) | Who provided the content of the care plan | |
careTeam | 0..* | Reference(BeHomecare Team) | Who's involved in plan? | |
goal | 0..* | Reference(Goal) | Desired outcome of plan | |
activity | I | 0..* | BackboneElement | Action to occur as part of plan |
outcomeCodeableConcept | 0..* | CodeableConcept | Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. | |
progress | 0..* | Annotation | Comments about the activity status/progress | |
detail | I | 0..1 | BackboneElement | In-line definition of activity |
kind | 0..1 | code | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. | |
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): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. | |
status | ?! | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle. |
statusReason | 0..1 | CodeableConcept | Reason for current status | |
doNotPerform | ?! | 0..1 | boolean | If true, activity is prohibiting action |
scheduled[x] | 0..1 | When activity is to occur | ||
scheduledTiming | Timing | |||
scheduledPeriod | Period | |||
scheduledString | string | |||
location | 0..1 | Reference(Location) | Where it should happen | |
performer | 0..* | Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization | BeHomecare Team) | Who will be responsible? | |
description | 0..1 | string | Extra info describing activity to perform | |
Documentation for this format |
This structure is derived from CarePlan
Summary
Must-Support: 32 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from CarePlan
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |
identifier | S | 0..* | Identifier | External Ids for this plan |
instantiatesCanonical | S | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | The protocol or definition that is instantiated by this care plan |
instantiatesUri | S | 0..* | uri | The protocol or definition that is instantiated by this care plan |
basedOn | S | 0..* | Reference(BeHomecare Plan) | Fulfills CarePlan |
replaces | S | 0..* | Reference(BeHomecare Plan) | CarePlan replaced by this CarePlan |
partOf | S | 0..* | Reference(BeHomecare Plan) | Part of referenced CarePlan |
status | S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
intent | S | 1..1 | code | proposal | plan | order | option |
category | S | 0..* | CodeableConcept | Type of plan |
title | S | 0..1 | string | Human-friendly name for the care plan |
description | S | 0..1 | string | Summary of nature of plan |
subject | S | 1..1 | Reference(BePatient) | Who the care plan is for |
encounter | S | 0..1 | Reference(Encounter) | Encounter created as part of |
period | S | 0..1 | Period | Time period plan covers |
created | 0..1 | dateTime | Date record was first recorded | |
author | S | 0..1 | Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization | BeHomecare Team) | Who is the designated responsible party |
contributor | S | 0..* | Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization | BeHomecare Team) | Who provided the content of the care plan |
careTeam | S | 0..* | Reference(BeHomecare Team) | Who's involved in plan? |
goal | S | 0..* | Reference(Goal) | Desired outcome of plan |
activity | S | 0..* | BackboneElement | Action to occur as part of plan |
outcomeCodeableConcept | S | 0..* | CodeableConcept | Results of the activity |
progress | S | 0..* | Annotation | Comments about the activity status/progress |
detail | ||||
kind | S | 0..1 | code | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription |
instantiatesCanonical | S | 0..* | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition |
instantiatesUri | S | 0..* | uri | Instantiates external protocol or definition |
code | S | 0..1 | CodeableConcept | Detail type of activity |
status | S | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error |
statusReason | S | 0..1 | CodeableConcept | Reason for current status |
doNotPerform | S | 0..1 | boolean | If true, activity is prohibiting action |
scheduled[x] | S | 0..1 | Timing, Period, string | When activity is to occur |
location | S | 0..1 | Reference(Location) | Where it should happen |
performer | S | 0..* | Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization | BeHomecare Team) | Who will be responsible? |
description | S | 0..1 | string | Extra info describing activity to perform |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |
id | Σ | 0..1 | string | 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: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..* | Identifier | External Ids for this plan |
instantiatesCanonical | SΣ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | The protocol or definition that is instantiated by this care plan |
instantiatesUri | SΣ | 0..* | uri | The protocol or definition that is instantiated by this care plan |
basedOn | SΣ | 0..* | Reference(BeHomecare Plan) | Fulfills CarePlan |
replaces | SΣ | 0..* | Reference(BeHomecare Plan) | CarePlan replaced by this CarePlan |
partOf | SΣ | 0..* | Reference(BeHomecare Plan) | Part of referenced CarePlan |
status | ?!SΣ | 1..1 | code | 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 | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. |
category | SΣ | 0..* | CodeableConcept | 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. |
title | SΣ | 0..1 | string | Human-friendly name for the care plan |
description | SΣ | 0..1 | string | Summary of nature of plan |
subject | SΣ | 1..1 | Reference(BePatient) | Who the care plan is for |
encounter | SΣ | 0..1 | Reference(Encounter) | Encounter created as part of |
period | SΣ | 0..1 | Period | Time period plan covers |
created | Σ | 0..1 | dateTime | Date record was first recorded |
author | SΣ | 0..1 | Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization | BeHomecare Team) | Who is the designated responsible party |
contributor | S | 0..* | Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization | BeHomecare Team) | Who provided the content of the care plan |
careTeam | S | 0..* | Reference(BeHomecare Team) | Who's involved in plan? |
addresses | Σ | 0..* | Reference(Condition) | Health issues this plan addresses |
supportingInfo | 0..* | Reference(Resource) | Information considered as part of plan | |
goal | S | 0..* | Reference(Goal) | Desired outcome of plan |
activity | SI | 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 | S | 0..* | CodeableConcept | Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. |
outcomeReference | 0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |
progress | S | 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 | In-line definition of activity |
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 | S | 0..1 | code | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. |
instantiatesCanonical | S | 0..* | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition |
instantiatesUri | S | 0..* | uri | Instantiates external protocol or definition |
code | S | 0..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. |
reasonCode | 0..* | CodeableConcept | Why activity should be done or why activity was prohibited Binding: SNOMEDCTClinicalFindings (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc. | |
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why activity is needed | |
goal | 0..* | Reference(Goal) | Goals this activity relates to | |
status | ?!S | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle. |
statusReason | S | 0..1 | CodeableConcept | Reason for current status |
doNotPerform | ?!S | 0..1 | boolean | If true, activity is prohibiting action |
scheduled[x] | S | 0..1 | When activity is to occur | |
scheduledTiming | Timing | |||
scheduledPeriod | Period | |||
scheduledString | string | |||
location | S | 0..1 | Reference(Location) | Where it should happen |
performer | S | 0..* | Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization | BeHomecare Team) | Who will be responsible? |
product[x] | 0..1 | What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||
productCodeableConcept | CodeableConcept | |||
productReference | Reference(Medication | Substance) | |||
dailyAmount | 0..1 | SimpleQuantity | How to consume/day? | |
quantity | 0..1 | SimpleQuantity | How much to administer/supply/consume | |
description | S | 0..1 | string | Extra info describing activity to perform |
note | 0..* | Annotation | Comments about the plan | |
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
CarePlan.language | preferred | CommonLanguages Max Binding: AllLanguages |
CarePlan.status | required | RequestStatus |
CarePlan.intent | required | CarePlanIntent |
CarePlan.category | example | CarePlanCategory |
CarePlan.activity.outcomeCodeableConcept | example | CarePlanActivityOutcome |
CarePlan.activity.detail.kind | required | CarePlanActivityKind |
CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT) |
CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindings |
CarePlan.activity.detail.status | required | CarePlanActivityStatus |
CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodes |
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-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-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-5 | CarePlan | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | CarePlan | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | CarePlan.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | CarePlan.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | CarePlan.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | CarePlan.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | CarePlan.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.instantiatesCanonical | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.instantiatesUri | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.basedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.replaces | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.partOf | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.intent | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.title | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.created | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.author | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.contributor | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.careTeam | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.addresses | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.supportingInfo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.goal | 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 | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.activity.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | CarePlan.activity.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | CarePlan.activity.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | CarePlan.activity.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | CarePlan.activity.outcomeCodeableConcept | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.activity.outcomeReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.activity.progress | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.activity.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.activity.detail | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.activity.detail.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | CarePlan.activity.detail.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | CarePlan.activity.detail.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | CarePlan.activity.detail.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | CarePlan.activity.detail.kind | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.activity.detail.instantiatesCanonical | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.activity.detail.instantiatesUri | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.activity.detail.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.activity.detail.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.activity.detail.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.activity.detail.goal | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.activity.detail.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.activity.detail.statusReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.activity.detail.doNotPerform | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.activity.detail.scheduled[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.activity.detail.location | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.activity.detail.performer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.activity.detail.product[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.activity.detail.dailyAmount | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.activity.detail.quantity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.activity.detail.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CarePlan.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |