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 Encounter

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

An oncology clinical encounter (treatment session, diagnostic visit, consultation) linked to the oncology episode of care.

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
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... 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 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:sessionId S 0..1 string Session ID Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-session-id-extension
.... extension:sessionNumber S 0..1 integer Session Number Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-session-number-extension
.... extension:cycleNumber S 0..1 integer Cycle Number Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-cycle-number-extension
.... extension:regimenReference S 0..1 Reference(CarePlan) Regimen Reference Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-regimen-reference-extension
.... extension:treatmentEligibility S 0..1 boolean Treatment Eligibility Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-treatment-eligibility-extension
.... extension:treatmentSetting S 0..* code Treatment Setting Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-treatment-setting-extension
Binding: Kenya Treatment Setting Value Set (required)
... identifier SΣ 1..1 Identifier Identifier(s) by which this encounter is known
... status ?!SΣ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
... class SΣ 1..1 Coding Classification of patient encounter
Binding: V3 Value SetActEncounterCode (required)
... type SΣ 1..* CodeableConcept Specific type of encounter
Binding: Kenya Oncology Encounter Type Value Set (required)
... subject SΣ 1..1 Reference(Patient) The patient or group present at the encounter
... episodeOfCare SΣ 1..* Reference(NCCP Oncology Episode of Care) Episode(s) of care that this encounter should be recorded against
... basedOn S 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
... participant Σ 0..* BackboneElement List of participants involved in the encounter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... individual SΣ 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson) Persons involved in the encounter other than the patient
... period S 1..1 Period The start and end time of the encounter
... reasonReference SΣ 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition SΣ 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
... location 0..* BackboneElement List of locations where the patient has been
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location S 1..1 Reference(Location) Location the encounter takes place
... serviceProvider S 1..1 Reference(Organization) The organization (facility) responsible for this encounter

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base required V3 Value SetActEncounterCode 📦2014-03-26 FHIR Std.
Encounter.type Base required Kenya Oncology Encounter Type Value Set 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Encounter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Encounter 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 Encounter 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 Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter 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
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... meta
.... profile S 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:sessionId S 0..1 string Session ID Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-session-id-extension
.... extension:sessionNumber S 0..1 integer Session Number Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-session-number-extension
.... extension:cycleNumber S 0..1 integer Cycle Number Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-cycle-number-extension
.... extension:regimenReference S 0..1 Reference(CarePlan) Regimen Reference Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-regimen-reference-extension
.... extension:treatmentEligibility S 0..1 boolean Treatment Eligibility Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-treatment-eligibility-extension
.... extension:treatmentSetting S 0..* code Treatment Setting Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-treatment-setting-extension
Binding: Kenya Treatment Setting Value Set (required)
... identifier S 1..1 Identifier Identifier(s) by which this encounter is known
... class S 1..1 Coding Classification of patient encounter
Binding: V3 Value SetActEncounterCode (required)
... type S 1..* CodeableConcept Specific type of encounter
Binding: Kenya Oncology Encounter Type Value Set (required)
... subject S 1..1 Reference(Patient) The patient or group present at the encounter
... episodeOfCare S 1..* Reference(NCCP Oncology Episode of Care) Episode(s) of care that this encounter should be recorded against
... basedOn S 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
... participant
.... individual S 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson) Persons involved in the encounter other than the patient
... period S 1..1 Period The start and end time of the encounter
... reasonReference S 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis
.... condition S 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
... location
.... location S 1..1 Reference(Location) Location the encounter takes place
... serviceProvider S 1..1 Reference(Organization) The organization (facility) responsible for this encounter

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Encounter.class Base required V3 Value SetActEncounterCode 📦2014-03-26 FHIR Std.
Encounter.type Base required Kenya Oncology Encounter Type Value Set 📦0.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... 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 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:sessionId S 0..1 string Session ID Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-session-id-extension
.... extension:sessionNumber S 0..1 integer Session Number Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-session-number-extension
.... extension:cycleNumber S 0..1 integer Cycle Number Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-cycle-number-extension
.... extension:regimenReference S 0..1 Reference(CarePlan) Regimen Reference Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-regimen-reference-extension
.... extension:treatmentEligibility S 0..1 boolean Treatment Eligibility Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-treatment-eligibility-extension
.... extension:treatmentSetting S 0..* code Treatment Setting Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-treatment-setting-extension
Binding: Kenya Treatment Setting Value Set (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..1 Identifier Identifier(s) by which this encounter is known
... status ?!SΣ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
... statusHistory 0..* BackboneElement List of past encounter statuses
.... 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
.... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
.... period 1..1 Period The time that the episode was in the specified status
... class SΣ 1..1 Coding Classification of patient encounter
Binding: V3 Value SetActEncounterCode (required)
... classHistory 0..* BackboneElement List of past encounter classes
.... 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
.... class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: V3 Value SetActEncounterCode (extensible): Classification of the encounter.
.... period 1..1 Period The time that the episode was in the specified class
... type SΣ 1..* CodeableConcept Specific type of encounter
Binding: Kenya Oncology Encounter Type Value Set (required)
... serviceType Σ 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: v3 Code System ActPriority (example): Indicates the urgency of the encounter.
... subject SΣ 1..1 Reference(Patient) The patient or group present at the encounter
... episodeOfCare SΣ 1..* Reference(NCCP Oncology Episode of Care) Episode(s) of care that this encounter should be recorded against
... basedOn S 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
... participant Σ 0..* BackboneElement List of participants involved in the encounter
.... 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
.... type Σ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
.... period 0..1 Period Period of time during the encounter that the participant participated
.... individual SΣ 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson) Persons involved in the encounter other than the patient
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
... period S 1..1 Period The start and end time of the encounter
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... reasonCode Σ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
... reasonReference SΣ 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
.... 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
.... condition SΣ 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
.... use 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
.... rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
... account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
... hospitalization 0..1 BackboneElement Details about the admission to a healthcare service
.... 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
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
.... admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.
.... reAdmission 0..1 CodeableConcept The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: v2 RE-ADMISSION INDICATOR (example): The reason for re-admission of this hospitalization encounter.
.... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
.... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
.... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.
.... destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
.... dischargeDisposition 0..1 CodeableConcept Category or kind of location after discharge
Binding: DischargeDisposition (example): Discharge Disposition.
... location 0..* BackboneElement List of locations where the patient has been
.... 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
.... location S 1..1 Reference(Location) Location the encounter takes place
.... status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
.... physicalType 0..1 CodeableConcept The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example): Physical form of the location.
.... period 0..1 Period Time period during which the patient was present at the location
... serviceProvider S 1..1 Reference(Organization) The organization (facility) responsible for this encounter
... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Encounter.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Encounter.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.statusHistory.​status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base required V3 Value SetActEncounterCode 📦2014-03-26 FHIR Std.
Encounter.classHistory.​class Base extensible V3 Value SetActEncounterCode 📦2014-03-26 FHIR Std.
Encounter.type Base required Kenya Oncology Encounter Type Value Set 📦0.1.0 This IG
Encounter.serviceType Base example Service type 📍4.0.1 FHIR Std.
Encounter.priority Base example v3 Code System ActPriority 📦2018-08-12 FHIR Std.
Encounter.participant.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Encounter.reasonCode Base preferred Encounter Reason Codes 📍4.0.1 FHIR Std.
Encounter.diagnosis.​use Base preferred DiagnosisRole 📍4.0.1 FHIR Std.
Encounter.hospitalization.​admitSource Base preferred Admit source 📍4.0.1 FHIR Std.
Encounter.hospitalization.​reAdmission Base example v2 RE-ADMISSION INDICATOR 📦2.9 FHIR Std.
Encounter.hospitalization.​dietPreference Base example Diet 📍4.0.1 FHIR Std.
Encounter.hospitalization.​specialCourtesy Base preferred Special courtesy 📍4.0.1 FHIR Std.
Encounter.hospitalization.​specialArrangement Base preferred Special arrangements 📍4.0.1 FHIR Std.
Encounter.hospitalization.​dischargeDisposition Base example Discharge disposition 📍4.0.1 FHIR Std.
Encounter.location.status Base required EncounterLocationStatus 📍4.0.1 FHIR Std.
Encounter.location.physicalType Base example Location type 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Encounter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Encounter 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 Encounter 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 Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter 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
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... 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 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:sessionId S 0..1 string Session ID Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-session-id-extension
.... extension:sessionNumber S 0..1 integer Session Number Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-session-number-extension
.... extension:cycleNumber S 0..1 integer Cycle Number Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-cycle-number-extension
.... extension:regimenReference S 0..1 Reference(CarePlan) Regimen Reference Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-regimen-reference-extension
.... extension:treatmentEligibility S 0..1 boolean Treatment Eligibility Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-treatment-eligibility-extension
.... extension:treatmentSetting S 0..* code Treatment Setting Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-treatment-setting-extension
Binding: Kenya Treatment Setting Value Set (required)
... identifier SΣ 1..1 Identifier Identifier(s) by which this encounter is known
... status ?!SΣ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
... class SΣ 1..1 Coding Classification of patient encounter
Binding: V3 Value SetActEncounterCode (required)
... type SΣ 1..* CodeableConcept Specific type of encounter
Binding: Kenya Oncology Encounter Type Value Set (required)
... subject SΣ 1..1 Reference(Patient) The patient or group present at the encounter
... episodeOfCare SΣ 1..* Reference(NCCP Oncology Episode of Care) Episode(s) of care that this encounter should be recorded against
... basedOn S 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
... participant Σ 0..* BackboneElement List of participants involved in the encounter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... individual SΣ 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson) Persons involved in the encounter other than the patient
... period S 1..1 Period The start and end time of the encounter
... reasonReference SΣ 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition SΣ 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
... location 0..* BackboneElement List of locations where the patient has been
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location S 1..1 Reference(Location) Location the encounter takes place
... serviceProvider S 1..1 Reference(Organization) The organization (facility) responsible for this encounter

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base required V3 Value SetActEncounterCode 📦2014-03-26 FHIR Std.
Encounter.type Base required Kenya Oncology Encounter Type Value Set 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Encounter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Encounter 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 Encounter 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 Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter 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
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... meta
.... profile S 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:sessionId S 0..1 string Session ID Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-session-id-extension
.... extension:sessionNumber S 0..1 integer Session Number Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-session-number-extension
.... extension:cycleNumber S 0..1 integer Cycle Number Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-cycle-number-extension
.... extension:regimenReference S 0..1 Reference(CarePlan) Regimen Reference Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-regimen-reference-extension
.... extension:treatmentEligibility S 0..1 boolean Treatment Eligibility Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-treatment-eligibility-extension
.... extension:treatmentSetting S 0..* code Treatment Setting Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-treatment-setting-extension
Binding: Kenya Treatment Setting Value Set (required)
... identifier S 1..1 Identifier Identifier(s) by which this encounter is known
... class S 1..1 Coding Classification of patient encounter
Binding: V3 Value SetActEncounterCode (required)
... type S 1..* CodeableConcept Specific type of encounter
Binding: Kenya Oncology Encounter Type Value Set (required)
... subject S 1..1 Reference(Patient) The patient or group present at the encounter
... episodeOfCare S 1..* Reference(NCCP Oncology Episode of Care) Episode(s) of care that this encounter should be recorded against
... basedOn S 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
... participant
.... individual S 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson) Persons involved in the encounter other than the patient
... period S 1..1 Period The start and end time of the encounter
... reasonReference S 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis
.... condition S 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
... location
.... location S 1..1 Reference(Location) Location the encounter takes place
... serviceProvider S 1..1 Reference(Organization) The organization (facility) responsible for this encounter

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Encounter.class Base required V3 Value SetActEncounterCode 📦2014-03-26 FHIR Std.
Encounter.type Base required Kenya Oncology Encounter Type Value Set 📦0.1.0 This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... 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 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:sessionId S 0..1 string Session ID Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-session-id-extension
.... extension:sessionNumber S 0..1 integer Session Number Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-session-number-extension
.... extension:cycleNumber S 0..1 integer Cycle Number Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-cycle-number-extension
.... extension:regimenReference S 0..1 Reference(CarePlan) Regimen Reference Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-regimen-reference-extension
.... extension:treatmentEligibility S 0..1 boolean Treatment Eligibility Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-treatment-eligibility-extension
.... extension:treatmentSetting S 0..* code Treatment Setting Extension
URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/nccp-treatment-setting-extension
Binding: Kenya Treatment Setting Value Set (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..1 Identifier Identifier(s) by which this encounter is known
... status ?!SΣ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
... statusHistory 0..* BackboneElement List of past encounter statuses
.... 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
.... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
.... period 1..1 Period The time that the episode was in the specified status
... class SΣ 1..1 Coding Classification of patient encounter
Binding: V3 Value SetActEncounterCode (required)
... classHistory 0..* BackboneElement List of past encounter classes
.... 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
.... class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: V3 Value SetActEncounterCode (extensible): Classification of the encounter.
.... period 1..1 Period The time that the episode was in the specified class
... type SΣ 1..* CodeableConcept Specific type of encounter
Binding: Kenya Oncology Encounter Type Value Set (required)
... serviceType Σ 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: v3 Code System ActPriority (example): Indicates the urgency of the encounter.
... subject SΣ 1..1 Reference(Patient) The patient or group present at the encounter
... episodeOfCare SΣ 1..* Reference(NCCP Oncology Episode of Care) Episode(s) of care that this encounter should be recorded against
... basedOn S 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
... participant Σ 0..* BackboneElement List of participants involved in the encounter
.... 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
.... type Σ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
.... period 0..1 Period Period of time during the encounter that the participant participated
.... individual SΣ 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson) Persons involved in the encounter other than the patient
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
... period S 1..1 Period The start and end time of the encounter
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... reasonCode Σ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
... reasonReference SΣ 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
.... 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
.... condition SΣ 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
.... use 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
.... rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
... account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
... hospitalization 0..1 BackboneElement Details about the admission to a healthcare service
.... 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
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
.... admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.
.... reAdmission 0..1 CodeableConcept The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: v2 RE-ADMISSION INDICATOR (example): The reason for re-admission of this hospitalization encounter.
.... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
.... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
.... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.
.... destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
.... dischargeDisposition 0..1 CodeableConcept Category or kind of location after discharge
Binding: DischargeDisposition (example): Discharge Disposition.
... location 0..* BackboneElement List of locations where the patient has been
.... 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
.... location S 1..1 Reference(Location) Location the encounter takes place
.... status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
.... physicalType 0..1 CodeableConcept The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example): Physical form of the location.
.... period 0..1 Period Time period during which the patient was present at the location
... serviceProvider S 1..1 Reference(Organization) The organization (facility) responsible for this encounter
... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Encounter.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Encounter.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.statusHistory.​status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base required V3 Value SetActEncounterCode 📦2014-03-26 FHIR Std.
Encounter.classHistory.​class Base extensible V3 Value SetActEncounterCode 📦2014-03-26 FHIR Std.
Encounter.type Base required Kenya Oncology Encounter Type Value Set 📦0.1.0 This IG
Encounter.serviceType Base example Service type 📍4.0.1 FHIR Std.
Encounter.priority Base example v3 Code System ActPriority 📦2018-08-12 FHIR Std.
Encounter.participant.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Encounter.reasonCode Base preferred Encounter Reason Codes 📍4.0.1 FHIR Std.
Encounter.diagnosis.​use Base preferred DiagnosisRole 📍4.0.1 FHIR Std.
Encounter.hospitalization.​admitSource Base preferred Admit source 📍4.0.1 FHIR Std.
Encounter.hospitalization.​reAdmission Base example v2 RE-ADMISSION INDICATOR 📦2.9 FHIR Std.
Encounter.hospitalization.​dietPreference Base example Diet 📍4.0.1 FHIR Std.
Encounter.hospitalization.​specialCourtesy Base preferred Special courtesy 📍4.0.1 FHIR Std.
Encounter.hospitalization.​specialArrangement Base preferred Special arrangements 📍4.0.1 FHIR Std.
Encounter.hospitalization.​dischargeDisposition Base example Discharge disposition 📍4.0.1 FHIR Std.
Encounter.location.status Base required EncounterLocationStatus 📍4.0.1 FHIR Std.
Encounter.location.physicalType Base example Location type 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Encounter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Encounter 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 Encounter 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 Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter 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