Quality Measure Implementation Guide (STU3 Ballot)
2.1.0 - ballot

This page is part of the Quality Measure STU2 for FHIR R4 Implementation Guide (v2.1.0: STU3 Ballot 1) based on FHIR R4. The current version which supercedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: CQFMDevice

Defining URL:http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/device-softwaresystem-cqfm
Version:2.1.0
Name:CQFMDevice
Status:Active as of 2019-02-13
Definition:

The SoftwareSystem device profile is used to capture software details about the various systems used in authoring, testing, packaging, or evaluation of a knowledge artifact

Publisher:Clinical Quality Information WG
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/device-softwaresystem-cqfm

Formal Views of Profile Content

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

This structure is derived from Device

Summary

Mandatory: 3 elements
Fixed Value: 1 element
Prohibited: 2 elements

This structure is derived from Device

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device 0..*DeviceItem used in healthcare
... manufacturer 0..1stringThe developers of the Software System
... deviceName 1..1BackboneElementThe name of the software
.... name 1..1stringThe name of the device
.... type 1..1codeudi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
Fixed Value: manufacturer-name
... type 0..1CodeableConceptauthoring | testing | tooling | evaluation | reporting | data-capture
Binding: Software System Type (extensible): The software system type

.... type 0..0
.... component 0..0
.... value 1..1stringThe version text
... url 0..1uriNetwork address to contact device

doco Documentation for this format
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..1stringThe developers of the Software System
... 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 1..1BackboneElementThe name of the software
.... 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.


Fixed Value: manufacturer-name
... modelNumber 0..1stringThe model number for the device
... partNumber 0..1stringThe part number of the device
... type 0..1CodeableConceptauthoring | testing | tooling | evaluation | reporting | data-capture
Binding: Software System Type (extensible): The software system type

... 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..1BackboneElementThe 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
.... 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 0..1Reference(Patient)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: 3 elements
Fixed Value: 1 element
Prohibited: 2 elements

Differential View

This structure is derived from Device

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device 0..*DeviceItem used in healthcare
... manufacturer 0..1stringThe developers of the Software System
... deviceName 1..1BackboneElementThe name of the software
.... name 1..1stringThe name of the device
.... type 1..1codeudi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
Fixed Value: manufacturer-name
... type 0..1CodeableConceptauthoring | testing | tooling | evaluation | reporting | data-capture
Binding: Software System Type (extensible): The software system type

.... type 0..0
.... component 0..0
.... value 1..1stringThe version text
... url 0..1uriNetwork address to contact device

doco Documentation for this format

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..1stringThe developers of the Software System
... 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 1..1BackboneElementThe name of the software
.... 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.


Fixed Value: manufacturer-name
... modelNumber 0..1stringThe model number for the device
... partNumber 0..1stringThe part number of the device
... type 0..1CodeableConceptauthoring | testing | tooling | evaluation | reporting | data-capture
Binding: Software System Type (extensible): The software system type

... 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..1BackboneElementThe 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
.... 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 0..1Reference(Patient)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: Schematron

Terminology Bindings

PathConformanceValueSet / Code
Device.languagepreferredCommonLanguages
Max Binding: AllLanguages
Device.udiCarrier.entryTyperequiredUDIEntryType
Device.statusrequiredFHIRDeviceStatus
Device.statusReasonextensibleFHIRDeviceStatusReason
Device.deviceName.typerequiredFixed Value: manufacturer-name
Device.typeextensibleSoftwareSystemType

Constraints

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