Nictiz FHIR NL R4 Zib2020
0.9.0 - CI Build

Nictiz FHIR NL R4 Zib2020 - Local Development build (v0.9.0). See the Directory of published versions

Resource Profile: nl core NursingIntervention

Official URL: http://nictiz.nl/fhir/StructureDefinition/nl-core-NursingIntervention Version: 0.9.0
Draft as of 2023-10-17 Computable Name: NlcoreNursingIntervention

Copyright/Legal: Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.

A nursing intervention is the care and/or treatment carried out by a nurse based on an expert opinion and clinical knowledge. It is part of the nursing process; interventions are determined as a result of indexed healthcare problems (nursing diagnoses) and based on treatment goals. Following the NEN-EN-ISO 18104 norm, it is possible to structure nursing interventions (or actions) in a hierarchy, where one intervention can be part of another intervention.

In a home care situation some actions can also be performed by the patient or a caregiver after a relevant instruction.

A derived profile from zib-NursingIntervention to provide a version better suited for implementation purposes. This profile augments the base profile with elements found in the various use cases that have adopted the zib.

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan C0..*ZibNursingInterventionNursingIntervention
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codedraft | 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.

... Slices for category Σ1..*CodeableConceptType of plan
Slice: Unordered, Open by value:coding
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.


.... category:nursingIntervention Σ1..1CodeableConceptType 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.



Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 9632001
... subject Σ1..1Reference(Patient | Group | nl core Patient)Who the care plan is for
... Slices for contributor 0..*Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)Who provided the content of the care plan
Slice: Unordered, Open by exists:extension(url='http://nictiz.nl/fhir/StructureDefinition/ext-NursingIntervention-ContributorIsRequester')
.... contributor:requester 0..*PatternNlCoreHealthProfessionalReference(nl core HealthProfessional PractitionerRole)A reference from one resource to another
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... contributorIsRequester 1..1booleanOptional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-NursingIntervention-ContributorIsRequester
... addresses Σ0..1Reference(Condition | nl core Problem)Indication
... goal 0..1Reference(Goal | http://nictiz.nl/fhir/StructureDefinition/nl-core-TreatmentObjective)TreatmentObjective
... activity C0..1BackboneElementAction to occur as part of plan
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
... note 0..1AnnotationComments about the plan
.... text Σ1..1markdownComment

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
CarePlan.statusrequiredRequestStatus
CarePlan.intentrequiredCarePlanIntent
CarePlan.categoryexampleCarePlanCategory
CarePlan.category:nursingInterventionexamplePattern: SNOMED CT code 9632001

Constraints

IdGradePath(s)DetailsRequirements
cpl-3errorCarePlan.activityProvide a reference or detail, not both
: detail.empty() or reference.empty()
dom-2errorCarePlanIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCarePlanIf 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-4errorCarePlanIf 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-5errorCarePlanIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCarePlanA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
zib-NursingIntervention-1errorCarePlanThe start and/or end date of a repeating schedule should be communicated in CarePlan.encounter as well.
: activity.detail.scheduled.ofType(Timing).repeat.bounds.ofType(Period).exists() implies (period = activity.detail.scheduled.ofType(Timing).repeat.bounds.ofType(Period))
NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan C0..*ZibNursingInterventionNursingIntervention
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this plan
... instantiatesCanonical Σ0..*canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(CarePlan)Fulfills CarePlan
... replaces Σ0..*Reference(CarePlan)CarePlan replaced by this CarePlan
... partOf Σ0..*Reference(CarePlan)Part of referenced CarePlan
... status ?!Σ1..1codedraft | 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..1codeproposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.

... Slices for category Σ1..*CodeableConceptType of plan
Slice: Unordered, Open by value:coding
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.


.... category:nursingIntervention Σ1..1CodeableConceptType 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.



Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 9632001
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
... title Σ0..1stringHuman-friendly name for the care plan
... description Σ0..1stringSummary of nature of plan
... subject Σ1..1Reference(Patient | Group | nl core Patient)Who the care plan is for
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... period Σ0..1PeriodTime period plan covers
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣC0..1dateTimeProcedureStartDateTime
.... end ΣC0..1dateTimeProcedureEndDateTime
... created Σ0..1dateTimeDate record was first recorded
... author Σ0..1Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)Who is the designated responsible party
... Slices for contributor 0..*Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)Who provided the content of the care plan
Slice: Unordered, Open by exists:extension(url='http://nictiz.nl/fhir/StructureDefinition/ext-NursingIntervention-ContributorIsRequester')
.... contributor:requester 0..*PatternNlCoreHealthProfessionalReference(nl core HealthProfessional PractitionerRole)A reference from one resource to another
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... contributorIsRequester 1..1booleanOptional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-NursingIntervention-ContributorIsRequester
..... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ0..1stringText alternative for the resource
... careTeam 0..*Reference(CareTeam)Who's involved in plan?
... addresses Σ0..1Reference(Condition | nl core Problem)Indication
... supportingInfo 0..*Reference(Resource)Information considered as part of plan
... goal 0..1Reference(Goal | http://nictiz.nl/fhir/StructureDefinition/nl-core-TreatmentObjective)TreatmentObjective
... activity C0..1BackboneElementAction to occur as part of plan
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... outcomeCodeableConcept 0..*CodeableConceptResults of the activity
Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.


.... outcomeReference 0..*Reference(Resource)Appointment, Encounter, Procedure, etc.
.... progress 0..*AnnotationComments about the activity status/progress
.... reference C0..1Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup)Activity details defined in specific resource
.... detail C0..1BackboneElementIn-line definition of activity
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medicalDevice 0..*Reference(DeviceUseStatement)Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CarePlan-MaterialUsed
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/ext-CarePlan-MaterialUsed"
...... value[x] 0..1Reference(DeviceUseStatement | nl core MedicalDevice)MedicalDevice
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind 0..1codeAppointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.

