NHDR Implementation Guide Release 1.0, published by NHDR. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/UP-Manila-SILab/PhilHealth-NHDR-IG-Review/ and changes regularly. See the Directory of published versions
Resource Profile: PH CarePlan
| Official URL: https://nhdr.gov.ph/fhir/StructureDefinition/PH-CarePlan | Version: 0.1.0 | |||
| Standards status: Draft | Computable Name: PH_CarePlan | |||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License |
||||
Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.
Usages:
- This Profile is not used by any profiles in this Specification
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  CarePlan |
0..* | CarePlan | Healthcare plan for patient or group | |
  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. | |
  subject |
1..1 | Reference(Patient | Group) | Who the care plan is for | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| CarePlan.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| CarePlan.intent | Base | required | Care Plan Intent | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | CarePlan | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | 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 | error | 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 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | CarePlan | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
This structure is derived from CarePlan
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| CarePlan |
0..* | CarePlan | Healthcare plan for patient or group | |
  meta |
||||
  Slices for extension |
Content/Rules for all slices | |||
  extension:hfRecordedDate |
0..1 | dateTime | The recorded date indicating when the record was uploaded by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate | |
 extension:hfLastUpdated |
0..* | dateTime | The date indicating when the record was last updated by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated | |
| lastUpdated |
0..1 | instant | When the resource was uploaded to the NHDR. | |
| implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| text |
0..0 | Text summary of the resource, for human interpretation | ||
| contained |
0..0 | Contained, inline Resources | ||
 extension |
0..0 | Extension | ||
 modifierExtension |
0..0 | Extension | ||
| identifier |
0..0 | External Ids for this plan | ||
| instantiatesCanonical |
0..0 | Instantiates FHIR protocol or definition | ||
| instantiatesUri |
0..0 | Instantiates external protocol or definition | ||
| basedOn |
0..0 | Fulfills CarePlan | ||
| replaces |
0..0 | CarePlan replaced by this CarePlan | ||
| partOf |
0..0 | Part of referenced CarePlan | ||
| title |
0..0 | Human-friendly name for the care plan | ||
| encounter |
0..0 | Encounter created as part of | ||
| period |
0..0 | Time period plan covers | ||
| created |
0..0 | Date record was first recorded | ||
| author |
0..0 | Who is the designated responsible party | ||
| contributor |
0..0 | Who provided the content of the care plan | ||
| careTeam |
0..0 | Who's involved in plan? | ||
| addresses |
0..0 | Health issues this plan addresses | ||
| supportingInfo |
0..0 | Information considered as part of plan | ||
| goal |
0..0 | Desired outcome of plan | ||
 activity |
||||
 id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| outcomeReference |
0..0 | Appointment, Encounter, Procedure, etc. | ||
| progress |
0..0 | Comments about the activity status/progress | ||
| reference |
0..0 | Activity details defined in specific resource | ||
| detail |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| kind |
0..0 | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | ||
| instantiatesCanonical |
0..0 | Instantiates FHIR protocol or definition | ||
| instantiatesUri |
0..0 | Instantiates external protocol or definition | ||
| reasonCode |
0..0 | Why activity should be done or why activity was prohibited | ||
| reasonReference |
0..0 | Why activity is needed | ||
| goal |
0..0 | Goals this activity relates to | ||
| statusReason |
0..0 | Reason for current status | ||
| doNotPerform |
0..0 | If true, activity is prohibiting action | ||
 scheduled[x] |
0..1 | Period | When activity is to occur | |
| performer |
0..0 | Who will be responsible? | ||
| product[x] |
0..0 | What is to be administered/supplied | ||
| dailyAmount |
0..0 | How to consume/day? | ||
| quantity |
0..0 | How much to administer/supply/consume | ||
| description |
0..0 | Extra info describing activity to perform | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension:hfRecordedDate |
0..1 | dateTime | The recorded date indicating when the record was uploaded by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate | |
| extension:hfLastUpdated |
0..* | dateTime | The date indicating when the record was last updated by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated | |
| versionId |
0..1 | id | Version specific identifier | |
| lastUpdated |
0..1 | instant | When the resource was uploaded to the NHDR. | |
| source |
0..1 | uri | Identifies where the resource comes from | |
| profile |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
| security |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |
| tag |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |
| 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. | |
| description |
0..1 | string | Summary of nature of plan | |
| subject |
1..1 | Reference(Patient | Group) | Who the care plan is for | |
| activity |
C | 0..* | BackboneElement | Action to occur as part of plan Constraints: cpl-3 |
| outcomeCodeableConcept |
0..* | CodeableConcept | Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. | |
| detail |
C | 0..1 | BackboneElement | In-line definition of activity |
| 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. | |
| scheduled[x] |
0..1 | Period | When activity is to occur | |
| location |
0..1 | Reference(Location) | Where it should happen | |
| note |
0..* | Annotation | Comments about the plan | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| CarePlan.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| CarePlan.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| CarePlan.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| CarePlan.intent | Base | required | Care Plan Intent | 📍4.0.1 | FHIR Std. |
| CarePlan.category | Base | example | Care Plan Category | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.outcomeCodeableConcept | Base | example | Care Plan Activity Outcome | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.code | Base | example | Procedure Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.status | Base | required | CarePlanActivityStatus | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| cpl-3 | error | CarePlan.activity | Provide a reference or detail, not both |
detail.empty() or reference.empty()
|
| dom-2 | error | CarePlan | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | 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 | error | 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 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | CarePlan | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from CarePlan
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| CarePlan |
0..* | CarePlan | Healthcare plan for patient or group | |
| 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. | |
| subject |
1..1 | Reference(Patient | Group) | Who the care plan is for | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| CarePlan.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| CarePlan.intent | Base | required | Care Plan Intent | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | CarePlan | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | 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 | error | 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 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | CarePlan | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
Differential View
This structure is derived from CarePlan
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| CarePlan |
0..* | CarePlan | Healthcare plan for patient or group | |
| meta |
||||
| Slices for extension |
Content/Rules for all slices | |||
| extension:hfRecordedDate |
0..1 | dateTime | The recorded date indicating when the record was uploaded by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate | |
| extension:hfLastUpdated |
0..* | dateTime | The date indicating when the record was last updated by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated | |
| lastUpdated |
0..1 | instant | When the resource was uploaded to the NHDR. | |
| implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| text |
0..0 | Text summary of the resource, for human interpretation | ||
| contained |
0..0 | Contained, inline Resources | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| identifier |
0..0 | External Ids for this plan | ||
| instantiatesCanonical |
0..0 | Instantiates FHIR protocol or definition | ||
| instantiatesUri |
0..0 | Instantiates external protocol or definition | ||
| basedOn |
0..0 | Fulfills CarePlan | ||
| replaces |
0..0 | CarePlan replaced by this CarePlan | ||
| partOf |
0..0 | Part of referenced CarePlan | ||
| title |
0..0 | Human-friendly name for the care plan | ||
| encounter |
0..0 | Encounter created as part of | ||
| period |
0..0 | Time period plan covers | ||
| created |
0..0 | Date record was first recorded | ||
| author |
0..0 | Who is the designated responsible party | ||
| contributor |
0..0 | Who provided the content of the care plan | ||
| careTeam |
0..0 | Who's involved in plan? | ||
| addresses |
0..0 | Health issues this plan addresses | ||
| supportingInfo |
0..0 | Information considered as part of plan | ||
| goal |
0..0 | Desired outcome of plan | ||
| activity |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| outcomeReference |
0..0 | Appointment, Encounter, Procedure, etc. | ||
| progress |
0..0 | Comments about the activity status/progress | ||
| reference |
0..0 | Activity details defined in specific resource | ||
| detail |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| kind |
0..0 | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | ||
| instantiatesCanonical |
0..0 | Instantiates FHIR protocol or definition | ||
| instantiatesUri |
0..0 | Instantiates external protocol or definition | ||
| reasonCode |
0..0 | Why activity should be done or why activity was prohibited | ||
| reasonReference |
0..0 | Why activity is needed | ||
| goal |
0..0 | Goals this activity relates to | ||
| statusReason |
0..0 | Reason for current status | ||
| doNotPerform |
0..0 | If true, activity is prohibiting action | ||
| scheduled[x] |
0..1 | Period | When activity is to occur | |
| performer |
0..0 | Who will be responsible? | ||
| product[x] |
0..0 | What is to be administered/supplied | ||
| dailyAmount |
0..0 | How to consume/day? | ||
| quantity |
0..0 | How much to administer/supply/consume | ||
| description |
0..0 | Extra info describing activity to perform | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension:hfRecordedDate |
0..1 | dateTime | The recorded date indicating when the record was uploaded by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate | |
| extension:hfLastUpdated |
0..* | dateTime | The date indicating when the record was last updated by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated | |
| versionId |
0..1 | id | Version specific identifier | |
| lastUpdated |
0..1 | instant | When the resource was uploaded to the NHDR. | |
| source |
0..1 | uri | Identifies where the resource comes from | |
| profile |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
| security |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |
| tag |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |
| 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. | |
| description |
0..1 | string | Summary of nature of plan | |
| subject |
1..1 | Reference(Patient | Group) | Who the care plan is for | |
| activity |
C | 0..* | BackboneElement | Action to occur as part of plan Constraints: cpl-3 |
| outcomeCodeableConcept |
0..* | CodeableConcept | Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. | |
| detail |
C | 0..1 | BackboneElement | In-line definition of activity |
| 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. | |
| scheduled[x] |
0..1 | Period | When activity is to occur | |
| location |
0..1 | Reference(Location) | Where it should happen | |
| note |
0..* | Annotation | Comments about the plan | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| CarePlan.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| CarePlan.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| CarePlan.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| CarePlan.intent | Base | required | Care Plan Intent | 📍4.0.1 | FHIR Std. |
| CarePlan.category | Base | example | Care Plan Category | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.outcomeCodeableConcept | Base | example | Care Plan Activity Outcome | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.code | Base | example | Procedure Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.status | Base | required | CarePlanActivityStatus | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| cpl-3 | error | CarePlan.activity | Provide a reference or detail, not both |
detail.empty() or reference.empty()
|
| dom-2 | error | CarePlan | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | 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 | error | 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 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | CarePlan | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from CarePlan
Other representations of profile: CSV, Excel, Schematron