QI-Core Implementation Guide
6.0.0 - STU6 United States of America flag

This page is part of the Quality Improvement Core Framework (v6.0.0: STU6 (v6.0.0)) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: QICore Service Not Requested

Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-servicenotrequested Version: 6.0.0
Active as of 2018-08-22 Computable Name: QICoreServiceNotRequested

Negation profile of ServiceRequest for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

Contents:

Guidance

Reference Guidance for use of the Service Not Requested profile can be found here.

  • See the Social Determinants of Health (SDOH) Guidance Page for more information when exchanging Social Determinants of Health (SDOH) Service Requests.
  • The ServiceRequest.category binding must support at a minimum the US Core ServiceRequest Category Codes. However, this valueset can be treated as extensible and other category codes can be used instead.
  • The ServiceRequest.code.extension:notDoneValueSet valueset identifies a set of possible coded values representing activities that were not requested, ordered, or performed.
  • The ServiceRequest.subject is Must Support with Must Support reference to QI-Core Patient

Usage

The ServiceRequest and ServiceNotRequested profiles represent the positive and negative statements for a service request.

See the patterns page for implementation and usage patterns.

Examples

Negation Example with valuesetService discontinued; indicates that none of the services in the given not done value set were requested.
Negation Example with codeService discontinued; indicates that the given service, by code, was not requested.

Both of these example instances meet measure intent for exclusion as defined in the following example CQL: 

define "Intermittent Pneumatic Compression Devices Not Ordered":
  ["ServiceNotRequested": "Application of intermittent pneumatic compression devices (IPC)"] DeviceNotOrdered
    where (DeviceNotOrdered.reasonRefused in "Medical Reason"
      or DeviceNotOrdered.reasonRefused in "Patient Refusal")
      and DeviceNotOrdered.status in { 'active', 'completed', 'on-hold' }

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

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from USCoreServiceRequestProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*USCoreServiceRequestProfileA request for a service to be performed
snr-1: to indicate what service was not performed, either at least one coding in the code or a notDoneValueSet extension shall be provided
... reasonRefused 1..1CodeableConcept(QI-Core) Extension
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-doNotPerformReason
Binding: QICore Negation Reason Codes (extensible): The reason the event did not occur or was not performed

... status 1..1code(QI-Core)(USCDI) draft | active | on-hold | revoked | completed | entered-in-error | unknown
... doNotPerform 1..1boolean(QI-Core) True if service/procedure should not be performed
Fixed Value: true
.... notDoneValueSet C0..1canonical(ValueSet)(QI-Core) What was not requested
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet
... subject 1..1Reference(QICore Patient)(QI-Core)(USCDI) Individual or Entity the service is ordered for
... occurrence[x] 0..1(QI-Core)(USCDI) When service should occur
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
.... occurrenceTimingTiming
... authoredOn 1..1dateTime(QI-Core)(USCDI) Date request signed
... requester 0..1Reference(QICore Practitioner | QICore PractitionerRole | QICore Organization | QICore Patient | QICore RelatedPerson | QICore Device | US Core Implantable Device Profile)(USCDI) Who/what is requesting service
... reasonCode 0..*CodeableConcept(QI-Core)(USCDI) Explanation/Justification for procedure or service
Binding: US Core Condition Codes (extensible)
... reasonReference Σ0..*Reference(QICore Condition Encounter Diagnosis | QICore Condition Problems Health Concerns)(QI-Core)(USCDI) Explanation/Justification for service or service

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ServiceRequest.reasonCodeextensibleUSCoreConditionCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code

Constraints

IdGradePath(s)DetailsRequirements
snr-1errorServiceRequestto indicate what service was not performed, 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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*USCoreServiceRequestProfileA request for a service to be performed
prr-1: orderDetail SHALL only be present if code is present
snr-1: to indicate what service was not performed, either at least one coding in the code or a notDoneValueSet extension shall be provided
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... reasonRefused 1..1CodeableConcept(QI-Core) Extension
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-doNotPerformReason
Binding: QICore Negation Reason Codes (extensible): The reason the event did not occur or was not performed


... status ?!SΣ1..1code(QI-Core)(USCDI) draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

... intent ?!SΣ1..1code(USCDI) proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.

... Slices for category SΣ0..*CodeableConcept(USCDI) Classification of service
Slice: Unordered, Open by pattern:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


.... category:us-core SΣ0..*CodeableConcept(USCDI) Classification of service
Binding: US Core ServiceRequest Category Codes (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets


... doNotPerform ?!Σ1..1boolean(QI-Core) True if service/procedure should not be performed
Fixed Value: true
... code SΣ1..1CodeableConcept(USCDI) What is being requested/ordered
Binding: US Core Procedure Codes (extensible)
.... notDoneValueSet C0..1canonical(ValueSet)(QI-Core) What was not requested
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet
... subject SΣ1..1Reference(QICore Patient)(QI-Core)(USCDI) Individual or Entity the service is ordered for
... occurrence[x] SΣ0..1(QI-Core)(USCDI) When service should occur
.... occurrencePeriodPeriod
... authoredOn SΣ1..1dateTime(QI-Core)(USCDI) Date request signed
... requester SΣ0..1Reference(QICore Practitioner | QICore PractitionerRole | QICore Organization | QICore Patient | QICore RelatedPerson | QICore Device | US Core Implantable Device Profile)(USCDI) Who/what is requesting service
... reasonCode Σ0..*CodeableConcept(QI-Core)(USCDI) Explanation/Justification for procedure or service
Binding: US Core Condition Codes (extensible)
... reasonReference Σ0..*Reference(QICore Condition Encounter Diagnosis | QICore Condition Problems Health Concerns)(QI-Core)(USCDI) Explanation/Justification for service or service

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.category:us-corerequiredUSCoreServiceRequestCategoryCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category
ServiceRequest.codeextensibleUSCoreProcedureCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code
ServiceRequest.reasonCodeextensibleUSCoreConditionCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf 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-4errorServiceRequestIf 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-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()
snr-1errorServiceRequestto indicate what service was not performed, 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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*USCoreServiceRequestProfileA request for a service to be performed
prr-1: orderDetail SHALL only be present if code is present
snr-1: to indicate what service was not performed, either at least one coding in the code or a notDoneValueSet extension shall be provided
... id Σ0..1idLogical 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): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... reasonRefused 1..1CodeableConcept(QI-Core) Extension
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-doNotPerformReason
Binding: QICore Negation Reason Codes (extensible): The reason the event did not occur or was not performed


... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifiers assigned to this order
... instantiatesCanonical Σ0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(CarePlan | ServiceRequest | MedicationRequest)What request fulfills
... replaces Σ0..*Reference(ServiceRequest)What request replaces
... requisition Σ0..1IdentifierComposite Request ID
... status ?!SΣ1..1code(QI-Core)(USCDI) draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

... intent ?!SΣ1..1code(USCDI) proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.

... Slices for category SΣ0..*CodeableConcept(USCDI) Classification of service
Slice: Unordered, Open by pattern:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


.... category:us-core SΣ0..*CodeableConcept(USCDI) Classification of service
Binding: US Core ServiceRequest Category Codes (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets


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

... doNotPerform ?!Σ1..1boolean(QI-Core) True if service/procedure should not be performed
Fixed Value: true
... code SΣ1..1CodeableConcept(USCDI) What is being requested/ordered
Binding: US Core Procedure Codes (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... notDoneValueSet C0..1canonical(ValueSet)(QI-Core) What was not requested
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
... orderDetail ΣC0..*CodeableConceptAdditional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.


... quantity[x] Σ0..1Service amount
.... quantityQuantityQuantity
.... quantityRatioRatio
.... quantityRangeRange
... subject SΣ1..1Reference(QICore Patient)(QI-Core)(USCDI) Individual or Entity the service is ordered for
... encounter Σ0..1Reference(Encounter)Encounter in which the request was created
... occurrence[x] SΣ0..1(QI-Core)(USCDI) When service should occur
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod S
.... occurrenceTimingTiming
... asNeeded[x] Σ0..1Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.

.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... authoredOn SΣ1..1dateTime(QI-Core)(USCDI) Date request signed
... requester SΣ0..1Reference(QICore Practitioner | QICore PractitionerRole | QICore Organization | QICore Patient | QICore RelatedPerson | QICore Device | US Core Implantable Device Profile)(USCDI) Who/what is requesting service
... performerType Σ0..1CodeableConceptPerformer role
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.

... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Requested performer
... locationCode Σ0..*CodeableConceptRequested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.


... locationReference Σ0..*Reference(Location)Requested location
... reasonCode Σ0..*CodeableConcept(QI-Core)(USCDI) Explanation/Justification for procedure or service
Binding: US Core Condition Codes (extensible)
... reasonReference Σ0..*Reference(QICore Condition Encounter Diagnosis | QICore Condition Problems Health Concerns)(QI-Core)(USCDI) Explanation/Justification for service or service
... insurance 0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... supportingInfo 0..*Reference(Resource)Additional clinical information
... specimen Σ0..*Reference(Specimen)Procedure Samples
... bodySite Σ0..*CodeableConceptLocation on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


... note 0..*AnnotationComments
... patientInstruction Σ0..1stringPatient or consumer-oriented instructions
... relevantHistory 0..*Reference(Provenance)Request provenance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ServiceRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.category:us-corerequiredUSCoreServiceRequestCategoryCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ServiceRequest.codeextensibleUSCoreProcedureCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
from the FHIR Standard
ServiceRequest.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard
ServiceRequest.performerTypeexampleParticipantRoles
http://hl7.org/fhir/ValueSet/participant-role
from the FHIR Standard
ServiceRequest.locationCodeexampleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
ServiceRequest.reasonCodeextensibleUSCoreConditionCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code
ServiceRequest.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf 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-4errorServiceRequestIf 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-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()
snr-1errorServiceRequestto indicate what service was not performed, 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()

Differential View

This structure is derived from USCoreServiceRequestProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*USCoreServiceRequestProfileA request for a service to be performed
snr-1: to indicate what service was not performed, either at least one coding in the code or a notDoneValueSet extension shall be provided
... reasonRefused 1..1CodeableConcept(QI-Core) Extension
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-doNotPerformReason
Binding: QICore Negation Reason Codes (extensible): The reason the event did not occur or was not performed

... status 1..1code(QI-Core)(USCDI) draft | active | on-hold | revoked | completed | entered-in-error | unknown
... doNotPerform 1..1boolean(QI-Core) True if service/procedure should not be performed
Fixed Value: true
.... notDoneValueSet C0..1canonical(ValueSet)(QI-Core) What was not requested
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet
... subject 1..1Reference(QICore Patient)(QI-Core)(USCDI) Individual or Entity the service is ordered for
... occurrence[x] 0..1(QI-Core)(USCDI) When service should occur
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
.... occurrenceTimingTiming
... authoredOn 1..1dateTime(QI-Core)(USCDI) Date request signed
... requester 0..1Reference(QICore Practitioner | QICore PractitionerRole | QICore Organization | QICore Patient | QICore RelatedPerson | QICore Device | US Core Implantable Device Profile)(USCDI) Who/what is requesting service
... reasonCode 0..*CodeableConcept(QI-Core)(USCDI) Explanation/Justification for procedure or service
Binding: US Core Condition Codes (extensible)
... reasonReference Σ0..*Reference(QICore Condition Encounter Diagnosis | QICore Condition Problems Health Concerns)(QI-Core)(USCDI) Explanation/Justification for service or service

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ServiceRequest.reasonCodeextensibleUSCoreConditionCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code

Constraints

IdGradePath(s)DetailsRequirements
snr-1errorServiceRequestto indicate what service was not performed, 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()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*USCoreServiceRequestProfileA request for a service to be performed
prr-1: orderDetail SHALL only be present if code is present
snr-1: to indicate what service was not performed, either at least one coding in the code or a notDoneValueSet extension shall be provided
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... reasonRefused 1..1CodeableConcept(QI-Core) Extension
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-doNotPerformReason
Binding: QICore Negation Reason Codes (extensible): The reason the event did not occur or was not performed


... status ?!SΣ1..1code(QI-Core)(USCDI) draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

... intent ?!SΣ1..1code(USCDI) proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.

... Slices for category SΣ0..*CodeableConcept(USCDI) Classification of service
Slice: Unordered, Open by pattern:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


.... category:us-core SΣ0..*CodeableConcept(USCDI) Classification of service
Binding: US Core ServiceRequest Category Codes (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets


... doNotPerform ?!Σ1..1boolean(QI-Core) True if service/procedure should not be performed
Fixed Value: true
... code SΣ1..1CodeableConcept(USCDI) What is being requested/ordered
Binding: US Core Procedure Codes (extensible)
.... notDoneValueSet C0..1canonical(ValueSet)(QI-Core) What was not requested
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet
... subject SΣ1..1Reference(QICore Patient)(QI-Core)(USCDI) Individual or Entity the service is ordered for
... occurrence[x] SΣ0..1(QI-Core)(USCDI) When service should occur
.... occurrencePeriodPeriod
... authoredOn SΣ1..1dateTime(QI-Core)(USCDI) Date request signed
... requester SΣ0..1Reference(QICore Practitioner | QICore PractitionerRole | QICore Organization | QICore Patient | QICore RelatedPerson | QICore Device | US Core Implantable Device Profile)(USCDI) Who/what is requesting service
... reasonCode Σ0..*CodeableConcept(QI-Core)(USCDI) Explanation/Justification for procedure or service
Binding: US Core Condition Codes (extensible)
... reasonReference Σ0..*Reference(QICore Condition Encounter Diagnosis | QICore Condition Problems Health Concerns)(QI-Core)(USCDI) Explanation/Justification for service or service

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.category:us-corerequiredUSCoreServiceRequestCategoryCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category
ServiceRequest.codeextensibleUSCoreProcedureCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code
ServiceRequest.reasonCodeextensibleUSCoreConditionCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf 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-4errorServiceRequestIf 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-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()
snr-1errorServiceRequestto indicate what service was not performed, 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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*USCoreServiceRequestProfileA request for a service to be performed
prr-1: orderDetail SHALL only be present if code is present
snr-1: to indicate what service was not performed, either at least one coding in the code or a notDoneValueSet extension shall be provided
... id Σ0..1idLogical 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): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... reasonRefused 1..1CodeableConcept(QI-Core) Extension
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-doNotPerformReason
Binding: QICore Negation Reason Codes (extensible): The reason the event did not occur or was not performed


... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifiers assigned to this order
... instantiatesCanonical Σ0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(CarePlan | ServiceRequest | MedicationRequest)What request fulfills
... replaces Σ0..*Reference(ServiceRequest)What request replaces
... requisition Σ0..1IdentifierComposite Request ID
... status ?!SΣ1..1code(QI-Core)(USCDI) draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

... intent ?!SΣ1..1code(USCDI) proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.

... Slices for category SΣ0..*CodeableConcept(USCDI) Classification of service
Slice: Unordered, Open by pattern:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


.... category:us-core SΣ0..*CodeableConcept(USCDI) Classification of service
Binding: US Core ServiceRequest Category Codes (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets


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

... doNotPerform ?!Σ1..1boolean(QI-Core) True if service/procedure should not be performed
Fixed Value: true
... code SΣ1..1CodeableConcept(USCDI) What is being requested/ordered
Binding: US Core Procedure Codes (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... notDoneValueSet C0..1canonical(ValueSet)(QI-Core) What was not requested
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
... orderDetail ΣC0..*CodeableConceptAdditional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.


... quantity[x] Σ0..1Service amount
.... quantityQuantityQuantity
.... quantityRatioRatio
.... quantityRangeRange
... subject SΣ1..1Reference(QICore Patient)(QI-Core)(USCDI) Individual or Entity the service is ordered for
... encounter Σ0..1Reference(Encounter)Encounter in which the request was created
... occurrence[x] SΣ0..1(QI-Core)(USCDI) When service should occur
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod S
.... occurrenceTimingTiming
... asNeeded[x] Σ0..1Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.

.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... authoredOn SΣ1..1dateTime(QI-Core)(USCDI) Date request signed
... requester SΣ0..1Reference(QICore Practitioner | QICore PractitionerRole | QICore Organization | QICore Patient | QICore RelatedPerson | QICore Device | US Core Implantable Device Profile)(USCDI) Who/what is requesting service
... performerType Σ0..1CodeableConceptPerformer role
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.

... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Requested performer
... locationCode Σ0..*CodeableConceptRequested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.


... locationReference Σ0..*Reference(Location)Requested location
... reasonCode Σ0..*CodeableConcept(QI-Core)(USCDI) Explanation/Justification for procedure or service
Binding: US Core Condition Codes (extensible)
... reasonReference Σ0..*Reference(QICore Condition Encounter Diagnosis | QICore Condition Problems Health Concerns)(QI-Core)(USCDI) Explanation/Justification for service or service
... insurance 0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... supportingInfo 0..*Reference(Resource)Additional clinical information
... specimen Σ0..*Reference(Specimen)Procedure Samples
... bodySite Σ0..*CodeableConceptLocation on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


... note 0..*AnnotationComments
... patientInstruction Σ0..1stringPatient or consumer-oriented instructions
... relevantHistory 0..*Reference(Provenance)Request provenance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ServiceRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.category:us-corerequiredUSCoreServiceRequestCategoryCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ServiceRequest.codeextensibleUSCoreProcedureCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
from the FHIR Standard
ServiceRequest.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard
ServiceRequest.performerTypeexampleParticipantRoles
http://hl7.org/fhir/ValueSet/participant-role
from the FHIR Standard
ServiceRequest.locationCodeexampleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
ServiceRequest.reasonCodeextensibleUSCoreConditionCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code
ServiceRequest.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf 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-4errorServiceRequestIf 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-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()
snr-1errorServiceRequestto indicate what service was not performed, 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()

 

Other representations of profile: CSV, Excel, Schematron