Kenya Core Implementation Guide
1.0.0 - release
Kenya Core Implementation Guide, published by Digital Health Agency (DHA), Kenya. This guide is not an authorized publication; it is the continuous build for version 1.0.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: https://fhir.dha.go.ke/ig/core/StructureDefinition/kenya-core-device | Version: 1.0.0 | |||
| Active as of 2026-08-11 | Computable Name: KenyaCoreDevice | |||
Kenya Core profile for a physical medical device (equipment, appliance, implant, monitor, etc.) used in the provision of care.
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: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Device | Item used in healthcare | |
![]() ![]() |
SΣ | 1..1 | id | Logical id of this artifact |
![]() ![]() |
SΣ | 1..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://fhir.dha.go.ke/ig/core/StructureDefinition/kenya-core-device|1.0.0 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
S | 0..* | Identifier | Instance identifier |
![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() |
SΣ | 1..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. |
![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() |
?!SΣ | 1..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. |
![]() ![]() |
S | 0..1 | string | Name of device manufacturer |
![]() ![]() |
S | 0..1 | dateTime | Date when the device was made |
![]() ![]() |
S | 0..1 | dateTime | Date and time of expiry of this device |
![]() ![]() |
S | 0..1 | string | Lot number of manufacture |
![]() ![]() |
S | 0..1 | string | Serial number assigned by the manufacturer |
![]() ![]() |
S | 0..* | BackboneElement | The name(s) of the device as given by the manufacturer |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 1..1 | string | The name of the device |
![]() ![]() ![]() |
S | 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Binding: DeviceNameType (required): The type of name the device is referred by. |
![]() ![]() |
S | 0..1 | string | The model number for the device |
![]() ![]() |
S | 0..1 | CodeableConcept | The kind or type of device Binding: DeviceType (example): Codes to identify medical devices. |
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept |
![]() ![]() |
S | 0..1 | Reference(KenyaCore Patient Profile) | Patient to whom the device is affixed |
![]() ![]() |
S | 0..1 | Reference(KenyaCore Organization Profile) | Organization responsible for device |
![]() ![]() |
S | 0..1 | Reference(Kenya Core Location Profile) | Where the device is found |
![]() ![]() |
S | 0..* | Annotation | Device notes and comments |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Device.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Device.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Device.status | Base | required | FHIRDeviceStatus | 📍4.0.1 | FHIR Std. |
| Device.deviceName.type | Base | required | DeviceNameType | 📍4.0.1 | FHIR Std. |
| Device.type | Base | example | Device Type | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Device | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Device | 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 | Device | 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 | Device | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Device | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Device
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Device | Item used in healthcare | |
![]() ![]() |
S | 1..1 | id | Logical id of this artifact |
![]() ![]() |
S | 1..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://fhir.dha.go.ke/ig/core/StructureDefinition/kenya-core-device|1.0.0 | |
![]() ![]() |
S | 0..* | Identifier | Instance identifier |
![]() ![]() ![]() |
S | 0..1 | code | usual | official | temp | secondary | old (If known) |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() |
S | 1..1 | code | active | inactive | entered-in-error | unknown |
![]() ![]() |
S | 0..1 | string | Name of device manufacturer |
![]() ![]() |
S | 0..1 | dateTime | Date when the device was made |
![]() ![]() |
S | 0..1 | dateTime | Date and time of expiry of this device |
![]() ![]() |
S | 0..1 | string | Lot number of manufacture |
![]() ![]() |
S | 0..1 | string | Serial number assigned by the manufacturer |
![]() ![]() |
S | 0..* | BackboneElement | The name(s) of the device as given by the manufacturer |
![]() ![]() ![]() |
S | 1..1 | string | The name of the device |
![]() ![]() ![]() |
S | 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other |
![]() ![]() |
S | 0..1 | string | The model number for the device |
![]() ![]() |
S | 0..1 | CodeableConcept | The kind or type of device |
![]() ![]() ![]() |
S | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() |
S | 0..1 | string | Plain text representation of the concept |
![]() ![]() |
S | 0..1 | Reference(KenyaCore Patient Profile) | Patient to whom the device is affixed |
![]() ![]() |
S | 0..1 | Reference(KenyaCore Organization Profile) | Organization responsible for device |
![]() ![]() |
S | 0..1 | Reference(Kenya Core Location Profile) | Where the device is found |
![]() ![]() |
S | 0..* | Annotation | Device notes and comments |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Device | Item used in healthcare | |||||
![]() ![]() |
SΣ | 1..1 | id | Logical id of this artifact | ||||
![]() ![]() |
SΣ | 1..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://fhir.dha.go.ke/ig/core/StructureDefinition/kenya-core-device|1.0.0 | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
S | 0..* | Identifier | Instance identifier | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() |
SΣ | 1..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. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
0..1 | Reference(DeviceDefinition) | The reference to the definition for the device | |||||
![]() ![]() |
Σ | 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Mandatory fixed portion of UDI | ||||
![]() ![]() ![]() |
0..1 | uri | UDI Issuing Organization | |||||
![]() ![]() ![]() |
0..1 | uri | Regional UDI authority | |||||
![]() ![]() ![]() |
Σ | 0..1 | base64Binary | UDI Machine Readable Barcode String | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | UDI Human Readable Barcode String | ||||
![]() ![]() ![]() |
0..1 | code | barcode | rfid | manual + Binding: UDIEntryType (required): Codes to identify how UDI data was entered. | |||||
![]() ![]() |
?!SΣ | 1..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. | ||||
![]() ![]() |
0..* | CodeableConcept | online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device. | |||||
![]() ![]() |
0..1 | string | The distinct identification string | |||||
![]() ![]() |
S | 0..1 | string | Name of device manufacturer | ||||
![]() ![]() |
S | 0..1 | dateTime | Date when the device was made | ||||
![]() ![]() |
S | 0..1 | dateTime | Date and time of expiry of this device | ||||
![]() ![]() |
S | 0..1 | string | Lot number of manufacture | ||||
![]() ![]() |
S | 0..1 | string | Serial number assigned by the manufacturer | ||||
![]() ![]() |
S | 0..* | BackboneElement | The name(s) of the device as given by the manufacturer | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
S | 1..1 | string | The name of the device | ||||
![]() ![]() ![]() |
S | 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Binding: DeviceNameType (required): The type of name the device is referred by. | ||||
![]() ![]() |
S | 0..1 | string | The model number for the device | ||||
![]() ![]() |
0..1 | string | The part number of the device | |||||
![]() ![]() |
S | 0..1 | CodeableConcept | The kind or type of device Binding: DeviceType (example): Codes to identify medical devices. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
0..* | BackboneElement | The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | CodeableConcept | The standard that is used to operate and communicate | |||||
![]() ![]() ![]() |
0..1 | string | The version of the standard that is used to operate and communicate | |||||
![]() ![]() |
0..* | BackboneElement | The actual design of the device or software version running on the device | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The type of the device version | |||||
![]() ![]() ![]() |
0..1 | Identifier | A single component of the device version | |||||
![]() ![]() ![]() |
1..1 | string | The version text | |||||
![]() ![]() |
0..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) | |||||
![]() ![]() ![]() |
0..* | Quantity | Property value as a quantity | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | |||||
![]() ![]() |
S | 0..1 | Reference(KenyaCore Patient Profile) | Patient to whom the device is affixed | ||||
![]() ![]() |
S | 0..1 | Reference(KenyaCore Organization Profile) | Organization responsible for device | ||||
![]() ![]() |
0..* | ContactPoint | Details for human/organization for support | |||||
![]() ![]() |
S | 0..1 | Reference(Kenya Core Location Profile) | Where the device is found | ||||
![]() ![]() |
0..1 | uri | Network address to contact device | |||||
![]() ![]() |
S | 0..* | Annotation | Device notes and comments | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Safety Characteristics of Device | ||||
![]() ![]() |
0..1 | Reference(Device) | The parent device | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Device.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Device.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Device.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Device.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Device.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Device.udiCarrier.entryType | Base | required | UDIEntryType | 📍4.0.1 | FHIR Std. |
| Device.status | Base | required | FHIRDeviceStatus | 📍4.0.1 | FHIR Std. |
| Device.statusReason | Base | extensible | FHIRDeviceStatusReason | 📍4.0.1 | FHIR Std. |
| Device.deviceName.type | Base | required | DeviceNameType | 📍4.0.1 | FHIR Std. |
| Device.type | Base | example | Device Type | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Device | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Device | 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 | Device | 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 | Device | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Device | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Device
Summary
Mandatory: 4 elements(6 nested mandatory elements)
Must-Support: 27 elements
Structures
This structure refers to these other structures:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Device | Item used in healthcare | |
![]() ![]() |
SΣ | 1..1 | id | Logical id of this artifact |
![]() ![]() |
SΣ | 1..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://fhir.dha.go.ke/ig/core/StructureDefinition/kenya-core-device|1.0.0 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
S | 0..* | Identifier | Instance identifier |
![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() |
SΣ | 1..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. |
![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() |
?!SΣ | 1..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. |
![]() ![]() |
S | 0..1 | string | Name of device manufacturer |
![]() ![]() |
S | 0..1 | dateTime | Date when the device was made |
![]() ![]() |
S | 0..1 | dateTime | Date and time of expiry of this device |
![]() ![]() |
S | 0..1 | string | Lot number of manufacture |
![]() ![]() |
S | 0..1 | string | Serial number assigned by the manufacturer |
![]() ![]() |
S | 0..* | BackboneElement | The name(s) of the device as given by the manufacturer |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 1..1 | string | The name of the device |
![]() ![]() ![]() |
S | 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Binding: DeviceNameType (required): The type of name the device is referred by. |
![]() ![]() |
S | 0..1 | string | The model number for the device |
![]() ![]() |
S | 0..1 | CodeableConcept | The kind or type of device Binding: DeviceType (example): Codes to identify medical devices. |
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept |
![]() ![]() |
S | 0..1 | Reference(KenyaCore Patient Profile) | Patient to whom the device is affixed |
![]() ![]() |
S | 0..1 | Reference(KenyaCore Organization Profile) | Organization responsible for device |
![]() ![]() |
S | 0..1 | Reference(Kenya Core Location Profile) | Where the device is found |
![]() ![]() |
S | 0..* | Annotation | Device notes and comments |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Device.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Device.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Device.status | Base | required | FHIRDeviceStatus | 📍4.0.1 | FHIR Std. |
| Device.deviceName.type | Base | required | DeviceNameType | 📍4.0.1 | FHIR Std. |
| Device.type | Base | example | Device Type | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Device | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Device | 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 | Device | 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 | Device | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Device | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Device
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Device | Item used in healthcare | |
![]() ![]() |
S | 1..1 | id | Logical id of this artifact |
![]() ![]() |
S | 1..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://fhir.dha.go.ke/ig/core/StructureDefinition/kenya-core-device|1.0.0 | |
![]() ![]() |
S | 0..* | Identifier | Instance identifier |
![]() ![]() ![]() |
S | 0..1 | code | usual | official | temp | secondary | old (If known) |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() |
S | 1..1 | code | active | inactive | entered-in-error | unknown |
![]() ![]() |
S | 0..1 | string | Name of device manufacturer |
![]() ![]() |
S | 0..1 | dateTime | Date when the device was made |
![]() ![]() |
S | 0..1 | dateTime | Date and time of expiry of this device |
![]() ![]() |
S | 0..1 | string | Lot number of manufacture |
![]() ![]() |
S | 0..1 | string | Serial number assigned by the manufacturer |
![]() ![]() |
S | 0..* | BackboneElement | The name(s) of the device as given by the manufacturer |
![]() ![]() ![]() |
S | 1..1 | string | The name of the device |
![]() ![]() ![]() |
S | 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other |
![]() ![]() |
S | 0..1 | string | The model number for the device |
![]() ![]() |
S | 0..1 | CodeableConcept | The kind or type of device |
![]() ![]() ![]() |
S | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() |
S | 0..1 | string | Plain text representation of the concept |
![]() ![]() |
S | 0..1 | Reference(KenyaCore Patient Profile) | Patient to whom the device is affixed |
![]() ![]() |
S | 0..1 | Reference(KenyaCore Organization Profile) | Organization responsible for device |
![]() ![]() |
S | 0..1 | Reference(Kenya Core Location Profile) | Where the device is found |
![]() ![]() |
S | 0..* | Annotation | Device notes and comments |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Device | Item used in healthcare | |||||
![]() ![]() |
SΣ | 1..1 | id | Logical id of this artifact | ||||
![]() ![]() |
SΣ | 1..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://fhir.dha.go.ke/ig/core/StructureDefinition/kenya-core-device|1.0.0 | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
S | 0..* | Identifier | Instance identifier | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() |
SΣ | 1..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. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
0..1 | Reference(DeviceDefinition) | The reference to the definition for the device | |||||
![]() ![]() |
Σ | 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Mandatory fixed portion of UDI | ||||
![]() ![]() ![]() |
0..1 | uri | UDI Issuing Organization | |||||
![]() ![]() ![]() |
0..1 | uri | Regional UDI authority | |||||
![]() ![]() ![]() |
Σ | 0..1 | base64Binary | UDI Machine Readable Barcode String | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | UDI Human Readable Barcode String | ||||
![]() ![]() ![]() |
0..1 | code | barcode | rfid | manual + Binding: UDIEntryType (required): Codes to identify how UDI data was entered. | |||||
![]() ![]() |
?!SΣ | 1..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. | ||||
![]() ![]() |
0..* | CodeableConcept | online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device. | |||||
![]() ![]() |
0..1 | string | The distinct identification string | |||||
![]() ![]() |
S | 0..1 | string | Name of device manufacturer | ||||
![]() ![]() |
S | 0..1 | dateTime | Date when the device was made | ||||
![]() ![]() |
S | 0..1 | dateTime | Date and time of expiry of this device | ||||
![]() ![]() |
S | 0..1 | string | Lot number of manufacture | ||||
![]() ![]() |
S | 0..1 | string | Serial number assigned by the manufacturer | ||||
![]() ![]() |
S | 0..* | BackboneElement | The name(s) of the device as given by the manufacturer | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
S | 1..1 | string | The name of the device | ||||
![]() ![]() ![]() |
S | 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Binding: DeviceNameType (required): The type of name the device is referred by. | ||||
![]() ![]() |
S | 0..1 | string | The model number for the device | ||||
![]() ![]() |
0..1 | string | The part number of the device | |||||
![]() ![]() |
S | 0..1 | CodeableConcept | The kind or type of device Binding: DeviceType (example): Codes to identify medical devices. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
0..* | BackboneElement | The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | CodeableConcept | The standard that is used to operate and communicate | |||||
![]() ![]() ![]() |
0..1 | string | The version of the standard that is used to operate and communicate | |||||
![]() ![]() |
0..* | BackboneElement | The actual design of the device or software version running on the device | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The type of the device version | |||||
![]() ![]() ![]() |
0..1 | Identifier | A single component of the device version | |||||
![]() ![]() ![]() |
1..1 | string | The version text | |||||
![]() ![]() |
0..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) | |||||
![]() ![]() ![]() |
0..* | Quantity | Property value as a quantity | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | |||||
![]() ![]() |
S | 0..1 | Reference(KenyaCore Patient Profile) | Patient to whom the device is affixed | ||||
![]() ![]() |
S | 0..1 | Reference(KenyaCore Organization Profile) | Organization responsible for device | ||||
![]() ![]() |
0..* | ContactPoint | Details for human/organization for support | |||||
![]() ![]() |
S | 0..1 | Reference(Kenya Core Location Profile) | Where the device is found | ||||
![]() ![]() |
0..1 | uri | Network address to contact device | |||||
![]() ![]() |
S | 0..* | Annotation | Device notes and comments | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Safety Characteristics of Device | ||||
![]() ![]() |
0..1 | Reference(Device) | The parent device | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Device.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Device.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Device.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Device.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Device.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Device.udiCarrier.entryType | Base | required | UDIEntryType | 📍4.0.1 | FHIR Std. |
| Device.status | Base | required | FHIRDeviceStatus | 📍4.0.1 | FHIR Std. |
| Device.statusReason | Base | extensible | FHIRDeviceStatusReason | 📍4.0.1 | FHIR Std. |
| Device.deviceName.type | Base | required | DeviceNameType | 📍4.0.1 | FHIR Std. |
| Device.type | Base | example | Device Type | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Device | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Device | 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 | Device | 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 | Device | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Device | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Device
Summary
Mandatory: 4 elements(6 nested mandatory elements)
Must-Support: 27 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron