[go: up one dir, main page]
FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3 R2

12.23 Resource DeviceUseStatement - Content

Orders and Observations Work GroupMaturity Level: 0 DraftCompartments: Device, Patient

A record of a device being used by a patient where the record is the result of a report from the patient or another clinician.

12.23.1 Scope and Usage

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, another 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.23.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.23.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceUseStatement DomainResourceRecord of use of a device
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..*IdentifierExternal identifier for this record
... status ?!Σ1..1codeactive | completed | entered-in-error +
DeviceUseStatementStatus (Required)
... subject 1..1Reference(Patient | Group)Patient using device
... whenUsed 0..1PeriodPeriod device was used
... timing[x] 0..1How often the device was used
.... timingTimingTiming
.... timingPeriodPeriod
.... timingDateTimedateTime
... recordedOn 0..1dateTimeWhen statement was recorded
... source 0..1Reference(Patient | Practitioner | RelatedPerson)Who made the statement
... device 1..1Reference(Device)Reference to device used
... indication 0..*CodeableConceptWhy device was used
... bodySite 0..1CodeableConceptTarget body site
SNOMED CT Body Structures (Example)
... note 0..*AnnotationAddition details (comments, instructions)

doco Documentation for this format

UML Diagram (Legend)

DeviceUseStatement (DomainResource)An external identifier for this statement such as an IRIidentifier : Identifier [0..*]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] A coded concept indicating the current status of a the Device Usage (Strength=Required)DeviceUseStatementStatus! The patient who used the devicesubject : Reference [1..1] Patient|Group The time period over which the device was usedwhenUsed : Period [0..1]How often the device was usedtiming[x] : Type [0..1] Timing|Period|dateTime The time at which the statement was made/recordedrecordedOn : dateTime [0..1]Who reported the device was being used by the patientsource : Reference [0..1] Patient|Practitioner|RelatedPerson The details of the device useddevice : Reference [1..1] Device Reason or justification for the use of the deviceindication : CodeableConcept [0..*]Indicates the site on the subject's body where the device was used ( i.e. the target site)bodySite : CodeableConcept [0..1] Codes describing anatomical locations. May include laterality. (Strength=Example)SNOMED CT Body Structures?? 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

<DeviceUseStatement 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>
 <status value="[code]"/><!-- 1..1 active | completed | entered-in-error + -->
 <subject><!-- 1..1 Reference(Patient|Group) Patient using device --></subject>
 <whenUsed><!-- 0..1 Period Period device was used --></whenUsed>
 <timing[x]><!-- 0..1 Timing|Period|dateTime How often  the device was used --></timing[x]>
 <recordedOn value="[dateTime]"/><!-- 0..1 When statement was recorded -->
 <source><!-- 0..1 Reference(Patient|Practitioner|RelatedPerson) Who made the statement --></source>
 <device><!-- 1..1 Reference(Device) Reference to device used --></device>
 <indication><!-- 0..* CodeableConcept Why device was used --></indication>
 <bodySite><!-- 0..1 CodeableConcept Target body site --></bodySite>
 <note><!-- 0..* Annotation Addition details (comments, instructions) --></note>
</DeviceUseStatement>

Turtle Template

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


[ a fhir:DeviceUseStatement;
  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:DeviceUseStatement.identifier [ Identifier ], ... ; # 0..* External identifier for this record
  fhir:DeviceUseStatement.status [ code ]; # 1..1 active | completed | entered-in-error +
  fhir:DeviceUseStatement.subject [ Reference(Patient|Group) ]; # 1..1 Patient using device
  fhir:DeviceUseStatement.whenUsed [ Period ]; # 0..1 Period device was used
  # DeviceUseStatement.timing[x] : 0..1 How often  the device was used. One of these 3
    fhir:DeviceUseStatement.timingTiming [ Timing ]
    fhir:DeviceUseStatement.timingPeriod [ Period ]
    fhir:DeviceUseStatement.timingDateTime [ dateTime ]
  fhir:DeviceUseStatement.recordedOn [ dateTime ]; # 0..1 When statement was recorded
  fhir:DeviceUseStatement.source [ Reference(Patient|Practitioner|RelatedPerson) ]; # 0..1 Who made the statement
  fhir:DeviceUseStatement.device [ Reference(Device) ]; # 1..1 Reference to device used
  fhir:DeviceUseStatement.indication [ CodeableConcept ], ... ; # 0..* Why device was used
  fhir:DeviceUseStatement.bodySite [ CodeableConcept ]; # 0..1 Target body site
  fhir:DeviceUseStatement.note [ Annotation ], ... ; # 0..* Addition details (comments, instructions)
]

Changes since DSTU2

DeviceUseStatement
DeviceUseStatement.status
  • Added Element
DeviceUseStatement.subject
  • Add Reference(Group)
DeviceUseStatement.source
  • Added Element
DeviceUseStatement.bodySite
  • Renamed from bodySite[x] to bodySite
  • Remove Reference(BodySite)
DeviceUseStatement.note
  • Added Element
DeviceUseStatement.notes
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

