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 Oncology Care Plan

Official URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-oncology-careplan Version: 0.1.0
Draft as of 2026-06-04 Computable Name: OncologyCareplan

Represents a structured oncology treatment care plan (chemotherapy, radiotherapy or multimodal) for a patient under the National Cancer Control Programme.

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:treatmentIntent S 1..1 code Treatment Intent Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-treatment-intent-extension
Binding: Kenya Treatment Intent Value Set (required)
.... extension:plannedCycles S 1..1 integer Planned Cycles Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-planned-cycles-extension
.... extension:cycleLengthDays S 1..1 integer Cycle Length Days Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-cycle-length-days-extension
.... extension:sessionsPerCycle S 1..1 integer Sessions Per Cycle Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-sessions-per-cycle-extension
.... extension:regimenCode S 1..1 Coding Regimen Code Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-regimen-code-extension
Binding: Kenya Treatment Course (Regimen) Value Set (required)
... identifier SΣ 1..* Identifier External Ids for this plan
... instantiatesCanonical SΣ 0..* canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) Instantiates FHIR protocol or definition
... basedOn SΣ 0..* Reference(CarePlan) Fulfills 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 SΣ 1..1 string Human-friendly name for the care plan
... description SΣ 0..1 string Summary of nature of plan
... subject SΣ 1..1 Reference(Patient) Who the care plan is for
... encounter SΣ 0..1 Reference(Encounter) Encounter created as part of
... period SΣ 1..1 Period Time period plan covers
... author SΣ 1..1 Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) 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
... supportingInfo S 0..* Reference(Resource) Information considered as part of plan
... goal S 0..* Reference(Goal) Desired outcome of plan
... activity SC 1..* BackboneElement Action to occur as part of plan
Constraints: cpl-3
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... reference SC 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... kind S 0..1 code Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required)
..... code S 0..1 CodeableConcept Detail type of activity
Binding: Kenya Procedure Code Value Set (required)
..... reasonCode S 0..* CodeableConcept Why activity should be done or why activity was prohibited
Binding: Kenya Manifestation Or Symptom Value Set (required)
..... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why activity is needed
..... status ?!S 1..1 code not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required)
..... doNotPerform ?! 0..1 boolean If true, activity is prohibiting action
..... Slices for scheduled[x] 0..1 When activity is to occur
Slice: Unordered, Open by type:$this
...... scheduledTiming Timing
...... scheduledPeriod Period
...... scheduledString string
...... scheduled[x]:scheduledTiming S 0..1 Timing When activity is to occur

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.​kind Base required Care Plan Activity Kind 📦4.0.1 FHIR Std.
CarePlan.activity.detail.​code Base required Kenya Procedure Code Value Set 📦0.1.0 This IG
CarePlan.activity.detail.​reasonCode Base required Kenya Manifestation Or Symptom Value Set 📦0.1.0 This IG
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:treatmentIntent S 1..1 code Treatment Intent Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-treatment-intent-extension
Binding: Kenya Treatment Intent Value Set (required)
.... extension:plannedCycles S 1..1 integer Planned Cycles Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-planned-cycles-extension
.... extension:cycleLengthDays S 1..1 integer Cycle Length Days Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-cycle-length-days-extension
.... extension:sessionsPerCycle S 1..1 integer Sessions Per Cycle Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-sessions-per-cycle-extension
.... extension:regimenCode S 1..1 Coding Regimen Code Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-regimen-code-extension
Binding: Kenya Treatment Course (Regimen) Value Set (required)
... identifier S 1..* Identifier External Ids for this plan
... basedOn S 0..* Reference(CarePlan) Fulfills 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 S 1..1 string Human-friendly name for the care plan
... description S 0..1 string Summary of nature of plan
... subject S 1..1 Reference(Patient) Who the care plan is for
... encounter S 0..1 Reference(Encounter) Encounter created as part of
... period S 1..1 Period Time period plan covers
... author S 1..1 Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) 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
... supportingInfo S 0..* Reference(Resource) Information considered as part of plan
... goal S 0..* Reference(Goal) Desired outcome of plan
... activity S 1..* BackboneElement Action to occur as part of plan
.... reference S 0..1 Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource
.... detail
..... kind S 0..1 code Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required)
..... code S 0..1 CodeableConcept Detail type of activity
Binding: Kenya Procedure Code Value Set (required)
..... reasonCode S 0..* CodeableConcept Why activity should be done or why activity was prohibited
Binding: Kenya Manifestation Or Symptom Value Set (required)
..... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why activity is needed
..... status S 1..1 code not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required)
..... Slices for scheduled[x] 0..1 Timing, Period, string When activity is to occur
Slice: Unordered, Open by type:$this
...... scheduled[x]:scheduledTiming S 0..1 Timing When activity is to occur

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
CarePlan.activity.detail.​kind Base required Care Plan Activity Kind 📦4.0.1 FHIR Std.
CarePlan.activity.detail.​code Base required Kenya Procedure Code Value Set 📦0.1.0 This IG
CarePlan.activity.detail.​reasonCode Base required Kenya Manifestation Or Symptom Value Set 📦0.1.0 This IG
CarePlan.activity.detail.​status Base required CarePlanActivityStatus 📦4.0.1 FHIR Std.
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:treatmentIntent S 1..1 code Treatment Intent Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-treatment-intent-extension
Binding: Kenya Treatment Intent Value Set (required)
.... extension:plannedCycles S 1..1 integer Planned Cycles Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-planned-cycles-extension
.... extension:cycleLengthDays S 1..1 integer Cycle Length Days Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-cycle-length-days-extension
.... extension:sessionsPerCycle S 1..1 integer Sessions Per Cycle Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-sessions-per-cycle-extension
.... extension:regimenCode S 1..1 Coding Regimen Code Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-regimen-code-extension
Binding: Kenya Treatment Course (Regimen) Value Set (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier External Ids for this plan
... instantiatesCanonical SΣ 0..* canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn SΣ 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 SΣ 1..1 string Human-friendly name for the care plan
... description SΣ 0..1 string Summary of nature of plan
... subject SΣ 1..1 Reference(Patient) Who the care plan is for
... encounter SΣ 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(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) 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 S 0..* Reference(Resource) Information considered as part of plan
... goal S 0..* Reference(Goal) Desired outcome of plan
... activity SC 1..* 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 SC 0..1 Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource
.... detail C 0..1 BackboneElement In-line definition of activity
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... kind S 0..1 code Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required)
..... 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: Kenya Procedure Code Value Set (required)
..... reasonCode S 0..* CodeableConcept Why activity should be done or why activity was prohibited
Binding: Kenya Manifestation Or Symptom Value Set (required)
..... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why activity is needed
..... goal 0..* Reference(Goal) Goals this activity relates to
..... status ?!S 1..1 code not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required)
..... statusReason 0..1 CodeableConcept Reason for current status
..... doNotPerform ?! 0..1 boolean If true, activity is prohibiting action
..... Slices for scheduled[x] 0..1 When activity is to occur
Slice: Unordered, Open by type:$this
...... scheduledTiming Timing
...... scheduledPeriod Period
...... scheduledString string
...... scheduled[x]:scheduledTiming S 0..1 Timing When activity is to occur
..... 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 required Kenya Procedure Code Value Set 📦0.1.0 This IG
CarePlan.activity.detail.​reasonCode Base required Kenya Manifestation Or Symptom Value Set 📦0.1.0 This IG
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:treatmentIntent S 1..1 code Treatment Intent Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-treatment-intent-extension
Binding: Kenya Treatment Intent Value Set (required)
.... extension:plannedCycles S 1..1 integer Planned Cycles Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-planned-cycles-extension
.... extension:cycleLengthDays S 1..1 integer Cycle Length Days Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-cycle-length-days-extension
.... extension:sessionsPerCycle S 1..1 integer Sessions Per Cycle Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-sessions-per-cycle-extension
.... extension:regimenCode S 1..1 Coding Regimen Code Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-regimen-code-extension
Binding: Kenya Treatment Course (Regimen) Value Set (required)
... identifier SΣ 1..* Identifier External Ids for this plan
... instantiatesCanonical SΣ 0..* canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) Instantiates FHIR protocol or definition
... basedOn SΣ 0..* Reference(CarePlan) Fulfills 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 SΣ 1..1 string Human-friendly name for the care plan
... description SΣ 0..1 string Summary of nature of plan
... subject SΣ 1..1 Reference(Patient) Who the care plan is for
... encounter SΣ 0..1 Reference(Encounter) Encounter created as part of
... period SΣ 1..1 Period Time period plan covers
... author SΣ 1..1 Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) 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
... supportingInfo S 0..* Reference(Resource) Information considered as part of plan
... goal S 0..* Reference(Goal) Desired outcome of plan
... activity SC 1..* BackboneElement Action to occur as part of plan
Constraints: cpl-3
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... reference SC 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... kind S 0..1 code Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required)
..... code S 0..1 CodeableConcept Detail type of activity
Binding: Kenya Procedure Code Value Set (required)
..... reasonCode S 0..* CodeableConcept Why activity should be done or why activity was prohibited
Binding: Kenya Manifestation Or Symptom Value Set (required)
..... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why activity is needed
..... status ?!S 1..1 code not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required)
..... doNotPerform ?! 0..1 boolean If true, activity is prohibiting action
..... Slices for scheduled[x] 0..1 When activity is to occur
Slice: Unordered, Open by type:$this
...... scheduledTiming Timing
...... scheduledPeriod Period
...... scheduledString string
...... scheduled[x]:scheduledTiming S 0..1 Timing When activity is to occur

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.​kind Base required Care Plan Activity Kind 📦4.0.1 FHIR Std.
CarePlan.activity.detail.​code Base required Kenya Procedure Code Value Set 📦0.1.0 This IG
CarePlan.activity.detail.​reasonCode Base required Kenya Manifestation Or Symptom Value Set 📦0.1.0 This IG
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:treatmentIntent S 1..1 code Treatment Intent Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-treatment-intent-extension
Binding: Kenya Treatment Intent Value Set (required)
.... extension:plannedCycles S 1..1 integer Planned Cycles Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-planned-cycles-extension
.... extension:cycleLengthDays S 1..1 integer Cycle Length Days Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-cycle-length-days-extension
.... extension:sessionsPerCycle S 1..1 integer Sessions Per Cycle Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-sessions-per-cycle-extension
.... extension:regimenCode S 1..1 Coding Regimen Code Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-regimen-code-extension
Binding: Kenya Treatment Course (Regimen) Value Set (required)
... identifier S 1..* Identifier External Ids for this plan
... basedOn S 0..* Reference(CarePlan) Fulfills 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 S 1..1 string Human-friendly name for the care plan
... description S 0..1 string Summary of nature of plan
... subject S 1..1 Reference(Patient) Who the care plan is for
... encounter S 0..1 Reference(Encounter) Encounter created as part of
... period S 1..1 Period Time period plan covers
... author S 1..1 Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) 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
... supportingInfo S 0..* Reference(Resource) Information considered as part of plan
... goal S 0..* Reference(Goal) Desired outcome of plan
... activity S 1..* BackboneElement Action to occur as part of plan
.... reference S 0..1 Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource
.... detail
..... kind S 0..1 code Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required)
..... code S 0..1 CodeableConcept Detail type of activity
Binding: Kenya Procedure Code Value Set (required)
..... reasonCode S 0..* CodeableConcept Why activity should be done or why activity was prohibited
Binding: Kenya Manifestation Or Symptom Value Set (required)
..... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why activity is needed
..... status S 1..1 code not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required)
..... Slices for scheduled[x] 0..1 Timing, Period, string When activity is to occur
Slice: Unordered, Open by type:$this
...... scheduled[x]:scheduledTiming S 0..1 Timing When activity is to occur

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
CarePlan.activity.detail.​kind Base required Care Plan Activity Kind 📦4.0.1 FHIR Std.
CarePlan.activity.detail.​code Base required Kenya Procedure Code Value Set 📦0.1.0 This IG
CarePlan.activity.detail.​reasonCode Base required Kenya Manifestation Or Symptom Value Set 📦0.1.0 This IG
CarePlan.activity.detail.​status Base required CarePlanActivityStatus 📦4.0.1 FHIR Std.

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:treatmentIntent S 1..1 code Treatment Intent Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-treatment-intent-extension
Binding: Kenya Treatment Intent Value Set (required)
.... extension:plannedCycles S 1..1 integer Planned Cycles Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-planned-cycles-extension
.... extension:cycleLengthDays S 1..1 integer Cycle Length Days Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-cycle-length-days-extension
.... extension:sessionsPerCycle S 1..1 integer Sessions Per Cycle Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-sessions-per-cycle-extension
.... extension:regimenCode S 1..1 Coding Regimen Code Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-regimen-code-extension
Binding: Kenya Treatment Course (Regimen) Value Set (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier External Ids for this plan
... instantiatesCanonical SΣ 0..* canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn SΣ 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 SΣ 1..1 string Human-friendly name for the care plan
... description SΣ 0..1 string Summary of nature of plan
... subject SΣ 1..1 Reference(Patient) Who the care plan is for
... encounter SΣ 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(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) 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 S 0..* Reference(Resource) Information considered as part of plan
... goal S 0..* Reference(Goal) Desired outcome of plan
... activity SC 1..* 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 SC 0..1 Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource
.... detail C 0..1 BackboneElement In-line definition of activity
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... kind S 0..1 code Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required)
..... 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: Kenya Procedure Code Value Set (required)
..... reasonCode S 0..* CodeableConcept Why activity should be done or why activity was prohibited
Binding: Kenya Manifestation Or Symptom Value Set (required)
..... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why activity is needed
..... goal 0..* Reference(Goal) Goals this activity relates to
..... status ?!S 1..1 code not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required)
..... statusReason 0..1 CodeableConcept Reason for current status
..... doNotPerform ?! 0..1 boolean If true, activity is prohibiting action
..... Slices for scheduled[x] 0..1 When activity is to occur
Slice: Unordered, Open by type:$this
...... scheduledTiming Timing
...... scheduledPeriod Period
...... scheduledString string
...... scheduled[x]:scheduledTiming S 0..1 Timing When activity is to occur
..... 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 required Kenya Procedure Code Value Set 📦0.1.0 This IG
CarePlan.activity.detail.​reasonCode Base required Kenya Manifestation Or Symptom Value Set 📦0.1.0 This IG
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