STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). 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.9 Resource DeviceUseStatement - Content

This resource is marked as a draft.

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.

12.9.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 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.

12.9.2 Boundaries and Relationships

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
bodySite[x]	Σ	0..1		Target body site
bodySiteCodeableConcept			CodeableConcept
bodySiteReference			Reference(BodySite)
whenUsed	Σ	0..1	Period
device	Σ	1..1	Reference(Device)
identifier	Σ	0..*	Identifier
indication	Σ	0..*	CodeableConcept
notes	Σ	0..*	string
recordedOn	Σ	0..1	dateTime
subject	Σ	1..1	Reference(Patient)
timing[x]	Σ	0..1
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[x]><!-- 0..1 CodeableConcept|Reference(BodySite) Target body site --></bodySite[x]>
 <whenUsed><!-- 0..1 Period  --></whenUsed>
 <device><!-- 1..1 Reference(Device)  --></device>
 <identifier><!-- 0..* Identifier  --></identifier>
 <indication><!-- 0..* CodeableConcept  --></indication>
 <notes value="[string]"/><!-- 0..*  -->
 <recordedOn value="[dateTime]"/><!-- 0..1  -->
 <subject><!-- 1..1 Reference(Patient)  --></subject>
 <timing[x]><!-- 0..1 Timing|Period|dateTime  --></timing[x]>
</DeviceUseStatement>

JSON Template

{
  "resourceType" : "DeviceUseStatement",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  // bodySite[x]: Target body site. One of these 2:
  "bodySiteCodeableConcept" : { CodeableConcept },
  "bodySiteReference" : { Reference(BodySite) },
  "whenUsed" : { Period }, // 
  "device" : { Reference(Device) }, // R!  
  "identifier" : [{ Identifier }], // 
  "indication" : [{ CodeableConcept }], // 
  "notes" : ["<string>"], // 
  "recordedOn" : "<dateTime>", // 
  "subject" : { Reference(Patient) }, // R!  
  // timing[x]: . 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
  # DeviceUseStatement.bodySite[x] : 0..1 Target body site. One of these 2
    fhir:DeviceUseStatement.bodySiteCodeableConcept [ CodeableConcept ]
    fhir:DeviceUseStatement.bodySiteReference [ Reference(BodySite) ]
  fhir:DeviceUseStatement.whenUsed [ Period ]; # 0..1 
  fhir:DeviceUseStatement.device [ Reference(Device) ]; # 1..1 
  fhir:DeviceUseStatement.identifier [ Identifier ], ... ; # 0..* 
  fhir:DeviceUseStatement.indication [ CodeableConcept ], ... ; # 0..* 
  fhir:DeviceUseStatement.notes [ string ], ... ; # 0..* 
  fhir:DeviceUseStatement.recordedOn [ dateTime ]; # 0..1 
  fhir:DeviceUseStatement.subject [ Reference(Patient) ]; # 1..1 
  # DeviceUseStatement.timing[x] : 0..1 . One of these 3
    fhir:DeviceUseStatement.timingTiming [ Timing ]
    fhir:DeviceUseStatement.timingPeriod [ Period ]
    fhir:DeviceUseStatement.timingDateTime [ dateTime ]
]

Changes since DSTU2

DeviceUseStatement

No Changes

See the Full Difference for further information

Structure

Name	Flags	Card.	Type	Description & Constraints
DeviceUseStatement	Σ		DomainResource
bodySite[x]	Σ	0..1		Target body site
bodySiteCodeableConcept			CodeableConcept
bodySiteReference			Reference(BodySite)
whenUsed	Σ	0..1	Period
device	Σ	1..1	Reference(Device)
identifier	Σ	0..*	Identifier
indication	Σ	0..*	CodeableConcept
notes	Σ	0..*	string
recordedOn	Σ	0..1	dateTime
subject	Σ	1..1	Reference(Patient)
timing[x]	Σ	0..1
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[x]><!-- 0..1 CodeableConcept|Reference(BodySite) Target body site --></bodySite[x]>
 <whenUsed><!-- 0..1 Period  --></whenUsed>
 <device><!-- 1..1 Reference(Device)  --></device>
 <identifier><!-- 0..* Identifier  --></identifier>
 <indication><!-- 0..* CodeableConcept  --></indication>
 <notes value="[string]"/><!-- 0..*  -->
 <recordedOn value="[dateTime]"/><!-- 0..1  -->
 <subject><!-- 1..1 Reference(Patient)  --></subject>
 <timing[x]><!-- 0..1 Timing|Period|dateTime  --></timing[x]>
</DeviceUseStatement>

JSON Template

{
  "resourceType" : "DeviceUseStatement",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  // bodySite[x]: Target body site. One of these 2:
  "bodySiteCodeableConcept" : { CodeableConcept },
  "bodySiteReference" : { Reference(BodySite) },
  "whenUsed" : { Period }, // 
  "device" : { Reference(Device) }, // R!  
  "identifier" : [{ Identifier }], // 
  "indication" : [{ CodeableConcept }], // 
  "notes" : ["<string>"], // 
  "recordedOn" : "<dateTime>", // 
  "subject" : { Reference(Patient) }, // R!  
  // timing[x]: . 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
  # DeviceUseStatement.bodySite[x] : 0..1 Target body site. One of these 2
    fhir:DeviceUseStatement.bodySiteCodeableConcept [ CodeableConcept ]
    fhir:DeviceUseStatement.bodySiteReference [ Reference(BodySite) ]
  fhir:DeviceUseStatement.whenUsed [ Period ]; # 0..1 
  fhir:DeviceUseStatement.device [ Reference(Device) ]; # 1..1 
  fhir:DeviceUseStatement.identifier [ Identifier ], ... ; # 0..* 
  fhir:DeviceUseStatement.indication [ CodeableConcept ], ... ; # 0..* 
  fhir:DeviceUseStatement.notes [ string ], ... ; # 0..* 
  fhir:DeviceUseStatement.recordedOn [ dateTime ]; # 0..1 
  fhir:DeviceUseStatement.subject [ Reference(Patient) ]; # 1..1 
  # DeviceUseStatement.timing[x] : 0..1 . One of these 3
    fhir:DeviceUseStatement.timingTiming [ Timing ]
    fhir:DeviceUseStatement.timingPeriod [ Period ]
    fhir:DeviceUseStatement.timingDateTime [ dateTime ]
]

Changes since DSTU2

DeviceUseStatement

No Changes

See the Full Difference for further information

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

Notes to reviewers:

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

12.9.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.

Name	Type	Description	Paths
device	reference	Search by device	DeviceUseStatement.device (Device)
patient	reference	Search by subject - a patient	DeviceUseStatement.subject (Patient)
subject	reference	Search by subject	DeviceUseStatement.subject (Patient)