FHIR Osiris Implementation Guide - Local Development build (v2.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/imaging-device | Version: 2.1.0 | |||
Draft as of 2024-03-21 | Computable Name: ImagingDevice |
Qualification of the equipment used to acquire a series of images
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 | Item used in healthcare | |
![]() ![]() ![]() | S | 1..1 | string | Name of device manufacturer |
![]() ![]() ![]() | S | 1..1 | BackboneElement | Equipment model name |
![]() ![]() ![]() ![]() | S | 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 Required Pattern: manufacturer-name | |
![]() ![]() ![]() | S | 1..1 | BackboneElement | Acquisition software version |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Device | Item used in healthcare | |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
![]() ![]() ![]() | ?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. |
![]() ![]() ![]() | S | 1..1 | string | Name of device manufacturer |
![]() ![]() ![]() | S | 1..1 | BackboneElement | Equipment model name |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | S | 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. Required Pattern: manufacturer-name | |
![]() ![]() ![]() | S | 1..1 | BackboneElement | Acquisition software version |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 1..1 | string | The version text | |
![]() |
Path | Conformance | ValueSet / Code | URI |
Device.status | required | FHIRDeviceStatushttp://hl7.org/fhir/ValueSet/device-status|4.0.1 from the FHIR Standard | |
Device.deviceName.type | required | Pattern: manufacturer-namehttp://hl7.org/fhir/ValueSet/device-nametype|4.0.1 from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | Device | Item used in healthcare | |||||
![]() ![]() ![]() | Σ | 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 | |||||
![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() | 0..* | Identifier | Instance identifier | |||||
![]() ![]() ![]() | C | 0..1 | Reference(DeviceDefinition) | The reference to the definition for the device ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() | Σ | 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() | ?!Σ | 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 | 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 | |||||
![]() ![]() ![]() | S | 1..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 | |||||
![]() ![]() ![]() | S | 1..1 | BackboneElement | Equipment model name | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | S | 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. Required Pattern: manufacturer-name | |||||
![]() ![]() ![]() | 0..1 | string | The model number for the device | |||||
![]() ![]() ![]() | 0..1 | string | The part number of the device | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept | The kind or type of device Binding: DeviceType (example): Codes to identify medical devices. | |||||
![]() ![]() ![]() | 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 | |||||
![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() | ?!Σ | 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 | |||||
![]() ![]() ![]() | S | 1..1 | BackboneElement | Acquisition software version | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() | ?!Σ | 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 | |||||
![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) | |||||
![]() ![]() ![]() ![]() | C | 0..* | Quantity | Property value as a quantity qty-3: If a code for the unit is present, the system SHALL also be present | ||||
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | |||||
![]() ![]() ![]() | C | 0..1 | Reference(Patient) | Patient to whom Device is affixed ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() | C | 0..1 | Reference(Organization) | Organization responsible for device ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() | C | 0..* | ContactPoint | Details for human/organization for support cpt-2: A system is required if a value is provided. | ||||
![]() ![]() ![]() | C | 0..1 | Reference(Location) | Where the device is found ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() | 0..1 | uri | Network address to contact device | |||||
![]() ![]() ![]() | 0..* | Annotation | Device notes and comments | |||||
![]() ![]() ![]() | Σ | 0..* | CodeableConcept | Safety Characteristics of Device | ||||
![]() ![]() ![]() | C | 0..1 | Reference(Device) | The parent device ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Device.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Device.udiCarrier.entryType | required | UDIEntryTypehttp://hl7.org/fhir/ValueSet/udi-entry-type|4.0.1 from the FHIR Standard | ||||
Device.status | required | FHIRDeviceStatushttp://hl7.org/fhir/ValueSet/device-status|4.0.1 from the FHIR Standard | ||||
Device.statusReason | extensible | FHIRDeviceStatusReasonhttp://hl7.org/fhir/ValueSet/device-status-reason from the FHIR Standard | ||||
Device.deviceName.type | required | Pattern: manufacturer-namehttp://hl7.org/fhir/ValueSet/device-nametype|4.0.1 from the FHIR Standard | ||||
Device.type | example | DeviceTypehttp://hl7.org/fhir/ValueSet/device-type from the FHIR Standard |
This structure is derived from Device
Differential View
This structure is derived from Device
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Device | Item used in healthcare | |
![]() ![]() ![]() | S | 1..1 | string | Name of device manufacturer |
![]() ![]() ![]() | S | 1..1 | BackboneElement | Equipment model name |
![]() ![]() ![]() ![]() | S | 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 Required Pattern: manufacturer-name | |
![]() ![]() ![]() | S | 1..1 | BackboneElement | Acquisition software version |
![]() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Device | Item used in healthcare | |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
![]() ![]() ![]() | ?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. |
![]() ![]() ![]() | S | 1..1 | string | Name of device manufacturer |
![]() ![]() ![]() | S | 1..1 | BackboneElement | Equipment model name |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | S | 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. Required Pattern: manufacturer-name | |
![]() ![]() ![]() | S | 1..1 | BackboneElement | Acquisition software version |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 1..1 | string | The version text | |
![]() |
Path | Conformance | ValueSet / Code | URI |
Device.status | required | FHIRDeviceStatushttp://hl7.org/fhir/ValueSet/device-status|4.0.1 from the FHIR Standard | |
Device.deviceName.type | required | Pattern: manufacturer-namehttp://hl7.org/fhir/ValueSet/device-nametype|4.0.1 from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | Device | Item used in healthcare | |||||
![]() ![]() ![]() | Σ | 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 | |||||
![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() | 0..* | Identifier | Instance identifier | |||||
![]() ![]() ![]() | C | 0..1 | Reference(DeviceDefinition) | The reference to the definition for the device ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() | Σ | 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() | ?!Σ | 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 | 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 | |||||
![]() ![]() ![]() | S | 1..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 | |||||
![]() ![]() ![]() | S | 1..1 | BackboneElement | Equipment model name | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | S | 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. Required Pattern: manufacturer-name | |||||
![]() ![]() ![]() | 0..1 | string | The model number for the device | |||||
![]() ![]() ![]() | 0..1 | string | The part number of the device | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept | The kind or type of device Binding: DeviceType (example): Codes to identify medical devices. | |||||
![]() ![]() ![]() | 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 | |||||
![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() | ?!Σ | 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 | |||||
![]() ![]() ![]() | S | 1..1 | BackboneElement | Acquisition software version | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() | ?!Σ | 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 | |||||
![]() ![]() ![]() ![]() | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) | |||||
![]() ![]() ![]() ![]() | C | 0..* | Quantity | Property value as a quantity qty-3: If a code for the unit is present, the system SHALL also be present | ||||
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | |||||
![]() ![]() ![]() | C | 0..1 | Reference(Patient) | Patient to whom Device is affixed ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() | C | 0..1 | Reference(Organization) | Organization responsible for device ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() | C | 0..* | ContactPoint | Details for human/organization for support cpt-2: A system is required if a value is provided. | ||||
![]() ![]() ![]() | C | 0..1 | Reference(Location) | Where the device is found ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() | 0..1 | uri | Network address to contact device | |||||
![]() ![]() ![]() | 0..* | Annotation | Device notes and comments | |||||
![]() ![]() ![]() | Σ | 0..* | CodeableConcept | Safety Characteristics of Device | ||||
![]() ![]() ![]() | C | 0..1 | Reference(Device) | The parent device ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Device.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Device.udiCarrier.entryType | required | UDIEntryTypehttp://hl7.org/fhir/ValueSet/udi-entry-type|4.0.1 from the FHIR Standard | ||||
Device.status | required | FHIRDeviceStatushttp://hl7.org/fhir/ValueSet/device-status|4.0.1 from the FHIR Standard | ||||
Device.statusReason | extensible | FHIRDeviceStatusReasonhttp://hl7.org/fhir/ValueSet/device-status-reason from the FHIR Standard | ||||
Device.deviceName.type | required | Pattern: manufacturer-namehttp://hl7.org/fhir/ValueSet/device-nametype|4.0.1 from the FHIR Standard | ||||
Device.type | example | DeviceTypehttp://hl7.org/fhir/ValueSet/device-type from the FHIR Standard |
This structure is derived from Device
Other representations of profile: CSV, Excel, Schematron