Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Resource Profile: nl-core-careplan
| Official URL: http://fhir.nl/fhir/StructureDefinition/nl-core-careplan | Version: 1.3.15 | |||
| Active as of 2025-09-22 | Computable Name: nl-core-careplan | |||
Copyright/Legal: CC0 |
||||
An nl-core base CarePlan profile, that references to all relating Dutch Health and Care Information models or HCIM (Dutch: Zorginformatiebouwsteen or ZIB) profiles. This profile is not based on an HCIM, because no HCIM exists for the CarePlan concept.
Multiple HCIMs are better interpreted in a coherent set than by themselves. These are the HCIMs NursingIntervention, TreatmentObjective and TreatmentOutcome. They constitute a CarePlan, hence the reason to create a CarePlan profile.
Usages:
- This Profile is not used by any profiles in this Implementation Guide
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.
This structure is derived from CarePlan
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  CarePlan |
0..* | CarePlan | Healthcare plan for patient or group | |
  text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
| identifier |
0..* | Identifier | External Ids for this plan | |
 subject |
1..1 | Reference(nl-core-patient | Group) | Who care plan is for | |
| context |
0..1 | Reference(HCIM Encounter | nl-core-episodeofcare) | Created in context of | |
| period |
0..1 | Period | Time period plan covers | |
 author |
0..* | Reference(nl-core-patient | nl-core-practitioner | nl-core-relatedperson | nl-core-organization | nl-core-careteam) | Who is responsible for contents of the plan | |
   Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:practitionerRole |
0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference | |
| goal |
0..* | Reference(HCIM TreatmentObjective) | Desired outcome of plan | |
 Slices for activity |
0..* | BackboneElement | Action to occur as part of plan Slice: Unordered, Open by pattern:detail.category | |
 activity:nursingIntervention |
C | 0..* | BackboneElement | Action to occur as part of plan Constraints: hicm-outcomeofcare-1 |
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 extension:comment |
0..1 | (Complex) | Comment URL: http://nictiz.nl/fhir/StructureDefinition/Comment | |
 Slices for valueString |
Content/Rules for all slices | |||
| valueString:valueString |
0..1 | string | Comment | |
| outcomeCodeableConcept |
0..1 | CodeableConcept | Results of the activity | |
 text |
0..1 | string | HealthcareResult | |
 outcomeReference |
0..1 | Reference(HCIM General Measurement | HCIM FunctionalOrMentalStatus) | MeasurementValue / HealthCondition | |
| reference |
0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | HCIM ProcedureRequest | ReferralRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource | |
| detail |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:medicalDevice |
0..* | (Complex) | MedicalDevice URL: http://nictiz.nl/fhir/StructureDefinition/extension-medicaldevice | |
| Slices for valueReference |
Content/Rules for all slices | |||
| valueReference:valueReference |
0..1 | Reference() | Value of extension | |
| category |
1..1 | CodeableConcept | Nursing procedure Required Pattern: At least the following | |
 coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 9632001 | |
| code |
1..1 | CodeableConcept | Intervention | |
| Slices for coding |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | |
 coding:interventionNICCodelist |
0..1 | Coding | interventionNICCodelist Binding: InterventieNICCodelijst (required): NIC - All Values | |
 system |
1..1 | uri | Identity of the terminology system | |
 code |
1..1 | code | Symbol in syntax defined by the system | |
| coding:interventionSnomedCodelist |
0..1 | Coding | interventionSnomedCodelist Binding: InterventieSnomedCodelijst (required): SNOMED CT - SNOMED CT: <<71388002 | procedure | | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| reasonReference |
0..1 | Reference(HCIM Problem) | Indication | |
| goal |
0..1 | Reference(HCIM TreatmentObjective) | TreatmentObjective | |
| Slices for scheduledTiming |
Content/Rules for all slices | |||
| scheduledTiming:scheduledTiming |
0..1 | Timing | When activity is to occur | |
| repeat |
||||
| Slices for boundsPeriod |
Content/Rules for all slices | |||
| boundsPeriod:boundsPeriod |
0..1 | Period | Length/Range of lengths, or (Start and/or end) limits | |
| start |
0..1 | dateTime | ProcedureStartDateTime | |
| end |
0..1 | dateTime | ProcedureEndDateTime | |
| frequency |
0..1 | integer | Frequency | |
| period |
0..1 | decimal | Interval | |
| location |
0..1 | Reference(nl-core-location) | Where it should happen | |
| performer |
0..* | Reference(nl-core-practitioner | nl-core-organization | nl-core-relatedperson | nl-core-patient | nl-core-careteam) | Performer | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:practitionerRole |
0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference | |
| description |
0..1 | string | Instruction | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| CarePlan.activity:nursingIntervention.detail.code.coding:interventionNICCodelist | required | InterventieNICCodelijst(a valid code from urn:oid:2.16.840.1.113883.6.15)http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.2.2--20171231000000From this IG | |
| CarePlan.activity:nursingIntervention.detail.code.coding:interventionSnomedCodelist | required | InterventieSnomedCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.2.4--20171231000000From this IG |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| hicm-outcomeofcare-1 | error | CarePlan.activity:nursingIntervention | Provide a HealthcareResult text or a reference, not both : outcomeCodeableConcept.empty() or outcomeReference.empty() |
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| CarePlan |
0..* | CarePlan | Healthcare plan for patient or group | |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
Σ | 0..* | Identifier | External Ids for this plan |
| status |
?!Σ | 1..1 | code | draft | active | suspended | completed | entered-in-error | cancelled | unknown Binding: CarePlanStatus (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(nl-core-patient | Group) | Who care plan is for |
| context |
Σ | 0..1 | Reference(HCIM Encounter | nl-core-episodeofcare) | Created in context of |
| period |
Σ | 0..1 | Period | Time period plan covers |
| author |
Σ | 0..* | Reference(nl-core-patient | nl-core-practitioner | nl-core-relatedperson | nl-core-organization | nl-core-careteam) | Who is responsible for contents of the plan |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:practitionerRole |
0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference | |
| goal |
0..* | Reference(HCIM TreatmentObjective) | Desired outcome of plan | |
| Slices for activity |
C | 0..* | BackboneElement | Action to occur as part of plan Slice: Unordered, Open by pattern:detail.category Constraints: cpl-3 |
| activity:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| activity:nursingIntervention |
C | 0..* | BackboneElement | Action to occur as part of plan Constraints: cpl-3, hicm-outcomeofcare-1 |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:comment |
0..1 | (Complex) | Comment URL: http://nictiz.nl/fhir/StructureDefinition/Comment | |
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/Comment" | |
| Slices for value[x] |
0..1 | string | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueString |
0..1 | string | Comment | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| outcomeCodeableConcept |
0..1 | CodeableConcept | Results of the activity Binding: Care Plan Activity Outcome (example): Identifies the results of the activity | |
| text |
Σ | 0..1 | string | HealthcareResult |
| outcomeReference |
0..1 | Reference(HCIM General Measurement | HCIM FunctionalOrMentalStatus) | MeasurementValue / HealthCondition | |
| reference |
C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | HCIM ProcedureRequest | ReferralRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| CarePlan.status | required | CarePlanStatushttp://hl7.org/fhir/ValueSet/care-plan-status|3.0.2From the FHIR Standard | |
| CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|3.0.2From the FHIR Standard | |
| CarePlan.activity:nursingIntervention.outcomeCodeableConcept | example | Care Plan Activity Outcomehttp://hl7.org/fhir/ValueSet/care-plan-activity-outcome|3.0.2From the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| cpl-3 | error | CarePlan.activity, CarePlan.activity:nursingIntervention | Provide a reference or detail, not both : detail.empty() or reference.empty() | |
| dom-1 | error | CarePlan | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.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 : contained.where(('#'+id in %resource.descendants().reference).not()).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() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| hicm-outcomeofcare-1 | error | CarePlan.activity:nursingIntervention | Provide a HealthcareResult text or a reference, not both : outcomeCodeableConcept.empty() or outcomeReference.empty() |
| 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 | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External Ids for this plan | ||||
| definition |
Σ | 0..* | Reference(PlanDefinition | Questionnaire) | Protocol or definition | ||||
| basedOn |
Σ | 0..* | Reference(CarePlan) | Fulfills care plan | ||||
| replaces |
Σ | 0..* | Reference(CarePlan) | CarePlan replaced by this CarePlan | ||||
| partOf |
Σ | 0..* | Reference(CarePlan) | Part of referenced CarePlan | ||||
| status |
?!Σ | 1..1 | code | draft | active | suspended | completed | entered-in-error | cancelled | unknown Binding: CarePlanStatus (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: Care Plan Category (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 CarePlan | ||||
| description |
Σ | 0..1 | string | Summary of nature of plan | ||||
| subject |
Σ | 1..1 | Reference(nl-core-patient | Group) | Who care plan is for | ||||
| context |
Σ | 0..1 | Reference(HCIM Encounter | nl-core-episodeofcare) | Created in context of | ||||
| period |
Σ | 0..1 | Period | Time period plan covers | ||||
| author |
Σ | 0..* | Reference(nl-core-patient | nl-core-practitioner | nl-core-relatedperson | nl-core-organization | nl-core-careteam) | Who is responsible for contents of the plan | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:practitionerRole |
0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| careTeam |
0..* | Reference(CareTeam) | 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 |
0..* | Reference(HCIM TreatmentObjective) | Desired outcome of plan | |||||
| Slices for activity |
C | 0..* | BackboneElement | Action to occur as part of plan Slice: Unordered, Open by pattern:detail.category Constraints: cpl-3 | ||||
| activity:All Slices |
Content/Rules for all slices | |||||||
 id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| outcomeCodeableConcept |
0..* | CodeableConcept | Results of the activity Binding: Care Plan Activity Outcome (example): Identifies the results of the activity | |||||
| outcomeReference |
0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |||||
| progress |
0..* | Annotation | Comments about the activity status/progress | |||||
| reference |
C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ProcedureRequest | ReferralRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource | ||||
| detail |
C | 0..1 | BackboneElement | In-line definition of activity | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| category |
0..1 | CodeableConcept | diet | drug | encounter | observation | procedure | supply | other Binding: CarePlanActivityCategory (example): High-level categorization of the type of activity in a care plan. | |||||
| definition |
0..1 | Reference(PlanDefinition | ActivityDefinition | Questionnaire) | Protocol or definition | |||||
| code |
0..1 | CodeableConcept | Detail type of activity Binding: Care Plan Activity (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: Activity Reason (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) | Condition triggering need for activity | |||||
| goal |
0..* | Reference(Goal) | Goals this activity relates to | |||||
| status |
?! | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown Binding: CarePlanActivityStatus (required): Indicates where the activity is at in its overall life cycle. | ||||
| statusReason |
0..1 | string | Reason for current status | |||||
| prohibited |
?! | 0..1 | boolean | Do NOT do | ||||
 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(Practitioner | Organization | RelatedPerson | Patient | CareTeam) | Who will be responsible? | |||||
| product[x] |
0..1 | What is to be administered/supplied Binding: SNOMED CT Medication Codes (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 |
0..1 | string | Extra info describing activity to perform | |||||
| activity:nursingIntervention |
C | 0..* | BackboneElement | Action to occur as part of plan Constraints: cpl-3, hicm-outcomeofcare-1 | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:comment |
0..1 | (Complex) | Comment URL: http://nictiz.nl/fhir/StructureDefinition/Comment | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/Comment" | |||||
| Slices for value[x] |
0..1 | string | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueString |
0..1 | string | Comment | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| outcomeCodeableConcept |
0..1 | CodeableConcept | Results of the activity Binding: Care Plan Activity Outcome (example): Identifies the results of the activity | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | HealthcareResult | ||||
| outcomeReference |
0..1 | Reference(HCIM General Measurement | HCIM FunctionalOrMentalStatus) | MeasurementValue / HealthCondition | |||||
| progress |
0..* | Annotation | Comments about the activity status/progress | |||||
| reference |
C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | HCIM ProcedureRequest | ReferralRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource | ||||
| detail |
C | 0..1 | BackboneElement | In-line definition of activity | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:medicalDevice |
0..* | (Complex) | MedicalDevice URL: http://nictiz.nl/fhir/StructureDefinition/extension-medicaldevice | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/extension-medicaldevice" | |||||
| Slices for value[x] |
0..1 | Reference() | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueReference |
0..1 | Reference() | Value of extension | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| category |
1..1 | CodeableConcept | Nursing procedure Binding: CarePlanActivityCategory (example): High-level categorization of the type of activity in a care plan. Required Pattern: At least the following | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 9632001 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| definition |
0..1 | Reference(PlanDefinition | ActivityDefinition | Questionnaire) | Protocol or definition | |||||
| code |
1..1 | CodeableConcept | Intervention Binding: Care Plan Activity (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | ||||
| coding:interventionNICCodelist |
Σ | 0..1 | Coding | interventionNICCodelist Binding: InterventieNICCodelijst (required): NIC - All Values | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| coding:interventionSnomedCodelist |
Σ | 0..1 | Coding | interventionSnomedCodelist Binding: InterventieSnomedCodelijst (required): SNOMED CT - SNOMED CT: <<71388002 | procedure | | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| reasonCode |
0..* | CodeableConcept | Why activity should be done or why activity was prohibited Binding: Activity Reason (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..1 | Reference(HCIM Problem) | Indication | |||||
| goal |
0..1 | Reference(HCIM TreatmentObjective) | TreatmentObjective | |||||
| status |
?! | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown Binding: CarePlanActivityStatus (required): Indicates where the activity is at in its overall life cycle. | ||||
| statusReason |
0..1 | string | Reason for current status | |||||
| prohibited |
?! | 0..1 | boolean | Do NOT do | ||||
| Slices for scheduled[x] |
0..1 | Timing | When activity is to occur Slice: Unordered, Closed by type:$this | |||||
| scheduled[x]:scheduledTiming |
0..1 | Timing | When activity is to occur | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| event |
Σ | 0..* | dateTime | When the event occurs | ||||
| repeat |
ΣC | 0..1 | Element | When the event is to occur Constraints: tim-9, tim-5, tim-6, tim-7, tim-8, tim-1, tim-10, tim-2, tim-4 | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for bounds[x] |
Σ | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Closed by type:$this | ||||
| bounds[x]:boundsPeriod |
Σ | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
ΣC | 0..1 | dateTime | ProcedureStartDateTime | ||||
| end |
ΣC | 0..1 | dateTime | ProcedureEndDateTime | ||||
| count |
Σ | 0..1 | integer | Number of times to repeat | ||||
| countMax |
Σ | 0..1 | integer | Maximum number of times to repeat | ||||
| duration |
Σ | 0..1 | decimal | How long when it happens | ||||
| durationMax |
Σ | 0..1 | decimal | How long when it happens (Max) | ||||
| durationUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
| frequency |
Σ | 0..1 | integer | Frequency | ||||
| frequencyMax |
Σ | 0..1 | integer | Event occurs up to frequencyMax times per period | ||||
| period |
Σ | 0..1 | decimal | Interval | ||||
| periodMax |
Σ | 0..1 | decimal | Upper limit of period (3-4 hours) | ||||
| periodUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
| dayOfWeek |
Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | ||||
| timeOfDay |
Σ | 0..* | time | Time of day for action | ||||
| when |
Σ | 0..* | code | Regular life events the event is tied to Binding: EventTiming (required): Real world event relating to the schedule. | ||||
| offset |
Σ | 0..1 | unsignedInt | Minutes from event (before or after) | ||||
| code |
Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | Q4H | Q6H + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. | ||||
| location |
0..1 | Reference(nl-core-location) | Where it should happen | |||||
| performer |
0..* | Reference(nl-core-practitioner | nl-core-organization | nl-core-relatedperson | nl-core-patient | nl-core-careteam) | Performer | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:practitionerRole |
0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| product[x] |
0..1 | What is to be administered/supplied Binding: SNOMED CT Medication Codes (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 |
0..1 | string | Instruction | |||||
| note |
0..* | Annotation | Comments about the plan | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI | |||
| CarePlan.language | extensible | Common Languageshttp://hl7.org/fhir/ValueSet/languages|3.0.2From the FHIR Standard
| ||||
| CarePlan.status | required | CarePlanStatushttp://hl7.org/fhir/ValueSet/care-plan-status|3.0.2From the FHIR Standard | ||||
| CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|3.0.2From the FHIR Standard | ||||
| CarePlan.category | example | Care Plan Categoryhttp://hl7.org/fhir/ValueSet/care-plan-category|3.0.2From the FHIR Standard | ||||
| CarePlan.activity.outcomeCodeableConcept | example | Care Plan Activity Outcomehttp://hl7.org/fhir/ValueSet/care-plan-activity-outcome|3.0.2From the FHIR Standard | ||||
| CarePlan.activity.detail.category | example | CarePlanActivityCategoryhttp://hl7.org/fhir/ValueSet/care-plan-activity-category|1.0.0From the FHIR Standard | ||||
| CarePlan.activity.detail.code | example | Care Plan Activityhttp://hl7.org/fhir/ValueSet/care-plan-activity|3.0.2From the FHIR Standard | ||||
| CarePlan.activity.detail.reasonCode | example | Activity Reasonhttp://hl7.org/fhir/ValueSet/activity-reason|3.0.2From the FHIR Standard | ||||
| CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|3.0.2From the FHIR Standard | ||||
| CarePlan.activity.detail.product[x] | example | SNOMED CT Medication Codeshttp://hl7.org/fhir/ValueSet/medication-codes|3.0.2From the FHIR Standard | ||||
| CarePlan.activity:nursingIntervention.outcomeCodeableConcept | example | Care Plan Activity Outcomehttp://hl7.org/fhir/ValueSet/care-plan-activity-outcome|3.0.2From the FHIR Standard | ||||
| CarePlan.activity:nursingIntervention.detail.category | example | Pattern Value: SNOMED-CT Code 9632001http://hl7.org/fhir/ValueSet/care-plan-activity-category|1.0.0From the FHIR Standard | ||||
| CarePlan.activity:nursingIntervention.detail.code | example | Care Plan Activityhttp://hl7.org/fhir/ValueSet/care-plan-activity|3.0.2From the FHIR Standard | ||||
| CarePlan.activity:nursingIntervention.detail.code.coding:interventionNICCodelist | required | InterventieNICCodelijst(a valid code from urn:oid:2.16.840.1.113883.6.15)http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.2.2--20171231000000From this IG | ||||
| CarePlan.activity:nursingIntervention.detail.code.coding:interventionSnomedCodelist | required | InterventieSnomedCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.2.4--20171231000000From this IG | ||||
| CarePlan.activity:nursingIntervention.detail.reasonCode | example | Activity Reasonhttp://hl7.org/fhir/ValueSet/activity-reason|3.0.2From the FHIR Standard | ||||
| CarePlan.activity:nursingIntervention.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|3.0.2From the FHIR Standard | ||||
| CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|3.0.2From the FHIR Standard | ||||
| CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|3.0.2From the FHIR Standard | ||||
| CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.repeat.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|3.0.2From the FHIR Standard | ||||
| CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|3.0.2From the FHIR Standard | ||||
| CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.code | preferred | TimingAbbreviationhttp://hl7.org/fhir/ValueSet/timing-abbreviation|3.0.2From the FHIR Standard | ||||
| CarePlan.activity:nursingIntervention.detail.product[x] | example | SNOMED CT Medication Codeshttp://hl7.org/fhir/ValueSet/medication-codes|3.0.2From the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| cpl-3 | error | CarePlan.activity, CarePlan.activity:nursingIntervention | Provide a reference or detail, not both : detail.empty() or reference.empty() | |
| dom-1 | error | CarePlan | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.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 : contained.where(('#'+id in %resource.descendants().reference).not()).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() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| hicm-outcomeofcare-1 | error | CarePlan.activity:nursingIntervention | Provide a HealthcareResult text or a reference, not both : outcomeCodeableConcept.empty() or outcomeReference.empty() | |
| tim-1 | error | CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.repeat | if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists() | |
| tim-2 | error | CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.repeat | if there's a period, there needs to be period units : period.empty() or periodUnit.exists() | |
| tim-4 | error | CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.repeat | duration SHALL be a non-negative value : duration.exists() implies duration >= 0 | |
| tim-5 | error | CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.repeat | period SHALL be a non-negative value : period.exists() implies period >= 0 | |
| tim-6 | error | CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.repeat | If there's a periodMax, there must be a period : periodMax.empty() or period.exists() | |
| tim-7 | error | CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.repeat | If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists() | |
| tim-8 | error | CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.repeat | If there's a countMax, there must be a count : countMax.empty() or count.exists() | |
| tim-9 | error | CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.repeat | If there's an offset, there must be a when (and not C, CM, CD, CV) : offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not())) | |
| tim-10 | error | CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.repeat | If there's a timeOfDay, there cannot be be a when, or vice versa : timeOfDay.empty() or when.empty() |
This structure is derived from CarePlan
Summary
Mandatory: 0 element(6 nested mandatory elements)
Structures
This structure refers to these other structures:
- nl-core-patient (http://fhir.nl/fhir/StructureDefinition/nl-core-patient)
- HCIM Encounter (http://nictiz.nl/fhir/StructureDefinition/zib-Encounter)
- nl-core-episodeofcare (http://fhir.nl/fhir/StructureDefinition/nl-core-episodeofcare)
- nl-core-practitioner (http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner)
- nl-core-relatedperson (http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson)
- nl-core-organization (http://fhir.nl/fhir/StructureDefinition/nl-core-organization)
- nl-core-careteam (http://fhir.nl/fhir/StructureDefinition/nl-core-careteam)
- HCIM TreatmentObjective (http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentObjective)
- HCIM General Measurement (http://nictiz.nl/fhir/StructureDefinition/zib-GeneralMeasurement)
- HCIM FunctionalOrMentalStatus (http://nictiz.nl/fhir/StructureDefinition/zib-FunctionalOrMentalStatus)
- HCIM ProcedureRequest (http://nictiz.nl/fhir/StructureDefinition/zib-ProcedureRequest)
- HCIM Problem (http://nictiz.nl/fhir/StructureDefinition/zib-Problem)
- nl-core-location (http://fhir.nl/fhir/StructureDefinition/nl-core-location)
Extensions
This structure refers to these extensions:
- http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
- http://nictiz.nl/fhir/StructureDefinition/Comment
- http://nictiz.nl/fhir/StructureDefinition/extension-medicaldevice
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of CarePlan.activity
- The element 1 is sliced based on the value of CarePlan.activity.detail.code.coding
Differential View
This structure is derived from CarePlan
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| CarePlan |
0..* | CarePlan | Healthcare plan for patient or group | |
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
| identifier |
0..* | Identifier | External Ids for this plan | |
| subject |
1..1 | Reference(nl-core-patient | Group) | Who care plan is for | |
| context |
0..1 | Reference(HCIM Encounter | nl-core-episodeofcare) | Created in context of | |
| period |
0..1 | Period | Time period plan covers | |
| author |
0..* | Reference(nl-core-patient | nl-core-practitioner | nl-core-relatedperson | nl-core-organization | nl-core-careteam) | Who is responsible for contents of the plan | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:practitionerRole |
0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference | |
| goal |
0..* | Reference(HCIM TreatmentObjective) | Desired outcome of plan | |
| Slices for activity |
0..* | BackboneElement | Action to occur as part of plan Slice: Unordered, Open by pattern:detail.category | |
| activity:nursingIntervention |
C | 0..* | BackboneElement | Action to occur as part of plan Constraints: hicm-outcomeofcare-1 |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:comment |
0..1 | (Complex) | Comment URL: http://nictiz.nl/fhir/StructureDefinition/Comment | |
| Slices for valueString |
Content/Rules for all slices | |||
| valueString:valueString |
0..1 | string | Comment | |
| outcomeCodeableConcept |
0..1 | CodeableConcept | Results of the activity | |
| text |
0..1 | string | HealthcareResult | |
| outcomeReference |
0..1 | Reference(HCIM General Measurement | HCIM FunctionalOrMentalStatus) | MeasurementValue / HealthCondition | |
| reference |
0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | HCIM ProcedureRequest | ReferralRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource | |
| detail |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:medicalDevice |
0..* | (Complex) | MedicalDevice URL: http://nictiz.nl/fhir/StructureDefinition/extension-medicaldevice | |
| Slices for valueReference |
Content/Rules for all slices | |||
| valueReference:valueReference |
0..1 | Reference() | Value of extension | |
| category |
1..1 | CodeableConcept | Nursing procedure Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 9632001 | |
| code |
1..1 | CodeableConcept | Intervention | |
| Slices for coding |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | |
| coding:interventionNICCodelist |
0..1 | Coding | interventionNICCodelist Binding: InterventieNICCodelijst (required): NIC - All Values | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| coding:interventionSnomedCodelist |
0..1 | Coding | interventionSnomedCodelist Binding: InterventieSnomedCodelijst (required): SNOMED CT - SNOMED CT: <<71388002 | procedure | | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| reasonReference |
0..1 | Reference(HCIM Problem) | Indication | |
| goal |
0..1 | Reference(HCIM TreatmentObjective) | TreatmentObjective | |
| Slices for scheduledTiming |
Content/Rules for all slices | |||
| scheduledTiming:scheduledTiming |
0..1 | Timing | When activity is to occur | |
| repeat |
||||
| Slices for boundsPeriod |
Content/Rules for all slices | |||
| boundsPeriod:boundsPeriod |
0..1 | Period | Length/Range of lengths, or (Start and/or end) limits | |
| start |
0..1 | dateTime | ProcedureStartDateTime | |
| end |
0..1 | dateTime | ProcedureEndDateTime | |
| frequency |
0..1 | integer | Frequency | |
| period |
0..1 | decimal | Interval | |
| location |
0..1 | Reference(nl-core-location) | Where it should happen | |
| performer |
0..* | Reference(nl-core-practitioner | nl-core-organization | nl-core-relatedperson | nl-core-patient | nl-core-careteam) | Performer | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:practitionerRole |
0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference | |
| description |
0..1 | string | Instruction | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| CarePlan.activity:nursingIntervention.detail.code.coding:interventionNICCodelist | required | InterventieNICCodelijst(a valid code from urn:oid:2.16.840.1.113883.6.15)http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.2.2--20171231000000From this IG | |
| CarePlan.activity:nursingIntervention.detail.code.coding:interventionSnomedCodelist | required | InterventieSnomedCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.2.4--20171231000000From this IG |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| hicm-outcomeofcare-1 | error | CarePlan.activity:nursingIntervention | Provide a HealthcareResult text or a reference, not both : outcomeCodeableConcept.empty() or outcomeReference.empty() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| CarePlan |
0..* | CarePlan | Healthcare plan for patient or group | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
Σ | 0..* | Identifier | External Ids for this plan |
| status |
?!Σ | 1..1 | code | draft | active | suspended | completed | entered-in-error | cancelled | unknown Binding: CarePlanStatus (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(nl-core-patient | Group) | Who care plan is for |
| context |
Σ | 0..1 | Reference(HCIM Encounter | nl-core-episodeofcare) | Created in context of |
| period |
Σ | 0..1 | Period | Time period plan covers |
| author |
Σ | 0..* | Reference(nl-core-patient | nl-core-practitioner | nl-core-relatedperson | nl-core-organization | nl-core-careteam) | Who is responsible for contents of the plan |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:practitionerRole |
0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference | |
| goal |
0..* | Reference(HCIM TreatmentObjective) | Desired outcome of plan | |
| Slices for activity |
C | 0..* | BackboneElement | Action to occur as part of plan Slice: Unordered, Open by pattern:detail.category Constraints: cpl-3 |
| activity:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| activity:nursingIntervention |
C | 0..* | BackboneElement | Action to occur as part of plan Constraints: cpl-3, hicm-outcomeofcare-1 |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:comment |
0..1 | (Complex) | Comment URL: http://nictiz.nl/fhir/StructureDefinition/Comment | |
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/Comment" | |
| Slices for value[x] |
0..1 | string | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueString |
0..1 | string | Comment | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| outcomeCodeableConcept |
0..1 | CodeableConcept | Results of the activity Binding: Care Plan Activity Outcome (example): Identifies the results of the activity | |
| text |
Σ | 0..1 | string | HealthcareResult |
| outcomeReference |
0..1 | Reference(HCIM General Measurement | HCIM FunctionalOrMentalStatus) | MeasurementValue / HealthCondition | |
| reference |
C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | HCIM ProcedureRequest | ReferralRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| CarePlan.status | required | CarePlanStatushttp://hl7.org/fhir/ValueSet/care-plan-status|3.0.2From the FHIR Standard | |
| CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|3.0.2From the FHIR Standard | |
| CarePlan.activity:nursingIntervention.outcomeCodeableConcept | example | Care Plan Activity Outcomehttp://hl7.org/fhir/ValueSet/care-plan-activity-outcome|3.0.2From the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| cpl-3 | error | CarePlan.activity, CarePlan.activity:nursingIntervention | Provide a reference or detail, not both : detail.empty() or reference.empty() | |
| dom-1 | error | CarePlan | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.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 : contained.where(('#'+id in %resource.descendants().reference).not()).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() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| hicm-outcomeofcare-1 | error | CarePlan.activity:nursingIntervention | Provide a HealthcareResult text or a reference, not both : outcomeCodeableConcept.empty() or outcomeReference.empty() |
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 | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External Ids for this plan | ||||
| definition |
Σ | 0..* | Reference(PlanDefinition | Questionnaire) | Protocol or definition | ||||
| basedOn |
Σ | 0..* | Reference(CarePlan) | Fulfills care plan | ||||
| replaces |
Σ | 0..* | Reference(CarePlan) | CarePlan replaced by this CarePlan | ||||
| partOf |
Σ | 0..* | Reference(CarePlan) | Part of referenced CarePlan | ||||
| status |
?!Σ | 1..1 | code | draft | active | suspended | completed | entered-in-error | cancelled | unknown Binding: CarePlanStatus (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: Care Plan Category (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 CarePlan | ||||
| description |
Σ | 0..1 | string | Summary of nature of plan | ||||
| subject |
Σ | 1..1 | Reference(nl-core-patient | Group) | Who care plan is for | ||||
| context |
Σ | 0..1 | Reference(HCIM Encounter | nl-core-episodeofcare) | Created in context of | ||||
| period |
Σ | 0..1 | Period | Time period plan covers | ||||
| author |
Σ | 0..* | Reference(nl-core-patient | nl-core-practitioner | nl-core-relatedperson | nl-core-organization | nl-core-careteam) | Who is responsible for contents of the plan | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:practitionerRole |
0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| careTeam |
0..* | Reference(CareTeam) | 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 |
0..* | Reference(HCIM TreatmentObjective) | Desired outcome of plan | |||||
| Slices for activity |
C | 0..* | BackboneElement | Action to occur as part of plan Slice: Unordered, Open by pattern:detail.category Constraints: cpl-3 | ||||
| activity:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| outcomeCodeableConcept |
0..* | CodeableConcept | Results of the activity Binding: Care Plan Activity Outcome (example): Identifies the results of the activity | |||||
| outcomeReference |
0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |||||
| progress |
0..* | Annotation | Comments about the activity status/progress | |||||
| reference |
C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ProcedureRequest | ReferralRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource | ||||
| detail |
C | 0..1 | BackboneElement | In-line definition of activity | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| category |
0..1 | CodeableConcept | diet | drug | encounter | observation | procedure | supply | other Binding: CarePlanActivityCategory (example): High-level categorization of the type of activity in a care plan. | |||||
| definition |
0..1 | Reference(PlanDefinition | ActivityDefinition | Questionnaire) | Protocol or definition | |||||
| code |
0..1 | CodeableConcept | Detail type of activity Binding: Care Plan Activity (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: Activity Reason (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) | Condition triggering need for activity | |||||
| goal |
0..* | Reference(Goal) | Goals this activity relates to | |||||
| status |
?! | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown Binding: CarePlanActivityStatus (required): Indicates where the activity is at in its overall life cycle. | ||||
| statusReason |
0..1 | string | Reason for current status | |||||
| prohibited |
?! | 0..1 | boolean | Do NOT do | ||||
| 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(Practitioner | Organization | RelatedPerson | Patient | CareTeam) | Who will be responsible? | |||||
| product[x] |
0..1 | What is to be administered/supplied Binding: SNOMED CT Medication Codes (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 |
0..1 | string | Extra info describing activity to perform | |||||
| activity:nursingIntervention |
C | 0..* | BackboneElement | Action to occur as part of plan Constraints: cpl-3, hicm-outcomeofcare-1 | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:comment |
0..1 | (Complex) | Comment URL: http://nictiz.nl/fhir/StructureDefinition/Comment | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/Comment" | |||||
| Slices for value[x] |
0..1 | string | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueString |
0..1 | string | Comment | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| outcomeCodeableConcept |
0..1 | CodeableConcept | Results of the activity Binding: Care Plan Activity Outcome (example): Identifies the results of the activity | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | HealthcareResult | ||||
| outcomeReference |
0..1 | Reference(HCIM General Measurement | HCIM FunctionalOrMentalStatus) | MeasurementValue / HealthCondition | |||||
| progress |
0..* | Annotation | Comments about the activity status/progress | |||||
| reference |
C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | HCIM ProcedureRequest | ReferralRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource | ||||
| detail |
C | 0..1 | BackboneElement | In-line definition of activity | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:medicalDevice |
0..* | (Complex) | MedicalDevice URL: http://nictiz.nl/fhir/StructureDefinition/extension-medicaldevice | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/extension-medicaldevice" | |||||
| Slices for value[x] |
0..1 | Reference() | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueReference |
0..1 | Reference() | Value of extension | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| category |
1..1 | CodeableConcept | Nursing procedure Binding: CarePlanActivityCategory (example): High-level categorization of the type of activity in a care plan. Required Pattern: At least the following | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 9632001 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| definition |
0..1 | Reference(PlanDefinition | ActivityDefinition | Questionnaire) | Protocol or definition | |||||
| code |
1..1 | CodeableConcept | Intervention Binding: Care Plan Activity (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | ||||
| coding:interventionNICCodelist |
Σ | 0..1 | Coding | interventionNICCodelist Binding: InterventieNICCodelijst (required): NIC - All Values | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| coding:interventionSnomedCodelist |
Σ | 0..1 | Coding | interventionSnomedCodelist Binding: InterventieSnomedCodelijst (required): SNOMED CT - SNOMED CT: <<71388002 | procedure | | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 1..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| reasonCode |
0..* | CodeableConcept | Why activity should be done or why activity was prohibited Binding: Activity Reason (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..1 | Reference(HCIM Problem) | Indication | |||||
| goal |
0..1 | Reference(HCIM TreatmentObjective) | TreatmentObjective | |||||
| status |
?! | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown Binding: CarePlanActivityStatus (required): Indicates where the activity is at in its overall life cycle. | ||||
| statusReason |
0..1 | string | Reason for current status | |||||
| prohibited |
?! | 0..1 | boolean | Do NOT do | ||||
| Slices for scheduled[x] |
0..1 | Timing | When activity is to occur Slice: Unordered, Closed by type:$this | |||||
| scheduled[x]:scheduledTiming |
0..1 | Timing | When activity is to occur | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| event |
Σ | 0..* | dateTime | When the event occurs | ||||
| repeat |
ΣC | 0..1 | Element | When the event is to occur Constraints: tim-9, tim-5, tim-6, tim-7, tim-8, tim-1, tim-10, tim-2, tim-4 | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for bounds[x] |
Σ | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Closed by type:$this | ||||
| bounds[x]:boundsPeriod |
Σ | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
ΣC | 0..1 | dateTime | ProcedureStartDateTime | ||||
| end |
ΣC | 0..1 | dateTime | ProcedureEndDateTime | ||||
| count |
Σ | 0..1 | integer | Number of times to repeat | ||||
| countMax |
Σ | 0..1 | integer | Maximum number of times to repeat | ||||
| duration |
Σ | 0..1 | decimal | How long when it happens | ||||
| durationMax |
Σ | 0..1 | decimal | How long when it happens (Max) | ||||
| durationUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
| frequency |
Σ | 0..1 | integer | Frequency | ||||
| frequencyMax |
Σ | 0..1 | integer | Event occurs up to frequencyMax times per period | ||||
| period |
Σ | 0..1 | decimal | Interval | ||||
| periodMax |
Σ | 0..1 | decimal | Upper limit of period (3-4 hours) | ||||
| periodUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
| dayOfWeek |
Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | ||||
| timeOfDay |
Σ | 0..* | time | Time of day for action | ||||
| when |
Σ | 0..* | code | Regular life events the event is tied to Binding: EventTiming (required): Real world event relating to the schedule. | ||||
| offset |
Σ | 0..1 | unsignedInt | Minutes from event (before or after) | ||||
| code |
Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | Q4H | Q6H + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. | ||||
| location |
0..1 | Reference(nl-core-location) | Where it should happen | |||||
| performer |
0..* | Reference(nl-core-practitioner | nl-core-organization | nl-core-relatedperson | nl-core-patient | nl-core-careteam) | Performer | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:practitionerRole |
0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| product[x] |
0..1 | What is to be administered/supplied Binding: SNOMED CT Medication Codes (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 |
0..1 | string | Instruction | |||||
| note |
0..* | Annotation | Comments about the plan | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI | |||
| CarePlan.language | extensible | Common Languageshttp://hl7.org/fhir/ValueSet/languages|3.0.2From the FHIR Standard
| ||||
| CarePlan.status | required | CarePlanStatushttp://hl7.org/fhir/ValueSet/care-plan-status|3.0.2From the FHIR Standard | ||||
| CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|3.0.2From the FHIR Standard | ||||
| CarePlan.category | example | Care Plan Categoryhttp://hl7.org/fhir/ValueSet/care-plan-category|3.0.2From the FHIR Standard | ||||
| CarePlan.activity.outcomeCodeableConcept | example | Care Plan Activity Outcomehttp://hl7.org/fhir/ValueSet/care-plan-activity-outcome|3.0.2From the FHIR Standard | ||||
| CarePlan.activity.detail.category | example | CarePlanActivityCategoryhttp://hl7.org/fhir/ValueSet/care-plan-activity-category|1.0.0From the FHIR Standard | ||||
| CarePlan.activity.detail.code | example | Care Plan Activityhttp://hl7.org/fhir/ValueSet/care-plan-activity|3.0.2From the FHIR Standard | ||||
| CarePlan.activity.detail.reasonCode | example | Activity Reasonhttp://hl7.org/fhir/ValueSet/activity-reason|3.0.2From the FHIR Standard | ||||
| CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|3.0.2From the FHIR Standard | ||||
| CarePlan.activity.detail.product[x] | example | SNOMED CT Medication Codeshttp://hl7.org/fhir/ValueSet/medication-codes|3.0.2From the FHIR Standard | ||||
| CarePlan.activity:nursingIntervention.outcomeCodeableConcept | example | Care Plan Activity Outcomehttp://hl7.org/fhir/ValueSet/care-plan-activity-outcome|3.0.2From the FHIR Standard | ||||
| CarePlan.activity:nursingIntervention.detail.category | example | Pattern Value: SNOMED-CT Code 9632001http://hl7.org/fhir/ValueSet/care-plan-activity-category|1.0.0From the FHIR Standard | ||||
| CarePlan.activity:nursingIntervention.detail.code | example | Care Plan Activityhttp://hl7.org/fhir/ValueSet/care-plan-activity|3.0.2From the FHIR Standard | ||||
| CarePlan.activity:nursingIntervention.detail.code.coding:interventionNICCodelist | required | InterventieNICCodelijst(a valid code from urn:oid:2.16.840.1.113883.6.15)http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.2.2--20171231000000From this IG | ||||
| CarePlan.activity:nursingIntervention.detail.code.coding:interventionSnomedCodelist | required | InterventieSnomedCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.2.4--20171231000000From this IG | ||||
| CarePlan.activity:nursingIntervention.detail.reasonCode | example | Activity Reasonhttp://hl7.org/fhir/ValueSet/activity-reason|3.0.2From the FHIR Standard | ||||
| CarePlan.activity:nursingIntervention.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|3.0.2From the FHIR Standard | ||||
| CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|3.0.2From the FHIR Standard | ||||
| CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|3.0.2From the FHIR Standard | ||||
| CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.repeat.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|3.0.2From the FHIR Standard | ||||
| CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|3.0.2From the FHIR Standard | ||||
| CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.code | preferred | TimingAbbreviationhttp://hl7.org/fhir/ValueSet/timing-abbreviation|3.0.2From the FHIR Standard | ||||
| CarePlan.activity:nursingIntervention.detail.product[x] | example | SNOMED CT Medication Codeshttp://hl7.org/fhir/ValueSet/medication-codes|3.0.2From the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| cpl-3 | error | CarePlan.activity, CarePlan.activity:nursingIntervention | Provide a reference or detail, not both : detail.empty() or reference.empty() | |
| dom-1 | error | CarePlan | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.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 : contained.where(('#'+id in %resource.descendants().reference).not()).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() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| hicm-outcomeofcare-1 | error | CarePlan.activity:nursingIntervention | Provide a HealthcareResult text or a reference, not both : outcomeCodeableConcept.empty() or outcomeReference.empty() | |
| tim-1 | error | CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.repeat | if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists() | |
| tim-2 | error | CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.repeat | if there's a period, there needs to be period units : period.empty() or periodUnit.exists() | |
| tim-4 | error | CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.repeat | duration SHALL be a non-negative value : duration.exists() implies duration >= 0 | |
| tim-5 | error | CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.repeat | period SHALL be a non-negative value : period.exists() implies period >= 0 | |
| tim-6 | error | CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.repeat | If there's a periodMax, there must be a period : periodMax.empty() or period.exists() | |
| tim-7 | error | CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.repeat | If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists() | |
| tim-8 | error | CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.repeat | If there's a countMax, there must be a count : countMax.empty() or count.exists() | |
| tim-9 | error | CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.repeat | If there's an offset, there must be a when (and not C, CM, CD, CV) : offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not())) | |
| tim-10 | error | CarePlan.activity:nursingIntervention.detail.scheduled[x]:scheduledTiming.repeat | If there's a timeOfDay, there cannot be be a when, or vice versa : timeOfDay.empty() or when.empty() |
This structure is derived from CarePlan
Summary
Mandatory: 0 element(6 nested mandatory elements)
Structures
This structure refers to these other structures:
- nl-core-patient (http://fhir.nl/fhir/StructureDefinition/nl-core-patient)
- HCIM Encounter (http://nictiz.nl/fhir/StructureDefinition/zib-Encounter)
- nl-core-episodeofcare (http://fhir.nl/fhir/StructureDefinition/nl-core-episodeofcare)
- nl-core-practitioner (http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner)
- nl-core-relatedperson (http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson)
- nl-core-organization (http://fhir.nl/fhir/StructureDefinition/nl-core-organization)
- nl-core-careteam (http://fhir.nl/fhir/StructureDefinition/nl-core-careteam)
- HCIM TreatmentObjective (http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentObjective)
- HCIM General Measurement (http://nictiz.nl/fhir/StructureDefinition/zib-GeneralMeasurement)
- HCIM FunctionalOrMentalStatus (http://nictiz.nl/fhir/StructureDefinition/zib-FunctionalOrMentalStatus)
- HCIM ProcedureRequest (http://nictiz.nl/fhir/StructureDefinition/zib-ProcedureRequest)
- HCIM Problem (http://nictiz.nl/fhir/StructureDefinition/zib-Problem)
- nl-core-location (http://fhir.nl/fhir/StructureDefinition/nl-core-location)
Extensions
This structure refers to these extensions:
- http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
- http://nictiz.nl/fhir/StructureDefinition/Comment
- http://nictiz.nl/fhir/StructureDefinition/extension-medicaldevice
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of CarePlan.activity
- The element 1 is sliced based on the value of CarePlan.activity.detail.code.coding
Other representations of profile: CSV, Excel, Schematron