12.26 Resource DeviceUsage - Content

Name	Flags	Card.	Type	Description & Constraints
DeviceUsage	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 | not-done | entered-in-error + Binding: Device Usage Status (Required)
category		0..*	CodeableConcept	The category of the statement - classifying how the statement is made
patient	Σ	1..1	Reference(Patient)	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 Binding: Device Usage Status (Required)
usageReason		0..*	CodeableConcept	The reason for asserting the usage status - for example forgot, lost, stolen, broken
adherence		0..1	BackboneElement	How device is being used
code		1..1	CodeableConcept	always | never | sometimes Binding: Device Usage Adherence Code (Example)
reason		1..*	CodeableConcept	lost | stolen | prescribed | broken | burned | forgot Binding: Device Usage Adherence Reason (Example)
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 | Procedure)	Why device was used
bodySite	Σ	0..1	CodeableReference(BodyStructure)	Target body site Binding: SNOMED CT Body Structures (Example)
note		0..*	Annotation	Addition details (comments, instructions)
Documentation for this format

See the Extensions for this resource

<DeviceUsage 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 | not-done | entered-in-error + -->
 <category><!-- 0..* CodeableConcept The category of the statement - classifying how the statement is made --></category>
 <patient><!-- 1..1 Reference(Patient) Patient using device --></patient>
 <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>
 <adherence>  <!-- 0..1 How device is being used -->
  <code><!-- 1..1 CodeableConcept always | never | sometimes --></code>
  <reason><!-- 1..* CodeableConcept lost | stolen | prescribed | broken | burned | forgot --></reason>
 </adherence>
 <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|Procedure) Why device was used --></reason>
 <bodySite><!-- 0..1 CodeableReference(BodyStructure) Target body site --></bodySite>
 <note><!-- 0..* Annotation Addition details (comments, instructions) --></note>
</DeviceUsage>

{
  "resourceType" : "DeviceUsage",
  // 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 | not-done | entered-in-error +
  "category" : [{ CodeableConcept }], // The category of the statement - classifying how the statement is made
  "patient" : { Reference(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
  "adherence" : { // How device is being used
    "code" : { CodeableConcept }, // R!  always | never | sometimes
    "reason" : [{ CodeableConcept }] // R!  lost | stolen | prescribed | broken | burned | forgot
  },
  "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|Procedure) }], // Why device was used
  "bodySite" : { CodeableReference(BodyStructure) }, // Target body site
  "note" : [{ Annotation }] // Addition details (comments, instructions)
}

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:DeviceUsage;
  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:identifier  ( [ Identifier ] ... ) ; # 0..* External identifier for this record
  fhir:basedOn  ( [ Reference(ServiceRequest) ] ... ) ; # 0..* Fulfills plan, proposal or order
  fhir:status [ code ] ; # 1..1 active | completed | not-done | entered-in-error +
  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* The category of the statement - classifying how the statement is made
  fhir:patient [ Reference(Patient) ] ; # 1..1 Patient using device
  fhir:derivedFrom  ( [ Reference(Claim|DocumentReference|Observation|Procedure|QuestionnaireResponse|
  ServiceRequest) ] ... ) ; # 0..* Supporting information
  fhir:context [ Reference(Encounter|EpisodeOfCare) ] ; # 0..1 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. One of these 3
    fhir:timing [  a fhir:Timing ; Timing ]
    fhir:timing [  a fhir:Period ; Period ]
    fhir:timing [  a fhir:dateTime ; dateTime ]
  fhir:dateAsserted [ dateTime ] ; # 0..1 When the statement was made (and recorded)
  fhir: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:usageReason  ( [ CodeableConcept ] ... ) ; # 0..* The reason for asserting the usage status - for example forgot, lost, stolen, broken
  fhir:adherence [ # 0..1 How device is being used
    fhir:code [ CodeableConcept ] ; # 1..1 always | never | sometimes
    fhir:reason  ( [ CodeableConcept ] ... ) ; # 1..* lost | stolen | prescribed | broken | burned | forgot
  ] ;
  fhir:informationSource [ Reference(Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] ; # 0..1 Who made the statement
  fhir:device [ CodeableReference(Device|DeviceDefinition) ] ; # 1..1 Code or Reference to device used
  fhir:reason  ( [ CodeableReference(Condition|DiagnosticReport|DocumentReference|Observation|Procedure) ] ... ) ; # 0..* Why device was used
  fhir:bodySite [ CodeableReference(BodyStructure) ] ; # 0..1 Target body site
  fhir:note  ( [ Annotation ] ... ) ; # 0..* Addition details (comments, instructions)
]

Changes from both R4 and R4B

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

Name	Flags	Card.	Type	Description & Constraints
DeviceUsage	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 | not-done | entered-in-error + Binding: Device Usage Status (Required)
category		0..*	CodeableConcept	The category of the statement - classifying how the statement is made
patient	Σ	1..1	Reference(Patient)	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 Binding: Device Usage Status (Required)
usageReason		0..*	CodeableConcept	The reason for asserting the usage status - for example forgot, lost, stolen, broken
adherence		0..1	BackboneElement	How device is being used
code		1..1	CodeableConcept	always | never | sometimes Binding: Device Usage Adherence Code (Example)
reason		1..*	CodeableConcept	lost | stolen | prescribed | broken | burned | forgot Binding: Device Usage Adherence Reason (Example)
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 | Procedure)	Why device was used
bodySite	Σ	0..1	CodeableReference(BodyStructure)	Target body site Binding: SNOMED CT Body Structures (Example)
note		0..*	Annotation	Addition details (comments, instructions)
Documentation for this format

See the Extensions for this resource

<DeviceUsage 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 | not-done | entered-in-error + -->
 <category><!-- 0..* CodeableConcept The category of the statement - classifying how the statement is made --></category>
 <patient><!-- 1..1 Reference(Patient) Patient using device --></patient>
 <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>
 <adherence>  <!-- 0..1 How device is being used -->
  <code><!-- 1..1 CodeableConcept always | never | sometimes --></code>
  <reason><!-- 1..* CodeableConcept lost | stolen | prescribed | broken | burned | forgot --></reason>
 </adherence>
 <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|Procedure) Why device was used --></reason>
 <bodySite><!-- 0..1 CodeableReference(BodyStructure) Target body site --></bodySite>
 <note><!-- 0..* Annotation Addition details (comments, instructions) --></note>
