Kenya Core FHIR Implementation Guide (IG)
0.1.0 - ci-build
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
| 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:
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 |
  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) | |
 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 | Provider License 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 |
| 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 | License number value Example General: 123456 |
| identifier:sladeCode |
ΣC | 0..1 | Identifier | Slade Facility Code |
| 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 | Slade code value 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 | FID value 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 | FR Code value Example General: 123456 |
 identifier:registrationNumber |
ΣC | 0..1 | Identifier | 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 | Registration number value Example General: 123456 |
| active |
?!SΣ | 1..1 | boolean | Whether the organization's record is active |
 type |
SΣC | 1..* | CodeableConcept | Type of organization Binding: OrganizationType (example): Used to categorize the organization. Constraints: provider-org-type-constraint |
 name |
SΣC | 1..1 | string | Organization name |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.identifier:providerLicense.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:sladeCode.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 | example | Organization type | 📍4.0.1 | FHIR Std. |
| 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
|
| 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()
|
| provider-org-type-constraint | error | Organization.type | Organization must be of type provider |
coding.where(system='https://fhir.sha.go.ke/fhir/terminology/CodeSystem/organization-type' and code='prov').exists()
|
This structure is derived from Organization
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Organization |
0..* | Organization | A grouping of people or organizations with a common purpose | |
| 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) | |
| 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 | Provider License Number | |
 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 | License number value | |
| identifier:sladeCode |
0..1 | Identifier | Slade Facility Code | |
| 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: slade-code | |
| display |
0..1 | string | Representation defined by the system Required Pattern: Code | |
| value |
1..1 | string | Slade code value | |
| 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: Fid | |
| value |
1..1 | string | FID value | |
| 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: Fr Code | |
| value |
1..1 | string | FR Code value | |
| identifier:registrationNumber |
0..1 | Identifier | 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: Registration Number | |
| value |
1..1 | string | Registration number value | |
| active |
S | 1..1 | boolean | Whether the organization's record is active |
| type |
SC | 1..* | CodeableConcept | Type of organization Constraints: provider-org-type-constraint |
| coding |
||||
| system |
0..1 | uri | Identity of the terminology system Required Pattern: https://fhir.sha.go.ke/fhir/terminology/CodeSystem/organization-type | |
| code |
0..1 | code | Symbol in syntax defined by the system Required Pattern: prov | |
| name |
S | 1..1 | string | Organization name |
| Documentation for this format | ||||
| 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()
|
| provider-org-type-constraint | error | Organization.type | Organization must be of type provider |
coding.where(system='https://fhir.sha.go.ke/fhir/terminology/CodeSystem/organization-type' and code='prov').exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| 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 |
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) | |||||
| 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 | Provider License 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. | ||||
| 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 | License number value 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:sladeCode |
ΣC | 0..1 | Identifier | Slade Facility Code | ||||
| 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: slade-code | ||||
| display |
Σ | 0..1 | string | Representation defined by the system Required Pattern: 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 | Slade code value 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: Fid | ||||
| 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 | FID value 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: Fr 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 | FR Code value 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 | 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: 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 | Registration number value 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ΣC | 1..* | CodeableConcept | Type of organization Binding: OrganizationType (example): Used to categorize the organization. Constraints: provider-org-type-constraint | ||||
| 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/organization-type | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: prov | ||||
| 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 | ||||
| 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 |
C | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3 | ||||
| address |
C | 0..* | Address | An address for the organization Constraints: org-2 | ||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| 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:sladeCode.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:sladeCode.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 | example | Organization type | 📍4.0.1 | FHIR Std. |
| Organization.contact.purpose | Base | extensible | Contact entity type | 📍4.0.1 | FHIR Std. |
| 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()
|
| provider-org-type-constraint | error | Organization.type | Organization must be of type provider |
coding.where(system='https://fhir.sha.go.ke/fhir/terminology/CodeSystem/organization-type' and code='prov').exists()
|
This structure is derived from Organization
Summary
Mandatory: 4 elements(5 nested mandatory elements)
Must-Support: 4 elements
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 |
| 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) | |
| 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 | Provider License 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 |
| 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 | License number value Example General: 123456 |
| identifier:sladeCode |
ΣC | 0..1 | Identifier | Slade Facility Code |
| 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 | Slade code value 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 | FID value 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 | FR Code value Example General: 123456 |
| identifier:registrationNumber |
ΣC | 0..1 | Identifier | 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 | Registration number value Example General: 123456 |
| active |
?!SΣ | 1..1 | boolean | Whether the organization's record is active |
| type |
SΣC | 1..* | CodeableConcept | Type of organization Binding: OrganizationType (example): Used to categorize the organization. Constraints: provider-org-type-constraint |
| name |
SΣC | 1..1 | string | Organization name |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.identifier:providerLicense.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:sladeCode.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 | example | Organization type | 📍4.0.1 | FHIR Std. |
| 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
|
| 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()
|
| provider-org-type-constraint | error | Organization.type | Organization must be of type provider |
coding.where(system='https://fhir.sha.go.ke/fhir/terminology/CodeSystem/organization-type' and code='prov').exists()
|
Differential View
This structure is derived from Organization
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Organization |
0..* | Organization | A grouping of people or organizations with a common purpose | |
| 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) | |
| 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 | Provider License Number | |
| 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 | License number value | |
| identifier:sladeCode |
0..1 | Identifier | Slade Facility Code | |
| 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: slade-code | |
| display |
0..1 | string | Representation defined by the system Required Pattern: Code | |
| value |
1..1 | string | Slade code value | |
| 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: Fid | |
| value |
1..1 | string | FID value | |
| 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: Fr Code | |
| value |
1..1 | string | FR Code value | |
| identifier:registrationNumber |
0..1 | Identifier | 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: Registration Number | |
| value |
1..1 | string | Registration number value | |
| active |
S | 1..1 | boolean | Whether the organization's record is active |
| type |
SC | 1..* | CodeableConcept | Type of organization Constraints: provider-org-type-constraint |
| coding |
||||
| system |
0..1 | uri | Identity of the terminology system Required Pattern: https://fhir.sha.go.ke/fhir/terminology/CodeSystem/organization-type | |
| code |
0..1 | code | Symbol in syntax defined by the system Required Pattern: prov | |
| name |
S | 1..1 | string | Organization name |
| Documentation for this format | ||||
| 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()
|
| provider-org-type-constraint | error | Organization.type | Organization must be of type provider |
coding.where(system='https://fhir.sha.go.ke/fhir/terminology/CodeSystem/organization-type' and code='prov').exists()
|
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 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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) | |||||
| 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 | Provider License 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. | ||||
| 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 | License number value 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:sladeCode |
ΣC | 0..1 | Identifier | Slade Facility Code | ||||
| 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: slade-code | ||||
| display |
Σ | 0..1 | string | Representation defined by the system Required Pattern: 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 | Slade code value 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: Fid | ||||
| 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 | FID value 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: Fr 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 | FR Code value 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 | 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: 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 | Registration number value 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ΣC | 1..* | CodeableConcept | Type of organization Binding: OrganizationType (example): Used to categorize the organization. Constraints: provider-org-type-constraint | ||||
| 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/organization-type | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: prov | ||||
| 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 | ||||
| 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 |
C | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3 | ||||
| address |
C | 0..* | Address | An address for the organization Constraints: org-2 | ||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| 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:sladeCode.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:sladeCode.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 | example | Organization type | 📍4.0.1 | FHIR Std. |
| Organization.contact.purpose | Base | extensible | Contact entity type | 📍4.0.1 | FHIR Std. |
| 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()
|
| provider-org-type-constraint | error | Organization.type | Organization must be of type provider |
coding.where(system='https://fhir.sha.go.ke/fhir/terminology/CodeSystem/organization-type' and code='prov').exists()
|
This structure is derived from Organization
Summary
Mandatory: 4 elements(5 nested mandatory elements)
Must-Support: 4 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron