SMART Base Clinical
1.0.1 - release International flag

SMART Base Clinical, published by WHO. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-base-clinical/ and changes regularly. See the Directory of published versions

Resource Profile: WHO SMART Guidelines Service Not Requested

Official URL: http://smart.who.int/base-clinical/StructureDefinition/sg-servicenotrequested Version: 1.0.1
Draft as of 2026-11-19 Computable Name: SGServiceNotRequested

The WHO SMART Guidelines Service Not Requested profile defines conformance requirements and exchange expectations for ServiceRequest resources used to communicate that a particular service (or class of services) should not be performed in WHO Smart Guidelines content.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* CPGServiceRequest A request for a service to be performed
Constraints: prr-1, snr-1
ServiceRequest.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ServiceRequest.Slices for extension Content/Rules for all slices
ServiceRequest.Slices for extension.extension:rationale This element must be supported. 0..1 markdown CPG Rationale Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale
ServiceRequest.Slices for extension.extension:rating This element must be supported. 0..1 Quantity, Range, Ratio CPG Rating Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rating
ServiceRequest.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ServiceRequest.identifier This element must be supported. This element is included in summaries. 1..* Identifier Identifiers assigned to this order
ServiceRequest.identifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
ServiceRequest.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
ServiceRequest.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
ServiceRequest.instantiatesCanonical This element must be supported. This element is included in summaries. 0..* canonical(ActivityDefinition | PlanDefinition) Source
ServiceRequest.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
ServiceRequest.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
ServiceRequest.category This element must be supported. This element is included in summaries. 0..* CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
ServiceRequest.priority This element must be supported. This element is included in summaries. 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
ServiceRequest.doNotPerform This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean True if service/procedure should not be performed
Fixed Value: true (no extensions allowed)
ServiceRequest.code This element must be supported. This element is included in summaries. C 1..1 CodeableConcept ​What is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here.
ServiceRequest.code.Slices for extension Content/Rules for all slices
ServiceRequest.code.Slices for extension.extension:notDoneValueSet This element must be supported. C 0..1 canonical(ValueSet) What was not requested
URL: http://hl7.org/fhir/StructureDefinition/cqf-notDoneValueSet
ServiceRequest.subject This element must be supported. This element is included in summaries. 1..1 Reference(WHO SMART Guidelines Patient) Individual or Entity the service is ordered for
ServiceRequest.encounter This element must be supported. This element is included in summaries. 0..1 Reference(WHO SMART Guidelines Encounter) Encounter in which the request was created
ServiceRequest.occurrence[x] This element must be supported. This element is included in summaries. 0..1 When service should occur
ServiceRequest.occurrence[x].occurrenceDateTime dateTime
ServiceRequest.occurrence[x].occurrencePeriod Period
ServiceRequest.occurrence[x].occurrenceTiming Timing
ServiceRequest.asNeeded[x] This element must be supported. This element is included in summaries. 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.
ServiceRequest.asNeeded[x].asNeededBoolean boolean
ServiceRequest.asNeeded[x].asNeededCodeableConcept CodeableConcept
ServiceRequest.authoredOn This element must be supported. This element is included in summaries. 1..1 dateTime Date request signed
ServiceRequest.requester This element must be supported. This element is included in summaries. 0..1 Reference(WHO SMART Guidelines Patient | WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines RelatedPerson) Who/what is requesting service
ServiceRequest.performer This element must be supported. This element is included in summaries. 0..* Reference(WHO SMART Guidelines Patient | WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines RelatedPerson) Requested performer
ServiceRequest.supportingInfo This element must be supported. 0..* Reference(Resource) Pertinent information

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ServiceRequest.category Base example Service Request Category Codes 📦4.0.1 FHIR Std.
ServiceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
ServiceRequest.code Base example Procedure Codes (SNOMED CT) 📦4.0.1 FHIR Std.
ServiceRequest.asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 requested, either at least one coding in the code element or a notDoneValueSet extension shall be provided code.extension('http://hl7.org/fhir/StructureDefinition/cqf-notDoneValueSet').exists() xor code.coding.exists()

