Kenya Core Implementation Guide
1.0.0 - release Kenya flag

Kenya Core Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Kenya Core Community Health Unit Location

Official URL: https://fhir.dha.go.ke/core/StructureDefinition/kenya-core-community-health-unit-location Version: 1.0.0
Active as of 2026-10-02 Computable Name: KenyaCoreCommunityHealthUnitLocation

The Community Health Unit (CHU) as a physical place: where it is and basic identifying facts. No workforce, services or partners – see KenyaCoreCommunityHealthUnit for those.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* Location Details and position information for a physical place
... id SΣ 1..1 id Resource id -- server-assigned; do not derive it from or duplicate the CHU code here (that belongs in identifier[chuCode], which is what chu-code-format validates)
... meta SΣ 1..1 Meta Metadata about the resource
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to

Required Pattern: https://fhir.dha.go.ke/core/StructureDefinition/kenya-core-community-health-unit-location
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
.... extension:operationalStatus S 1..1 CodeableConcept CHU Operational Status
URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-operational-status
Binding: Community Health Unit Operational Status (required)
.... extension:functionalStatus S 0..1 CodeableConcept CHU Functional Status
URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-functional-status
Binding: Community Health Unit Functional Status (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by value:system
.... identifier:chuCode SΣ 1..1 Identifier CHU code issued by the CHU Registry (CHUID-CC-NNNNNN-D) -- links this Location back to the CHU it represents
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-code
..... value ΣC 1..1 string The value that is unique
Constraints: chu-code-format
Example General: 123456
... status ?!SΣ 1..1 code active | suspended | inactive
Binding: LocationStatus (required)
... name SΣ 1..1 string Name of the location as used by humans
... alias S 0..* string Nickname
... type SΣ 1..* CodeableConcept Type of function performed
Binding: Community Health Unit Organization Type (required)
... telecom S 0..* ContactPoint Contact details of the location
... address S 0..1 Address Physical location
.... Slices for extension Content/Rules for all slices
..... extension:constituency S 0..1 string Kenya Constituency
URL: https://fhir.dha.go.ke/core/StructureDefinition/kenya-constituency
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... text SΣ 0..1 string Free-text location description
Example General: 137 Nowhere Street, Erewhon 9132
.... city SΣ 0..1 string Sub-County
Example General: Erewhon
.... district SΣ 0..1 string County
Example General: Madison
.... state SΣ 0..1 string Ward
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... position S 0..1 BackboneElement Native Location field for coordinates -- unlike Organization, Location doesn't need the geolocation extension for this
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... longitude S 1..1 decimal Longitude with WGS84 datum
.... latitude S 1..1 decimal Latitude with WGS84 datum
... managingOrganization SΣ 0..1 Reference(KenyaCore Organization Profile) Primary health facility the CHU is linked to
.... identifier SΣ 0..1 Identifier Facility Registry code (FR code) of the linked facility
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.dha.go.ke/terminology/CodeSystem/facility-identifier-types-cs
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: fr-code
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... display SΣ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.identifier:chuCode.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.status Base required LocationStatus 📦4.0.1 FHIR Std.
Location.type Base required Community Health Unit Organization Type 📦1.0.0 This IG
Location.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Location.managingOrganization.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.managingOrganization.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
chu-code-format error Location.identifier:chuCode.value CHU code must be CHUID-<2-digit county code>-<sequence>-<Luhn check digit>, e.g. CHUID-07-103287-4 $this.matches('^CHUID-[0-9]{2}-[0-9]{6,}-[0-9]$')
dom-2 error Location If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Location 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 Location 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 Location If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Location 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()

This structure is derived from Location

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* Location Details and position information for a physical place
... id S 1..1 id Resource id -- server-assigned; do not derive it from or duplicate the CHU code here (that belongs in identifier[chuCode], which is what chu-code-format validates)
... meta S 1..1 Meta Metadata about the resource
.... profile 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
Required Pattern: https://fhir.dha.go.ke/core/StructureDefinition/kenya-core-community-health-unit-location
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:operationalStatus S 1..1 CodeableConcept CHU Operational Status
URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-operational-status
Binding: Community Health Unit Operational Status (required)
.... extension:functionalStatus S 0..1 CodeableConcept CHU Functional Status
URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-functional-status
Binding: Community Health Unit Functional Status (required)
.... identifier:chuCode S 1..1 Identifier CHU code issued by the CHU Registry (CHUID-CC-NNNNNN-D) -- links this Location back to the CHU it represents
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... system 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-code
..... value C 1..1 string The value that is unique
Constraints: chu-code-format
... status S 1..1 code active | suspended | inactive
Binding: LocationStatus (required)
... name S 1..1 string Name of the location as used by humans
... alias S 0..* string Nickname
... type S 1..* CodeableConcept Type of function performed
Binding: Community Health Unit Organization Type (required)
... telecom S 0..* ContactPoint Contact details of the location
... address S 0..1 Address Physical location
.... Slices for extension Content/Rules for all slices
..... extension:constituency S 0..1 string Kenya Constituency
URL: https://fhir.dha.go.ke/core/StructureDefinition/kenya-constituency
.... text S 0..1 string Free-text location description
.... city S 0..1 string Sub-County
.... district S 0..1 string County
.... state S 0..1 string Ward
.... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... position S 0..1 BackboneElement Native Location field for coordinates -- unlike Organization, Location doesn't need the geolocation extension for this
.... longitude S 1..1 decimal Longitude with WGS84 datum
.... latitude S 1..1 decimal Latitude with WGS84 datum
... managingOrganization S 0..1 Reference(KenyaCore Organization Profile) Primary health facility the CHU is linked to
.... identifier S 0..1 Identifier Facility Registry code (FR code) of the linked facility
..... type 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.dha.go.ke/terminology/CodeSystem/facility-identifier-types-cs
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: fr-code
..... value 1..1 string The value that is unique
.... display S 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Location.status Base required LocationStatus 📦4.0.1 FHIR Std.
Location.type Base required Community Health Unit Organization Type 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
chu-code-format error Location.identifier:chuCode.value CHU code must be CHUID-<2-digit county code>-<sequence>-<Luhn check digit>, e.g. CHUID-07-103287-4 $this.matches('^CHUID-[0-9]{2}-[0-9]{6,}-[0-9]$')
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* Location Details and position information for a physical place
... id SΣ 1..1 id Resource id -- server-assigned; do not derive it from or duplicate the CHU code here (that belongs in identifier[chuCode], which is what chu-code-format validates)
... meta SΣ 1..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 Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to

Required Pattern: https://fhir.dha.go.ke/core/StructureDefinition/kenya-core-community-health-unit-location
.... 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
... 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 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:operationalStatus S 1..1 CodeableConcept CHU Operational Status
URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-operational-status
Binding: Community Health Unit Operational Status (required)
.... extension:functionalStatus S 0..1 CodeableConcept CHU Functional Status
URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-functional-status
Binding: Community Health Unit Functional Status (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by value:system
.... identifier:chuCode SΣ 1..1 Identifier CHU code issued by the CHU Registry (CHUID-CC-NNNNNN-D) -- links this Location back to the CHU it represents
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-code
..... value ΣC 1..1 string The value that is unique
Constraints: chu-code-format
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code active | suspended | inactive
Binding: LocationStatus (required)
... operationalStatus Σ 0..1 Coding The operational status of the location (typically only for a bed/room)
Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).
... name SΣ 1..1 string Name of the location as used by humans
... alias S 0..* string Nickname
... description Σ 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
... mode Σ 0..1 code instance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
... type SΣ 1..* CodeableConcept Type of function performed
Binding: Community Health Unit Organization Type (required)
... telecom S 0..* ContactPoint Contact details of the location
... address S 0..1 Address Physical location
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:constituency S 0..1 string Kenya Constituency
URL: https://fhir.dha.go.ke/core/StructureDefinition/kenya-constituency
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
.... text SΣ 0..1 string Free-text location description
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 0..1 string Sub-County
Example General: Erewhon
.... district SΣ 0..1 string County
Example General: Madison
.... state SΣ 0..1 string Ward
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... physicalType Σ 0..1 CodeableConcept Physical form of the location
Binding: LocationType (example): Physical form of the location.
... position S 0..1 BackboneElement Native Location field for coordinates -- unlike Organization, Location doesn't need the geolocation extension for this
.... 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
.... longitude S 1..1 decimal Longitude with WGS84 datum
.... latitude S 1..1 decimal Latitude with WGS84 datum
.... altitude 0..1 decimal Altitude with WGS84 datum
... managingOrganization SΣ 0..1 Reference(KenyaCore Organization Profile) Primary health facility the CHU is linked to
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier SΣ 0..1 Identifier Facility Registry code (FR code) of the linked facility
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.dha.go.ke/terminology/CodeSystem/facility-identifier-types-cs
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: fr-code
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... display SΣ 0..1 string Text alternative for the resource
... partOf 0..1 Reference(Location) Another Location this one is physically a part of
... hoursOfOperation 0..* BackboneElement What days/times during a week is this location usually open
.... 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
.... daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.
.... allDay 0..1 boolean The Location is open all day
.... openingTime 0..1 time Time that the Location opens
.... closingTime 0..1 time Time that the Location closes
... availabilityExceptions 0..1 string Description of availability exceptions
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Location.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Location.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Location.identifier:chuCode.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.identifier:chuCode.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Location.status Base required LocationStatus 📦4.0.1 FHIR Std.
Location.operationalStatus Base preferred hl7VS-bedStatus 📦3.0.0 THO v7.4
Location.mode Base required LocationMode 📍4.0.1 FHIR Std.
Location.type Base required Community Health Unit Organization Type 📦1.0.0 This IG
Location.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Location.address.type Base required AddressType 📍4.0.1 FHIR Std.
Location.physicalType Base example Location type 📍4.0.1 FHIR Std.
Location.managingOrganization.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Location.managingOrganization.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.managingOrganization.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Location.hoursOfOperation.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
chu-code-format error Location.identifier:chuCode.value CHU code must be CHUID-<2-digit county code>-<sequence>-<Luhn check digit>, e.g. CHUID-07-103287-4 $this.matches('^CHUID-[0-9]{2}-[0-9]{6,}-[0-9]$')
dom-2 error Location If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Location 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 Location 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 Location If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Location 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()

This structure is derived from Location

Summary

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

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Location.identifier

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* Location Details and position information for a physical place
... id SΣ 1..1 id Resource id -- server-assigned; do not derive it from or duplicate the CHU code here (that belongs in identifier[chuCode], which is what chu-code-format validates)
... meta SΣ 1..1 Meta Metadata about the resource
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to

Required Pattern: https://fhir.dha.go.ke/core/StructureDefinition/kenya-core-community-health-unit-location
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
.... extension:operationalStatus S 1..1 CodeableConcept CHU Operational Status
URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-operational-status
Binding: Community Health Unit Operational Status (required)
.... extension:functionalStatus S 0..1 CodeableConcept CHU Functional Status
URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-functional-status
Binding: Community Health Unit Functional Status (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by value:system
.... identifier:chuCode SΣ 1..1 Identifier CHU code issued by the CHU Registry (CHUID-CC-NNNNNN-D) -- links this Location back to the CHU it represents
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-code
..... value ΣC 1..1 string The value that is unique
Constraints: chu-code-format
Example General: 123456
... status ?!SΣ 1..1 code active | suspended | inactive
Binding: LocationStatus (required)
... name SΣ 1..1 string Name of the location as used by humans
... alias S 0..* string Nickname
... type SΣ 1..* CodeableConcept Type of function performed
Binding: Community Health Unit Organization Type (required)
... telecom S 0..* ContactPoint Contact details of the location
... address S 0..1 Address Physical location
.... Slices for extension Content/Rules for all slices
..... extension:constituency S 0..1 string Kenya Constituency
URL: https://fhir.dha.go.ke/core/StructureDefinition/kenya-constituency
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... text SΣ 0..1 string Free-text location description
Example General: 137 Nowhere Street, Erewhon 9132
.... city SΣ 0..1 string Sub-County
Example General: Erewhon
.... district SΣ 0..1 string County
Example General: Madison
.... state SΣ 0..1 string Ward
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... position S 0..1 BackboneElement Native Location field for coordinates -- unlike Organization, Location doesn't need the geolocation extension for this
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... longitude S 1..1 decimal Longitude with WGS84 datum
.... latitude S 1..1 decimal Latitude with WGS84 datum
... managingOrganization SΣ 0..1 Reference(KenyaCore Organization Profile) Primary health facility the CHU is linked to
.... identifier SΣ 0..1 Identifier Facility Registry code (FR code) of the linked facility
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.dha.go.ke/terminology/CodeSystem/facility-identifier-types-cs
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: fr-code
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... display SΣ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.identifier:chuCode.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.status Base required LocationStatus 📦4.0.1 FHIR Std.
Location.type Base required Community Health Unit Organization Type 📦1.0.0 This IG
Location.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Location.managingOrganization.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.managingOrganization.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
chu-code-format error Location.identifier:chuCode.value CHU code must be CHUID-<2-digit county code>-<sequence>-<Luhn check digit>, e.g. CHUID-07-103287-4 $this.matches('^CHUID-[0-9]{2}-[0-9]{6,}-[0-9]$')
dom-2 error Location If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Location 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 Location 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 Location If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Location 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

This structure is derived from Location

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* Location Details and position information for a physical place
... id S 1..1 id Resource id -- server-assigned; do not derive it from or duplicate the CHU code here (that belongs in identifier[chuCode], which is what chu-code-format validates)
... meta S 1..1 Meta Metadata about the resource
.... profile 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
Required Pattern: https://fhir.dha.go.ke/core/StructureDefinition/kenya-core-community-health-unit-location
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:operationalStatus S 1..1 CodeableConcept CHU Operational Status
URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-operational-status
Binding: Community Health Unit Operational Status (required)
.... extension:functionalStatus S 0..1 CodeableConcept CHU Functional Status
URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-functional-status
Binding: Community Health Unit Functional Status (required)
.... identifier:chuCode S 1..1 Identifier CHU code issued by the CHU Registry (CHUID-CC-NNNNNN-D) -- links this Location back to the CHU it represents
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... system 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-code
..... value C 1..1 string The value that is unique
Constraints: chu-code-format
... status S 1..1 code active | suspended | inactive
Binding: LocationStatus (required)
... name S 1..1 string Name of the location as used by humans
... alias S 0..* string Nickname
... type S 1..* CodeableConcept Type of function performed
Binding: Community Health Unit Organization Type (required)
... telecom S 0..* ContactPoint Contact details of the location
... address S 0..1 Address Physical location
.... Slices for extension Content/Rules for all slices
..... extension:constituency S 0..1 string Kenya Constituency
URL: https://fhir.dha.go.ke/core/StructureDefinition/kenya-constituency
.... text S 0..1 string Free-text location description
.... city S 0..1 string Sub-County
.... district S 0..1 string County
.... state S 0..1 string Ward
.... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... position S 0..1 BackboneElement Native Location field for coordinates -- unlike Organization, Location doesn't need the geolocation extension for this
.... longitude S 1..1 decimal Longitude with WGS84 datum
.... latitude S 1..1 decimal Latitude with WGS84 datum
... managingOrganization S 0..1 Reference(KenyaCore Organization Profile) Primary health facility the CHU is linked to
.... identifier S 0..1 Identifier Facility Registry code (FR code) of the linked facility
..... type 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.dha.go.ke/terminology/CodeSystem/facility-identifier-types-cs
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: fr-code
..... value 1..1 string The value that is unique
.... display S 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Location.status Base required LocationStatus 📦4.0.1 FHIR Std.
Location.type Base required Community Health Unit Organization Type 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
chu-code-format error Location.identifier:chuCode.value CHU code must be CHUID-<2-digit county code>-<sequence>-<Luhn check digit>, e.g. CHUID-07-103287-4 $this.matches('^CHUID-[0-9]{2}-[0-9]{6,}-[0-9]$')

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* Location Details and position information for a physical place
... id SΣ 1..1 id Resource id -- server-assigned; do not derive it from or duplicate the CHU code here (that belongs in identifier[chuCode], which is what chu-code-format validates)
... meta SΣ 1..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 Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to

Required Pattern: https://fhir.dha.go.ke/core/StructureDefinition/kenya-core-community-health-unit-location
.... 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
... 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 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:operationalStatus S 1..1 CodeableConcept CHU Operational Status
URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-operational-status
Binding: Community Health Unit Operational Status (required)
.... extension:functionalStatus S 0..1 CodeableConcept CHU Functional Status
URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-functional-status
Binding: Community Health Unit Functional Status (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by value:system
.... identifier:chuCode SΣ 1..1 Identifier CHU code issued by the CHU Registry (CHUID-CC-NNNNNN-D) -- links this Location back to the CHU it represents
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-code
..... value ΣC 1..1 string The value that is unique
Constraints: chu-code-format
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code active | suspended | inactive
Binding: LocationStatus (required)
... operationalStatus Σ 0..1 Coding The operational status of the location (typically only for a bed/room)
Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).
... name SΣ 1..1 string Name of the location as used by humans
... alias S 0..* string Nickname
... description Σ 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
... mode Σ 0..1 code instance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
... type SΣ 1..* CodeableConcept Type of function performed
Binding: Community Health Unit Organization Type (required)
... telecom S 0..* ContactPoint Contact details of the location
... address S 0..1 Address Physical location
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:constituency S 0..1 string Kenya Constituency
URL: https://fhir.dha.go.ke/core/StructureDefinition/kenya-constituency
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
.... text SΣ 0..1 string Free-text location description
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 0..1 string Sub-County
Example General: Erewhon
.... district SΣ 0..1 string County
Example General: Madison
.... state SΣ 0..1 string Ward
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... physicalType Σ 0..1 CodeableConcept Physical form of the location
Binding: LocationType (example): Physical form of the location.
... position S 0..1 BackboneElement Native Location field for coordinates -- unlike Organization, Location doesn't need the geolocation extension for this
.... 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
.... longitude S 1..1 decimal Longitude with WGS84 datum
.... latitude S 1..1 decimal Latitude with WGS84 datum
.... altitude 0..1 decimal Altitude with WGS84 datum
... managingOrganization SΣ 0..1 Reference(KenyaCore Organization Profile) Primary health facility the CHU is linked to
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier SΣ 0..1 Identifier Facility Registry code (FR code) of the linked facility
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.dha.go.ke/terminology/CodeSystem/facility-identifier-types-cs
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: fr-code
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... display SΣ 0..1 string Text alternative for the resource
... partOf 0..1 Reference(Location) Another Location this one is physically a part of
... hoursOfOperation 0..* BackboneElement What days/times during a week is this location usually open
.... 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
.... daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.
.... allDay 0..1 boolean The Location is open all day
.... openingTime 0..1 time Time that the Location opens
.... closingTime 0..1 time Time that the Location closes
... availabilityExceptions 0..1 string Description of availability exceptions
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Location.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Location.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Location.identifier:chuCode.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.identifier:chuCode.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Location.status Base required LocationStatus 📦4.0.1 FHIR Std.
Location.operationalStatus Base preferred hl7VS-bedStatus 📦3.0.0 THO v7.4
Location.mode Base required LocationMode 📍4.0.1 FHIR Std.
Location.type Base required Community Health Unit Organization Type 📦1.0.0 This IG
Location.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Location.address.type Base required AddressType 📍4.0.1 FHIR Std.
Location.physicalType Base example Location type 📍4.0.1 FHIR Std.
Location.managingOrganization.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Location.managingOrganization.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.managingOrganization.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Location.hoursOfOperation.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
chu-code-format error Location.identifier:chuCode.value CHU code must be CHUID-<2-digit county code>-<sequence>-<Luhn check digit>, e.g. CHUID-07-103287-4 $this.matches('^CHUID-[0-9]{2}-[0-9]{6,}-[0-9]$')
dom-2 error Location If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Location 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 Location 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 Location If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Location 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()

This structure is derived from Location

Summary

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

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Location.identifier

 

Other representations of profile: CSV, Excel, Schematron