0.1.0 - ci-build

oncologyfhirigkenya - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Oncology Care Plan Kenya

Official URL: http://example.org/StructureDefinition/oncology-kenya-careplan Version: 0.1.0
Draft as of 2025-06-24 Computable Name: OncologyKenyaCarePlan

A structured CarePlan profile for oncology management in Kenya. Aligns with the Kenya National Cancer Control Strategy (2023–2027), Cancer Policy (2020–2030), KEMRI and County Cancer Registries. Supports multidisciplinary cancer care coordination, treatment protocols, and reporting using ICD-10 exclusively.

Usages:

Formal Views of Profile Content

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

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:county 0..1 CodeableConcept County Where Care Plan is Managed
URL: http://example.org/StructureDefinition/careplan-context-county
Binding: https://www.kenyacode.com/fhir/ValueSet/kenya-county-codes (required)
.... extension:referralSource 0..1 CodeableConcept Referral Source for Oncology Care Plan
URL: http://example.org/StructureDefinition/careplan-referral-source
Binding: https://www.sha.go.ke/fhir/ValueSet/kenya-referral-sources (extensible)
.... extension:reportToRegistry 0..1 boolean Flag for National Cancer Registry Reporting
URL: http://example.org/StructureDefinition/careplan-registry-flag
... status S 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
... intent S 1..1 code proposal | plan | order | option
... title S 0..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 | Group) Who the care plan is for
... period S 1..1 Period Time period plan covers
... careTeam S 0..* Reference(CareTeam) Who's involved in plan?
... addresses S 0..* 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 0..* BackboneElement Action to occur as part of plan
.... detail S 0..1 BackboneElement In-line definition of activity
..... code S 1..1 CodeableConcept Detail type of activity
Binding: http://id.who.int/icd10 (required)
..... status S 1..1 code not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
..... scheduled[x] 0..1 When activity is to occur
...... scheduledTiming Timing
...... scheduledPeriod Period

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
CarePlan.categoryextensiblehttp://id.who.int/icd10
http://id.who.int/icd10
CarePlan.activity.detail.coderequiredhttp://id.who.int/icd10
http://id.who.int/icd10
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:county 0..1 CodeableConcept County Where Care Plan is Managed
URL: http://example.org/StructureDefinition/careplan-context-county
Binding: https://www.kenyacode.com/fhir/ValueSet/kenya-county-codes (required)
.... extension:referralSource 0..1 CodeableConcept Referral Source for Oncology Care Plan
URL: http://example.org/StructureDefinition/careplan-referral-source
Binding: https://www.sha.go.ke/fhir/ValueSet/kenya-referral-sources (extensible)
.... extension:reportToRegistry 0..1 boolean Flag for National Cancer Registry Reporting
URL: http://example.org/StructureDefinition/careplan-registry-flag
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... intent ?!SΣ 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
... category SΣ 0..* CodeableConcept Type of plan
Binding: http://id.who.int/icd10 (extensible)
... title SΣ 0..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 | Group) Who the care plan is for
... period SΣ 1..1 Period Time period plan covers
... careTeam S 0..* Reference(CareTeam) Who's involved in plan?
... addresses SΣ 0..* 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 0..* BackboneElement Action to occur as part of plan
Constraints: cpl-3
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... detail SC 0..1 BackboneElement In-line definition of activity
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code S 1..1 CodeableConcept Detail type of activity
Binding: http://id.who.int/icd10 (required)
..... status ?!S 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
..... scheduled[x] 0..1 When activity is to occur
...... scheduledTiming Timing
...... scheduledPeriod Period

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
From the FHIR Standard
CarePlan.intentrequiredCarePlanIntent
http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1
From the FHIR Standard
CarePlan.categoryextensiblehttp://id.who.int/icd10
http://id.who.int/icd10
CarePlan.activity.detail.coderequiredhttp://id.who.int/icd10
http://id.who.int/icd10
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus
http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1
From the FHIR Standard

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()
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
... 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 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:county 0..1 CodeableConcept County Where Care Plan is Managed
URL: http://example.org/StructureDefinition/careplan-context-county
Binding: https://www.kenyacode.com/fhir/ValueSet/kenya-county-codes (required)
.... extension:referralSource 0..1 CodeableConcept Referral Source for Oncology Care Plan
URL: http://example.org/StructureDefinition/careplan-referral-source
Binding: https://www.sha.go.ke/fhir/ValueSet/kenya-referral-sources (extensible)
.... extension:reportToRegistry 0..1 boolean Flag for National Cancer Registry Reporting
URL: http://example.org/StructureDefinition/careplan-registry-flag
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this plan
... instantiatesCanonical Σ 0..* 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): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
... intent ?!SΣ 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
... category SΣ 0..* CodeableConcept Type of plan
Binding: http://id.who.int/icd10 (extensible)
... title SΣ 0..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 | Group) 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 Σ 0..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 0..* Reference(CareTeam) Who's involved in plan?
... addresses SΣ 0..* 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 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 SC 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 1..1 CodeableConcept Detail type of activity
Binding: http://id.who.int/icd10 (required)
..... 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 ?!S 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
..... 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 How to consume/day?
..... quantity 0..1 SimpleQuantity 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

PathConformanceValueSetURI
CarePlan.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
From the FHIR Standard
CarePlan.intentrequiredCarePlanIntent
http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1
From the FHIR Standard
CarePlan.categoryextensiblehttp://id.who.int/icd10
http://id.who.int/icd10
CarePlan.activity.outcomeCodeableConceptexampleCarePlanActivityOutcome
http://hl7.org/fhir/ValueSet/care-plan-activity-outcome
From the FHIR Standard
CarePlan.activity.detail.kindrequiredCarePlanActivityKind
http://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1
From the FHIR Standard
CarePlan.activity.detail.coderequiredhttp://id.who.int/icd10
http://id.who.int/icd10
CarePlan.activity.detail.reasonCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
From the FHIR Standard
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus
http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1
From the FHIR Standard
CarePlan.activity.detail.product[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
From the FHIR Standard

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()

This structure is derived from CarePlan

Summary

Mandatory: 1 element(1 nested mandatory element)
Must-Support: 15 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:county 0..1 CodeableConcept County Where Care Plan is Managed
URL: http://example.org/StructureDefinition/careplan-context-county
Binding: https://www.kenyacode.com/fhir/ValueSet/kenya-county-codes (required)
.... extension:referralSource 0..1 CodeableConcept Referral Source for Oncology Care Plan
URL: http://example.org/StructureDefinition/careplan-referral-source
Binding: https://www.sha.go.ke/fhir/ValueSet/kenya-referral-sources (extensible)
.... extension:reportToRegistry 0..1 boolean Flag for National Cancer Registry Reporting
URL: http://example.org/StructureDefinition/careplan-registry-flag
... status S 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
... intent S 1..1 code proposal | plan | order | option
... title S 0..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 | Group) Who the care plan is for
... period S 1..1 Period Time period plan covers
... careTeam S 0..* Reference(CareTeam) Who's involved in plan?
... addresses S 0..* 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 0..* BackboneElement Action to occur as part of plan
.... detail S 0..1 BackboneElement In-line definition of activity
..... code S 1..1 CodeableConcept Detail type of activity
Binding: http://id.who.int/icd10 (required)
..... status S 1..1 code not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
..... scheduled[x] 0..1 When activity is to occur
...... scheduledTiming Timing
...... scheduledPeriod Period

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
CarePlan.categoryextensiblehttp://id.who.int/icd10
http://id.who.int/icd10
CarePlan.activity.detail.coderequiredhttp://id.who.int/icd10
http://id.who.int/icd10

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:county 0..1 CodeableConcept County Where Care Plan is Managed
URL: http://example.org/StructureDefinition/careplan-context-county
Binding: https://www.kenyacode.com/fhir/ValueSet/kenya-county-codes (required)
.... extension:referralSource 0..1 CodeableConcept Referral Source for Oncology Care Plan
URL: http://example.org/StructureDefinition/careplan-referral-source
Binding: https://www.sha.go.ke/fhir/ValueSet/kenya-referral-sources (extensible)
.... extension:reportToRegistry 0..1 boolean Flag for National Cancer Registry Reporting
URL: http://example.org/StructureDefinition/careplan-registry-flag
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... intent ?!SΣ 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
... category SΣ 0..* CodeableConcept Type of plan
Binding: http://id.who.int/icd10 (extensible)
... title SΣ 0..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 | Group) Who the care plan is for
... period SΣ 1..1 Period Time period plan covers
... careTeam S 0..* Reference(CareTeam) Who's involved in plan?
... addresses SΣ 0..* 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 0..* BackboneElement Action to occur as part of plan
Constraints: cpl-3
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... detail SC 0..1 BackboneElement In-line definition of activity
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code S 1..1 CodeableConcept Detail type of activity
Binding: http://id.who.int/icd10 (required)
..... status ?!S 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
..... scheduled[x] 0..1 When activity is to occur
...... scheduledTiming Timing
...... scheduledPeriod Period

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
From the FHIR Standard
CarePlan.intentrequiredCarePlanIntent
http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1
From the FHIR Standard
CarePlan.categoryextensiblehttp://id.who.int/icd10
http://id.who.int/icd10
CarePlan.activity.detail.coderequiredhttp://id.who.int/icd10
http://id.who.int/icd10
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus
http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1
From the FHIR Standard

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()

Snapshot View

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
... 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 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:county 0..1 CodeableConcept County Where Care Plan is Managed
URL: http://example.org/StructureDefinition/careplan-context-county
Binding: https://www.kenyacode.com/fhir/ValueSet/kenya-county-codes (required)
.... extension:referralSource 0..1 CodeableConcept Referral Source for Oncology Care Plan
URL: http://example.org/StructureDefinition/careplan-referral-source
Binding: https://www.sha.go.ke/fhir/ValueSet/kenya-referral-sources (extensible)
.... extension:reportToRegistry 0..1 boolean Flag for National Cancer Registry Reporting
URL: http://example.org/StructureDefinition/careplan-registry-flag
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this plan
... instantiatesCanonical Σ 0..* 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): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
... intent ?!SΣ 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
... category SΣ 0..* CodeableConcept Type of plan
Binding: http://id.who.int/icd10 (extensible)
... title SΣ 0..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 | Group) 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 Σ 0..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 0..* Reference(CareTeam) Who's involved in plan?
... addresses SΣ 0..* 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 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 SC 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 1..1 CodeableConcept Detail type of activity
Binding: http://id.who.int/icd10 (required)
..... 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 ?!S 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
..... 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 How to consume/day?
..... quantity 0..1 SimpleQuantity 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

PathConformanceValueSetURI
CarePlan.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
From the FHIR Standard
CarePlan.intentrequiredCarePlanIntent
http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1
From the FHIR Standard
CarePlan.categoryextensiblehttp://id.who.int/icd10
http://id.who.int/icd10
CarePlan.activity.outcomeCodeableConceptexampleCarePlanActivityOutcome
http://hl7.org/fhir/ValueSet/care-plan-activity-outcome
From the FHIR Standard
CarePlan.activity.detail.kindrequiredCarePlanActivityKind
http://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1
From the FHIR Standard
CarePlan.activity.detail.coderequiredhttp://id.who.int/icd10
http://id.who.int/icd10
CarePlan.activity.detail.reasonCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
From the FHIR Standard
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus
http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1
From the FHIR Standard
CarePlan.activity.detail.product[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
From the FHIR Standard

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()

This structure is derived from CarePlan

Summary

Mandatory: 1 element(1 nested mandatory element)
Must-Support: 15 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron