eHealth Infrastructure
2.7.0 - Release 14

eHealth Infrastructure - Local Development build (v2.7.0). See the Directory of published versions

Resource Profile: ehealth-deviceusestatement - Detailed Descriptions

Active as of 2023-03-20

Definitions for the ehealth-deviceusestatement resource profile.

Guidance on how to interpret the contents of this table can be found here.

1. DeviceUseStatement
2. DeviceUseStatement.extension
Control10..*
SlicingThis element introduces a set of slices on DeviceUseStatement.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3. DeviceUseStatement.extension:Context
SliceNameContext
Control1..1
TypeExtension(ehealth-deviceusestatement-context) (Extension Type: Reference(ehealth-careplan) : {r})
4. DeviceUseStatement.subject
TypeReference(ehealth-patient|Patient|Group) : {r}
5. DeviceUseStatement.source
TypeReference(ehealth-patient|ehealth-practitioner|ehealth-relatedperson|Patient|Practitioner|PractitionerRole|RelatedPerson) : {r}
6. DeviceUseStatement.device
TypeReference(ehealth-device|Device)
7. DeviceUseStatement.note
Control0..?
8. DeviceUseStatement.note.authorReference
Control0..1
TypeReference(ehealth-practitioner|ehealth-patient|ehealth-relatedperson)
9. DeviceUseStatement.note.authorString
Control0..1
Typestring

Guidance on how to interpret the contents of this table can be found here.

1. DeviceUseStatement
Definition

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.

Control0..*
Summaryfalse
InvariantsDefined on this element
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (: text.`div`.exists())
2. DeviceUseStatement.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Control0..1
Typeuri
Is Modifiertrue
Summarytrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
3. DeviceUseStatement.extension
Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control10..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on DeviceUseStatement.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. DeviceUseStatement.extension:Context
SliceNameContext
Definition

The careplan context for the device use

Control1..1 This element is affected by the following invariants: ele-1
TypeExtension(ehealth-deviceusestatement-context) (Extension Type: Reference(ehealth-careplan) : {r})
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
5. DeviceUseStatement.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summaryfalse
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
6. DeviceUseStatement.status
Definition

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.

Control1..1
BindingThe codes SHALL be taken from DeviceUseStatementStatus

A coded concept indicating the current status of the Device Usage.

Typecode
Is Modifiertrue
Summarytrue
Comments

DeviceUseStatment is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for contains codes that assert the status of the use by the patient (for example, stopped or on hold) as well as codes that assert the status of the resource itself (for example, entered in error).

This element is labeled as a modifier because the status contains the codes that mark the statement as not currently valid.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. DeviceUseStatement.subject
Definition

The patient who used the device.

Control1..1
TypeReference(ehealth-patient|Patient|Group) : {r}
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. DeviceUseStatement.source
Definition

Who reported the device was being used by the patient.

Control0..1
TypeReference(ehealth-patient|ehealth-practitioner|ehealth-relatedperson|Patient|Practitioner|PractitionerRole|RelatedPerson) : {r}
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. DeviceUseStatement.device
Definition

The details of the device used.

Control1..1
TypeReference(ehealth-device|Device)
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here.

1. DeviceUseStatement
Definition

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.

Control0..*
Summaryfalse
2. DeviceUseStatement.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Summarytrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

3. DeviceUseStatement.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Control0..1
TypeMeta
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. DeviceUseStatement.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Control0..1
Typeuri
Is Modifiertrue
Summarytrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. DeviceUseStatement.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages A human language
Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Summaryfalse
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. DeviceUseStatement.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1
TypeNarrative
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. DeviceUseStatement.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

8. DeviceUseStatement.extension
Definition

An Extension

Control1..*
TypeExtension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on DeviceUseStatement.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
9. DeviceUseStatement.extension:Context
SliceNameContext
Definition

The careplan context for the device use

Control1..1 This element is affected by the following invariants: ele-1
TypeExtension(ehealth-deviceusestatement-context) (Extension Type: Reference(ehealth-careplan) : {r})
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. DeviceUseStatement.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summaryfalse
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
11. DeviceUseStatement.identifier
Definition

An external identifier for this statement such as an IRI.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. DeviceUseStatement.basedOn
Definition

A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement.

Control0..*
TypeReference(ServiceRequest)
Summarytrue
Requirements

Allows tracing of authorization for the DeviceUseStatement and tracking whether proposals/recommendations were acted upon.

Alternate Namesfulfills
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. DeviceUseStatement.status
Definition

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.

Control1..1
BindingThe codes SHALL be taken from DeviceUseStatementStatus A coded concept indicating the current status of the Device Usage
Typecode
Is Modifiertrue
Summarytrue
Comments

DeviceUseStatment is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for contains codes that assert the status of the use by the patient (for example, stopped or on hold) as well as codes that assert the status of the resource itself (for example, entered in error).

This element is labeled as a modifier because the status contains the codes that mark the statement as not currently valid.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. DeviceUseStatement.subject
Definition

The patient who used the device.

Control1..1
TypeReference(ehealth-patient) : {r}
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. DeviceUseStatement.derivedFrom
Definition

Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement.

Control0..*
TypeReference(ServiceRequest|Procedure|Claim|Observation|QuestionnaireResponse|DocumentReference)
Summarytrue
Comments

The most common use cases for deriving a DeviceUseStatement comes from creating it from a request or from an observation or a claim. it should be noted that the amount of information that is available varies from the type resource that you derive the DeviceUseStatement from.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. DeviceUseStatement.timing[x]
Definition

How often the device was used.

Control0..1
TypeChoice of: Timing, Period, dateTime
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. DeviceUseStatement.recordedOn
Definition

The time at which the statement was made/recorded.

Control0..1
TypedateTime
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. DeviceUseStatement.source
Definition

Who reported the device was being used by the patient.

Control0..1
TypeReference(ehealth-patient|ehealth-practitioner|ehealth-relatedperson) : {r}
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. DeviceUseStatement.device
Definition

The details of the device used.

Control1..1
TypeReference(ehealth-device)
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. DeviceUseStatement.reasonCode
Definition

Reason or justification for the use of the device.

Control0..*
TypeCodeableConcept
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. DeviceUseStatement.reasonReference
Definition

Indicates another resource whose existence justifies this DeviceUseStatement.

Control0..*
TypeReference(Condition|Observation|DiagnosticReport|DocumentReference|Media)
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. DeviceUseStatement.bodySite
Definition

Indicates the anotomic location on the subject's body where the device was used ( i.e. the target).

Control0..1
BindingFor example codes, see SNOMEDCTBodyStructures Codes describing anatomical locations. May include laterality
TypeCodeableConcept
Summarytrue
Requirements

Knowing where the device is targeted is important for tracking if multiple sites are possible. If more information than just a code is required, use the extension http://hl7.org/fhir/StructureDefinition/bodySite.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. DeviceUseStatement.note
Definition

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.

Control0..*
TypeAnnotation
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. DeviceUseStatement.note.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
25. DeviceUseStatement.note.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on DeviceUseStatement.note.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
26. DeviceUseStatement.note.author[x]
Definition

The individual responsible for making the annotation.

Control0..1
TypeChoice of: Reference(Practitioner|Patient|RelatedPerson|Organization), string
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Comments

Organization is used when there's no need for specific attribution as to who made the comment.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on DeviceUseStatement.note.author[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
27. DeviceUseStatement.note.author[x]:authorReference
SliceNameauthorReference
Definition

The individual responsible for making the annotation.

Control0..1
TypeReference(ehealth-practitioner|ehealth-patient|ehealth-relatedperson)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Comments

Organization is used when there's no need for specific attribution as to who made the comment.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. DeviceUseStatement.note.author[x]:authorString
SliceNameauthorString
Definition

The individual responsible for making the annotation.

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Comments

Organization is used when there's no need for specific attribution as to who made the comment.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. DeviceUseStatement.note.time
Definition

Indicates when this particular annotation was made.

Control0..1
TypedateTime
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. DeviceUseStatement.note.text
Definition

The text of the annotation in markdown format.

Control1..1
Typemarkdown
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))