..... instantiatesCanonical 0..*canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition)Instantiates FHIR protocol or definition
..... instantiatesUri 0..*uriInstantiates external protocol or definition
..... code 0..1CodeableConceptIntervention
Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.18--20200901000000 (required)
..... reasonCode 0..*CodeableConceptWhy activity should be done or why activity was prohibited
Binding: SNOMEDCTClinicalFindings (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc.


..... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why activity is needed
..... goal 0..*Reference(Goal)Goals this activity relates to
..... status ?!1..1codenot-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.

..... statusReason 0..1CodeableConceptReason for current status
..... doNotPerform ?!0..1booleanIf true, activity is prohibiting action
..... Slices for scheduled[x] 0..1When activity is to occur
Slice: Unordered, Open by type:$this
...... scheduledTimingTiming
...... scheduledPeriodPeriod
...... scheduledStringstring
...... scheduled[x]:scheduledTiming 0..1TimingWhen activity is to occur
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... event Σ0..*dateTimeWhen the event occurs
....... repeat ΣC0..1ElementWhen the event is to occur
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ Slices for bounds[x] Σ0..1Length/Range of lengths, or (Start and/or end) limits
Slice: Unordered, Open by type:$this
......... boundsDurationDuration
......... boundsRangeRange
......... boundsPeriodPeriod
......... bounds[x]:boundsPeriod Σ0..1PeriodLength/Range of lengths, or (Start and/or end) limits
.......... id 0..1stringUnique id for inter-element referencing
.......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.......... start ΣC0..1dateTimeProcedureStartDateTime
.......... end ΣC0..1dateTimeProcedureEndDateTime
........ count Σ0..1positiveIntNumber of times to repeat
........ countMax Σ0..1positiveIntMaximum number of times to repeat
........ duration Σ0..1decimalHow long when it happens
........ durationMax Σ0..1decimalHow long when it happens (Max)
........ durationUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).

........ frequency Σ0..1positiveIntInterval / Frequency
........ frequencyMax Σ0..1positiveIntEvent occurs up to frequencyMax times per period
........ period Σ0..1decimalInterval / Frequency
........ periodMax Σ0..1decimalUpper limit of period (3-4 hours)
........ periodUnit Σ0..1codeInterval / Frequency
Binding: UnitsOfTime (required): A unit of time (units from UCUM).

........ dayOfWeek Σ0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
........ timeOfDay Σ0..*timeTime of day for action
........ when Σ0..*codeCode for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.


........ offset Σ0..1unsignedIntMinutes from event (before or after)
....... code Σ0..1CodeableConceptBID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.

..... location 0..1Reference(Location)Where it should happen
..... Slices for performer 0..1Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device)Who will be responsible?
Slice: Unordered, Open by profile:resolve()
...... performer:healthcareProvider 0..1PatternNlCoreHealthProfessionalReference(nl core HealthProfessional PractitionerRole)A reference from one resource to another
...... performer:caregiver 0..1Reference(nl core ContactPerson)Caregiver
...... performer:patient 0..1Reference(nl core Patient)Patient
..... product[x] 0..1What is to be administered/supplied
Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity.

...... productCodeableConceptCodeableConcept
...... productReferenceReference(Medication | Substance)
..... dailyAmount 0..1SimpleQuantityHow to consume/day?
..... quantity 0..1SimpleQuantityHow much to administer/supply/consume
..... description 0..1stringInstruction
... note 0..1AnnotationComments about the plan
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text Σ1..1markdownComment

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
CarePlan.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
CarePlan.statusrequiredRequestStatus
CarePlan.intentrequiredCarePlanIntent
CarePlan.categoryexampleCarePlanCategory
CarePlan.category:nursingInterventionexamplePattern: SNOMED CT code 9632001
CarePlan.contributor:requester.typeextensibleResourceType
CarePlan.activity.outcomeCodeableConceptexampleCarePlanActivityOutcome
CarePlan.activity.detail.kindrequiredCarePlanActivityKind
CarePlan.activity.detail.coderequiredhttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.18--20200901000000
CarePlan.activity.detail.reasonCodeexampleSNOMEDCTClinicalFindings
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus
CarePlan.activity.detail.scheduled[x]:scheduledTiming.repeat.durationUnitrequiredUnitsOfTime
CarePlan.activity.detail.scheduled[x]:scheduledTiming.repeat.periodUnitrequiredUnitsOfTime
CarePlan.activity.detail.scheduled[x]:scheduledTiming.repeat.dayOfWeekrequiredDaysOfWeek
CarePlan.activity.detail.scheduled[x]:scheduledTiming.repeat.whenrequiredEventTiming
CarePlan.activity.detail.scheduled[x]:scheduledTiming.codepreferredTimingAbbreviation
CarePlan.activity.detail.product[x]exampleSNOMEDCTMedicationCodes

Constraints

IdGradePath(s)DetailsRequirements
cpl-3errorCarePlan.activityProvide a reference or detail, not both
: detail.empty() or reference.empty()
dom-2errorCarePlanIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCarePlanIf 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-4errorCarePlanIf 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-5errorCarePlanIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCarePlanA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
tim-1errorCarePlan.activity.detail.scheduled[x]:scheduledTiming.repeatif there's a duration, there needs to be duration units
: duration.empty() or durationUnit.exists()
tim-2errorCarePlan.activity.detail.scheduled[x]:scheduledTiming.repeatif there's a period, there needs to be period units
: period.empty() or periodUnit.exists()
tim-4errorCarePlan.activity.detail.scheduled[x]:scheduledTiming.repeatduration SHALL be a non-negative value
: duration.exists() implies duration >= 0
tim-5errorCarePlan.activity.detail.scheduled[x]:scheduledTiming.repeatperiod SHALL be a non-negative value
: period.exists() implies period >= 0
tim-6errorCarePlan.activity.detail.scheduled[x]:scheduledTiming.repeatIf there's a periodMax, there must be a period
: periodMax.empty() or period.exists()
tim-7errorCarePlan.activity.detail.scheduled[x]:scheduledTiming.repeatIf there's a durationMax, there must be a duration
: durationMax.empty() or duration.exists()
tim-8errorCarePlan.activity.detail.scheduled[x]:scheduledTiming.repeatIf there's a countMax, there must be a count
: countMax.empty() or count.exists()
tim-9errorCarePlan.activity.detail.scheduled[x]:scheduledTiming.repeatIf 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-10errorCarePlan.activity.detail.scheduled[x]:scheduledTiming.repeatIf there's a timeOfDay, there cannot be a when, or vice versa
: timeOfDay.empty() or when.empty()
zib-NursingIntervention-1errorCarePlanThe start and/or end date of a repeating schedule should be communicated in CarePlan.encounter as well.
: activity.detail.scheduled.ofType(Timing).repeat.bounds.ofType(Period).exists() implies (period = activity.detail.scheduled.ofType(Timing).repeat.bounds.ofType(Period))

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan C0..*ZibNursingInterventionNursingIntervention
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codedraft | 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.

... Slices for category Σ1..*CodeableConceptType of plan
Slice: Unordered, Open by value:coding
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.


.... category:nursingIntervention Σ1..1CodeableConceptType 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.



Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 9632001
... subject Σ1..1Reference(Patient | Group | nl core Patient)Who the care plan is for
... Slices for contributor 0..*Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)Who provided the content of the care plan
Slice: Unordered, Open by exists:extension(url='http://nictiz.nl/fhir/StructureDefinition/ext-NursingIntervention-ContributorIsRequester')
.... contributor:requester 0..*PatternNlCoreHealthProfessionalReference(nl core HealthProfessional PractitionerRole)A reference from one resource to another
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... contributorIsRequester 1..1booleanOptional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-NursingIntervention-ContributorIsRequester
... addresses Σ0..1Reference(Condition | nl core Problem)Indication
... goal 0..1Reference(Goal | http://nictiz.nl/fhir/StructureDefinition/nl-core-TreatmentObjective)TreatmentObjective
... activity C0..1BackboneElementAction to occur as part of plan
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
... note 0..1AnnotationComments about the plan
.... text Σ1..1markdownComment

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
CarePlan.statusrequiredRequestStatus
CarePlan.intentrequiredCarePlanIntent
CarePlan.categoryexampleCarePlanCategory
CarePlan.category:nursingInterventionexamplePattern: SNOMED CT code 9632001

Constraints

IdGradePath(s)DetailsRequirements
cpl-3errorCarePlan.activityProvide a reference or detail, not both
: detail.empty() or reference.empty()
dom-2errorCarePlanIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCarePlanIf 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-4errorCarePlanIf 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-5errorCarePlanIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCarePlanA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
zib-NursingIntervention-1errorCarePlanThe start and/or end date of a repeating schedule should be communicated in CarePlan.encounter as well.
: activity.detail.scheduled.ofType(Timing).repeat.bounds.ofType(Period).exists() implies (period = activity.detail.scheduled.ofType(Timing).repeat.bounds.ofType(Period))

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan C0..*ZibNursingInterventionNursingIntervention
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this plan
... instantiatesCanonical Σ0..*canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(CarePlan)Fulfills CarePlan
... replaces Σ0..*Reference(CarePlan)CarePlan replaced by this CarePlan
... partOf Σ0..*Reference(CarePlan)Part of referenced CarePlan
... status ?!Σ1..1codedraft | 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..1codeproposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.

... Slices for category Σ1..*CodeableConceptType of plan
Slice: Unordered, Open by value:coding
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.


.... category:nursingIntervention Σ1..1CodeableConceptType 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.



Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 9632001
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
... title Σ0..1stringHuman-friendly name for the care plan
... description Σ0..1stringSummary of nature of plan
... subject Σ1..1Reference(Patient | Group | nl core Patient)Who the care plan is for
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... period Σ0..1PeriodTime period plan covers
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣC0..1dateTimeProcedureStartDateTime
.... end ΣC0..1dateTimeProcedureEndDateTime
... created Σ0..1dateTimeDate record was first recorded
... author Σ0..1Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)Who is the designated responsible party
... Slices for contributor 0..*Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)Who provided the content of the care plan
Slice: Unordered, Open by exists:extension(url='http://nictiz.nl/fhir/StructureDefinition/ext-NursingIntervention-ContributorIsRequester')
.... contributor:requester 0..*PatternNlCoreHealthProfessionalReference(nl core HealthProfessional PractitionerRole)A reference from one resource to another
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... contributorIsRequester 1..1booleanOptional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-NursingIntervention-ContributorIsRequester
..... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ0..1stringText alternative for the resource
... careTeam 0..*Reference(CareTeam)Who's involved in plan?
... addresses Σ0..1Reference(Condition | nl core Problem)Indication
... supportingInfo 0..*Reference(Resource)Information considered as part of plan
... goal 0..1Reference(Goal | http://nictiz.nl/fhir/StructureDefinition/nl-core-TreatmentObjective)TreatmentObjective
... activity C0..1BackboneElementAction to occur as part of plan
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... outcomeCodeableConcept 0..*CodeableConceptResults of the activity
Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.


.... outcomeReference 0..*Reference(Resource)Appointment, Encounter, Procedure, etc.
.... progress 0..*AnnotationComments about the activity status/progress
.... reference C0..1Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup)Activity details defined in specific resource
.... detail C0..1BackboneElementIn-line definition of activity
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medicalDevice 0..*Reference(DeviceUseStatement)Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CarePlan-MaterialUsed
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/ext-CarePlan-MaterialUsed"
...... value[x] 0..1Reference(DeviceUseStatement | nl core MedicalDevice)MedicalDevice
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind 0..1codeAppointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.

..... instantiatesCanonical 0..*canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition)Instantiates FHIR protocol or definition
..... instantiatesUri 0..*uriInstantiates external protocol or definition
..... code 0..1CodeableConceptIntervention
Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.18--20200901000000 (required)
..... reasonCode 0..*CodeableConceptWhy activity should be done or why activity was prohibited
Binding: SNOMEDCTClinicalFindings (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc.


..... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why activity is needed
..... goal 0..*Reference(Goal)Goals this activity relates to
..... status ?!1..1codenot-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.

..... statusReason 0..1CodeableConceptReason for current status
..... doNotPerform ?!0..1booleanIf true, activity is prohibiting action
..... Slices for scheduled[x] 0..1When activity is to occur
Slice: Unordered, Open by type:$this
...... scheduledTimingTiming
...... scheduledPeriodPeriod
...... scheduledStringstring
...... scheduled[x]:scheduledTiming 0..1TimingWhen activity is to occur
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... event Σ0..*dateTimeWhen the event occurs
....... repeat ΣC0..1ElementWhen the event is to occur
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ Slices for bounds[x] Σ0..1Length/Range of lengths, or (Start and/or end) limits
Slice: Unordered, Open by type:$this
......... boundsDurationDuration
......... boundsRangeRange
......... boundsPeriodPeriod
......... bounds[x]:boundsPeriod Σ0..1PeriodLength/Range of lengths, or (Start and/or end) limits
.......... id 0..1stringUnique id for inter-element referencing
.......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.......... start ΣC0..1dateTimeProcedureStartDateTime
.......... end ΣC0..1dateTimeProcedureEndDateTime
........ count Σ0..1positiveIntNumber of times to repeat
........ countMax Σ0..1positiveIntMaximum number of times to repeat
........ duration Σ0..1decimalHow long when it happens
........ durationMax Σ0..1decimalHow long when it happens (Max)
........ durationUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).

........ frequency Σ0..1positiveIntInterval / Frequency
........ frequencyMax Σ0..1positiveIntEvent occurs up to frequencyMax times per period
........ period Σ0..1decimalInterval / Frequency
........ periodMax Σ0..1decimalUpper limit of period (3-4 hours)
........ periodUnit Σ0..1codeInterval / Frequency
Binding: UnitsOfTime (required): A unit of time (units from UCUM).

........ dayOfWeek Σ0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
........ timeOfDay Σ0..*timeTime of day for action
........ when Σ0..*codeCode for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.


........ offset Σ0..1unsignedIntMinutes from event (before or after)
....... code Σ0..1CodeableConceptBID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.

..... location 0..1Reference(Location)Where it should happen
..... Slices for performer 0..1Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device)Who will be responsible?
Slice: Unordered, Open by profile:resolve()
...... performer:healthcareProvider 0..1PatternNlCoreHealthProfessionalReference(nl core HealthProfessional PractitionerRole)A reference from one resource to another
...... performer:caregiver 0..1Reference(nl core ContactPerson)Caregiver
...... performer:patient 0..1Reference(nl core Patient)Patient
..... product[x] 0..1What is to be administered/supplied
Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity.

