Kenya National Cancer Control Programme (NCCP) FHIR Implementation Guide
0.1.0 - ci-build Kenya flag

Kenya National Cancer Control Programme (NCCP) FHIR Implementation Guide, published by Digital Health Agency (DHA), Kenya. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IntelliSOFT-Consulting/nccpFHIRIG/ and changes regularly. See the Directory of published versions

Resource Profile: NCCP Radiotherapy Care Plan

Official URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-radiotherapy-care-plan Version: 0.1.0
Draft as of 2026-06-04 Computable Name: RadiotherapyCarePlan

Radiotherapy-specific care plan capturing fractions, dose per fraction, technique and target volume.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... meta Σ 0..1 Meta Metadata about the resource
.... profile SΣ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 5..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:rtIntent S 1..1 code Radiotherapy Intent Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-intent-extension
Binding: Kenya Radiotherapy Intent Value Set (required)
.... extension:rtTotalFractions S 1..1 integer Radiotherapy Total Fractions Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-total-fractions-extension
.... extension:rtDosePerFraction S 1..1 Quantity Radiotherapy Dose Per Fraction Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-dose-per-fraction-extension
.... extension:rtTreatmentTechnique S 1..1 code Radiotherapy Treatment Technique Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-treatment-technique-extension
Binding: Kenya Radiotherapy Treatment Technique Value Set (required)
.... extension:rtTargetVolume S 1..* code Radiotherapy Target Volume Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-target-volume-extension
Binding: Kenya Radiotherapy Target Volume Value Set (required)
... identifier SΣ 1..* Identifier External Ids for this plan
... instantiatesCanonical SΣ 0..1 canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) Instantiates FHIR protocol or definition
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... intent ?!SΣ 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required)
... category SΣ 1..* CodeableConcept Type of plan
Binding: Kenya Care Plan Category Value Set (required)
... subject SΣ 1..1 Reference(Patient) Who the care plan is for
... period SΣ 1..1 Period Time period plan covers
... author SΣ 1..1 Reference(Practitioner) Who is the designated responsible party
... careTeam S 1..* Reference(CareTeam) Who's involved in plan?
... addresses SΣ 1..* Reference(Condition) Health issues this plan addresses
... activity C 0..* BackboneElement Action to occur as part of plan
Constraints: cpl-3
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... detail C 0..1 BackboneElement In-line definition of activity
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code S 0..1 CodeableConcept Detail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
..... status ?! 1..1 code not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.
..... doNotPerform ?! 0..1 boolean If true, activity is prohibiting action

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CarePlan.status Base required RequestStatus 📦4.0.1 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📦4.0.1 FHIR Std.
CarePlan.category Base required Kenya Care Plan Category Value Set 📦0.1.0 This IG
CarePlan.activity.detail.​code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​status Base required CarePlanActivityStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpl-3 error CarePlan.activity Provide a reference or detail, not both detail.empty() or reference.empty()
dom-2 error CarePlan If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CarePlan If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error CarePlan If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error CarePlan If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CarePlan A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... meta
.... profile S 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
... Slices for extension 5..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:rtIntent S 1..1 code Radiotherapy Intent Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-intent-extension
Binding: Kenya Radiotherapy Intent Value Set (required)
.... extension:rtTotalFractions S 1..1 integer Radiotherapy Total Fractions Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-total-fractions-extension
.... extension:rtDosePerFraction S 1..1 Quantity Radiotherapy Dose Per Fraction Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-dose-per-fraction-extension
.... extension:rtTreatmentTechnique S 1..1 code Radiotherapy Treatment Technique Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-treatment-technique-extension
Binding: Kenya Radiotherapy Treatment Technique Value Set (required)
.... extension:rtTargetVolume S 1..* code Radiotherapy Target Volume Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-target-volume-extension
Binding: Kenya Radiotherapy Target Volume Value Set (required)
... identifier S 1..* Identifier External Ids for this plan
... status S 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... intent S 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required)
... category S 1..* CodeableConcept Type of plan
Binding: Kenya Care Plan Category Value Set (required)
... subject S 1..1 Reference(Patient) Who the care plan is for
... period S 1..1 Period Time period plan covers
... author S 1..1 Reference(Practitioner) Who is the designated responsible party
... careTeam S 1..* Reference(CareTeam) Who's involved in plan?
... addresses S 1..* Reference(Condition) Health issues this plan addresses
... activity
.... detail
..... code S 0..1 CodeableConcept Detail type of activity

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
CarePlan.status Base required RequestStatus 📦4.0.1 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📦4.0.1 FHIR Std.
CarePlan.category Base required Kenya Care Plan Category Value Set 📦0.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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
... Slices for extension 5..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:rtIntent S 1..1 code Radiotherapy Intent Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-intent-extension
Binding: Kenya Radiotherapy Intent Value Set (required)
.... extension:rtTotalFractions S 1..1 integer Radiotherapy Total Fractions Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-total-fractions-extension
.... extension:rtDosePerFraction S 1..1 Quantity Radiotherapy Dose Per Fraction Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-dose-per-fraction-extension
.... extension:rtTreatmentTechnique S 1..1 code Radiotherapy Treatment Technique Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-treatment-technique-extension
Binding: Kenya Radiotherapy Treatment Technique Value Set (required)
.... extension:rtTargetVolume S 1..* code Radiotherapy Target Volume Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-target-volume-extension
Binding: Kenya Radiotherapy Target Volume Value Set (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier External Ids for this plan
... instantiatesCanonical SΣ 0..1 canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates 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 ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... intent ?!SΣ 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required)
... category SΣ 1..* CodeableConcept Type of plan
Binding: Kenya Care Plan Category Value Set (required)
... title Σ 0..1 string Human-friendly name for the care plan
... description Σ 0..1 string Summary of nature of plan
... subject SΣ 1..1 Reference(Patient) Who the care plan is for
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... period SΣ 1..1 Period Time period plan covers
... created Σ 0..1 dateTime Date record was first recorded
... author SΣ 1..1 Reference(Practitioner) Who is the designated responsible party
... contributor 0..* Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who provided the content of the care plan
... careTeam S 1..* Reference(CareTeam) Who's involved in plan?
... addresses SΣ 1..* Reference(Condition) Health issues this plan addresses
... supportingInfo 0..* Reference(Resource) Information considered as part of plan
... goal 0..* Reference(Goal) Desired outcome of plan
... activity C 0..* BackboneElement Action to occur as part of plan
Constraints: cpl-3
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... outcomeCodeableConcept 0..* CodeableConcept Results of the activity
Binding: CarePlanActivityOutcome (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 | ServiceRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource
.... detail C 0..1 BackboneElement In-line definition of activity
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... kind 0..1 code Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.
..... instantiatesCanonical 0..* canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) Instantiates FHIR protocol or definition
..... instantiatesUri 0..* uri Instantiates external protocol or definition
..... code S 0..1 CodeableConcept Detail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
..... reasonCode 0..* CodeableConcept Why activity should be done or why activity was prohibited
Binding: SNOMEDCTClinicalFindings (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc.
..... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why activity is needed
..... goal 0..* Reference(Goal) Goals this activity relates to
..... status ?! 1..1 code not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.
..... statusReason 0..1 CodeableConcept Reason for current status
..... doNotPerform ?! 0..1 boolean If true, activity is prohibiting action
..... scheduled[x] 0..1 When activity is to occur
...... scheduledTiming Timing
...... scheduledPeriod Period
...... scheduledString string
..... location 0..1 Reference(Location) Where it should happen
..... performer 0..* Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) Who will be responsible?
..... product[x] 0..1 What is to be administered/supplied
Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity.
...... productCodeableConcept CodeableConcept
...... productReference Reference(Medication | Substance)
..... dailyAmount 0..1 SimpleQuantity(4.0.1) How to consume/day?
..... quantity 0..1 SimpleQuantity(4.0.1) How much to administer/supply/consume
..... description 0..1 string Extra info describing activity to perform
... note 0..* Annotation Comments about the plan

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CarePlan.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
CarePlan.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
CarePlan.language Base preferred Common Languages 📍4.0.1 FHIR Std.
CarePlan.status Base required RequestStatus 📦4.0.1 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📦4.0.1 FHIR Std.
CarePlan.category Base required Kenya Care Plan Category Value Set 📦0.1.0 This IG
CarePlan.activity.outcomeCodeableConcept Base example Care Plan Activity Outcome 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​kind Base required Care Plan Activity Kind 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​reasonCode Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​status Base required CarePlanActivityStatus 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​product[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpl-3 error CarePlan.activity Provide a reference or detail, not both detail.empty() or reference.empty()
dom-2 error CarePlan If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CarePlan If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error CarePlan If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error CarePlan If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CarePlan A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... meta Σ 0..1 Meta Metadata about the resource
.... profile SΣ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 5..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:rtIntent S 1..1 code Radiotherapy Intent Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-intent-extension
Binding: Kenya Radiotherapy Intent Value Set (required)
.... extension:rtTotalFractions S 1..1 integer Radiotherapy Total Fractions Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-total-fractions-extension
.... extension:rtDosePerFraction S 1..1 Quantity Radiotherapy Dose Per Fraction Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-dose-per-fraction-extension
.... extension:rtTreatmentTechnique S 1..1 code Radiotherapy Treatment Technique Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-treatment-technique-extension
Binding: Kenya Radiotherapy Treatment Technique Value Set (required)
.... extension:rtTargetVolume S 1..* code Radiotherapy Target Volume Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-target-volume-extension
Binding: Kenya Radiotherapy Target Volume Value Set (required)
... identifier SΣ 1..* Identifier External Ids for this plan
... instantiatesCanonical SΣ 0..1 canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) Instantiates FHIR protocol or definition
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... intent ?!SΣ 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required)
... category SΣ 1..* CodeableConcept Type of plan
Binding: Kenya Care Plan Category Value Set (required)
... subject SΣ 1..1 Reference(Patient) Who the care plan is for
... period SΣ 1..1 Period Time period plan covers
... author SΣ 1..1 Reference(Practitioner) Who is the designated responsible party
... careTeam S 1..* Reference(CareTeam) Who's involved in plan?
... addresses SΣ 1..* Reference(Condition) Health issues this plan addresses
... activity C 0..* BackboneElement Action to occur as part of plan
Constraints: cpl-3
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... detail C 0..1 BackboneElement In-line definition of activity
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code S 0..1 CodeableConcept Detail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
..... status ?! 1..1 code not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.
..... doNotPerform ?! 0..1 boolean If true, activity is prohibiting action

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CarePlan.status Base required RequestStatus 📦4.0.1 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📦4.0.1 FHIR Std.
CarePlan.category Base required Kenya Care Plan Category Value Set 📦0.1.0 This IG
CarePlan.activity.detail.​code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​status Base required CarePlanActivityStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpl-3 error CarePlan.activity Provide a reference or detail, not both detail.empty() or reference.empty()
dom-2 error CarePlan If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CarePlan If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error CarePlan If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error CarePlan If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CarePlan A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... meta
.... profile S 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
... Slices for extension 5..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:rtIntent S 1..1 code Radiotherapy Intent Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-intent-extension
Binding: Kenya Radiotherapy Intent Value Set (required)
.... extension:rtTotalFractions S 1..1 integer Radiotherapy Total Fractions Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-total-fractions-extension
.... extension:rtDosePerFraction S 1..1 Quantity Radiotherapy Dose Per Fraction Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-dose-per-fraction-extension
.... extension:rtTreatmentTechnique S 1..1 code Radiotherapy Treatment Technique Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-treatment-technique-extension
Binding: Kenya Radiotherapy Treatment Technique Value Set (required)
.... extension:rtTargetVolume S 1..* code Radiotherapy Target Volume Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-target-volume-extension
Binding: Kenya Radiotherapy Target Volume Value Set (required)
... identifier S 1..* Identifier External Ids for this plan
... status S 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... intent S 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required)
... category S 1..* CodeableConcept Type of plan
Binding: Kenya Care Plan Category Value Set (required)
... subject S 1..1 Reference(Patient) Who the care plan is for
... period S 1..1 Period Time period plan covers
... author S 1..1 Reference(Practitioner) Who is the designated responsible party
... careTeam S 1..* Reference(CareTeam) Who's involved in plan?
... addresses S 1..* Reference(Condition) Health issues this plan addresses
... activity
.... detail
..... code S 0..1 CodeableConcept Detail type of activity

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
CarePlan.status Base required RequestStatus 📦4.0.1 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📦4.0.1 FHIR Std.
CarePlan.category Base required Kenya Care Plan Category Value Set 📦0.1.0 This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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
... Slices for extension 5..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:rtIntent S 1..1 code Radiotherapy Intent Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-intent-extension
Binding: Kenya Radiotherapy Intent Value Set (required)
.... extension:rtTotalFractions S 1..1 integer Radiotherapy Total Fractions Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-total-fractions-extension
.... extension:rtDosePerFraction S 1..1 Quantity Radiotherapy Dose Per Fraction Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-dose-per-fraction-extension
.... extension:rtTreatmentTechnique S 1..1 code Radiotherapy Treatment Technique Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-treatment-technique-extension
Binding: Kenya Radiotherapy Treatment Technique Value Set (required)
.... extension:rtTargetVolume S 1..* code Radiotherapy Target Volume Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-rt-target-volume-extension
Binding: Kenya Radiotherapy Target Volume Value Set (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier External Ids for this plan
... instantiatesCanonical SΣ 0..1 canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates 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 ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... intent ?!SΣ 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required)
... category SΣ 1..* CodeableConcept Type of plan
Binding: Kenya Care Plan Category Value Set (required)
... title Σ 0..1 string Human-friendly name for the care plan
... description Σ 0..1 string Summary of nature of plan
... subject SΣ 1..1 Reference(Patient) Who the care plan is for
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... period SΣ 1..1 Period Time period plan covers
... created Σ 0..1 dateTime Date record was first recorded
... author SΣ 1..1 Reference(Practitioner) Who is the designated responsible party
... contributor 0..* Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who provided the content of the care plan
... careTeam S 1..* Reference(CareTeam) Who's involved in plan?
... addresses SΣ 1..* Reference(Condition) Health issues this plan addresses
... supportingInfo 0..* Reference(Resource) Information considered as part of plan
... goal 0..* Reference(Goal) Desired outcome of plan
... activity C 0..* BackboneElement Action to occur as part of plan
Constraints: cpl-3
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... outcomeCodeableConcept 0..* CodeableConcept Results of the activity
Binding: CarePlanActivityOutcome (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 | ServiceRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource
.... detail C 0..1 BackboneElement In-line definition of activity
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... kind 0..1 code Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.
..... instantiatesCanonical 0..* canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) Instantiates FHIR protocol or definition
..... instantiatesUri 0..* uri Instantiates external protocol or definition
..... code S 0..1 CodeableConcept Detail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
..... reasonCode 0..* CodeableConcept Why activity should be done or why activity was prohibited
Binding: SNOMEDCTClinicalFindings (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc.
..... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why activity is needed
..... goal 0..* Reference(Goal) Goals this activity relates to
..... status ?! 1..1 code not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.
..... statusReason 0..1 CodeableConcept Reason for current status
..... doNotPerform ?! 0..1 boolean If true, activity is prohibiting action
..... scheduled[x] 0..1 When activity is to occur
...... scheduledTiming Timing
...... scheduledPeriod Period
...... scheduledString string
..... location 0..1 Reference(Location) Where it should happen
..... performer 0..* Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) Who will be responsible?
..... product[x] 0..1 What is to be administered/supplied
Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity.
...... productCodeableConcept CodeableConcept
...... productReference Reference(Medication | Substance)
..... dailyAmount 0..1 SimpleQuantity(4.0.1) How to consume/day?
..... quantity 0..1 SimpleQuantity(4.0.1) How much to administer/supply/consume
..... description 0..1 string Extra info describing activity to perform
... note 0..* Annotation Comments about the plan

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CarePlan.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
CarePlan.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
CarePlan.language Base preferred Common Languages 📍4.0.1 FHIR Std.
CarePlan.status Base required RequestStatus 📦4.0.1 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📦4.0.1 FHIR Std.
CarePlan.category Base required Kenya Care Plan Category Value Set 📦0.1.0 This IG
CarePlan.activity.outcomeCodeableConcept Base example Care Plan Activity Outcome 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​kind Base required Care Plan Activity Kind 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​reasonCode Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​status Base required CarePlanActivityStatus 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​product[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpl-3 error CarePlan.activity Provide a reference or detail, not both detail.empty() or reference.empty()
dom-2 error CarePlan If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CarePlan If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error CarePlan If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error CarePlan If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CarePlan A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron