Magentus Practice Management FHIR® Implementation Guide
1.3.2 - Release
Australia
This page is part of the Magentus Practice Management FHIR Implementation Guide (v1.3.2: Releases Draft) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions
| Official URL: http://fhir.geniesolutions.io/StructureDefinition/ebookings-prosthesis | Version: 1.3.2 | ||||
| Active as of 2026-10-02 | Computable Name: EBookingsProsthesis | ||||
A prosthesis or implant to be used in the booked procedure, so the hospital can have it available in theatre. Carries the device name and type, and patient identifies the patient. patient does not identify the booking, because one patient can have several bookings. The booking reaches the device through the prosthesis slice of Appointment.supportingInformation, or by containing it in the Appointment. serialNumber is prohibited — at booking time the device is identified by what is needed, not by a specific manufactured unit.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Device | Item used in healthcare | |
![]() ![]() |
SΣ | 0..1 | id | Logical id of this artifact |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. |
![]() ![]() |
S | 1..1 | BackboneElement | The name of the device as given by the manufacturer |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
1..1 | string | Name of device | |
![]() ![]() ![]() |
1..1 | code | Fixed: user-friendly-name Binding: DeviceNameType (required): The type of name the device is referred by. Required Pattern: user-friendly-name | |
![]() ![]() |
S | 1..1 | CodeableConcept | The kind or type of device Binding: DeviceType (example): Codes to identify medical devices. Required Pattern: At least the following |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 53350007 | |
![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Prosthesis | |
![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() |
S | 1..1 | Reference(EBookings Patient) | Patient to whom device is affixed |
![]() ![]() ![]() |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() |
S | 0..1 | Annotation | Prosthesis notes including serial number |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Device.status | Base | required | FHIRDeviceStatus | 📍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. |
| 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()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
Device | |||
![]() ![]() |
S | 0..1 | id | Logical id of this artifact |
![]() ![]() |
0..0 | Serial number assigned by the manufacturer | ||
![]() ![]() |
S | 1..1 | BackboneElement | The name of the device as given by the manufacturer |
![]() ![]() ![]() |
1..1 | string | Name of device | |
![]() ![]() ![]() |
1..1 | code | Fixed: user-friendly-name Required Pattern: user-friendly-name | |
![]() ![]() |
S | 1..1 | CodeableConcept | The kind or type of device Required Pattern: At least the following |
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 53350007 | |
![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Prosthesis | |
![]() ![]() |
S | 1..1 | Reference(EBookings Patient) | Patient to whom device is affixed |
![]() ![]() ![]() |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
![]() ![]() |
S | 0..1 | Annotation | Prosthesis notes including serial number |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Device | Item used in healthcare | |||||
![]() ![]() |
SΣ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation 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 | |||||
![]() ![]() |
0..1 | Reference(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 | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Mandatory fixed portion of UDI | ||||
![]() ![]() ![]() |
0..1 | uri | UDI Issuing Organization | |||||
![]() ![]() ![]() |
0..1 | uri | Regional UDI authority | |||||
![]() ![]() ![]() |
Σ | 0..1 | base64Binary | UDI Machine Readable Barcode String | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | UDI Human Readable Barcode String | ||||
![]() ![]() ![]() |
0..1 | code | barcode | rfid | manual + Binding: UDIEntryType (required): Codes to identify how UDI data was entered. | |||||
![]() ![]() |
?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. | ||||
![]() ![]() |
0..* | CodeableConcept | online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device. | |||||
![]() ![]() |
0..1 | string | The distinct identification string | |||||
![]() ![]() |
0..1 | string | Name of device manufacturer | |||||
![]() ![]() |
0..1 | dateTime | Date when the device was made | |||||
![]() ![]() |
0..1 | dateTime | Date and time of expiry of this device (if applicable) | |||||
![]() ![]() |
0..1 | string | Lot number of manufacture | |||||
![]() ![]() |
S | 1..1 | BackboneElement | The name of the device as given by the manufacturer | ||||
![]() ![]() ![]() |
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 | Name of device | |||||
![]() ![]() ![]() |
1..1 | code | Fixed: user-friendly-name Binding: DeviceNameType (required): The type of name the device is referred by. Required Pattern: user-friendly-name | |||||
![]() ![]() |
0..1 | string | The model number for the device | |||||
![]() ![]() |
0..1 | string | The part number of the device | |||||
![]() ![]() |
S | 1..1 | CodeableConcept | The kind or type of device Binding: DeviceType (example): Codes to identify medical devices. Required Pattern: At least the following | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 53350007 | |||||
![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Prosthesis | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() |
0..* | BackboneElement | The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | CodeableConcept | The standard that is used to operate and communicate | |||||
![]() ![]() ![]() |
0..1 | string | The version of the standard that is used to operate and communicate | |||||
![]() ![]() |
0..* | BackboneElement | The actual design of the device or software version running on 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 | The type of the device version | |||||
![]() ![]() ![]() |
0..1 | Identifier | A single component of the device version | |||||
![]() ![]() ![]() |
1..1 | string | The version text | |||||
![]() ![]() |
0..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
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 DeviceDefinitionPropetyCode (Extensible) | |||||
![]() ![]() ![]() |
0..* | Quantity | Property value as a quantity | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | |||||
![]() ![]() |
S | 1..1 | Reference(EBookings Patient) | Patient to whom device is affixed | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
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 | |||||
![]() ![]() |
S | 0..1 | Annotation | Prosthesis notes including serial number | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Safety Characteristics of Device | ||||
![]() ![]() |
0..1 | Reference(Device) | The parent device | |||||
Documentation for this format | ||||||||
| 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.status | Base | required | FHIRDeviceStatus | 📍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. |
| Device.patient.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| 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()
|
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Device | Item used in healthcare | |
![]() ![]() |
SΣ | 0..1 | id | Logical id of this artifact |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. |
![]() ![]() |
S | 1..1 | BackboneElement | The name of the device as given by the manufacturer |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
1..1 | string | Name of device | |
![]() ![]() ![]() |
1..1 | code | Fixed: user-friendly-name Binding: DeviceNameType (required): The type of name the device is referred by. Required Pattern: user-friendly-name | |
![]() ![]() |
S | 1..1 | CodeableConcept | The kind or type of device Binding: DeviceType (example): Codes to identify medical devices. Required Pattern: At least the following |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 53350007 | |
![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Prosthesis | |
![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() |
S | 1..1 | Reference(EBookings Patient) | Patient to whom device is affixed |
![]() ![]() ![]() |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() |
S | 0..1 | Annotation | Prosthesis notes including serial number |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Device.status | Base | required | FHIRDeviceStatus | 📍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. |
| 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()
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
Device | |||
![]() ![]() |
S | 0..1 | id | Logical id of this artifact |
![]() ![]() |
0..0 | Serial number assigned by the manufacturer | ||
![]() ![]() |
S | 1..1 | BackboneElement | The name of the device as given by the manufacturer |
![]() ![]() ![]() |
1..1 | string | Name of device | |
![]() ![]() ![]() |
1..1 | code | Fixed: user-friendly-name Required Pattern: user-friendly-name | |
![]() ![]() |
S | 1..1 | CodeableConcept | The kind or type of device Required Pattern: At least the following |
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 53350007 | |
![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Prosthesis | |
![]() ![]() |
S | 1..1 | Reference(EBookings Patient) | Patient to whom device is affixed |
![]() ![]() ![]() |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
![]() ![]() |
S | 0..1 | Annotation | Prosthesis notes including serial number |
Documentation for this format | ||||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Device | Item used in healthcare | |||||
![]() ![]() |
SΣ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation 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 | |||||
![]() ![]() |
0..1 | Reference(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 | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Mandatory fixed portion of UDI | ||||
![]() ![]() ![]() |
0..1 | uri | UDI Issuing Organization | |||||
![]() ![]() ![]() |
0..1 | uri | Regional UDI authority | |||||
![]() ![]() ![]() |
Σ | 0..1 | base64Binary | UDI Machine Readable Barcode String | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | UDI Human Readable Barcode String | ||||
![]() ![]() ![]() |
0..1 | code | barcode | rfid | manual + Binding: UDIEntryType (required): Codes to identify how UDI data was entered. | |||||
![]() ![]() |
?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. | ||||
![]() ![]() |
0..* | CodeableConcept | online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device. | |||||
![]() ![]() |
0..1 | string | The distinct identification string | |||||
![]() ![]() |
0..1 | string | Name of device manufacturer | |||||
![]() ![]() |
0..1 | dateTime | Date when the device was made | |||||
![]() ![]() |
0..1 | dateTime | Date and time of expiry of this device (if applicable) | |||||
![]() ![]() |
0..1 | string | Lot number of manufacture | |||||
![]() ![]() |
S | 1..1 | BackboneElement | The name of the device as given by the manufacturer | ||||
![]() ![]() ![]() |
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 | Name of device | |||||
![]() ![]() ![]() |
1..1 | code | Fixed: user-friendly-name Binding: DeviceNameType (required): The type of name the device is referred by. Required Pattern: user-friendly-name | |||||
![]() ![]() |
0..1 | string | The model number for the device | |||||
![]() ![]() |
0..1 | string | The part number of the device | |||||
![]() ![]() |
S | 1..1 | CodeableConcept | The kind or type of device Binding: DeviceType (example): Codes to identify medical devices. Required Pattern: At least the following | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 53350007 | |||||
![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Prosthesis | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() |
0..* | BackboneElement | The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | CodeableConcept | The standard that is used to operate and communicate | |||||
![]() ![]() ![]() |
0..1 | string | The version of the standard that is used to operate and communicate | |||||
![]() ![]() |
0..* | BackboneElement | The actual design of the device or software version running on 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 | The type of the device version | |||||
![]() ![]() ![]() |
0..1 | Identifier | A single component of the device version | |||||
![]() ![]() ![]() |
1..1 | string | The version text | |||||
![]() ![]() |
0..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
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 DeviceDefinitionPropetyCode (Extensible) | |||||
![]() ![]() ![]() |
0..* | Quantity | Property value as a quantity | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | |||||
![]() ![]() |
S | 1..1 | Reference(EBookings Patient) | Patient to whom device is affixed | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
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 | |||||
![]() ![]() |
S | 0..1 | Annotation | Prosthesis notes including serial number | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Safety Characteristics of Device | ||||
![]() ![]() |
0..1 | Reference(Device) | The parent device | |||||
Documentation for this format | ||||||||
| 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.status | Base | required | FHIRDeviceStatus | 📍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. |
| Device.patient.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| 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()
|
Other representations of profile: CSV, Excel, Schematron