...... productCodeableConceptCodeableConcept
...... productReferenceReference(Medication | Substance)
..... dailyAmount 0..1SimpleQuantityHow to consume/day?
..... quantity 0..1SimpleQuantityHow much to administer/supply/consume
..... description 0..1stringInstruction
... note 0..1AnnotationComments about the plan
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text Σ1..1markdownComment

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
CarePlan.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
CarePlan.statusrequiredRequestStatus
CarePlan.intentrequiredCarePlanIntent
CarePlan.categoryexampleCarePlanCategory
CarePlan.category:nursingInterventionexamplePattern: SNOMED CT code 9632001
CarePlan.contributor:requester.typeextensibleResourceType
CarePlan.activity.outcomeCodeableConceptexampleCarePlanActivityOutcome
CarePlan.activity.detail.kindrequiredCarePlanActivityKind
CarePlan.activity.detail.coderequiredhttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.18--20200901000000
CarePlan.activity.detail.reasonCodeexampleSNOMEDCTClinicalFindings
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus
CarePlan.activity.detail.scheduled[x]:scheduledTiming.repeat.durationUnitrequiredUnitsOfTime
CarePlan.activity.detail.scheduled[x]:scheduledTiming.repeat.periodUnitrequiredUnitsOfTime
CarePlan.activity.detail.scheduled[x]:scheduledTiming.repeat.dayOfWeekrequiredDaysOfWeek
CarePlan.activity.detail.scheduled[x]:scheduledTiming.repeat.whenrequiredEventTiming
CarePlan.activity.detail.scheduled[x]:scheduledTiming.codepreferredTimingAbbreviation
CarePlan.activity.detail.product[x]exampleSNOMEDCTMedicationCodes

Constraints

IdGradePath(s)DetailsRequirements
cpl-3errorCarePlan.activityProvide a reference or detail, not both
: detail.empty() or reference.empty()
dom-2errorCarePlanIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCarePlanIf 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-4errorCarePlanIf 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-5errorCarePlanIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCarePlanA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
tim-1errorCarePlan.activity.detail.scheduled[x]:scheduledTiming.repeatif there's a duration, there needs to be duration units
: duration.empty() or durationUnit.exists()
tim-2errorCarePlan.activity.detail.scheduled[x]:scheduledTiming.repeatif there's a period, there needs to be period units
: period.empty() or periodUnit.exists()
tim-4errorCarePlan.activity.detail.scheduled[x]:scheduledTiming.repeatduration SHALL be a non-negative value
: duration.exists() implies duration >= 0
tim-5errorCarePlan.activity.detail.scheduled[x]:scheduledTiming.repeatperiod SHALL be a non-negative value
: period.exists() implies period >= 0
tim-6errorCarePlan.activity.detail.scheduled[x]:scheduledTiming.repeatIf there's a periodMax, there must be a period
: periodMax.empty() or period.exists()
tim-7errorCarePlan.activity.detail.scheduled[x]:scheduledTiming.repeatIf there's a durationMax, there must be a duration
: durationMax.empty() or duration.exists()
tim-8errorCarePlan.activity.detail.scheduled[x]:scheduledTiming.repeatIf there's a countMax, there must be a count
: countMax.empty() or count.exists()
tim-9errorCarePlan.activity.detail.scheduled[x]:scheduledTiming.repeatIf 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-10errorCarePlan.activity.detail.scheduled[x]:scheduledTiming.repeatIf there's a timeOfDay, there cannot be a when, or vice versa
: timeOfDay.empty() or when.empty()
zib-NursingIntervention-1errorCarePlanThe start and/or end date of a repeating schedule should be communicated in CarePlan.encounter as well.
: activity.detail.scheduled.ofType(Timing).repeat.bounds.ofType(Period).exists() implies (period = activity.detail.scheduled.ofType(Timing).repeat.bounds.ofType(Period))

 

Other representations of profile: CSV, Excel, Schematron