QI-Core Implementation Guide
6.0.0 - STU6
QI-Core Implementation Guide
6.0.0 - STU6
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. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-servicerequest | Version: 6.0.0 | |||
| Active as of 2018-08-22 | Computable Name: QICoreServiceRequest | |||
Profile of ServiceRequest for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.
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.ServiceRequest.code valueset is broad to accommodate a wide variety of use cases and should be constrained to a subset for a particular use case or domain. (for example, LOINC for laboratory orders.)ServiceRequest.subject is Must Support with Must Support reference to QI-Core PatientTo create an expression specifically requesting information that a ServiceRequest intentionally did not occur for a medical, patient or system reason, use the profile QICore-Servicenotrequested.
The following example illustrates the use of the ServiceRequest profile:
define "Intermittent Pneumatic Compression Devices Ordered":
["ServiceRequest": "Application of intermittent pneumatic compression devices (IPC)"] DeviceOrdered
where DeviceOrdered.status in { 'active', 'completed', 'on-hold' }
| Request for Appendectomy Example |
| Request for Myringotomy Procedure Example |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreServiceRequestProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ServiceRequest | 0..* | USCoreServiceRequestProfile | A request for a service to be performed dom-7: if doNotPerform is present, it SHALL be false | |
  status | 1..1 | code | (QI-Core)(USCDI) draft | active | on-hold | revoked | completed | entered-in-error | unknown | |
 doNotPerform | 0..1 | boolean | (QI-Core) True if service/procedure should not be performed Fixed Value: false | |
 subject | 1..1 | Reference(QICore Patient) | (QI-Core)(USCDI) Individual or Entity the service is ordered for | |
  occurrence[x] | 0..1 | (QI-Core)(USCDI) When service should occur | ||
 occurrenceDateTime | dateTime | |||
 occurrencePeriod | Period | |||
 occurrenceTiming | Timing | |||
