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

D.4.1 StructureDefinition-qicore-devicenotrequested

Introduction:

See the patterns page for implementation and usage patterns.

Examples:

Negation Example

D.4.1.1 Formal Views of Profile Content

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:

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceRequest I0..*DeviceRequestMedical device request
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... qicore-doNotPerformReason SI1..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-doNotPerformReason
Binding: Negation Reason Codes (extensible)
... modifierExtension ?!I0..*(Slice Definition)Extension
Slice: Unordered, Open by value:url
... modifierExtension:doNotPerform ?!SI1..1doNotPerformtrue if request is prohibiting action
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/request-doNotPerform"
.... value[x] SI1..1booleanValue of extension
Fixed Value: true
... identifier ΣI0..*IdentifierExternal Request identifier
... instantiatesCanonical ΣI0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri ΣI0..*uriInstantiates external protocol or definition
... basedOn ΣI0..*Reference(Resource)What request fulfills
... priorRequest ΣI0..*Reference(Resource)What request replaces
... groupIdentifier ΣI0..1IdentifierIdentifier of composite request
... status ?!SΣI1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required)
Fixed Value: completed
... intent ?!SΣI1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required)
... priority ΣI0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... code[x] SΣI1..1CodeableConceptDevice requested
Binding: FHIRDeviceTypes (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*CodingCode defined by a terminology system
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... valueset-reference SI1..1uriWhat was not done
URL: http://hl7.org/fhir/StructureDefinition/valueset-reference
..... system ΣI0..1uriIdentity of the terminology system
..... version ΣI0..1stringVersion of the system - if relevant
..... code ΣI0..1codeSymbol in syntax defined by the system
..... display ΣI0..1stringRepresentation defined by the system
..... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text ΣI0..1stringPlain text representation of the concept
... parameter I0..*BackboneElementDevice details
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code I0..1CodeableConceptDevice detail
Binding: (unbound) (example)
.... value[x] I0..1Value of detail
..... valueCodeableConceptCodeableConcept
..... valueQuantityQuantity
..... valueRangeRange
..... valueBooleanboolean
... subject SΣI1..1Reference(QICorePatient)Focus of request
... encounter SΣI0..1Reference(QICoreEncounter)Encounter motivating request
... occurrence[x] ΣI0..1Desired time or schedule for use
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
.... occurrenceTimingTiming
... authoredOn SΣI1..1dateTimeWhen recorded
... requester ΣI0..1Reference(Device | Practitioner | PractitionerRole | Organization)Who/what is requesting diagnostics
... performerType ΣI0..1CodeableConceptFiller role
Binding: ParticipantRoles (example)
... performer ΣI0..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Requested Filler
... reasonCode ΣI0..*CodeableConceptCoded Reason for request
Binding: Condition/Problem/DiagnosisCodes (example)
... reasonReference ΣI0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Linked Reason for request
... insurance I0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... supportingInfo I0..*Reference(Resource)Additional clinical information
... note SI0..*AnnotationNotes or comments
... relevantHistory I0..*Reference(Provenance)Request provenance

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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceRequest I0..*DeviceRequestMedical device request
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... qicore-doNotPerformReason SI1..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-doNotPerformReason
Binding: Negation Reason Codes (extensible)
... modifierExtension ?!I0..*(Slice Definition)Extension
Slice: Unordered, Open by value:url
... modifierExtension:doNotPerform ?!SI1..1doNotPerformtrue if request is prohibiting action
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/request-doNotPerform"
.... value[x] SI1..1booleanValue of extension
Fixed Value: true
... identifier ΣI0..*IdentifierExternal Request identifier
... instantiatesCanonical ΣI0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri ΣI0..*uriInstantiates external protocol or definition
... basedOn ΣI0..*Reference(Resource)What request fulfills
... priorRequest ΣI0..*Reference(Resource)What request replaces
... groupIdentifier ΣI0..1IdentifierIdentifier of composite request
... status ?!SΣI1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required)
Fixed Value: completed
... intent ?!SΣI1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required)
... priority ΣI0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... code[x] SΣI1..1CodeableConceptDevice requested
Binding: FHIRDeviceTypes (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*CodingCode defined by a terminology system
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... valueset-reference SI1..1uriWhat was not done
URL: http://hl7.org/fhir/StructureDefinition/valueset-reference
..... system ΣI0..1uriIdentity of the terminology system
..... version ΣI0..1stringVersion of the system - if relevant
..... code ΣI0..1codeSymbol in syntax defined by the system
..... display ΣI0..1stringRepresentation defined by the system
..... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text ΣI0..1stringPlain text representation of the concept
... parameter I0..*BackboneElementDevice details
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code I0..1CodeableConceptDevice detail
Binding: (unbound) (example)
.... value[x] I0..1Value of detail
..... valueCodeableConceptCodeableConcept
..... valueQuantityQuantity
..... valueRangeRange
..... valueBooleanboolean
... subject SΣI1..1Reference(QICorePatient)Focus of request
... encounter SΣI0..1Reference(QICoreEncounter)Encounter motivating request
... occurrence[x] ΣI0..1Desired time or schedule for use
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
.... occurrenceTimingTiming
... authoredOn SΣI1..1dateTimeWhen recorded
... requester ΣI0..1Reference(Device | Practitioner | PractitionerRole | Organization)Who/what is requesting diagnostics
... performerType ΣI0..1CodeableConceptFiller role
Binding: ParticipantRoles (example)
... performer ΣI0..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Requested Filler
... reasonCode ΣI0..*CodeableConceptCoded Reason for request
Binding: Condition/Problem/DiagnosisCodes (example)
... reasonReference ΣI0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Linked Reason for request
... insurance I0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... supportingInfo I0..*Reference(Resource)Additional clinical information
... note SI0..*AnnotationNotes or comments
... relevantHistory I0..*Reference(Provenance)Request provenance

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

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

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2DeviceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3DeviceRequestIf 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-4DeviceRequestIf 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-5DeviceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6DeviceRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1DeviceRequest.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DeviceRequest.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DeviceRequest.extension:doNotPerformReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DeviceRequest.extension:doNotPerformReasonMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DeviceRequest.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DeviceRequest.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DeviceRequest.modifierExtension:doNotPerformAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DeviceRequest.modifierExtension:doNotPerformMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DeviceRequest.modifierExtension:doNotPerform.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.instantiatesCanonicalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.instantiatesUriAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.basedOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.priorRequestAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.groupIdentifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.intentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.priorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.code[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.code[x].extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DeviceRequest.code[x].extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DeviceRequest.code[x].codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.code[x].coding.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DeviceRequest.code[x].coding.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DeviceRequest.code[x].coding.extension:doNotPerformValueSetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DeviceRequest.code[x].coding.extension:doNotPerformValueSetMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DeviceRequest.code[x].coding.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.code[x].coding.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.code[x].coding.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.code[x].coding.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.code[x].coding.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.code[x].textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.parameterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.parameter.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DeviceRequest.parameter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DeviceRequest.parameter.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DeviceRequest.parameter.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DeviceRequest.parameter.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.parameter.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.occurrence[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.authoredOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.requesterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.performerTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.performerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.reasonCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.reasonReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.insuranceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.supportingInfoAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DeviceRequest.relevantHistoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())