Nictiz FHIR NL R4 Zib2020
0.9.0 - CI Build

Nictiz FHIR NL R4 Zib2020 - Local Development build (v0.9.0). See the Directory of published versions

Resource Profile: ZibHearingFunctionHearingAid - Detailed Descriptions

Draft as of 2023-10-17

Definitions for the zib-HearingFunction.HearingAid resource profile.

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

0. DeviceUseStatement
Definition

The medical aid used to help the patient hear.

Comments

This is a specialization of the zib-MedicalDevice profile to represent HearingAid devices within the context of zib HearingFunction.

2. DeviceUseStatement.device
TypeReference(Device, zib HearingFunction.HearingAid.Product)
4. DeviceUseStatement.reasonReference:bowelFunction
Slice NamebowelFunction
Control0..0
6. DeviceUseStatement.reasonReference:functionalOrMentalStatus
Slice NamefunctionalOrMentalStatus
Control0..0
8. DeviceUseStatement.reasonReference:mobility
Slice Namemobility
Control0..0
10. DeviceUseStatement.reasonReference:stoma
Slice Namestoma
Control0..0
12. DeviceUseStatement.reasonReference:hearingFunction
Slice NamehearingFunction
ShortHearingFunction
Comments

Please note that on a functional level, zib HearingFunction references zib MedicalDevice, but in FHIR this direction is reversed.

TypeReference(zib HearingFunction)
Alternate NamesFunctieHoren
14. DeviceUseStatement.bodySite
Definition

The anatomical location of the hearing aid, such as: ‘left ear’.

ShortLocation / AnatomicalLocation / DeviceAnatomicalLocation
BindingThe codes SHALL be taken from http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.4.17.3--20200901000000
Alternate NamesHulpmiddelAnatomischeLocatie

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

0. DeviceUseStatement
Definition

The medical aid used to help the patient hear.


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.

ShortMedicalDeviceRecord of use of a device
Comments

This is a specialization of the zib-MedicalDevice profile to represent HearingAid devices within the context of zib HearingFunction.

Control0..*
Is Modifierfalse
Summaryfalse
Alternate NamesMedischHulpmiddel
Invariantsdom-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.

ShortA set of rules under which this content was created
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.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. DeviceUseStatement.extension:healthProfessional
Slice NamehealthProfessional
Definition

An Extension

ShortExtension
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(ext MedicalDevice.HealthProfessional) (Extension Type: Reference(Reference)(zib HealthProfessional PractitionerRole))
Is Modifierfalse
Invariantsele-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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. DeviceUseStatement.extension:location
Slice Namelocation
Definition

An Extension

ShortExtension
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(ext MedicalDevice.Location) (Extension Type: Reference(zib HealthcareProvider))
Is Modifierfalse
Invariantsele-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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. 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).

ShortExtensions that cannot be ignored
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
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
Invariantsele-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.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.

Shortactive | completed | entered-in-error +
Comments

This element is implictly mapped to the zib concepts NL-CM:10.1.11 (StartDate) and NL-CM:10.1.14 (EndDate). Unless the status is explicitly recorded, the following guidance applies:

  • When StartDate is in the future, .status will usually be set to intended.
  • When StartDate is in the past and EndDate has a value and in the future or EndDate has no value, .status will usually be set to active.
  • When EndDate has a value and is in the past, .status will usually be set to completed.

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.

Control1..1
BindingThe codes SHALL be taken from DeviceUseStatementStatushttp://hl7.org/fhir/ValueSet/device-statement-status|4.0.1

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

Typecode
Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. DeviceUseStatement.subject
Definition

The patient who used the device.

ShortPatient using device
Control1..1
TypeReference(Patient, Group)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. DeviceUseStatement.derivedFrom
Definition

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

ShortSupporting information
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.

Control0..*
TypeReference(ServiceRequest, Procedure, Claim, Observation, QuestionnaireResponse, DocumentReference)
Is Modifierfalse
Summarytrue
Invariantsele-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.derivedFrom. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • profile @ resolve()
16. DeviceUseStatement.derivedFrom:procedure-request
Slice Nameprocedure-request
Definition

The procedure which has the purpose of placing this product in or on the body.


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

ShortProcedureSupporting information
Comments
  • Note 1: on a functional level, zib Procedure references zib MedicalDevice, but in FHIR this direction is reversed.
  • Note 2: zib Procedure can represent a requested or (to be) performed procedure. This slice represents requested procedures, while slice procedure-event represents performed procedures.

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.

Control0..*
TypeReference(zib Procedure request, ServiceRequest, Procedure, Claim, Observation, QuestionnaireResponse, DocumentReference)
Is Modifierfalse
Summarytrue
Alternate NamesVerrichting
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. DeviceUseStatement.derivedFrom:procedure-event
Slice Nameprocedure-event
Definition

The procedure which has the purpose of placing this product in or on the body.


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

ShortProcedureSupporting information
Comments
  • Note 1: on a functional level, zib Procedure references zib MedicalDevice, but in FHIR this direction is reversed.
  • Note 2: zib Procedure can represent a requested or (to be) performed procedure. This slice represents performed procedures, while slice procedure-request represents requested procedures.

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.

Control0..*
TypeReference(zib Procedure event, ServiceRequest, Procedure, Claim, Observation, QuestionnaireResponse, DocumentReference)
Is Modifierfalse
Summarytrue
Alternate NamesVerrichting
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. DeviceUseStatement.timing[x]
Definition

How often the device was used.

ShortHow 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]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-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.timing[x]. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • type @ $this
22. DeviceUseStatement.timing[x]:timingPeriod
Slice NametimingPeriod
Definition

How often the device was used.

ShortHow often the device was used
Control0..1
TypePeriod, dateTime, Timing
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. DeviceUseStatement.device
Definition

The details of the device used.

ShortReference to device used
Control1..1
TypeReference(Device, zib HearingFunction.HearingAid.Product)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. DeviceUseStatement.reasonReference
Definition

Indicates another resource whose existence justifies this DeviceUseStatement.

ShortWhy was DeviceUseStatement performed?
Control0..*
TypeReference(Condition, Observation, DiagnosticReport, DocumentReference, Media)
Is Modifierfalse
Summarytrue
Invariantsele-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.reasonReference. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • profile @ resolve()
28. DeviceUseStatement.reasonReference:indication
Slice Nameindication
Definition

The medical reason for use of the medical device.


Indicates another resource whose existence justifies this DeviceUseStatement.

ShortIndicationWhy was DeviceUseStatement performed?
Control0..*
TypeReference(zib Problem, Condition, Observation, DiagnosticReport, DocumentReference, Media)
Is Modifierfalse
Summarytrue
Alternate NamesIndicatie
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. DeviceUseStatement.reasonReference:bowelFunction
Slice NamebowelFunction
Definition

Indicates another resource whose existence justifies this DeviceUseStatement.

ShortBowelFunctionWhy was DeviceUseStatement performed?
Comments

Please note that on a functional level, zib BowelFunction references zib MedicalDevice, but in FHIR this direction is reversed.

Control0..0*
TypeReference(zib BowelFunction, Condition, Observation, DiagnosticReport, DocumentReference, Media)
Is Modifierfalse
Summarytrue
Alternate NamesDarmfunctie
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. DeviceUseStatement.reasonReference:functionalOrMentalStatus
Slice NamefunctionalOrMentalStatus
Definition

Indicates another resource whose existence justifies this DeviceUseStatement.

ShortFunctionalOrMentalStatusWhy was DeviceUseStatement performed?
Comments

Please note that on a functional level, zib FunctionalOrMentalStatus references zib MedicalDevice, but in FHIR this direction is reversed.

Control0..0*
TypeReference(zib FunctionalOrMentalStatus, Condition, Observation, DiagnosticReport, DocumentReference, Media)
Is Modifierfalse
Summarytrue
Alternate NamesFunctioneleOfMentaleStatus
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. DeviceUseStatement.reasonReference:mobility
Slice Namemobility
Definition

Indicates another resource whose existence justifies this DeviceUseStatement.

ShortMobilityWhy was DeviceUseStatement performed?
Comments

Please note that on a functional level, zib Mobility references zib MedicalDevice, but in FHIR this direction is reversed.

Control0..0*
TypeReference(zib Mobility, Condition, Observation, DiagnosticReport, DocumentReference, Media)
Is Modifierfalse
Summarytrue
Alternate NamesMobiliteit
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. DeviceUseStatement.reasonReference:stoma
Slice Namestoma
Definition

Indicates another resource whose existence justifies this DeviceUseStatement.

ShortStomaWhy was DeviceUseStatement performed?
Comments

Please note that on a functional level, zib Stoma references zib MedicalDevice, but in FHIR this direction is reversed.

Control0..0*
TypeReference(zib Stoma, Condition, Observation, DiagnosticReport, DocumentReference, Media)
Is Modifierfalse
Summarytrue
Alternate NamesStoma
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. DeviceUseStatement.reasonReference:hearingFunction
Slice NamehearingFunction
Definition

Indicates another resource whose existence justifies this DeviceUseStatement.

ShortHearingFunctionWhy was DeviceUseStatement performed?
Comments

Please note that on a functional level, zib HearingFunction references zib MedicalDevice, but in FHIR this direction is reversed.

Control0..*
TypeReference(zib HearingFunction, Condition, Observation, DiagnosticReport, DocumentReference, Media)
Is Modifierfalse
Summarytrue
Alternate NamesFunctieHoren
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. DeviceUseStatement.bodySite
Definition

The anatomical location of the hearing aid, such as: ‘left ear’.


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

ShortLocation / AnatomicalLocation / DeviceAnatomicalLocationTarget body site
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Control0..1
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from For example codes, see http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.4.17.3--20200901000000http://hl7.org/fhir/ValueSet/body-site
TypeCodeableConcept(zib AnatomicalLocation)
Is Modifierfalse
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.

Alternate NamesLocatie, AnatomischeLocatie, HulpmiddelAnatomischeLocatie
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. 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.

ShortAddition details (comments, instructions)
Control0..1*
TypeAnnotation
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. DeviceUseStatement.note.text
Definition

Comment about use or information on the medical device used.


The text of the annotation in markdown format.

ShortCommentThe annotation - text content (as markdown)
Control1..1
Typemarkdown
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesToelichting
Invariantsele-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

0. DeviceUseStatement
Definition

The medical aid used to help the patient hear.

ShortMedicalDevice
Comments

This is a specialization of the zib-MedicalDevice profile to represent HearingAid devices within the context of zib HearingFunction.

Control0..*
Is Modifierfalse
Summaryfalse
Alternate NamesMedischHulpmiddel
Invariantsdom-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.id
Definition

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

ShortLogical id of this artifact
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.

Control0..1
Typeid
Is Modifierfalse
Summarytrue
4. 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.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. 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.

ShortA set of rules under which this content was created
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.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. DeviceUseStatement.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
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).

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages: A human language.
Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. 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.

ShortText summary of the resource, for human interpretation
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.

Control0..1
TypeNarrative
Is Modifierfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. 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.

ShortContained, inline 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.

Control0..*
TypeResource
Is Modifierfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. DeviceUseStatement.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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: , and can be differentiated using the following discriminators:
  • value @ url
16. DeviceUseStatement.extension:healthProfessional
Slice NamehealthProfessional
Definition

An Extension

ShortExtension
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(ext MedicalDevice.HealthProfessional) (Extension Type: Reference(Reference)(zib HealthProfessional PractitionerRole))
Is Modifierfalse
Invariantsele-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())
18. DeviceUseStatement.extension:location
Slice Namelocation
Definition

An Extension

ShortExtension
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(ext MedicalDevice.Location) (Extension Type: Reference(zib HealthcareProvider))
Is Modifierfalse
Invariantsele-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())
20. 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.

ShortExtensions that cannot be ignored
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
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
Invariantsele-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())
22. DeviceUseStatement.identifier
Definition

An external identifier for this statement such as an IRI.

ShortExternal identifier for this record
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. DeviceUseStatement.basedOn
Definition

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

ShortFulfills plan, proposal or order
Control0..*
TypeReference(ServiceRequest)
Is Modifierfalse
Summarytrue
Requirements

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

Alternate Namesfulfills
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. 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.

Shortactive | completed | entered-in-error +
Comments

This element is implictly mapped to the zib concepts NL-CM:10.1.11 (StartDate) and NL-CM:10.1.14 (EndDate). Unless the status is explicitly recorded, the following guidance applies:

Control1..1
BindingThe codes SHALL be taken from DeviceUseStatementStatus: A coded concept indicating the current status of the Device Usage.
Typecode
Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. DeviceUseStatement.subject
Definition

The patient who used the device.

ShortPatient using device
Control1..1
TypeReference(Patient, Group)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. DeviceUseStatement.derivedFrom
Definition

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

ShortSupporting information
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.

Control0..*
TypeReference(ServiceRequest, Procedure, Claim, Observation, QuestionnaireResponse, DocumentReference)
Is Modifierfalse
Summarytrue
Invariantsele-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.derivedFrom. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • profile @ resolve()
32. DeviceUseStatement.derivedFrom:procedure-request
Slice Nameprocedure-request
Definition

The procedure which has the purpose of placing this product in or on the body.

ShortProcedure
Comments
  • Note 1: on a functional level, zib Procedure references zib MedicalDevice, but in FHIR this direction is reversed.
  • Note 2: zib Procedure can represent a requested or (to be) performed procedure. This slice represents requested procedures, while slice procedure-event represents performed procedures.
Control0..*
TypeReference(zib Procedure request)
Is Modifierfalse
Summarytrue
Alternate NamesVerrichting
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. DeviceUseStatement.derivedFrom:procedure-event
Slice Nameprocedure-event
Definition

The procedure which has the purpose of placing this product in or on the body.

ShortProcedure
Comments
  • Note 1: on a functional level, zib Procedure references zib MedicalDevice, but in FHIR this direction is reversed.
  • Note 2: zib Procedure can represent a requested or (to be) performed procedure. This slice represents performed procedures, while slice procedure-request represents requested procedures.
Control0..*
TypeReference(zib Procedure event)
Is Modifierfalse
Summarytrue
Alternate NamesVerrichting
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. DeviceUseStatement.timing[x]
Definition

How often the device was used.

ShortHow 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]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-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.timing[x]. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • type @ $this
38. DeviceUseStatement.timing[x]:timingPeriod
Slice NametimingPeriod
Definition

How often the device was used.

ShortHow often the device was used
Control0..1
TypePeriod
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. DeviceUseStatement.timing[x]:timingPeriod.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
42. DeviceUseStatement.timing[x]:timingPeriod.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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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.timing[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
44. DeviceUseStatement.timing[x]:timingPeriod.start
Definition

The start date of the first use or implant of the medical device. A ‘vague’ date, such as only the year, is permitted.

ShortStartDate
Comments

If the low element is missing, the meaning is that the low boundary is not known.

Control0..1
This element is affected by the following invariants: per-1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesBeginDatum
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. DeviceUseStatement.timing[x]:timingPeriod.end
Definition

The end date of the last use or explant of the medical device. A ‘vague’ date, such as only the year, is permitted.

ShortEndDate
Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

Control0..1
This element is affected by the following invariants: per-1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesEindDatum
Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. DeviceUseStatement.recordedOn
Definition

The time at which the statement was made/recorded.

ShortWhen statement was recorded
Control0..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. DeviceUseStatement.source
Definition

Who reported the device was being used by the patient.

ShortWho made the statement
Control0..1
TypeReference(Patient, Practitioner, PractitionerRole, RelatedPerson)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. DeviceUseStatement.device
Definition

The details of the device used.

ShortReference to device used
Control1..1
TypeReference(Device, zib HearingFunction.HearingAid.Product)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. DeviceUseStatement.reasonCode
Definition

Reason or justification for the use of the device.

ShortWhy device was used
Control0..*
TypeCodeableConcept
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. DeviceUseStatement.reasonReference
Definition

Indicates another resource whose existence justifies this DeviceUseStatement.

ShortWhy was DeviceUseStatement performed?
Control0..*
TypeReference(Condition, Observation, DiagnosticReport, DocumentReference, Media)
Is Modifierfalse
Summarytrue
Invariantsele-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.reasonReference. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • profile @ resolve()
58. DeviceUseStatement.reasonReference:indication
Slice Nameindication
Definition

The medical reason for use of the medical device.

ShortIndication
Control0..*
TypeReference(zib Problem)
Is Modifierfalse
Summarytrue
Alternate NamesIndicatie
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. DeviceUseStatement.reasonReference:bowelFunction
Slice NamebowelFunction
Definition

Indicates another resource whose existence justifies this DeviceUseStatement.

ShortBowelFunction
Comments

Please note that on a functional level, zib BowelFunction references zib MedicalDevice, but in FHIR this direction is reversed.

Control0..0
TypeReference(zib BowelFunction)
Is Modifierfalse
Summarytrue
Alternate NamesDarmfunctie
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. DeviceUseStatement.reasonReference:functionalOrMentalStatus
Slice NamefunctionalOrMentalStatus
Definition

Indicates another resource whose existence justifies this DeviceUseStatement.

ShortFunctionalOrMentalStatus
Comments

Please note that on a functional level, zib FunctionalOrMentalStatus references zib MedicalDevice, but in FHIR this direction is reversed.

Control0..0
TypeReference(zib FunctionalOrMentalStatus)
Is Modifierfalse
Summarytrue
Alternate NamesFunctioneleOfMentaleStatus
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. DeviceUseStatement.reasonReference:mobility
Slice Namemobility
Definition

Indicates another resource whose existence justifies this DeviceUseStatement.

ShortMobility
Comments

Please note that on a functional level, zib Mobility references zib MedicalDevice, but in FHIR this direction is reversed.

Control0..0
TypeReference(zib Mobility)
Is Modifierfalse
Summarytrue
Alternate NamesMobiliteit
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. DeviceUseStatement.reasonReference:stoma
Slice Namestoma
Definition

Indicates another resource whose existence justifies this DeviceUseStatement.

ShortStoma
Comments

Please note that on a functional level, zib Stoma references zib MedicalDevice, but in FHIR this direction is reversed.

Control0..0
TypeReference(zib Stoma)
Is Modifierfalse
Summarytrue
Alternate NamesStoma
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. DeviceUseStatement.reasonReference:hearingFunction
Slice NamehearingFunction
Definition

Indicates another resource whose existence justifies this DeviceUseStatement.

ShortHearingFunction
Comments

Please note that on a functional level, zib HearingFunction references zib MedicalDevice, but in FHIR this direction is reversed.

Control0..*
TypeReference(zib HearingFunction)
Is Modifierfalse
Summarytrue
Alternate NamesFunctieHoren
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. DeviceUseStatement.bodySite
Definition

The anatomical location of the hearing aid, such as: ‘left ear’.

ShortLocation / AnatomicalLocation / DeviceAnatomicalLocation
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Control0..1
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.4.17.3--20200901000000
TypeCodeableConcept(zib AnatomicalLocation)
Is Modifierfalse
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.

Alternate NamesLocatie, AnatomischeLocatie, HulpmiddelAnatomischeLocatie
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. 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.

ShortAddition details (comments, instructions)
Control0..1
TypeAnnotation
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. 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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
76. 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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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: , and can be differentiated using the following discriminators:
  • value @ url
78. DeviceUseStatement.note.author[x]
Definition

The individual responsible for making the annotation.

ShortIndividual responsible for the annotation
Comments

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

Control0..1
TypeChoice of: Reference(Practitioner, Patient, RelatedPerson, Organization), string
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. DeviceUseStatement.note.time
Definition

Indicates when this particular annotation was made.

ShortWhen the annotation was made
Control0..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. DeviceUseStatement.note.text
Definition

Comment about use or information on the medical device used.

ShortComment
Control1..1
Typemarkdown
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesToelichting
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))