This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
STU
3).
(v3.5.0:
R4
Ballot
#2).
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
Orders
and
Observations
Work
Group
|
Maturity Level : 0 |
|
Compartments : 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.
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.
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.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
TU | DomainResource |
Record
of
use
of
a
device
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
External
identifier
for
this
record
|
| Σ | 0..* | Reference ( ServiceRequest ) |
Fulfills
plan,
proposal
or
order
|
![]()
|
?! Σ | 1..1 | code |
active
|
completed
|
entered-in-error
+
DeviceUseStatementStatus ( Required ) |
|
Σ | 1..1 | Reference ( Patient | Group ) | Patient using device |
|
Σ |
|
|
|
|
Σ | 0..1 | How often the device was used | |
|
Timing | |||
|
Period | |||
|
dateTime | |||
|
Σ | 0..1 | dateTime | When statement was recorded |
|
Σ | 0..1 | Reference ( Patient | Practitioner | RelatedPerson ) | Who made the statement |
|
Σ | 1..1 | Reference ( Device ) | Reference to device used |
|
Σ | 0..* | CodeableConcept |
Why
device
was
used
|
| Σ | 0..* | Reference ( Condition | Observation | DiagnosticReport | DocumentReference | Media ) |
Why
was
DeviceUseStatement
performed?
|
![]()
|
Σ | 0..1 | CodeableConcept |
Target
body
site
SNOMED CT Body Structures ( Example ) |
|
0..* | Annotation |
Addition
details
(comments,
instructions)
|
|
Documentation
for
this
format
|
||||
UML Diagram ( Legend )
XML Template
<<DeviceUseStatement xmlns="http://hl7.org/fhir"><!-- 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 + --> <subject><!-- 1..1 Reference(Patient|Group) Patient using device --></subject><</whenUsed><derivedFrom><!-- 0..* Reference(ServiceRequest|Procedure|Claim|Observation| QuestionnaireResponse|DocumentReference) Supporting information --></derivedFrom> <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> <</bodySite><reasonCode><!-- 0..* CodeableConcept Why device was used --></reasonCode> <reasonReference><!-- 0..* Reference(Condition|Observation|DiagnosticReport| DocumentReference|Media) Why was DeviceUseStatement performed? --></reasonReference> <bodySite><!-- 0..1 CodeableConcept Target body site --></bodySite> <note><!-- 0..* Annotation Addition details (comments, instructions) --></note> </DeviceUseStatement>
JSON Template
{
"resourceType" : "",
"resourceType" : "DeviceUseStatement",
// 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 +
"subject" : { Reference(Patient|Group) }, // R! Patient using device
"derivedFrom" : [{ Reference(ServiceRequest|Procedure|Claim|Observation|
QuestionnaireResponse|DocumentReference) }], // Supporting information
// timing[x]: How often the device was used. One of these 3:
" },
" },
">",
"
"
"
"
"
"
"timingTiming" : { Timing },
"timingPeriod" : { Period },
"timingDateTime" : "<dateTime>",
"recordedOn" : "<dateTime>", // When statement was recorded
"source" : { Reference(Patient|Practitioner|RelatedPerson) }, // Who made the statement
"device" : { Reference(Device) }, // R! Reference to device used
"reasonCode" : [{ CodeableConcept }], // Why device was used
"reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
DocumentReference|Media) }], // Why was DeviceUseStatement performed?
"bodySite" : { CodeableConcept }, // Target body site
"note" : [{ Annotation }] // Addition details (comments, instructions)
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ 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.basedOn [ Reference(ServiceRequest) ], ... ; # 0..* Fulfills plan, proposal or order fhir:DeviceUseStatement.status [ code ]; # 1..1 active | completed | entered-in-error + fhir:DeviceUseStatement.subject [ Reference(Patient|Group) ]; # 1..1 Patient using device
fhir:fhir:DeviceUseStatement.derivedFrom [ Reference(ServiceRequest|Procedure|Claim|Observation|QuestionnaireResponse| DocumentReference) ], ... ; # 0..* Supporting information # 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 usedfhir: fhir:fhir:DeviceUseStatement.reasonCode [ CodeableConcept ], ... ; # 0..* Why device was used fhir:DeviceUseStatement.reasonReference [ Reference(Condition|Observation|DiagnosticReport|DocumentReference|Media) ], ... ; # 0..* Why was DeviceUseStatement performed? fhir:DeviceUseStatement.bodySite [ CodeableConcept ]; # 0..1 Target body site fhir:DeviceUseStatement.note [ Annotation ], ... ; # 0..* Addition details (comments, instructions) ]
Changes
since
DSTU2
R3
| DeviceUseStatement | |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
See the Full Difference for further information
This analysis is available as XML or JSON .
See
R2
<-->
R3
<-->
R4
Conversion
Maps
(status
=
1
test
that
all
execute
ok.
All
tests
pass
1
fail
round-trip
testing
and
1
r3
resources
are
invalid
(1
(0
errors).
).
)
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
TU | DomainResource |
Record
of
use
of
a
device
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
External
identifier
for
this
record
|
| Σ | 0..* | Reference ( ServiceRequest ) |
Fulfills
plan,
proposal
or
order
|
![]()
|
?! Σ | 1..1 | code |
active
|
completed
|
entered-in-error
+
DeviceUseStatementStatus ( Required ) |
|
Σ | 1..1 | Reference ( Patient | Group ) | Patient using device |
|
Σ |
|
|
|
|
Σ | 0..1 | How often the device was used | |
|
Timing | |||
|
Period | |||
|
dateTime | |||
|
Σ | 0..1 | dateTime | When statement was recorded |
|
Σ | 0..1 | Reference ( Patient | Practitioner | RelatedPerson ) | Who made the statement |
|
Σ | 1..1 | Reference ( Device ) | Reference to device used |
|
Σ | 0..* | CodeableConcept |
Why
device
was
used
|
| Σ | 0..* | Reference ( Condition | Observation | DiagnosticReport | DocumentReference | Media ) |
Why
was
DeviceUseStatement
performed?
|
![]()
|
Σ | 0..1 | CodeableConcept |
Target
body
site
SNOMED CT Body Structures ( Example ) |
|
0..* | Annotation |
Addition
details
(comments,
instructions)
|
|
Documentation
for
this
format
|
||||
XML Template
<<DeviceUseStatement xmlns="http://hl7.org/fhir"><!-- 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 + --> <subject><!-- 1..1 Reference(Patient|Group) Patient using device --></subject><</whenUsed><derivedFrom><!-- 0..* Reference(ServiceRequest|Procedure|Claim|Observation| QuestionnaireResponse|DocumentReference) Supporting information --></derivedFrom> <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> <</bodySite><reasonCode><!-- 0..* CodeableConcept Why device was used --></reasonCode> <reasonReference><!-- 0..* Reference(Condition|Observation|DiagnosticReport| DocumentReference|Media) Why was DeviceUseStatement performed? --></reasonReference> <bodySite><!-- 0..1 CodeableConcept Target body site --></bodySite> <note><!-- 0..* Annotation Addition details (comments, instructions) --></note> </DeviceUseStatement>
JSON Template
{
"resourceType" : "",
"resourceType" : "DeviceUseStatement",
// 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 +
"subject" : { Reference(Patient|Group) }, // R! Patient using device
"derivedFrom" : [{ Reference(ServiceRequest|Procedure|Claim|Observation|
QuestionnaireResponse|DocumentReference) }], // Supporting information
// timing[x]: How often the device was used. One of these 3:
" },
" },
">",
"
"
"
"
"
"
"timingTiming" : { Timing },
"timingPeriod" : { Period },
"timingDateTime" : "<dateTime>",
"recordedOn" : "<dateTime>", // When statement was recorded
"source" : { Reference(Patient|Practitioner|RelatedPerson) }, // Who made the statement
"device" : { Reference(Device) }, // R! Reference to device used
"reasonCode" : [{ CodeableConcept }], // Why device was used
"reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
DocumentReference|Media) }], // Why was DeviceUseStatement performed?
"bodySite" : { CodeableConcept }, // Target body site
"note" : [{ Annotation }] // Addition details (comments, instructions)
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ 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.basedOn [ Reference(ServiceRequest) ], ... ; # 0..* Fulfills plan, proposal or order fhir:DeviceUseStatement.status [ code ]; # 1..1 active | completed | entered-in-error + fhir:DeviceUseStatement.subject [ Reference(Patient|Group) ]; # 1..1 Patient using device
fhir:fhir:DeviceUseStatement.derivedFrom [ Reference(ServiceRequest|Procedure|Claim|Observation|QuestionnaireResponse| DocumentReference) ], ... ; # 0..* Supporting information # 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 usedfhir: fhir:fhir:DeviceUseStatement.reasonCode [ CodeableConcept ], ... ; # 0..* Why device was used fhir:DeviceUseStatement.reasonReference [ Reference(Condition|Observation|DiagnosticReport|DocumentReference|Media) ], ... ; # 0..* Why was DeviceUseStatement performed? fhir:DeviceUseStatement.bodySite [ CodeableConcept ]; # 0..1 Target body site fhir:DeviceUseStatement.note [ Annotation ], ... ; # 0..* Addition details (comments, instructions) ]
Changes
since
DSTU2
Release
3
| DeviceUseStatement | |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
See the Full Difference for further information
This analysis is available as XML or JSON .
See
R2
<-->
R3
<-->
R4
Conversion
Maps
(status
=
1
test
that
all
execute
ok.
All
tests
pass
1
fail
round-trip
testing
and
1
r3
resources
are
invalid
(1
(0
errors).
).
)
Alternate
See
the
Profiles
&
Extensions
and
the
alternate
definitions:
Master
Definition
(
XML
,
+
JSON
),
,
XML
Schema
/
Schematron
(for
)
+
JSON
Schema
,
ShEx
(for
Turtle
)
+
see
the
extensions
&
the
dependency
analysis
| Path | Definition | Type | Reference |
|---|---|---|---|
| DeviceUseStatement.status |
A
coded
concept
indicating
the
current
status
of
a
the
Device
|
Required | DeviceUseStatementStatus |
| DeviceUseStatement.bodySite | Codes describing anatomical locations. May include laterality. | Example |
|
Notes to reviewers:
At this time, the code bindings are placeholders to be fleshed out upon further review by the community.
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
| Name | Type | Description | Expression | In Common |
| device | reference | Search by device |
DeviceUseStatement.device
( Device ) |
|
| identifier | token | Search by identifier | DeviceUseStatement.identifier | |
| patient | reference | Search by subject - a patient |
DeviceUseStatement.subject
( Group , Patient ) |
|
| subject | reference | Search by subject |
DeviceUseStatement.subject
( Group , Patient ) |