Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

12.24 Resource DeviceUsage - Content

Orders and Observations Work GroupMaturity Level: 0 Trial UseSecurity 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.

12.24.1 Scope and Usage

This resource is an event resource from a FHIR workflow perspective - see These resources have not yet undergone proper review by PC, CQI, CDS, and OO. At this time, they are to be considered only as draft resource proposals for potential submission.

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.

12.24.2 Boundaries and Relationships

This resource is different from DeviceRequest which records a request to use the device. This also is distinct from the Procedure resource which may describe the implantation or explantation of a device.

12.24.3 References

No resources refer to this resource directly.

This resource implements the Event pattern.

12.24.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceUsage TUDomainResourceRecord of use of a device
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierExternal identifier for this record
... basedOn Σ0..*Reference(ServiceRequest)Fulfills plan, proposal or order
... status ?!Σ1..1codeactive | completed | entered-in-error +
DeviceUsageStatus (Required)
... subject Σ1..1Reference(Patient)Patient using device
... derivedFrom Σ0..*Reference(ServiceRequest | Procedure | Claim | Observation | QuestionnaireResponse | DocumentReference)Supporting information
... context Σ0..1Reference(Encounter | EpisodeOfCare)The encounter or episode of care that establishes the context for this device use statement
... timing[x] Σ0..1How often the device was used
.... timingTimingTiming
.... timingPeriodPeriod
.... timingDateTimedateTime
... dateAsserted Σ0..1dateTimeWhen the statement was made (and recorded)
... usageStatus 0..1CodeableConceptThe 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..*CodeableConceptThe reason for asserting the usage status - for example forgot, lost, stolen, broken
... informationSource Σ0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)Who made the statement
... device Σ1..1CodeableReference(Device | DeviceDefinition)Code or Reference to device used
... reason Σ0..*CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference)Why device was used
... bodySite Σ0..1CodeableReference(BodyStructure)Target body site
SNOMED CT Body Structures (Example)
... note 0..*AnnotationAddition details (comments, instructions)

doco Documentation for this format

UML Diagram (Legend)

DeviceUsage (DomainResource)An external identifier for this statement such as an IRIidentifier : Identifier [0..*]A plan, proposal or order that is fulfilled in whole or in part by this DeviceUsagebasedOn : Reference [0..*] « ServiceRequest »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 (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)DeviceUsageStatus! »This attribute indicates a category for the statement - The device statement may be made in an inpatient or outpatient settting (inpatient | outpatient | community | patientspecified)category : CodeableConcept [0..*]The patient who used the devicesubject : Reference [1..1] « Patient »Allows linking the DeviceUsage to the underlying Request, or to other information that supports or is used to derive the DeviceUsagederivedFrom : Reference [0..*] « ServiceRequest|Procedure|Claim| Observation|QuestionnaireResponse|DocumentReference »The encounter or episode of care that establishes the context for this device use statementcontext : Reference [0..1] « Encounter|EpisodeOfCare »How often the device was usedtiming[x] : DataType [0..1] « Timing|Period|dateTime »The time at which the statement was recorded by informationSourcedateAsserted : dateTime [0..1]The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statementusageStatus : CodeableConcept [0..1] « null (Strength=Required)DeviceUsageStatus! »The reason for asserting the usage status - for example forgot, lost, stolen, brokenusageReason : CodeableConcept [0..*]Who reported the device was being used by the patientinformationSource : Reference [0..1] « Patient|Practitioner| PractitionerRole|RelatedPerson|Organization »Code or Reference to device useddevice : DataType [1..1] « Device|DeviceDefinition »Reason or justification for the use of the device. A coded concept, or another resource whose existence justifies this DeviceUsagereason : DataType [0..*] « Condition|Observation|DiagnosticReport| DocumentReference »Indicates the anotomic location on the subject's body where the device was used ( i.e. the target)bodySite : DataType [0..1] « BodyStructure; Codes describing anatomical locations. May include laterality. (Strength=Example)SNOMEDCTBodyStructures?? »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 statementnote : Annotation [0..*]

XML Template

<DeviceUsage xmlns="http://hl7.org/fhir"> doco
 <!-- 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 | entered-in-error + -->
 <category><!-- 0..* CodeableConcept The category of the statement - classifying how the statement is made --></category>
 <subject><!-- 1..1 Reference(Patient) Patient using device --></subject>
 <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>
 <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) 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

{doco
  "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 | entered-in-error +
  "category" : [{ CodeableConcept }], // The category of the statement - classifying how the statement is made
  "subject" : { 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
  "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) }], // Why device was used
  "bodySite" : { CodeableReference(BodyStructure) }, // Target body site
  "note" : [{ Annotation }] // Addition details (comments, instructions)
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:DeviceUsage;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:DeviceUsage.identifier [ Identifier ], ... ; # 0..* External identifier for this record
  fhir:DeviceUsage.basedOn [ Reference(ServiceRequest) ], ... ; # 0..* Fulfills plan, proposal or order
  fhir:DeviceUsage.status [ code ]; # 1..1 active | completed | entered-in-error +
  fhir:DeviceUsage.category [ CodeableConcept ], ... ; # 0..* The category of the statement - classifying how the statement is made
  fhir:DeviceUsage.subject [ Reference(Patient) ]; # 1..1 Patient using device
  fhir:DeviceUsage.derivedFrom [ Reference(Claim|DocumentReference|Observation|Procedure|QuestionnaireResponse|
  ServiceRequest) ], ... ; # 0..* Supporting information
  fhir:DeviceUsage.context [ Reference(Encounter|EpisodeOfCare) ]; # 0..1 The encounter or episode of care that establishes the context for this device use statement
  # DeviceUsage.timing[x] : 0..1 How often  the device was used. One of these 3
    fhir:DeviceUsage.timingTiming [ Timing ]
    fhir:DeviceUsage.timingPeriod [ Period ]
    fhir:DeviceUsage.timingDateTime [ dateTime ]
  fhir:DeviceUsage.dateAsserted [ dateTime ]; # 0..1 When the statement was made (and recorded)
  fhir:DeviceUsage.usageStatus [ CodeableConcept ]; # 0..1 The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement
  fhir:DeviceUsage.usageReason [ CodeableConcept ], ... ; # 0..* The reason for asserting the usage status - for example forgot, lost, stolen, broken
  fhir:DeviceUsage.informationSource [ Reference(Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Who made the statement
  fhir:DeviceUsage.device [ CodeableReference(Device|DeviceDefinition) ]; # 1..1 Code or Reference to device used
  fhir:DeviceUsage.reason [ CodeableReference(Condition|DiagnosticReport|DocumentReference|Observation) ], ... ; # 0..* Why device was used
  fhir:DeviceUsage.bodySite [ CodeableReference(BodyStructure) ]; # 0..1 Target body site
  fhir:DeviceUsage.note [ Annotation ], ... ; # 0..* Addition details (comments, instructions)
]

Changes since R3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceUsage TUDomainResourceRecord of use of a device
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierExternal identifier for this record
... basedOn Σ0..*Reference(ServiceRequest)Fulfills plan, proposal or order
... status ?!Σ1..1codeactive | completed | entered-in-error +
DeviceUsageStatus (Required)
... subject Σ1..1Reference(Patient)Patient using device
... derivedFrom Σ0..*Reference(ServiceRequest | Procedure | Claim | Observation | QuestionnaireResponse | DocumentReference)Supporting information
... context Σ0..1Reference(Encounter | EpisodeOfCare)The encounter or episode of care that establishes the context for this device use statement
... timing[x] Σ0..1How often the device was used
.... timingTimingTiming
.... timingPeriodPeriod
.... timingDateTimedateTime
... dateAsserted Σ0..1dateTimeWhen the statement was made (and recorded)
... usageStatus 0..1CodeableConceptThe 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..*CodeableConceptThe reason for asserting the usage status - for example forgot, lost, stolen, broken
... informationSource Σ0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)Who made the statement
... device Σ1..1CodeableReference(Device | DeviceDefinition)Code or Reference to device used
... reason Σ0..*CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference)Why device was used
... bodySite Σ0..1CodeableReference(BodyStructure)Target body site
SNOMED CT Body Structures (Example)
... note 0..*AnnotationAddition details (comments, instructions)

doco Documentation for this format

UML Diagram (Legend)

DeviceUsage (DomainResource)An external identifier for this statement such as an IRIidentifier : Identifier [0..*]A plan, proposal or order that is fulfilled in whole or in part by this DeviceUsagebasedOn : Reference [0..*] « ServiceRequest »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 (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)DeviceUsageStatus! »This attribute indicates a category for the statement - The device statement may be made in an inpatient or outpatient settting (inpatient | outpatient | community | patientspecified)category : CodeableConcept [0..*]The patient who used the devicesubject : Reference [1..1] « Patient »Allows linking the DeviceUsage to the underlying Request, or to other information that supports or is used to derive the DeviceUsagederivedFrom : Reference [0..*] « ServiceRequest|Procedure|Claim| Observation|QuestionnaireResponse|DocumentReference »The encounter or episode of care that establishes the context for this device use statementcontext : Reference [0..1] « Encounter|EpisodeOfCare »How often the device was usedtiming[x] : DataType [0..1] « Timing|Period|dateTime »The time at which the statement was recorded by informationSourcedateAsserted : dateTime [0..1]The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statementusageStatus : CodeableConcept [0..1] « null (Strength=Required)DeviceUsageStatus! »The reason for asserting the usage status - for example forgot, lost, stolen, brokenusageReason : CodeableConcept [0..*]Who reported the device was being used by the patientinformationSource : Reference [0..1] « Patient|Practitioner| PractitionerRole|RelatedPerson|Organization »Code or Reference to device useddevice : DataType [1..1] « Device|DeviceDefinition »Reason or justification for the use of the device. A coded concept, or another resource whose existence justifies this DeviceUsagereason : DataType [0..*] « Condition|Observation|DiagnosticReport| DocumentReference »Indicates the anotomic location on the subject's body where the device was used ( i.e. the target)bodySite : DataType [0..1] « BodyStructure; Codes describing anatomical locations. May include laterality. (Strength=Example)SNOMEDCTBodyStructures?? »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 statementnote : Annotation [0..*]

XML Template

<DeviceUsage xmlns="http://hl7.org/fhir"> doco
 <!-- 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 | entered-in-error + -->
 <category><!-- 0..* CodeableConcept The category of the statement - classifying how the statement is made --></category>
 <subject><!-- 1..1 Reference(Patient) Patient using device --></subject>
 <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>
 <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) 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

{doco
  "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 | entered-in-error +
  "category" : [{ CodeableConcept }], // The category of the statement - classifying how the statement is made
  "subject" : { 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
  "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) }], // Why device was used
  "bodySite" : { CodeableReference(BodyStructure) }, // Target body site
  "note" : [{ Annotation }] // Addition details (comments, instructions)
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:DeviceUsage;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:DeviceUsage.identifier [ Identifier ], ... ; # 0..* External identifier for this record
  fhir:DeviceUsage.basedOn [ Reference(ServiceRequest) ], ... ; # 0..* Fulfills plan, proposal or order
  fhir:DeviceUsage.status [ code ]; # 1..1 active | completed | entered-in-error +
  fhir:DeviceUsage.category [ CodeableConcept ], ... ; # 0..* The category of the statement - classifying how the statement is made
  fhir:DeviceUsage.subject [ Reference(Patient) ]; # 1..1 Patient using device
  fhir:DeviceUsage.derivedFrom [ Reference(Claim|DocumentReference|Observation|Procedure|QuestionnaireResponse|
  ServiceRequest) ], ... ; # 0..* Supporting information
  fhir:DeviceUsage.context [ Reference(Encounter|EpisodeOfCare) ]; # 0..1 The encounter or episode of care that establishes the context for this device use statement
  # DeviceUsage.timing[x] : 0..1 How often  the device was used. One of these 3
    fhir:DeviceUsage.timingTiming [ Timing ]
    fhir:DeviceUsage.timingPeriod [ Period ]
    fhir:DeviceUsage.timingDateTime [ dateTime ]
  fhir:DeviceUsage.dateAsserted [ dateTime ]; # 0..1 When the statement was made (and recorded)
  fhir:DeviceUsage.usageStatus [ CodeableConcept ]; # 0..1 The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement
  fhir:DeviceUsage.usageReason [ CodeableConcept ], ... ; # 0..* The reason for asserting the usage status - for example forgot, lost, stolen, broken
  fhir:DeviceUsage.informationSource [ Reference(Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Who made the statement
  fhir:DeviceUsage.device [ CodeableReference(Device|DeviceDefinition) ]; # 1..1 Code or Reference to device used
  fhir:DeviceUsage.reason [ CodeableReference(Condition|DiagnosticReport|DocumentReference|Observation) ], ... ; # 0..* Why device was used
  fhir:DeviceUsage.bodySite [ CodeableReference(BodyStructure) ]; # 0..1 Target body site
  fhir:DeviceUsage.note [ Annotation ], ... ; # 0..* Addition details (comments, instructions)
]

Changes since Release 3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis a

12.24.4.1 Terminology Bindings

PathDefinitionTypeReference
DeviceUsage.status RequiredDeviceUsageStatus
DeviceUsage.usageStatus RequiredDeviceUsageStatus
DeviceUsage.bodySite Codes describing anatomical locations. May include laterality.ExampleSNOMEDCTBodyStructures

Notes to reviewers:

At this time, the code bindings are placeholders to be fleshed out upon further review by the community.

12.24.5 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
device DtokenSearch by deviceDeviceUsage.device.concept
identifiertokenSearch by identifierDeviceUsage.identifier
patientreferenceSearch by subject - a patientDeviceUsage.subject
(Patient)
subjectreferenceSearch by subjectDeviceUsage.subject
(Patient)