- This is an Implementation Guide for UK Core FHIR Assets in Development.
- There will be disruption as the content will be updated on an ad-hoc basis and with links not working.
- Therefore this Implementation Guide must not be implemented.
- Please follow the guidance on the "Contact Us" page if you need any assistance.
StructureDefinition-UKCore-Device
Canonical_URL | Status | Current_Version | Last_Updated | Description |
---|---|---|---|---|
https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device | draft | 1.2.0 | 2023-12-12 | This profile defines the UK constraints and extensions on the International FHIR resource Device. |
Profile_Purpose |
---|
The purpose of this profile is to hold information about a type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. It is referenced by other resources for recording which device performed an action such as a procedure or an observation, referenced when prescribing and dispensing devices for patient use or for ordering supplies, and used to record and transmit Unique Device Identifier (UDI) information about a device such as a patient's implant. |
Detailed Descriptions
Device | |
Definition | A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Device.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | System.String |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Device.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
Device.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Mappings |
|
Device.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. CommonLanguages (preferred) |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Mappings |
|
Device.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
Device.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
Device.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Device.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Device.identifier | |
Definition | Unique instance identifiers assigned to a device by manufacturers other organizations or owners. |
Cardinality | 0...* |
Type | Identifier |
Comments | The barcode string from a barcode present on a device label or package may identify the instance, include names given to the device in local usage, or may identify the type of device. If the identifier identifies the type of device, Device.type element should be used. |
Invariants |
|
Mappings |
|
Device.definition | |
Definition | The reference to the definition for the device. |
Cardinality | 0...1 |
Type | Reference(DeviceDefinition) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Device.udiCarrier | |
Definition | Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold. |
Cardinality | 0...* |
Type | BackboneElement |
Summary | True |
Comments | UDI may identify an unique instance of a device, or it may only identify the type of the device. See UDI mappings for a complete mapping of UDI parts to Device. |
Invariants |
|
Mappings |
|
Device.udiCarrier.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | System.String |
Mappings |
|
Device.udiCarrier.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Device.udiCarrier.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Device.udiCarrier.deviceIdentifier | |
Definition | The device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | DI |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Device.udiCarrier.issuer | |
Definition | Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include : 1) GS1: http://hl7.org/fhir/NamingSystem/gs1-di, 2) HIBCC: http://hl7.org/fhir/NamingSystem/hibcc-dI, 3) ICCBBA for blood containers: http://hl7.org/fhir/NamingSystem/iccbba-blood-di, 4) ICCBA for other devices: http://hl7.org/fhir/NamingSystem/iccbba-other-di. |
Cardinality | 0...1 |
Type | uri |
Alias | Barcode System |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Device.udiCarrier.jurisdiction | |
Definition | The identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/fda-udi. |
Cardinality | 0...1 |
Type | uri |
Requirements | Allows a recipient of a UDI to know which database will contain the UDI-associated metadata. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Device.udiCarrier.carrierAIDC | |
Definition | The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - e.g., a barcode or RFID. Because of limitations on character sets in XML and the need to round-trip JSON data through XML, AIDC Formats *SHALL* be base64 encoded. |
Cardinality | 0...1 |
Type | base64Binary |
Summary | True |
Alias | Automatic Identification and Data Capture |
Comments | The AIDC form of UDIs should be scanned or otherwise used for the identification of the device whenever possible to minimize errors in records resulting from manual transcriptions. If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label. |
Invariants |
|
Mappings |
|
Device.udiCarrier.carrierHRF | |
Definition | The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | Human Readable Form |
Comments | If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label. |
Invariants |
|
Mappings |
|
Device.udiCarrier.entryType | |
Definition | A coded entry to indicate how the data was entered. |
Cardinality | 0...1 |
Type | code |
Binding | Codes to identify how UDI data was entered. UDIEntryType (required) |
Requirements | Supports a way to distinguish hand entered from machine read data. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Device.status | |
Definition | Status of the Device availability. |
Cardinality | 0...1 |
Type | code |
Binding | The availability status of the device. FHIRDeviceStatus (required) |
Must Support | True |
Modifier | True |
Summary | True |
Comments | This element is labeled as a modifier because the status contains the codes inactive and entered-in-error that mark the device (record)as not currently valid. |
Invariants |
|
Mappings |
|
Device.statusReason | |
Definition | Reason for the dtatus of the Device availability. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The availability status reason of the device. FHIRDeviceStatusReason (extensible) |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Device.distinctIdentifier | |
Definition | The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product. |
Cardinality | 0...1 |
Type | string |
Alias | Distinct Identification Code (DIC) |
Comments | For example, this applies to devices in the United States regulated under Code of Federal Regulation 21CFR§1271.290(c). |
Invariants |
|
Mappings |
|
Device.manufacturer | |
Definition | A name of the manufacturer. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Device.manufactureDate | |
Definition | The date and time when the device was manufactured. |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
Device.expirationDate | |
Definition | The date and time beyond which this device is no longer valid or should not be used (if applicable). |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
Device.lotNumber | |
Definition | Lot number assigned by the manufacturer. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Device.serialNumber | |
Definition | The serial number assigned by the organization when the device was manufactured. |
Cardinality | 0...1 |
Type | string |
Comments | Alphanumeric Maximum 20. |
Invariants |
|
Mappings |
|
Device.deviceName | |
Definition | This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Device.deviceName.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | System.String |
Mappings |
|
Device.deviceName.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Device.deviceName.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Device.deviceName.name | |
Definition | The name of the device. |
Cardinality | 1...1 |
Type | string |
Alias | Σ |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Device.deviceName.type | |
Definition | The type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName. |
Cardinality | 1...1 |
Type | code |
Binding | The type of name the device is referred by. DeviceNameType (required) |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Device.modelNumber | |
Definition | The model number for the device. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Device.partNumber | |
Definition | The part number of the device. |
Cardinality | 0...1 |
Type | string |
Comments | Alphanumeric Maximum 20. |
Invariants |
|
Mappings |
|
Device.type | |
Definition | The kind or type of device. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A code from the SNOMED Clinical Terminology UK coding system that describes a type of device. UKCoreDeviceType (preferred) |
Must Support | True |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Device.specialization | |
Definition | The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Device.specialization.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | System.String |
Mappings |
|
Device.specialization.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Device.specialization.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Device.specialization.systemType | |
Definition | The standard that is used to operate and communicate. |
Cardinality | 1...1 |
Type | CodeableConcept |
Alias | Σ |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Device.specialization.version | |
Definition | The version of the standard that is used to operate and communicate. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Device.version | |
Definition | The actual design of the device or software version running on the device. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Device.version.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | System.String |
Mappings |
|
Device.version.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Device.version.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Device.version.type | |
Definition | The type of the device version. |
Cardinality | 0...1 |
Type | CodeableConcept |
Alias | Σ |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Device.version.component | |
Definition | A single component of the device version. |
Cardinality | 0...1 |
Type | Identifier |
Invariants |
|
Mappings |
|
Device.version.value | |
Definition | The version text. |
Cardinality | 1...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Device.property | |
Definition | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Device.property.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | System.String |
Mappings |
|
Device.property.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Device.property.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Device.property.type | |
Definition | Code that specifies the property DeviceDefinitionPropetyCode (Extensible). |
Cardinality | 1...1 |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Device.property.valueQuantity | |
Definition | Property value as a quantity. |
Cardinality | 0...* |
Type | Quantity |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
Invariants |
|
Mappings |
|
Device.property.valueCode | |
Definition | Property value as a code, e.g., NTP4 (synced to NTP). |
Cardinality | 0...* |
Type | CodeableConcept |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Device.patient | |
Definition | Patient information, If the device is affixed to a person. |
Cardinality | 0...1 |
Type | Reference(Patient) |
Requirements | If the device is implanted in a patient, then need to associate the device to the patient. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Device.owner | |
Definition | An organization that is responsible for the provision and ongoing maintenance of the device. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Device.contact | |
Definition | Contact details for an organization or a particular human that is responsible for the device. |
Cardinality | 0...* |
Type | ContactPoint |
Comments | used for troubleshooting etc. |
Invariants |
|
Mappings |
|
Device.location | |
Definition | The place where the device can be found. |
Cardinality | 0...1 |
Type | Reference(Location) |
Requirements | Device.location can be used to track device location. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Device.url | |
Definition | A network address on which the device may be contacted directly. |
Cardinality | 0...1 |
Type | uri |
Comments | If the device is running a FHIR server, the network address should be the Base URL from which a conformance statement may be retrieved. |
Invariants |
|
Mappings |
|
Device.note | |
Definition | Descriptive information, usage information or implantation information that is not captured in an existing element. |
Cardinality | 0...* |
Type | Annotation |
Comments | For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). |
Invariants |
|
Mappings |
|
Device.safety | |
Definition | Provides additional safety characteristics about a medical device. For example devices containing latex. |
Cardinality | 0...* |
Type | CodeableConcept |
Summary | True |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Device.parent | |
Definition | The parent device. |
Cardinality | 0...1 |
Type | Reference(Device) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Table View
Device | .. | |
Device.status | .. | |
Device.type | .. |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="UKCore-Device" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device" /> <version value="1.2.0" /> <name value="UKCoreDevice" /> <title value="UK Core Device" /> <status value="draft" /> <date value="2023-12-12" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="ukcore@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <description value="This profile defines the UK constraints and extensions on the International FHIR resource [Device](https://hl7.org/fhir/R4/Device.html)." /> <purpose value="The purpose of this profile is to hold information about a type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. It is referenced by other resources for recording which device performed an action such as a procedure or an observation, referenced when prescribing and dispensing devices for patient use or for ordering supplies, and used to record and transmit Unique Device Identifier (UDI) information about a device such as a patient's implant." /> <copyright value="Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html." /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="Device" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Device" /> <derivation value="constraint" /> <differential> <element id="Device.status"> <path value="Device.status" /> <short value="The status of the Device." /> <mustSupport value="true" /> </element> <element id="Device.type"> <path value="Device.type" /> <short value="The type of the Device." /> <mustSupport value="true" /> <binding> <strength value="preferred" /> <description value="A code from the SNOMED Clinical Terminology UK coding system that describes a type of device." /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-DeviceType" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "UKCore-Device", "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device", "version": "1.2.0", "name": "UKCoreDevice", "title": "UK Core Device", "status": "draft", "date": "2023-12-12", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "ukcore@hl7.org.uk", "use": "work", "rank": 1 } ] } ], "description": "This profile defines the UK constraints and extensions on the International FHIR resource [Device](https://hl7.org/fhir/R4/Device.html).", "purpose": "The purpose of this profile is to hold information about a type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. It is referenced by other resources for recording which device performed an action such as a procedure or an observation, referenced when prescribing and dispensing devices for patient use or for ordering supplies, and used to record and transmit Unique Device Identifier (UDI) information about a device such as a patient's implant.", "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Device", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Device", "derivation": "constraint", "differential": { "element": [ { "id": "Device.status", "path": "Device.status", "short": "The status of the Device.", "mustSupport": true }, { "id": "Device.type", "path": "Device.type", "short": "The type of the Device.", "mustSupport": true, "binding": { "strength": "preferred", "description": "A code from the SNOMED Clinical Terminology UK coding system that describes a type of device.", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-DeviceType" } } ] } }
Usage
This Profile has the following derived profiles:id | baseDefinition | status |
---|---|---|
UKCore-Device-BloodPressure | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device | active |
This Profile is referenced in the following Extensions:
id | targetProfile |
---|---|
Extension-UKCore-DeviceReference | http://hl7.org/fhir/StructureDefinition/Device |
Extension-UKCore-FamilyMemberHistoryParticipant | http://hl7.org/fhir/StructureDefinition/Patient; http://hl7.org/fhir/StructureDefinition/Practitioner; http://hl7.org/fhir/StructureDefinition/PractitionerRole; http://hl7.org/fhir/StructureDefinition/RelatedPerson; http://hl7.org/fhir/StructureDefinition/Device; http://hl7.org/fhir/StructureDefinition/Organization; http://hl7.org/fhir/StructureDefinition/CareTeam |
This Profile is referenced in the following Profiles:
Feedback
Click here to:Examples
Colostomy Bag - An example to illustrate a colostomy bagExample UKCore-Device-ColostomyBag Software as a Medical Device - An example to illustrate recording AI softweare as a medical device.
Example UKCore-Device-SoftwareAsAMedicalDevice
Sphygmomanometer - An example to illustrate recording a specific blood pressure device.
Example UKCore-Device-Sphygmomanometer
Example Usage Scenarios
The following are example usage scenarios for the UK Core Device profile:
- Query and retrieve information regarding a medical device
- Record or update a device used during a patient's care
Profile Specific Implementation Guidance:
Minimum Viable Content
A minimum viable content that all provider and consumer systems SHALL support are the following elements.
Element | Reason |
---|---|
Device.status |
The status of the Device. |
Device.type |
The type of the Device. |
Bindings (differential)
More information about the bindings to UK Core ValueSets can be found below.
Context | Strength | Link |
---|---|---|
Device.type | Preferred | ValueSet UKCore-DeviceType |
patient
Where possible, it is expected that the resource being referenced SHOULD conform to Profile UKCore-Patient.
owner
Where possible, it is expected that the resource being referenced SHOULD conform to Profile UKCore-Organization.
location
Where possible, it is expected that the resource being referenced SHOULD conform to Profile UKCore-Location.
parent
Where possible, it is expected that the resource being referenced SHOULD conform to Profile UKCore-Device.