</DeviceUsage>

{
  "resourceType" : "DeviceUsage",
  // 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 | not-done | entered-in-error +
  "category" : [{ CodeableConcept }], // The category of the statement - classifying how the statement is made
  "patient" : { Reference(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
  "adherence" : { // How device is being used
    "code" : { CodeableConcept }, // R!  always | never | sometimes
    "reason" : [{ CodeableConcept }] // R!  lost | stolen | prescribed | broken | burned | forgot
  },
  "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|Procedure) }], // Why device was used
  "bodySite" : { CodeableReference(BodyStructure) }, // Target body site
  "note" : [{ Annotation }] // Addition details (comments, instructions)
}

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:DeviceUsage;
  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:identifier  ( [ Identifier ] ... ) ; # 0..* External identifier for this record
  fhir:basedOn  ( [ Reference(ServiceRequest) ] ... ) ; # 0..* Fulfills plan, proposal or order
  fhir:status [ code ] ; # 1..1 active | completed | not-done | entered-in-error +
  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* The category of the statement - classifying how the statement is made
  fhir:patient [ Reference(Patient) ] ; # 1..1 Patient using device
  fhir:derivedFrom  ( [ Reference(Claim|DocumentReference|Observation|Procedure|QuestionnaireResponse|
  ServiceRequest) ] ... ) ; # 0..* Supporting information
  fhir:context [ Reference(Encounter|EpisodeOfCare) ] ; # 0..1 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. One of these 3
    fhir:timing [  a fhir:Timing ; Timing ]
    fhir:timing [  a fhir:Period ; Period ]
    fhir:timing [  a fhir:dateTime ; dateTime ]
  fhir:dateAsserted [ dateTime ] ; # 0..1 When the statement was made (and recorded)
  fhir: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:usageReason  ( [ CodeableConcept ] ... ) ; # 0..* The reason for asserting the usage status - for example forgot, lost, stolen, broken
  fhir:adherence [ # 0..1 How device is being used
    fhir:code [ CodeableConcept ] ; # 1..1 always | never | sometimes
    fhir:reason  ( [ CodeableConcept ] ... ) ; # 1..* lost | stolen | prescribed | broken | burned | forgot
  ] ;
  fhir:informationSource [ Reference(Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] ; # 0..1 Who made the statement
  fhir:device [ CodeableReference(Device|DeviceDefinition) ] ; # 1..1 Code or Reference to device used
  fhir:reason  ( [ CodeableReference(Condition|DiagnosticReport|DocumentReference|Observation|Procedure) ] ... ) ; # 0..* Why device was used
  fhir:bodySite [ CodeableReference(BodyStructure) ] ; # 0..1 Target body site
  fhir:note  ( [ Annotation ] ... ) ; # 0..* Addition details (comments, instructions)
]

Changes from both R4 and R4B

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.