Nictiz FHIR NL R4 Zib2020
0.9.0 - CI Build
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
| Official URL: http://nictiz.nl/fhir/StructureDefinition/zib-HearingFunction.HearingAid | Version: 0.9.0 | |||
| Draft as of 2023-10-17 | Computable Name: ZibHearingFunctionHearingAid | |||
Copyright/Legal: Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise. |
||||
Hearing is the ability to observe sound, with the purpose of communicating with others, localizing the source of the sound and recognizing certain sounds. This pertains to observing the sound waves, and not processing the sounds in the brain. A hearing disorder can lead to things including communication problems.
This DeviceUseStatement resource represents the adaptations for zib (‘Zorginformatiebouwsteen’, i.e. Health and Care Information Model) HearingFunction v3.2 (2020) of zib MedicalDevice v3.3.1 (2020).
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ZibMedicalDevice
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  DeviceUseStatement | 0..* | ZibMedicalDevice | This is an abstract profile. Child profiles: NlcoreHearingFunctionHearingAid MedicalDevice | |
  device | 1..1 | Reference(Device | zib HearingFunction.HearingAid.Product) | Reference to device used | |
 reasonReference:bowelFunction | 0..0 | |||
| reasonReference:functionalOrMentalStatus | 0..0 | |||
| reasonReference:mobility | 0..0 | |||
| reasonReference:stoma | 0..0 | |||
| reasonReference:hearingFunction | 0..* | Reference(zib HearingFunction) | HearingFunction | |
  bodySite | 0..1 | ZibAnatomicalLocation | Location / AnatomicalLocation / DeviceAnatomicalLocation Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.4.17.3--20200901000000 (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| DeviceUseStatement.bodySite | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.4.17.3--20200901000000 |
| Path | Conformance | ValueSet |
| DeviceUseStatement.status | required | DeviceUseStatementStatus |
| DeviceUseStatement.bodySite | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.4.17.3--20200901000000 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | DeviceUseStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | DeviceUseStatement | 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 | error | DeviceUseStatement | 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 | error | DeviceUseStatement | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DeviceUseStatement | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| DeviceUseStatement | 0..* | ZibMedicalDevice | This is an abstract profile. Child profiles: NlcoreHearingFunctionHearingAid MedicalDevice | |||||
 id | Σ | 0..1 | id | Logical id of this artifact | ||||
 meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| healthProfessional | 0..1 | PatternZibHealthProfessionalReference(zib HealthProfessional PractitionerRole) | Extension URL: http://nictiz.nl/fhir/StructureDefinition/ext-MedicalDevice.HealthProfessional | |||||
| location | 0..1 | Reference(zib HealthcareProvider) | Extension URL: http://nictiz.nl/fhir/StructureDefinition/ext-MedicalDevice.Location | |||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | External identifier for this record | ||||
| basedOn | Σ | 0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order | ||||
| status | ?!Σ | 1..1 | code | active | completed | entered-in-error + Binding: DeviceUseStatementStatus (required): A coded concept indicating the current status of the Device Usage. | ||||
| subject | Σ | 1..1 | Reference(Patient | Group) | Patient using device | ||||
  Slices for derivedFrom | Σ | 0..* | Reference(ServiceRequest | Procedure | Claim | Observation | QuestionnaireResponse | DocumentReference) | Supporting information Slice: Unordered, Open by profile:resolve() | ||||
  derivedFrom:procedure-request | Σ | 0..* | Reference(zib Procedure request) | Procedure | ||||
 derivedFrom:procedure-event | Σ | 0..* | Reference(zib Procedure event) | Procedure | ||||
| Slices for timing[x] | Σ | 0..1 | How often the device was used Slice: Unordered, Open by type:$this | |||||
| timingTiming | Timing | |||||||
| timingPeriod | Period | |||||||
| timingDateTime | dateTime | |||||||
 timing[x]:timingPeriod | Σ | 0..1 | Period | How often the device was used | ||||
  id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | ΣC | 0..1 | dateTime | StartDate | ||||
 end | ΣC | 0..1 | dateTime | EndDate | ||||
| recordedOn | Σ | 0..1 | dateTime | When statement was recorded | ||||
| source | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who made the statement | ||||
| device | Σ | 1..1 | Reference(Device | zib HearingFunction.HearingAid.Product) | Reference to device used | ||||
| reasonCode | Σ | 0..* | CodeableConcept | Why device was used | ||||
| Slices for reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference | Media) | Why was DeviceUseStatement performed? Slice: Unordered, Open by profile:resolve() | ||||
| reasonReference:indication | Σ | 0..* | Reference(zib Problem) | Indication | ||||
| reasonReference:hearingFunction | Σ | 0..* | Reference(zib HearingFunction) | HearingFunction | ||||
| bodySite | 0..1 | ZibAnatomicalLocation | Location / AnatomicalLocation / DeviceAnatomicalLocation Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.4.17.3--20200901000000 (required) | |||||
 note | 0..1 | Annotation | Addition details (comments, instructions) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
 author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString | string | |||||||
