US Quality Core Implementation Guide
1.0.0-ballot - STU 1 - ballot United States of America flag

US Quality Core Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-quality-core/ and changes regularly. See the Directory of published versions

Resource Profile: US Quality Core Device Prohibited

Official URL: http://hl7.org/fhir/us/quality-core/StructureDefinition/us-quality-core-deviceprohibited Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 4 Computable Name: USQualityCoreDeviceProhibited
Other Identifiers: OID:2.16.840.1.113883.4.642.40.78.42.11

Negation profile of DeviceRequest for decision support/quality metrics. Indicates a proposal, plan, or order not to provide a device.

The DeviceRequest profile defines the conformance expectations for a DeviceRequest, regardless of whether it is a positive or negative statement. The DeviceRequested and DeviceProhibited profiles derive from DeviceRequest and represent the positive and negative statements for a device request.

For a more complete discussion of representation of negation within US Quality Core and quality improvement artifacts, see the Negation in US Quality Core topic.

USCDI+ Quality Element Support Expectations

Systems are expected to support this profile as part of implementing USCDI+ Quality V2 in FHIR and meeting the conformance requirements of this guide.

The following elements are specifically relevant to USCDI+ Quality V2 data classes and elements. Systems are expected to support these elements as applicable to their role in US Quality Core data exchange. See the Must Support section of this guide for more information. These elements are flagged as (USCDI+ Quality) in the formal profile views.

USCDI+ Quality Elements:

Profile element Description USCDI+ Quality Data Element(s)
authoredOn When recorded Orders: Medical Device Order
code[x] Device requested Orders: Medical Device Order
intent proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Orders: Medical Device Order
modifierExtension:doNotPerform Extension Orders: Medical Device Order
requester Who/what is requesting diagnostics Provenance: Author
status draft | active | on-hold | revoked | completed | entered-in-error | unknown Orders: Medical Device Order

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DeviceRequest C 0..* USQualityCoreDeviceRequest Medical device request
Constraints: drq-3
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for modifierExtension ?! 1..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:doNotPerform ?! 1..1 (Complex) (USCDI+ Quality) Extension
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceRequest.doNotPerform
Constraints: ext-1
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceRequest.doNotPerform"
..... value[x] 1..1 boolean Value of extension
Fixed Value: true
... status ?!Σ 0..1 code (USCDI+ Quality) draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Codes representing the status of the request.
... Slices for code[x] ΣC 1..1 (USCDI+ Quality) Device requested
Slice: Unordered, Open by type:$this
Binding: FHIRDeviceTypes (preferred)
.... codeReference Reference(US Core Device Profile(9.0.0))
.... codeCodeableConcept CodeableConcept
.... code[x]:codeCodeableConcept Σ 0..1 CodeableConcept Device requested
Binding: FHIRDeviceTypes (example): Codes for devices that can be requested.
..... Slices for extension Content/Rules for all slices
...... extension:codeOptions C 0..1 canonical(ValueSet) (USCDI+ Quality) Url of a value set of candidate devices
URL: http://hl7.org/fhir/StructureDefinition/codeOptions
... subject Σ 1..1 Reference(US Quality Core Patient) Focus of request
... authoredOn Σ 1..1 dateTime (USCDI+ Quality) When recorded
... reasonCode Σ 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: US Quality Core Negation Reason Codes (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DeviceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
DeviceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
DeviceRequest.code[x] Base preferred FHIR Device Types 📦4.0.1 FHIR Std.
DeviceRequest.code[x]:codeCodeableConcept Base example FHIR Device Types 📍4.0.1 FHIR Std.
DeviceRequest.reasonCode Base extensible US Quality Core Negation Reason Codes 📦1.0.0-ballot This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error DeviceRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DeviceRequest If 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-4 error DeviceRequest If 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-5 error DeviceRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DeviceRequest A resource should have narrative for robust management text.`div`.exists()
drq-3 error DeviceRequest to indicate what device, either at least one coding in the code or a codeOptions extension shall be provided (code is Reference).not() implies code.extension('http://hl7.org/fhir/StructureDefinition/codeOptions').exists() xor code.coding.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DeviceRequest 0..* USQualityCoreDeviceRequest Medical device request
... modifierExtension 1..* Extension Extension
... Slices for modifierExtension Content/Rules for all slices
.... modifierExtension:doNotPerform 1..1 R5 DeviceRequest.doNotPerform (USCDI+ Quality) Extension
..... value[x] 1..1 boolean Value of extension
Fixed Value: true
... authoredOn 1..1 dateTime (USCDI+ Quality) When recorded

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DeviceRequest.reasonCode Base extensible US Quality Core Negation Reason Codes 📦1.0.0-ballot This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DeviceRequest C 0..* USQualityCoreDeviceRequest Medical device request
Constraints: drq-3
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... Slices for modifierExtension ?! 1..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:doNotPerform ?! 1..1 (Complex) (USCDI+ Quality) Extension
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceRequest.doNotPerform
Constraints: ext-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceRequest.doNotPerform"
..... value[x] 1..1 boolean Value of extension
Fixed Value: true
... identifier Σ 0..* Identifier External Request identifier
... instantiatesCanonical Σ 0..* canonical(ActivityDefinition | PlanDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(Resource) What request fulfills
... priorRequest Σ 0..* Reference(Resource) What request replaces
... groupIdentifier Σ 0..1 Identifier Identifier of composite request
... status ?!Σ 0..1 code (USCDI+ Quality) draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Codes representing the status of the request.
... intent ?!Σ 1..1 code (USCDI+ Quality) proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of diagnostic request.
... priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... Slices for code[x] ΣC 1..1 (USCDI+ Quality) Device requested
Slice: Unordered, Open by type:$this
Binding: FHIRDeviceTypes (preferred)
.... codeReference Reference(US Core Device Profile(9.0.0))
.... codeCodeableConcept CodeableConcept
.... code[x]:codeCodeableConcept Σ 0..1 CodeableConcept Device requested
Binding: FHIRDeviceTypes (example): Codes for devices that can be requested.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for extension Content/Rules for all slices
...... extension:codeOptions C 0..1 canonical(ValueSet) (USCDI+ Quality) Url of a value set of candidate devices
URL: http://hl7.org/fhir/StructureDefinition/codeOptions
..... coding Σ 0..* Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
... parameter 0..* BackboneElement Device details
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 0..1 CodeableConcept Device detail
Binding Description: (example): A code that identifies the device detail.
.... value[x] 0..1 Value of detail
..... valueCodeableConcept CodeableConcept
..... valueQuantity Quantity
..... valueRange Range
..... valueBoolean boolean
... subject Σ 1..1 Reference(US Quality Core Patient) Focus of request
... encounter Σ 0..1 Reference(Encounter) Encounter motivating request
... occurrence[x] Σ 0..1 Desired time or schedule for use
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... authoredOn Σ 1..1 dateTime (USCDI+ Quality) When recorded
... requester Σ 0..1 Reference(Device | Practitioner | PractitionerRole | Organization) (USCDI+ Quality) Who/what is requesting diagnostics
... performerType Σ 0..1 CodeableConcept Filler role
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
... performer Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Requested Filler
... reasonCode Σ 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: US Quality Core Negation Reason Codes (extensible)
... 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 0..* Annotation Notes or comments
... relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DeviceRequest.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DeviceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
DeviceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
DeviceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
DeviceRequest.code[x] Base preferred FHIR Device Types 📦4.0.1 FHIR Std.
DeviceRequest.code[x]:codeCodeableConcept Base example FHIR Device Types 📍4.0.1 FHIR Std.
DeviceRequest.parameter.​code Base example Not State Unknown
DeviceRequest.performerType Base example Participant Roles 📍4.0.1 FHIR Std.
DeviceRequest.reasonCode Base extensible US Quality Core Negation Reason Codes 📦1.0.0-ballot This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error DeviceRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DeviceRequest If 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-4 error DeviceRequest If 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-5 error DeviceRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DeviceRequest A resource should have narrative for robust management text.`div`.exists()
drq-3 error DeviceRequest to indicate what device, either at least one coding in the code or a codeOptions extension shall be provided (code is Reference).not() implies code.extension('http://hl7.org/fhir/StructureDefinition/codeOptions').exists() xor code.coding.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Mandatory: 4 elements
Fixed: 1 element

Maturity: 4

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DeviceRequest C 0..* USQualityCoreDeviceRequest Medical device request
Constraints: drq-3
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for modifierExtension ?! 1..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:doNotPerform ?! 1..1 (Complex) (USCDI+ Quality) Extension
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceRequest.doNotPerform
Constraints: ext-1
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceRequest.doNotPerform"
..... value[x] 1..1 boolean Value of extension
Fixed Value: true
... status ?!Σ 0..1 code (USCDI+ Quality) draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Codes representing the status of the request.
... Slices for code[x] ΣC 1..1 (USCDI+ Quality) Device requested
Slice: Unordered, Open by type:$this
Binding: FHIRDeviceTypes (preferred)
.... codeReference Reference(US Core Device Profile(9.0.0))
.... codeCodeableConcept CodeableConcept
.... code[x]:codeCodeableConcept Σ 0..1 CodeableConcept Device requested
Binding: FHIRDeviceTypes (example): Codes for devices that can be requested.
..... Slices for extension Content/Rules for all slices
...... extension:codeOptions C 0..1 canonical(ValueSet) (USCDI+ Quality) Url of a value set of candidate devices
URL: http://hl7.org/fhir/StructureDefinition/codeOptions
... subject Σ 1..1 Reference(US Quality Core Patient) Focus of request
... authoredOn Σ 1..1 dateTime (USCDI+ Quality) When recorded
... reasonCode Σ 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: US Quality Core Negation Reason Codes (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DeviceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
DeviceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
DeviceRequest.code[x] Base preferred FHIR Device Types 📦4.0.1 FHIR Std.
DeviceRequest.code[x]:codeCodeableConcept Base example FHIR Device Types 📍4.0.1 FHIR Std.
DeviceRequest.reasonCode Base extensible US Quality Core Negation Reason Codes 📦1.0.0-ballot This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error DeviceRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DeviceRequest If 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-4 error DeviceRequest If 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-5 error DeviceRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DeviceRequest A resource should have narrative for robust management text.`div`.exists()
drq-3 error DeviceRequest to indicate what device, either at least one coding in the code or a codeOptions extension shall be provided (code is Reference).not() implies code.extension('http://hl7.org/fhir/StructureDefinition/codeOptions').exists() xor code.coding.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DeviceRequest 0..* USQualityCoreDeviceRequest Medical device request
... modifierExtension 1..* Extension Extension
... Slices for modifierExtension Content/Rules for all slices
.... modifierExtension:doNotPerform 1..1 R5 DeviceRequest.doNotPerform (USCDI+ Quality) Extension
..... value[x] 1..1 boolean Value of extension
Fixed Value: true
... authoredOn 1..1 dateTime (USCDI+ Quality) When recorded

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DeviceRequest.reasonCode Base extensible US Quality Core Negation Reason Codes 📦1.0.0-ballot This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DeviceRequest C 0..* USQualityCoreDeviceRequest Medical device request
Constraints: drq-3
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... Slices for modifierExtension ?! 1..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:doNotPerform ?! 1..1 (Complex) (USCDI+ Quality) Extension
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceRequest.doNotPerform
Constraints: ext-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-DeviceRequest.doNotPerform"
..... value[x] 1..1 boolean Value of extension
Fixed Value: true
... identifier Σ 0..* Identifier External Request identifier
... instantiatesCanonical Σ 0..* canonical(ActivityDefinition | PlanDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(Resource) What request fulfills
... priorRequest Σ 0..* Reference(Resource) What request replaces
... groupIdentifier Σ 0..1 Identifier Identifier of composite request
... status ?!Σ 0..1 code (USCDI+ Quality) draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Codes representing the status of the request.
... intent ?!Σ 1..1 code (USCDI+ Quality) proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of diagnostic request.
... priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... Slices for code[x] ΣC 1..1 (USCDI+ Quality) Device requested
Slice: Unordered, Open by type:$this
Binding: FHIRDeviceTypes (preferred)
.... codeReference Reference(US Core Device Profile(9.0.0))
.... codeCodeableConcept CodeableConcept
.... code[x]:codeCodeableConcept Σ 0..1 CodeableConcept Device requested
Binding: FHIRDeviceTypes (example): Codes for devices that can be requested.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for extension Content/Rules for all slices
...... extension:codeOptions C 0..1 canonical(ValueSet) (USCDI+ Quality) Url of a value set of candidate devices
URL: http://hl7.org/fhir/StructureDefinition/codeOptions
..... coding Σ 0..* Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
... parameter 0..* BackboneElement Device details
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 0..1 CodeableConcept Device detail
Binding Description: (example): A code that identifies the device detail.
.... value[x] 0..1 Value of detail
..... valueCodeableConcept CodeableConcept
..... valueQuantity Quantity
..... valueRange Range
..... valueBoolean boolean
... subject Σ 1..1 Reference(US Quality Core Patient) Focus of request
... encounter Σ 0..1 Reference(Encounter) Encounter motivating request
... occurrence[x] Σ 0..1 Desired time or schedule for use
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... authoredOn Σ 1..1 dateTime (USCDI+ Quality) When recorded
... requester Σ 0..1 Reference(Device | Practitioner | PractitionerRole | Organization) (USCDI+ Quality) Who/what is requesting diagnostics
... performerType Σ 0..1 CodeableConcept Filler role
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
... performer Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Requested Filler
... reasonCode Σ 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: US Quality Core Negation Reason Codes (extensible)
... 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 0..* Annotation Notes or comments
... relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DeviceRequest.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DeviceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
DeviceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
DeviceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
DeviceRequest.code[x] Base preferred FHIR Device Types 📦4.0.1 FHIR Std.
DeviceRequest.code[x]:codeCodeableConcept Base example FHIR Device Types 📍4.0.1 FHIR Std.
DeviceRequest.parameter.​code Base example Not State Unknown
DeviceRequest.performerType Base example Participant Roles 📍4.0.1 FHIR Std.
DeviceRequest.reasonCode Base extensible US Quality Core Negation Reason Codes 📦1.0.0-ballot This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error DeviceRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DeviceRequest If 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-4 error DeviceRequest If 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-5 error DeviceRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DeviceRequest A resource should have narrative for robust management text.`div`.exists()
drq-3 error DeviceRequest to indicate what device, either at least one coding in the code or a codeOptions extension shall be provided (code is Reference).not() implies code.extension('http://hl7.org/fhir/StructureDefinition/codeOptions').exists() xor code.coding.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Mandatory: 4 elements
Fixed: 1 element

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Element Conformance Indicators by Profile Layer

Badges identify the profile layer where each conformance indicator is first introduced. Indicators introduced in an earlier layer remain applicable in later derived profiles.

Element conformance indicators organized by the profile layer where they are first introduced
Profile element FHIR US Quality Core
modifierExtension Mandatory
modifierExtension:doNotPerform Mandatory USCDI+ Quality
modifierExtension:doNotPerform.url Mandatory
modifierExtension:doNotPerform.value[x] Mandatory
status USCDI+ Quality
intent Mandatory USCDI+ Quality
code[x] Mandatory USCDI+ Quality
code[x]:codeCodeableConcept.extension:codeOptions USCDI+ Quality
subject Mandatory
authoredOn Mandatory USCDI+ Quality
requester USCDI+ Quality
reasonCode USCDI+ Quality

Cardinality note: “Mandatory” means the element has a minimum cardinality greater than zero. For nested elements, the cardinality indicator applies when the containing element is present.

Mandatory US Quality Core Server Search Parameters

The searches below are the focused set identified by US Quality Core as needed to retrieve USCDI+ Quality data for quality measurement and reporting. See the US Core FHIR RESTful Search API Requirements for detailed information on requirements by search parameter type.

See the US Quality Core Server CapabilityStatement for complete requirements for the underlying DeviceRequest resource and Search Requirement Selection for how this focused set was selected.

Servers supporting this profile SHALL support the following search parameters and search parameter combinations:

  1. SHALL support searching for all DeviceRequest resources for a patient using the patient search parameter.

    GET [base]/DeviceRequest?patient={Patient/}[id]

    Example:

    GET [base]/DeviceRequest?patient=Patient/example

    Implementation Notes: Fetches a bundle of US Quality Core Device Prohibited resources matching the specified search criteria. See how to search by reference.

    Rationale for inclusion: Supports patient-scoped retrieval of DeviceRequest resources for USCDI+ Quality workflows.

  2. SHALL support searching for all DeviceRequest resources for a patient using the combination of the patient and code search parameters.

    • Including optional support for OR search on code (e.g.code={system|}[search_code],{system|}[search_code],...).

    GET [base]/DeviceRequest?patient={Patient/}[id]&code={system|}[search_code]

    Example:

    GET [base]/DeviceRequest?patient=Patient/example&code=http://snomed.info/sct|86184003

    Implementation Notes: Fetches a bundle of US Quality Core Device Prohibited resources matching the specified search criteria. See how to search by reference and how to search by token.

    Rationale for inclusion: Supports patient-scoped retrieval of DeviceRequest resources filtered by code for USCDI+ Quality workflows.

  3. SHALL support searching for all DeviceRequest resources for a patient using the combination of the patient and do-not-perform search parameters.

    • Including optional support for OR search on do-not-perform (e.g.do-not-perform=[true|false],[true|false],...).

    GET [base]/DeviceRequest?patient={Patient/}[id]&do-not-perform=[true|false]

    Example:

    GET [base]/DeviceRequest?patient=Patient/example&do-not-perform=true

    Implementation Notes: Fetches a bundle of US Quality Core Device Prohibited resources matching the specified search criteria. See how to search by reference and how to search by token.

    Rationale for inclusion: Supports patient-scoped retrieval of DeviceRequest resources filtered by a do-not-perform indicator to support negation workflows.