| authoredOn | 0..1 | dateTime | (QI-Core)(USCDI) Date request signed | |
| requester | 0..1 | Reference(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 | |
| reasonReference | Σ | 0..* | Reference(QICore Condition Encounter Diagnosis | QICore Condition Problems Health Concerns) | (QI-Core)(USCDI) Explanation/Justification for service or service |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| dom-7 | error | ServiceRequest | if doNotPerform is present, it SHALL be false : doNotPerform.empty() or doNotPerform=false |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest | C | 0..* | USCoreServiceRequestProfile | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present dom-7: if doNotPerform is present, it SHALL be false |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!SΣ | 1..1 | code | (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..1 | code | (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 | ?!Σ | 0..1 | boolean | (QI-Core) True if service/procedure should not be performed Fixed Value: false |
| code | SΣ | 1..1 | CodeableConcept | (USCDI) What is being requested/ordered Binding: US Core Procedure Codes (extensible) |
| subject | SΣ | 1..1 | Reference(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 | |
| occurrencePeriod | Period | |||
| authoredOn | SΣ | 0..1 | dateTime | (QI-Core)(USCDI) Date request signed |
| requester | SΣ | 0..1 | Reference(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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | |
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | |
| ServiceRequest.category:us-core | required | USCoreServiceRequestCategoryCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category | |
| ServiceRequest.code | extensible | USCoreProcedureCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code | |
| ServiceRequest.reasonCode | extensible | USCoreConditionCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-condition-code |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | 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 | ServiceRequest | 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 | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| dom-7 | error | ServiceRequest | if doNotPerform is present, it SHALL be false : doNotPerform.empty() or doNotPerform=false | |
| 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() | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest | C | 0..* | USCoreServiceRequestProfile | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present dom-7: if doNotPerform is present, it SHALL be false | ||||
| 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.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Identifiers assigned to this order | ||||
| instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | ||||
| replaces | Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
| requisition | Σ | 0..1 | Identifier | Composite Request ID | ||||
| status | ?!SΣ | 1..1 | code | (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..1 | code | (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..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
| doNotPerform | ?!Σ | 0..1 | boolean | (QI-Core) True if service/procedure should not be performed Fixed Value: false | ||||
| code | SΣ | 1..1 | CodeableConcept | (USCDI) What is being requested/ordered Binding: US Core Procedure Codes (extensible) | ||||
| orderDetail | ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
| quantity[x] | Σ | 0..1 | Service amount | |||||
| quantityQuantity | Quantity | |||||||
| quantityRatio | Ratio | |||||||
| quantityRange | Range | |||||||
| subject | SΣ | 1..1 | Reference(QICore Patient) | (QI-Core)(USCDI) Individual or Entity the service is ordered for | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
| occurrence[x] | SΣ | 0..1 | (QI-Core)(USCDI) When service should occur | |||||
| occurrenceDateTime | dateTime | |||||||
| occurrencePeriod | Period S | |||||||
| occurrenceTiming | Timing | |||||||
| asNeeded[x] | Σ | 0..1 | Preconditions 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. | |||||
| asNeededBoolean | boolean | |||||||
| asNeededCodeableConcept | CodeableConcept | |||||||
| authoredOn | SΣ | 0..1 | dateTime | (QI-Core)(USCDI) Date request signed | ||||
| requester | SΣ | 0..1 | Reference(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..1 | CodeableConcept | Performer 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..* | CodeableConcept | Requested 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..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| note | 0..* | Annotation | Comments | |||||
| patientInstruction | Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory | 0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| ServiceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | ||||
| ServiceRequest.category:us-core | required | USCoreServiceRequestCategoryCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category | ||||
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| ServiceRequest.code | extensible | USCoreProcedureCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailfrom the FHIR Standard | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom the FHIR Standard | ||||
| ServiceRequest.performerType | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
| ServiceRequest.reasonCode | extensible | USCoreConditionCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-condition-code | ||||
| ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | 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 | ServiceRequest | 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 | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| dom-7 | error | ServiceRequest | if doNotPerform is present, it SHALL be false : doNotPerform.empty() or doNotPerform=false | |
| 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() | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
This structure is derived from USCoreServiceRequestProfile
Summary
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Differential View
This structure is derived from USCoreServiceRequestProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest | 0..* | USCoreServiceRequestProfile | A request for a service to be performed dom-7: if doNotPerform is present, it SHALL be false | |
| status | 1..1 | code | (QI-Core)(USCDI) draft | active | on-hold | revoked | completed | entered-in-error | unknown | |
| doNotPerform | 0..1 | boolean | (QI-Core) True if service/procedure should not be performed Fixed Value: false | |
| subject | 1..1 | Reference(QICore Patient) | (QI-Core)(USCDI) Individual or Entity the service is ordered for | |
| occurrence[x] | 0..1 | (QI-Core)(USCDI) When service should occur | ||
| occurrenceDateTime | dateTime | |||
| occurrencePeriod | Period | |||
| occurrenceTiming | Timing | |||
| authoredOn | 0..1 | dateTime | (QI-Core)(USCDI) Date request signed | |
| requester | 0..1 | Reference(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 | |
| reasonReference | Σ | 0..* | Reference(QICore Condition Encounter Diagnosis | QICore Condition Problems Health Concerns) | (QI-Core)(USCDI) Explanation/Justification for service or service |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| dom-7 | error | ServiceRequest | if doNotPerform is present, it SHALL be false : doNotPerform.empty() or doNotPerform=false |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest | C | 0..* | USCoreServiceRequestProfile | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present dom-7: if doNotPerform is present, it SHALL be false |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!SΣ | 1..1 | code | (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..1 | code | (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 | ?!Σ | 0..1 | boolean | (QI-Core) True if service/procedure should not be performed Fixed Value: false |
| code | SΣ | 1..1 | CodeableConcept | (USCDI) What is being requested/ordered Binding: US Core Procedure Codes (extensible) |
| subject | SΣ | 1..1 | Reference(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 | |
| occurrencePeriod | Period | |||
| authoredOn | SΣ | 0..1 | dateTime | (QI-Core)(USCDI) Date request signed |
| requester | SΣ | 0..1 | Reference(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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | |
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | |
| ServiceRequest.category:us-core | required | USCoreServiceRequestCategoryCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category | |
| ServiceRequest.code | extensible | USCoreProcedureCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code | |
| ServiceRequest.reasonCode | extensible | USCoreConditionCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-condition-code |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | 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 | ServiceRequest | 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 | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| dom-7 | error | ServiceRequest | if doNotPerform is present, it SHALL be false : doNotPerform.empty() or doNotPerform=false | |
| 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() | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest | C | 0..* | USCoreServiceRequestProfile | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present dom-7: if doNotPerform is present, it SHALL be false | ||||
| 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.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Identifiers assigned to this order | ||||
| instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | ||||
| replaces | Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
| requisition | Σ | 0..1 | Identifier | Composite Request ID | ||||
| status | ?!SΣ | 1..1 | code | (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..1 | code | (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..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
| doNotPerform | ?!Σ | 0..1 | boolean | (QI-Core) True if service/procedure should not be performed Fixed Value: false | ||||
| code | SΣ | 1..1 | CodeableConcept | (USCDI) What is being requested/ordered Binding: US Core Procedure Codes (extensible) | ||||
| orderDetail | ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
| quantity[x] | Σ | 0..1 | Service amount | |||||
| quantityQuantity | Quantity | |||||||
| quantityRatio | Ratio | |||||||
| quantityRange | Range | |||||||
| subject | SΣ | 1..1 | Reference(QICore Patient) | (QI-Core)(USCDI) Individual or Entity the service is ordered for | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
| occurrence[x] | SΣ | 0..1 | (QI-Core)(USCDI) When service should occur | |||||
| occurrenceDateTime | dateTime | |||||||
| occurrencePeriod | Period S | |||||||
| occurrenceTiming | Timing | |||||||
| asNeeded[x] | Σ | 0..1 | Preconditions 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. | |||||
| asNeededBoolean | boolean | |||||||
| asNeededCodeableConcept | CodeableConcept | |||||||
| authoredOn | SΣ | 0..1 | dateTime | (QI-Core)(USCDI) Date request signed | ||||
| requester | SΣ | 0..1 | Reference(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..1 | CodeableConcept | Performer 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..* | CodeableConcept | Requested 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..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| note | 0..* | Annotation | Comments | |||||
| patientInstruction | Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory | 0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| ServiceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | ||||
| ServiceRequest.category:us-core | required | USCoreServiceRequestCategoryCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category | ||||
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| ServiceRequest.code | extensible | USCoreProcedureCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailfrom the FHIR Standard | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom the FHIR Standard | ||||
| ServiceRequest.performerType | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
| ServiceRequest.reasonCode | extensible | USCoreConditionCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-condition-code | ||||
| ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | 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 | ServiceRequest | 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 | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| dom-7 | error | ServiceRequest | if doNotPerform is present, it SHALL be false : doNotPerform.empty() or doNotPerform=false | |
| 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() | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
This structure is derived from USCoreServiceRequestProfile
Summary
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron
IG © 2019+ HL7 International / Clinical Quality Information. Package hl7.fhir.us.qicore#6.0.0 based on FHIR 4.0.1. Generated 2024-03-01
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change