| time | Σ | 0..1 | dateTime | When the annotation was made | ||||
| text | Σ | 1..1 | markdown | Comment | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| DeviceUseStatement.language | preferred | CommonLanguages
| ||||
| DeviceUseStatement.status | required | DeviceUseStatementStatus | ||||
| DeviceUseStatement.bodySite | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.4.17.3--20200901000000 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | DeviceUseStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | DeviceUseStatement | 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 | error | DeviceUseStatement | 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 | error | DeviceUseStatement | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DeviceUseStatement | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from ZibMedicalDevice
Differential View
This structure is derived from ZibMedicalDevice
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DeviceUseStatement | 0..* | ZibMedicalDevice | This is an abstract profile. Child profiles: NlcoreHearingFunctionHearingAid MedicalDevice | |
| device | 1..1 | Reference(Device | zib HearingFunction.HearingAid.Product) | Reference to device used | |
| reasonReference:bowelFunction | 0..0 | |||
| reasonReference:functionalOrMentalStatus | 0..0 | |||
| reasonReference:mobility | 0..0 | |||
| reasonReference:stoma | 0..0 | |||
| reasonReference:hearingFunction | 0..* | Reference(zib HearingFunction) | HearingFunction | |
| bodySite | 0..1 | ZibAnatomicalLocation | Location / AnatomicalLocation / DeviceAnatomicalLocation Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.4.17.3--20200901000000 (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| DeviceUseStatement.bodySite | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.4.17.3--20200901000000 |
Key Elements View
| Path | Conformance | ValueSet |
| DeviceUseStatement.status | required | DeviceUseStatementStatus |
| DeviceUseStatement.bodySite | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.4.17.3--20200901000000 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | DeviceUseStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | DeviceUseStatement | 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 | error | DeviceUseStatement | 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 | error | DeviceUseStatement | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DeviceUseStatement | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| DeviceUseStatement | 0..* | ZibMedicalDevice | This is an abstract profile. Child profiles: NlcoreHearingFunctionHearingAid MedicalDevice | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| healthProfessional | 0..1 | PatternZibHealthProfessionalReference(zib HealthProfessional PractitionerRole) | Extension URL: http://nictiz.nl/fhir/StructureDefinition/ext-MedicalDevice.HealthProfessional | |||||
| location | 0..1 | Reference(zib HealthcareProvider) | Extension URL: http://nictiz.nl/fhir/StructureDefinition/ext-MedicalDevice.Location | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | External identifier for this record | ||||
| basedOn | Σ | 0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order | ||||
| status | ?!Σ | 1..1 | code | active | completed | entered-in-error + Binding: DeviceUseStatementStatus (required): A coded concept indicating the current status of the Device Usage. | ||||
| subject | Σ | 1..1 | Reference(Patient | Group) | Patient using device | ||||
| Slices for derivedFrom | Σ | 0..* | Reference(ServiceRequest | Procedure | Claim | Observation | QuestionnaireResponse | DocumentReference) | Supporting information Slice: Unordered, Open by profile:resolve() | ||||
| derivedFrom:procedure-request | Σ | 0..* | Reference(zib Procedure request) | Procedure | ||||
| derivedFrom:procedure-event | Σ | 0..* | Reference(zib Procedure event) | Procedure | ||||
| Slices for timing[x] | Σ | 0..1 | How often the device was used Slice: Unordered, Open by type:$this | |||||
| timingTiming | Timing | |||||||
| timingPeriod | Period | |||||||
| timingDateTime | dateTime | |||||||
| timing[x]:timingPeriod | Σ | 0..1 | Period | How often the device was used | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | ΣC | 0..1 | dateTime | StartDate | ||||
| end | ΣC | 0..1 | dateTime | EndDate | ||||
| recordedOn | Σ | 0..1 | dateTime | When statement was recorded | ||||
| source | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who made the statement | ||||
| device | Σ | 1..1 | Reference(Device | zib HearingFunction.HearingAid.Product) | Reference to device used | ||||
| reasonCode | Σ | 0..* | CodeableConcept | Why device was used | ||||
| Slices for reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference | Media) | Why was DeviceUseStatement performed? Slice: Unordered, Open by profile:resolve() | ||||
| reasonReference:indication | Σ | 0..* | Reference(zib Problem) | Indication | ||||
| reasonReference:hearingFunction | Σ | 0..* | Reference(zib HearingFunction) | HearingFunction | ||||
| bodySite | 0..1 | ZibAnatomicalLocation | Location / AnatomicalLocation / DeviceAnatomicalLocation Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.4.17.3--20200901000000 (required) | |||||
| note | 0..1 | Annotation | Addition details (comments, instructions) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString | string | |||||||
| time | Σ | 0..1 | dateTime | When the annotation was made | ||||
| text | Σ | 1..1 | markdown | Comment | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| DeviceUseStatement.language | preferred | CommonLanguages
| ||||
| DeviceUseStatement.status | required | DeviceUseStatementStatus | ||||
| DeviceUseStatement.bodySite | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.4.17.3--20200901000000 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | DeviceUseStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | DeviceUseStatement | 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 | error | DeviceUseStatement | 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 | error | DeviceUseStatement | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DeviceUseStatement | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from ZibMedicalDevice
Other representations of profile: CSV, Excel, Schematron