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-MedicalDevice.Product | Version: 0.9.0 | |||
| Draft as of 2023-10-17 | Computable Name: ZibMedicalDeviceProduct | |||
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. |
||||
Medical devices are any internally implanted and external devices and/or aids used by the patient (in the past) to reduce the effects of functional limitations in organ systems or to facilitate the treatment of a disease.
This Device resource represents the Product concept of the Dutch zib (‘Zorginformatiebouwsteen’, i.e. Health and Care Information Model) MedicalDevice v3.3.1 (2020).
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Device
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | Device | This is an abstract profile. Child profiles: NlcoreMedicalDeviceProduct, ZibHearingFunctionHearingAidProduct, ZibVisualFunctionVisualAidProduct Product | |
![]() ![]() | 0..1 | Identifier | Instance identifier Slice: Unordered, Open by pattern:$this | |
![]() ![]() ![]() | 0..1 | Identifier | ProductID Required Pattern: At least the following | |
![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.gs1.org/gtin | |
![]() ![]() ![]() | 0..1 | Identifier | ProductID Required Pattern: At least the following | |
![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.40 | |
![]() ![]() | 0..1 | BackboneElement | Unique Device Identifier (UDI) Barcode string Slice: Unordered, Open by value:issuer | |
![]() ![]() ![]() | 0..1 | BackboneElement | Unique Device Identifier (UDI) Barcode string | |
![]() ![]() ![]() ![]() | 0..1 | string | Mandatory fixed portion of UDI | |
![]() ![]() ![]() ![]() | 0..1 | uri | UDI Issuing Organization Required Pattern: https://www.gs1.org/gtin | |
![]() ![]() ![]() ![]() | 0..1 | string | ProductID | |
![]() ![]() ![]() | 0..1 | BackboneElement | Unique Device Identifier (UDI) Barcode string | |
![]() ![]() ![]() ![]() | 0..1 | uri | UDI Issuing Organization Required Pattern: urn:oid:2.16.840.1.113883.6.40 | |
![]() ![]() ![]() ![]() | 0..1 | string | ProductID | |
![]() ![]() | 0..1 | dateTime | Date when the device was made | |
![]() ![]() | 0..1 | dateTime | Date and time of expiry of this device (if applicable) | |
![]() ![]() | 0..1 | string | Lot number of manufacture | |
![]() ![]() | 0..1 | string | Serial number assigned by the manufacturer | |
![]() ![]() | 0..1 | CodeableConcept | ProductType Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.10.1.1--20200901000000 (required) | |
![]() ![]() | 0..1 | Annotation | Device notes and comments | |
![]() ![]() ![]() | 1..1 | markdown | ProductDescription | |
Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Device.type | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.10.1.1--20200901000000 |
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | Device | This is an abstract profile. Child profiles: NlcoreMedicalDeviceProduct, ZibHearingFunctionHearingAidProduct, ZibVisualFunctionVisualAidProduct Product | |
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() | 0..1 | Identifier | Instance identifier Slice: Unordered, Open by pattern:$this | |
![]() ![]() ![]() | 0..1 | Identifier | ProductID Required Pattern: At least the following | |
![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.gs1.org/gtin | |
![]() ![]() ![]() | 0..1 | Identifier | ProductID Required Pattern: At least the following | |
![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.40 | |
![]() ![]() | Σ | 0..1 | BackboneElement | Unique Device Identifier (UDI) Barcode string Slice: Unordered, Open by value:issuer |
![]() ![]() ![]() | Content/Rules for all slices | |||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() | Σ | 0..1 | BackboneElement | Unique Device Identifier (UDI) Barcode string |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Mandatory fixed portion of UDI |
![]() ![]() ![]() ![]() | 0..1 | uri | UDI Issuing Organization Required Pattern: https://www.gs1.org/gtin | |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | ProductID |
![]() ![]() ![]() | Σ | 0..1 | BackboneElement | Unique Device Identifier (UDI) Barcode string |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 0..1 | uri | UDI Issuing Organization Required Pattern: urn:oid:2.16.840.1.113883.6.40 | |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | ProductID |
![]() ![]() | ?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. |
![]() ![]() | 0..1 | dateTime | Date when the device was made | |
![]() ![]() | 0..1 | dateTime | Date and time of expiry of this device (if applicable) | |
![]() ![]() | 0..1 | string | Lot number of manufacture | |
![]() ![]() | 0..1 | string | Serial number assigned by the manufacturer | |
![]() ![]() | 0..1 | CodeableConcept | ProductType Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.10.1.1--20200901000000 (required) | |
![]() ![]() | 0..1 | Annotation | Device notes and comments | |
![]() ![]() ![]() | Σ | 1..1 | markdown | ProductDescription |
Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Device.status | required | FHIRDeviceStatus |
| Device.type | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.10.1.1--20200901000000 |
| Id | Grade | Path(s) | Details | Requirements |
| 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 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 | 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() | |
| dom-5 | error | Device | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Device | 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![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() | 0..* | Device | This is an abstract profile. Child profiles: NlcoreMedicalDeviceProduct, ZibHearingFunctionHearingAidProduct, ZibVisualFunctionVisualAidProduct Product | |||||
![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() | 0..1 | Identifier | Instance identifier Slice: Unordered, Open by pattern:$this | |||||
![]() ![]() ![]() | 0..1 | Identifier | ProductID Required Pattern: At least the following | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.gs1.org/gtin | |||||
![]() ![]() ![]() ![]() | 0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() | 0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() | 0..1 | Identifier | ProductID Required Pattern: At least the following | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.40 | |||||
![]() ![]() ![]() ![]() | 0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() | 0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() | 0..1 | Reference(DeviceDefinition) | The reference to the definition for the device | |||||
![]() ![]() | Σ | 0..1 | BackboneElement | Unique Device Identifier (UDI) Barcode string Slice: Unordered, Open by value:issuer | ||||
![]() ![]() ![]() | Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Mandatory fixed portion of UDI | ||||
![]() ![]() ![]() ![]() | 0..1 | uri | UDI Issuing Organization | |||||
![]() ![]() ![]() ![]() | 0..1 | uri | Regional UDI authority | |||||
![]() ![]() ![]() ![]() | Σ | 0..1 | base64Binary | UDI Machine Readable Barcode String | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | UDI Human Readable Barcode String | ||||
![]() ![]() ![]() ![]() | 0..1 | code | barcode | rfid | manual + Binding: UDIEntryType (required): Codes to identify how UDI data was entered. | |||||
![]() ![]() ![]() | Σ | 0..1 | BackboneElement | Unique Device Identifier (UDI) Barcode string | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Mandatory fixed portion of UDI | ||||
![]() ![]() ![]() ![]() | 0..1 | uri | UDI Issuing Organization Required Pattern: https://www.gs1.org/gtin | |||||
![]() ![]() ![]() ![]() | 0..1 | uri | Regional UDI authority | |||||
![]() ![]() ![]() ![]() | Σ | 0..1 | base64Binary | UDI Machine Readable Barcode String | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | ProductID | ||||
![]() ![]() ![]() ![]() | 0..1 | code | barcode | rfid | manual + Binding: UDIEntryType (required): Codes to identify how UDI data was entered. | |||||
![]() ![]() ![]() | Σ | 0..1 | BackboneElement | Unique Device Identifier (UDI) Barcode string | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Mandatory fixed portion of UDI | ||||
![]() ![]() ![]() ![]() | 0..1 | uri | UDI Issuing Organization Required Pattern: urn:oid:2.16.840.1.113883.6.40 | |||||
![]() ![]() ![]() ![]() | 0..1 | uri | Regional UDI authority | |||||
![]() ![]() ![]() ![]() | Σ | 0..1 | base64Binary | UDI Machine Readable Barcode String | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | ProductID | ||||
![]() ![]() ![]() ![]() | 0..1 | code | barcode | rfid | manual + Binding: UDIEntryType (required): Codes to identify how UDI data was entered. | |||||
![]() ![]() | ?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. | ||||
![]() ![]() | 0..* | CodeableConcept | online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device. | |||||
![]() ![]() | 0..1 | string | The distinct identification string | |||||
![]() ![]() | 0..1 | string | Name of device manufacturer | |||||
![]() ![]() | 0..1 | dateTime | Date when the device was made | |||||
![]() ![]() | 0..1 | dateTime | Date and time of expiry of this device (if applicable) | |||||
![]() ![]() | 0..1 | string | Lot number of manufacture | |||||
![]() ![]() | 0..1 | string | Serial number assigned by the manufacturer | |||||
![]() ![]() | 0..* | BackboneElement | The name of the device as given by the manufacturer | |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | 1..1 | string | The name of the device | |||||
![]() ![]() ![]() | 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Binding: DeviceNameType (required): The type of name the device is referred by. | |||||
![]() ![]() | 0..1 | string | The model number for the device | |||||
![]() ![]() | 0..1 | string | The part number of the device | |||||
![]() ![]() | 0..1 | CodeableConcept | ProductType Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.10.1.1--20200901000000 (required) | |||||
![]() ![]() | 0..* | BackboneElement | The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication | |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | 1..1 | CodeableConcept | The standard that is used to operate and communicate | |||||
![]() ![]() ![]() | 0..1 | string | The version of the standard that is used to operate and communicate | |||||
![]() ![]() | 0..* | BackboneElement | The actual design of the device or software version running on the device | |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | 0..1 | CodeableConcept | The type of the device version | |||||
![]() ![]() ![]() | 0..1 | Identifier | A single component of the device version | |||||
![]() ![]() ![]() | 1..1 | string | The version text | |||||
![]() ![]() | 0..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties | |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | 1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) | |||||
![]() ![]() ![]() | 0..* | Quantity | Property value as a quantity | |||||
![]() ![]() ![]() | 0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | |||||
![]() ![]() | 0..1 | Reference(Patient) | Patient to whom Device is affixed | |||||
![]() ![]() | 0..1 | Reference(Organization) | Organization responsible for device | |||||
![]() ![]() | 0..* | ContactPoint | Details for human/organization for support | |||||
![]() ![]() | 0..1 | Reference(Location) | Where the device is found | |||||
![]() ![]() | 0..1 | uri | Network address to contact device | |||||
![]() ![]() | 0..1 | Annotation | Device notes and comments | |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | Σ | 0..1 | Individual responsible for the annotation | |||||
![]() ![]() ![]() ![]() | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
![]() ![]() ![]() ![]() | string | |||||||
![]() ![]() ![]() | Σ | 0..1 | dateTime | When the annotation was made | ||||
![]() ![]() ![]() | Σ | 1..1 | markdown | ProductDescription | ||||
![]() ![]() | Σ | 0..* | CodeableConcept | Safety Characteristics of Device | ||||
![]() ![]() | 0..1 | Reference(Device) | The parent device | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Device.language | preferred | CommonLanguages
| ||||
| Device.udiCarrier.entryType | required | UDIEntryType | ||||
| Device.udiCarrier:gs1UdiCarrier.entryType | required | UDIEntryType | ||||
| Device.udiCarrier:hibcUdiCarrier.entryType | required | UDIEntryType | ||||
| Device.status | required | FHIRDeviceStatus | ||||
| Device.statusReason | extensible | FHIRDeviceStatusReason | ||||
| Device.deviceName.type | required | DeviceNameType | ||||
| Device.type | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.10.1.1--20200901000000 |
| Id | Grade | Path(s) | Details | Requirements |
| 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 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 | 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() | |
| dom-5 | error | Device | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Device | 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() |
Differential View
This structure is derived from Device
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | Device | This is an abstract profile. Child profiles: NlcoreMedicalDeviceProduct, ZibHearingFunctionHearingAidProduct, ZibVisualFunctionVisualAidProduct Product | |
![]() ![]() | 0..1 | Identifier | Instance identifier Slice: Unordered, Open by pattern:$this | |
![]() ![]() ![]() | 0..1 | Identifier | ProductID Required Pattern: At least the following | |
![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.gs1.org/gtin | |
![]() ![]() ![]() | 0..1 | Identifier | ProductID Required Pattern: At least the following | |
![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.40 | |
![]() ![]() | 0..1 | BackboneElement | Unique Device Identifier (UDI) Barcode string Slice: Unordered, Open by value:issuer | |
![]() ![]() ![]() | 0..1 | BackboneElement | Unique Device Identifier (UDI) Barcode string | |
![]() ![]() ![]() ![]() | 0..1 | string | Mandatory fixed portion of UDI | |
![]() ![]() ![]() ![]() | 0..1 | uri | UDI Issuing Organization Required Pattern: https://www.gs1.org/gtin | |
![]() ![]() ![]() ![]() | 0..1 | string | ProductID | |
![]() ![]() ![]() | 0..1 | BackboneElement | Unique Device Identifier (UDI) Barcode string | |
![]() ![]() ![]() ![]() | 0..1 | uri | UDI Issuing Organization Required Pattern: urn:oid:2.16.840.1.113883.6.40 | |
![]() ![]() ![]() ![]() | 0..1 | string | ProductID | |
![]() ![]() | 0..1 | dateTime | Date when the device was made | |
![]() ![]() | 0..1 | dateTime | Date and time of expiry of this device (if applicable) | |
![]() ![]() | 0..1 | string | Lot number of manufacture | |
![]() ![]() | 0..1 | string | Serial number assigned by the manufacturer | |
![]() ![]() | 0..1 | CodeableConcept | ProductType Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.10.1.1--20200901000000 (required) | |
![]() ![]() | 0..1 | Annotation | Device notes and comments | |
![]() ![]() ![]() | 1..1 | markdown | ProductDescription | |
Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Device.type | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.10.1.1--20200901000000 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | Device | This is an abstract profile. Child profiles: NlcoreMedicalDeviceProduct, ZibHearingFunctionHearingAidProduct, ZibVisualFunctionVisualAidProduct Product | |
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() | 0..1 | Identifier | Instance identifier Slice: Unordered, Open by pattern:$this | |
![]() ![]() ![]() | 0..1 | Identifier | ProductID Required Pattern: At least the following | |
![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.gs1.org/gtin | |
![]() ![]() ![]() | 0..1 | Identifier | ProductID Required Pattern: At least the following | |
![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.40 | |
![]() ![]() | Σ | 0..1 | BackboneElement | Unique Device Identifier (UDI) Barcode string Slice: Unordered, Open by value:issuer |
![]() ![]() ![]() | Content/Rules for all slices | |||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() | Σ | 0..1 | BackboneElement | Unique Device Identifier (UDI) Barcode string |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Mandatory fixed portion of UDI |
![]() ![]() ![]() ![]() | 0..1 | uri | UDI Issuing Organization Required Pattern: https://www.gs1.org/gtin | |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | ProductID |
![]() ![]() ![]() | Σ | 0..1 | BackboneElement | Unique Device Identifier (UDI) Barcode string |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 0..1 | uri | UDI Issuing Organization Required Pattern: urn:oid:2.16.840.1.113883.6.40 | |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | ProductID |
![]() ![]() | ?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. |
![]() ![]() | 0..1 | dateTime | Date when the device was made | |
![]() ![]() | 0..1 | dateTime | Date and time of expiry of this device (if applicable) | |
![]() ![]() | 0..1 | string | Lot number of manufacture | |
![]() ![]() | 0..1 | string | Serial number assigned by the manufacturer | |
![]() ![]() | 0..1 | CodeableConcept | ProductType Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.10.1.1--20200901000000 (required) | |
![]() ![]() | 0..1 | Annotation | Device notes and comments | |
![]() ![]() ![]() | Σ | 1..1 | markdown | ProductDescription |
Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Device.status | required | FHIRDeviceStatus |
| Device.type | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.10.1.1--20200901000000 |
| Id | Grade | Path(s) | Details | Requirements |
| 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 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 | 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() | |
| dom-5 | error | Device | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Device | 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![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() | 0..* | Device | This is an abstract profile. Child profiles: NlcoreMedicalDeviceProduct, ZibHearingFunctionHearingAidProduct, ZibVisualFunctionVisualAidProduct Product | |||||
![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() | 0..1 | Identifier | Instance identifier Slice: Unordered, Open by pattern:$this | |||||
![]() ![]() ![]() | 0..1 | Identifier | ProductID Required Pattern: At least the following | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.gs1.org/gtin | |||||
![]() ![]() ![]() ![]() | 0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() | 0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() | 0..1 | Identifier | ProductID Required Pattern: At least the following | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.40 | |||||
![]() ![]() ![]() ![]() | 0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() | 0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() | 0..1 | Reference(DeviceDefinition) | The reference to the definition for the device | |||||
![]() ![]() | Σ | 0..1 | BackboneElement | Unique Device Identifier (UDI) Barcode string Slice: Unordered, Open by value:issuer | ||||
![]() ![]() ![]() | Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Mandatory fixed portion of UDI | ||||
![]() ![]() ![]() ![]() | 0..1 | uri | UDI Issuing Organization | |||||
![]() ![]() ![]() ![]() | 0..1 | uri | Regional UDI authority | |||||
![]() ![]() ![]() ![]() | Σ | 0..1 | base64Binary | UDI Machine Readable Barcode String | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | UDI Human Readable Barcode String | ||||
![]() ![]() ![]() ![]() | 0..1 | code | barcode | rfid | manual + Binding: UDIEntryType (required): Codes to identify how UDI data was entered. | |||||
![]() ![]() ![]() | Σ | 0..1 | BackboneElement | Unique Device Identifier (UDI) Barcode string | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Mandatory fixed portion of UDI | ||||
![]() ![]() ![]() ![]() | 0..1 | uri | UDI Issuing Organization Required Pattern: https://www.gs1.org/gtin | |||||
![]() ![]() ![]() ![]() | 0..1 | uri | Regional UDI authority | |||||
![]() ![]() ![]() ![]() | Σ | 0..1 | base64Binary | UDI Machine Readable Barcode String | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | ProductID | ||||
![]() ![]() ![]() ![]() | 0..1 | code | barcode | rfid | manual + Binding: UDIEntryType (required): Codes to identify how UDI data was entered. | |||||
![]() ![]() ![]() | Σ | 0..1 | BackboneElement | Unique Device Identifier (UDI) Barcode string | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Mandatory fixed portion of UDI | ||||
![]() ![]() ![]() ![]() | 0..1 | uri | UDI Issuing Organization Required Pattern: urn:oid:2.16.840.1.113883.6.40 | |||||
![]() ![]() ![]() ![]() | 0..1 | uri | Regional UDI authority | |||||
![]() ![]() ![]() ![]() | Σ | 0..1 | base64Binary | UDI Machine Readable Barcode String | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | ProductID | ||||
![]() ![]() ![]() ![]() | 0..1 | code | barcode | rfid | manual + Binding: UDIEntryType (required): Codes to identify how UDI data was entered. | |||||
![]() ![]() | ?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. | ||||
![]() ![]() | 0..* | CodeableConcept | online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device. | |||||
![]() ![]() | 0..1 | string | The distinct identification string | |||||
![]() ![]() | 0..1 | string | Name of device manufacturer | |||||
![]() ![]() | 0..1 | dateTime | Date when the device was made | |||||
![]() ![]() | 0..1 | dateTime | Date and time of expiry of this device (if applicable) | |||||
![]() ![]() | 0..1 | string | Lot number of manufacture | |||||
![]() ![]() | 0..1 | string | Serial number assigned by the manufacturer | |||||
![]() ![]() | 0..* | BackboneElement | The name of the device as given by the manufacturer | |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | 1..1 | string | The name of the device | |||||
![]() ![]() ![]() | 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Binding: DeviceNameType (required): The type of name the device is referred by. | |||||
![]() ![]() | 0..1 | string | The model number for the device | |||||
![]() ![]() | 0..1 | string | The part number of the device | |||||
![]() ![]() | 0..1 | CodeableConcept | ProductType Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.10.1.1--20200901000000 (required) | |||||
![]() ![]() | 0..* | BackboneElement | The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication | |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | 1..1 | CodeableConcept | The standard that is used to operate and communicate | |||||
![]() ![]() ![]() | 0..1 | string | The version of the standard that is used to operate and communicate | |||||
![]() ![]() | 0..* | BackboneElement | The actual design of the device or software version running on the device | |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | 0..1 | CodeableConcept | The type of the device version | |||||
![]() ![]() ![]() | 0..1 | Identifier | A single component of the device version | |||||
![]() ![]() ![]() | 1..1 | string | The version text | |||||
![]() ![]() | 0..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties | |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | 1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) | |||||
![]() ![]() ![]() | 0..* | Quantity | Property value as a quantity | |||||
![]() ![]() ![]() | 0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | |||||
![]() ![]() | 0..1 | Reference(Patient) | Patient to whom Device is affixed | |||||
![]() ![]() | 0..1 | Reference(Organization) | Organization responsible for device | |||||
![]() ![]() | 0..* | ContactPoint | Details for human/organization for support | |||||
![]() ![]() | 0..1 | Reference(Location) | Where the device is found | |||||
![]() ![]() | 0..1 | uri | Network address to contact device | |||||
![]() ![]() | 0..1 | Annotation | Device notes and comments | |||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | Σ | 0..1 | Individual responsible for the annotation | |||||
![]() ![]() ![]() ![]() | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
![]() ![]() ![]() ![]() | string | |||||||
![]() ![]() ![]() | Σ | 0..1 | dateTime | When the annotation was made | ||||
![]() ![]() ![]() | Σ | 1..1 | markdown | ProductDescription | ||||
![]() ![]() | Σ | 0..* | CodeableConcept | Safety Characteristics of Device | ||||
![]() ![]() | 0..1 | Reference(Device) | The parent device | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Device.language | preferred | CommonLanguages
| ||||
| Device.udiCarrier.entryType | required | UDIEntryType | ||||
| Device.udiCarrier:gs1UdiCarrier.entryType | required | UDIEntryType | ||||
| Device.udiCarrier:hibcUdiCarrier.entryType | required | UDIEntryType | ||||
| Device.status | required | FHIRDeviceStatus | ||||
| Device.statusReason | extensible | FHIRDeviceStatusReason | ||||
| Device.deviceName.type | required | DeviceNameType | ||||
| Device.type | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.10.1.1--20200901000000 |
| Id | Grade | Path(s) | Details | Requirements |
| 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 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 | 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() | |
| dom-5 | error | Device | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Device | 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() |
Other representations of profile: CSV, Excel, Schematron