Uzbekistan Digital Health Platform
0.12.0 - ci-build Uzbekistan flag

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

Resource Profile: UZ Core DeviceUsage ( Experimental )

Official URL: https://dhp.uz/fhir/core/StructureDefinition/uz-core-deviceusage Version: 0.12.0
Draft as of 2026-10-30 Computable Name: UZCoreDeviceUsage

Uzbekistan Core DeviceUsage profile, used to record that a patient is using, has used or will use a device

UZ Core DeviceUsage records that a patient is using, has used or will use a device - an insulin pump, a hearing aid, a wheelchair, an intrauterine device. It is a statement: who reported the use, when, how regularly the device is actually used, and why it is used. It does not describe the device itself; the device is given as a SNOMED CT concept, or as a reference to a UZ Core Device or a DeviceDefinition. A DeviceUsage may fulfil a ServiceRequest that ordered the device, and its reason can point to a Condition, Observation or DiagnosticReport. The use is reported by the patient, a practitioner or practitioner role, a related person or an organization.

Mandatory and Must Support data elements

The elements below must always be present (mandatory) or must be supported when the data is available (Must Support) - not all 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.

Each UZ Core DeviceUsage Must Have

This profile adds no mandatory elements of its own. The base DeviceUsage resource requires three:

  1. a status of the statement, from the device usage status value set (required binding);
  2. the patient - a reference to a UZ Core Patient;
  3. the device - a coded device concept or a reference to a UZ Core Device or a DeviceDefinition.

Each UZ Core DeviceUsage Must Support

  • an identifier for the statement, always sent with its system;
  • basedOn - the ServiceRequest that ordered the device;
  • category - the setting of the use, from the device usage category value set (preferred binding);
  • timing[x] - when the device is used: a dateTime, a Period or a Timing;
  • dateAsserted - when the statement was made;
  • usageStatus and usageReason - the status of the use itself, as opposed to the status of the statement, and why it has that status;
  • adherence - how regularly the device is used (adherence codes), with a reason (adherence reasons) (preferred bindings);
  • informationSource - who reported the use: Patient, Practitioner, PractitionerRole, RelatedPerson or Organization, all UZ Core profiles;
  • reason - why the device is used, as a concept or a reference to a UZ Core Condition, Observation or DiagnosticReport;
  • bodySite - where on the body the device is used, from the body site value set (preferred binding);
  • note.

Building the JSON, step by step

The examples below go from the smallest instance the server will accept to a statement that records adherence. Copy one and adapt it - every value shown validates against this profile. The complete reference instances are linked at the bottom of the page (active use, usage period, reference to a UZ Core Device).

The smallest DeviceUsage you should send

status, patient and device are the only mandatory elements. Every UZ Core resource must also name the profile it claims to conform to in meta.profile - that is how the server knows which rules to validate against:

{
  "resourceType": "DeviceUsage",
  "meta": { "profile": ["https://dhp.uz/fhir/core/StructureDefinition/uz-core-deviceusage"] },
  "language": "en",
  "status": "active",
  "patient": { "reference": "Patient/example-salim" },
  "device": {
    "concept": {
      "coding": [{ "system": "http://snomed.info/sct", "code": "69805005", "display": "Insulin pump" }]
    }
  }
}

status describes the statement, not the device: active means the patient is still using it, completed that the use has ended, intended that it is planned, and entered-in-error withdraws a wrong statement. device is a CodeableReference - a SNOMED CT device concept goes under concept, and a reference to a UZ Core Device or DeviceDefinition goes one level deeper ({ "reference": { "reference": "Device/id" } }). See References and CodeableReferences for the distinction.

A recorded device use

In practice a clinician records when the use started, why the device is used and where it sits on the body. timingPeriod with only a start says the use is ongoing; add an end and set status to completed when it stops. dateAsserted is when the statement was made, and informationSource is who made it:

{
  "resourceType": "DeviceUsage",
  "meta": { "profile": ["https://dhp.uz/fhir/core/StructureDefinition/uz-core-deviceusage"] },
  "language": "en",
  "status": "active",
  "patient": { "reference": "Patient/example-salim" },
  "timingPeriod": { "start": "2025-03-10" },
  "dateAsserted": "2026-09-15T10:30:00+05:00",
  "informationSource": { "reference": "Practitioner/example-practitioner" },
  "device": {
    "concept": {
      "coding": [{ "system": "http://snomed.info/sct", "code": "69805005", "display": "Insulin pump" }]
    }
  },
  "reason": [{
    "concept": {
      "coding": [{ "system": "http://snomed.info/sct", "code": "46635009", "display": "Type 1 diabetes mellitus" }]
    }
  }],
  "bodySite": {
    "concept": {
      "coding": [{ "system": "http://snomed.info/sct", "code": "75093004", "display": "Skin structure of abdomen" }]
    }
  },
  "note": [{ "text": "Infusion set changed every 3 days; site rotated around the abdomen." }]
}

reason and bodySite are also CodeableReferences. Here the indication is a coded concept; when the diagnosis is already recorded, point to it instead with { "reference": { "reference": "Condition/id" } }. When the device was ordered, add basedOn with a reference to the ServiceRequest, and category for the setting of the use.

Recording adherence

When the patient reports how regularly the device is actually used, add adherence. Its code (always, sometimes, never) and at least one reason (forgot, lost, broken, stolen …) are both mandatory once adherence is present. usageStatus records the status of the use itself, from the same status codes as status:

{
  "resourceType": "DeviceUsage",
  "meta": { "profile": ["https://dhp.uz/fhir/core/StructureDefinition/uz-core-deviceusage"] },
  "language": "en",
  "status": "active",
  "patient": { "reference": "Patient/example-salim" },
  "dateAsserted": "2026-10-20T09:00:00+05:00",
  "informationSource": { "reference": "Patient/example-salim" },
  "device": {
    "concept": {
      "coding": [{ "system": "http://snomed.info/sct", "code": "69805005", "display": "Insulin pump" }]
    }
  },
  "usageStatus": {
    "coding": [{ "system": "http://hl7.org/fhir/deviceusage-status", "code": "active" }]
  },
  "adherence": {
    "code": {
      "coding": [{ "system": "http://hl7.org/fhir/deviceusage-adherence-code", "code": "sometimes" }]
    },
    "reason": [{
      "coding": [{ "system": "http://hl7.org/fhir/deviceusage-adherence-reason", "code": "forgot" }]
    }]
  }
}

Here the patient reported the use themselves, so informationSource points to the patient. The usageStatus, adherence code and adherence reason codings carry no display: the server fills it in, and the Uzbek and Russian displays come from the code system supplements.

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

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DeviceUsage 0..* DeviceUsage(5.0.0) Record of use of a device
DeviceUsage.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DeviceUsage.contained 0..* Resource Contained, inline Resources
DeviceUsage.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
DeviceUsage.identifier This element must be supported. This element is included in summaries. 0..* Identifier External identifier for this record
DeviceUsage.basedOn This element must be supported. This element is included in summaries. 0..* Reference(UZ Core ServiceRequest(0.12.0)) Fulfills plan, proposal or order
DeviceUsage.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code active | completed | not-done | entered-in-error +
Binding: DeviceUsageStatusVS (0.12.0) (required)
DeviceUsage.category This element must be supported. 0..* CodeableConcept The category of the statement - classifying how the statement is made
Binding: DeviceUsageCategoryVS (0.12.0) (preferred)
DeviceUsage.patient This element must be supported. This element is included in summaries. 1..1 Reference(UZ Core Patient(0.12.0)) Patient using device
DeviceUsage.timing[x] This element must be supported. This element is included in summaries. 0..1 How often the device was used
DeviceUsage.timing[x].timingTiming Timing
DeviceUsage.timing[x].timingPeriod Period
DeviceUsage.timing[x].timingDateTime dateTime
DeviceUsage.dateAsserted This element must be supported. This element is included in summaries. 0..1 dateTime When the statement was made (and recorded)
DeviceUsage.usageStatus This element must be supported. 0..1 CodeableConcept The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement
Binding: DeviceUsageStatusVS (0.12.0) (required)
DeviceUsage.usageReason This element must be supported. 0..* CodeableConcept The reason for asserting the usage status - for example forgot, lost, stolen, broken
DeviceUsage.adherence This element must be supported. 0..1 BackboneElement How device is being used
DeviceUsage.adherence.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
DeviceUsage.adherence.code 1..1 CodeableConcept always | never | sometimes
Binding: DeviceUsageAdherenceCodeVS (0.12.0) (preferred)
DeviceUsage.adherence.reason 1..* CodeableConcept lost | stolen | prescribed | broken | burned | forgot
Binding: DeviceUsageAdherenceReasonVS (0.12.0) (preferred)
DeviceUsage.informationSource This element must be supported. This element is included in summaries. 0..1 Reference(UZ Core Patient(0.12.0) | UZ Core Practitioner(0.12.0) | UZ Core PractitionerRole(0.12.0) | UZ Core RelatedPerson(0.12.0) | UZ Core Organization(0.12.0)) Who made the statement
DeviceUsage.device This element must be supported. This element is included in summaries. 1..1 CodeableReference(UZ Core Device(0.12.0) | DeviceDefinition) Code or Reference to device used
DeviceUsage.reason This element must be supported. This element is included in summaries. 0..* CodeableReference(UZ Core Condition(0.12.0) | UZ Core Observation(0.12.0) | UZ Core DiagnosticReport(0.12.0)) Why device was used
DeviceUsage.bodySite This element must be supported. This element is included in summaries. 0..1 CodeableReference(BodyStructure) Target body site
Binding: BodySiteVS (0.12.0) (preferred)
DeviceUsage.note This element must be supported. 0..* Annotation Addition details (comments, instructions)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DeviceUsage.status Base required DeviceUsage status 📍0.12.0 This IG
DeviceUsage.category Base preferred DeviceUsage category 📍0.12.0 This IG
DeviceUsage.usageStatus Base required DeviceUsage status 📍0.12.0 This IG
DeviceUsage.adherence.​code Base preferred DeviceUsage adherence code 📍0.12.0 This IG
DeviceUsage.adherence.​reason Base preferred DeviceUsage adherence reason 📍0.12.0 This IG
DeviceUsage.bodySite Base preferred Body site 📍0.12.0 This IG

Constraints

Id Grade Path(s) Description Expression

This structure is derived from DeviceUsage

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DeviceUsage 0..* DeviceUsage(5.0.0) Record of use of a device
DeviceUsage.identifier This element must be supported. 0..* Identifier External identifier for this record
DeviceUsage.basedOn This element must be supported. 0..* Reference(UZ Core ServiceRequest(0.12.0)) Fulfills plan, proposal or order
DeviceUsage.status This element must be supported. 1..1 code active | completed | not-done | entered-in-error +
Binding: DeviceUsageStatusVS (0.12.0) (required)
DeviceUsage.patient This element must be supported. 1..1 Reference(UZ Core Patient(0.12.0)) Patient using device
DeviceUsage.timing[x] This element must be supported. 0..1 Timing, Period, dateTime How often the device was used
DeviceUsage.dateAsserted This element must be supported. 0..1 dateTime When the statement was made (and recorded)
DeviceUsage.usageStatus This element must be supported. 0..1 CodeableConcept The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement
Binding: DeviceUsageStatusVS (0.12.0) (required)
DeviceUsage.usageReason This element must be supported. 0..* CodeableConcept The reason for asserting the usage status - for example forgot, lost, stolen, broken
DeviceUsage.adherence This element must be supported. 0..1 BackboneElement How device is being used
DeviceUsage.adherence.code 1..1 CodeableConcept always | never | sometimes
Binding: DeviceUsageAdherenceCodeVS (0.12.0) (preferred)
DeviceUsage.adherence.reason 1..* CodeableConcept lost | stolen | prescribed | broken | burned | forgot
Binding: DeviceUsageAdherenceReasonVS (0.12.0) (preferred)
DeviceUsage.informationSource This element must be supported. 0..1 Reference(UZ Core Patient(0.12.0) | UZ Core Practitioner(0.12.0) | UZ Core PractitionerRole(0.12.0) | UZ Core RelatedPerson(0.12.0) | UZ Core Organization(0.12.0)) Who made the statement
DeviceUsage.device This element must be supported. 1..1 CodeableReference(UZ Core Device(0.12.0) | DeviceDefinition) Code or Reference to device used
DeviceUsage.reason This element must be supported. 0..* CodeableReference(UZ Core Condition(0.12.0) | UZ Core Observation(0.12.0) | UZ Core DiagnosticReport(0.12.0)) Why device was used
DeviceUsage.bodySite This element must be supported. 0..1 CodeableReference(BodyStructure) Target body site
Binding: BodySiteVS (0.12.0) (preferred)
DeviceUsage.note This element must be supported. 0..* Annotation Addition details (comments, instructions)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DeviceUsage.status Base required DeviceUsage status 📍0.12.0 This IG
DeviceUsage.category Base preferred DeviceUsage category 📍0.12.0 This IG
DeviceUsage.usageStatus Base required DeviceUsage status 📍0.12.0 This IG
DeviceUsage.adherence.​code Base preferred DeviceUsage adherence code 📍0.12.0 This IG
DeviceUsage.adherence.​reason Base preferred DeviceUsage adherence reason 📍0.12.0 This IG
DeviceUsage.bodySite Base preferred Body site 📍0.12.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
DeviceUsage 0..* DeviceUsage(5.0.0) Record of use of a device
DeviceUsage.id This element is included in summaries. 0..1 id Logical id of this artifact
DeviceUsage.meta This element is included in summaries. 0..1 Meta Metadata about the resource
DeviceUsage.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DeviceUsage.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
DeviceUsage.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
DeviceUsage.contained 0..* Resource Contained, inline Resources
DeviceUsage.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
DeviceUsage.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
DeviceUsage.identifier This element must be supported. This element is included in summaries. 0..* Identifier External identifier for this record
DeviceUsage.basedOn This element must be supported. This element is included in summaries. 0..* Reference(UZ Core ServiceRequest(0.12.0)) Fulfills plan, proposal or order
DeviceUsage.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code active | completed | not-done | entered-in-error +
Binding: DeviceUsageStatusVS (0.12.0) (required)
DeviceUsage.category This element must be supported. 0..* CodeableConcept The category of the statement - classifying how the statement is made
Binding: DeviceUsageCategoryVS (0.12.0) (preferred)
DeviceUsage.patient This element must be supported. This element is included in summaries. 1..1 Reference(UZ Core Patient(0.12.0)) Patient using device
DeviceUsage.derivedFrom This element is included in summaries. 0..* Reference(ServiceRequest | Procedure | Claim | Observation | QuestionnaireResponse | DocumentReference) Supporting information
DeviceUsage.context This element is included in summaries. 0..1 Reference(Encounter | EpisodeOfCare) The encounter or episode of care that establishes the context for this device use statement
DeviceUsage.timing[x] This element must be supported. This element is included in summaries. 0..1 How often the device was used
DeviceUsage.timing[x].timingTiming Timing
DeviceUsage.timing[x].timingPeriod Period
DeviceUsage.timing[x].timingDateTime dateTime
DeviceUsage.dateAsserted This element must be supported. This element is included in summaries. 0..1 dateTime When the statement was made (and recorded)
DeviceUsage.usageStatus This element must be supported. 0..1 CodeableConcept The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement
Binding: DeviceUsageStatusVS (0.12.0) (required)
DeviceUsage.usageReason This element must be supported. 0..* CodeableConcept The reason for asserting the usage status - for example forgot, lost, stolen, broken
DeviceUsage.adherence This element must be supported. 0..1 BackboneElement How device is being used
DeviceUsage.adherence.id 0..1 string Unique id for inter-element referencing
DeviceUsage.adherence.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
DeviceUsage.adherence.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
DeviceUsage.adherence.code 1..1 CodeableConcept always | never | sometimes
Binding: DeviceUsageAdherenceCodeVS (0.12.0) (preferred)
DeviceUsage.adherence.reason 1..* CodeableConcept lost | stolen | prescribed | broken | burned | forgot
Binding: DeviceUsageAdherenceReasonVS (0.12.0) (preferred)
DeviceUsage.informationSource This element must be supported. This element is included in summaries. 0..1 Reference(UZ Core Patient(0.12.0) | UZ Core Practitioner(0.12.0) | UZ Core PractitionerRole(0.12.0) | UZ Core RelatedPerson(0.12.0) | UZ Core Organization(0.12.0)) Who made the statement
DeviceUsage.device This element must be supported. This element is included in summaries. 1..1 CodeableReference(UZ Core Device(0.12.0) | DeviceDefinition) Code or Reference to device used
DeviceUsage.reason This element must be supported. This element is included in summaries. 0..* CodeableReference(UZ Core Condition(0.12.0) | UZ Core Observation(0.12.0) | UZ Core DiagnosticReport(0.12.0)) Why device was used
DeviceUsage.bodySite This element must be supported. This element is included in summaries. 0..1 CodeableReference(BodyStructure) Target body site
Binding: BodySiteVS (0.12.0) (preferred)
DeviceUsage.note This element must be supported. 0..* Annotation Addition details (comments, instructions)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DeviceUsage.language Base required All Languages 📍5.0.0 FHIR Std.
DeviceUsage.status Base required DeviceUsage status 📍0.12.0 This IG
DeviceUsage.category Base preferred DeviceUsage category 📍0.12.0 This IG
DeviceUsage.usageStatus Base required DeviceUsage status 📍0.12.0 This IG
DeviceUsage.adherence.​code Base preferred DeviceUsage adherence code 📍0.12.0 This IG
DeviceUsage.adherence.​reason Base preferred DeviceUsage adherence reason 📍0.12.0 This IG
DeviceUsage.bodySite Base preferred Body site 📍0.12.0 This IG

Constraints

Id Grade Path(s) Description Expression

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DeviceUsage 0..* DeviceUsage(5.0.0) Record of use of a device
DeviceUsage.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DeviceUsage.contained 0..* Resource Contained, inline Resources
DeviceUsage.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
DeviceUsage.identifier This element must be supported. This element is included in summaries. 0..* Identifier External identifier for this record
DeviceUsage.basedOn This element must be supported. This element is included in summaries. 0..* Reference(UZ Core ServiceRequest(0.12.0)) Fulfills plan, proposal or order
DeviceUsage.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code active | completed | not-done | entered-in-error +
Binding: DeviceUsageStatusVS (0.12.0) (required)
DeviceUsage.category This element must be supported. 0..* CodeableConcept The category of the statement - classifying how the statement is made
Binding: DeviceUsageCategoryVS (0.12.0) (preferred)
DeviceUsage.patient This element must be supported. This element is included in summaries. 1..1 Reference(UZ Core Patient(0.12.0)) Patient using device
DeviceUsage.timing[x] This element must be supported. This element is included in summaries. 0..1 How often the device was used
DeviceUsage.timing[x].timingTiming Timing
DeviceUsage.timing[x].timingPeriod Period
DeviceUsage.timing[x].timingDateTime dateTime
DeviceUsage.dateAsserted This element must be supported. This element is included in summaries. 0..1 dateTime When the statement was made (and recorded)
DeviceUsage.usageStatus This element must be supported. 0..1 CodeableConcept The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement
Binding: DeviceUsageStatusVS (0.12.0) (required)
DeviceUsage.usageReason This element must be supported. 0..* CodeableConcept The reason for asserting the usage status - for example forgot, lost, stolen, broken
DeviceUsage.adherence This element must be supported. 0..1 BackboneElement How device is being used
DeviceUsage.adherence.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
DeviceUsage.adherence.code 1..1 CodeableConcept always | never | sometimes
Binding: DeviceUsageAdherenceCodeVS (0.12.0) (preferred)
DeviceUsage.adherence.reason 1..* CodeableConcept lost | stolen | prescribed | broken | burned | forgot
Binding: DeviceUsageAdherenceReasonVS (0.12.0) (preferred)
DeviceUsage.informationSource This element must be supported. This element is included in summaries. 0..1 Reference(UZ Core Patient(0.12.0) | UZ Core Practitioner(0.12.0) | UZ Core PractitionerRole(0.12.0) | UZ Core RelatedPerson(0.12.0) | UZ Core Organization(0.12.0)) Who made the statement
DeviceUsage.device This element must be supported. This element is included in summaries. 1..1 CodeableReference(UZ Core Device(0.12.0) | DeviceDefinition) Code or Reference to device used
DeviceUsage.reason This element must be supported. This element is included in summaries. 0..* CodeableReference(UZ Core Condition(0.12.0) | UZ Core Observation(0.12.0) | UZ Core DiagnosticReport(0.12.0)) Why device was used
DeviceUsage.bodySite This element must be supported. This element is included in summaries. 0..1 CodeableReference(BodyStructure) Target body site
Binding: BodySiteVS (0.12.0) (preferred)
DeviceUsage.note This element must be supported. 0..* Annotation Addition details (comments, instructions)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DeviceUsage.status Base required DeviceUsage status 📍0.12.0 This IG
DeviceUsage.category Base preferred DeviceUsage category 📍0.12.0 This IG
DeviceUsage.usageStatus Base required DeviceUsage status 📍0.12.0 This IG
DeviceUsage.adherence.​code Base preferred DeviceUsage adherence code 📍0.12.0 This IG
DeviceUsage.adherence.​reason Base preferred DeviceUsage adherence reason 📍0.12.0 This IG
DeviceUsage.bodySite Base preferred Body site 📍0.12.0 This IG

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from DeviceUsage

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DeviceUsage 0..* DeviceUsage(5.0.0) Record of use of a device
DeviceUsage.identifier This element must be supported. 0..* Identifier External identifier for this record
DeviceUsage.basedOn This element must be supported. 0..* Reference(UZ Core ServiceRequest(0.12.0)) Fulfills plan, proposal or order
DeviceUsage.status This element must be supported. 1..1 code active | completed | not-done | entered-in-error +
Binding: DeviceUsageStatusVS (0.12.0) (required)
DeviceUsage.category This element must be supported. 0..* CodeableConcept The category of the statement - classifying how the statement is made
Binding: DeviceUsageCategoryVS (0.12.0) (preferred)
DeviceUsage.patient This element must be supported. 1..1 Reference(UZ Core Patient(0.12.0)) Patient using device
DeviceUsage.timing[x] This element must be supported. 0..1 Timing, Period, dateTime How often the device was used
DeviceUsage.dateAsserted This element must be supported. 0..1 dateTime When the statement was made (and recorded)
DeviceUsage.usageStatus This element must be supported. 0..1 CodeableConcept The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement
Binding: DeviceUsageStatusVS (0.12.0) (required)
DeviceUsage.usageReason This element must be supported. 0..* CodeableConcept The reason for asserting the usage status - for example forgot, lost, stolen, broken
DeviceUsage.adherence This element must be supported. 0..1 BackboneElement How device is being used
DeviceUsage.adherence.code 1..1 CodeableConcept always | never | sometimes
Binding: DeviceUsageAdherenceCodeVS (0.12.0) (preferred)
DeviceUsage.adherence.reason 1..* CodeableConcept lost | stolen | prescribed | broken | burned | forgot
Binding: DeviceUsageAdherenceReasonVS (0.12.0) (preferred)
DeviceUsage.informationSource This element must be supported. 0..1 Reference(UZ Core Patient(0.12.0) | UZ Core Practitioner(0.12.0) | UZ Core PractitionerRole(0.12.0) | UZ Core RelatedPerson(0.12.0) | UZ Core Organization(0.12.0)) Who made the statement
DeviceUsage.device This element must be supported. 1..1 CodeableReference(UZ Core Device(0.12.0) | DeviceDefinition) Code or Reference to device used
DeviceUsage.reason This element must be supported. 0..* CodeableReference(UZ Core Condition(0.12.0) | UZ Core Observation(0.12.0) | UZ Core DiagnosticReport(0.12.0)) Why device was used
DeviceUsage.bodySite This element must be supported. 0..1 CodeableReference(BodyStructure) Target body site
Binding: BodySiteVS (0.12.0) (preferred)
DeviceUsage.note This element must be supported. 0..* Annotation Addition details (comments, instructions)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DeviceUsage.status Base required DeviceUsage status 📍0.12.0 This IG
DeviceUsage.category Base preferred DeviceUsage category 📍0.12.0 This IG
DeviceUsage.usageStatus Base required DeviceUsage status 📍0.12.0 This IG
DeviceUsage.adherence.​code Base preferred DeviceUsage adherence code 📍0.12.0 This IG
DeviceUsage.adherence.​reason Base preferred DeviceUsage adherence reason 📍0.12.0 This IG
DeviceUsage.bodySite Base preferred Body site 📍0.12.0 This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DeviceUsage 0..* DeviceUsage(5.0.0) Record of use of a device
DeviceUsage.id This element is included in summaries. 0..1 id Logical id of this artifact
DeviceUsage.meta This element is included in summaries. 0..1 Meta Metadata about the resource
DeviceUsage.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DeviceUsage.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
DeviceUsage.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
DeviceUsage.contained 0..* Resource Contained, inline Resources
DeviceUsage.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
DeviceUsage.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
DeviceUsage.identifier This element must be supported. This element is included in summaries. 0..* Identifier External identifier for this record
DeviceUsage.basedOn This element must be supported. This element is included in summaries. 0..* Reference(UZ Core ServiceRequest(0.12.0)) Fulfills plan, proposal or order
DeviceUsage.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code active | completed | not-done | entered-in-error +
Binding: DeviceUsageStatusVS (0.12.0) (required)
DeviceUsage.category This element must be supported. 0..* CodeableConcept The category of the statement - classifying how the statement is made
Binding: DeviceUsageCategoryVS (0.12.0) (preferred)
DeviceUsage.patient This element must be supported. This element is included in summaries. 1..1 Reference(UZ Core Patient(0.12.0)) Patient using device
DeviceUsage.derivedFrom This element is included in summaries. 0..* Reference(ServiceRequest | Procedure | Claim | Observation | QuestionnaireResponse | DocumentReference) Supporting information
DeviceUsage.context This element is included in summaries. 0..1 Reference(Encounter | EpisodeOfCare) The encounter or episode of care that establishes the context for this device use statement
DeviceUsage.timing[x] This element must be supported. This element is included in summaries. 0..1 How often the device was used
DeviceUsage.timing[x].timingTiming Timing
DeviceUsage.timing[x].timingPeriod Period
DeviceUsage.timing[x].timingDateTime dateTime
DeviceUsage.dateAsserted This element must be supported. This element is included in summaries. 0..1 dateTime When the statement was made (and recorded)
DeviceUsage.usageStatus This element must be supported. 0..1 CodeableConcept The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement
Binding: DeviceUsageStatusVS (0.12.0) (required)
DeviceUsage.usageReason This element must be supported. 0..* CodeableConcept The reason for asserting the usage status - for example forgot, lost, stolen, broken
DeviceUsage.adherence This element must be supported. 0..1 BackboneElement How device is being used
DeviceUsage.adherence.id 0..1 string Unique id for inter-element referencing
DeviceUsage.adherence.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
DeviceUsage.adherence.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
DeviceUsage.adherence.code 1..1 CodeableConcept always | never | sometimes
Binding: DeviceUsageAdherenceCodeVS (0.12.0) (preferred)
DeviceUsage.adherence.reason 1..* CodeableConcept lost | stolen | prescribed | broken | burned | forgot
Binding: DeviceUsageAdherenceReasonVS (0.12.0) (preferred)
DeviceUsage.informationSource This element must be supported. This element is included in summaries. 0..1 Reference(UZ Core Patient(0.12.0) | UZ Core Practitioner(0.12.0) | UZ Core PractitionerRole(0.12.0) | UZ Core RelatedPerson(0.12.0) | UZ Core Organization(0.12.0)) Who made the statement
DeviceUsage.device This element must be supported. This element is included in summaries. 1..1 CodeableReference(UZ Core Device(0.12.0) | DeviceDefinition) Code or Reference to device used
DeviceUsage.reason This element must be supported. This element is included in summaries. 0..* CodeableReference(UZ Core Condition(0.12.0) | UZ Core Observation(0.12.0) | UZ Core DiagnosticReport(0.12.0)) Why device was used
DeviceUsage.bodySite This element must be supported. This element is included in summaries. 0..1 CodeableReference(BodyStructure) Target body site
Binding: BodySiteVS (0.12.0) (preferred)
DeviceUsage.note This element must be supported. 0..* Annotation Addition details (comments, instructions)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DeviceUsage.language Base required All Languages 📍5.0.0 FHIR Std.
DeviceUsage.status Base required DeviceUsage status 📍0.12.0 This IG
DeviceUsage.category Base preferred DeviceUsage category 📍0.12.0 This IG
DeviceUsage.usageStatus Base required DeviceUsage status 📍0.12.0 This IG
DeviceUsage.adherence.​code Base preferred DeviceUsage adherence code 📍0.12.0 This IG
DeviceUsage.adherence.​reason Base preferred DeviceUsage adherence reason 📍0.12.0 This IG
DeviceUsage.bodySite Base preferred Body site 📍0.12.0 This IG