This structure is derived from CPGServiceRequest

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* CPGServiceRequest A request for a service to be performed
Constraints: snr-1
ServiceRequest.identifier This element must be supported. 1..* Identifier Identifiers assigned to this order
ServiceRequest.identifier.use This element must be supported. 1..1 code usual | official | temp | secondary | old (If known)
ServiceRequest.identifier.system This element must be supported. 1..1 uri The namespace for the identifier value
ServiceRequest.identifier.value This element must be supported. 1..1 string The value that is unique
ServiceRequest.status This element must be supported. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
ServiceRequest.doNotPerform This element must be supported. 1..1 boolean True if service/procedure should not be performed
Fixed Value: true (no extensions allowed)
ServiceRequest.code.Slices for extension Content/Rules for all slices
ServiceRequest.code.Slices for extension.extension:notDoneValueSet This element must be supported. C 0..1 canonical(ValueSet) What was not requested
URL: http://hl7.org/fhir/StructureDefinition/cqf-notDoneValueSet
ServiceRequest.subject This element must be supported. 1..1 Reference(WHO SMART Guidelines Patient) Individual or Entity the service is ordered for
ServiceRequest.encounter This element must be supported. 0..1 Reference(WHO SMART Guidelines Encounter) Encounter in which the request was created
ServiceRequest.occurrence[x] This element must be supported. 0..1 dateTime, Period, Timing When service should occur
ServiceRequest.authoredOn This element must be supported. 1..1 dateTime Date request signed
ServiceRequest.requester This element must be supported. 0..1 Reference(WHO SMART Guidelines Patient | WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines RelatedPerson) Who/what is requesting service
ServiceRequest.performer This element must be supported. 0..* Reference(WHO SMART Guidelines Patient | WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines RelatedPerson) Requested performer

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
snr-1 error ServiceRequest To indicate what service was not requested, either at least one coding in the code element or a notDoneValueSet extension shall be provided code.extension('http://hl7.org/fhir/StructureDefinition/cqf-notDoneValueSet').exists() xor code.coding.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* CPGServiceRequest A request for a service to be performed
Constraints: prr-1, snr-1
ServiceRequest.id This element is included in summaries. 0..1 id Logical id of this artifact
ServiceRequest.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ServiceRequest.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ServiceRequest.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
ServiceRequest.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
ServiceRequest.contained 0..* Resource Contained, inline Resources
ServiceRequest.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ServiceRequest.Slices for extension.extension:rationale This element must be supported. 0..1 markdown CPG Rationale Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale
ServiceRequest.Slices for extension.extension:rating This element must be supported. 0..1 Quantity, Range, Ratio CPG Rating Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rating
ServiceRequest.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ServiceRequest.identifier This element must be supported. This element is included in summaries. 1..* Identifier Identifiers assigned to this order
ServiceRequest.identifier.id 0..1 string Unique id for inter-element referencing
ServiceRequest.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.identifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
ServiceRequest.identifier.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ServiceRequest.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
ServiceRequest.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
ServiceRequest.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
ServiceRequest.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
ServiceRequest.instantiatesCanonical This element must be supported. This element is included in summaries. 0..* canonical(ActivityDefinition | PlanDefinition) Source
ServiceRequest.instantiatesUri This element is included in summaries. 0..* uri Instantiates external protocol or definition
ServiceRequest.basedOn This element is included in summaries. 0..* Reference(CarePlan | ServiceRequest | MedicationRequest) What request fulfills
ServiceRequest.replaces This element is included in summaries. 0..* Reference(ServiceRequest) What request replaces
ServiceRequest.requisition This element is included in summaries. 0..1 Identifier Composite Request ID
ServiceRequest.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
ServiceRequest.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
ServiceRequest.category This element must be supported. This element is included in summaries. 0..* CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
ServiceRequest.priority This element must be supported. This element is included in summaries. 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
ServiceRequest.doNotPerform This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean True if service/procedure should not be performed
Fixed Value: true (no extensions allowed)
ServiceRequest.code This element must be supported. This element is included in summaries. C 1..1 CodeableConcept ​What is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here.
ServiceRequest.code.id 0..1 string Unique id for inter-element referencing
ServiceRequest.code.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.code.Slices for extension.extension:notDoneValueSet This element must be supported. C 0..1 canonical(ValueSet) What was not requested
URL: http://hl7.org/fhir/StructureDefinition/cqf-notDoneValueSet
ServiceRequest.code.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
ServiceRequest.code.text This element is included in summaries. 0..1 string Plain text representation of the concept
ServiceRequest.orderDetail This element is included in summaries. C 0..* CodeableConcept Additional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
ServiceRequest.quantity[x] This element is included in summaries. 0..1 Service amount
ServiceRequest.quantity[x].quantityQuantity Quantity
ServiceRequest.quantity[x].quantityRatio Ratio
ServiceRequest.quantity[x].quantityRange Range
ServiceRequest.subject This element must be supported. This element is included in summaries. 1..1 Reference(WHO SMART Guidelines Patient) Individual or Entity the service is ordered for
ServiceRequest.encounter This element must be supported. This element is included in summaries. 0..1 Reference(WHO SMART Guidelines Encounter) Encounter in which the request was created
ServiceRequest.occurrence[x] This element must be supported. This element is included in summaries. 0..1 When service should occur
ServiceRequest.occurrence[x].occurrenceDateTime dateTime
ServiceRequest.occurrence[x].occurrencePeriod Period
ServiceRequest.occurrence[x].occurrenceTiming Timing
ServiceRequest.asNeeded[x] This element must be supported. This element is included in summaries. 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.
ServiceRequest.asNeeded[x].asNeededBoolean boolean
ServiceRequest.asNeeded[x].asNeededCodeableConcept CodeableConcept
ServiceRequest.authoredOn This element must be supported. This element is included in summaries. 1..1 dateTime Date request signed
ServiceRequest.requester This element must be supported. This element is included in summaries. 0..1 Reference(WHO SMART Guidelines Patient | WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines RelatedPerson) Who/what is requesting service
ServiceRequest.performerType This element is included in summaries. 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.
ServiceRequest.performer This element must be supported. This element is included in summaries. 0..* Reference(WHO SMART Guidelines Patient | WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines RelatedPerson) Requested performer
ServiceRequest.locationCode This element is included in summaries. 0..* CodeableConcept Requested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.
ServiceRequest.locationReference This element is included in summaries. 0..* Reference(Location) Requested location
ServiceRequest.reasonCode This element is included in summaries. 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.
ServiceRequest.reasonReference This element is included in summaries. 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
ServiceRequest.insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
ServiceRequest.supportingInfo This element must be supported. 0..* Reference(Resource) Pertinent information
ServiceRequest.specimen This element is included in summaries. 0..* Reference(Specimen) Procedure Samples
ServiceRequest.bodySite This element is included in summaries. 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
ServiceRequest.note 0..* Annotation Comments
ServiceRequest.patientInstruction This element is included in summaries. 0..1 string Patient or consumer-oriented instructions
ServiceRequest.relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.language Base preferred Common Languages 📦4.0.1 FHIR Std.
ServiceRequest.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ServiceRequest.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ServiceRequest.category Base example Service Request Category Codes 📦4.0.1 FHIR Std.
ServiceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
ServiceRequest.code Base example Procedure Codes (SNOMED CT) 📦4.0.1 FHIR Std.
ServiceRequest.orderDetail Base example Service Request Order Details Codes 📦4.0.1 FHIR Std.
ServiceRequest.asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📦4.0.1 FHIR Std.
ServiceRequest.performerType Base example Participant Roles 📦4.0.1 FHIR Std.
ServiceRequest.locationCode Base example ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.3
ServiceRequest.reasonCode Base example Procedure Reason Codes 📦4.0.1 FHIR Std.
ServiceRequest.bodySite Base example SNOMED CT Body Structures 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 requested, either at least one coding in the code element or a notDoneValueSet extension shall be provided code.extension('http://hl7.org/fhir/StructureDefinition/cqf-notDoneValueSet').exists() xor code.coding.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* CPGServiceRequest A request for a service to be performed
Constraints: prr-1, snr-1
ServiceRequest.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ServiceRequest.Slices for extension Content/Rules for all slices
ServiceRequest.Slices for extension.extension:rationale This element must be supported. 0..1 markdown CPG Rationale Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale
ServiceRequest.Slices for extension.extension:rating This element must be supported. 0..1 Quantity, Range, Ratio CPG Rating Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rating
ServiceRequest.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ServiceRequest.identifier This element must be supported. This element is included in summaries. 1..* Identifier Identifiers assigned to this order
ServiceRequest.identifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
ServiceRequest.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
ServiceRequest.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
ServiceRequest.instantiatesCanonical This element must be supported. This element is included in summaries. 0..* canonical(ActivityDefinition | PlanDefinition) Source
ServiceRequest.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
ServiceRequest.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
ServiceRequest.category This element must be supported. This element is included in summaries. 0..* CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
ServiceRequest.priority This element must be supported. This element is included in summaries. 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
ServiceRequest.doNotPerform This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean True if service/procedure should not be performed
Fixed Value: true (no extensions allowed)
ServiceRequest.code This element must be supported. This element is included in summaries. C 1..1 CodeableConcept ​What is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here.
ServiceRequest.code.Slices for extension Content/Rules for all slices
ServiceRequest.code.Slices for extension.extension:notDoneValueSet This element must be supported. C 0..1 canonical(ValueSet) What was not requested
URL: http://hl7.org/fhir/StructureDefinition/cqf-notDoneValueSet
ServiceRequest.subject This element must be supported. This element is included in summaries. 1..1 Reference(WHO SMART Guidelines Patient) Individual or Entity the service is ordered for
ServiceRequest.encounter This element must be supported. This element is included in summaries. 0..1 Reference(WHO SMART Guidelines Encounter) Encounter in which the request was created
ServiceRequest.occurrence[x] This element must be supported. This element is included in summaries. 0..1 When service should occur
ServiceRequest.occurrence[x].occurrenceDateTime dateTime
ServiceRequest.occurrence[x].occurrencePeriod Period
ServiceRequest.occurrence[x].occurrenceTiming Timing
ServiceRequest.asNeeded[x] This element must be supported. This element is included in summaries. 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.
ServiceRequest.asNeeded[x].asNeededBoolean boolean
ServiceRequest.asNeeded[x].asNeededCodeableConcept CodeableConcept
ServiceRequest.authoredOn This element must be supported. This element is included in summaries. 1..1 dateTime Date request signed
ServiceRequest.requester This element must be supported. This element is included in summaries. 0..1 Reference(WHO SMART Guidelines Patient | WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines RelatedPerson) Who/what is requesting service
ServiceRequest.performer This element must be supported. This element is included in summaries. 0..* Reference(WHO SMART Guidelines Patient | WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines RelatedPerson) Requested performer
ServiceRequest.supportingInfo This element must be supported. 0..* Reference(Resource) Pertinent information

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ServiceRequest.category Base example Service Request Category Codes 📦4.0.1 FHIR Std.
ServiceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
ServiceRequest.code Base example Procedure Codes (SNOMED CT) 📦4.0.1 FHIR Std.
ServiceRequest.asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 requested, either at least one coding in the code element or a notDoneValueSet extension shall be provided code.extension('http://hl7.org/fhir/StructureDefinition/cqf-notDoneValueSet').exists() xor code.coding.exists()

