Release 5 Ballot
WorkflowThis page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
| Orders and Observations Work Group | Maturity Level: 1 | Trial Use | Security Category: Patient | Compartments: Patient |
A record of a device being used by a patient where the record is the result of a report from the patient or a clinician.
This resource is an event resource from a FHIR workflow perspective - see Workflow. It is the intent of the Orders and Observation Workgroup to align this resource with the workflow pattern for event resources.
This resource records the use of a healthcare-related device by a patient. The record is the result of a report of use by the patient, a provider or a related person. The resource can be used to note the use of an assistive device such as a wheelchair or hearing aid, a contraceptive such an intra-uterine device, or other implanted devices such as a pacemaker.
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  DeviceUsage | TU | DomainResource | Record of use of a device Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
  identifier | Σ | 0..* | Identifier | External identifier for this record |
 basedOn | Σ | 0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order |
 status | ?!Σ | 1..1 | code | active | completed | not-done | entered-in-error + DeviceUsageStatus (Required) |
| category | 0..* | CodeableConcept | The category of the statement - classifying how the statement is made | |
| patient | Σ | 1..1 | Reference(Patient) | Patient using device |
| derivedFrom | Σ | 0..* | Reference(ServiceRequest | Procedure | Claim | Observation | QuestionnaireResponse | DocumentReference) | Supporting information |
| context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | The encounter or episode of care that establishes the context for this device use statement |
  timing[x] | Σ | 0..1 | How often the device was used | |
 timingTiming | Timing | |||
| timingPeriod | Period | |||
 timingDateTime | dateTime | |||
| dateAsserted | Σ | 0..1 | dateTime | When the statement was made (and recorded) |
| usageStatus | 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 DeviceUsageStatus (Required) | |
| usageReason | 0..* | CodeableConcept | The reason for asserting the usage status - for example forgot, lost, stolen, broken | |
 adherence | 0..1 | BackboneElement | How device is being used | |
| code | 1..1 | CodeableConcept | always | never | sometimes DeviceUsageAdherenceCode (Example) | |
| reason | 1..* | CodeableConcept | lost | stolen | prescribed | broken | burned | forgot DeviceUsageAdherenceReason (Example) | |
| informationSource | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Who made the statement |
| device | Σ | 1..1 | CodeableReference(Device | DeviceDefinition) | Code or Reference to device used |
| reason | Σ | 0..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | Procedure) | Why device was used |
| bodySite | Σ | 0..1 | CodeableReference(BodyStructure) | Target body site SNOMED CT Body Structures (Example) |
| note | 0..* | Annotation | Addition details (comments, instructions) | |
| Documentation for this format | ||||
See the Extensions for this resource
UML Diagram (Legend)
XML Template
<DeviceUsage xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier External identifier for this record --></identifier> <basedOn><!-- 0..* Reference(ServiceRequest) Fulfills plan, proposal or order --></basedOn> <status value="[code]"/><!-- 1..1 active | completed | not-done | entered-in-error + --> <category><!-- 0..* CodeableConcept The category of the statement - classifying how the statement is made --></category> <patient><!-- 1..1 Reference(Patient) Patient using device --></patient> <derivedFrom><!-- 0..* Reference(Claim|DocumentReference|Observation|Procedure| QuestionnaireResponse|ServiceRequest) Supporting information --></derivedFrom> <context><!-- 0..1 Reference(Encounter|EpisodeOfCare) The encounter or episode of care that establishes the context for this device use statement --></context> <timing[x]><!-- 0..1 Timing|Period|dateTime How often the device was used --></timing[x]> <dateAsserted value="[dateTime]"/><!-- 0..1 When the statement was made (and recorded) --> <usageStatus><!-- 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 --></usageStatus> <usageReason><!-- 0..* CodeableConcept The reason for asserting the usage status - for example forgot, lost, stolen, broken --></usageReason> <adherence> <!-- 0..1 How device is being used --> <code><!-- 1..1 CodeableConcept always | never | sometimes --></code> <reason><!-- 1..* CodeableConcept lost | stolen | prescribed | broken | burned | forgot --></reason> </adherence> <informationSource><!-- 0..1 Reference(Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) Who made the statement --></informationSource> <device><!-- 1..1 CodeableReference(Device|DeviceDefinition) Code or Reference to device used --></device> <reason><!-- 0..* CodeableReference(Condition|DiagnosticReport|DocumentReference| Observation|Procedure) Why device was used --></reason> <bodySite><!-- 0..1 CodeableReference(BodyStructure) Target body site --></bodySite> <note><!-- 0..* Annotation Addition details (comments, instructions) --></note> </DeviceUsage>
JSON Template
{
"resourceType" : "DeviceUsage",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // External identifier for this record
"basedOn" : [{ Reference(ServiceRequest) }], // Fulfills plan, proposal or order
"status" : "<code>", // R! active | completed | not-done | entered-in-error +
"category" : [{ CodeableConcept }], // The category of the statement - classifying how the statement is made
"patient" : { Reference(Patient) }, // R! Patient using device
"derivedFrom" : [{ Reference(Claim|DocumentReference|Observation|Procedure|
QuestionnaireResponse|ServiceRequest) }], // Supporting information
"context" : { Reference(Encounter|EpisodeOfCare) }, // The encounter or episode of care that establishes the context for this device use statement
// timing[x]: How often the device was used. One of these 3:
"timingTiming" : { Timing },
"timingPeriod" : { Period },
"timingDateTime" : "<dateTime>",
"dateAsserted" : "<dateTime>", // When the statement was made (and recorded)
"usageStatus" : { CodeableConcept }, // The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement
"usageReason" : [{ CodeableConcept }], // The reason for asserting the usage status - for example forgot, lost, stolen, broken
"adherence" : { // How device is being used
"code" : { CodeableConcept }, // R! always | never | sometimes
"reason" : [{ CodeableConcept }] // R! lost | stolen | prescribed | broken | burned | forgot
},
"informationSource" : { Reference(Organization|Patient|Practitioner|
PractitionerRole|RelatedPerson) }, // Who made the statement
"device" : { CodeableReference(Device|DeviceDefinition) }, // R! Code or Reference to device used
"reason" : [{ CodeableReference(Condition|DiagnosticReport|DocumentReference|
Observation|Procedure) }], // Why device was used
"bodySite" : { CodeableReference(BodyStructure) }, // Target body site
"note" : [{ Annotation }] // Addition details (comments, instructions)
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DeviceUsage | TU | DomainResource | Record of use of a device Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
| identifier | Σ | 0..* | Identifier | External identifier for this record |
| basedOn | Σ | 0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order |
| status | ?!Σ | 1..1 | code | active | completed | not-done | entered-in-error + DeviceUsageStatus (Required) |
| category | 0..* | CodeableConcept | The category of the statement - classifying how the statement is made | |
| patient | Σ | 1..1 | Reference(Patient) | Patient using device |
| derivedFrom | Σ | 0..* | Reference(ServiceRequest | Procedure | Claim | Observation | QuestionnaireResponse | DocumentReference) | Supporting information |
| context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | The encounter or episode of care that establishes the context for this device use statement |
| timing[x] | Σ | 0..1 | How often the device was used | |
| timingTiming | Timing | |||
| timingPeriod | Period | |||
| timingDateTime | dateTime | |||
| dateAsserted | Σ | 0..1 | dateTime | When the statement was made (and recorded) |
| usageStatus | 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 DeviceUsageStatus (Required) | |
| usageReason | 0..* | CodeableConcept | The reason for asserting the usage status - for example forgot, lost, stolen, broken | |
| adherence | 0..1 | BackboneElement | How device is being used | |
| code | 1..1 | CodeableConcept | always | never | sometimes DeviceUsageAdherenceCode (Example) | |
| reason | 1..* | CodeableConcept | lost | stolen | prescribed | broken | burned | forgot DeviceUsageAdherenceReason (Example) | |
| informationSource | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Who made the statement |
| device | Σ | 1..1 | CodeableReference(Device | DeviceDefinition) | Code or Reference to device used |
| reason | Σ | 0..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | Procedure) | Why device was used |
| bodySite | Σ | 0..1 | CodeableReference(BodyStructure) | Target body site SNOMED CT Body Structures (Example) |
| note | 0..* | Annotation | Addition details (comments, instructions) | |
| Documentation for this format | ||||
See the Extensions for this resource
XML Template
<DeviceUsage xmlns="http://hl7.org/fhir">
JSON Template
{
"resourceType" : "DeviceUsage",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // External identifier for this record
"basedOn" : [{ Reference(ServiceRequest) }], // Fulfills plan, proposal or order
"status" : "<code>", // R! active | completed | not-done | entered-in-error +
"category" : [{ CodeableConcept }], // The category of the statement - classifying how the statement is made
"patient" : { Reference(Patient) }, // R! Patient using device
"derivedFrom" : [{ Reference(Claim|DocumentReference|Observation|Procedure|
QuestionnaireResponse|ServiceRequest) }], // Supporting information
"context" : { Reference(Encounter|EpisodeOfCare) }, // The encounter or episode of care that establishes the context for this device use statement
// timing[x]: How often the device was used. One of these 3:
"timingTiming" : { Timing },
"timingPeriod" : { Period },
"timingDateTime" : "<dateTime>",
"dateAsserted" : "<dateTime>", // When the statement was made (and recorded)
"usageStatus" : { CodeableConcept }, // The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement
"usageReason" : [{ CodeableConcept }], // The reason for asserting the usage status - for example forgot, lost, stolen, broken
"adherence" : { // How device is being used
"code" : { CodeableConcept }, // R! always | never | sometimes
"reason" : [{ CodeableConcept }] // R! lost | stolen | prescribed | broken | burned | forgot
},
"informationSource" : { Reference(Organization|Patient|Practitioner|
PractitionerRole|RelatedPerson) }, // Who made the statement
"device" : { CodeableReference(Device|DeviceDefinition) }, // R! Code or Reference to device used
"reason" : [{ CodeableReference(Condition|DiagnosticReport|DocumentReference|
Observation|Procedure) }], // Why device was used
"bodySite" : { CodeableReference(BodyStructure) }, // Target body site
"note" : [{ Annotation }] // Addition details (comments, instructions)
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis
| Path | Definition | Type | Reference |
|---|---|---|---|
| DeviceUsage.status | A coded concept indicating the current status of the Device Usage. | Required | DeviceUsageStatus |
| DeviceUsage.usageStatus | A coded concept indicating the current status of the Device Usage. | Required | DeviceUsageStatus |
| DeviceUsage.adherence.code | A coded concept indicating the adherence of device usage. | Example | DeviceUsageAdherenceCode |
| DeviceUsage.adherence.reason | A coded concept indicating the adherence of device usage. | Example | DeviceUsageAdherenceReason |
| DeviceUsage.bodySite | This value set includes all codes from SNOMED CT | Example | SNOMEDCTBodyStructures |
Notes to reviewers:
At this time, the code bindings are placeholders to be fleshed out upon further review by the community.
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
| Name | Type | Description | Expression | In Common |
| device D | token | Search by device | DeviceUsage.device.concept | |
| identifier | token | Search by identifier | DeviceUsage.identifier | |
| patient | reference | Search by patient who used / uses the device | DeviceUsage.patient (Patient) |
FHIR ®© HL7.org 2011+. FHIR R5 Ballot hl7.fhir.core#5.0.0-ballot generated on Wed, Sep 7, 2022 11:08+1000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R5 Draft |
|
Propose a change