HL7 Europe Imaging Study Report
0.1.0-ballot - ci-build 150

HL7 Europe Imaging Study Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.1.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/oijauregui/ehdsimaging/tree/master and changes regularly. See the Directory of published versions

Resource Profile: Im Imaging Device

Official URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/ImImagingDevice Version: 0.1.0-ballot
Standards status: Draft Maturity Level: 1 Computable Name: ImImagingDevice

Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License

The device the made the image.

Usages:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device C 0..* Device Item used in healthcare
Constraints: dev-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code active | inactive | entered-in-error
Binding: FHIRDeviceStatus (required): The record status of the device.
... manufacturer 0..1 string Name of device manufacturer
... serialNumber 0..1 string Serial number assigned by the manufacturer
... name C 0..* BackboneElement The name or names of the device as known to the manufacturer and/or patient
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... value Σ 1..1 string The term that names the device
.... type Σ 1..1 code registered-name | user-friendly-name | patient-reported-name
Binding: DeviceNameType (required): The type of name the device is referred by.
.... display ?!ΣC 0..1 boolean The preferred device name
... Slices for category 1..* CodeableConcept Indicates a high-level grouping of the device
Slice: Unordered, Open by value:$this
Binding: FHIRDeviceCategory (example): Categories of medical devices.
.... category:imaging 1..1 CodeableConcept Indicates a high-level grouping of the device
Binding: FHIRDeviceCategory (example): Categories of medical devices.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 314789007
...... display 1..1 string Representation defined by the system
Fixed Value: Diagnostic imaging equipment
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... type 0..* CodeableConcept The kind or type of device
Binding: Imaging Device Type (extensible)
... version 0..* BackboneElement The actual design of the device or software version running on the device
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... value 1..1 string The version text

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Device.statusrequiredFHIRDeviceStatus
http://hl7.org/fhir/ValueSet/device-status|5.0.0
From the FHIR Standard
Device.name.typerequiredDeviceNameType
http://hl7.org/fhir/ValueSet/device-nametype|5.0.0
From the FHIR Standard
Device.categoryexampleFHIRDeviceCategory
http://hl7.org/fhir/ValueSet/device-category
From this IG
Device.category:imagingexamplePattern Value: SNOMED-CT Code 314789007("Diagnostic imaging equipment")
http://hl7.org/fhir/ValueSet/device-category
From this IG
Device.typeextensibleImImagingDeviceType
http://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-device-type
From this IG

Constraints

IdGradePath(s)DetailsRequirements
dev-1errorDeviceonly one Device.name.display SHALL be true when there is more than one Device.name
: name.where(display=true).count() <= 1
dom-2errorDeviceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorDeviceIf 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-5errorDeviceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Device

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device Device
... identifier 0..* Identifier Instance identifier
... udiCarrier
.... deviceIdentifier 1..1 string Mandatory fixed portion of UDI
... status 1..1 code active | inactive | entered-in-error
... serialNumber 0..1 string Serial number assigned by the manufacturer
... name 0..* BackboneElement The name or names of the device as known to the manufacturer and/or patient
... Slices for category 1..* CodeableConcept Indicates a high-level grouping of the device
Slice: Unordered, Open by value:$this
.... category:imaging 1..1 CodeableConcept Indicates a high-level grouping of the device
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 314789007
...... display 1..1 string Representation defined by the system
Fixed Value: Diagnostic imaging equipment
... type 0..* CodeableConcept The kind or type of device
Binding: Imaging Device Type (extensible)
... version 0..* BackboneElement The actual design of the device or software version running on the device

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Device.typeextensibleImImagingDeviceType
http://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-device-type
From this IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device C 0..* Device Item used in healthcare
Constraints: dev-1
... 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: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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
... displayName 0..1 string The name used to display by default when the device is referenced
... definition 0..1 CodeableReference(DeviceDefinition) The reference to the definition for the device
... udiCarrier Σ 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 Mandatory fixed portion of UDI
.... issuer Σ 1..1 uri UDI Issuing Organization
.... jurisdiction 0..1 uri Regional UDI authority
.... carrierAIDC Σ 0..1 base64Binary UDI Machine Readable Barcode String
.... carrierHRF Σ 0..1 string UDI Human Readable Barcode String
.... entryType 0..1 code barcode | rfid | manual | card | self-reported | electronic-transmission | unknown
Binding: UDIEntryType (required): Codes to identify how UDI data was entered.
... status ?!Σ 1..1 code active | inactive | entered-in-error
Binding: FHIRDeviceStatus (required): The record status of the device.
... availabilityStatus 0..1 CodeableConcept lost | damaged | destroyed | available
Binding: FHIRDeviceAvailabilityStatus (extensible): The availability status reason of the device.
... biologicalSourceEvent 0..1 Identifier An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled
... manufacturer 0..1 string Name of device manufacturer
... manufactureDate 0..1 dateTime Date when the device was made
... expirationDate 0..1 dateTime Date and time of expiry of this device (if applicable)
... lotNumber 0..1 string Lot number of manufacture
... serialNumber 0..1 string Serial number assigned by the manufacturer
... name C 0..* BackboneElement The name or names of the device as known to the manufacturer and/or patient
.... 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
.... value Σ 1..1 string The term that names the device
.... type Σ 1..1 code registered-name | user-friendly-name | patient-reported-name
Binding: DeviceNameType (required): The type of name the device is referred by.
.... display ?!ΣC 0..1 boolean The preferred device name
... modelNumber 0..1 string The manufacturer's model number for the device
... partNumber 0..1 string The part number or catalog number of the device
... Slices for category 1..* CodeableConcept Indicates a high-level grouping of the device
Slice: Unordered, Open by value:$this
Binding: FHIRDeviceCategory (example): Categories of medical devices.
.... category:imaging 1..1 CodeableConcept Indicates a high-level grouping of the device
Binding: FHIRDeviceCategory (example): Categories of medical devices.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 314789007
...... display 1..1 string Representation defined by the system
Fixed Value: Diagnostic imaging equipment
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... type 0..* CodeableConcept The kind or type of device
Binding: Imaging Device Type (extensible)
... version 0..* BackboneElement The actual design of the device or software version running on the device
.... 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 0..1 CodeableConcept The type of the device version, e.g. manufacturer, approved, internal
Binding: DeviceVersionType (example): The type of version indicated for the device.
.... component 0..1 Identifier The hardware or software module of the device to which the version applies
.... installDate 0..1 dateTime The date the version was installed on the device
.... value 1..1 string The version text
... conformsTo 0..* BackboneElement Identifies the standards, specifications, or formal guidances for the capabilities supported by the device
.... 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
.... category 0..1 CodeableConcept Describes the common type of the standard, specification, or formal guidance. communication | performance | measurement
Binding: DeviceSpecificationCategory (example): The kind of standards used by the device.
.... specification 1..1 CodeableConcept Identifies the standard, specification, or formal guidance that the device adheres to
Binding: DeviceSpecificationType (example): The type of version indicated for the device.
.... version 0..1 string Specific form or variant of the standard
... property 0..* BackboneElement Inherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc.
.... 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 being represented
Binding: DeviceType (example): Device property type.
.... value[x] 1..1 Value of the property
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueBoolean boolean
..... valueInteger integer
..... valueRange Range
..... valueAttachment Attachment
... mode 0..1 CodeableConcept The designated condition for performing a task
Binding: FHIRDeviceOperationMode (example): Operational mode of a device.
... cycle 0..1 Count The series of occurrences that repeats during the operation of the device
... duration 0..1 Duration A measurement of time during the device's operation (e.g., days, hours, mins, etc.)
... owner 0..1 Reference(Organization) Organization responsible for device
... contact 0..* ContactPoint Details for human/organization for support
... location 0..1 Reference(Location) Where the device is found
... url 0..1 uri Network address to contact device
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to electronic services provided by the device
... gateway 0..* CodeableReference(Device) Linked device acting as a communication/data collector, translator or controller
... note 0..* Annotation Device notes and comments
... safety Σ 0..* CodeableConcept Safety Characteristics of Device
Binding: DeviceSafety (example)
... parent 0..1 Reference(Device) The higher level or encompassing device that this device is a logical part of

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Device.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
Device.udiCarrier.entryTyperequiredUDIEntryType
http://hl7.org/fhir/ValueSet/udi-entry-type|5.0.0
From the FHIR Standard
Device.statusrequiredFHIRDeviceStatus
http://hl7.org/fhir/ValueSet/device-status|5.0.0
From the FHIR Standard
Device.availabilityStatusextensibleFHIRDeviceAvailabilityStatus
http://hl7.org/fhir/ValueSet/device-availability-status
From the FHIR Standard
Device.name.typerequiredDeviceNameType
http://hl7.org/fhir/ValueSet/device-nametype|5.0.0
From the FHIR Standard
Device.categoryexampleFHIRDeviceCategory
http://hl7.org/fhir/ValueSet/device-category
From this IG
Device.category:imagingexamplePattern Value: SNOMED-CT Code 314789007("Diagnostic imaging equipment")
http://hl7.org/fhir/ValueSet/device-category
From this IG
Device.typeextensibleImImagingDeviceType
http://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-device-type
From this IG
Device.version.typeexampleDeviceVersionType
http://hl7.org/fhir/ValueSet/device-versiontype
From the FHIR Standard
Device.conformsTo.categoryexampleDeviceSpecificationCategory
http://hl7.org/fhir/ValueSet/device-specification-category
From the FHIR Standard
Device.conformsTo.specificationexampleDeviceSpecificationType
http://hl7.org/fhir/ValueSet/device-specification-type
From the FHIR Standard
Device.property.typeexampleDeviceType
http://hl7.org/fhir/ValueSet/device-property-type
From the FHIR Standard
Device.modeexampleFHIRDeviceOperationMode
http://hl7.org/fhir/ValueSet/device-operation-mode
From the FHIR Standard
Device.safetyexampleDeviceSafety
http://hl7.org/fhir/ValueSet/device-safety
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dev-1errorDeviceonly one Device.name.display SHALL be true when there is more than one Device.name
: name.where(display=true).count() <= 1
dom-2errorDeviceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorDeviceIf 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-5errorDeviceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Device

Summary

Mandatory: 3 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Device.category

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device C 0..* Device Item used in healthcare
Constraints: dev-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code active | inactive | entered-in-error
Binding: FHIRDeviceStatus (required): The record status of the device.
... manufacturer 0..1 string Name of device manufacturer
... serialNumber 0..1 string Serial number assigned by the manufacturer
... name C 0..* BackboneElement The name or names of the device as known to the manufacturer and/or patient
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... value Σ 1..1 string The term that names the device
.... type Σ 1..1 code registered-name | user-friendly-name | patient-reported-name
Binding: DeviceNameType (required): The type of name the device is referred by.
.... display ?!ΣC 0..1 boolean The preferred device name
... Slices for category 1..* CodeableConcept Indicates a high-level grouping of the device
Slice: Unordered, Open by value:$this
Binding: FHIRDeviceCategory (example): Categories of medical devices.
.... category:imaging 1..1 CodeableConcept Indicates a high-level grouping of the device
Binding: FHIRDeviceCategory (example): Categories of medical devices.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 314789007
...... display 1..1 string Representation defined by the system
Fixed Value: Diagnostic imaging equipment
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... type 0..* CodeableConcept The kind or type of device
Binding: Imaging Device Type (extensible)
... version 0..* BackboneElement The actual design of the device or software version running on the device
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... value 1..1 string The version text

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Device.statusrequiredFHIRDeviceStatus
http://hl7.org/fhir/ValueSet/device-status|5.0.0
From the FHIR Standard
Device.name.typerequiredDeviceNameType
http://hl7.org/fhir/ValueSet/device-nametype|5.0.0
From the FHIR Standard
Device.categoryexampleFHIRDeviceCategory
http://hl7.org/fhir/ValueSet/device-category
From this IG
Device.category:imagingexamplePattern Value: SNOMED-CT Code 314789007("Diagnostic imaging equipment")
http://hl7.org/fhir/ValueSet/device-category
From this IG
Device.typeextensibleImImagingDeviceType
http://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-device-type
From this IG

Constraints

IdGradePath(s)DetailsRequirements
dev-1errorDeviceonly one Device.name.display SHALL be true when there is more than one Device.name
: name.where(display=true).count() <= 1
dom-2errorDeviceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorDeviceIf 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-5errorDeviceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Device

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device Device
... identifier 0..* Identifier Instance identifier
... udiCarrier
.... deviceIdentifier 1..1 string Mandatory fixed portion of UDI
... status 1..1 code active | inactive | entered-in-error
... serialNumber 0..1 string Serial number assigned by the manufacturer
... name 0..* BackboneElement The name or names of the device as known to the manufacturer and/or patient
... Slices for category 1..* CodeableConcept Indicates a high-level grouping of the device
Slice: Unordered, Open by value:$this
.... category:imaging 1..1 CodeableConcept Indicates a high-level grouping of the device
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 314789007
...... display 1..1 string Representation defined by the system
Fixed Value: Diagnostic imaging equipment
... type 0..* CodeableConcept The kind or type of device
Binding: Imaging Device Type (extensible)
... version 0..* BackboneElement The actual design of the device or software version running on the device

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Device.typeextensibleImImagingDeviceType
http://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-device-type
From this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device C 0..* Device Item used in healthcare
Constraints: dev-1
... 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: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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
... displayName 0..1 string The name used to display by default when the device is referenced
... definition 0..1 CodeableReference(DeviceDefinition) The reference to the definition for the device
... udiCarrier Σ 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 Mandatory fixed portion of UDI
.... issuer Σ 1..1 uri UDI Issuing Organization
.... jurisdiction 0..1 uri Regional UDI authority
.... carrierAIDC Σ 0..1 base64Binary UDI Machine Readable Barcode String
.... carrierHRF Σ 0..1 string UDI Human Readable Barcode String
.... entryType 0..1 code barcode | rfid | manual | card | self-reported | electronic-transmission | unknown
Binding: UDIEntryType (required): Codes to identify how UDI data was entered.
... status ?!Σ 1..1 code active | inactive | entered-in-error
Binding: FHIRDeviceStatus (required): The record status of the device.
... availabilityStatus 0..1 CodeableConcept lost | damaged | destroyed | available
Binding: FHIRDeviceAvailabilityStatus (extensible): The availability status reason of the device.
... biologicalSourceEvent 0..1 Identifier An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled
... manufacturer 0..1 string Name of device manufacturer
... manufactureDate 0..1 dateTime Date when the device was made
... expirationDate 0..1 dateTime Date and time of expiry of this device (if applicable)
... lotNumber 0..1 string Lot number of manufacture
... serialNumber 0..1 string Serial number assigned by the manufacturer
... name C 0..* BackboneElement The name or names of the device as known to the manufacturer and/or patient
.... 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
.... value Σ 1..1 string The term that names the device
.... type Σ 1..1 code registered-name | user-friendly-name | patient-reported-name
Binding: DeviceNameType (required): The type of name the device is referred by.
.... display ?!ΣC 0..1 boolean The preferred device name
... modelNumber 0..1 string The manufacturer's model number for the device
... partNumber 0..1 string The part number or catalog number of the device
... Slices for category 1..* CodeableConcept Indicates a high-level grouping of the device
Slice: Unordered, Open by value:$this
Binding: FHIRDeviceCategory (example): Categories of medical devices.
.... category:imaging 1..1 CodeableConcept Indicates a high-level grouping of the device
Binding: FHIRDeviceCategory (example): Categories of medical devices.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 314789007
...... display 1..1 string Representation defined by the system
Fixed Value: Diagnostic imaging equipment
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... type 0..* CodeableConcept The kind or type of device
Binding: Imaging Device Type (extensible)
... version 0..* BackboneElement The actual design of the device or software version running on the device
.... 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 0..1 CodeableConcept The type of the device version, e.g. manufacturer, approved, internal
Binding: DeviceVersionType (example): The type of version indicated for the device.
.... component 0..1 Identifier The hardware or software module of the device to which the version applies
.... installDate 0..1 dateTime The date the version was installed on the device
.... value 1..1 string The version text
... conformsTo 0..* BackboneElement Identifies the standards, specifications, or formal guidances for the capabilities supported by the device
.... 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
.... category 0..1 CodeableConcept Describes the common type of the standard, specification, or formal guidance. communication | performance | measurement
Binding: DeviceSpecificationCategory (example): The kind of standards used by the device.
.... specification 1..1 CodeableConcept Identifies the standard, specification, or formal guidance that the device adheres to
Binding: DeviceSpecificationType (example): The type of version indicated for the device.
.... version 0..1 string Specific form or variant of the standard
... property 0..* BackboneElement Inherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc.
.... 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 being represented
Binding: DeviceType (example): Device property type.
.... value[x] 1..1 Value of the property
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueBoolean boolean
..... valueInteger integer
..... valueRange Range
..... valueAttachment Attachment
... mode 0..1 CodeableConcept The designated condition for performing a task
Binding: FHIRDeviceOperationMode (example): Operational mode of a device.
... cycle 0..1 Count The series of occurrences that repeats during the operation of the device
... duration 0..1 Duration A measurement of time during the device's operation (e.g., days, hours, mins, etc.)
... owner 0..1 Reference(Organization) Organization responsible for device
... contact 0..* ContactPoint Details for human/organization for support
... location 0..1 Reference(Location) Where the device is found
... url 0..1 uri Network address to contact device
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to electronic services provided by the device
... gateway 0..* CodeableReference(Device) Linked device acting as a communication/data collector, translator or controller
... note 0..* Annotation Device notes and comments
... safety Σ 0..* CodeableConcept Safety Characteristics of Device
Binding: DeviceSafety (example)
... parent 0..1 Reference(Device) The higher level or encompassing device that this device is a logical part of

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Device.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
Device.udiCarrier.entryTyperequiredUDIEntryType
http://hl7.org/fhir/ValueSet/udi-entry-type|5.0.0
From the FHIR Standard
Device.statusrequiredFHIRDeviceStatus
http://hl7.org/fhir/ValueSet/device-status|5.0.0
From the FHIR Standard
Device.availabilityStatusextensibleFHIRDeviceAvailabilityStatus
http://hl7.org/fhir/ValueSet/device-availability-status
From the FHIR Standard
Device.name.typerequiredDeviceNameType
http://hl7.org/fhir/ValueSet/device-nametype|5.0.0
From the FHIR Standard
Device.categoryexampleFHIRDeviceCategory
http://hl7.org/fhir/ValueSet/device-category
From this IG
Device.category:imagingexamplePattern Value: SNOMED-CT Code 314789007("Diagnostic imaging equipment")
http://hl7.org/fhir/ValueSet/device-category
From this IG
Device.typeextensibleImImagingDeviceType
http://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-device-type
From this IG
Device.version.typeexampleDeviceVersionType
http://hl7.org/fhir/ValueSet/device-versiontype
From the FHIR Standard
Device.conformsTo.categoryexampleDeviceSpecificationCategory
http://hl7.org/fhir/ValueSet/device-specification-category
From the FHIR Standard
Device.conformsTo.specificationexampleDeviceSpecificationType
http://hl7.org/fhir/ValueSet/device-specification-type
From the FHIR Standard
Device.property.typeexampleDeviceType
http://hl7.org/fhir/ValueSet/device-property-type
From the FHIR Standard
Device.modeexampleFHIRDeviceOperationMode
http://hl7.org/fhir/ValueSet/device-operation-mode
From the FHIR Standard
Device.safetyexampleDeviceSafety
http://hl7.org/fhir/ValueSet/device-safety
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dev-1errorDeviceonly one Device.name.display SHALL be true when there is more than one Device.name
: name.where(display=true).count() <= 1
dom-2errorDeviceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorDeviceIf 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-5errorDeviceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Device

Summary

Mandatory: 3 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Device.category

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron