QI-Core Implementation Guide
4.1.0 - release

This page is part of the Quality Improvement Core Framework (v4.1.0: STU 4) based on FHIR R4. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions

Resource Profile: QICoreDevice

Defining URL:http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-device
Version:4.1.0
Name:QICoreDevice
Status:Draft as of 8/22/18
Definition:

Profile of Device for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

Publisher:http://www.hl7.org/Special/committees/cqi/index.cfm
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-device
Usage

FHIR defines the Device Resource as 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. FHIR and US Core further differentiate devices into two “classes”:

The FHIR Device Resource addresses both implantable and non-implantable devices. US Core only references Implantable Device. QI-Core inherits Implantable Device from US Core and builds directly from FHIR for the QI-Core Device Resource.

Therefore, when creating an expression for an eCQM or a CDS artifact, assure you are using the appropriate Device or Implantable Device resource.

See the patterns page for implementation and usage patterns.

Examples

General Device Example

Formal Views of Profile Content

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

This structure is derived from Device

Summary

Mandatory: 1 element
Must-Support: 1 element

Structures

This structure refers to these other structures:

This structure is derived from Device

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device 0..*DeviceItem used in healthcare
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierInstance identifier
... definition 0..1Reference(DeviceDefinition)The reference to the definition for the device
... udiCarrier Σ0..*BackboneElementUnique Device Identifier (UDI) Barcode string
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... deviceIdentifier Σ0..1stringMandatory fixed portion of UDI
.... issuer 0..1uriUDI Issuing Organization
.... jurisdiction 0..1uriRegional UDI authority
.... carrierAIDC Σ0..1base64BinaryUDI Machine Readable Barcode String
.... carrierHRF Σ0..1stringUDI Human Readable Barcode String
.... entryType 0..1codebarcode | rfid | manual +
Binding: UDIEntryType (required): Codes to identify how UDI data was entered.

... status ?!Σ0..1codeactive | inactive | entered-in-error | unknown
Binding: FHIRDeviceStatus (required): The availability status of the device.

... statusReason 0..*CodeableConceptonline | paused | standby | offline | not-ready | transduc-discon | hw-discon | off
Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device.


... distinctIdentifier 0..1stringThe distinct identification string
... manufacturer 0..1stringName of device manufacturer
... manufactureDate 0..1dateTimeDate when the device was made
... expirationDate 0..1dateTimeDate and time of expiry of this device (if applicable)
... lotNumber 0..1stringLot number of manufacture
... serialNumber 0..1stringSerial number assigned by the manufacturer
... deviceName 0..*BackboneElementThe name of the device as given by the manufacturer
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name 1..1stringThe name of the device
.... type 1..1codeudi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
Binding: DeviceNameType (required): The type of name the device is referred by.

... modelNumber 0..1stringThe model number for the device
... partNumber 0..1stringThe part number of the device
... type 0..1CodeableConceptThe kind or type of device
Binding: DeviceType (example): Codes to identify medical devices.

... specialization 0..*BackboneElementThe capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... systemType 1..1CodeableConceptThe standard that is used to operate and communicate
.... version 0..1stringThe version of the standard that is used to operate and communicate
... version 0..*BackboneElementThe actual design of the device or software version running on the device
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 0..1CodeableConceptThe type of the device version
.... component 0..1IdentifierA single component of the device version
.... value 1..1stringThe version text
... property 0..*BackboneElementThe actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1CodeableConceptCode that specifies the property DeviceDefinitionPropetyCode (Extensible)
.... valueQuantity 0..*QuantityProperty value as a quantity
.... valueCode 0..*CodeableConceptProperty value as a code, e.g., NTP4 (synced to NTP)
... patient S1..1Reference(QICorePatient)Patient to whom Device is affixed
... owner 0..1Reference(Organization)Organization responsible for device
... contact 0..*ContactPointDetails for human/organization for support
... location 0..1Reference(Location)Where the device is found
... url 0..1uriNetwork address to contact device
... note 0..*AnnotationDevice notes and comments
... safety Σ0..*CodeableConceptSafety Characteristics of Device
... parent 0..1Reference(Device)The parent device

doco Documentation for this format

This structure is derived from Device

Summary

Mandatory: 1 element
Must-Support: 1 element

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Device

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device 0..*DeviceItem used in healthcare
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierInstance identifier
... definition 0..1Reference(DeviceDefinition)The reference to the definition for the device
... udiCarrier Σ0..*BackboneElementUnique Device Identifier (UDI) Barcode string
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... deviceIdentifier Σ0..1stringMandatory fixed portion of UDI
.... issuer 0..1uriUDI Issuing Organization
.... jurisdiction 0..1uriRegional UDI authority
.... carrierAIDC Σ0..1base64BinaryUDI Machine Readable Barcode String
.... carrierHRF Σ0..1stringUDI Human Readable Barcode String
.... entryType 0..1codebarcode | rfid | manual +
Binding: UDIEntryType (required): Codes to identify how UDI data was entered.

... status ?!Σ0..1codeactive | inactive | entered-in-error | unknown
Binding: FHIRDeviceStatus (required): The availability status of the device.

... statusReason 0..*CodeableConceptonline | paused | standby | offline | not-ready | transduc-discon | hw-discon | off
Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device.


... distinctIdentifier 0..1stringThe distinct identification string
... manufacturer 0..1stringName of device manufacturer
... manufactureDate 0..1dateTimeDate when the device was made
... expirationDate 0..1dateTimeDate and time of expiry of this device (if applicable)
... lotNumber 0..1stringLot number of manufacture
... serialNumber 0..1stringSerial number assigned by the manufacturer
... deviceName 0..*BackboneElementThe name of the device as given by the manufacturer
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name 1..1stringThe name of the device
.... type 1..1codeudi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
Binding: DeviceNameType (required): The type of name the device is referred by.

... modelNumber 0..1stringThe model number for the device
... partNumber 0..1stringThe part number of the device
... type 0..1CodeableConceptThe kind or type of device
Binding: DeviceType (example): Codes to identify medical devices.

... specialization 0..*BackboneElementThe capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... systemType 1..1CodeableConceptThe standard that is used to operate and communicate
.... version 0..1stringThe version of the standard that is used to operate and communicate
... version 0..*BackboneElementThe actual design of the device or software version running on the device
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 0..1CodeableConceptThe type of the device version
.... component 0..1IdentifierA single component of the device version
.... value 1..1stringThe version text
... property 0..*BackboneElementThe actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1CodeableConceptCode that specifies the property DeviceDefinitionPropetyCode (Extensible)
.... valueQuantity 0..*QuantityProperty value as a quantity
.... valueCode 0..*CodeableConceptProperty value as a code, e.g., NTP4 (synced to NTP)
... patient S1..1Reference(QICorePatient)Patient to whom Device is affixed
... owner 0..1Reference(Organization)Organization responsible for device
... contact 0..*ContactPointDetails for human/organization for support
... location 0..1Reference(Location)Where the device is found
... url 0..1uriNetwork address to contact device
... note 0..*AnnotationDevice notes and comments
... safety Σ0..*CodeableConceptSafety Characteristics of Device
... parent 0..1Reference(Device)The parent device

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Device.languagepreferredCommonLanguages
Max Binding: AllLanguages
Device.udiCarrier.entryTyperequiredUDIEntryType
Device.statusrequiredFHIRDeviceStatus
Device.statusReasonextensibleFHIRDeviceStatusReason
Device.deviceName.typerequiredDeviceNameType
Device.typeexampleDeviceType

Constraints

IdGradePathDetailsRequirements
dom-2errorDeviceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceIf 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-4errorDeviceIf 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-5errorDeviceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Best PracticeDeviceA resource should have narrative for robust management
: text.`div`.exists()
ele-1errorDevice.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDevice.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDevice.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDevice.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDevice.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.definitionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.udiCarrierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.udiCarrier.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDevice.udiCarrier.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDevice.udiCarrier.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDevice.udiCarrier.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDevice.udiCarrier.deviceIdentifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.udiCarrier.issuerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.udiCarrier.jurisdictionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.udiCarrier.carrierAIDCAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.udiCarrier.carrierHRFAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.udiCarrier.entryTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.statusReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.distinctIdentifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.manufacturerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.manufactureDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.expirationDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.lotNumberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.serialNumberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.deviceNameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.deviceName.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDevice.deviceName.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDevice.deviceName.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDevice.deviceName.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDevice.deviceName.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.deviceName.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.modelNumberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.partNumberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.specializationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.specialization.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDevice.specialization.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDevice.specialization.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDevice.specialization.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDevice.specialization.systemTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.specialization.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.version.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDevice.version.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDevice.version.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDevice.version.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDevice.version.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.version.componentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.version.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.propertyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.property.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDevice.property.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDevice.property.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDevice.property.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDevice.property.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.property.valueQuantityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.property.valueCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.patientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.ownerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.locationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.safetyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDevice.parentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())