Uzbekistan Digital Health Platform
0.12.0 - ci-build
Uzbekistan Digital Health Platform
0.12.0 - ci-build
Uzbekistan Digital Health Platform, published by Ministry of Health of the Republic of Uzbekistan. This guide is not an authorized publication; it is the continuous build for version 0.12.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/uzinfocom-org/digital-health-ig/ and changes regularly. See the Directory of published versions
| Official URL: https://dhp.uz/fhir/core/StructureDefinition/uz-core-device | Version: 0.12.0 | ||||
| Draft as of 2026-10-30 | Computable Name: UZCoreDevice | ||||
Uzbekistan Core Device profile, used to record the identity, status and description of a medical device
UZ Core Device describes one physical medical device: a piece of hospital equipment such as a CT scanner, or a single item such as an intrauterine device. It records what the device is (a SNOMED CT type and a category), who made it and when, the model, serial and lot numbers that tell this unit apart, whether it is active and available, and the organization and location it belongs to. Other resources point to it when a device takes part in care. Observation uses device for the device that took the measurement, Procedure for a performer or a subject, AdverseEvent for a suspected cause, DeviceUsage for a device a patient uses, and SupplyRequest, SupplyDelivery and InventoryItem for the item supplied or stocked. A Device is a shared record of a real unit, so search for an existing Device by serial number or identifier before you create a new one.
The elements below must always be present (mandatory) or must be supported when the data is available (Must Support). Not all of them are required, but your system must populate each Must Support element when it has the data, and process it on receipt. This is the human-readable summary; the formal views below give the exact cardinalities, types and terminology bindings.
The base Device resource has no mandatory elements, and this profile adds none. Inside an optional name, both value and type are required.
system (see Identifiers);status (active / inactive / entered-in-error) from the required device status value set, and the availabilityStatus (available / lost / damaged / destroyed) from the extensible availability status value set;displayName, and each name with its value, its type from the name type value set (registered, user-friendly or patient-reported name), and the display flag;type, coded with SNOMED CT from the device type value set, and the category from the device category value set;manufacturer, modelNumber and partNumber;serialNumber, lotNumber, manufactureDate and expirationDate;owner, a reference to an Organization, and the location, a reference to a Location;contact details for the device, and free-text notes.Look a device up before you register it, so the same unit is not recorded twice (| separates system from value and is URL-encoded as %7C):
# by serial number - the reliable match for one unit
GET [base]/Device?serial-number=SN-2023-001456
# by type, within one organization
GET [base]/Device?type=http://snomed.info/sct|54953005&organization=Organization/[id]
# by manufacturer and model, or by batch
GET [base]/Device?manufacturer=Siemens Healthineers&model=SOMATOM Edge
GET [base]/Device?lot-number=CU-2025-0412
A type search matches any coding in type. The Quick Start at the bottom of the page lists the remaining searches.
The examples below go from the smallest useful instance to a fully described unit. Each one validates against this profile. The complete reference instance is the CT scanner example.
The profile makes nothing mandatory, but every UZ Core resource names its profile in meta.profile, which tells the server which rules to validate against. A device record is only useful with a type that says what the device is and a status. This much passes validation:
{
"resourceType": "Device",
"meta": { "profile": ["https://dhp.uz/fhir/core/StructureDefinition/uz-core-device"] },
"language": "en",
"status": "active",
"type": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "54953005",
"display": "Computed tomography scanner"
}
]
}
]
}
type is a list of CodeableConcepts coded with SNOMED CT from the physical device hierarchy (49062001 |Device| and below). status is the record status: active while the device is in use, inactive once it is withdrawn, and entered-in-error for a record created by mistake.
Hospital equipment is usually described the way it was registered: manufacturer, model and serial number, its registered name, and the owner and location that tell you which organization holds it and where it stands. availabilityStatus says whether the device can be used right now, separately from status:
{
"resourceType": "Device",
"meta": { "profile": ["https://dhp.uz/fhir/core/StructureDefinition/uz-core-device"] },
"language": "en",
"displayName": "SOMATOM Edge CT scanner",
"status": "active",
"availabilityStatus": {
"coding": [ { "system": "http://hl7.org/fhir/device-availability-status", "code": "available" } ]
},
"manufacturer": "Siemens Healthineers",
"manufactureDate": "2023-05-15",
"serialNumber": "SN-2023-001456",
"name": [
{ "value": "SOMATOM Edge", "type": "registered-name", "display": true }
],
"modelNumber": "SOMATOM Edge",
"category": [
{
"coding": [ { "system": "http://hl7.org/fhir/device-category", "code": "dme" } ]
}
],
"type": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "54953005",
"display": "Computed tomography scanner"
}
]
}
],
"owner": { "reference": "Organization/tashkent-diseases-hospital" },
"location": { "reference": "Location/example-location" }
}
name.type is a plain code (registered-name, user-friendly-name or patient-reported-name), not a CodeableConcept. Set display to true on the name that should be shown by default. displayName is the label a user interface shows. availabilityStatus and category use HL7 codes. Their English displays come from the base code systems and their Uzbek and Russian ones from DHP supplements, so you can leave display out and let the server fill it in. owner and location are plain References.
An implant or a single-use item is tracked by its batch rather than as a long-lived asset: send the lotNumber and expirationDate from the package, and the category codes that say how it is used. category repeats, so one device can be both implantable and single-use:
{
"resourceType": "Device",
"meta": { "profile": ["https://dhp.uz/fhir/core/StructureDefinition/uz-core-device"] },
"language": "en",
"status": "active",
"availabilityStatus": {
"coding": [ { "system": "http://hl7.org/fhir/device-availability-status", "code": "available" } ]
},
"manufacturer": "Pregna International",
"manufactureDate": "2025-04-10",
"expirationDate": "2030-03-31",
"lotNumber": "CU-2025-0412",
"name": [
{ "value": "Copper T 380A", "type": "registered-name", "display": true }
],
"category": [
{ "coding": [ { "system": "http://hl7.org/fhir/device-category", "code": "implantable" } ] },
{ "coding": [ { "system": "http://hl7.org/fhir/device-category", "code": "single-use" } ] }
],
"type": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "268460000",
"display": "Intrauterine contraceptive device"
}
]
}
],
"owner": { "reference": "Organization/xonobod-medical-association" }
}
expirationDate and manufactureDate are dateTimes, so a plain date is enough. The UZ Core device type value set carries Uzbek and Russian names for the contraceptive device types: intrauterine contraceptive device, condom, drug-eluting contraceptive implant and contraceptive device.
For example API calls, see the Quick Start at the bottom of this page.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Device |
C | 0..* | Device(5.0.0) | Item used in healthcare Constraints: dev-1 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| contained |
0..* | Resource | Contained, inline Resources | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | |
 identifier |
0..* | Identifier | Instance identifier | |
| displayName |
0..1 | string | The name used to display by default when the device is referenced | |
| status |
0..1 | code | active | inactive | entered-in-error Binding: DeviceStatusVS (0.12.0) (required) | |
| availabilityStatus |
0..1 | CodeableConcept | lost | damaged | destroyed | available Binding: DeviceAvailabilityStatusVS (0.12.0) (extensible) | |
| manufacturer |
0..1 | string | Name of device manufacturer | |
| manufactureDate |
0..1 | dateTime | Date when the device was made | |
| expirationDate |
0..1 | dateTime | Date and time of expiry of this device (if applicable) | |
| lotNumber |
0..1 | string | Lot number of manufacture | |
| serialNumber |
0..1 | string | Serial number assigned by the manufacturer | |
 name |
C | 0..* | BackboneElement | The name or names of the device as known to the manufacturer and/or patient |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |
| value |
1..1 | string | The term that names the device | |
| type |
1..1 | code | registered-name | user-friendly-name | patient-reported-name Binding: DeviceNameTypeVS (0.12.0) (required) | |
 display |
C | 0..1 | boolean | The preferred device name |
| modelNumber |
0..1 | string | The manufacturer's model number for the device | |
| partNumber |
0..1 | string | The part number or catalog number of the device | |
| category |
0..* | CodeableConcept | Indicates a high-level grouping of the device Binding: DeviceCategoryVS (0.12.0) (preferred) | |
| type |
0..* | CodeableConcept | The kind or type of device Binding: DeviceTypeVS (0.12.0) (preferred) | |
 owner |
0..1 | Reference(UZ Core Organization(0.12.0)) | Organization responsible for device | |
| contact |
0..* | ContactPoint | Details for human/organization for support | |
| location |
0..1 | Reference(UZ Core Location(0.12.0)) | Where the device is found | |
| note |
0..* | Annotation | Device notes and comments | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Device.status | Base | required | Device status | 📍0.12.0 | This IG |
| Device.availabilityStatus | Base | extensible | Device availability status | 📍0.12.0 | This IG |
| Device.name.type | Base | required | Device name type | 📍0.12.0 | This IG |
| Device.category | Base | preferred | Device category | 📍0.12.0 | This IG |
| Device.type | Base | preferred | Device type | 📍0.12.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Device
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Device |
0..* | Device(5.0.0) | Item used in healthcare | |
 identifier |
0..* | Identifier | Instance identifier | |
| displayName |
0..1 | string | The name used to display by default when the device is referenced | |
| status |
0..1 | code | active | inactive | entered-in-error Binding: DeviceStatusVS (0.12.0) (required) | |
| availabilityStatus |
0..1 | CodeableConcept | lost | damaged | destroyed | available Binding: DeviceAvailabilityStatusVS (0.12.0) (extensible) | |
| manufacturer |
0..1 | string | Name of device manufacturer | |
| manufactureDate |
0..1 | dateTime | Date when the device was made | |
| expirationDate |
0..1 | dateTime | Date and time of expiry of this device (if applicable) | |
| lotNumber |
0..1 | string | Lot number of manufacture | |
| serialNumber |
0..1 | string | Serial number assigned by the manufacturer | |
| name |
0..* | BackboneElement | The name or names of the device as known to the manufacturer and/or patient | |
| value |
1..1 | string | The term that names the device | |
| type |
1..1 | code | registered-name | user-friendly-name | patient-reported-name Binding: DeviceNameTypeVS (0.12.0) (required) | |
| display |
0..1 | boolean | The preferred device name | |
| modelNumber |
0..1 | string | The manufacturer's model number for the device | |
| partNumber |
0..1 | string | The part number or catalog number of the device | |
| category |
0..* | CodeableConcept | Indicates a high-level grouping of the device Binding: DeviceCategoryVS (0.12.0) (preferred) | |
| type |
0..* | CodeableConcept | The kind or type of device Binding: DeviceTypeVS (0.12.0) (preferred) | |
| owner |
0..1 | Reference(UZ Core Organization(0.12.0)) | Organization responsible for device | |
| contact |
0..* | ContactPoint | Details for human/organization for support | |
| location |
0..1 | Reference(UZ Core Location(0.12.0)) | Where the device is found | |
| note |
0..* | Annotation | Device notes and comments | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Device.status | Base | required | Device status | 📍0.12.0 | This IG |
| Device.availabilityStatus | Base | extensible | Device availability status | 📍0.12.0 | This IG |
| Device.name.type | Base | required | Device name type | 📍0.12.0 | This IG |
| Device.category | Base | preferred | Device category | 📍0.12.0 | This IG |
| Device.type | Base | preferred | Device type | 📍0.12.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Device |
C | 0..* | Device(5.0.0) | Item used in healthcare Constraints: dev-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: AllLanguages (required): IETF language tag for 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 | |||||
 extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | |||||
| identifier |
0..* | Identifier | Instance identifier | |||||
| displayName |
0..1 | string | The name used to display by default when the device is referenced | |||||
| definition |
0..1 | CodeableReference(DeviceDefinition) | The reference to the definition for the device | |||||
| udiCarrier |
0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||
| deviceIdentifier |
1..1 | string | Mandatory fixed portion of UDI | |||||
| issuer |
1..1 | uri | UDI Issuing Organization | |||||
| jurisdiction |
0..1 | uri | Regional UDI authority | |||||
| carrierAIDC |
0..1 | base64Binary | UDI Machine Readable Barcode String | |||||
| carrierHRF |
0..1 | string | UDI Human Readable Barcode String | |||||
| entryType |
0..1 | code | barcode | rfid | manual | card | self-reported | electronic-transmission | unknown Binding: UDIEntryType (required): Codes to identify how UDI data was entered. | |||||
| status |
0..1 | code | active | inactive | entered-in-error Binding: DeviceStatusVS (0.12.0) (required) | |||||
| availabilityStatus |
0..1 | CodeableConcept | lost | damaged | destroyed | available Binding: DeviceAvailabilityStatusVS (0.12.0) (extensible) | |||||
| biologicalSourceEvent |
0..1 | Identifier | An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled | |||||
| manufacturer |
0..1 | string | Name of device manufacturer | |||||
| manufactureDate |
0..1 | dateTime | Date when the device was made | |||||
| expirationDate |
0..1 | dateTime | Date and time of expiry of this device (if applicable) | |||||
| lotNumber |
0..1 | string | Lot number of manufacture | |||||
| serialNumber |
0..1 | string | Serial number assigned by the manufacturer | |||||
| name |
C | 0..* | BackboneElement | The name or names of the device as known to the manufacturer and/or patient | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||
| value |
1..1 | string | The term that names the device | |||||
| type |
1..1 | code | registered-name | user-friendly-name | patient-reported-name Binding: DeviceNameTypeVS (0.12.0) (required) | |||||
| display |
C | 0..1 | boolean | The preferred device name | ||||
| modelNumber |
0..1 | string | The manufacturer's model number for the device | |||||
| partNumber |
0..1 | string | The part number or catalog number of the device | |||||
| category |
0..* | CodeableConcept | Indicates a high-level grouping of the device Binding: DeviceCategoryVS (0.12.0) (preferred) | |||||
| type |
0..* | CodeableConcept | The kind or type of device Binding: DeviceTypeVS (0.12.0) (preferred) | |||||
| version |
0..* | BackboneElement | The actual design of the device or software version running on the device | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||
| type |
0..1 | CodeableConcept | The type of the device version, e.g. manufacturer, approved, internal Binding: DeviceVersionType (example): The type of version indicated for the device. | |||||
| component |
0..1 | Identifier | The hardware or software module of the device to which the version applies | |||||
| installDate |
0..1 | dateTime | The date the version was installed on the device | |||||
| value |
1..1 | string | The version text | |||||
| conformsTo |
0..* | BackboneElement | Identifies the standards, specifications, or formal guidances for the capabilities supported by the device | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||
| category |
0..1 | CodeableConcept | Describes the common type of the standard, specification, or formal guidance. communication | performance | measurement Binding: DeviceSpecificationCategory (example): The kind of standards used by the device. | |||||
| specification |
1..1 | CodeableConcept | Identifies the standard, specification, or formal guidance that the device adheres to Binding: DeviceSpecificationType (example): The type of version indicated for the device. | |||||
| version |
0..1 | string | Specific form or variant of the standard | |||||
| property |
0..* | BackboneElement | Inherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||
| type |
1..1 | CodeableConcept | Code that specifies the property being represented Binding: DeviceType (example): Device property type. | |||||
  value[x] |
1..1 | Value of the property | ||||||
 valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueRange |
Range | |||||||
| valueAttachment |
Attachment | |||||||
| mode |
0..1 | CodeableConcept | The designated condition for performing a task Binding: FHIRDeviceOperationMode (example): Operational mode of a device. | |||||
| cycle |
0..1 | Count | The series of occurrences that repeats during the operation of the device | |||||
| duration |
0..1 | Duration | A measurement of time during the device's operation (e.g., days, hours, mins, etc.) | |||||
| owner |
0..1 | Reference(UZ Core Organization(0.12.0)) | Organization responsible for device | |||||
| contact |
0..* | ContactPoint | Details for human/organization for support | |||||
| location |
0..1 | Reference(UZ Core Location(0.12.0)) | Where the device is found | |||||
| url |
0..1 | uri | Network address to contact device | |||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services provided by the device | |||||
| gateway |
0..* | CodeableReference(Device) | Linked device acting as a communication/data collector, translator or controller | |||||
| note |
0..* | Annotation | Device notes and comments | |||||
| safety |
0..* | CodeableConcept | Safety Characteristics of Device Binding: DeviceSafety (example) | |||||
| parent |
0..1 | Reference(Device) | The higher level or encompassing device that this device is a logical part of | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Device.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Device.udiCarrier.entryType | Base | required | UDI Entry Type | 📍5.0.0 | FHIR Std. |
| Device.status | Base | required | Device status | 📍0.12.0 | This IG |
| Device.availabilityStatus | Base | extensible | Device availability status | 📍0.12.0 | This IG |
| Device.name.type | Base | required | Device name type | 📍0.12.0 | This IG |
| Device.category | Base | preferred | Device category | 📍0.12.0 | This IG |
| Device.type | Base | preferred | Device type | 📍0.12.0 | This IG |
| Device.version.type | Base | example | Device Version Type | 📍5.0.0 | FHIR Std. |
| Device.conformsTo.category | Base | example | Device Specification Category | 📍5.0.0 | FHIR Std. |
| Device.conformsTo.specification | Base | example | Device Specification Type | 📍5.0.0 | FHIR Std. |
| Device.property.type | Base | example | Device Property Type | 📍5.0.0 | FHIR Std. |
| Device.mode | Base | example | FHIR Device Operation Mode | 📍5.0.0 | FHIR Std. |
| Device.safety | Base | example | Device Safety | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Device
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Device |
C | 0..* | Device(5.0.0) | Item used in healthcare Constraints: dev-1 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| contained |
0..* | Resource | Contained, inline Resources | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | |
| identifier |
0..* | Identifier | Instance identifier | |
| displayName |
0..1 | string | The name used to display by default when the device is referenced | |
| status |
0..1 | code | active | inactive | entered-in-error Binding: DeviceStatusVS (0.12.0) (required) | |
| availabilityStatus |
0..1 | CodeableConcept | lost | damaged | destroyed | available Binding: DeviceAvailabilityStatusVS (0.12.0) (extensible) | |
| manufacturer |
0..1 | string | Name of device manufacturer | |
| manufactureDate |
0..1 | dateTime | Date when the device was made | |
| expirationDate |
0..1 | dateTime | Date and time of expiry of this device (if applicable) | |
| lotNumber |
0..1 | string | Lot number of manufacture | |
| serialNumber |
0..1 | string | Serial number assigned by the manufacturer | |
| name |
C | 0..* | BackboneElement | The name or names of the device as known to the manufacturer and/or patient |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |
| value |
1..1 | string | The term that names the device | |
| type |
1..1 | code | registered-name | user-friendly-name | patient-reported-name Binding: DeviceNameTypeVS (0.12.0) (required) | |
| display |
C | 0..1 | boolean | The preferred device name |
| modelNumber |
0..1 | string | The manufacturer's model number for the device | |
| partNumber |
0..1 | string | The part number or catalog number of the device | |
| category |
0..* | CodeableConcept | Indicates a high-level grouping of the device Binding: DeviceCategoryVS (0.12.0) (preferred) | |
| type |
0..* | CodeableConcept | The kind or type of device Binding: DeviceTypeVS (0.12.0) (preferred) | |
| owner |
0..1 | Reference(UZ Core Organization(0.12.0)) | Organization responsible for device | |
| contact |
0..* | ContactPoint | Details for human/organization for support | |
| location |
0..1 | Reference(UZ Core Location(0.12.0)) | Where the device is found | |
| note |
0..* | Annotation | Device notes and comments | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Device.status | Base | required | Device status | 📍0.12.0 | This IG |
| Device.availabilityStatus | Base | extensible | Device availability status | 📍0.12.0 | This IG |
| Device.name.type | Base | required | Device name type | 📍0.12.0 | This IG |
| Device.category | Base | preferred | Device category | 📍0.12.0 | This IG |
| Device.type | Base | preferred | Device type | 📍0.12.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from Device
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Device |
0..* | Device(5.0.0) | Item used in healthcare | |
| identifier |
0..* | Identifier | Instance identifier | |
| displayName |
0..1 | string | The name used to display by default when the device is referenced | |
| status |
0..1 | code | active | inactive | entered-in-error Binding: DeviceStatusVS (0.12.0) (required) | |
| availabilityStatus |
0..1 | CodeableConcept | lost | damaged | destroyed | available Binding: DeviceAvailabilityStatusVS (0.12.0) (extensible) | |
| manufacturer |
0..1 | string | Name of device manufacturer | |
| manufactureDate |
0..1 | dateTime | Date when the device was made | |
| expirationDate |
0..1 | dateTime | Date and time of expiry of this device (if applicable) | |
| lotNumber |
0..1 | string | Lot number of manufacture | |
| serialNumber |
0..1 | string | Serial number assigned by the manufacturer | |
| name |
0..* | BackboneElement | The name or names of the device as known to the manufacturer and/or patient | |
| value |
1..1 | string | The term that names the device | |
| type |
1..1 | code | registered-name | user-friendly-name | patient-reported-name Binding: DeviceNameTypeVS (0.12.0) (required) | |
| display |
0..1 | boolean | The preferred device name | |
| modelNumber |
0..1 | string | The manufacturer's model number for the device | |
| partNumber |
0..1 | string | The part number or catalog number of the device | |
| category |
0..* | CodeableConcept | Indicates a high-level grouping of the device Binding: DeviceCategoryVS (0.12.0) (preferred) | |
| type |
0..* | CodeableConcept | The kind or type of device Binding: DeviceTypeVS (0.12.0) (preferred) | |
| owner |
0..1 | Reference(UZ Core Organization(0.12.0)) | Organization responsible for device | |
| contact |
0..* | ContactPoint | Details for human/organization for support | |
| location |
0..1 | Reference(UZ Core Location(0.12.0)) | Where the device is found | |
| note |
0..* | Annotation | Device notes and comments | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Device.status | Base | required | Device status | 📍0.12.0 | This IG |
| Device.availabilityStatus | Base | extensible | Device availability status | 📍0.12.0 | This IG |
| Device.name.type | Base | required | Device name type | 📍0.12.0 | This IG |
| Device.category | Base | preferred | Device category | 📍0.12.0 | This IG |
| Device.type | Base | preferred | Device type | 📍0.12.0 | This IG |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Device |
C | 0..* | Device(5.0.0) | Item used in healthcare Constraints: dev-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: AllLanguages (required): IETF language tag for 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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | |||||
| identifier |
0..* | Identifier | Instance identifier | |||||
| displayName |
0..1 | string | The name used to display by default when the device is referenced | |||||
| definition |
0..1 | CodeableReference(DeviceDefinition) | The reference to the definition for the device | |||||
| udiCarrier |
0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||
| deviceIdentifier |
1..1 | string | Mandatory fixed portion of UDI | |||||
| issuer |
1..1 | uri | UDI Issuing Organization | |||||
| jurisdiction |
0..1 | uri | Regional UDI authority | |||||
| carrierAIDC |
0..1 | base64Binary | UDI Machine Readable Barcode String | |||||
| carrierHRF |
0..1 | string | UDI Human Readable Barcode String | |||||
| entryType |
0..1 | code | barcode | rfid | manual | card | self-reported | electronic-transmission | unknown Binding: UDIEntryType (required): Codes to identify how UDI data was entered. | |||||
| status |
0..1 | code | active | inactive | entered-in-error Binding: DeviceStatusVS (0.12.0) (required) | |||||
| availabilityStatus |
0..1 | CodeableConcept | lost | damaged | destroyed | available Binding: DeviceAvailabilityStatusVS (0.12.0) (extensible) | |||||
| biologicalSourceEvent |
0..1 | Identifier | An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled | |||||
| manufacturer |
0..1 | string | Name of device manufacturer | |||||
| manufactureDate |
0..1 | dateTime | Date when the device was made | |||||
| expirationDate |
0..1 | dateTime | Date and time of expiry of this device (if applicable) | |||||
| lotNumber |
0..1 | string | Lot number of manufacture | |||||
| serialNumber |
0..1 | string | Serial number assigned by the manufacturer | |||||
| name |
C | 0..* | BackboneElement | The name or names of the device as known to the manufacturer and/or patient | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||
| value |
1..1 | string | The term that names the device | |||||
| type |
1..1 | code | registered-name | user-friendly-name | patient-reported-name Binding: DeviceNameTypeVS (0.12.0) (required) | |||||
| display |
C | 0..1 | boolean | The preferred device name | ||||
| modelNumber |
0..1 | string | The manufacturer's model number for the device | |||||
| partNumber |
0..1 | string | The part number or catalog number of the device | |||||
| category |
0..* | CodeableConcept | Indicates a high-level grouping of the device Binding: DeviceCategoryVS (0.12.0) (preferred) | |||||
| type |
0..* | CodeableConcept | The kind or type of device Binding: DeviceTypeVS (0.12.0) (preferred) | |||||
| version |
0..* | BackboneElement | The actual design of the device or software version running on the device | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||
| type |
0..1 | CodeableConcept | The type of the device version, e.g. manufacturer, approved, internal Binding: DeviceVersionType (example): The type of version indicated for the device. | |||||
| component |
0..1 | Identifier | The hardware or software module of the device to which the version applies | |||||
| installDate |
0..1 | dateTime | The date the version was installed on the device | |||||
| value |
1..1 | string | The version text | |||||
| conformsTo |
0..* | BackboneElement | Identifies the standards, specifications, or formal guidances for the capabilities supported by the device | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||
| category |
0..1 | CodeableConcept | Describes the common type of the standard, specification, or formal guidance. communication | performance | measurement Binding: DeviceSpecificationCategory (example): The kind of standards used by the device. | |||||
| specification |
1..1 | CodeableConcept | Identifies the standard, specification, or formal guidance that the device adheres to Binding: DeviceSpecificationType (example): The type of version indicated for the device. | |||||
| version |
0..1 | string | Specific form or variant of the standard | |||||
| property |
0..* | BackboneElement | Inherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||
| type |
1..1 | CodeableConcept | Code that specifies the property being represented Binding: DeviceType (example): Device property type. | |||||
| value[x] |
1..1 | Value of the property | ||||||
| valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueRange |
Range | |||||||
| valueAttachment |
Attachment | |||||||
| mode |
0..1 | CodeableConcept | The designated condition for performing a task Binding: FHIRDeviceOperationMode (example): Operational mode of a device. | |||||
| cycle |
0..1 | Count | The series of occurrences that repeats during the operation of the device | |||||
| duration |
0..1 | Duration | A measurement of time during the device's operation (e.g., days, hours, mins, etc.) | |||||
| owner |
0..1 | Reference(UZ Core Organization(0.12.0)) | Organization responsible for device | |||||
| contact |
0..* | ContactPoint | Details for human/organization for support | |||||
| location |
0..1 | Reference(UZ Core Location(0.12.0)) | Where the device is found | |||||
| url |
0..1 | uri | Network address to contact device | |||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services provided by the device | |||||
| gateway |
0..* | CodeableReference(Device) | Linked device acting as a communication/data collector, translator or controller | |||||
| note |
0..* | Annotation | Device notes and comments | |||||
| safety |
0..* | CodeableConcept | Safety Characteristics of Device Binding: DeviceSafety (example) | |||||
| parent |
0..1 | Reference(Device) | The higher level or encompassing device that this device is a logical part of | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Device.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Device.udiCarrier.entryType | Base | required | UDI Entry Type | 📍5.0.0 | FHIR Std. |
| Device.status | Base | required | Device status | 📍0.12.0 | This IG |
| Device.availabilityStatus | Base | extensible | Device availability status | 📍0.12.0 | This IG |
| Device.name.type | Base | required | Device name type | 📍0.12.0 | This IG |
| Device.category | Base | preferred | Device category | 📍0.12.0 | This IG |
| Device.type | Base | preferred | Device type | 📍0.12.0 | This IG |
| Device.version.type | Base | example | Device Version Type | 📍5.0.0 | FHIR Std. |
| Device.conformsTo.category | Base | example | Device Specification Category | 📍5.0.0 | FHIR Std. |
| Device.conformsTo.specification | Base | example | Device Specification Type | 📍5.0.0 | FHIR Std. |
| Device.property.type | Base | example | Device Property Type | 📍5.0.0 | FHIR Std. |
| Device.mode | Base | example | FHIR Device Operation Mode | 📍5.0.0 | FHIR Std. |
| Device.safety | Base | example | Device Safety | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Device
Other representations of profile: CSV, Excel, Schematron
Common API interactions for this profile. Requests require a JWT access token - see Security and authentication. [base] is the FHIR server base URL; | separates a code system from its value and must be URL-encoded as %7C.
Read a device by server id
GET [base]/Device/[id]
Find a device before registering it (the usual first step)
GET [base]/Device?serial-number=SN-2023-001456
GET [base]/Device?type=http://snomed.info/sct%7C54953005&organization=Organization/[id]
Other useful searches
GET [base]/Device?organization=Organization/[id]&status=active
GET [base]/Device?location=Location/[id]
GET [base]/Device?manufacturer=Siemens Healthineers&model=SOMATOM Edge
GET [base]/Device?device-name=SOMATOM
GET [base]/Device?lot-number=CU-2025-0412
GET [base]/Device?expiration-date=le2026-12-31
Register a new device (only after confirming no match exists)
POST [base]/Device
{
"resourceType": "Device",
"meta": { "profile": [ "https://dhp.uz/fhir/core/StructureDefinition/uz-core-device" ] },
"status": "active",
"type": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "54953005" } ] } ],
"serialNumber": "...",
...
}
Update an existing device (e.g. set availabilityStatus to damaged, or status to inactive when the device is withdrawn)
PUT [base]/Device/[id]
If-Match: W/"3" # the ETag from your last read; 412 if it changed since
{
"resourceType": "Device",
"id": "[id]",
"meta": { "profile": [ "https://dhp.uz/fhir/core/StructureDefinition/uz-core-device" ] },
...
}
See the CapabilityStatement for the full list of supported search parameters.