QI-Core Implementation Guide: STU 4 (v4.0.0 for FHIR 4.0.1)
QI-Core Implementation Guide - This is the current published version.. See the Directory of published versions
| Negation Example |
The official URL for this profile is:
http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-devicenotrequested
Profile of DeviceRequest for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.
This profile builds on DeviceRequest.
This profile was published on Thu Jul 11 00:00:00 UTC 2019 as a draft by Health Level Seven, Inc. - CQI WG.
Description of Profiles, Differentials, and Snapshots.
Summary
Mandatory: 6 elements (1 nested mandatory element)
Must-Support: 11 elements
Fixed Value: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  DeviceRequest | 0..* | DeviceRequest | ||
  qicore-doNotPerformReason | S | 1..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-doNotPerformReason Binding: Negation Reason Codes (extensible) |
| modifierExtension:doNotPerform | ?!S | 1..1 | doNotPerform | |
   value[x] | S | 1..1 | boolean | Fixed Value: true |
| status | S | 1..1 | code | Fixed Value: completed |
 intent | S | 1..1 | code | |
 code[x] | S | 1..1 | CodeableConcept | |
 coding | 0..* | Coding | ||
 valueset-reference | S | 1..1 | uri | What was not done URL: http://hl7.org/fhir/StructureDefinition/valueset-reference |
 subject | S | 1..1 | Reference(QICorePatient) | |
| encounter | S | 0..1 | Reference(QICoreEncounter) | |
| authoredOn | S | 1..1 | dateTime | |
| note | S | 0..* | Annotation | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DeviceRequest | I | 0..* | DeviceRequest | Medical device request |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| qicore-doNotPerformReason | SI | 1..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-doNotPerformReason Binding: Negation Reason Codes (extensible) |
 modifierExtension | ?!I | 0..* | (Slice Definition) | Extension Slice: Unordered, Open by value:url |
| modifierExtension:doNotPerform | ?!SI | 1..1 | doNotPerform | true if request is prohibiting action |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..0 | ||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/request-doNotPerform" | |
| value[x] | SI | 1..1 | boolean | Value of extension Fixed Value: true |
| identifier | ΣI | 0..* | Identifier | External Request identifier |
| instantiatesCanonical | ΣI | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition |
| instantiatesUri | ΣI | 0..* | uri | Instantiates external protocol or definition |
| basedOn | ΣI | 0..* | Reference(Resource) | What request fulfills |
| priorRequest | ΣI | 0..* | Reference(Resource) | What request replaces |
| groupIdentifier | ΣI | 0..1 | Identifier | Identifier of composite request |
| status | ?!SΣI | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required) Fixed Value: completed |
| intent | ?!SΣI | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required) |
| priority | ΣI | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
| code[x] | SΣI | 1..1 | CodeableConcept | Device requested Binding: FHIRDeviceTypes (example) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| valueset-reference | SI | 1..1 | uri | What was not done URL: http://hl7.org/fhir/StructureDefinition/valueset-reference |
| system | ΣI | 0..1 | uri | Identity of the terminology system |
| version | ΣI | 0..1 | string | Version of the system - if relevant |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system |
| display | ΣI | 0..1 | string | Representation defined by the system |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user |
| text | ΣI | 0..1 | string | Plain text representation of the concept |
| parameter | I | 0..* | BackboneElement | Device details |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | I | 0..1 | CodeableConcept | Device detail Binding: (unbound) (example) |
 value[x] | I | 0..1 | Value of detail | |
| valueCodeableConcept | CodeableConcept | |||
| valueQuantity | Quantity | |||
| valueRange | Range | |||
| valueBoolean | boolean | |||
| subject | SΣI | 1..1 | Reference(QICorePatient) | Focus of request |
| encounter | SΣI | 0..1 | Reference(QICoreEncounter) | Encounter motivating request |
| occurrence[x] | ΣI | 0..1 | Desired time or schedule for use | |
| occurrenceDateTime | dateTime | |||
| occurrencePeriod | Period | |||
| occurrenceTiming | Timing | |||
| authoredOn | SΣI | 1..1 | dateTime | When recorded |
| requester | ΣI | 0..1 | Reference(Device | Practitioner | PractitionerRole | Organization) | Who/what is requesting diagnostics |
| performerType | ΣI | 0..1 | CodeableConcept | Filler role Binding: ParticipantRoles (example) |
| performer | ΣI | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested Filler |
| reasonCode | ΣI | 0..* | CodeableConcept | Coded Reason for request Binding: Condition/Problem/DiagnosisCodes (example) |
| reasonReference | ΣI | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Linked Reason for request |
| insurance | I | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage |
| supportingInfo | I | 0..* | Reference(Resource) | Additional clinical information |
| note | SI | 0..* | Annotation | Notes or comments |
| relevantHistory | I | 0..* | Reference(Provenance) | Request provenance |
| Documentation for this format | ||||
Summary
Mandatory: 6 elements (1 nested mandatory element)
Must-Support: 11 elements
Fixed Value: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DeviceRequest | 0..* | DeviceRequest | ||
| qicore-doNotPerformReason | S | 1..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-doNotPerformReason Binding: Negation Reason Codes (extensible) |
| modifierExtension:doNotPerform | ?!S | 1..1 | doNotPerform | |
| value[x] | S | 1..1 | boolean | Fixed Value: true |
| status | S | 1..1 | code | Fixed Value: completed |
| intent | S | 1..1 | code | |
| code[x] | S | 1..1 | CodeableConcept | |
| coding | 0..* | Coding | ||
| valueset-reference | S | 1..1 | uri | What was not done URL: http://hl7.org/fhir/StructureDefinition/valueset-reference |
| subject | S | 1..1 | Reference(QICorePatient) | |
| encounter | S | 0..1 | Reference(QICoreEncounter) | |
| authoredOn | S | 1..1 | dateTime | |
| note | S | 0..* | Annotation | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DeviceRequest | I | 0..* | DeviceRequest | Medical device request |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| qicore-doNotPerformReason | SI | 1..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-doNotPerformReason Binding: Negation Reason Codes (extensible) |
| modifierExtension | ?!I | 0..* | (Slice Definition) | Extension Slice: Unordered, Open by value:url |
| modifierExtension:doNotPerform | ?!SI | 1..1 | doNotPerform | true if request is prohibiting action |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..0 | ||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/request-doNotPerform" | |
| value[x] | SI | 1..1 | boolean | Value of extension Fixed Value: true |
| identifier | ΣI | 0..* | Identifier | External Request identifier |
| instantiatesCanonical | ΣI | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition |
| instantiatesUri | ΣI | 0..* | uri | Instantiates external protocol or definition |
| basedOn | ΣI | 0..* | Reference(Resource) | What request fulfills |
| priorRequest | ΣI | 0..* | Reference(Resource) | What request replaces |
| groupIdentifier | ΣI | 0..1 | Identifier | Identifier of composite request |
| status | ?!SΣI | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required) Fixed Value: completed |
| intent | ?!SΣI | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required) |
| priority | ΣI | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
| code[x] | SΣI | 1..1 | CodeableConcept | Device requested Binding: FHIRDeviceTypes (example) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| valueset-reference | SI | 1..1 | uri | What was not done URL: http://hl7.org/fhir/StructureDefinition/valueset-reference |
| system | ΣI | 0..1 | uri | Identity of the terminology system |
| version | ΣI | 0..1 | string | Version of the system - if relevant |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system |
| display | ΣI | 0..1 | string | Representation defined by the system |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user |
| text | ΣI | 0..1 | string | Plain text representation of the concept |
| parameter | I | 0..* | BackboneElement | Device details |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | I | 0..1 | CodeableConcept | Device detail Binding: (unbound) (example) |
| value[x] | I | 0..1 | Value of detail | |
| valueCodeableConcept | CodeableConcept | |||
| valueQuantity | Quantity | |||
| valueRange | Range | |||
| valueBoolean | boolean | |||
| subject | SΣI | 1..1 | Reference(QICorePatient) | Focus of request |
| encounter | SΣI | 0..1 | Reference(QICoreEncounter) | Encounter motivating request |
| occurrence[x] | ΣI | 0..1 | Desired time or schedule for use | |
| occurrenceDateTime | dateTime | |||
| occurrencePeriod | Period | |||
| occurrenceTiming | Timing | |||
| authoredOn | SΣI | 1..1 | dateTime | When recorded |
| requester | ΣI | 0..1 | Reference(Device | Practitioner | PractitionerRole | Organization) | Who/what is requesting diagnostics |
| performerType | ΣI | 0..1 | CodeableConcept | Filler role Binding: ParticipantRoles (example) |
| performer | ΣI | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested Filler |
| reasonCode | ΣI | 0..* | CodeableConcept | Coded Reason for request Binding: Condition/Problem/DiagnosisCodes (example) |
| reasonReference | ΣI | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Linked Reason for request |
| insurance | I | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage |
| supportingInfo | I | 0..* | Reference(Resource) | Additional clinical information |
| note | SI | 0..* | Annotation | Notes or comments |
| relevantHistory | I | 0..* | Reference(Provenance) | Request provenance |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| DeviceRequest.language | preferred | CommonLanguages Max Binding: AllLanguages |
| DeviceRequest.status | required | Fixed Value: completed |
| DeviceRequest.intent | required | RequestIntent |
| DeviceRequest.priority | required | RequestPriority |
| DeviceRequest.code[x] | example | FHIRDeviceTypes |
| DeviceRequest.parameter.code | example | |
| DeviceRequest.performerType | example | ParticipantRoles |
| DeviceRequest.reasonCode | example | Condition/Problem/DiagnosisCodes |
| Id | Path | Details | Requirements |
| dom-2 | DeviceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | 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 | 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 | DeviceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | DeviceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | DeviceRequest.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DeviceRequest.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DeviceRequest.extension:doNotPerformReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DeviceRequest.extension:doNotPerformReason | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DeviceRequest.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DeviceRequest.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DeviceRequest.modifierExtension:doNotPerform | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DeviceRequest.modifierExtension:doNotPerform | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DeviceRequest.modifierExtension:doNotPerform.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.instantiatesCanonical | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.instantiatesUri | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.basedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.priorRequest | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.groupIdentifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.intent | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.priority | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.code[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.code[x].extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DeviceRequest.code[x].extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DeviceRequest.code[x].coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.code[x].coding.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DeviceRequest.code[x].coding.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DeviceRequest.code[x].coding.extension:doNotPerformValueSet | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DeviceRequest.code[x].coding.extension:doNotPerformValueSet | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DeviceRequest.code[x].coding.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.code[x].coding.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.code[x].coding.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.code[x].coding.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.code[x].coding.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.code[x].text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.parameter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.parameter.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DeviceRequest.parameter.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DeviceRequest.parameter.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DeviceRequest.parameter.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DeviceRequest.parameter.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.parameter.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.occurrence[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.authoredOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.requester | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.performerType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.performer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.insurance | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.supportingInfo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DeviceRequest.relevantHistory | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
© HL7.org 2011+. (Clinical Quality Improvement WG). hl7.fhir.us.qicore#4.0.0 based on FHIR v4.0.1 Generated 2020-03-24.
Links: Home
| QA Report | Search
| Version History
| 
| Propose a change 