Constraints

Id Grade Path(s) Description Expression

 

Other representations of profile: CSV, Excel, Schematron

Quick Start

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 code and must be URL-encoded as %7C.

Read by server id

GET [base]/DeviceUsage/[id]

Find a patient's devices

GET [base]/DeviceUsage?patient=Patient/[id]
GET [base]/DeviceUsage?patient=Patient/[id]&status=active
GET [base]/DeviceUsage?patient=Patient/[id]&device=http://snomed.info/sct%7C69805005

device matches the coded concept in device.concept. DeviceUsage is not yet listed in the CapabilityStatement; the searches above are the standard FHIR R5 DeviceUsage search parameters (patient, status, device, identifier).

Create

POST [base]/DeviceUsage
{
  "resourceType": "DeviceUsage",
  "meta": { "profile": [ "https://dhp.uz/fhir/core/StructureDefinition/uz-core-deviceusage" ] },
  "status": "active",
  "patient": { "reference": "Patient/[id]" },
  "device": { "concept": { "coding": [ { "system": "http://snomed.info/sct", "code": "69805005" } ] } },
  ...
}

Update (e.g. the patient stops using the device) - PUT the full resource back with status set to completed or stopped and an end on timingPeriod:

PUT [base]/DeviceUsage/[id]
If-Match: W/"3"   # the ETag from your last read; 412 if it changed since
{
  "resourceType": "DeviceUsage",
  "id": "[id]",
  "meta": { "profile": [ "https://dhp.uz/fhir/core/StructureDefinition/uz-core-deviceusage" ] },
  ...
}

A statement recorded by mistake is not deleted: set its status to entered-in-error.