Release 4 4B

This page is part of the FHIR Specification (v4.0.1: R4 (v4.3.0: R4B - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). ). 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 R4B R4 R3 R2

12.20 Resource DeviceUseStatement - Content

Orders and Observations Work Group Maturity Level : 0   Trial Use Security Category : Patient 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.20.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.20.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.20.3 References

No resources refer to this resource directly.

This resource implements the Event pattern.

12.20.3 12.20.4 Resource Content

UML Diagram ( Legend )

DeviceUseStatement ( DomainResource ) An external identifier for this statement such as an IRI identifier : Identifier [0..*] A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement basedOn : Reference [0..*] « ServiceRequest » 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 the Device Usage. null (Strength=Required) DeviceUseStatementStatus ! » The patient who used the device subject : Reference [1..1] « Patient | Group » Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement derivedFrom : Reference [0..*] « ServiceRequest | Procedure | Claim | Observation | QuestionnaireResponse | DocumentReference » How often the device was used timing[x] : Type Element [0..1] « Timing | Period | dateTime » The time at which the statement was made/recorded recordedOn : dateTime [0..1] Who reported the device was being used by the patient source : Reference [0..1] « Patient | Practitioner | PractitionerRole | RelatedPerson » The details of the device used device : Reference [1..1] « Device » Reason or justification for the use of the device reasonCode : CodeableConcept [0..*] Indicates another resource whose existence justifies this DeviceUseStatement reasonReference : Reference [0..*] « Condition | Observation | DiagnosticReport | DocumentReference | Media » Indicates the anotomic location on the subject's body where the device was used ( i.e. the target) bodySite : CodeableConcept [0..1] « Codes describing anatomical locations. May include laterality. null (Strength=Example) SNOMEDCTBodyStructures ?? » 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 statement note : Annotation [0..*]

XML Template

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.basedOn [ Reference(ServiceRequest) ], ... ; # 0..* Fulfills plan, proposal or order
  fhir:DeviceUseStatement.status [ code ]; # 1..1 active | completed | entered-in-error +
  fhir:
  fhir:|
  

  fhir:DeviceUseStatement.subject [ Reference(Group|Patient) ]; # 1..1 Patient using device
  fhir:DeviceUseStatement.derivedFrom [ Reference(Claim|DocumentReference|Observation|Procedure|QuestionnaireResponse|
  ServiceRequest) ], ... ; # 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|PractitionerRole|RelatedPerson) ]; # 0..1 Who made the statement
  fhir:DeviceUseStatement.device [ Reference(Device) ]; # 1..1 Reference to device used
  fhir:DeviceUseStatement.reasonCode [ CodeableConcept ], ... ; # 0..* Why device was used
  fhir:

  fhir:DeviceUseStatement.reasonReference [ Reference(Condition|DiagnosticReport|DocumentReference|Media|Observation) ], ... ; # 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 R3 R4

DeviceUseStatement DeviceUseStatement.basedOn Added Element DeviceUseStatement.status Change value set from http://hl7.org/fhir/ValueSet/device-statement-status to http://hl7.org/fhir/ValueSet/device-statement-status|4.0.1 DeviceUseStatement.derivedFrom Added Element DeviceUseStatement.source
  • Type Reference: Added Target Type PractitionerRole DeviceUseStatement.reasonCode Added Element DeviceUseStatement.reasonReference Added Element DeviceUseStatement.whenUsed deleted DeviceUseStatement.indication deleted No Changes

See the Full Difference for further information

This analysis is available as XML or JSON .

Conversions between R3 and R4

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

UML Diagram ( Legend )

DeviceUseStatement ( DomainResource ) An external identifier for this statement such as an IRI identifier : Identifier [0..*] A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement basedOn : Reference [0..*] « ServiceRequest » 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 the Device Usage. null (Strength=Required) DeviceUseStatementStatus ! » The patient who used the device subject : Reference [1..1] « Patient | Group » Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement derivedFrom : Reference [0..*] « ServiceRequest | Procedure | Claim | Observation | QuestionnaireResponse | DocumentReference » How often the device was used timing[x] : Type Element [0..1] « Timing | Period | dateTime » The time at which the statement was made/recorded recordedOn : dateTime [0..1] Who reported the device was being used by the patient source : Reference [0..1] « Patient | Practitioner | PractitionerRole | RelatedPerson » The details of the device used device : Reference [1..1] « Device » Reason or justification for the use of the device reasonCode : CodeableConcept [0..*] Indicates another resource whose existence justifies this DeviceUseStatement reasonReference : Reference [0..*] « Condition | Observation | DiagnosticReport | DocumentReference | Media » Indicates the anotomic location on the subject's body where the device was used ( i.e. the target) bodySite : CodeableConcept [0..1] « Codes describing anatomical locations. May include laterality. null (Strength=Example) SNOMEDCTBodyStructures ?? » 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 statement note : Annotation [0..*]

XML Template

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.basedOn [ Reference(ServiceRequest) ], ... ; # 0..* Fulfills plan, proposal or order
  fhir:DeviceUseStatement.status [ code ]; # 1..1 active | completed | entered-in-error +
  fhir:
  fhir:|
  

  fhir:DeviceUseStatement.subject [ Reference(Group|Patient) ]; # 1..1 Patient using device
  fhir:DeviceUseStatement.derivedFrom [ Reference(Claim|DocumentReference|Observation|Procedure|QuestionnaireResponse|
  ServiceRequest) ], ... ; # 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|PractitionerRole|RelatedPerson) ]; # 0..1 Who made the statement
  fhir:DeviceUseStatement.device [ Reference(Device) ]; # 1..1 Reference to device used
  fhir:DeviceUseStatement.reasonCode [ CodeableConcept ], ... ; # 0..* Why device was used
  fhir:

  fhir:DeviceUseStatement.reasonReference [ Reference(Condition|DiagnosticReport|DocumentReference|Media|Observation) ], ... ; # 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 Release 3 4

DeviceUseStatement DeviceUseStatement.basedOn Added Element DeviceUseStatement.status Change value set from http://hl7.org/fhir/ValueSet/device-statement-status to http://hl7.org/fhir/ValueSet/device-statement-status|4.0.1 DeviceUseStatement.derivedFrom Added Element DeviceUseStatement.source
  • Type Reference: Added Target Type PractitionerRole DeviceUseStatement.reasonCode Added Element DeviceUseStatement.reasonReference Added Element DeviceUseStatement.whenUsed deleted DeviceUseStatement.indication deleted No Changes

See the Full Difference for further information

This analysis is available as XML or JSON .

Conversions between R3 and R4

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

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions & the dependency analysis

12.20.3.1 12.20.4.1 Terminology Bindings

Path Definition Type Reference
DeviceUseStatement.status A coded concept indicating the current status of the Device Usage. Required DeviceUseStatementStatus
DeviceUseStatement.bodySite Codes describing anatomical locations. May include laterality. Example SNOMEDCTBodyStructures

Notes to reviewers:

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

12.20.4 12.20.5 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 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 DeviceUseStatement.subject.where(resolve() is Patient)
( Group , Patient ) 		33 Resources
subject reference Search by subject DeviceUseStatement.subject
( Group , Patient )