R4 Draft for Comment
WorkflowThis page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). 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 | Draft | 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
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> <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> <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" : "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/> .
Changes since DSTU2
| DeviceUseStatement | |
| DeviceUseStatement.basedOn |
|
| DeviceUseStatement.status |
|
| DeviceUseStatement.subject |
|
| DeviceUseStatement.derivedFrom |
|
| DeviceUseStatement.source |
|
| DeviceUseStatement.reasonCode |
|
| DeviceUseStatement.reasonReference |
|
| DeviceUseStatement.bodySite |
|
| DeviceUseStatement.note |
|
| DeviceUseStatement.whenUsed |
|
| DeviceUseStatement.indication |
|
| DeviceUseStatement.notes |
|
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
XML Template
<DeviceUseStatement xmlns="http://hl7.org/fhir">
JSON Template
{
"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/> .
Changes since DSTU2
| DeviceUseStatement | |
| DeviceUseStatement.basedOn |
|
| DeviceUseStatement.status |
|
| DeviceUseStatement.subject |
|
| DeviceUseStatement.derivedFrom |
|
| DeviceUseStatement.source |
|
| DeviceUseStatement.reasonCode |
|
| DeviceUseStatement.reasonReference |
|
| DeviceUseStatement.bodySite |
|
| DeviceUseStatement.note |
|
| DeviceUseStatement.whenUsed |
|
| DeviceUseStatement.indication |
|
| DeviceUseStatement.notes |
|
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 + 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 Usage | Required | DeviceUseStatementStatus |
| DeviceUseStatement.bodySite | Codes describing anatomical locations. May include laterality. | Example | SNOMED CT Body Structures |
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) | 29 Resources |
| subject | reference | Search by subject | DeviceUseStatement.subject (Group, Patient) |
®© HL7.org 2011+. FHIR Release 4 Draft for Comment (Jan-2018 v3.2.0-12885) generated on Wed, Dec 20, 2017 15:56+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change