Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: HCIM HearingFunction HearingAid Product

A HearingFunction resource as defined by the Dutch Health and Care Information models (Dutch: Zorginformatiebouwsteen or ZIB) HearingFunction v3.1(2017EN).

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.

Purpose of HCIM

Information on hearing function disorders is important in patient nursing and care and particularly in communication with the patient.

Purpose of this resource

This HCIM complements the zib-HearingFunction (Observation) profile to note the use of any visual aids. It can be bound to this profile using the zib-HearingFunction-HearingAid (DeviceUseStatement) profile.

Usage:

• Examples for this Resource Profile: Device/zib-hearingfunction-hearingaidproduct-01

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Zib MedicalDevice Product

Name	Flags	Card.	Type	Description & Constraints
Device		0..*	Zib MedicalDevice Product	Product
type		0..1	CodeableConcept	ProductType Binding: HorenHulpmiddelTypeCodelijst (extensible): HorenHulpmiddelTypeCodelijst
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Device.type	extensible	HorenHulpmiddelTypeCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.4.17.2--20171231000000 from this IG

Name	Flags	Card.	Type	Description & Constraints
Device		0..*	Zib MedicalDevice Product	Product
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier		0..*	Identifier	ProductID Slice: Unordered, Open by value:type
identifier:serialNumber		0..1	Identifier	serial number (21) part of the UDI
use	?!Σ	0..1	code	usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
coding	Σ	1..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/identifier-type
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: SNO
value	Σ	1..1	string	The value that is unique Example General: 123456
status	?!Σ	0..1	code	active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device.
type		0..1	CodeableConcept	ProductType Binding: HorenHulpmiddelTypeCodelijst (extensible): HorenHulpmiddelTypeCodelijst
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Device.identifier:serialNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use from the FHIR Standard
Device.identifier:serialNumber.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Device.status	required	FHIRDeviceStatus http://hl7.org/fhir/ValueSet/device-status from the FHIR Standard
Device.type	extensible	HorenHulpmiddelTypeCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.4.17.2--20171231000000 from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	Device	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	Device	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Device	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4	error	Device	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()

Name	Flags	Card.	Type	Description & Constraints
Device		0..*	Zib MedicalDevice Product	Product
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: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier		0..*	Identifier	ProductID Slice: Unordered, Open by value:type
identifier:serialNumber		0..1	Identifier	serial number (21) part of the UDI
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/identifier-type
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: SNO
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
udi	Σ	0..1	BackboneElement	Unique Device Identifier (UDI) Barcode string
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
deviceIdentifier	Σ	0..1	string	application identifier (AI) (01) part of the udi
name	Σ	0..1	string	Device Name as appears on UDI label
jurisdiction		0..1	uri	Regional UDI authority
carrierHRF	Σ	0..1	string	ProductID
carrierAIDC	Σ	0..1	base64Binary	UDI Machine Readable Barcode String
issuer		0..1	uri	UDI Issuing Organization
entryType		0..1	code	barcode | rfid | manual + Binding: UDIEntryType (required): Codes to identify how UDI data was entered
status	?!Σ	0..1	code	active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device.
type		0..1	CodeableConcept	ProductType Binding: HorenHulpmiddelTypeCodelijst (extensible): HorenHulpmiddelTypeCodelijst
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
lotNumber		0..1	string	batch or lot number (10) part of the UDI
manufacturer		0..1	string	Name of device manufacturer
manufactureDate		0..1	dateTime	Date when the device was made
expirationDate		0..1	dateTime	expiration date (17) part of the UDI
model		0..1	string	Model id assigned by the manufacturer
version		0..1	string	Version number (i.e. software)
patient		0..1	Reference(nl-core-patient)	Patient to whom Device is affixed
owner		0..1	Reference(nl-core-organization)	Organization responsible for device
contact		0..*	ContactPoint	Details for human/organization for support
location		0..1	Reference(nl-core-location)	Where the resource is found
url		0..1	uri	Network address to contact device
note		0..*	Annotation	Device notes and comments
id		0..1	string	xml:id (or equivalent in JSON)
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)
authorString			string
time	Σ	0..1	dateTime	When the annotation was made
text		1..1	string	ProductDescription
safety	Σ	0..*	CodeableConcept	Safety Characteristics of Device Binding: DeviceSafety (example): Codes used to identify medical devices safety characterics. These codes are derived in part from the United States Food and Drug Administration recommendations and are provided here as a suggestive example.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Device.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Device.identifier:serialNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use from the FHIR Standard
Device.identifier:serialNumber.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Device.udi.entryType	required	UDIEntryType http://hl7.org/fhir/ValueSet/udi-entry-type from the FHIR Standard
Device.status	required	FHIRDeviceStatus http://hl7.org/fhir/ValueSet/device-status from the FHIR Standard
Device.type	extensible	HorenHulpmiddelTypeCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.4.17.2--20171231000000 from this IG
Device.safety	example	DeviceSafety http://hl7.org/fhir/ValueSet/device-safety from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	Device	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	Device	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Device	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4	error	Device	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()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())

This structure is derived from Zib MedicalDevice Product

Summary

Differential View

This structure is derived from Zib MedicalDevice Product

Name	Flags	Card.	Type	Description & Constraints
Device		0..*	Zib MedicalDevice Product	Product
type		0..1	CodeableConcept	ProductType Binding: HorenHulpmiddelTypeCodelijst (extensible): HorenHulpmiddelTypeCodelijst
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Device.type	extensible	HorenHulpmiddelTypeCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.4.17.2--20171231000000 from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Device		0..*	Zib MedicalDevice Product	Product
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier		0..*	Identifier	ProductID Slice: Unordered, Open by value:type
identifier:serialNumber		0..1	Identifier	serial number (21) part of the UDI
use	?!Σ	0..1	code	usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
coding	Σ	1..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/identifier-type
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: SNO
value	Σ	1..1	string	The value that is unique Example General: 123456
status	?!Σ	0..1	code	active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device.
type		0..1	CodeableConcept	ProductType Binding: HorenHulpmiddelTypeCodelijst (extensible): HorenHulpmiddelTypeCodelijst
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Device.identifier:serialNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use from the FHIR Standard
Device.identifier:serialNumber.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Device.status	required	FHIRDeviceStatus http://hl7.org/fhir/ValueSet/device-status from the FHIR Standard
Device.type	extensible	HorenHulpmiddelTypeCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.4.17.2--20171231000000 from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	Device	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	Device	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Device	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4	error	Device	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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Device		0..*	Zib MedicalDevice Product	Product
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: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier		0..*	Identifier	ProductID Slice: Unordered, Open by value:type
identifier:serialNumber		0..1	Identifier	serial number (21) part of the UDI
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/identifier-type
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: SNO
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
udi	Σ	0..1	BackboneElement	Unique Device Identifier (UDI) Barcode string
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
deviceIdentifier	Σ	0..1	string	application identifier (AI) (01) part of the udi
name	Σ	0..1	string	Device Name as appears on UDI label
jurisdiction		0..1	uri	Regional UDI authority
carrierHRF	Σ	0..1	string	ProductID
carrierAIDC	Σ	0..1	base64Binary	UDI Machine Readable Barcode String
issuer		0..1	uri	UDI Issuing Organization
entryType		0..1	code	barcode | rfid | manual + Binding: UDIEntryType (required): Codes to identify how UDI data was entered
status	?!Σ	0..1	code	active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device.
type		0..1	CodeableConcept	ProductType Binding: HorenHulpmiddelTypeCodelijst (extensible): HorenHulpmiddelTypeCodelijst
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
lotNumber		0..1	string	batch or lot number (10) part of the UDI
manufacturer		0..1	string	Name of device manufacturer
manufactureDate		0..1	dateTime	Date when the device was made
expirationDate		0..1	dateTime	expiration date (17) part of the UDI
model		0..1	string	Model id assigned by the manufacturer
version		0..1	string	Version number (i.e. software)
patient		0..1	Reference(nl-core-patient)	Patient to whom Device is affixed
owner		0..1	Reference(nl-core-organization)	Organization responsible for device
contact		0..*	ContactPoint	Details for human/organization for support
location		0..1	Reference(nl-core-location)	Where the resource is found
url		0..1	uri	Network address to contact device
note		0..*	Annotation	Device notes and comments
id		0..1	string	xml:id (or equivalent in JSON)
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)
authorString			string
time	Σ	0..1	dateTime	When the annotation was made
text		1..1	string	ProductDescription
safety	Σ	0..*	CodeableConcept	Safety Characteristics of Device Binding: DeviceSafety (example): Codes used to identify medical devices safety characterics. These codes are derived in part from the United States Food and Drug Administration recommendations and are provided here as a suggestive example.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Device.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Device.identifier:serialNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use from the FHIR Standard
Device.identifier:serialNumber.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Device.udi.entryType	required	UDIEntryType http://hl7.org/fhir/ValueSet/udi-entry-type from the FHIR Standard
Device.status	required	FHIRDeviceStatus http://hl7.org/fhir/ValueSet/device-status from the FHIR Standard
Device.type	extensible	HorenHulpmiddelTypeCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.4.17.2--20171231000000 from this IG
Device.safety	example	DeviceSafety http://hl7.org/fhir/ValueSet/device-safety from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	Device	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	Device	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Device	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4	error	Device	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()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())

This structure is derived from Zib MedicalDevice Product

Summary

Other representations of profile: CSV, Excel, Schematron