HL7 Belgium care-coordination
0.0.1 - R4
HL7 Belgium care-coordination
0.0.1 - R4
HL7 Belgium care-coordination, published by eHealth Platform. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/care-coordination/ and changes regularly. See the Directory of published versions
| Official URL: https://www.ehealth.fgov.be/standards/fhir/care-coordination/StructureDefinition/be-homecare-plan | Version: 0.0.1 | |||
| Active as of 2021-01-18 | Computable Name: BeHomeCarePlan | |||
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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
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(2.1.2)) | 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(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | BeOrganization(2.1.2) | BeHomecare Team) | Who is the designated responsible party |
| contributor |
S | 0..* | Reference(BePatient(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | BeOrganization(2.1.2) | 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(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | BeOrganization(2.1.2) | 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 dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 identifier |
SΣ | 0..* | Identifier | External Ids for this plan ele-1: All FHIR elements must have a @value or children |
| instantiatesCanonical |
SΣ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | The protocol or definition that is instantiated by this care plan ele-1: All FHIR elements must have a @value or children |
| instantiatesUri |
SΣ | 0..* | uri | The protocol or definition that is instantiated by this care plan ele-1: All FHIR elements must have a @value or children |
| basedOn |
SΣ | 0..* | Reference(BeHomecare Plan) | Fulfills CarePlan ele-1: All FHIR elements must have a @value or children |
| replaces |
SΣ | 0..* | Reference(BeHomecare Plan) | CarePlan replaced by this CarePlan ele-1: All FHIR elements must have a @value or children |
| partOf |
SΣ | 0..* | Reference(BeHomecare Plan) | Part of referenced CarePlan ele-1: All FHIR elements must have a @value or children |
| 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. ele-1: All FHIR elements must have a @value or children |
| intent |
?!SΣ | 1..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. ele-1: All FHIR elements must have a @value or children |
| 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. ele-1: All FHIR elements must have a @value or children |
| title |
SΣ | 0..1 | string | Human-friendly name for the care plan ele-1: All FHIR elements must have a @value or children |
| description |
SΣ | 0..1 | string | Summary of nature of plan ele-1: All FHIR elements must have a @value or children |
| subject |
SΣ | 1..1 | Reference(BePatient(2.1.2)) | Who the care plan is for ele-1: All FHIR elements must have a @value or children |
| encounter |
SΣ | 0..1 | Reference(Encounter) | Encounter created as part of ele-1: All FHIR elements must have a @value or children |
| period |
SΣ | 0..1 | Period | Time period plan covers ele-1: All FHIR elements must have a @value or children |
| created |
Σ | 0..1 | dateTime | Date record was first recorded ele-1: All FHIR elements must have a @value or children |
| author |
SΣ | 0..1 | Reference(BePatient(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | BeOrganization(2.1.2) | BeHomecare Team) | Who is the designated responsible party ele-1: All FHIR elements must have a @value or children |
| contributor |
S | 0..* | Reference(BePatient(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | BeOrganization(2.1.2) | BeHomecare Team) | Who provided the content of the care plan ele-1: All FHIR elements must have a @value or children |
| careTeam |
S | 0..* | Reference(BeHomecare Team) | Who's involved in plan? ele-1: All FHIR elements must have a @value or children |
| goal |
S | 0..* | Reference(Goal) | Desired outcome of plan ele-1: All FHIR elements must have a @value or children |
| activity |
SC | 0..* | BackboneElement | Action to occur as part of plan cpl-3: Provide a reference or detail, not both ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| outcomeCodeableConcept |
S | 0..* | CodeableConcept | Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. ele-1: All FHIR elements must have a @value or children |
| progress |
S | 0..* | Annotation | Comments about the activity status/progress ele-1: All FHIR elements must have a @value or children |
| detail |
C | 0..1 | BackboneElement | In-line definition of activity ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| 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. ele-1: All FHIR elements must have a @value or children |
| instantiatesCanonical |
S | 0..* | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition ele-1: All FHIR elements must have a @value or children |
| instantiatesUri |
S | 0..* | uri | Instantiates external protocol or definition ele-1: All FHIR elements must have a @value or children |
| 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. ele-1: All FHIR elements must have a @value or children |
| 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. ele-1: All FHIR elements must have a @value or children |
| statusReason |
S | 0..1 | CodeableConcept | Reason for current status ele-1: All FHIR elements must have a @value or children |
| doNotPerform |
?!S | 0..1 | boolean | If true, activity is prohibiting action ele-1: All FHIR elements must have a @value or children |
  scheduled[x] |
S | 0..1 | When activity is to occur ele-1: All FHIR elements must have a @value or children | |
 scheduledTiming |
Timing | |||
| scheduledPeriod |
Period | |||
| scheduledString |
string | |||
| location |
S | 0..1 | Reference(Location) | Where it should happen ele-1: All FHIR elements must have a @value or children |
| performer |
S | 0..* | Reference(BePatient(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | BeOrganization(2.1.2) | BeHomecare Team) | Who will be responsible? ele-1: All FHIR elements must have a @value or children |
| description |
S | 0..1 | string | Extra info describing activity to perform ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1from the FHIR Standard | |
| CarePlan.category | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-categoryfrom the FHIR Standard | |
| CarePlan.activity.outcomeCodeableConcept | example | CarePlanActivityOutcomehttp://hl7.org/fhir/ValueSet/care-plan-activity-outcomefrom the FHIR Standard | |
| CarePlan.activity.detail.kind | required | CarePlanActivityKindhttp://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1from the FHIR Standard | |
| CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | |
| CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1from the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| CarePlan |
0..* | CarePlan | Healthcare plan for patient or group | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
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(2.1.2)) | 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(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | BeOrganization(2.1.2) | BeHomecare Team) | Who is the designated responsible party | ||||
| contributor |
S | 0..* | Reference(BePatient(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | BeOrganization(2.1.2) | 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 |
SC | 0..* | BackboneElement | Action to occur as part of plan cpl-3: Provide a reference or detail, not both | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| outcomeCodeableConcept |
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 |
C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource | ||||
| detail |
C | 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(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | BeOrganization(2.1.2) | 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 | ||||||||
| Path | Conformance | ValueSet | URI | |||
| CarePlan.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1from the FHIR Standard | ||||
| CarePlan.category | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-categoryfrom the FHIR Standard | ||||
| CarePlan.activity.outcomeCodeableConcept | example | CarePlanActivityOutcomehttp://hl7.org/fhir/ValueSet/care-plan-activity-outcomefrom the FHIR Standard | ||||
| CarePlan.activity.detail.kind | required | CarePlanActivityKindhttp://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1from the FHIR Standard | ||||
| CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | ||||
| CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard | ||||
| CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1from the FHIR Standard | ||||
| CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard |
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(2.1.2)) | 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(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | BeOrganization(2.1.2) | BeHomecare Team) | Who is the designated responsible party |
| contributor |
S | 0..* | Reference(BePatient(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | BeOrganization(2.1.2) | 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(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | BeOrganization(2.1.2) | BeHomecare Team) | Who will be responsible? |
| description |
S | 0..1 | string | Extra info describing activity to perform |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CarePlan |
0..* | CarePlan | Healthcare plan for patient or group dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| identifier |
SΣ | 0..* | Identifier | External Ids for this plan ele-1: All FHIR elements must have a @value or children |
| instantiatesCanonical |
SΣ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | The protocol or definition that is instantiated by this care plan ele-1: All FHIR elements must have a @value or children |
| instantiatesUri |
SΣ | 0..* | uri | The protocol or definition that is instantiated by this care plan ele-1: All FHIR elements must have a @value or children |
| basedOn |
SΣ | 0..* | Reference(BeHomecare Plan) | Fulfills CarePlan ele-1: All FHIR elements must have a @value or children |
| replaces |
SΣ | 0..* | Reference(BeHomecare Plan) | CarePlan replaced by this CarePlan ele-1: All FHIR elements must have a @value or children |
| partOf |
SΣ | 0..* | Reference(BeHomecare Plan) | Part of referenced CarePlan ele-1: All FHIR elements must have a @value or children |
| 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. ele-1: All FHIR elements must have a @value or children |
| intent |
?!SΣ | 1..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. ele-1: All FHIR elements must have a @value or children |
| 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. ele-1: All FHIR elements must have a @value or children |
| title |
SΣ | 0..1 | string | Human-friendly name for the care plan ele-1: All FHIR elements must have a @value or children |
| description |
SΣ | 0..1 | string | Summary of nature of plan ele-1: All FHIR elements must have a @value or children |
| subject |
SΣ | 1..1 | Reference(BePatient(2.1.2)) | Who the care plan is for ele-1: All FHIR elements must have a @value or children |
| encounter |
SΣ | 0..1 | Reference(Encounter) | Encounter created as part of ele-1: All FHIR elements must have a @value or children |
| period |
SΣ | 0..1 | Period | Time period plan covers ele-1: All FHIR elements must have a @value or children |
| created |
Σ | 0..1 | dateTime | Date record was first recorded ele-1: All FHIR elements must have a @value or children |
| author |
SΣ | 0..1 | Reference(BePatient(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | BeOrganization(2.1.2) | BeHomecare Team) | Who is the designated responsible party ele-1: All FHIR elements must have a @value or children |
| contributor |
S | 0..* | Reference(BePatient(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | BeOrganization(2.1.2) | BeHomecare Team) | Who provided the content of the care plan ele-1: All FHIR elements must have a @value or children |
| careTeam |
S | 0..* | Reference(BeHomecare Team) | Who's involved in plan? ele-1: All FHIR elements must have a @value or children |
| goal |
S | 0..* | Reference(Goal) | Desired outcome of plan ele-1: All FHIR elements must have a @value or children |
| activity |
SC | 0..* | BackboneElement | Action to occur as part of plan cpl-3: Provide a reference or detail, not both ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| outcomeCodeableConcept |
S | 0..* | CodeableConcept | Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. ele-1: All FHIR elements must have a @value or children |
| progress |
S | 0..* | Annotation | Comments about the activity status/progress ele-1: All FHIR elements must have a @value or children |
| detail |
C | 0..1 | BackboneElement | In-line definition of activity ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| 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. ele-1: All FHIR elements must have a @value or children |
| instantiatesCanonical |
S | 0..* | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition ele-1: All FHIR elements must have a @value or children |
| instantiatesUri |
S | 0..* | uri | Instantiates external protocol or definition ele-1: All FHIR elements must have a @value or children |
| 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. ele-1: All FHIR elements must have a @value or children |
| 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. ele-1: All FHIR elements must have a @value or children |
| statusReason |
S | 0..1 | CodeableConcept | Reason for current status ele-1: All FHIR elements must have a @value or children |
| doNotPerform |
?!S | 0..1 | boolean | If true, activity is prohibiting action ele-1: All FHIR elements must have a @value or children |
| scheduled[x] |
S | 0..1 | When activity is to occur ele-1: All FHIR elements must have a @value or children | |
| scheduledTiming |
Timing | |||
| scheduledPeriod |
Period | |||
| scheduledString |
string | |||
| location |
S | 0..1 | Reference(Location) | Where it should happen ele-1: All FHIR elements must have a @value or children |
| performer |
S | 0..* | Reference(BePatient(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | BeOrganization(2.1.2) | BeHomecare Team) | Who will be responsible? ele-1: All FHIR elements must have a @value or children |
| description |
S | 0..1 | string | Extra info describing activity to perform ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1from the FHIR Standard | |
| CarePlan.category | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-categoryfrom the FHIR Standard | |
| CarePlan.activity.outcomeCodeableConcept | example | CarePlanActivityOutcomehttp://hl7.org/fhir/ValueSet/care-plan-activity-outcomefrom the FHIR Standard | |
| CarePlan.activity.detail.kind | required | CarePlanActivityKindhttp://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1from the FHIR Standard | |
| CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | |
| CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1from the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| CarePlan |
0..* | CarePlan | Healthcare plan for patient or group | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
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(2.1.2)) | 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(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | BeOrganization(2.1.2) | BeHomecare Team) | Who is the designated responsible party | ||||
| contributor |
S | 0..* | Reference(BePatient(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | BeOrganization(2.1.2) | 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 |
SC | 0..* | BackboneElement | Action to occur as part of plan cpl-3: Provide a reference or detail, not both | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| outcomeCodeableConcept |
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 |
C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource | ||||
| detail |
C | 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(2.1.2) | BePractitioner(2.1.2) | BePractitionerRole(2.1.2) | BeOrganization(2.1.2) | 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 | ||||||||
| Path | Conformance | ValueSet | URI | |||
| CarePlan.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1from the FHIR Standard | ||||
| CarePlan.category | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-categoryfrom the FHIR Standard | ||||
| CarePlan.activity.outcomeCodeableConcept | example | CarePlanActivityOutcomehttp://hl7.org/fhir/ValueSet/care-plan-activity-outcomefrom the FHIR Standard | ||||
| CarePlan.activity.detail.kind | required | CarePlanActivityKindhttp://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1from the FHIR Standard | ||||
| CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | ||||
| CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard | ||||
| CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1from the FHIR Standard | ||||
| CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard |
This structure is derived from CarePlan
Summary
Must-Support: 32 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ eHealth Platform. Package hl7.fhir.be.care-coordination#0.0.1 based on FHIR 4.0.1. Generated 2024-12-17
Links: Table of Contents |
QA Report
