Radiation Dose Summary for Diagnostic Procedures on FHIR
0.1.0 - STU 1 Ballot

Publication Build: This will be filled in by the publication tooling

## Resource Profile: Modality Device

Defining URL: | http://hl7.org/fhir/uv/radiation-dose-summary/StructureDefinition/modality-device
Version: | 0.1.0
Name: | ModalityDevice
Title: | Modality Device
Status: | Draft as of 12/8/21 3:51 PM
Definition: | Modality profiling as a Device resource
Publisher: | HL7 Imaging Integration Working Group
Source Resource: | XML / JSON / Turtle

The official URL for this profile is:

    http://hl7.org/fhir/uv/radiation-dose-summary/StructureDefinition/modality-device

### Formal Views of Profile Content

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

- Text Summary
- Differential Table
- Snapshot Table
- Snapshot Table (Must Support)
- All

This structure is derived from Device

Summary

Mandatory: 5 elements (6 nested mandatory elements)
Must-Support: 9 elements

Slices

This structure defines the following Slices:

- The element Device.identifier is sliced based on the value of pattern:type
- The element Device.deviceName is sliced based on the value of value:type

This structure is derived from Device

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Device |  | 0..* | Device | Item used in healthcare
Slices for identifier |  | 1..* | Identifier | Instance identifier Slice: Unordered, Open by pattern:type
identifier:deviceSerialNumber | S | 0..1 | Identifier | Describes the Device Serial Number, related to tag(0018,1000) Device Serial Number
type |  | 1..1 | CodeableConcept | Description of identifier 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://terminology.hl7.org/CodeSystem/v2-0203
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SNO
display |  | 1..1 | string | Representation defined by the system Fixed Value: Serial Number
value |  | 1..1 | string | The value that is unique
identifier:aeTitle | S | 1..1 | Identifier | Describes the AETitle of the modality irradiating the patient
type |  | 1..1 | CodeableConcept | Description of identifier 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://hl7.org/fhir/uv/radiation-dose-summary/CodeSystem/dicom-identifier-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: application-entity
display |  | 1..1 | string | Representation defined by the system Fixed Value: Application Entity
value |  | 1..1 | string | The value that is unique
identifier:deviceUID | S | 0..1 | Identifier | Describes the Device UID, related to tag(0018,1002) Device UID
type |  | 1..1 | CodeableConcept | Description of identifier 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://hl7.org/fhir/uv/radiation-dose-summary/CodeSystem/dicom-identifier-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: device-uid
display |  | 1..1 | string | Representation defined by the system Fixed Value: Device UID
system |  | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:dicom:uid
value |  | 1..1 | string | The value that is unique
identifier:deviceID | S | 0..1 | Identifier | Describes the Device ID, related to tag((0018,1003) Device ID
type |  | 1..1 | CodeableConcept | Description of identifier 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://hl7.org/fhir/uv/radiation-dose-summary/CodeSystem/dicom-identifier-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: device-id
display |  | 1..1 | string | Representation defined by the system Fixed Value: Device ID
value |  | 1..1 | string | The value that is unique
manufacturer | S | 0..1 | string | The manufacturer of the modality, related to tag(0008,0070) manufacturer
serialNumber | S | 0..1 | string | The serial number of the modality, which is the Device Serial Number
Slices for deviceName |  | 0..* | BackboneElement | The name of the device as given by the manufacturer Slice: Unordered, Open by value:type
deviceName:manufacturer | S | 0..1 | BackboneElement | The manufacturer of the modality
type |  | 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Required Pattern: manufacturer-name
deviceName:manufacturerModelName | S | 0..1 | BackboneElement | The model name of the modality
type |  | 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Required Pattern: model-name
type | S | 1..1 | CodeableConcept | Describes the main modality type (CT, MG, etc.) Binding: Modality (required)
version |  | 0..* | BackboneElement | Describes the Software Versions of the device, related to tag(0018,1020) Software Versions
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Device |  | 0..* | Device | Item used in healthcare
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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
Slices for identifier |  | 1..* | Identifier | Instance identifier Slice: Unordered, Open by pattern:type
identifier:deviceSerialNumber | S | 0..1 | Identifier | Describes the Device Serial Number, related to tag(0018,1000) Device Serial Number
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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://terminology.hl7.org/CodeSystem/v2-0203
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SNO
display |  | 1..1 | string | Representation defined by the system Fixed Value: Serial Number
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:aeTitle | S | 1..1 | Identifier | Describes the AETitle of the modality irradiating the patient
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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://hl7.org/fhir/uv/radiation-dose-summary/CodeSystem/dicom-identifier-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: application-entity
display |  | 1..1 | string | Representation defined by the system Fixed Value: Application Entity
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:deviceUID | S | 0..1 | Identifier | Describes the Device UID, related to tag(0018,1002) Device UID
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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://hl7.org/fhir/uv/radiation-dose-summary/CodeSystem/dicom-identifier-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: device-uid
display |  | 1..1 | string | Representation defined by the system Fixed Value: Device UID
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:dicom:uid
value | Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:deviceID | S | 0..1 | Identifier | Describes the Device ID, related to tag((0018,1003) Device ID
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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://hl7.org/fhir/uv/radiation-dose-summary/CodeSystem/dicom-identifier-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: device-id
display |  | 1..1 | string | Representation defined by the system Fixed Value: Device ID
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
definition |  | 0..1 | Reference(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 | Σ | 0..1 | string | Mandatory fixed portion of UDI
issuer |  | 0..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 + Binding: UDIEntryType (required): Codes to identify how UDI data was entered.
status | ?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device.
statusReason |  | 0..* | CodeableConcept | online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device.
distinctIdentifier |  | 0..1 | string | The distinct identification string
manufacturer | S | 0..1 | string | The manufacturer of the modality, related to tag(0008,0070) 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 | S | 0..1 | string | The serial number of the modality, which is the Device Serial Number
Slices for deviceName |  | 0..* | BackboneElement | The name of the device as given by the manufacturer Slice: Unordered, Open by value:type
deviceName:All Slices |  |  |  | Content/Rules for all slices
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.
deviceName:manufacturer | S | 0..1 | BackboneElement | The manufacturer of the modality
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. Required Pattern: manufacturer-name
deviceName:manufacturerModelName | S | 0..1 | BackboneElement | The model name of the modality
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. Required Pattern: model-name
modelNumber |  | 0..1 | string | The model number for the device
partNumber |  | 0..1 | string | The part number of the device
type | S | 1..1 | CodeableConcept | Describes the main modality type (CT, MG, etc.) Binding: Modality (required)
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 | CodeableConcept | 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..* | BackboneElement | Describes the Software Versions of the device, related to tag(0018,1020) Software Versions
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
component |  | 0..1 | Identifier | A single component of the device version
value |  | 1..1 | string | The version text
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)
patient |  | 0..1 | Reference(Patient) | Patient to whom Device is affixed
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
note |  | 0..* | Annotation | Device notes and comments
safety | Σ | 0..* | CodeableConcept | Safety Characteristics of Device
parent |  | 0..1 | Reference(Device) | The parent device
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Device |  | 0..* | Device | Item used in healthcare
identifier:deviceSerialNumber |  | 0..1 | Identifier | Describes the Device Serial Number, related to tag(0018,1000) Device Serial Number
identifier:aeTitle |  | 1..1 | Identifier | Describes the AETitle of the modality irradiating the patient
identifier:deviceUID |  | 0..1 | Identifier | Describes the Device UID, related to tag(0018,1002) Device UID
identifier:deviceID |  | 0..1 | Identifier | Describes the Device ID, related to tag((0018,1003) Device ID
manufacturer |  | 0..1 | string | The manufacturer of the modality, related to tag(0008,0070) manufacturer
serialNumber |  | 0..1 | string | The serial number of the modality, which is the Device Serial Number
deviceName:manufacturer |  | 0..1 | BackboneElement | The manufacturer of the modality
deviceName:manufacturerModelName |  | 0..1 | BackboneElement | The model name of the modality
type |  | 1..1 | CodeableConcept | Describes the main modality type (CT, MG, etc.) Binding: Modality (required)
Documentation for this format

This structure is derived from Device

Summary

Mandatory: 5 elements (6 nested mandatory elements)
Must-Support: 9 elements

Slices

This structure defines the following Slices:

- The element Device.identifier is sliced based on the value of pattern:type
- The element Device.deviceName is sliced based on the value of value:type

Differential View

This structure is derived from Device

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Device |  | 0..* | Device | Item used in healthcare
Slices for identifier |  | 1..* | Identifier | Instance identifier Slice: Unordered, Open by pattern:type
identifier:deviceSerialNumber | S | 0..1 | Identifier | Describes the Device Serial Number, related to tag(0018,1000) Device Serial Number
type |  | 1..1 | CodeableConcept | Description of identifier 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://terminology.hl7.org/CodeSystem/v2-0203
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SNO
display |  | 1..1 | string | Representation defined by the system Fixed Value: Serial Number
value |  | 1..1 | string | The value that is unique
identifier:aeTitle | S | 1..1 | Identifier | Describes the AETitle of the modality irradiating the patient
type |  | 1..1 | CodeableConcept | Description of identifier 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://hl7.org/fhir/uv/radiation-dose-summary/CodeSystem/dicom-identifier-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: application-entity
display |  | 1..1 | string | Representation defined by the system Fixed Value: Application Entity
value |  | 1..1 | string | The value that is unique
identifier:deviceUID | S | 0..1 | Identifier | Describes the Device UID, related to tag(0018,1002) Device UID
type |  | 1..1 | CodeableConcept | Description of identifier 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://hl7.org/fhir/uv/radiation-dose-summary/CodeSystem/dicom-identifier-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: device-uid
display |  | 1..1 | string | Representation defined by the system Fixed Value: Device UID
system |  | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:dicom:uid
value |  | 1..1 | string | The value that is unique
identifier:deviceID | S | 0..1 | Identifier | Describes the Device ID, related to tag((0018,1003) Device ID
type |  | 1..1 | CodeableConcept | Description of identifier 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://hl7.org/fhir/uv/radiation-dose-summary/CodeSystem/dicom-identifier-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: device-id
display |  | 1..1 | string | Representation defined by the system Fixed Value: Device ID
value |  | 1..1 | string | The value that is unique
manufacturer | S | 0..1 | string | The manufacturer of the modality, related to tag(0008,0070) manufacturer
serialNumber | S | 0..1 | string | The serial number of the modality, which is the Device Serial Number
Slices for deviceName |  | 0..* | BackboneElement | The name of the device as given by the manufacturer Slice: Unordered, Open by value:type
deviceName:manufacturer | S | 0..1 | BackboneElement | The manufacturer of the modality
type |  | 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Required Pattern: manufacturer-name
deviceName:manufacturerModelName | S | 0..1 | BackboneElement | The model name of the modality
type |  | 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Required Pattern: model-name
type | S | 1..1 | CodeableConcept | Describes the main modality type (CT, MG, etc.) Binding: Modality (required)
version |  | 0..* | BackboneElement | Describes the Software Versions of the device, related to tag(0018,1020) Software Versions
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Device |  | 0..* | Device | Item used in healthcare
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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
Slices for identifier |  | 1..* | Identifier | Instance identifier Slice: Unordered, Open by pattern:type
identifier:deviceSerialNumber | S | 0..1 | Identifier | Describes the Device Serial Number, related to tag(0018,1000) Device Serial Number
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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://terminology.hl7.org/CodeSystem/v2-0203
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SNO
display |  | 1..1 | string | Representation defined by the system Fixed Value: Serial Number
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:aeTitle | S | 1..1 | Identifier | Describes the AETitle of the modality irradiating the patient
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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://hl7.org/fhir/uv/radiation-dose-summary/CodeSystem/dicom-identifier-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: application-entity
display |  | 1..1 | string | Representation defined by the system Fixed Value: Application Entity
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:deviceUID | S | 0..1 | Identifier | Describes the Device UID, related to tag(0018,1002) Device UID
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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://hl7.org/fhir/uv/radiation-dose-summary/CodeSystem/dicom-identifier-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: device-uid
display |  | 1..1 | string | Representation defined by the system Fixed Value: Device UID
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:dicom:uid
value | Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:deviceID | S | 0..1 | Identifier | Describes the Device ID, related to tag((0018,1003) Device ID
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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://hl7.org/fhir/uv/radiation-dose-summary/CodeSystem/dicom-identifier-type
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: device-id
display |  | 1..1 | string | Representation defined by the system Fixed Value: Device ID
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
definition |  | 0..1 | Reference(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 | Σ | 0..1 | string | Mandatory fixed portion of UDI
issuer |  | 0..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 + Binding: UDIEntryType (required): Codes to identify how UDI data was entered.
status | ?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device.
statusReason |  | 0..* | CodeableConcept | online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device.
distinctIdentifier |  | 0..1 | string | The distinct identification string
manufacturer | S | 0..1 | string | The manufacturer of the modality, related to tag(0008,0070) 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 | S | 0..1 | string | The serial number of the modality, which is the Device Serial Number
Slices for deviceName |  | 0..* | BackboneElement | The name of the device as given by the manufacturer Slice: Unordered, Open by value:type
deviceName:All Slices |  |  |  | Content/Rules for all slices
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.
deviceName:manufacturer | S | 0..1 | BackboneElement | The manufacturer of the modality
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. Required Pattern: manufacturer-name
deviceName:manufacturerModelName | S | 0..1 | BackboneElement | The model name of the modality
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. Required Pattern: model-name
modelNumber |  | 0..1 | string | The model number for the device
partNumber |  | 0..1 | string | The part number of the device
type | S | 1..1 | CodeableConcept | Describes the main modality type (CT, MG, etc.) Binding: Modality (required)
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 | CodeableConcept | 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..* | BackboneElement | Describes the Software Versions of the device, related to tag(0018,1020) Software Versions
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
component |  | 0..1 | Identifier | A single component of the device version
value |  | 1..1 | string | The version text
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)
patient |  | 0..1 | Reference(Patient) | Patient to whom Device is affixed
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
note |  | 0..* | Annotation | Device notes and comments
safety | Σ | 0..* | CodeableConcept | Safety Characteristics of Device
parent |  | 0..1 | Reference(Device) | The parent device
Documentation for this format

Other representations of profile: CSV, Excel, Schematron

#### Terminology Bindings

Path | Conformance | ValueSet / Code
Device.language | preferred | CommonLanguages Max Binding: AllLanguages
Device.identifier:deviceSerialNumber.use | required | IdentifierUse
Device.identifier:deviceSerialNumber.type | extensible | Pattern: SNO("Serial Number")
Device.identifier:aeTitle.use | required | IdentifierUse
Device.identifier:aeTitle.type | extensible | Pattern: application-entity("Application Entity")
Device.identifier:deviceUID.use | required | IdentifierUse
Device.identifier:deviceUID.type | extensible | Pattern: device-uid("Device UID")
Device.identifier:deviceID.use | required | IdentifierUse
Device.identifier:deviceID.type | extensible | Pattern: device-id("Device ID")
Device.udiCarrier.entryType | required | UDIEntryType
Device.status | required | FHIRDeviceStatus
Device.statusReason | extensible | FHIRDeviceStatusReason
Device.deviceName.type | required | DeviceNameType
Device.deviceName:manufacturer.type | required | Pattern: manufacturer-name
Device.deviceName:manufacturerModelName.type | required | Pattern: model-name
Device.type | required | Modality