See R2 <--> R3 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (1 errors).).

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceUseStatement DomainResourceRecord of use of a device
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..*IdentifierExternal identifier for this record
... status ?!Σ1..1codeactive | completed | entered-in-error +
DeviceUseStatementStatus (Required)
... subject 1..1Reference(Patient | Group)Patient using device
... whenUsed 0..1PeriodPeriod device was used
... timing[x] 0..1How often the device was used
.... timingTimingTiming
.... timingPeriodPeriod
.... timingDateTimedateTime
... recordedOn 0..1dateTimeWhen statement was recorded
... source 0..1Reference(Patient | Practitioner | RelatedPerson)Who made the statement
... device 1..1Reference(Device)Reference to device used
... indication 0..*CodeableConceptWhy device was used
... bodySite 0..1CodeableConceptTarget body site
SNOMED CT Body Structures (Example)
... note 0..*AnnotationAddition details (comments, instructions)

doco Documentation for this format

UML Diagram (Legend)

DeviceUseStatement (DomainResource)An external identifier for this statement such as an IRIidentifier : Identifier [0..*]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] A coded concept indicating the current status of a the Device Usage (Strength=Required)DeviceUseStatementStatus! The patient who used the devicesubject : Reference [1..1] Patient|Group The time period over which the device was usedwhenUsed : Period [0..1]How often the device was usedtiming[x] : Type [0..1] Timing|Period|dateTime The time at which the statement was made/recordedrecordedOn : dateTime [0..1]Who reported the device was being used by the patientsource : Reference [0..1] Patient|Practitioner|RelatedPerson The details of the device useddevice : Reference [1..1] Device Reason or justification for the use of the deviceindication : CodeableConcept [0..*]Indicates the site on the subject's body where the device was used ( i.e. the target site)bodySite : CodeableConcept [0..1] Codes describing anatomical locations. May include laterality. (Strength=Example)SNOMED CT Body Structures?? 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

<DeviceUseStatement 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>
 <status value="[code]"/><!-- 1..1 active | completed | entered-in-error + -->
 <subject><!-- 1..1 Reference(Patient|Group) Patient using device --></subject>
 <whenUsed><!-- 0..1 Period Period device was used --></whenUsed>
 <timing[x]><!-- 0..1 Timing|Period|dateTime How often  the device was used --></timing[x]>
 <recordedOn value="[dateTime]"/><!-- 0..1 When statement was recorded -->
 <source><!-- 0..1 Reference(Patient|Practitioner|RelatedPerson) Who made the statement --></source>
 <device><!-- 1..1 Reference(Device) Reference to device used --></device>
 <indication><!-- 0..* CodeableConcept Why device was used --></indication>
 <bodySite><!-- 0..1 CodeableConcept Target body site --></bodySite>
 <note><!-- 0..* Annotation Addition details (comments, instructions) --></note>
</DeviceUseStatement>

Turtle Template

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


[ a fhir:DeviceUseStatement;
  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:DeviceUseStatement.identifier [ Identifier ], ... ; # 0..* External identifier for this record
  fhir:DeviceUseStatement.status [ code ]; # 1..1 active | completed | entered-in-error +
  fhir:DeviceUseStatement.subject [ Reference(Patient|Group) ]; # 1..1 Patient using device
  fhir:DeviceUseStatement.whenUsed [ Period ]; # 0..1 Period device was used
  # DeviceUseStatement.timing[x] : 0..1 How often  the device was used. One of these 3
    fhir:DeviceUseStatement.timingTiming [ Timing ]
    fhir:DeviceUseStatement.timingPeriod [ Period ]
    fhir:DeviceUseStatement.timingDateTime [ dateTime ]
  fhir:DeviceUseStatement.recordedOn [ dateTime ]; # 0..1 When statement was recorded
  fhir:DeviceUseStatement.source [ Reference(Patient|Practitioner|RelatedPerson) ]; # 0..1 Who made the statement
  fhir:DeviceUseStatement.device [ Reference(Device) ]; # 1..1 Reference to device used
  fhir:DeviceUseStatement.indication [ CodeableConcept ], ... ; # 0..* Why device was used
  fhir:DeviceUseStatement.bodySite [ CodeableConcept ]; # 0..1 Target body site
  fhir:DeviceUseStatement.note [ Annotation ], ... ; # 0..* Addition details (comments, instructions)
]

Changes since DSTU2

DeviceUseStatement
DeviceUseStatement.status
  • Added Element
DeviceUseStatement.subject
  • Add Reference(Group)
DeviceUseStatement.source
  • Added Element
DeviceUseStatement.bodySite
  • Renamed from bodySite[x] to bodySite
  • Remove Reference(BodySite)
DeviceUseStatement.note
  • Added Element
DeviceUseStatement.notes
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

See R2 <--> R3 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (1 errors).).

 

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle)

12.23.3.1 Terminology Bindings

PathDefinitionTypeReference
DeviceUseStatement.status A coded concept indicating the current status of a the Device UsageRequiredDeviceUseStatementStatus
DeviceUseStatement.bodySite Codes describing anatomical locations. May include laterality.ExampleSNOMED CT Body Structures

Notes to reviewers:

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

12.23.4 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
devicereferenceSearch by deviceDeviceUseStatement.device
(Device)
identifiertokenSearch by identifierDeviceUseStatement.identifier
patientreferenceSearch by subject - a patientDeviceUseStatement.subject
(Group, Patient)		31 Resources
subjectreferenceSearch by subjectDeviceUseStatement.subject
(Group, Patient)