This page is part of the FHIR Specification (v4.5.0: R5 Preview #3). 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 | Trial Use | Security Category: Patient | Compartments: Patient |
A record of a device being used by a patient where the record is the result of a report from the patient or a clinician.
This resource is an event resource from a FHIR workflow perspective - see 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, a 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.
No resources refer to this resource directly.
This resource implements the Event pattern.
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceUseStatement | TU | DomainResource | Record of use of a device Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
identifier | Σ | 0..* | Identifier | External identifier for this record |
basedOn | Σ | 0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order |
status | ?!Σ | 1..1 | code | active | completed | entered-in-error + DeviceUseStatementStatus (Required) |
category | 0..* | CodeableConcept | The category of the statement - classifying how the statement is made | |
subject | Σ | 1..1 | Reference(Patient | Group) | Patient using device |
derivedFrom | Σ | 0..* | Reference(ServiceRequest | Procedure | Claim | Observation | QuestionnaireResponse | DocumentReference) | Supporting information |
context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | The encounter or episode of care that establishes the context for this device use statement |
timing[x] | Σ | 0..1 | How often the device was used | |
timingTiming | Timing | |||
timingPeriod | Period | |||
timingDateTime | dateTime | |||
dateAsserted | Σ | 0..1 | dateTime | When the statement was made (and recorded) |
usageStatus | 0..1 | CodeableConcept | The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement | |
usageReason | 0..* | CodeableConcept | The reason for asserting the usage status - for example forgot, lost, stolen, broken | |
informationSource | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Who made the statement |
device | Σ | 1..1 | CodeableReference(Device | DeviceDefinition) | Code or Reference to device used |
reason | Σ | 0..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) | Why device was used |
bodySite | Σ | 0..1 | CodeableReference(BodyStructure) | Target body site SNOMED CT Body Structures (Example) |
note | 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 + --> <category><!-- 0..* CodeableConcept The category of the statement - classifying how the statement is made --></category> <subject><!-- 1..1 Reference(Group|Patient) Patient using device --></subject> <derivedFrom><!-- 0..* Reference(Claim|DocumentReference|Observation|Procedure| QuestionnaireResponse|ServiceRequest) Supporting information --></derivedFrom> <context><!-- 0..1 Reference(Encounter|EpisodeOfCare) The encounter or episode of care that establishes the context for this device use statement --></context> <timing[x]><!-- 0..1 Timing|Period|dateTime How often the device was used --></timing[x]> <dateAsserted value="[dateTime]"/><!-- 0..1 When the statement was made (and recorded) --> <usageStatus><!-- 0..1 CodeableConcept The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement --></usageStatus> <usageReason><!-- 0..* CodeableConcept The reason for asserting the usage status - for example forgot, lost, stolen, broken --></usageReason> <informationSource><!-- 0..1 Reference(Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) Who made the statement --></informationSource> <device><!-- 1..1 CodeableReference(Device|DeviceDefinition) Code or Reference to device used --></device> <reason><!-- 0..* CodeableReference(Condition|DiagnosticReport|DocumentReference| Observation) Why device was used --></reason> <bodySite><!-- 0..1 CodeableReference(BodyStructure) 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 + "category" : [{ CodeableConcept }], // The category of the statement - classifying how the statement is made "subject" : { Reference(Group|Patient) }, // R! Patient using device "derivedFrom" : [{ Reference(Claim|DocumentReference|Observation|Procedure| QuestionnaireResponse|ServiceRequest) }], // Supporting information "context" : { Reference(Encounter|EpisodeOfCare) }, // The encounter or episode of care that establishes the context for this device use statement // timing[x]: How often the device was used. One of these 3: "timingTiming" : { Timing }, "timingPeriod" : { Period }, "timingDateTime" : "<dateTime>", "dateAsserted" : "<dateTime>", // When the statement was made (and recorded) "usageStatus" : { CodeableConcept }, // The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement "usageReason" : [{ CodeableConcept }], // The reason for asserting the usage status - for example forgot, lost, stolen, broken "informationSource" : { Reference(Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) }, // Who made the statement "device" : { CodeableReference(Device|DeviceDefinition) }, // R! Code or Reference to device used "reason" : [{ CodeableReference(Condition|DiagnosticReport|DocumentReference| Observation) }], // Why device was used "bodySite" : { CodeableReference(BodyStructure) }, // 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.category [ CodeableConcept ], ... ; # 0..* The category of the statement - classifying how the statement is made fhir:DeviceUseStatement.subject [ Reference(Group|Patient) ]; # 1..1 Patient using device fhir:DeviceUseStatement.derivedFrom [ Reference(Claim|DocumentReference|Observation|Procedure|QuestionnaireResponse| ServiceRequest) ], ... ; # 0..* Supporting information fhir:DeviceUseStatement.context [ Reference(Encounter|EpisodeOfCare) ]; # 0..1 The encounter or episode of care that establishes the context for this device use statement # 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.dateAsserted [ dateTime ]; # 0..1 When the statement was made (and recorded) fhir:DeviceUseStatement.usageStatus [ CodeableConcept ]; # 0..1 The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement fhir:DeviceUseStatement.usageReason [ CodeableConcept ], ... ; # 0..* The reason for asserting the usage status - for example forgot, lost, stolen, broken fhir:DeviceUseStatement.informationSource [ Reference(Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Who made the statement fhir:DeviceUseStatement.device [ CodeableReference(Device|DeviceDefinition) ]; # 1..1 Code or Reference to device used fhir:DeviceUseStatement.reason [ CodeableReference(Condition|DiagnosticReport|DocumentReference|Observation) ], ... ; # 0..* Why device was used fhir:DeviceUseStatement.bodySite [ CodeableReference(BodyStructure) ]; # 0..1 Target body site fhir:DeviceUseStatement.note [ Annotation ], ... ; # 0..* Addition details (comments, instructions) ]
Changes since R3
DeviceUseStatement | |
DeviceUseStatement.status |
|
DeviceUseStatement.category |
|
DeviceUseStatement.context |
|
DeviceUseStatement.dateAsserted |
|
DeviceUseStatement.usageStatus |
|
DeviceUseStatement.usageReason |
|
DeviceUseStatement.informationSource |
|
DeviceUseStatement.device |
|
DeviceUseStatement.reason |
|
DeviceUseStatement.bodySite |
|
DeviceUseStatement.recordedOn |
|
DeviceUseStatement.source |
|
DeviceUseStatement.reasonCode |
|
DeviceUseStatement.reasonReference |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
See R3 <--> R4 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and all r3 resources are valid.)
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceUseStatement | TU | DomainResource | Record of use of a device Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
identifier | Σ | 0..* | Identifier | External identifier for this record |
basedOn | Σ | 0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order |
status | ?!Σ | 1..1 | code | active | completed | entered-in-error + DeviceUseStatementStatus (Required) |
category | 0..* | CodeableConcept | The category of the statement - classifying how the statement is made | |
subject | Σ | 1..1 | Reference(Patient | Group) | Patient using device |
derivedFrom | Σ | 0..* | Reference(ServiceRequest | Procedure | Claim | Observation | QuestionnaireResponse | DocumentReference) | Supporting information |
context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | The encounter or episode of care that establishes the context for this device use statement |
timing[x] | Σ | 0..1 | How often the device was used | |
timingTiming | Timing | |||
timingPeriod | Period | |||
timingDateTime | dateTime | |||
dateAsserted | Σ | 0..1 | dateTime | When the statement was made (and recorded) |
usageStatus | 0..1 | CodeableConcept | The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement | |
usageReason | 0..* | CodeableConcept | The reason for asserting the usage status - for example forgot, lost, stolen, broken | |
informationSource | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Who made the statement |
device | Σ | 1..1 | CodeableReference(Device | DeviceDefinition) | Code or Reference to device used |
reason | Σ | 0..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) | Why device was used |
bodySite | Σ | 0..1 | CodeableReference(BodyStructure) | Target body site SNOMED CT Body Structures (Example) |
note | 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 + --> <category><!-- 0..* CodeableConcept The category of the statement - classifying how the statement is made --></category> <subject><!-- 1..1 Reference(Group|Patient) Patient using device --></subject> <derivedFrom><!-- 0..* Reference(Claim|DocumentReference|Observation|Procedure| QuestionnaireResponse|ServiceRequest) Supporting information --></derivedFrom> <context><!-- 0..1 Reference(Encounter|EpisodeOfCare) The encounter or episode of care that establishes the context for this device use statement --></context> <timing[x]><!-- 0..1 Timing|Period|dateTime How often the device was used --></timing[x]> <dateAsserted value="[dateTime]"/><!-- 0..1 When the statement was made (and recorded) --> <usageStatus><!-- 0..1 CodeableConcept The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement --></usageStatus> <usageReason><!-- 0..* CodeableConcept The reason for asserting the usage status - for example forgot, lost, stolen, broken --></usageReason> <informationSource><!-- 0..1 Reference(Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) Who made the statement --></informationSource> <device><!-- 1..1 CodeableReference(Device|DeviceDefinition) Code or Reference to device used --></device> <reason><!-- 0..* CodeableReference(Condition|DiagnosticReport|DocumentReference| Observation) Why device was used --></reason> <bodySite><!-- 0..1 CodeableReference(BodyStructure) 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 + "category" : [{ CodeableConcept }], // The category of the statement - classifying how the statement is made "subject" : { Reference(Group|Patient) }, // R! Patient using device "derivedFrom" : [{ Reference(Claim|DocumentReference|Observation|Procedure| QuestionnaireResponse|ServiceRequest) }], // Supporting information "context" : { Reference(Encounter|EpisodeOfCare) }, // The encounter or episode of care that establishes the context for this device use statement // timing[x]: How often the device was used. One of these 3: "timingTiming" : { Timing }, "timingPeriod" : { Period }, "timingDateTime" : "<dateTime>", "dateAsserted" : "<dateTime>", // When the statement was made (and recorded) "usageStatus" : { CodeableConcept }, // The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement "usageReason" : [{ CodeableConcept }], // The reason for asserting the usage status - for example forgot, lost, stolen, broken "informationSource" : { Reference(Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) }, // Who made the statement "device" : { CodeableReference(Device|DeviceDefinition) }, // R! Code or Reference to device used "reason" : [{ CodeableReference(Condition|DiagnosticReport|DocumentReference| Observation) }], // Why device was used "bodySite" : { CodeableReference(BodyStructure) }, // 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.category [ CodeableConcept ], ... ; # 0..* The category of the statement - classifying how the statement is made fhir:DeviceUseStatement.subject [ Reference(Group|Patient) ]; # 1..1 Patient using device fhir:DeviceUseStatement.derivedFrom [ Reference(Claim|DocumentReference|Observation|Procedure|QuestionnaireResponse| ServiceRequest) ], ... ; # 0..* Supporting information fhir:DeviceUseStatement.context [ Reference(Encounter|EpisodeOfCare) ]; # 0..1 The encounter or episode of care that establishes the context for this device use statement # 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.dateAsserted [ dateTime ]; # 0..1 When the statement was made (and recorded) fhir:DeviceUseStatement.usageStatus [ CodeableConcept ]; # 0..1 The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement fhir:DeviceUseStatement.usageReason [ CodeableConcept ], ... ; # 0..* The reason for asserting the usage status - for example forgot, lost, stolen, broken fhir:DeviceUseStatement.informationSource [ Reference(Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Who made the statement fhir:DeviceUseStatement.device [ CodeableReference(Device|DeviceDefinition) ]; # 1..1 Code or Reference to device used fhir:DeviceUseStatement.reason [ CodeableReference(Condition|DiagnosticReport|DocumentReference|Observation) ], ... ; # 0..* Why device was used fhir:DeviceUseStatement.bodySite [ CodeableReference(BodyStructure) ]; # 0..1 Target body site fhir:DeviceUseStatement.note [ Annotation ], ... ; # 0..* Addition details (comments, instructions) ]
Changes since Release 3
DeviceUseStatement | |
DeviceUseStatement.status |
|
DeviceUseStatement.category |
|
DeviceUseStatement.context |
|
DeviceUseStatement.dateAsserted |
|
DeviceUseStatement.usageStatus |
|
DeviceUseStatement.usageReason |
|
DeviceUseStatement.informationSource |
|
DeviceUseStatement.device |
|
DeviceUseStatement.reason |
|
DeviceUseStatement.bodySite |
|
DeviceUseStatement.recordedOn |
|
DeviceUseStatement.source |
|
DeviceUseStatement.reasonCode |
|
DeviceUseStatement.reasonReference |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
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 spreadsheet version & the dependency analysis a
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.
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 D | token | Search by device | DeviceUseStatement.device.concept | |
identifier | token | Search by identifier | DeviceUseStatement.identifier | |
patient | reference | Search by subject - a patient | DeviceUseStatement.subject (Group, Patient) | 33 Resources |
subject | reference | Search by subject | DeviceUseStatement.subject (Group, Patient) |