This 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 |
Detailed Descriptions for the elements in the DeviceUsage resource.
DeviceUsage | |
Element Id | DeviceUsage |
Definition | 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. |
Short Display | Record of use of a device |
Cardinality | 0..* |
Type | DomainResource |
Summary | false |
DeviceUsage.identifier | |
Element Id | DeviceUsage.identifier |
Definition | An external identifier for this statement such as an IRI. |
Short Display | External identifier for this record |
Note | This is a business identifier, not a resource identifier (see discussion) |
Cardinality | 0..* |
Type | Identifier |
Summary | true |
DeviceUsage.basedOn | |
Element Id | DeviceUsage.basedOn |
Definition | A plan, proposal or order that is fulfilled in whole or in part by this DeviceUsage. |
Short Display | Fulfills plan, proposal or order |
Cardinality | 0..* |
Type | Reference(ServiceRequest) |
Requirements | Allows tracing of authorization for the DeviceUsage and tracking whether proposals/recommendations were acted upon. |
Alternate Names | fulfills |
Summary | true |
DeviceUsage.status | |
Element Id | DeviceUsage.status |
Definition | A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed. |
Short Display | active | completed | not-done | entered-in-error + |
Cardinality | 1..1 |
Terminology Binding | DeviceUsageStatus (Required) |
Type | code |
Is Modifier | true (Reason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid) |
Summary | true |
Comments | DeviceUseStatment is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for contains codes that assert the status of the use by the patient (for example, stopped or on hold) as well as codes that assert the status of the resource itself (for example, entered in error). This element is labeled as a modifier because the status contains the codes that mark the statement as not currently valid. |
DeviceUsage.category | |
Element Id | DeviceUsage.category |
Definition | This attribute indicates a category for the statement - The device statement may be made in an inpatient or outpatient settting (inpatient | outpatient | community | patientspecified). |
Short Display | The category of the statement - classifying how the statement is made |
Cardinality | 0..* |
Type | CodeableConcept |
Summary | false |
DeviceUsage.patient | |
Element Id | DeviceUsage.patient |
Definition | The patient who used the device. |
Short Display | Patient using device |
Cardinality | 1..1 |
Type | Reference(Patient) |
Summary | true |
DeviceUsage.derivedFrom | |
Element Id | DeviceUsage.derivedFrom |
Definition | Allows linking the DeviceUsage to the underlying Request, or to other information that supports or is used to derive the DeviceUsage. |
Short Display | Supporting information |
Cardinality | 0..* |
Type | Reference(ServiceRequest | Procedure | Claim | Observation | QuestionnaireResponse | DocumentReference) |
Summary | true |
Comments | The most common use cases for deriving a DeviceUsage comes from creating it from a request or from an observation or a claim. it should be noted that the amount of information that is available varies from the type resource that you derive the DeviceUsage from. |
DeviceUsage.context | |
Element Id | DeviceUsage.context |
Definition | The encounter or episode of care that establishes the context for this device use statement. |
Short Display | The encounter or episode of care that establishes the context for this device use statement |
Cardinality | 0..1 |
Type | Reference(Encounter | EpisodeOfCare) |
Summary | true |
DeviceUsage.timing[x] | |
Element Id | DeviceUsage.timing[x] |
Definition | How often the device was used. |
Short Display | How often the device was used |
Cardinality | 0..1 |
Type | Timing|Period|dateTime |
[x] Note | See Choice of Datatypes for further information about how to use [x] |
Summary | true |
DeviceUsage.dateAsserted | |
Element Id | DeviceUsage.dateAsserted |
Definition | The time at which the statement was recorded by informationSource. |
Short Display | When the statement was made (and recorded) |
Cardinality | 0..1 |
Type | dateTime |
Summary | true |
DeviceUsage.usageStatus | |
Element Id | DeviceUsage.usageStatus |
Definition | The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement. |
Short Display | The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement |
Cardinality | 0..1 |
Terminology Binding | DeviceUsageStatus (Required) |
Type | CodeableConcept |
Summary | false |
DeviceUsage.usageReason | |
Element Id | DeviceUsage.usageReason |
Definition | The reason for asserting the usage status - for example forgot, lost, stolen, broken. |
Short Display | The reason for asserting the usage status - for example forgot, lost, stolen, broken |
Cardinality | 0..* |
Type | CodeableConcept |
Summary | false |
DeviceUsage.adherence | |
Element Id | DeviceUsage.adherence |
Definition | This indicates how or if the device is being used. |
Short Display | How device is being used |
Cardinality | 0..1 |
Summary | false |
DeviceUsage.adherence.code | |
Element Id | DeviceUsage.adherence.code |
Definition | Type of adherence. |
Short Display | always | never | sometimes |
Cardinality | 1..1 |
Terminology Binding | DeviceUsageAdherenceCode (Example) |
Type | CodeableConcept |
Summary | false |
DeviceUsage.adherence.reason | |
Element Id | DeviceUsage.adherence.reason |
Definition | Reason for adherence type. |
Short Display | lost | stolen | prescribed | broken | burned | forgot |
Cardinality | 1..* |
Terminology Binding | DeviceUsageAdherenceReason (Example) |
Type | CodeableConcept |
Summary | false |
DeviceUsage.informationSource | |
Element Id | DeviceUsage.informationSource |
Definition | Who reported the device was being used by the patient. |
Short Display | Who made the statement |
Cardinality | 0..1 |
Type | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) |
Summary | true |
DeviceUsage.device | |
Element Id | DeviceUsage.device |
Definition | Code or Reference to device used. |
Short Display | Code or Reference to device used |
Cardinality | 1..1 |
Type | CodeableReference(Device | DeviceDefinition) |
Summary | true |
DeviceUsage.reason | |
Element Id | DeviceUsage.reason |
Definition | Reason or justification for the use of the device. A coded concept, or another resource whose existence justifies this DeviceUsage. |
Short Display | Why device was used |
Cardinality | 0..* |
Type | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | Procedure) |
Summary | true |
Comments | When the status is not done, the reason code indicates why it was not done. |
DeviceUsage.bodySite | |
Element Id | DeviceUsage.bodySite |
Definition | Indicates the anotomic location on the subject's body where the device was used ( i.e. the target). |
Short Display | Target body site |
Cardinality | 0..1 |
Terminology Binding | SNOMED CT Body Structures (Example) |
Type | CodeableReference(BodyStructure) |
Requirements | Knowing where the device is targeted is important for tracking if multiple sites are possible. If more information than just a code is required, use the extension http://hl7.org/fhir/StructureDefinition/bodySite. |
Summary | true |
DeviceUsage.note | |
Element Id | DeviceUsage.note |
Definition | Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement. |
Short Display | Addition details (comments, instructions) |
Cardinality | 0..* |
Type | Annotation |
Summary | false |