OO Incubator Implementation Guide
0.1.0 - ci-build International flag

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 Draft as of 2021-01-02 Maturity Level: 1 Computable Name: DeviceUsage
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1402

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.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Resource Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DeviceUsage 0..* 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
... partOf Σ 0..* Reference(DeviceUsage) Part of referenced device usage
... category 0..* CodeableConcept The category of the statement - classifying how the statement is made
... subject Σ 1..1 Reference(Patient | Group) Individuals(s) who used the 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
Binding: DeviceUsageStatus (required): Codes representing the usage status of the device.
... 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
Binding: DeviceUsageAdherenceCode (example): Codes for adherence
.... reason 1..* CodeableConcept lost | stolen | prescribed | broken | burned | forgot
Binding: DeviceUsageAdherenceReason (example): Codes for adherence reason
... informationSource Σ 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization | Group) 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
... bodyStructure Σ 0..1 CodeableReference(BodyStructure) Target body structure
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body Structures
... 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 📦6.0.0-ballot3 FHIR Std.
DeviceUsage.usageStatus Base required Device Usage Status 📦6.0.0-ballot3 FHIR Std.
DeviceUsage.adherence.​code Base example Device Usage Adherence Code 📦6.0.0-ballot3 FHIR Std.
DeviceUsage.adherence.​reason Base example Device Usage Adherence Reason 📦6.0.0-ballot3 FHIR Std.
DeviceUsage.bodyStructure Base example SNOMED CT Body Structures 📦6.0.0-ballot3 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="[id]"/><!-- 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..1 ​* 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" : "<id>", // 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..1 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..1 Target body structure
  fhir:note  ( [ Annotation ] ... ) ; # 0..* Addition details (comments, instructions)
]

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DeviceUsage 0..* 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
... partOf Σ 0..* Reference(DeviceUsage) Part of referenced device usage
... category 0..* CodeableConcept The category of the statement - classifying how the statement is made
... subject Σ 1..1 Reference(Patient | Group) Individuals(s) who used the 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
Binding: DeviceUsageStatus (required): Codes representing the usage status of the device.
... 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
Binding: DeviceUsageAdherenceCode (example): Codes for adherence
.... reason 1..* CodeableConcept lost | stolen | prescribed | broken | burned | forgot
Binding: DeviceUsageAdherenceReason (example): Codes for adherence reason
... informationSource Σ 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization | Group) 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
... bodyStructure Σ 0..1 CodeableReference(BodyStructure) Target body structure
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body Structures
... 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 📦6.0.0-ballot3 FHIR Std.
DeviceUsage.usageStatus Base required Device Usage Status 📦6.0.0-ballot3 FHIR Std.
DeviceUsage.adherence.​code Base example Device Usage Adherence Code 📦6.0.0-ballot3 FHIR Std.
DeviceUsage.adherence.​reason Base example Device Usage Adherence Reason 📦6.0.0-ballot3 FHIR Std.
DeviceUsage.bodyStructure Base example SNOMED CT Body Structures 📦6.0.0-ballot3 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
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)
reference reference

Target body structure (reference)

 DeviceUsage.bodyStructure.reference
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