Differential View

This structure is derived from CPGServiceRequest

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* CPGServiceRequest A request for a service to be performed
Constraints: snr-1
ServiceRequest.identifier This element must be supported. 1..* Identifier Identifiers assigned to this order
ServiceRequest.identifier.use This element must be supported. 1..1 code usual | official | temp | secondary | old (If known)
ServiceRequest.identifier.system This element must be supported. 1..1 uri The namespace for the identifier value
ServiceRequest.identifier.value This element must be supported. 1..1 string The value that is unique
ServiceRequest.status This element must be supported. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
ServiceRequest.doNotPerform This element must be supported. 1..1 boolean True if service/procedure should not be performed
Fixed Value: true (no extensions allowed)
ServiceRequest.code This element must be supported. C 1..1 CodeableConcept What is being requested/ordered
ServiceRequest.code.Slices for extension Content/Rules for all slices
ServiceRequest.code.Slices for extension.extension:notDoneValueSet This element must be supported. C 0..1 canonical(ValueSet) What was not requested
URL: http://hl7.org/fhir/StructureDefinition/cqf-notDoneValueSet
ServiceRequest.subject This element must be supported. 1..1 Reference(WHO SMART Guidelines Patient) Individual or Entity the service is ordered for
ServiceRequest.encounter This element must be supported. 0..1 Reference(WHO SMART Guidelines Encounter) Encounter in which the request was created
ServiceRequest.occurrence[x] This element must be supported. 0..1 dateTime, Period, Timing When service should occur
ServiceRequest.authoredOn This element must be supported. 1..1 dateTime Date request signed
ServiceRequest.requester This element must be supported. 0..1 Reference(WHO SMART Guidelines Patient | WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines RelatedPerson) Who/what is requesting service
ServiceRequest.performer This element must be supported. 0..* Reference(WHO SMART Guidelines Patient | WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines RelatedPerson) Requested performer

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
snr-1 error ServiceRequest To indicate what service was not requested, either at least one coding in the code element or a notDoneValueSet extension shall be provided code.extension('http://hl7.org/fhir/StructureDefinition/cqf-notDoneValueSet').exists() xor code.coding.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* CPGServiceRequest A request for a service to be performed
Constraints: prr-1, snr-1
ServiceRequest.id This element is included in summaries. 0..1 id Logical id of this artifact
ServiceRequest.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ServiceRequest.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ServiceRequest.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
ServiceRequest.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
ServiceRequest.contained 0..* Resource Contained, inline Resources
ServiceRequest.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ServiceRequest.Slices for extension.extension:rationale This element must be supported. 0..1 markdown CPG Rationale Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale
ServiceRequest.Slices for extension.extension:rating This element must be supported. 0..1 Quantity, Range, Ratio CPG Rating Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rating
ServiceRequest.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ServiceRequest.identifier This element must be supported. This element is included in summaries. 1..* Identifier Identifiers assigned to this order
ServiceRequest.identifier.id 0..1 string Unique id for inter-element referencing
ServiceRequest.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.identifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
ServiceRequest.identifier.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ServiceRequest.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
ServiceRequest.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
ServiceRequest.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
ServiceRequest.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
ServiceRequest.instantiatesCanonical This element must be supported. This element is included in summaries. 0..* canonical(ActivityDefinition | PlanDefinition) Source
ServiceRequest.instantiatesUri This element is included in summaries. 0..* uri Instantiates external protocol or definition
ServiceRequest.basedOn This element is included in summaries. 0..* Reference(CarePlan | ServiceRequest | MedicationRequest) What request fulfills
ServiceRequest.replaces This element is included in summaries. 0..* Reference(ServiceRequest) What request replaces
ServiceRequest.requisition This element is included in summaries. 0..1 Identifier Composite Request ID
ServiceRequest.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
ServiceRequest.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
ServiceRequest.category This element must be supported. This element is included in summaries. 0..* CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
ServiceRequest.priority This element must be supported. This element is included in summaries. 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
ServiceRequest.doNotPerform This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean True if service/procedure should not be performed
Fixed Value: true (no extensions allowed)
ServiceRequest.code This element must be supported. This element is included in summaries. C 1..1 CodeableConcept ​What is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here.
ServiceRequest.code.id 0..1 string Unique id for inter-element referencing
ServiceRequest.code.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.code.Slices for extension.extension:notDoneValueSet This element must be supported. C 0..1 canonical(ValueSet) What was not requested
URL: http://hl7.org/fhir/StructureDefinition/cqf-notDoneValueSet
ServiceRequest.code.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
ServiceRequest.code.text This element is included in summaries. 0..1 string Plain text representation of the concept
ServiceRequest.orderDetail This element is included in summaries. C 0..* CodeableConcept Additional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
ServiceRequest.quantity[x] This element is included in summaries. 0..1 Service amount
ServiceRequest.quantity[x].quantityQuantity Quantity
ServiceRequest.quantity[x].quantityRatio Ratio
ServiceRequest.quantity[x].quantityRange Range
ServiceRequest.subject This element must be supported. This element is included in summaries. 1..1 Reference(WHO SMART Guidelines Patient) Individual or Entity the service is ordered for
ServiceRequest.encounter This element must be supported. This element is included in summaries. 0..1 Reference(WHO SMART Guidelines Encounter) Encounter in which the request was created
ServiceRequest.occurrence[x] This element must be supported. This element is included in summaries. 0..1 When service should occur
ServiceRequest.occurrence[x].occurrenceDateTime dateTime
ServiceRequest.occurrence[x].occurrencePeriod Period
ServiceRequest.occurrence[x].occurrenceTiming Timing
ServiceRequest.asNeeded[x] This element must be supported. This element is included in summaries. 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.
ServiceRequest.asNeeded[x].asNeededBoolean boolean
ServiceRequest.asNeeded[x].asNeededCodeableConcept CodeableConcept
ServiceRequest.authoredOn This element must be supported. This element is included in summaries. 1..1 dateTime Date request signed
ServiceRequest.requester This element must be supported. This element is included in summaries. 0..1 Reference(WHO SMART Guidelines Patient | WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines RelatedPerson) Who/what is requesting service
ServiceRequest.performerType This element is included in summaries. 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.
ServiceRequest.performer This element must be supported. This element is included in summaries. 0..* Reference(WHO SMART Guidelines Patient | WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines RelatedPerson) Requested performer
ServiceRequest.locationCode This element is included in summaries. 0..* CodeableConcept Requested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.
ServiceRequest.locationReference This element is included in summaries. 0..* Reference(Location) Requested location
ServiceRequest.reasonCode This element is included in summaries. 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.
ServiceRequest.reasonReference This element is included in summaries. 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
ServiceRequest.insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
ServiceRequest.supportingInfo This element must be supported. 0..* Reference(Resource) Pertinent information
ServiceRequest.specimen This element is included in summaries. 0..* Reference(Specimen) Procedure Samples
ServiceRequest.bodySite This element is included in summaries. 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
ServiceRequest.note 0..* Annotation Comments
ServiceRequest.patientInstruction This element is included in summaries. 0..1 string Patient or consumer-oriented instructions
ServiceRequest.relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.language Base preferred Common Languages 📦4.0.1 FHIR Std.
ServiceRequest.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ServiceRequest.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ServiceRequest.category Base example Service Request Category Codes 📦4.0.1 FHIR Std.
ServiceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
ServiceRequest.code Base example Procedure Codes (SNOMED CT) 📦4.0.1 FHIR Std.
ServiceRequest.orderDetail Base example Service Request Order Details Codes 📦4.0.1 FHIR Std.
ServiceRequest.asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📦4.0.1 FHIR Std.
ServiceRequest.performerType Base example Participant Roles 📦4.0.1 FHIR Std.
ServiceRequest.locationCode Base example ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.3
ServiceRequest.reasonCode Base example Procedure Reason Codes 📦4.0.1 FHIR Std.
ServiceRequest.bodySite Base example SNOMED CT Body Structures 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 requested, either at least one coding in the code element or a notDoneValueSet extension shall be provided code.extension('http://hl7.org/fhir/StructureDefinition/cqf-notDoneValueSet').exists() xor code.coding.exists()

 

Other representations of profile: CSV, Excel, Schematron