STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

F.8.1.4 StructureDefinition: QICore-Device - Detailed Descriptions

Definitions for the qicore-device Profile.

Device(QICore-Device)
Definition

This resource identifies an instance or 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. Medical devices includes durable (reusable) medical equipment, implantable devices, as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health. Non-medical devices may include items such as a machine, cellphone, computer, application, etc.

Control0..*
TypeDevice
Device.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
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. Bundles always have an id, though it is usually a generated UUID.

Device.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
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.

Control0..1
Typeuri
Is Modifiertrue
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 as much as possible.

Device.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHALL be taken from http://tools.ietf.org/html/bcp47
Typecode
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).

Device.text
Definition

A human-readable narrative that contains a summary of the resource, and may 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.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

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.

Control0..*
TypeResource
Alternate Namesinline 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.

Device.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

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. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, 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.

Device.identifier
Definition

Unique instance identifiers assigned to a device by manufacturers other organizations or owners.

Control0..*
TypeIdentifier
Alternate NamesSerial Number
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. For UDI, this element corresponds to the variable portion of the UDI that identifies the serial number of a specific device. See UDI mappings for a complete mapping of UDI parts to Device.

Device.udiCarrier
Definition

Unique device identifier (UDI) barcode or rfid string assigned to device label or package.

Control0..1
TypeIdentifier
Alternate NamesUDI, Barcode String
Comments

The udiCarrier string may identify an unique instance of a device, or it may only identify the type of the device. The Human Readable format (HRF) is required in FHIR. AIDC identifiers cannot be conveyed in FHIR, Because of limitations on character sets in XML and the need to round-trip JSON data through XML. See UDI mappings for a complete mapping of UDI parts to Device.

Device.status
Definition

Status of the Device availability.

Control0..1
BindingThe availability status of the device.
The codes SHALL be taken from DeviceStatus
Typecode
Is Modifiertrue
Must Supporttrue
Device.type
Definition

Code or identifier to identify a kind of device.

Control1..1
BindingCodes to identify medical devices
For example codes, see Device Types
TypeCodeableConcept
Must Supporttrue
Comments

There can be different code values thath may correspond to different granularities of the same concept. These can be represented as translations using the codeableConcept datatype. For UDI, this element corresponds to the UDI device identifier (DI) part. See UDI mappings for a complete mapping of UDI parts to Device.

Device.lotNumber
Definition

Lot number assigned by the manufacturer.

Control0..1
Typestring
Comments

Alphanumeric. For UDI, this element corresponds to the variable portion of a UDI that identifies the lot or batch number within which a physical instance of a device was manufactured. See UDI mappings for a complete mapping of UDI parts to Device.

Device.manufacturer
Definition

A name of the manufacturer.

Control0..1
Typestring
Device.manufactureDate
Definition

The date and time when the device was manufactured.

Control0..1
TypedateTime
Comments

For UDI, this element corresponds to the variable portion of a UDI that identifies the date a physical instance of a device was manufactured. See UDI mappings for a complete mapping of UDI parts to Device.

Device.expirationDate
Definition

The date and time beyond which this device is no longer valid or should not be used (if applicable).

Control0..1
TypedateTime
Comments

For UDI, this element corresponds to the variable portion of a UDI that identifies the expiration date of a physical instance of a device. See UDI mappings for a complete mapping of UDI parts to Device.

Device.model
Definition

The "model" is an identifier assigned by the manufacturer to identify the product by its type. This number is shared by the all devices sold as the same type.

Control0..1
Typestring
Device.version
Definition

The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.

Control0..1
Typestring
Device.patient
Definition

Patient information, If the device is affixed to a person.

Control0..1
TypeReference(QICore-Patient)
Must Supporttrue
Requirements

If the device is implanted in a patient, then need to associate the device to the patient.

Device.owner
Definition

An organization that is responsible for the provision and ongoing maintenance of the device.

Control0..1
TypeReference(QICore-Organization)
Device.contact
Definition

Contact details for an organization or a particular human that is responsible for the device.

Control0..*
TypeContactPoint
Comments

used for troubleshooting etc.

Device.location
Definition

The place where the device can be found.

Control0..1
TypeReference(QICore-Location)
Must Supporttrue
Requirements

Device.location can be used to track device location.

Device.url
Definition

A network address on which the device may be contacted directly.

Control0..1
Typeuri
Comments

If the device is running a FHIR server, the network address should be the root URL from which a conformance statement may be retrieved.

Device.note
Definition

Descriptive information, usage information or implantation information that is not captured in an existing element.

Control0..*
TypeAnnotation