Kenya Core FHIR Implementation Guide (IG)
0.1.0 - ci-build

Kenya Core FHIR Implementation Guide (IG), published by IntelliSOFT Consulting. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IntelliSOFT-Consulting/Kenya-core-FHIR-IG/ and changes regularly. See the Directory of published versions

Resource Profile: KenyaCore Organization Profile

Official URL: http://example.org/StructureDefinition/provider-organization Version: 0.1.0
Active as of 2025-12-15 Computable Name: KenyaCoreOrganization

Organization representing healthcare provider facilities in Kenya.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

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
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
Constraints: org-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:facilityLevel 0..1 CodeableConcept Facility Level Extension
URL: http://example.org/StructureDefinition/facility-level-extension
Binding: Facility Level Value Set (required)
.... extension:approvalStatus 0..1 CodeableConcept Approval Status Extension
URL: http://example.org/StructureDefinition/approval-status-extension
Binding: Approval Status Value Set (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:providerLicense ΣC 0..1 Identifier Licensing
..... 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 Σ 0..1 uri The namespace for the identifier value
Required Pattern: https://fhir.sha.go.ke/fhir/license/provider-license
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:fid ΣC 0..1 Identifier Facility ID (FID)
..... 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
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:frCode ΣC 0..1 Identifier Facility Registry Code
Constraints: provider-org-fr-code-format
..... 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
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:registrationNumber ΣC 0..1 Identifier Facility registration number
..... 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
..... value Σ 1..1 string The value that is unique
Example General: 123456
... active ?!SΣ 1..1 boolean Whether the organization's record is active
... type SΣ 1..* CodeableConcept Type of organization
Binding: Organization Type Value Set (required)
... name SΣC 1..1 string Organization name
... telecom SC 0..* ContactPoint A contact detail for the organization
Constraints: org-3
... address SC 0..* Address An address for the organization
Constraints: org-2
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Organization.identifier:providerLicense.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:fid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:frCode.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:registrationNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.type Base required Organization Type Value Set 📦0.1.0 This IG
Organization.address.​use Base required AddressUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
provider-org-fr-code-format warning Organization.identifier:frCode FR Code must match expected format value.matches('^FID-\d{2}-\d{6}-\d$')
provider-org-min-identifier error Organization.identifier Must have at least one identifier identifier.exists()

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization 0..* Organization A grouping of people or organizations with a common purpose
... meta
.... profile 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
Fixed Value: https://fhir.sha.go.ke/fhir/StructureDefinition/provider-organization|1.0.0
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:facilityLevel 0..1 CodeableConcept Facility Level Extension
URL: http://example.org/StructureDefinition/facility-level-extension
Binding: Facility Level Value Set (required)
.... extension:approvalStatus 0..1 CodeableConcept Approval Status Extension
URL: http://example.org/StructureDefinition/approval-status-extension
Binding: Approval Status Value Set (required)
... Slices for identifier SC 1..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
Constraints: provider-org-min-identifier
.... identifier:providerLicense 0..1 Identifier Licensing
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... system 0..1 uri The namespace for the identifier value
Required Pattern: https://fhir.sha.go.ke/fhir/license/provider-license
..... value 1..1 string The value that is unique
.... identifier:fid 0..1 Identifier Facility ID (FID)
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... type
...... coding
....... system 0..1 uri Identity of the terminology system
Required Pattern: https://fhir.sha.go.ke/fhir/terminology/CodeSystem/facility-identifier-types
....... code 0..1 code Symbol in syntax defined by the system
Required Pattern: fid
....... display 0..1 string Representation defined by the system
Required Pattern: Facility ID
..... value 1..1 string The value that is unique
.... identifier:frCode C 0..1 Identifier Facility Registry Code
Constraints: provider-org-fr-code-format
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... type
...... coding
....... system 0..1 uri Identity of the terminology system
Required Pattern: https://fhir.sha.go.ke/fhir/terminology/CodeSystem/facility-identifier-types
....... code 0..1 code Symbol in syntax defined by the system
Required Pattern: fr-code
....... display 0..1 string Representation defined by the system
Required Pattern: Facility registry code
..... value 1..1 string The value that is unique
.... identifier:registrationNumber 0..1 Identifier Facility registration number
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... type
...... coding
....... system 0..1 uri Identity of the terminology system
Required Pattern: https://fhir.sha.go.ke/fhir/terminology/CodeSystem/facility-identifier-types
....... code 0..1 code Symbol in syntax defined by the system
Required Pattern: registration-number
....... display 0..1 string Representation defined by the system
Required Pattern: Facility registration number
..... value 1..1 string The value that is unique
... type S 1..* CodeableConcept Type of organization
Binding: Organization Type Value Set (required)
... name S 1..1 string Organization name
... telecom S 0..* ContactPoint A contact detail for the organization
... address S 0..* Address An address for the organization
.... city S 0..1 string Sub-County
.... district S 0..1 string County
.... state S 0..1 string Ward

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Organization.type Base required Organization Type Value Set 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
provider-org-fr-code-format warning Organization.identifier:frCode FR Code must match expected format value.matches('^FID-\d{2}-\d{6}-\d$')
provider-org-min-identifier error Organization.identifier Must have at least one identifier identifier.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
Constraints: org-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to

Fixed Value: https://fhir.sha.go.ke/fhir/StructureDefinition/provider-organization|1.0.0
.... 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 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:facilityLevel 0..1 CodeableConcept Facility Level Extension
URL: http://example.org/StructureDefinition/facility-level-extension
Binding: Facility Level Value Set (required)
.... extension:approvalStatus 0..1 CodeableConcept Approval Status Extension
URL: http://example.org/StructureDefinition/approval-status-extension
Binding: Approval Status Value Set (required)
... 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 pattern:$this
Constraints: provider-org-min-identifier
.... identifier:providerLicense ΣC 0..1 Identifier Licensing
..... 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 Σ 0..1 uri The namespace for the identifier value
Required Pattern: https://fhir.sha.go.ke/fhir/license/provider-license
..... 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:fid ΣC 0..1 Identifier Facility ID (FID)
..... 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 0..1 uri Identity of the terminology system
Required Pattern: https://fhir.sha.go.ke/fhir/terminology/CodeSystem/facility-identifier-types
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
Required Pattern: fid
....... display Σ 0..1 string Representation defined by the system
Required Pattern: Facility ID
....... 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)
.... identifier:frCode ΣC 0..1 Identifier Facility Registry Code
Constraints: provider-org-fr-code-format
..... 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 0..1 uri Identity of the terminology system
Required Pattern: https://fhir.sha.go.ke/fhir/terminology/CodeSystem/facility-identifier-types
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
Required Pattern: fr-code
....... display Σ 0..1 string Representation defined by the system
Required Pattern: Facility registry code
....... 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)
.... identifier:registrationNumber ΣC 0..1 Identifier Facility 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 .
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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 0..1 uri Identity of the terminology system
Required Pattern: https://fhir.sha.go.ke/fhir/terminology/CodeSystem/facility-identifier-types
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
Required Pattern: registration-number
....... display Σ 0..1 string Representation defined by the system
Required Pattern: Facility registration number
....... 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)
... active ?!SΣ 1..1 boolean Whether the organization's record is active
... type SΣ 1..* CodeableConcept Type of organization
Binding: Organization Type Value Set (required)
... name SΣC 1..1 string Organization name
... alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
... telecom SC 0..* ContactPoint A contact detail for the organization
Constraints: org-3
... address SC 0..* Address An address for the organization
Constraints: org-2
.... 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 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 Σ 0..1 string Text representation of the address
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 Σ 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 Σ 0..1 Reference(Organization) The organization of which this organization forms a part
... contact 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 0..1 HumanName A name associated with the contact
.... telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
.... address 0..1 Address Visiting or postal addresses for the contact
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

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:providerLicense.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:providerLicense.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Organization.identifier:fid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:fid.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Organization.identifier:frCode.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:frCode.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Organization.identifier:registrationNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:registrationNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Organization.type Base required Organization Type Value Set 📦0.1.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.contact.​purpose Base extensible Contact entity type 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
provider-org-fr-code-format warning Organization.identifier:frCode FR Code must match expected format value.matches('^FID-\d{2}-\d{6}-\d$')
provider-org-min-identifier error Organization.identifier Must have at least one identifier identifier.exists()

This structure is derived from Organization

Summary

Mandatory: 4 elements(5 nested mandatory elements)
Must-Support: 9 elements
Fixed: 1 element

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
Constraints: org-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:facilityLevel 0..1 CodeableConcept Facility Level Extension
URL: http://example.org/StructureDefinition/facility-level-extension
Binding: Facility Level Value Set (required)
.... extension:approvalStatus 0..1 CodeableConcept Approval Status Extension
URL: http://example.org/StructureDefinition/approval-status-extension
Binding: Approval Status Value Set (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:providerLicense ΣC 0..1 Identifier Licensing
..... 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 Σ 0..1 uri The namespace for the identifier value
Required Pattern: https://fhir.sha.go.ke/fhir/license/provider-license
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:fid ΣC 0..1 Identifier Facility ID (FID)
..... 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
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:frCode ΣC 0..1 Identifier Facility Registry Code
Constraints: provider-org-fr-code-format
..... 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
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:registrationNumber ΣC 0..1 Identifier Facility registration number
..... 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
..... value Σ 1..1 string The value that is unique
Example General: 123456
... active ?!SΣ 1..1 boolean Whether the organization's record is active
... type SΣ 1..* CodeableConcept Type of organization
Binding: Organization Type Value Set (required)
... name SΣC 1..1 string Organization name
... telecom SC 0..* ContactPoint A contact detail for the organization
Constraints: org-3
... address SC 0..* Address An address for the organization
Constraints: org-2
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Organization.identifier:providerLicense.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:fid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:frCode.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:registrationNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.type Base required Organization Type Value Set 📦0.1.0 This IG
Organization.address.​use Base required AddressUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
provider-org-fr-code-format warning Organization.identifier:frCode FR Code must match expected format value.matches('^FID-\d{2}-\d{6}-\d$')
provider-org-min-identifier error Organization.identifier Must have at least one identifier identifier.exists()

Differential View

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization 0..* Organization A grouping of people or organizations with a common purpose
... meta
.... profile 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
Fixed Value: https://fhir.sha.go.ke/fhir/StructureDefinition/provider-organization|1.0.0
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:facilityLevel 0..1 CodeableConcept Facility Level Extension
URL: http://example.org/StructureDefinition/facility-level-extension
Binding: Facility Level Value Set (required)
.... extension:approvalStatus 0..1 CodeableConcept Approval Status Extension
URL: http://example.org/StructureDefinition/approval-status-extension
Binding: Approval Status Value Set (required)
... Slices for identifier SC 1..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
Constraints: provider-org-min-identifier
.... identifier:providerLicense 0..1 Identifier Licensing
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... system 0..1 uri The namespace for the identifier value
Required Pattern: https://fhir.sha.go.ke/fhir/license/provider-license
..... value 1..1 string The value that is unique
.... identifier:fid 0..1 Identifier Facility ID (FID)
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... type
...... coding
....... system 0..1 uri Identity of the terminology system
Required Pattern: https://fhir.sha.go.ke/fhir/terminology/CodeSystem/facility-identifier-types
....... code 0..1 code Symbol in syntax defined by the system
Required Pattern: fid
....... display 0..1 string Representation defined by the system
Required Pattern: Facility ID
..... value 1..1 string The value that is unique
.... identifier:frCode C 0..1 Identifier Facility Registry Code
Constraints: provider-org-fr-code-format
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... type
...... coding
....... system 0..1 uri Identity of the terminology system
Required Pattern: https://fhir.sha.go.ke/fhir/terminology/CodeSystem/facility-identifier-types
....... code 0..1 code Symbol in syntax defined by the system
Required Pattern: fr-code
....... display 0..1 string Representation defined by the system
Required Pattern: Facility registry code
..... value 1..1 string The value that is unique
.... identifier:registrationNumber 0..1 Identifier Facility registration number
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... type
...... coding
....... system 0..1 uri Identity of the terminology system
Required Pattern: https://fhir.sha.go.ke/fhir/terminology/CodeSystem/facility-identifier-types
....... code 0..1 code Symbol in syntax defined by the system
Required Pattern: registration-number
....... display 0..1 string Representation defined by the system
Required Pattern: Facility registration number
..... value 1..1 string The value that is unique
... type S 1..* CodeableConcept Type of organization
Binding: Organization Type Value Set (required)
... name S 1..1 string Organization name
... telecom S 0..* ContactPoint A contact detail for the organization
... address S 0..* Address An address for the organization
.... city S 0..1 string Sub-County
.... district S 0..1 string County
.... state S 0..1 string Ward

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Organization.type Base required Organization Type Value Set 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
provider-org-fr-code-format warning Organization.identifier:frCode FR Code must match expected format value.matches('^FID-\d{2}-\d{6}-\d$')
provider-org-min-identifier error Organization.identifier Must have at least one identifier identifier.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
Constraints: org-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to

Fixed Value: https://fhir.sha.go.ke/fhir/StructureDefinition/provider-organization|1.0.0
.... 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 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:facilityLevel 0..1 CodeableConcept Facility Level Extension
URL: http://example.org/StructureDefinition/facility-level-extension
Binding: Facility Level Value Set (required)
.... extension:approvalStatus 0..1 CodeableConcept Approval Status Extension
URL: http://example.org/StructureDefinition/approval-status-extension
Binding: Approval Status Value Set (required)
... 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 pattern:$this
Constraints: provider-org-min-identifier
.... identifier:providerLicense ΣC 0..1 Identifier Licensing
..... 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 Σ 0..1 uri The namespace for the identifier value
Required Pattern: https://fhir.sha.go.ke/fhir/license/provider-license
..... 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:fid ΣC 0..1 Identifier Facility ID (FID)
..... 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 0..1 uri Identity of the terminology system
Required Pattern: https://fhir.sha.go.ke/fhir/terminology/CodeSystem/facility-identifier-types
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
Required Pattern: fid
....... display Σ 0..1 string Representation defined by the system
Required Pattern: Facility ID
....... 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)
.... identifier:frCode ΣC 0..1 Identifier Facility Registry Code
Constraints: provider-org-fr-code-format
..... 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 0..1 uri Identity of the terminology system
Required Pattern: https://fhir.sha.go.ke/fhir/terminology/CodeSystem/facility-identifier-types
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
Required Pattern: fr-code
....... display Σ 0..1 string Representation defined by the system
Required Pattern: Facility registry code
....... 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)
.... identifier:registrationNumber ΣC 0..1 Identifier Facility 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 .
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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 0..1 uri Identity of the terminology system
Required Pattern: https://fhir.sha.go.ke/fhir/terminology/CodeSystem/facility-identifier-types
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
Required Pattern: registration-number
....... display Σ 0..1 string Representation defined by the system
Required Pattern: Facility registration number
....... 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)
... active ?!SΣ 1..1 boolean Whether the organization's record is active
... type SΣ 1..* CodeableConcept Type of organization
Binding: Organization Type Value Set (required)
... name SΣC 1..1 string Organization name
... alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
... telecom SC 0..* ContactPoint A contact detail for the organization
Constraints: org-3
... address SC 0..* Address An address for the organization
Constraints: org-2
.... 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 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 Σ 0..1 string Text representation of the address
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 Σ 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 Σ 0..1 Reference(Organization) The organization of which this organization forms a part
... contact 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 0..1 HumanName A name associated with the contact
.... telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
.... address 0..1 Address Visiting or postal addresses for the contact
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

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:providerLicense.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:providerLicense.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Organization.identifier:fid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:fid.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Organization.identifier:frCode.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:frCode.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Organization.identifier:registrationNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:registrationNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Organization.type Base required Organization Type Value Set 📦0.1.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.contact.​purpose Base extensible Contact entity type 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
provider-org-fr-code-format warning Organization.identifier:frCode FR Code must match expected format value.matches('^FID-\d{2}-\d{6}-\d$')
provider-org-min-identifier error Organization.identifier Must have at least one identifier identifier.exists()

This structure is derived from Organization

Summary

Mandatory: 4 elements(5 nested mandatory elements)
Must-Support: 9 elements
Fixed: 1 element

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron