IL Core Implementation Guide
0.18.0 - draft
This page is part of the IL-Core IG (v0.18.0: draft-1 Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: http://fhir.health.gov.il/StructureDefinition/il-core-device-definition | Version: 0.18.0 | |||
Standards status: Draft | Maturity Level: 0 | Computable Name: ILCoreDeviceDefinition |
Israel Core proposed constraints and extensions on the DeviceDefinition Resource
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DeviceDefinition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceDefinition | 0..* | DeviceDefinition | ILCore DeviceDefinition Profile | |
Slices for manufacturer[x] | 0..1 | string, Reference(Organization) | Name of device manufacturer Slice: Unordered, Open by type:$this | |
manufacturer[x]:manufacturerReference | 0..1 | Reference(ILCore Organization Profile) | Name of device manufacturer | |
owner | 0..1 | Reference(ILCore Organization Profile) | Organization responsible for device | |
parentDevice | 0..1 | Reference(ILCore DeviceDefinition Profile) | The parent device it can be part of | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceDefinition | 0..* | DeviceDefinition | ILCore DeviceDefinition Profile | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for manufacturer[x] | 0..1 | Name of device manufacturer Slice: Unordered, Open by type:$this | ||
manufacturerString | string | |||
manufacturerReference | Reference(Organization) | |||
manufacturer[x]:manufacturerReference | 0..1 | Reference(ILCore Organization Profile) | Name of device manufacturer | |
owner | 0..1 | Reference(ILCore Organization Profile) | Organization responsible for device | |
parentDevice | Σ | 0..1 | Reference(ILCore DeviceDefinition Profile) | The parent device it can be part of |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
DeviceDefinition | 0..* | DeviceDefinition | ILCore DeviceDefinition Profile | |||||
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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 0..* | Identifier | Instance identifier | |||||
udiDeviceIdentifier | 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
deviceIdentifier | 1..1 | string | The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier | |||||
issuer | 1..1 | uri | The organization that assigns the identifier algorithm | |||||
jurisdiction | 1..1 | uri | The jurisdiction to which the deviceIdentifier applies | |||||
Slices for manufacturer[x] | 0..1 | Name of device manufacturer Slice: Unordered, Open by type:$this | ||||||
manufacturerString | string | |||||||
manufacturerReference | Reference(Organization) | |||||||
manufacturer[x]:manufacturerReference | 0..1 | Reference(ILCore Organization Profile) | Name of device manufacturer | |||||
deviceName | 0..* | BackboneElement | A name given to the device to identify it | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | 1..1 | string | The name of the device | |||||
type | 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. | |||||
modelNumber | 0..1 | string | The model number for the device | |||||
type | 0..1 | CodeableConcept | What kind of device or device system this is Binding: FHIRDeviceTypes (example): Type of device e.g. according to official classification. | |||||
specialization | 0..* | BackboneElement | The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
systemType | 1..1 | string | The standard that is used to operate and communicate | |||||
version | 0..1 | string | The version of the standard that is used to operate and communicate | |||||
version | 0..* | string | Available versions | |||||
safety | Σ | 0..* | CodeableConcept | Safety characteristics of the device Binding: DeviceSafety (example) | ||||
shelfLifeStorage | 0..* | ProductShelfLife | Shelf Life and storage information | |||||
physicalCharacteristics | 0..1 | ProdCharacteristic | Dimensions, color etc. | |||||
languageCode | 0..* | CodeableConcept | Language code for the human-readable text strings produced by the device (all supported) | |||||
capability | 0..* | BackboneElement | Device capabilities | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Type of capability | |||||
description | 0..* | CodeableConcept | Description of capability | |||||
property | 0..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) | |||||
valueQuantity | 0..* | Quantity | Property value as a quantity | |||||
valueCode | 0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | |||||
owner | 0..1 | Reference(ILCore Organization Profile) | Organization responsible for device | |||||
contact | 0..* | ContactPoint | Details for human/organization for support | |||||
url | 0..1 | uri | Network address to contact device | |||||
onlineInformation | 0..1 | uri | Access to on-line information | |||||
note | 0..* | Annotation | Device notes and comments | |||||
quantity | 0..1 | Quantity | The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product) | |||||
parentDevice | Σ | 0..1 | Reference(ILCore DeviceDefinition Profile) | The parent device it can be part of | ||||
material | 0..* | BackboneElement | A substance used to create the material(s) of which the device is made | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
substance | 1..1 | CodeableConcept | The substance | |||||
alternate | 0..1 | boolean | Indicates an alternative material of the device | |||||
allergenicIndicator | 0..1 | boolean | Whether the substance is a known or suspected allergen | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
DeviceDefinition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
DeviceDefinition.deviceName.type | required | DeviceNameTypehttp://hl7.org/fhir/ValueSet/device-nametype|4.0.1 from the FHIR Standard | ||||
DeviceDefinition.type | example | FHIRDeviceTypeshttp://hl7.org/fhir/ValueSet/device-kind from the FHIR Standard | ||||
DeviceDefinition.safety | example | DeviceSafetyhttp://hl7.org/fhir/ValueSet/device-safety from the FHIR Standard |
This structure is derived from DeviceDefinition
Summary
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Differential View
This structure is derived from DeviceDefinition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceDefinition | 0..* | DeviceDefinition | ILCore DeviceDefinition Profile | |
Slices for manufacturer[x] | 0..1 | string, Reference(Organization) | Name of device manufacturer Slice: Unordered, Open by type:$this | |
manufacturer[x]:manufacturerReference | 0..1 | Reference(ILCore Organization Profile) | Name of device manufacturer | |
owner | 0..1 | Reference(ILCore Organization Profile) | Organization responsible for device | |
parentDevice | 0..1 | Reference(ILCore DeviceDefinition Profile) | The parent device it can be part of | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceDefinition | 0..* | DeviceDefinition | ILCore DeviceDefinition Profile | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for manufacturer[x] | 0..1 | Name of device manufacturer Slice: Unordered, Open by type:$this | ||
manufacturerString | string | |||
manufacturerReference | Reference(Organization) | |||
manufacturer[x]:manufacturerReference | 0..1 | Reference(ILCore Organization Profile) | Name of device manufacturer | |
owner | 0..1 | Reference(ILCore Organization Profile) | Organization responsible for device | |
parentDevice | Σ | 0..1 | Reference(ILCore DeviceDefinition Profile) | The parent device it can be part of |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
DeviceDefinition | 0..* | DeviceDefinition | ILCore DeviceDefinition Profile | |||||
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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 0..* | Identifier | Instance identifier | |||||
udiDeviceIdentifier | 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
deviceIdentifier | 1..1 | string | The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier | |||||
issuer | 1..1 | uri | The organization that assigns the identifier algorithm | |||||
jurisdiction | 1..1 | uri | The jurisdiction to which the deviceIdentifier applies | |||||
Slices for manufacturer[x] | 0..1 | Name of device manufacturer Slice: Unordered, Open by type:$this | ||||||
manufacturerString | string | |||||||
manufacturerReference | Reference(Organization) | |||||||
manufacturer[x]:manufacturerReference | 0..1 | Reference(ILCore Organization Profile) | Name of device manufacturer | |||||
deviceName | 0..* | BackboneElement | A name given to the device to identify it | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | 1..1 | string | The name of the device | |||||
type | 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. | |||||
modelNumber | 0..1 | string | The model number for the device | |||||
type | 0..1 | CodeableConcept | What kind of device or device system this is Binding: FHIRDeviceTypes (example): Type of device e.g. according to official classification. | |||||
specialization | 0..* | BackboneElement | The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
systemType | 1..1 | string | The standard that is used to operate and communicate | |||||
version | 0..1 | string | The version of the standard that is used to operate and communicate | |||||
version | 0..* | string | Available versions | |||||
safety | Σ | 0..* | CodeableConcept | Safety characteristics of the device Binding: DeviceSafety (example) | ||||
shelfLifeStorage | 0..* | ProductShelfLife | Shelf Life and storage information | |||||
physicalCharacteristics | 0..1 | ProdCharacteristic | Dimensions, color etc. | |||||
languageCode | 0..* | CodeableConcept | Language code for the human-readable text strings produced by the device (all supported) | |||||
capability | 0..* | BackboneElement | Device capabilities | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Type of capability | |||||
description | 0..* | CodeableConcept | Description of capability | |||||
property | 0..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) | |||||
valueQuantity | 0..* | Quantity | Property value as a quantity | |||||
valueCode | 0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | |||||
owner | 0..1 | Reference(ILCore Organization Profile) | Organization responsible for device | |||||
contact | 0..* | ContactPoint | Details for human/organization for support | |||||
url | 0..1 | uri | Network address to contact device | |||||
onlineInformation | 0..1 | uri | Access to on-line information | |||||
note | 0..* | Annotation | Device notes and comments | |||||
quantity | 0..1 | Quantity | The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product) | |||||
parentDevice | Σ | 0..1 | Reference(ILCore DeviceDefinition Profile) | The parent device it can be part of | ||||
material | 0..* | BackboneElement | A substance used to create the material(s) of which the device is made | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
substance | 1..1 | CodeableConcept | The substance | |||||
alternate | 0..1 | boolean | Indicates an alternative material of the device | |||||
allergenicIndicator | 0..1 | boolean | Whether the substance is a known or suspected allergen | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
DeviceDefinition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
DeviceDefinition.deviceName.type | required | DeviceNameTypehttp://hl7.org/fhir/ValueSet/device-nametype|4.0.1 from the FHIR Standard | ||||
DeviceDefinition.type | example | FHIRDeviceTypeshttp://hl7.org/fhir/ValueSet/device-kind from the FHIR Standard | ||||
DeviceDefinition.safety | example | DeviceSafetyhttp://hl7.org/fhir/ValueSet/device-safety from the FHIR Standard |
This structure is derived from DeviceDefinition
Summary
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron