Orthovision AI FHIR Implementation Guide
0.2.0 - ci-build
Orthovision AI FHIR Implementation Guide - Local Development build (v0.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://medoco.health/fhir/StructureDefinition/orthovision-ai-model | Version: 0.2.0 | |||
| Active as of 2025-10-29 | Computable Name: OrthovisionAIModel | |||
This profile represents an AI model used by the Orthovision service for DICOM image classification.
The OrthovisionAIModel profile provides a comprehensive framework for describing AI systems used in medical image classification. This guidance helps implementers properly document their AI models to ensure transparency and traceability.
The AI model Device resource integrates with the Task workflow:
requestedPerformer if knownperformerDevice extension when processing beginsThis ensures full traceability from classification request through AI processing to final results.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Device | Item used in healthcare Constraints: dev-1 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
S | 1..1 | string | AI model/system display name |
![]() ![]() |
?!SΣ | 1..1 | code | Operational status Binding: FHIRDeviceStatus (required): The record status of the device. |
![]() ![]() |
S | 1..1 | string | AI system developer/vendor |
![]() ![]() |
SC | 1..* | BackboneElement | AI model/system name |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
Σ | 1..1 | string | The term that names the device |
![]() ![]() ![]() |
Σ | 1..1 | code | registered-name | user-friendly-name | patient-reported-name Binding: DeviceNameType (required): The type of name the device is referred by. |
![]() ![]() ![]() |
?!ΣC | 0..1 | boolean | The preferred device name |
![]() ![]() |
S | 0..1 | string | AI model identifier |
![]() ![]() |
S | 0..* | BackboneElement | Software versions |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
1..1 | string | The version text | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Device.status | Base | required | FHIR Device Status | 📍5.0.0 | FHIR Std. |
| Device.name.type | Base | required | Device Name Type | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dev-1 | error | Device | only one Device.name.display SHALL be true when there is more than one Device.name |
name.where(display=true).count() <= 1
|
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Device | Item used in healthcare | |
![]() ![]() |
S | 1..1 | string | AI model/system display name |
![]() ![]() |
S | 1..1 | code | Operational status |
![]() ![]() |
S | 1..1 | string | AI system developer/vendor |
![]() ![]() |
S | 1..* | BackboneElement | AI model/system name |
![]() ![]() |
S | 0..1 | string | AI model identifier |
![]() ![]() |
S | 0..* | BackboneElement | Software versions |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Device | Item used in healthcare Constraints: dev-1 | ||||
![]() ![]() |
Σ | 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: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
0..* | Identifier | Instance identifier | |||||
![]() ![]() |
S | 1..1 | string | AI model/system display name | ||||
![]() ![]() |
0..1 | CodeableReference(DeviceDefinition) | The reference to the definition for the device | |||||
![]() ![]() |
Σ | 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | Mandatory fixed portion of UDI | ||||
![]() ![]() ![]() |
Σ | 1..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 | card | self-reported | electronic-transmission | unknown Binding: UDIEntryType (required): Codes to identify how UDI data was entered. | |||||
![]() ![]() |
?!SΣ | 1..1 | code | Operational status Binding: FHIRDeviceStatus (required): The record status of the device. | ||||
![]() ![]() |
0..1 | CodeableConcept | lost | damaged | destroyed | available Binding: FHIRDeviceAvailabilityStatus (extensible): The availability status reason of the device. | |||||
![]() ![]() |
0..1 | Identifier | An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled | |||||
![]() ![]() |
S | 1..1 | string | AI system developer/vendor | ||||
![]() ![]() |
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 | |||||
![]() ![]() |
SC | 1..* | BackboneElement | AI model/system name | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | The term that names the device | ||||
![]() ![]() ![]() |
Σ | 1..1 | code | registered-name | user-friendly-name | patient-reported-name Binding: DeviceNameType (required): The type of name the device is referred by. | ||||
![]() ![]() ![]() |
?!ΣC | 0..1 | boolean | The preferred device name | ||||
![]() ![]() |
S | 0..1 | string | AI model identifier | ||||
![]() ![]() |
0..1 | string | The part number or catalog number of the device | |||||
![]() ![]() |
0..* | CodeableConcept | Indicates a high-level grouping of the device Binding: FHIRDeviceCategory (example): Categories of medical devices. | |||||
![]() ![]() |
0..* | CodeableConcept | The kind or type of device Binding: DeviceType (example): Codes to identify medical devices. | |||||
![]() ![]() |
S | 0..* | BackboneElement | Software versions | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The type of the device version, e.g. manufacturer, approved, internal Binding: DeviceVersionType (example): The type of version indicated for the device. | |||||
![]() ![]() ![]() |
0..1 | Identifier | The hardware or software module of the device to which the version applies | |||||
![]() ![]() ![]() |
0..1 | dateTime | The date the version was installed on the device | |||||
![]() ![]() ![]() |
1..1 | string | The version text | |||||
![]() ![]() |
0..* | BackboneElement | Identifies the standards, specifications, or formal guidances for the capabilities supported by the device | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Describes the common type of the standard, specification, or formal guidance. communication | performance | measurement Binding: DeviceSpecificationCategory (example): The kind of standards used by the device. | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Identifies the standard, specification, or formal guidance that the device adheres to Binding: DeviceSpecificationType (example): The type of version indicated for the device. | |||||
![]() ![]() ![]() |
0..1 | string | Specific form or variant of the standard | |||||
![]() ![]() |
0..* | BackboneElement | Inherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc. | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Code that specifies the property being represented Binding: DeviceType (example): Device property type. | |||||
![]() ![]() ![]() |
1..1 | Value of the property | ||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() |
0..1 | CodeableConcept | The designated condition for performing a task Binding: FHIRDeviceOperationMode (example): Operational mode of a device. | |||||
![]() ![]() |
0..1 | Count | The series of occurrences that repeats during the operation of the device | |||||
![]() ![]() |
0..1 | Duration | A measurement of time during the device's operation (e.g., days, hours, mins, etc.) | |||||
![]() ![]() |
0..1 | Reference(Organization) | Organization responsible for device | |||||
![]() ![]() |
0..* | ContactPoint | Details for human/organization for support | |||||
![]() ![]() |
0..1 | Reference(Location) | Where the device is found | |||||
![]() ![]() |
0..1 | uri | Network address to contact device | |||||
![]() ![]() |
0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services provided by the device | |||||
![]() ![]() |
0..* | CodeableReference(Device) | Linked device acting as a communication/data collector, translator or controller | |||||
![]() ![]() |
0..* | Annotation | Device notes and comments | |||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Safety Characteristics of Device Binding: DeviceSafety (example) | ||||
![]() ![]() |
0..1 | Reference(Device) | The higher level or encompassing device that this device is a logical part of | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Device.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Device.udiCarrier.entryType | Base | required | UDI Entry Type | 📍5.0.0 | FHIR Std. |
| Device.status | Base | required | FHIR Device Status | 📍5.0.0 | FHIR Std. |
| Device.availabilityStatus | Base | extensible | FHIR Device Availability Status | 📍5.0.0 | FHIR Std. |
| Device.name.type | Base | required | Device Name Type | 📍5.0.0 | FHIR Std. |
| Device.category | Base | example | FHIR Device Category | 📍5.0.0 | FHIR Std. |
| Device.type | Base | example | Device Type | 📍5.0.0 | FHIR Std. |
| Device.version.type | Base | example | Device Version Type | 📍5.0.0 | FHIR Std. |
| Device.conformsTo.category | Base | example | Device Specification Category | 📍5.0.0 | FHIR Std. |
| Device.conformsTo.specification | Base | example | Device Specification Type | 📍5.0.0 | FHIR Std. |
| Device.property.type | Base | example | Device Property Type | 📍5.0.0 | FHIR Std. |
| Device.mode | Base | example | FHIR Device Operation Mode | 📍5.0.0 | FHIR Std. |
| Device.safety | Base | example | Device Safety | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dev-1 | error | Device | only one Device.name.display SHALL be true when there is more than one Device.name |
name.where(display=true).count() <= 1
|
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-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
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Device | Item used in healthcare Constraints: dev-1 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
S | 1..1 | string | AI model/system display name |
![]() ![]() |
?!SΣ | 1..1 | code | Operational status Binding: FHIRDeviceStatus (required): The record status of the device. |
![]() ![]() |
S | 1..1 | string | AI system developer/vendor |
![]() ![]() |
SC | 1..* | BackboneElement | AI model/system name |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
Σ | 1..1 | string | The term that names the device |
![]() ![]() ![]() |
Σ | 1..1 | code | registered-name | user-friendly-name | patient-reported-name Binding: DeviceNameType (required): The type of name the device is referred by. |
![]() ![]() ![]() |
?!ΣC | 0..1 | boolean | The preferred device name |
![]() ![]() |
S | 0..1 | string | AI model identifier |
![]() ![]() |
S | 0..* | BackboneElement | Software versions |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
1..1 | string | The version text | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Device.status | Base | required | FHIR Device Status | 📍5.0.0 | FHIR Std. |
| Device.name.type | Base | required | Device Name Type | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dev-1 | error | Device | only one Device.name.display SHALL be true when there is more than one Device.name |
name.where(display=true).count() <= 1
|
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-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()
|
Differential View
This structure is derived from Device
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Device | Item used in healthcare | |
![]() ![]() |
S | 1..1 | string | AI model/system display name |
![]() ![]() |
S | 1..1 | code | Operational status |
![]() ![]() |
S | 1..1 | string | AI system developer/vendor |
![]() ![]() |
S | 1..* | BackboneElement | AI model/system name |
![]() ![]() |
S | 0..1 | string | AI model identifier |
![]() ![]() |
S | 0..* | BackboneElement | Software versions |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Device | Item used in healthcare Constraints: dev-1 | ||||
![]() ![]() |
Σ | 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: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
0..* | Identifier | Instance identifier | |||||
![]() ![]() |
S | 1..1 | string | AI model/system display name | ||||
![]() ![]() |
0..1 | CodeableReference(DeviceDefinition) | The reference to the definition for the device | |||||
![]() ![]() |
Σ | 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | Mandatory fixed portion of UDI | ||||
![]() ![]() ![]() |
Σ | 1..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 | card | self-reported | electronic-transmission | unknown Binding: UDIEntryType (required): Codes to identify how UDI data was entered. | |||||
![]() ![]() |
?!SΣ | 1..1 | code | Operational status Binding: FHIRDeviceStatus (required): The record status of the device. | ||||
![]() ![]() |
0..1 | CodeableConcept | lost | damaged | destroyed | available Binding: FHIRDeviceAvailabilityStatus (extensible): The availability status reason of the device. | |||||
![]() ![]() |
0..1 | Identifier | An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled | |||||
![]() ![]() |
S | 1..1 | string | AI system developer/vendor | ||||
![]() ![]() |
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 | |||||
![]() ![]() |
SC | 1..* | BackboneElement | AI model/system name | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | The term that names the device | ||||
![]() ![]() ![]() |
Σ | 1..1 | code | registered-name | user-friendly-name | patient-reported-name Binding: DeviceNameType (required): The type of name the device is referred by. | ||||
![]() ![]() ![]() |
?!ΣC | 0..1 | boolean | The preferred device name | ||||
![]() ![]() |
S | 0..1 | string | AI model identifier | ||||
![]() ![]() |
0..1 | string | The part number or catalog number of the device | |||||
![]() ![]() |
0..* | CodeableConcept | Indicates a high-level grouping of the device Binding: FHIRDeviceCategory (example): Categories of medical devices. | |||||
![]() ![]() |
0..* | CodeableConcept | The kind or type of device Binding: DeviceType (example): Codes to identify medical devices. | |||||
![]() ![]() |
S | 0..* | BackboneElement | Software versions | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The type of the device version, e.g. manufacturer, approved, internal Binding: DeviceVersionType (example): The type of version indicated for the device. | |||||
![]() ![]() ![]() |
0..1 | Identifier | The hardware or software module of the device to which the version applies | |||||
![]() ![]() ![]() |
0..1 | dateTime | The date the version was installed on the device | |||||
![]() ![]() ![]() |
1..1 | string | The version text | |||||
![]() ![]() |
0..* | BackboneElement | Identifies the standards, specifications, or formal guidances for the capabilities supported by the device | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Describes the common type of the standard, specification, or formal guidance. communication | performance | measurement Binding: DeviceSpecificationCategory (example): The kind of standards used by the device. | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Identifies the standard, specification, or formal guidance that the device adheres to Binding: DeviceSpecificationType (example): The type of version indicated for the device. | |||||
![]() ![]() ![]() |
0..1 | string | Specific form or variant of the standard | |||||
![]() ![]() |
0..* | BackboneElement | Inherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc. | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Code that specifies the property being represented Binding: DeviceType (example): Device property type. | |||||
![]() ![]() ![]() |
1..1 | Value of the property | ||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() |
0..1 | CodeableConcept | The designated condition for performing a task Binding: FHIRDeviceOperationMode (example): Operational mode of a device. | |||||
![]() ![]() |
0..1 | Count | The series of occurrences that repeats during the operation of the device | |||||
![]() ![]() |
0..1 | Duration | A measurement of time during the device's operation (e.g., days, hours, mins, etc.) | |||||
![]() ![]() |
0..1 | Reference(Organization) | Organization responsible for device | |||||
![]() ![]() |
0..* | ContactPoint | Details for human/organization for support | |||||
![]() ![]() |
0..1 | Reference(Location) | Where the device is found | |||||
![]() ![]() |
0..1 | uri | Network address to contact device | |||||
![]() ![]() |
0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services provided by the device | |||||
![]() ![]() |
0..* | CodeableReference(Device) | Linked device acting as a communication/data collector, translator or controller | |||||
![]() ![]() |
0..* | Annotation | Device notes and comments | |||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Safety Characteristics of Device Binding: DeviceSafety (example) | ||||
![]() ![]() |
0..1 | Reference(Device) | The higher level or encompassing device that this device is a logical part of | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Device.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Device.udiCarrier.entryType | Base | required | UDI Entry Type | 📍5.0.0 | FHIR Std. |
| Device.status | Base | required | FHIR Device Status | 📍5.0.0 | FHIR Std. |
| Device.availabilityStatus | Base | extensible | FHIR Device Availability Status | 📍5.0.0 | FHIR Std. |
| Device.name.type | Base | required | Device Name Type | 📍5.0.0 | FHIR Std. |
| Device.category | Base | example | FHIR Device Category | 📍5.0.0 | FHIR Std. |
| Device.type | Base | example | Device Type | 📍5.0.0 | FHIR Std. |
| Device.version.type | Base | example | Device Version Type | 📍5.0.0 | FHIR Std. |
| Device.conformsTo.category | Base | example | Device Specification Category | 📍5.0.0 | FHIR Std. |
| Device.conformsTo.specification | Base | example | Device Specification Type | 📍5.0.0 | FHIR Std. |
| Device.property.type | Base | example | Device Property Type | 📍5.0.0 | FHIR Std. |
| Device.mode | Base | example | FHIR Device Operation Mode | 📍5.0.0 | FHIR Std. |
| Device.safety | Base | example | Device Safety | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dev-1 | error | Device | only one Device.name.display SHALL be true when there is more than one Device.name |
name.where(display=true).count() <= 1
|
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-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
Other representations of profile: CSV, Excel, Schematron