RetinaIntegration
0.5.0 - ci-build

RetinaIntegration - Local Development build (v0.5.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Retina AI Device

Official URL: http://dips.no/fhir/RetinaIntegration/StructureDefinition/retina-ai-device Version: 0.5.0
Draft as of 2025-12-02 Computable Name: RetinaAIDevice

AI device/software system used for automated retina screening analysis.

The AI system that performs grading of the images.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 0..* Device Item used in healthcare
... deviceName 1..1 BackboneElement The name of the device as given by the manufacturer
.... name 1..1 string AI Product Name
.... type 1..1 code Device Name Type: model-name
Binding: DeviceNameType (required): The type of name the device is referred by.
Required Pattern: model-name
... Slices for version 1..* BackboneElement The actual design of the device or software version running on the device
Slice: Unordered, Open by value:type
.... version:All Slices Content/Rules for all slices
..... value 1..1 string The version text
.... version:algorithmVersion 1..1 BackboneElement The actual design of the device or software version running on the device
..... type 1..1 CodeableConcept The type of the device version
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 0..1 uri Identity of the terminology system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: model-number
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... value 1..1 string Algorithm Version
.... version:protocol 0..1 BackboneElement The actual design of the device or software version running on the device
..... type 1..1 CodeableConcept Protocol Type: software
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 0..1 uri Identity of the terminology system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: software
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... value 1..1 string AI Protocol

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Device.deviceName.type Base required DeviceNameType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Device If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Device If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Device If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Device If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Device A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

This structure is derived from Device

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 0..* Device Item used in healthcare
... implicitRules 0..0 A set of rules under which this content was created
... modifierExtension 0..0 Extension
... status 0..0 active | inactive | entered-in-error | unknown
.... modifierExtension 0..0 Extension
.... name 1..1 string AI Product Name
.... type 1..1 code Device Name Type: model-name
Required Pattern: model-name
... Slices for version 1..* BackboneElement The actual design of the device or software version running on the device
Slice: Unordered, Open by value:type
.... version:All Slices Content/Rules for all slices
..... modifierExtension 0..0 Extension
.... version:algorithmVersion 1..1 BackboneElement The actual design of the device or software version running on the device
..... modifierExtension 0..0 Extension
..... type 1..1 CodeableConcept The type of the device version
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: model-number
...... id 0..0 Unique id for inter-element referencing
...... extension 0..0 Extension
...... text 0..0 Plain text representation of the concept
..... value 1..1 string Algorithm Version
.... version:protocol 0..1 BackboneElement The actual design of the device or software version running on the device
..... modifierExtension 0..0 Extension
..... type 1..1 CodeableConcept Protocol Type: software
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: software
...... id 0..0 Unique id for inter-element referencing
...... extension 0..0 Extension
...... text 0..0 Plain text representation of the concept
..... value 1..1 string AI Protocol

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 0..* Device Item used in healthcare
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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
... identifier 0..* Identifier Instance identifier
... 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.
... 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 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
... deviceName 1..1 BackboneElement The name of the device as given by the manufacturer
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... name 1..1 string AI Product Name
.... type 1..1 code Device Name Type: model-name
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 0..1 CodeableConcept The kind or type of device
Binding: DeviceType (example): Codes to identify medical devices.
... 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
... Slices for version 1..* BackboneElement The actual design of the device or software version running on the device
Slice: Unordered, Open by value:type
.... version: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
..... 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
.... version:algorithmVersion 1..1 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
..... type 1..1 CodeableConcept The type of the device version
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 0..1 uri Identity of the terminology system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: model-number
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
..... component 0..1 Identifier A single component of the device version
..... value 1..1 string Algorithm Version
.... version:protocol 0..1 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
..... type 1..1 CodeableConcept Protocol Type: software
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 0..1 uri Identity of the terminology system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: software
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
..... component 0..1 Identifier A single component of the device version
..... value 1..1 string AI Protocol
... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Device.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Device.udiCarrier.entryType Base required UDIEntryType 📍4.0.1 FHIR Std.
Device.statusReason Base extensible FHIRDeviceStatusReason 📍4.0.1 FHIR Std.
Device.deviceName.type Base required DeviceNameType 📍4.0.1 FHIR Std.
Device.type Base example Device Type 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Device If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Device If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Device If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Device If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Device A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Device

Summary

Mandatory: 4 elements(1 nested mandatory element)
Prohibited: 13 elements

Slices

This structure defines the following Slices:

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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 0..* Device Item used in healthcare
... deviceName 1..1 BackboneElement The name of the device as given by the manufacturer
.... name 1..1 string AI Product Name
.... type 1..1 code Device Name Type: model-name
Binding: DeviceNameType (required): The type of name the device is referred by.
Required Pattern: model-name
... Slices for version 1..* BackboneElement The actual design of the device or software version running on the device
Slice: Unordered, Open by value:type
.... version:All Slices Content/Rules for all slices
..... value 1..1 string The version text
.... version:algorithmVersion 1..1 BackboneElement The actual design of the device or software version running on the device
..... type 1..1 CodeableConcept The type of the device version
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 0..1 uri Identity of the terminology system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: model-number
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... value 1..1 string Algorithm Version
.... version:protocol 0..1 BackboneElement The actual design of the device or software version running on the device
..... type 1..1 CodeableConcept Protocol Type: software
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 0..1 uri Identity of the terminology system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: software
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... value 1..1 string AI Protocol

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Device.deviceName.type Base required DeviceNameType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Device If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Device If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Device If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Device If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Device A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

Differential View

This structure is derived from Device

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 0..* Device Item used in healthcare
... implicitRules 0..0 A set of rules under which this content was created
... modifierExtension 0..0 Extension
... status 0..0 active | inactive | entered-in-error | unknown
.... modifierExtension 0..0 Extension
.... name 1..1 string AI Product Name
.... type 1..1 code Device Name Type: model-name
Required Pattern: model-name
... Slices for version 1..* BackboneElement The actual design of the device or software version running on the device
Slice: Unordered, Open by value:type
.... version:All Slices Content/Rules for all slices
..... modifierExtension 0..0 Extension
.... version:algorithmVersion 1..1 BackboneElement The actual design of the device or software version running on the device
..... modifierExtension 0..0 Extension
..... type 1..1 CodeableConcept The type of the device version
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: model-number
...... id 0..0 Unique id for inter-element referencing
...... extension 0..0 Extension
...... text 0..0 Plain text representation of the concept
..... value 1..1 string Algorithm Version
.... version:protocol 0..1 BackboneElement The actual design of the device or software version running on the device
..... modifierExtension 0..0 Extension
..... type 1..1 CodeableConcept Protocol Type: software
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: software
...... id 0..0 Unique id for inter-element referencing
...... extension 0..0 Extension
...... text 0..0 Plain text representation of the concept
..... value 1..1 string AI Protocol

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 0..* Device Item used in healthcare
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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
... identifier 0..* Identifier Instance identifier
... 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.
... 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 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
... deviceName 1..1 BackboneElement The name of the device as given by the manufacturer
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... name 1..1 string AI Product Name
.... type 1..1 code Device Name Type: model-name
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 0..1 CodeableConcept The kind or type of device
Binding: DeviceType (example): Codes to identify medical devices.
... 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
... Slices for version 1..* BackboneElement The actual design of the device or software version running on the device
Slice: Unordered, Open by value:type
.... version: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
..... 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
.... version:algorithmVersion 1..1 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
..... type 1..1 CodeableConcept The type of the device version
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 0..1 uri Identity of the terminology system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: model-number
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
..... component 0..1 Identifier A single component of the device version
..... value 1..1 string Algorithm Version
.... version:protocol 0..1 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
..... type 1..1 CodeableConcept Protocol Type: software
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 0..1 uri Identity of the terminology system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: software
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
..... component 0..1 Identifier A single component of the device version
..... value 1..1 string AI Protocol
... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Device.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Device.udiCarrier.entryType Base required UDIEntryType 📍4.0.1 FHIR Std.
Device.statusReason Base extensible FHIRDeviceStatusReason 📍4.0.1 FHIR Std.
Device.deviceName.type Base required DeviceNameType 📍4.0.1 FHIR Std.
Device.type Base example Device Type 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Device If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Device If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Device If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Device If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Device A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Device

Summary

Mandatory: 4 elements(1 nested mandatory element)
Prohibited: 13 elements

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron