This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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 or another provider. 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 DeviceUseRequest 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 |
---|---|---|---|---|
DeviceUseStatement | Σ | DomainResource | Record of use of a device | |
bodySite | Σ | 0..1 | CodeableConcept | Target body site SNOMED CT Body Structures (Example) |
whenUsed | Σ | 0..1 | Period | Period device was used |
device | Σ | 1..1 | Reference(Device) | Reference to device used |
identifier | Σ | 0..* | Identifier | External identifier for this record |
indication | Σ | 0..* | CodeableConcept | Why device was used |
notes | Σ | 0..* | string | Addition details (comments, instructions) |
recordedOn | Σ | 0..1 | dateTime | When statement was recorded |
subject | Σ | 1..1 | Reference(Patient) | Patient using device |
timing[x] | Σ | 0..1 | How often the device was used | |
timingTiming | Timing | |||
timingPeriod | Period | |||
timingDateTime | dateTime | |||
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 --> <bodySite><!-- 0..1 CodeableConcept Target body site --></bodySite> <whenUsed><!-- 0..1 Period Period device was used --></whenUsed> <device><!-- 1..1 Reference(Device) Reference to device used --></device> <identifier><!-- 0..* Identifier External identifier for this record --></identifier> <indication><!-- 0..* CodeableConcept Why device was used --></indication> <notes value="[string]"/><!-- 0..* Addition details (comments, instructions) --> <recordedOn value="[dateTime]"/><!-- 0..1 When statement was recorded --> <subject><!-- 1..1 Reference(Patient) Patient using device --></subject> <timing[x]><!-- 0..1 Timing|Period|dateTime How often the device was used --></timing[x]> </DeviceUseStatement>
JSON Template
{ "resourceType" : "DeviceUseStatement", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "bodySite" : { CodeableConcept }, // Target body site "whenUsed" : { Period }, // Period device was used "device" : { Reference(Device) }, // R! Reference to device used "identifier" : [{ Identifier }], // External identifier for this record "indication" : [{ CodeableConcept }], // Why device was used "notes" : ["<string>"], // Addition details (comments, instructions) "recordedOn" : "<dateTime>", // When statement was recorded "subject" : { Reference(Patient) }, // R! Patient using device // timing[x]: How often the device was used. One of these 3: "timingTiming" : { Timing } "timingPeriod" : { Period } "timingDateTime" : "<dateTime>" }
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.bodySite [ CodeableConcept ]; # 0..1 Target body site fhir:DeviceUseStatement.whenUsed [ Period ]; # 0..1 Period device was used fhir:DeviceUseStatement.device [ Reference(Device) ]; # 1..1 Reference to device used fhir:DeviceUseStatement.identifier [ Identifier ], ... ; # 0..* External identifier for this record fhir:DeviceUseStatement.indication [ CodeableConcept ], ... ; # 0..* Why device was used fhir:DeviceUseStatement.notes [ string ], ... ; # 0..* Addition details (comments, instructions) fhir:DeviceUseStatement.recordedOn [ dateTime ]; # 0..1 When statement was recorded fhir:DeviceUseStatement.subject [ Reference(Patient) ]; # 1..1 Patient using device # 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 ] ]
Changes since DSTU2
DeviceUseStatement | |
DeviceUseStatement.bodySite |
Renamed from bodySite[x] to bodySite Remove Reference(BodySite) |
See the Full Difference for further information
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceUseStatement | Σ | DomainResource | Record of use of a device | |
bodySite | Σ | 0..1 | CodeableConcept | Target body site SNOMED CT Body Structures (Example) |
whenUsed | Σ | 0..1 | Period | Period device was used |
device | Σ | 1..1 | Reference(Device) | Reference to device used |
identifier | Σ | 0..* | Identifier | External identifier for this record |
indication | Σ | 0..* | CodeableConcept | Why device was used |
notes | Σ | 0..* | string | Addition details (comments, instructions) |
recordedOn | Σ | 0..1 | dateTime | When statement was recorded |
subject | Σ | 1..1 | Reference(Patient) | Patient using device |
timing[x] | Σ | 0..1 | How often the device was used | |
timingTiming | Timing | |||
timingPeriod | Period | |||
timingDateTime | dateTime | |||
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 --> <bodySite><!-- 0..1 CodeableConcept Target body site --></bodySite> <whenUsed><!-- 0..1 Period Period device was used --></whenUsed> <device><!-- 1..1 Reference(Device) Reference to device used --></device> <identifier><!-- 0..* Identifier External identifier for this record --></identifier> <indication><!-- 0..* CodeableConcept Why device was used --></indication> <notes value="[string]"/><!-- 0..* Addition details (comments, instructions) --> <recordedOn value="[dateTime]"/><!-- 0..1 When statement was recorded --> <subject><!-- 1..1 Reference(Patient) Patient using device --></subject> <timing[x]><!-- 0..1 Timing|Period|dateTime How often the device was used --></timing[x]> </DeviceUseStatement>
JSON Template
{ "resourceType" : "DeviceUseStatement", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "bodySite" : { CodeableConcept }, // Target body site "whenUsed" : { Period }, // Period device was used "device" : { Reference(Device) }, // R! Reference to device used "identifier" : [{ Identifier }], // External identifier for this record "indication" : [{ CodeableConcept }], // Why device was used "notes" : ["<string>"], // Addition details (comments, instructions) "recordedOn" : "<dateTime>", // When statement was recorded "subject" : { Reference(Patient) }, // R! Patient using device // timing[x]: How often the device was used. One of these 3: "timingTiming" : { Timing } "timingPeriod" : { Period } "timingDateTime" : "<dateTime>" }
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.bodySite [ CodeableConcept ]; # 0..1 Target body site fhir:DeviceUseStatement.whenUsed [ Period ]; # 0..1 Period device was used fhir:DeviceUseStatement.device [ Reference(Device) ]; # 1..1 Reference to device used fhir:DeviceUseStatement.identifier [ Identifier ], ... ; # 0..* External identifier for this record fhir:DeviceUseStatement.indication [ CodeableConcept ], ... ; # 0..* Why device was used fhir:DeviceUseStatement.notes [ string ], ... ; # 0..* Addition details (comments, instructions) fhir:DeviceUseStatement.recordedOn [ dateTime ]; # 0..1 When statement was recorded fhir:DeviceUseStatement.subject [ Reference(Patient) ]; # 1..1 Patient using device # 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 ] ]
Changes since DSTU2
DeviceUseStatement | |
DeviceUseStatement.bodySite |
Renamed from bodySite[x] to bodySite Remove Reference(BodySite) |
See the Full Difference for further information
Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle), JSON-LD (for RDF as JSON-LD),
Path | Definition | Type | Reference |
---|---|---|---|
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 | Paths | In Common |
device | reference | Search by device | DeviceUseStatement.device (Device) | |
patient | reference | Search by subject - a patient | DeviceUseStatement.subject (Patient) | 31 Resources |
subject | reference | Search by subject | DeviceUseStatement.subject (Patient) |