This page is part of the Quality Improvement Core Framework (v6.0.0-ballot: STU6 (v6.0.0) Ballot 1) based on FHIR R4. The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-servicenotrequested | Version: 6.0.0-ballot | |||
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.
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.extension:notDoneValueSet
valueset identifies a set of possible coded values representing activities that were not requested, ordered, or performed.ServiceRequest.subject
is Must Support with Must Support reference to QI Core PatientThe ServiceRequest and ServiceNotRequested profiles represent the positive and negative statements for a service request.
Negation Example with valueset | Service discontinued; indicates that none of the services in the given not done value set were requested. |
Negation Example with code | Service 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 QICore and quality improvement artifacts, see the Negation in QI Core topic.
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 | C | 0..* | USCoreServiceRequestProfile | A 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 | S | 1..1 | CodeableConcept | 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..1 | code | (USCDI) draft | active | on-hold | revoked | completed | entered-in-error | unknown |
doNotPerform | S | 1..1 | boolean | True if service/procedure should not be performed Fixed Value: true |
code | ||||
notDoneValueSet | SC | 0..1 | canonical(ValueSet) | What was not requested URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet |
subject | S | 1..1 | Reference(QICore Patient) | (USCDI) Individual or Entity the service is ordered for |
occurrence[x] | S | 0..1 | (USCDI) When service should occur | |
occurrenceDateTime | dateTime S | |||
occurrencePeriod | Period S | |||
occurrenceTiming | Timing S | |||
authoredOn | S | 1..1 | dateTime | (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 | S | 0..* | CodeableConcept | (USCDI) Explanation/Justification for procedure or service Binding: US Core Condition Codes (extensible) |
reasonReference | SΣ | 0..* | Reference(QICore Condition Encounter Diagnosis S | QICore Condition Problems Health Concerns S) | Explanation/Justification for service or service |
Documentation for this format |
Path | Conformance | ValueSet |
ServiceRequest.reasonCode | extensible | USCoreConditionCodes |
Id | Grade | Path(s) | Details | Requirements |
snr-1 | error | ServiceRequest | to 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() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | C | 0..* | USCoreServiceRequestProfile | A 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 |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
reasonRefused | S | 1..1 | CodeableConcept | 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..* | Extension | Extensions that cannot be ignored |
status | ?!SΣ | 1..1 | code | (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 | ?!SΣ | 1..1 | boolean | True if service/procedure should not be performed Fixed Value: true |
code | SΣ | 1..1 | CodeableConcept | (USCDI) What is being requested/ordered Binding: US Core Procedure Codes (extensible) |
notDoneValueSet | SC | 0..1 | canonical(ValueSet) | What was not requested URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet |
subject | SΣ | 1..1 | Reference(QICore Patient) | (USCDI) Individual or Entity the service is ordered for |
occurrence[x] | SΣ | 0..1 | (USCDI) When service should occur | |
occurrenceDateTime | dateTime | |||
occurrencePeriod | Period | |||
occurrenceTiming | Timing | |||
authoredOn | SΣ | 1..1 | dateTime | (USCDI) Date request signed |
requester | SΣ | 0..1 | Reference(QICore PractitionerRole | QICore Patient | QICore RelatedPerson) | (USCDI) Who/what is requesting service |
reasonCode | SΣ | 0..* | CodeableConcept | (USCDI) Explanation/Justification for procedure or service Binding: US Core Condition Codes (extensible) |
reasonReference | SΣ | 0..* | Reference(QICore Condition Encounter Diagnosis | QICore Condition Problems Health Concerns) | Explanation/Justification for service or service |
Documentation for this format |
Path | Conformance | ValueSet |
ServiceRequest.status | required | RequestStatus |
ServiceRequest.intent | required | RequestIntent |
ServiceRequest.category | example | ServiceRequestCategoryCodes |
ServiceRequest.category:us-core | required | USCoreServiceRequestCategoryCodes |
ServiceRequest.code | extensible | USCoreProcedureCodes |
ServiceRequest.reasonCode | extensible | USCoreConditionCodes |
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() | |
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() | |
snr-1 | error | ServiceRequest | to 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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ServiceRequest | C | 0..* | USCoreServiceRequestProfile | A 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 | ||||
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 | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
reasonRefused | S | 1..1 | CodeableConcept | 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..* | 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 | (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 | ?!SΣ | 1..1 | boolean | True if service/procedure should not be performed Fixed Value: true | ||||
code | SΣ | 1..1 | CodeableConcept | (USCDI) What is being requested/ordered Binding: US Core Procedure Codes (extensible) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
notDoneValueSet | SC | 0..1 | canonical(ValueSet) | What was not requested URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet | ||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
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) | (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 | (USCDI) When service should occur | |||||
occurrenceDateTime | dateTime S | |||||||
occurrencePeriod | Period S | |||||||
occurrenceTiming | Timing S | |||||||
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Σ | 1..1 | dateTime | (USCDI) Date request signed | ||||
requester | SΣ | 0..1 | Reference(QICore Practitioner | QICore PractitionerRole S | QICore Organization | QICore Patient S | QICore RelatedPerson S | 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 | SΣ | 0..* | CodeableConcept | (USCDI) Explanation/Justification for procedure or service Binding: US Core Condition Codes (extensible) | ||||
reasonReference | SΣ | 0..* | Reference(QICore Condition Encounter Diagnosis S | QICore Condition Problems Health Concerns S) | 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 | ||||
ServiceRequest.language | preferred | CommonLanguages
| ||||
ServiceRequest.status | required | RequestStatus | ||||
ServiceRequest.intent | required | RequestIntent | ||||
ServiceRequest.category | example | ServiceRequestCategoryCodes | ||||
ServiceRequest.category:us-core | required | USCoreServiceRequestCategoryCodes | ||||
ServiceRequest.priority | required | RequestPriority | ||||
ServiceRequest.code | extensible | USCoreProcedureCodes | ||||
ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodes | ||||
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodes | ||||
ServiceRequest.performerType | example | ParticipantRoles | ||||
ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleType | ||||
ServiceRequest.reasonCode | extensible | USCoreConditionCodes | ||||
ServiceRequest.bodySite | example | SNOMEDCTBodyStructures |
Id | Grade | Path(s) | Details | Requirements |
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() |
This structure is derived from USCoreServiceRequestProfile
Summary
Mandatory: 3 elements
Must-Support: 9 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from USCoreServiceRequestProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | C | 0..* | USCoreServiceRequestProfile | A 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 | S | 1..1 | CodeableConcept | 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..1 | code | (USCDI) draft | active | on-hold | revoked | completed | entered-in-error | unknown |
doNotPerform | S | 1..1 | boolean | True if service/procedure should not be performed Fixed Value: true |
code | ||||
notDoneValueSet | SC | 0..1 | canonical(ValueSet) | What was not requested URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet |
subject | S | 1..1 | Reference(QICore Patient) | (USCDI) Individual or Entity the service is ordered for |
occurrence[x] | S | 0..1 | (USCDI) When service should occur | |
occurrenceDateTime | dateTime S | |||
occurrencePeriod | Period S | |||
occurrenceTiming | Timing S | |||
authoredOn | S | 1..1 | dateTime | (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 | S | 0..* | CodeableConcept | (USCDI) Explanation/Justification for procedure or service Binding: US Core Condition Codes (extensible) |
reasonReference | SΣ | 0..* | Reference(QICore Condition Encounter Diagnosis S | QICore Condition Problems Health Concerns S) | Explanation/Justification for service or service |
Documentation for this format |
Path | Conformance | ValueSet |
ServiceRequest.reasonCode | extensible | USCoreConditionCodes |
Id | Grade | Path(s) | Details | Requirements |
snr-1 | error | ServiceRequest | to 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
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | C | 0..* | USCoreServiceRequestProfile | A 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 |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
reasonRefused | S | 1..1 | CodeableConcept | 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..* | Extension | Extensions that cannot be ignored |
status | ?!SΣ | 1..1 | code | (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 | ?!SΣ | 1..1 | boolean | True if service/procedure should not be performed Fixed Value: true |
code | SΣ | 1..1 | CodeableConcept | (USCDI) What is being requested/ordered Binding: US Core Procedure Codes (extensible) |
notDoneValueSet | SC | 0..1 | canonical(ValueSet) | What was not requested URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet |
subject | SΣ | 1..1 | Reference(QICore Patient) | (USCDI) Individual or Entity the service is ordered for |
occurrence[x] | SΣ | 0..1 | (USCDI) When service should occur | |
occurrenceDateTime | dateTime | |||
occurrencePeriod | Period | |||
occurrenceTiming | Timing | |||
authoredOn | SΣ | 1..1 | dateTime | (USCDI) Date request signed |
requester | SΣ | 0..1 | Reference(QICore PractitionerRole | QICore Patient | QICore RelatedPerson) | (USCDI) Who/what is requesting service |
reasonCode | SΣ | 0..* | CodeableConcept | (USCDI) Explanation/Justification for procedure or service Binding: US Core Condition Codes (extensible) |
reasonReference | SΣ | 0..* | Reference(QICore Condition Encounter Diagnosis | QICore Condition Problems Health Concerns) | Explanation/Justification for service or service |
Documentation for this format |
Path | Conformance | ValueSet |
ServiceRequest.status | required | RequestStatus |
ServiceRequest.intent | required | RequestIntent |
ServiceRequest.category | example | ServiceRequestCategoryCodes |
ServiceRequest.category:us-core | required | USCoreServiceRequestCategoryCodes |
ServiceRequest.code | extensible | USCoreProcedureCodes |
ServiceRequest.reasonCode | extensible | USCoreConditionCodes |
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() | |
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() | |
snr-1 | error | ServiceRequest | to 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
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ServiceRequest | C | 0..* | USCoreServiceRequestProfile | A 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 | ||||
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 | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
reasonRefused | S | 1..1 | CodeableConcept | 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..* | 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 | (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 | ?!SΣ | 1..1 | boolean | True if service/procedure should not be performed Fixed Value: true | ||||
code | SΣ | 1..1 | CodeableConcept | (USCDI) What is being requested/ordered Binding: US Core Procedure Codes (extensible) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
notDoneValueSet | SC | 0..1 | canonical(ValueSet) | What was not requested URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet | ||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
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) | (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 | (USCDI) When service should occur | |||||
occurrenceDateTime | dateTime S | |||||||
occurrencePeriod | Period S | |||||||
occurrenceTiming | Timing S | |||||||
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Σ | 1..1 | dateTime | (USCDI) Date request signed | ||||
requester | SΣ | 0..1 | Reference(QICore Practitioner | QICore PractitionerRole S | QICore Organization | QICore Patient S | QICore RelatedPerson S | 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 | SΣ | 0..* | CodeableConcept | (USCDI) Explanation/Justification for procedure or service Binding: US Core Condition Codes (extensible) | ||||
reasonReference | SΣ | 0..* | Reference(QICore Condition Encounter Diagnosis S | QICore Condition Problems Health Concerns S) | 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 | ||||
ServiceRequest.language | preferred | CommonLanguages
| ||||
ServiceRequest.status | required | RequestStatus | ||||
ServiceRequest.intent | required | RequestIntent | ||||
ServiceRequest.category | example | ServiceRequestCategoryCodes | ||||
ServiceRequest.category:us-core | required | USCoreServiceRequestCategoryCodes | ||||
ServiceRequest.priority | required | RequestPriority | ||||
ServiceRequest.code | extensible | USCoreProcedureCodes | ||||
ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodes | ||||
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodes | ||||
ServiceRequest.performerType | example | ParticipantRoles | ||||
ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleType | ||||
ServiceRequest.reasonCode | extensible | USCoreConditionCodes | ||||
ServiceRequest.bodySite | example | SNOMEDCTBodyStructures |
Id | Grade | Path(s) | Details | Requirements |
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() |
This structure is derived from USCoreServiceRequestProfile
Summary
Mandatory: 3 elements
Must-Support: 9 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron