Kenya Core Implementation Guide
1.0.0 - release
Kenya Core Implementation Guide
1.0.0 - release
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
| Official URL: https://fhir.dha.go.ke/core/StructureDefinition/kenya-core-community-health-unit | Version: 1.0.0 | |||
| Active as of 2026-10-02 | Computable Name: KenyaCoreCommunityHealthUnit | |||
A Community Health Unit (CHU) as registered in the Community Health Unit Registry (CHUR).
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Organization |
C | 0..* | Organization | A grouping of people or organizations with a common purpose Constraints: org-1, chu-active-matches-operational-status |
  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 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 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) |
| extension:approvalStatus |
S | 0..1 | CodeableConcept | Registration approval: PENDING-APPROVAL, APPROVED or NOT-APPROVED URL: https://fhir.dha.go.ke/core/StructureDefinition/approval-status-extension Binding: Approval Status Value Set (required) |
| extension:dateEstablished |
S | 0..1 | date | CHU Date Established URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-date-established |
| extension:catchmentPopulation |
S | 0..1 | (Complex) | CHU Catchment Population URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-catchment-population |
| extension:workforceSummary |
S | 0..1 | (Complex) | CHU Workforce Summary URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-workforce-summary |
| extension:transportResource |
0..* | (Complex) | CHU Transport Resource URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-transport-resource | |
 extension:incomeGeneratingActivity |
0..* | (Complex) | CHU Income Generating Activity URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-income-generating-activity | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 Slices for identifier |
SΣC | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system |
 identifier:chuCode |
SΣC | 1..1 | Identifier | CHU code issued by the CHU Registry (CHUID-CC-NNNNNN-D) |
  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 |
| identifier:registrationReference |
SΣC | 0..1 | Identifier | CHU Registry registration reference (CHU/CCC/YYYY/NNNN) |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-registration-reference |
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:mohRegistrationNumber |
SΣC | 0..1 | Identifier | Ministry of Health registration number |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-moh-registration-number |
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:socialServicesRegistrationNumber |
SΣC | 0..1 | Identifier | Department of Social Services registration number |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-social-services-registration-number |
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
 identifier:operatingLicence |
SΣC | 0..* | Identifier | Operating licence |
 use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-operating-licence |
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
| period |
SΣ | 0..1 | Period | Time period when id is/was valid for use |
| active |
?!SΣ | 1..1 | boolean | True only when the operational status is ACTIVE |
| type |
SΣ | 1..* | CodeableConcept | Kind of organization Binding: Community Health Unit Organization Type (required) |
| name |
SΣC | 1..1 | string | Name used for the organization |
| alias |
S | 0..* | string | Nickname |
| telecom |
SC | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3 |
| address |
SC | 0..1 | Address | An address for the organization Constraints: org-2 |
| Slices for extension |
Content/Rules for all slices | |||
| extension:geolocation |
S | 0..1 | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation |
| 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) |
 partOf |
SΣ | 0..1 | Reference(KenyaCore Organization Profile) | Primary health facility the CHU is linked to |
| Slices for extension |
Content/Rules for all slices | |||
| extension:verified |
S | 0..1 | boolean | CHU Facility Link Verified URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-facility-link-verified |
| 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 |
 contact |
S | 0..* | BackboneElement | Contact for the organization for a certain purpose |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
S | 0..1 | HumanName | A name associated with the contact |
| telecom |
S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
| address |
S | 0..1 | Address | Visiting or postal addresses for the contact |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.identifier:chuCode.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:registrationReference.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:mohRegistrationNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:socialServicesRegistrationNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:operatingLicence.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.type | Base | required | Community Health Unit Organization Type | 📦1.0.0 | This IG |
| Organization.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Organization.partOf.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.partOf.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| chu-active-matches-operational-status | error | Organization | active must be true exactly when the CHU operational status is ACTIVE |
active = extension('https://fhir.dha.go.ke/core/StructureDefinition/chu-operational-status').value.coding.where(code = 'ACTIVE').exists()
|
| chu-code-format | error | Organization.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 | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Organization | 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 | Organization | 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 | Organization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Organization | 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()
|
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one |
(identifier.count() + name.count()) > 0
|
| org-2 | error | Organization.address | An address of an organization can never be of use 'home' |
where(use = 'home').empty()
|
| org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' |
where(use = 'home').empty()
|
This structure is derived from Organization
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Organization |
C | 0..* | Organization | A grouping of people or organizations with a common purpose Constraints: chu-active-matches-operational-status |
 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 | |
| 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) |
| extension:approvalStatus |
S | 0..1 | CodeableConcept | Registration approval: PENDING-APPROVAL, APPROVED or NOT-APPROVED URL: https://fhir.dha.go.ke/core/StructureDefinition/approval-status-extension Binding: Approval Status Value Set (required) |
| extension:dateEstablished |
S | 0..1 | date | CHU Date Established URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-date-established |
| extension:catchmentPopulation |
S | 0..1 | (Complex) | CHU Catchment Population URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-catchment-population |
| extension:workforceSummary |
S | 0..1 | (Complex) | CHU Workforce Summary URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-workforce-summary |
| extension:transportResource |
0..* | (Complex) | CHU Transport Resource URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-transport-resource | |
| extension:incomeGeneratingActivity |
0..* | (Complex) | CHU Income Generating Activity URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-income-generating-activity | |
| Slices for identifier |
S | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system |
| identifier:chuCode |
S | 1..1 | Identifier | CHU code issued by the CHU Registry (CHUID-CC-NNNNNN-D) |
| 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 |
| identifier:registrationReference |
S | 0..1 | Identifier | CHU Registry registration reference (CHU/CCC/YYYY/NNNN) |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-registration-reference | |
| value |
1..1 | string | The value that is unique | |
| identifier:mohRegistrationNumber |
S | 0..1 | Identifier | Ministry of Health registration number |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-moh-registration-number | |
| value |
1..1 | string | The value that is unique | |
| identifier:socialServicesRegistrationNumber |
S | 0..1 | Identifier | Department of Social Services registration number |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-social-services-registration-number | |
| value |
1..1 | string | The value that is unique | |
| identifier:operatingLicence |
S | 0..* | Identifier | Operating licence |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-operating-licence | |
| value |
1..1 | string | The value that is unique | |
| period |
S | 0..1 | Period | Time period when id is/was valid for use |
| active |
S | 1..1 | boolean | True only when the operational status is ACTIVE |
| type |
S | 1..* | CodeableConcept | Kind of organization Binding: Community Health Unit Organization Type (required) |
| name |
S | 1..1 | string | Name used for the organization |
| alias |
S | 0..* | string | Nickname |
| telecom |
S | 0..* | ContactPoint | A contact detail for the organization |
| address |
S | 0..1 | Address | An address for the organization |
| Slices for extension |
Content/Rules for all slices | |||
| extension:geolocation |
S | 0..1 | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation |
| 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) |
| partOf |
S | 0..1 | Reference(KenyaCore Organization Profile) | Primary health facility the CHU is linked to |
| Slices for extension |
Content/Rules for all slices | |||
| extension:verified |
S | 0..1 | boolean | CHU Facility Link Verified URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-facility-link-verified |
| 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 |
| contact |
S | 0..* | BackboneElement | Contact for the organization for a certain purpose |
| name |
S | 0..1 | HumanName | A name associated with the contact |
| telecom |
S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
| address |
S | 0..1 | Address | Visiting or postal addresses for the contact |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.type | Base | required | Community Health Unit Organization Type | 📦1.0.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| chu-active-matches-operational-status | error | Organization | active must be true exactly when the CHU operational status is ACTIVE |
active = extension('https://fhir.dha.go.ke/core/StructureDefinition/chu-operational-status').value.coding.where(code = 'ACTIVE').exists()
|
| chu-code-format | error | Organization.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]$')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | Organization | A grouping of people or organizations with a common purpose Constraints: org-1, chu-active-matches-operational-status | ||||
| 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 | ||||
| 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.
| |||||
| 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) | ||||
| extension:approvalStatus |
S | 0..1 | CodeableConcept | Registration approval: PENDING-APPROVAL, APPROVED or NOT-APPROVED URL: https://fhir.dha.go.ke/core/StructureDefinition/approval-status-extension Binding: Approval Status Value Set (required) | ||||
| extension:dateEstablished |
S | 0..1 | date | CHU Date Established URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-date-established | ||||
| extension:catchmentPopulation |
S | 0..1 | (Complex) | CHU Catchment Population URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-catchment-population | ||||
| extension:workforceSummary |
S | 0..1 | (Complex) | CHU Workforce Summary URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-workforce-summary | ||||
| extension:transportResource |
0..* | (Complex) | CHU Transport Resource URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-transport-resource | |||||
| extension:incomeGeneratingActivity |
0..* | (Complex) | CHU Income Generating Activity URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-income-generating-activity | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
SΣC | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system | ||||
| identifier:chuCode |
SΣC | 1..1 | Identifier | CHU code issued by the CHU Registry (CHUID-CC-NNNNNN-D) | ||||
| 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) | ||||
| identifier:registrationReference |
SΣC | 0..1 | Identifier | CHU Registry registration reference (CHU/CCC/YYYY/NNNN) | ||||
| 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. | ||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-registration-reference | ||||
| 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) | ||||
| identifier:mohRegistrationNumber |
SΣC | 0..1 | Identifier | Ministry of Health registration number | ||||
| 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. | ||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-moh-registration-number | ||||
| 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) | ||||
| identifier:socialServicesRegistrationNumber |
SΣC | 0..1 | Identifier | Department of Social Services registration number | ||||
| 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. | ||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-social-services-registration-number | ||||
| 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) | ||||
| identifier:operatingLicence |
SΣC | 0..* | Identifier | Operating licence | ||||
| 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. | ||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-operating-licence | ||||
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
SΣ | 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) | ||||
| active |
?!SΣ | 1..1 | boolean | True only when the operational status is ACTIVE | ||||
| type |
SΣ | 1..* | CodeableConcept | Kind of organization Binding: Community Health Unit Organization Type (required) | ||||
| name |
SΣC | 1..1 | string | Name used for the organization | ||||
| alias |
S | 0..* | string | Nickname | ||||
| telecom |
SC | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3 | ||||
| address |
SC | 0..1 | Address | An address for the organization Constraints: org-2 | ||||
| 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:geolocation |
S | 0..1 | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation | ||||
| 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"} | ||||
| partOf |
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 | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:verified |
S | 0..1 | boolean | CHU Facility Link Verified URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-facility-link-verified | ||||
| 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 | ||||
| contact |
S | 0..* | BackboneElement | Contact for the organization for a certain purpose | ||||
| 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 | ||||
| purpose |
0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
| name |
S | 0..1 | HumanName | A name associated with the contact | ||||
| telecom |
S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | ||||
| address |
S | 0..1 | Address | Visiting or postal addresses for the contact | ||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Organization.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Organization.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Organization.identifier:chuCode.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:chuCode.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Organization.identifier:registrationReference.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:registrationReference.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Organization.identifier:mohRegistrationNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:mohRegistrationNumber.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Organization.identifier:socialServicesRegistrationNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:socialServicesRegistrationNumber.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Organization.identifier:operatingLicence.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:operatingLicence.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Organization.type | Base | required | Community Health Unit Organization Type | 📦1.0.0 | This IG |
| Organization.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Organization.address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| Organization.partOf.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Organization.partOf.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.partOf.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Organization.contact.purpose | Base | extensible | Contact entity type | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| chu-active-matches-operational-status | error | Organization | active must be true exactly when the CHU operational status is ACTIVE |
active = extension('https://fhir.dha.go.ke/core/StructureDefinition/chu-operational-status').value.coding.where(code = 'ACTIVE').exists()
|
| chu-code-format | error | Organization.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 | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Organization | 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 | Organization | 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 | Organization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Organization | 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()
|
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one |
(identifier.count() + name.count()) > 0
|
| org-2 | error | Organization.address | An address of an organization can never be of use 'home' |
where(use = 'home').empty()
|
| org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' |
where(use = 'home').empty()
|
This structure is derived from Organization
Summary
Mandatory: 12 elements(9 nested mandatory elements)
Must-Support: 36 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Organization |
C | 0..* | Organization | A grouping of people or organizations with a common purpose Constraints: org-1, chu-active-matches-operational-status |
| 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 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| 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) |
| extension:approvalStatus |
S | 0..1 | CodeableConcept | Registration approval: PENDING-APPROVAL, APPROVED or NOT-APPROVED URL: https://fhir.dha.go.ke/core/StructureDefinition/approval-status-extension Binding: Approval Status Value Set (required) |
| extension:dateEstablished |
S | 0..1 | date | CHU Date Established URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-date-established |
| extension:catchmentPopulation |
S | 0..1 | (Complex) | CHU Catchment Population URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-catchment-population |
| extension:workforceSummary |
S | 0..1 | (Complex) | CHU Workforce Summary URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-workforce-summary |
| extension:transportResource |
0..* | (Complex) | CHU Transport Resource URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-transport-resource | |
| extension:incomeGeneratingActivity |
0..* | (Complex) | CHU Income Generating Activity URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-income-generating-activity | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
SΣC | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system |
| identifier:chuCode |
SΣC | 1..1 | Identifier | CHU code issued by the CHU Registry (CHUID-CC-NNNNNN-D) |
| 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 |
| identifier:registrationReference |
SΣC | 0..1 | Identifier | CHU Registry registration reference (CHU/CCC/YYYY/NNNN) |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-registration-reference |
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:mohRegistrationNumber |
SΣC | 0..1 | Identifier | Ministry of Health registration number |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-moh-registration-number |
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:socialServicesRegistrationNumber |
SΣC | 0..1 | Identifier | Department of Social Services registration number |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-social-services-registration-number |
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:operatingLicence |
SΣC | 0..* | Identifier | Operating licence |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-operating-licence |
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
| period |
SΣ | 0..1 | Period | Time period when id is/was valid for use |
| active |
?!SΣ | 1..1 | boolean | True only when the operational status is ACTIVE |
| type |
SΣ | 1..* | CodeableConcept | Kind of organization Binding: Community Health Unit Organization Type (required) |
| name |
SΣC | 1..1 | string | Name used for the organization |
| alias |
S | 0..* | string | Nickname |
| telecom |
SC | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3 |
| address |
SC | 0..1 | Address | An address for the organization Constraints: org-2 |
| Slices for extension |
Content/Rules for all slices | |||
| extension:geolocation |
S | 0..1 | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation |
| 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) |
| partOf |
SΣ | 0..1 | Reference(KenyaCore Organization Profile) | Primary health facility the CHU is linked to |
| Slices for extension |
Content/Rules for all slices | |||
| extension:verified |
S | 0..1 | boolean | CHU Facility Link Verified URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-facility-link-verified |
| 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 |
| contact |
S | 0..* | BackboneElement | Contact for the organization for a certain purpose |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
S | 0..1 | HumanName | A name associated with the contact |
| telecom |
S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
| address |
S | 0..1 | Address | Visiting or postal addresses for the contact |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.identifier:chuCode.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:registrationReference.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:mohRegistrationNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:socialServicesRegistrationNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:operatingLicence.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.type | Base | required | Community Health Unit Organization Type | 📦1.0.0 | This IG |
| Organization.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Organization.partOf.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.partOf.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| chu-active-matches-operational-status | error | Organization | active must be true exactly when the CHU operational status is ACTIVE |
active = extension('https://fhir.dha.go.ke/core/StructureDefinition/chu-operational-status').value.coding.where(code = 'ACTIVE').exists()
|
| chu-code-format | error | Organization.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 | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Organization | 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 | Organization | 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 | Organization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Organization | 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()
|
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one |
(identifier.count() + name.count()) > 0
|
| org-2 | error | Organization.address | An address of an organization can never be of use 'home' |
where(use = 'home').empty()
|
| org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' |
where(use = 'home').empty()
|
Differential View
This structure is derived from Organization
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Organization |
C | 0..* | Organization | A grouping of people or organizations with a common purpose Constraints: chu-active-matches-operational-status |
| 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 | |
| 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) |
| extension:approvalStatus |
S | 0..1 | CodeableConcept | Registration approval: PENDING-APPROVAL, APPROVED or NOT-APPROVED URL: https://fhir.dha.go.ke/core/StructureDefinition/approval-status-extension Binding: Approval Status Value Set (required) |
| extension:dateEstablished |
S | 0..1 | date | CHU Date Established URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-date-established |
| extension:catchmentPopulation |
S | 0..1 | (Complex) | CHU Catchment Population URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-catchment-population |
| extension:workforceSummary |
S | 0..1 | (Complex) | CHU Workforce Summary URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-workforce-summary |
| extension:transportResource |
0..* | (Complex) | CHU Transport Resource URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-transport-resource | |
| extension:incomeGeneratingActivity |
0..* | (Complex) | CHU Income Generating Activity URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-income-generating-activity | |
| Slices for identifier |
S | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system |
| identifier:chuCode |
S | 1..1 | Identifier | CHU code issued by the CHU Registry (CHUID-CC-NNNNNN-D) |
| 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 |
| identifier:registrationReference |
S | 0..1 | Identifier | CHU Registry registration reference (CHU/CCC/YYYY/NNNN) |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-registration-reference | |
| value |
1..1 | string | The value that is unique | |
| identifier:mohRegistrationNumber |
S | 0..1 | Identifier | Ministry of Health registration number |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-moh-registration-number | |
| value |
1..1 | string | The value that is unique | |
| identifier:socialServicesRegistrationNumber |
S | 0..1 | Identifier | Department of Social Services registration number |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-social-services-registration-number | |
| value |
1..1 | string | The value that is unique | |
| identifier:operatingLicence |
S | 0..* | Identifier | Operating licence |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-operating-licence | |
| value |
1..1 | string | The value that is unique | |
| period |
S | 0..1 | Period | Time period when id is/was valid for use |
| active |
S | 1..1 | boolean | True only when the operational status is ACTIVE |
| type |
S | 1..* | CodeableConcept | Kind of organization Binding: Community Health Unit Organization Type (required) |
| name |
S | 1..1 | string | Name used for the organization |
| alias |
S | 0..* | string | Nickname |
| telecom |
S | 0..* | ContactPoint | A contact detail for the organization |
| address |
S | 0..1 | Address | An address for the organization |
| Slices for extension |
Content/Rules for all slices | |||
| extension:geolocation |
S | 0..1 | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation |
| 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) |
| partOf |
S | 0..1 | Reference(KenyaCore Organization Profile) | Primary health facility the CHU is linked to |
| Slices for extension |
Content/Rules for all slices | |||
| extension:verified |
S | 0..1 | boolean | CHU Facility Link Verified URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-facility-link-verified |
| 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 |
| contact |
S | 0..* | BackboneElement | Contact for the organization for a certain purpose |
| name |
S | 0..1 | HumanName | A name associated with the contact |
| telecom |
S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
| address |
S | 0..1 | Address | Visiting or postal addresses for the contact |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.type | Base | required | Community Health Unit Organization Type | 📦1.0.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| chu-active-matches-operational-status | error | Organization | active must be true exactly when the CHU operational status is ACTIVE |
active = extension('https://fhir.dha.go.ke/core/StructureDefinition/chu-operational-status').value.coding.where(code = 'ACTIVE').exists()
|
| chu-code-format | error | Organization.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
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | Organization | A grouping of people or organizations with a common purpose Constraints: org-1, chu-active-matches-operational-status | ||||
| 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 | ||||
| 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.
| |||||
| 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) | ||||
| extension:approvalStatus |
S | 0..1 | CodeableConcept | Registration approval: PENDING-APPROVAL, APPROVED or NOT-APPROVED URL: https://fhir.dha.go.ke/core/StructureDefinition/approval-status-extension Binding: Approval Status Value Set (required) | ||||
| extension:dateEstablished |
S | 0..1 | date | CHU Date Established URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-date-established | ||||
| extension:catchmentPopulation |
S | 0..1 | (Complex) | CHU Catchment Population URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-catchment-population | ||||
| extension:workforceSummary |
S | 0..1 | (Complex) | CHU Workforce Summary URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-workforce-summary | ||||
| extension:transportResource |
0..* | (Complex) | CHU Transport Resource URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-transport-resource | |||||
| extension:incomeGeneratingActivity |
0..* | (Complex) | CHU Income Generating Activity URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-income-generating-activity | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
SΣC | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system | ||||
| identifier:chuCode |
SΣC | 1..1 | Identifier | CHU code issued by the CHU Registry (CHUID-CC-NNNNNN-D) | ||||
| 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) | ||||
| identifier:registrationReference |
SΣC | 0..1 | Identifier | CHU Registry registration reference (CHU/CCC/YYYY/NNNN) | ||||
| 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. | ||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-registration-reference | ||||
| 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) | ||||
| identifier:mohRegistrationNumber |
SΣC | 0..1 | Identifier | Ministry of Health registration number | ||||
| 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. | ||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-moh-registration-number | ||||
| 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) | ||||
| identifier:socialServicesRegistrationNumber |
SΣC | 0..1 | Identifier | Department of Social Services registration number | ||||
| 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. | ||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-social-services-registration-number | ||||
| 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) | ||||
| identifier:operatingLicence |
SΣC | 0..* | Identifier | Operating licence | ||||
| 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. | ||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.dha.go.ke/fhir/identifier/chu-operating-licence | ||||
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
SΣ | 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) | ||||
| active |
?!SΣ | 1..1 | boolean | True only when the operational status is ACTIVE | ||||
| type |
SΣ | 1..* | CodeableConcept | Kind of organization Binding: Community Health Unit Organization Type (required) | ||||
| name |
SΣC | 1..1 | string | Name used for the organization | ||||
| alias |
S | 0..* | string | Nickname | ||||
| telecom |
SC | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3 | ||||
| address |
SC | 0..1 | Address | An address for the organization Constraints: org-2 | ||||
| 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:geolocation |
S | 0..1 | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation | ||||
| 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"} | ||||
| partOf |
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 | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:verified |
S | 0..1 | boolean | CHU Facility Link Verified URL: https://fhir.dha.go.ke/core/StructureDefinition/chu-facility-link-verified | ||||
| 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 | ||||
| contact |
S | 0..* | BackboneElement | Contact for the organization for a certain purpose | ||||
| 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 | ||||
| purpose |
0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
| name |
S | 0..1 | HumanName | A name associated with the contact | ||||
| telecom |
S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | ||||
| address |
S | 0..1 | Address | Visiting or postal addresses for the contact | ||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Organization.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Organization.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Organization.identifier:chuCode.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:chuCode.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Organization.identifier:registrationReference.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:registrationReference.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Organization.identifier:mohRegistrationNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:mohRegistrationNumber.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Organization.identifier:socialServicesRegistrationNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:socialServicesRegistrationNumber.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Organization.identifier:operatingLicence.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:operatingLicence.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Organization.type | Base | required | Community Health Unit Organization Type | 📦1.0.0 | This IG |
| Organization.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Organization.address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| Organization.partOf.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Organization.partOf.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.partOf.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Organization.contact.purpose | Base | extensible | Contact entity type | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| chu-active-matches-operational-status | error | Organization | active must be true exactly when the CHU operational status is ACTIVE |
active = extension('https://fhir.dha.go.ke/core/StructureDefinition/chu-operational-status').value.coding.where(code = 'ACTIVE').exists()
|
| chu-code-format | error | Organization.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 | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Organization | 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 | Organization | 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 | Organization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Organization | 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()
|
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one |
(identifier.count() + name.count()) > 0
|
| org-2 | error | Organization.address | An address of an organization can never be of use 'home' |
where(use = 'home').empty()
|
| org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' |
where(use = 'home').empty()
|
This structure is derived from Organization
Summary
Mandatory: 12 elements(9 nested mandatory elements)
Must-Support: 36 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron