OO Incubator Implementation Guide
0.1.0 - ci-build Global (Whole world)

OO Incubator Implementation Guide, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/oo-incubator/ and changes regularly. See the Directory of published versions

Resource: DeviceUsage

Official URL: http://hl7.org/fhir/StructureDefinition/DeviceUsage Version: 0.1.0
Standards status: Trial-use Maturity Level: 1 Computable Name: DeviceUsage
Other Identifiers: OID:2.16.840.1.113883.4.642.40.98.42.4

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.

Scope and Usage

This resource records the use of a healthcare-related device by the patient, a provider or a related person, and is primarily used for patient-reported or second-hand reporting. The resource can be used to note the use of an assistive device such as a wheelchair or hearing aid, a contraceptive, or an implanted device such as a pacemaker. It may also be used, for example, to capture an approximate assertion that the patient used the device over a six month period.

This resource is an event resource from a FHIR workflow perspective - see Workflow.

Boundaries and Relationships

There are several resources that can be used to represent device use events or requests. The following Resources should be used in the following manner:

DeviceRequest - records a request to use the device.

Procedure- records the implant or explant event of a device in a patient.

DeviceAssociation - If precise information (e.g., from the assigning system) about the association of the device with the patient is known, DeviceAssociation is the typical mechanism to record the information.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Resource Content

Description Differentials, Snapshots, and other representations.

This structure is derived from DomainResource

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DeviceUsage 0..* DomainResource Record of use of a device

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
This resource is an additional resource
DeviceUsage.identifier This element is included in summaries. 0..* Identifier External identifier for this record
DeviceUsage.basedOn This element is included in summaries. 0..* Reference(ServiceRequest) Fulfills plan, proposal or order
DeviceUsage.partOf This element is included in summaries. 0..* Reference(DeviceUsage) Part of referenced device usage
DeviceUsage.category 0..* CodeableConcept The category of the statement - classifying how the statement is made
DeviceUsage.subject This element is included in summaries. 1..1 Reference(Patient | Group) Individuals(s) who used the 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 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 is included in summaries. 0..1 dateTime When the statement was made (and recorded)
DeviceUsage.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
Binding: Device Usage Status Values (required): Codes representing the usage status of the device.
DeviceUsage.usageReason 0..* CodeableConcept The reason for asserting the usage status - for example forgot, lost, stolen, broken
DeviceUsage.adherence 0..1 BackboneElement How device is being used
DeviceUsage.adherence.code 1..1 CodeableConcept always | never | sometimes
Binding: Device Usage Adherence Code Values (example): Codes for adherence
DeviceUsage.adherence.reason 1..* CodeableConcept lost | stolen | prescribed | broken | burned | forgot
Binding: Device Usage Adherence Reason Values (example): Codes for adherence reason
DeviceUsage.informationSource This element is included in summaries. 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization | Group) Who made the statement
DeviceUsage.device This element is included in summaries. 1..1 CodeableReference(Device | DeviceDefinition) Code or Reference to device used
DeviceUsage.reason This element is included in summaries. 0..* CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | Procedure) Why device was used
DeviceUsage.bodyStructure This element is included in summaries. 0..* CodeableReference(BodyStructure) Target body structure
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body Structures
DeviceUsage.note 0..* Annotation Addition details (comments, instructions)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DeviceUsage.status Base required Device Usage Status Values 📦0.1.0 This IG
DeviceUsage.usageStatus Base required Device Usage Status Values 📦0.1.0 This IG
DeviceUsage.adherence.​code Base example Device Usage Adherence Code Values 📦0.1.0 This IG
DeviceUsage.adherence.​reason Base example Device Usage Adherence Reason Values 📦0.1.0 This IG
DeviceUsage.bodyStructure Base example SNOMED CT Body Structures 📦6.0.0-snapshot1 FHIR Std.
<DeviceUsage xmlns="http://hl7.org/fhir"> doco
 <id value="[id]"/><!-- 0..1 * Logical id of this artifact  -->
 <meta><!-- I 0..1 * Metadata about the resource  --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 * A set of rules under which this content was created  -->
 <language value="[code]"/><!-- I 0..1 * Language of the resource content  -->
 <text><!-- I 0..1 * Text summary of the resource, for human interpretation  --></text>
 <contained><!-- 0..* * Contained, inline Resources  --></contained>
 <extension><!-- See Extensions  Additional content defined by implementations  --></extension>
 <modifierExtension><!-- I 0..* * Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- 0..* * External identifier for this record  --></identifier>
 <basedOn><!-- 0..* * Fulfills plan, proposal or order  --></basedOn>
 <partOf><!-- 0..* * Part of referenced device usage  --></partOf>
 <status value="[code]"/><!-- 1..1 * preparation | active | completed | not-done | entered-in-error +  -->
 <category><!-- 0..* * The category of the statement - classifying how the statement is made  --></category>
 <subject><!-- 1..1 * Individuals(s) who used the device  --></subject>
 <derivedFrom><!-- 0..* * Supporting information  --></derivedFrom>
 <context><!-- 0..1 * 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 * 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..* * The reason for asserting the usage status - for example forgot, lost, stolen, broken  --></usageReason>
 <adherence> I 0..1 *  <!-- I 0..1 How device is being used -->
  <id value="[string]"/><!-- 0..1 * Unique id for inter-element referencing   -->
  <extension><!-- See Extensions  Additional content defined by implementations   --></extension>
  <modifierExtension><!-- I 0..* * Extensions that cannot be ignored even if unrecognized   --></modifierExtension>
  <code><!-- 1..1 * always | never | sometimes   --></code>
  <reason><!-- 1..* * lost | stolen | prescribed | broken | burned | forgot   --></reason>
 </adherence>
 <informationSource><!-- 0..1 * Who made the statement  --></informationSource>
 <device><!-- 1..1 * Code or Reference to device used  --></device>
 <reason><!-- 0..* * Why device was used  --></reason>
 <bodyStructure><!-- 0..* * Target body structure  --></bodyStructure>
 <note><!-- 0..* * Addition details (comments, instructions)  --></note>
</DeviceUsage>
{doco
  "resourceType" : "DeviceUsage",
  "id" : "<id>", // 0..1 Logical id of this artifact
  "meta" : { Meta }, // I 0..1 Metadata about the resource
  "implicitRules" : "<uri>", // I 0..1 A set of rules under which this content was created
  "language" : "<code>", // I 0..1 Language of the resource content
  "text" : { Narrative }, // I 0..1 Text summary of the resource, for human interpretation
  "contained" : [{ Resource }], // 0..* Contained, inline Resources
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
  "identifier" : [{ Identifier }], // 0..* External identifier for this record
  "basedOn" : [{ Reference(ServiceRequest) }], // 0..* Fulfills plan, proposal or order
  "partOf" : [{ Reference(DeviceUsage) }], // 0..* Part of referenced device usage
  "status" : "<code>", // 1..1 preparation | active | completed | not-done | entered-in-error +
  "category" : [{ CodeableConcept }], // 0..* The category of the statement - classifying how the statement is made
  "subject" : { Reference(Group|Patient) }, // 1..1 Individuals(s) who used the device
  "derivedFrom" : [{ Reference(Claim|DocumentReference|Observation|Procedure|
   QuestionnaireResponse|ServiceRequest) }], // 0..* Supporting information
  "context" : { Reference(Encounter|EpisodeOfCare) }, // 0..1 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>", // 0..1 When the statement was made (and recorded)
  "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
  "usageReason" : [{ CodeableConcept }], // 0..* The reason for asserting the usage status - for example forgot, lost, stolen, broken
  "adherence" : { BackboneElement }, // I 0..1 How device is being used
    "id" : "<string>", // 0..1 Unique id for inter-element referencing
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
    "code" : { CodeableConcept }, // 1..1 always | never | sometimes
    "reason" : [{ CodeableConcept }] // 1..* lost | stolen | prescribed | broken | burned | forgot
  }
  "informationSource" : { Reference(Group|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson) }, // 0..1 Who made the statement
  "device" : { CodeableReference(Device|DeviceDefinition) }, // 1..1 Code or Reference to device used
  "reason" : [{ CodeableReference(Condition|DiagnosticReport|DocumentReference|
   Observation|Procedure) }], // 0..* Why device was used
  "bodyStructure" : [{ CodeableReference(BodyStructure) }], // 0..* Target body structure
  "note" : [{ Annotation }] // 0..* Addition details (comments, instructions)
}
@prefix fhir: <http://hl7.org/fhir/> .doco


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

  fhir:id [ id ] ; # 0..1 Logical id of this artifact
  fhir:meta [ Meta ] ; # 0..1 I Metadata about the resource
  fhir:implicitRules [ uri ] ; # 0..1 I A set of rules under which this content was created
  fhir:language [ code ] ; # 0..1 I Language of the resource content
  fhir:text [ Narrative ] ; # 0..1 I Text summary of the resource, for human interpretation
  fhir:contained  ( [ Resource ] ... ) ; # 0..* Contained, inline Resources
  fhir:extension  ( [ Extension ] ... ) ; # 0..* I Additional content defined by implementations
  fhir:modifierExtension  ( [ Extension ] ... ) ; # 0..* I Extensions that cannot be ignored
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* External identifier for this record
  fhir:basedOn  ( [ Reference(ServiceRequest) ] ... ) ; # 0..* Fulfills plan, proposal or order
  fhir:partOf  ( [ Reference(DeviceUsage) ] ... ) ; # 0..* Part of referenced device usage
  fhir:status [ code ] ; # 1..1 preparation | active | completed | not-done | entered-in-error +
  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* The category of the statement - classifying how the statement is made
  fhir:subject [ Reference(Group|Patient) ] ; # 1..1 Individuals(s) who used the device
  fhir:derivedFrom  ( [ Reference(Claim|DocumentReference|Observation|Procedure|QuestionnaireResponse|
  ServiceRequest) ] ... ) ; # 0..* Supporting information
  fhir:context [ Reference(Encounter|EpisodeOfCare) ] ; # 0..1 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. One of these 3
    fhir:timing[  a fhir:Timing ; Timing ]
    fhir:timing[  a fhir:Period ; Period ]
    fhir:timing[  a fhir:dateTime ; dateTime ]
  fhir:dateAsserted [ dateTime ] ; # 0..1 When the statement was made (and recorded)
  fhir: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:usageReason  ( [ CodeableConcept ] ... ) ; # 0..* The reason for asserting the usage status - for example forgot, lost, stolen, broken
  fhir:adherence [ BackboneElement ] ; # 0..1 I How device is being used
  fhir:informationSource [ Reference(Group|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] ; # 0..1 Who made the statement
  fhir:device [ CodeableReference(Device|DeviceDefinition) ] ; # 1..1 Code or Reference to device used
  fhir:reason  ( [ CodeableReference(Condition|DiagnosticReport|DocumentReference|Observation|Procedure) ] ... ) ; # 0..* Why device was used
  fhir:bodyStructure  ( [ CodeableReference(BodyStructure) ] ... ) ; # 0..* Target body structure
  fhir:note  ( [ Annotation ] ... ) ; # 0..* Addition details (comments, instructions)
]

Differential View

This structure is derived from DomainResource

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DeviceUsage 0..* DomainResource Record of use of a device

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
This resource is an additional resource
DeviceUsage.identifier This element is included in summaries. 0..* Identifier External identifier for this record
DeviceUsage.basedOn This element is included in summaries. 0..* Reference(ServiceRequest) Fulfills plan, proposal or order
DeviceUsage.partOf This element is included in summaries. 0..* Reference(DeviceUsage) Part of referenced device usage
DeviceUsage.status This element is a modifier element. This element is included in summaries. 1..1 code preparation | active | completed | not-done | entered-in-error +
Binding: Device Usage Status Values (required): A coded concept indicating the current status of the Device Usage.
DeviceUsage.category 0..* CodeableConcept The category of the statement - classifying how the statement is made
DeviceUsage.subject This element is included in summaries. 1..1 Reference(Patient | Group) Individuals(s) who used the 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 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 is included in summaries. 0..1 dateTime When the statement was made (and recorded)
DeviceUsage.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
Binding: Device Usage Status Values (required): Codes representing the usage status of the device.
DeviceUsage.usageReason 0..* CodeableConcept The reason for asserting the usage status - for example forgot, lost, stolen, broken
DeviceUsage.adherence 0..1 BackboneElement How device is being used
DeviceUsage.adherence.code 1..1 CodeableConcept always | never | sometimes
Binding: Device Usage Adherence Code Values (example): Codes for adherence
DeviceUsage.adherence.reason 1..* CodeableConcept lost | stolen | prescribed | broken | burned | forgot
Binding: Device Usage Adherence Reason Values (example): Codes for adherence reason
DeviceUsage.informationSource This element is included in summaries. 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization | Group) Who made the statement
DeviceUsage.device This element is included in summaries. 1..1 CodeableReference(Device | DeviceDefinition) Code or Reference to device used
DeviceUsage.reason This element is included in summaries. 0..* CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | Procedure) Why device was used
DeviceUsage.bodyStructure This element is included in summaries. 0..* CodeableReference(BodyStructure) Target body structure
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body Structures
DeviceUsage.note 0..* Annotation Addition details (comments, instructions)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DeviceUsage.status Base required Device Usage Status Values 📦0.1.0 This IG
DeviceUsage.usageStatus Base required Device Usage Status Values 📦0.1.0 This IG
DeviceUsage.adherence.​code Base example Device Usage Adherence Code Values 📦0.1.0 This IG
DeviceUsage.adherence.​reason Base example Device Usage Adherence Reason Values 📦0.1.0 This IG
DeviceUsage.bodyStructure Base example SNOMED CT Body Structures 📦6.0.0-snapshot1 FHIR Std.

 

Other representations of resource: CSV, Excel

Notes:

Notes to reviewers:

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

Name Type Description Expression
body-structure-code token

Code for target body structure

DeviceUsage.bodyStructure.concept
body-structure-reference reference

Target body structure (reference)

DeviceUsage.bodyStructure.reference
device token

Search by device

DeviceUsage.device.concept
identifier token

Search by identifier

DeviceUsage.identifier
patient reference

Search by patient who used the device

DeviceUsage.subject.where(resolve() is Patient)
researchStudy reference

SearchParameter for Research Study Extension

DomainResource.extension('http://hl7.org/fhir/StructureDefinition/workflow-researchStudy').value
status token

The status of the device usage

DeviceUsage.status
subject reference

The individual(s) who used the device

DeviceUsage.subject
workflow-EpisodeOfCare reference

​ SearchParameter for EpisodeOfCare extension

Resource.extension('http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare').value