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: QICoreDeviceNotRequested

Defining URL:http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-devicenotrequested
Version:4.1.0
Name:QICoreDeviceNotRequested
Status:Draft as of 7/11/19
Definition:

Profile of DeviceRequest 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-devicenotrequested
Usage

See the patterns page for implementation and usage patterns.

The DeviceRequest and DeviceNotRequested profiles represent the positive and negative statements for a device request. To ensure instances retrieved meet negative intent, applications should check the status and doNotPerform elements as illustrated in this example:

define DeviceNotRequested:
  [DeviceRequest] D
    where D.status = 'completed'
      and D.doNotPerform() is true

Examples

Negation Example with valueset
Negation Example with code

Formal Views of Profile Content

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

This structure is derived from DeviceRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceRequest I0..*DeviceRequestMedical device request
dnr-1: to indicate what device was not requested, either at least one coding in the code or a notDoneValueSet extension shall be provided
... qicore-doNotPerformReason S1..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-doNotPerformReason
Binding: Negation Reason Codes (extensible): The reason the event did not occur or was not performed

... modifierExtension:doNotPerform ?!S1..1Extension-4.6-DeviceRequest.doNotPerformExtension
.... value[x] S1..1booleanValue of extension
Fixed Value: true
... status S1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Fixed Value: completed
... code[x] SI1..1CodeableConceptDevice requested
.... qicore-notDoneValueSet SI0..1canonical(ValueSet)What was not done
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet
... subject S1..1Reference(QICorePatient)Focus of request
... encounter S0..1Reference(QICoreEncounter)Encounter motivating request
... authoredOn S1..1dateTimeWhen recorded
... note S0..*AnnotationNotes or comments

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceRequest I0..*DeviceRequestMedical device request
dnr-1: to indicate what device was not requested, either at least one coding in the code or a notDoneValueSet extension shall be provided
... 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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... qicore-doNotPerformReason S1..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-doNotPerformReason
Binding: Negation Reason Codes (extensible): The reason the event did not occur or was not performed


... Slices for modifierExtension ?!0..*ExtensionExtension
Slice: Unordered, Open by value:url
... modifierExtension:doNotPerform ?!S1..1Extension-4.6-DeviceRequest.doNotPerformExtension
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uriidentifies the meaning of the extension
.... value[x] S1..1booleanValue of extension
Fixed Value: true
... identifier Σ0..*IdentifierExternal Request identifier
... instantiatesCanonical Σ0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(Resource)What request fulfills
... priorRequest Σ0..*Reference(Resource)What request replaces
... groupIdentifier Σ0..1IdentifierIdentifier of composite request
... status ?!SΣ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Codes representing the status of the request.


Fixed Value: completed
... intent ?!SΣ1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of diagnostic request.

... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... code[x] SΣI1..1CodeableConceptDevice requested
Binding: FHIRDeviceTypes (example): Codes for devices that can be requested.

.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... qicore-notDoneValueSet SI0..1canonical(ValueSet)What was not done
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet
.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
... parameter 0..*BackboneElementDevice details
.... 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
.... code 0..1CodeableConceptDevice detail
Binding: (unbound) (example): A code that identifies the device detail.

.... value[x] 0..1Value of detail
..... valueCodeableConceptCodeableConcept
..... valueQuantityQuantity
..... valueRangeRange
..... valueBooleanboolean
... subject SΣ1..1Reference(QICorePatient)Focus of request
... encounter SΣ0..1Reference(QICoreEncounter)Encounter motivating request
... occurrence[x] Σ0..1Desired time or schedule for use
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
.... occurrenceTimingTiming
... authoredOn SΣ1..1dateTimeWhen recorded
... requester Σ0..1Reference(Device | Practitioner | PractitionerRole | Organization)Who/what is requesting diagnostics
... performerType Σ0..1CodeableConceptFiller role
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.

... performer Σ0..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Requested Filler
... reasonCode Σ0..*CodeableConceptCoded Reason for request
Binding: Condition/Problem/DiagnosisCodes (example): Diagnosis or problem codes justifying the reason for requesting the device.


... reasonReference Σ0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Linked Reason for request
... insurance 0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... supportingInfo 0..*Reference(Resource)Additional clinical information
... note S0..*AnnotationNotes or comments
... relevantHistory 0..*Reference(Provenance)Request provenance

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceRequest I0..*DeviceRequestMedical device request
dnr-1: to indicate what device was not requested, either at least one coding in the code or a notDoneValueSet extension shall be provided
... qicore-doNotPerformReason 1..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-doNotPerformReason
Binding: Negation Reason Codes (extensible): The reason the event did not occur or was not performed


... modifierExtension:doNotPerform ?!1..1Extension-4.6-DeviceRequest.doNotPerformExtension
.... value[x] 1..1booleanValue of extension
Fixed Value: true
... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Codes representing the status of the request.


Fixed Value: completed
... code[x] ΣI1..1CodeableConceptDevice requested
Binding: FHIRDeviceTypes (example): Codes for devices that can be requested.

.... qicore-notDoneValueSet I0..1canonical(ValueSet)What was not done
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet
... subject Σ1..1Reference(QICorePatient)Focus of request
... encounter Σ0..1Reference(QICoreEncounter)Encounter motivating request
... authoredOn Σ1..1dateTimeWhen recorded
... note 0..*AnnotationNotes or comments

doco Documentation for this format

Differential View

This structure is derived from DeviceRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceRequest I0..*DeviceRequestMedical device request
dnr-1: to indicate what device was not requested, either at least one coding in the code or a notDoneValueSet extension shall be provided
... qicore-doNotPerformReason S1..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-doNotPerformReason
Binding: Negation Reason Codes (extensible): The reason the event did not occur or was not performed

... modifierExtension:doNotPerform ?!S1..1Extension-4.6-DeviceRequest.doNotPerformExtension
.... value[x] S1..1booleanValue of extension
Fixed Value: true
... status S1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Fixed Value: completed
... code[x] SI1..1CodeableConceptDevice requested
.... qicore-notDoneValueSet SI0..1canonical(ValueSet)What was not done
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet
... subject S1..1Reference(QICorePatient)Focus of request
... encounter S0..1Reference(QICoreEncounter)Encounter motivating request
... authoredOn S1..1dateTimeWhen recorded
... note S0..*AnnotationNotes or comments

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceRequest I0..*DeviceRequestMedical device request
dnr-1: to indicate what device was not requested, either at least one coding in the code or a notDoneValueSet extension shall be provided
... 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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... qicore-doNotPerformReason S1..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-doNotPerformReason
Binding: Negation Reason Codes (extensible): The reason the event did not occur or was not performed


... Slices for modifierExtension ?!0..*ExtensionExtension
Slice: Unordered, Open by value:url
... modifierExtension:doNotPerform ?!S1..1Extension-4.6-DeviceRequest.doNotPerformExtension
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uriidentifies the meaning of the extension
.... value[x] S1..1booleanValue of extension
Fixed Value: true
... identifier Σ0..*IdentifierExternal Request identifier
... instantiatesCanonical Σ0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(Resource)What request fulfills
... priorRequest Σ0..*Reference(Resource)What request replaces
... groupIdentifier Σ0..1IdentifierIdentifier of composite request
... status ?!SΣ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Codes representing the status of the request.


Fixed Value: completed
... intent ?!SΣ1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of diagnostic request.

... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... code[x] SΣI1..1CodeableConceptDevice requested
Binding: FHIRDeviceTypes (example): Codes for devices that can be requested.

.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... qicore-notDoneValueSet SI0..1canonical(ValueSet)What was not done
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet
.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
... parameter 0..*BackboneElementDevice details
.... 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
.... code 0..1CodeableConceptDevice detail
Binding: (unbound) (example): A code that identifies the device detail.

.... value[x] 0..1Value of detail
..... valueCodeableConceptCodeableConcept
..... valueQuantityQuantity
..... valueRangeRange
..... valueBooleanboolean
... subject SΣ1..1Reference(QICorePatient)Focus of request
... encounter SΣ0..1Reference(QICoreEncounter)Encounter motivating request
... occurrence[x] Σ0..1Desired time or schedule for use
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
.... occurrenceTimingTiming
... authoredOn SΣ1..1dateTimeWhen recorded
... requester Σ0..1Reference(Device | Practitioner | PractitionerRole | Organization)Who/what is requesting diagnostics
... performerType Σ0..1CodeableConceptFiller role
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.

... performer Σ0..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Requested Filler
... reasonCode Σ0..*CodeableConceptCoded Reason for request
Binding: Condition/Problem/DiagnosisCodes (example): Diagnosis or problem codes justifying the reason for requesting the device.


... reasonReference Σ0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Linked Reason for request
... insurance 0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... supportingInfo 0..*Reference(Resource)Additional clinical information
... note S0..*AnnotationNotes or comments
... relevantHistory 0..*Reference(Provenance)Request provenance

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
DeviceRequest.languagepreferredCommonLanguages
Max Binding: AllLanguages
DeviceRequest.statusrequiredFixed Value: completed
DeviceRequest.intentrequiredRequestIntent
DeviceRequest.priorityrequiredRequestPriority
DeviceRequest.code[x]exampleFHIRDeviceTypes
DeviceRequest.parameter.codeexample
DeviceRequest.performerTypeexampleParticipantRoles
DeviceRequest.reasonCodeexampleCondition/Problem/DiagnosisCodes

Constraints

IdGradePathDetailsRequirements
dom-2errorDeviceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceRequestIf 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-4errorDeviceRequestIf 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-5errorDeviceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Best PracticeDeviceRequestA resource should have narrative for robust management
: text.`div`.exists()
dnr-1errorDeviceRequestto indicate what device was not requested, either at least one coding in the code or a notDoneValueSet extension shall be provided
: code.extension('http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet').exists() xor code.coding.exists()
ele-1errorDeviceRequest.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDeviceRequest.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDeviceRequest.extension:doNotPerformReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDeviceRequest.extension:doNotPerformReasonMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDeviceRequest.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDeviceRequest.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDeviceRequest.modifierExtension:doNotPerformAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDeviceRequest.modifierExtension:doNotPerformMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDeviceRequest.modifierExtension:doNotPerform.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDeviceRequest.modifierExtension:doNotPerform.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDeviceRequest.modifierExtension:doNotPerform.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.instantiatesCanonicalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.instantiatesUriAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.basedOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.priorRequestAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.groupIdentifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.intentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.priorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.code[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.code[x].extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDeviceRequest.code[x].extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDeviceRequest.code[x].extension:doNotPerformValueSetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDeviceRequest.code[x].extension:doNotPerformValueSetMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDeviceRequest.code[x].codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.code[x].textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.parameterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.parameter.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDeviceRequest.parameter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDeviceRequest.parameter.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDeviceRequest.parameter.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDeviceRequest.parameter.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.parameter.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.occurrence[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.authoredOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.requesterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.performerTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.performerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.reasonCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.reasonReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.insuranceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.supportingInfoAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDeviceRequest.relevantHistoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())