US Core Implementation Guide
10.0.0-ballot - STU 10 Ballot United States of America flag

US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 10.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions

Resource Profile: US Core ServiceRequest Profile

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-servicerequest Version: 10.0.0-ballot
Standards status: Trial-use Maturity Level: 4 Computable Name: USCoreServiceRequestProfile
Other Identifiers: OID:2.16.840.1.113883.4.642.40.2.42.60

The US Core ServiceRequest Profile inherits from the FHIR ServiceRequest resource; refer to it for scope and usage definitions. This profile sets minimum expectations for recording, searching, and fetching the ServiceRequest information. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

Example Usage Scenarios:

The following are example usage scenarios for this profile:

  • Query for a specific procedure or test request, such as an electrocardiogram (ECG) order or a referral to a support program.
  • Query for a specific service offered to a patient, such as a referral to a support program.
  • Query for a category of service request (e.g., all cardiology requests)

Mandatory and Must Support Data Elements

The following data elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.

Each Service Request Must Have:

  1. a status
  2. an intent code indicating whether the request is a proposal, plan, or order.
  3. a code defining what is being requested1
  4. a patient

Each Service Request Must Support:

  1. a category2
  2. the encounter in which the request was created
  3. when requested service should happen
  4. when the request was made
  5. the requester3

Additional USCDI Requirements:

These Additional USCDI Requirements elements are not Mandatory or Must Support but are required for ONC Health IT certification testing and are included in the formal definition of the profile and the ServiceRequest examples.

  1. the name of the test, procedure, or service to be performed
  2. a reason or indication for referral or consultation4
  3. a business identifier assigned to the order5

1,2,3,4,5 see guidance below

Profile Specific Implementation Guidance

This section provides detailed implementation guidance for the US Core Profile to support implementation and certification.

  • For more information on exchanging Social Determinants of Health (SDOH) service requests, See the Screening and Assessments guidance page.

  • 4Servers and Clients SHALL support both US Core ServiceRequest and US Core Procedure Profiles for communicating the reason or justification for a referral as Additional USCDI Requirements.§,§ Typically, the reason or justification for a referral or consultation is communicated through Procedure.basedOn linking the Procedure to the US Core ServiceRequest Profile that includes either ServiceRequest.reasonCode or ServiceRequest.reasonReference. When the Procedure does not have an associated ServiceRequest, it is communicated through the US Core Procedure Profile's Procedure.reasonCode or Procedure.reasonReference. Depending on the procedure being documented, a Server will select the appropriate Profile to use.

    • Although both ServiceRequest.reasonCode and ServiceRequest.reasonReference are marked as Additional USCDI Requirements, the certifying Server system is not required to support both, but SHALL support at least one of these elements.§ The certifying Client application SHALL support both elements.§
      • when using ServiceRequest.reasonReference:
        • Servers SHALL support at least one target resource in ServiceRequest.reasonReference.§ Clients SHALL support all target resources.§
        • The referenced resources SHOULD be a US Core Profile as documented in Referencing US Core Profiles.§
  • 3The profile element ServiceRequest.requester communicates the individual level provenance author data corresponding to the U.S. Core Data for Interoperability (USCDI) Provenance Author Data Elements.
  • 5Accession numbers originate with the order as ServiceRequest.identifier, and, typically, the same identifier appears on the report as DiagnosticReport.identifier and the study results, in other words, as Observation.identifier or ImagingStudy.identifier. Recording it on the order allows a client to start from a known business identifier and reach the corresponding report and results.

USCDI Laboratory Order, Imaging Order, Clinical Test Order, Procedure Order, and Referral Order Data Elements

USCDI Portable Medical Order (PMO) Data Element

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 9.0.0:

  • The data elements list has changed
  • Formal Views of Profile Content

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

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    ServiceRequest C 0..* ServiceRequest A request for a service to be performed
    Constraints: prr-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.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    ServiceRequest.identifier This element is included in summaries. 0..* Identifier 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Identifiers assigned to this order instance
    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.Slices for category This element must be supported. This element is included in summaries. 0..* CodeableConcept Classification of service
    Slice: Unordered, Open by value:$this
    Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    ServiceRequest.Slices for category.category:us-core This element must be supported. This element is included in summaries. 0..* CodeableConcept Classification of service
    Binding: US Core ServiceRequest Category Codes (required): Note that other codes are permitted in other slices, see Required Bindings When Slicing by Value Sets
    ServiceRequest.doNotPerform This element is a modifier element. This element is included in summaries. 0..1 boolean True if service/procedure should not be performed
    ServiceRequest.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept What is being requested/ordered
    Binding: US Core Procedure Codes (extensible)
    ServiceRequest.code.text This element is included in summaries. 0..1 string 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The name of the test, procedure, or service to be performed.
    ServiceRequest.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile This type must be supported. | Group | US Core Location Profile | US Core Device Profile) Individual or Entity the service is ordered for
    ServiceRequest.encounter This element must be supported. This element is included in summaries. 0..1 Reference(US Core Encounter Profile) 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].occurrencePeriod Period This type must be supported.
    ServiceRequest.occurrence[x].occurrenceDateTime dateTime
    ServiceRequest.occurrence[x].occurrenceTiming Timing
    ServiceRequest.authoredOn This element must be supported. This element is included in summaries. 0..1 dateTime Date request signed
    ServiceRequest.requester This element must be supported. This element is included in summaries. 0..1 Reference(US Core Practitioner Profile This type must be supported. | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core RelatedPerson Profile | US Core Device Profile) Who/what is requesting service
    ServiceRequest.reasonCode This element is included in summaries. 0..* CodeableConcept 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Explanation/Justification for procedure or service
    Binding: US Core Condition Codes (extensible)
    ServiceRequest.reasonReference This element is included in summaries. 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Profile that supports the requested service

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    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.category:us-core Base required US Core ServiceRequest Category Codes 📦10.0.0-ballot This IG
    ServiceRequest.code Base extensible US Core Procedure Codes 📦10.0.0-ballot This IG
    ServiceRequest.reasonCode Base extensible US Core Condition Codes 📦10.0.0-ballot This IG

    Constraints

    Id Grade Path(s) Description Expression

    This structure is derived from ServiceRequest

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    ServiceRequest 0..* ServiceRequest A request for a service to be performed
    ServiceRequest.identifier 0..* Identifier 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Identifiers assigned to this order instance
    ServiceRequest.status This element must be supported. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
    ServiceRequest.intent This element must be supported. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
    ServiceRequest.Slices for category This element must be supported. 0..* CodeableConcept Classification of service
    Slice: Unordered, Open by value:$this
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    ServiceRequest.Slices for category.category:us-core This element must be supported. 0..* CodeableConcept Classification of service
    Binding: US Core ServiceRequest Category Codes (required): Note that other codes are permitted in other slices, see Required Bindings When Slicing by Value Sets
    ServiceRequest.code This element must be supported. 1..1 CodeableConcept What is being requested/ordered
    Binding: US Core Procedure Codes (extensible)
    ServiceRequest.code.text 0..1 string 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The name of the test, procedure, or service to be performed.
    ServiceRequest.subject This element must be supported. 1..1 Reference(US Core Patient Profile This type must be supported. | Group | US Core Location Profile | US Core Device Profile) Individual or Entity the service is ordered for
    ServiceRequest.encounter This element must be supported. 0..1 Reference(US Core Encounter Profile) Encounter in which the request was created
    ServiceRequest.occurrence[x] This element must be supported. 0..1 When service should occur
    ServiceRequest.occurrence[x].occurrencePeriod Period This type must be supported.
    ServiceRequest.occurrence[x].occurrenceDateTime dateTime
    ServiceRequest.occurrence[x].occurrenceTiming Timing
    ServiceRequest.authoredOn This element must be supported. 0..1 dateTime Date request signed
    ServiceRequest.requester This element must be supported. 0..1 Reference(US Core Practitioner Profile This type must be supported. | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core RelatedPerson Profile | US Core Device Profile) Who/what is requesting service
    ServiceRequest.reasonCode 0..* CodeableConcept 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Explanation/Justification for procedure or service
    Binding: US Core Condition Codes (extensible)
    ServiceRequest.reasonReference 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Profile that supports the requested service

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    ServiceRequest.category:us-core Base required US Core ServiceRequest Category Codes 📦10.0.0-ballot This IG
    ServiceRequest.code Base extensible US Core Procedure Codes 📦10.0.0-ballot This IG
    ServiceRequest.reasonCode Base extensible US Core Condition Codes 📦10.0.0-ballot This IG
    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    ServiceRequest C 0..* ServiceRequest A request for a service to be performed
    Constraints: prr-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.extension 0..* Extension Additional content defined by implementations
    ServiceRequest.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    ServiceRequest.identifier This element is included in summaries. 0..* Identifier 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Identifiers assigned to this order instance
    ServiceRequest.instantiatesCanonical This element is included in summaries. 0..* canonical(ActivityDefinition | PlanDefinition) Instantiates FHIR protocol or definition
    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.Slices for category This element must be supported. This element is included in summaries. 0..* CodeableConcept Classification of service
    Slice: Unordered, Open by value:$this
    Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    ServiceRequest.Slices for category.category:us-core This element must be supported. This element is included in summaries. 0..* CodeableConcept Classification of service
    Binding: US Core ServiceRequest Category Codes (required): Note that other codes are permitted in other slices, see Required Bindings When Slicing by Value Sets
    ServiceRequest.priority 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 is included in summaries. 0..1 boolean True if service/procedure should not be performed
    ServiceRequest.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept What is being requested/ordered
    Binding: US Core Procedure Codes (extensible)
    ServiceRequest.code.id 0..1 string Unique id for inter-element referencing
    ServiceRequest.code.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    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 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The name of the test, procedure, or service to be performed.
    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(US Core Patient Profile This type must be supported. | Group | US Core Location Profile | US Core Device Profile) Individual or Entity the service is ordered for
    ServiceRequest.encounter This element must be supported. This element is included in summaries. 0..1 Reference(US Core Encounter Profile) 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].occurrencePeriod Period This type must be supported.
    ServiceRequest.occurrence[x].occurrenceDateTime dateTime
    ServiceRequest.occurrence[x].occurrenceTiming Timing
    ServiceRequest.asNeeded[x] 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. 0..1 dateTime Date request signed
    ServiceRequest.requester This element must be supported. This element is included in summaries. 0..1 Reference(US Core Practitioner Profile This type must be supported. | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core RelatedPerson Profile | US Core Device Profile) 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 is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | 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: US Core Condition Codes (extensible)
    ServiceRequest.reasonReference This element is included in summaries. 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Profile that supports the requested service
    ServiceRequest.insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
    ServiceRequest.supportingInfo 0..* Reference(Resource) Additional clinical 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.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.category:us-core Base required US Core ServiceRequest Category Codes 📦10.0.0-ballot This IG
    ServiceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
    ServiceRequest.code Base extensible US Core Procedure Codes 📦10.0.0-ballot This IG
    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.4
    ServiceRequest.reasonCode Base extensible US Core Condition Codes 📦10.0.0-ballot This IG
    ServiceRequest.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    ServiceRequest C 0..* ServiceRequest A request for a service to be performed
    Constraints: prr-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.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    ServiceRequest.identifier This element is included in summaries. 0..* Identifier 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Identifiers assigned to this order instance
    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.Slices for category This element must be supported. This element is included in summaries. 0..* CodeableConcept Classification of service
    Slice: Unordered, Open by value:$this
    Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    ServiceRequest.Slices for category.category:us-core This element must be supported. This element is included in summaries. 0..* CodeableConcept Classification of service
    Binding: US Core ServiceRequest Category Codes (required): Note that other codes are permitted in other slices, see Required Bindings When Slicing by Value Sets
    ServiceRequest.doNotPerform This element is a modifier element. This element is included in summaries. 0..1 boolean True if service/procedure should not be performed
    ServiceRequest.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept What is being requested/ordered
    Binding: US Core Procedure Codes (extensible)
    ServiceRequest.code.text This element is included in summaries. 0..1 string 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The name of the test, procedure, or service to be performed.
    ServiceRequest.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile This type must be supported. | Group | US Core Location Profile | US Core Device Profile) Individual or Entity the service is ordered for
    ServiceRequest.encounter This element must be supported. This element is included in summaries. 0..1 Reference(US Core Encounter Profile) 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].occurrencePeriod Period This type must be supported.
    ServiceRequest.occurrence[x].occurrenceDateTime dateTime
    ServiceRequest.occurrence[x].occurrenceTiming Timing
    ServiceRequest.authoredOn This element must be supported. This element is included in summaries. 0..1 dateTime Date request signed
    ServiceRequest.requester This element must be supported. This element is included in summaries. 0..1 Reference(US Core Practitioner Profile This type must be supported. | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core RelatedPerson Profile | US Core Device Profile) Who/what is requesting service
    ServiceRequest.reasonCode This element is included in summaries. 0..* CodeableConcept 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Explanation/Justification for procedure or service
    Binding: US Core Condition Codes (extensible)
    ServiceRequest.reasonReference This element is included in summaries. 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Profile that supports the requested service

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    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.category:us-core Base required US Core ServiceRequest Category Codes 📦10.0.0-ballot This IG
    ServiceRequest.code Base extensible US Core Procedure Codes 📦10.0.0-ballot This IG
    ServiceRequest.reasonCode Base extensible US Core Condition Codes 📦10.0.0-ballot This IG

    Constraints

    Id Grade Path(s) Description Expression

    Differential View

    This structure is derived from ServiceRequest

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    ServiceRequest 0..* ServiceRequest A request for a service to be performed
    ServiceRequest.identifier 0..* Identifier 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Identifiers assigned to this order instance
    ServiceRequest.status This element must be supported. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
    ServiceRequest.intent This element must be supported. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
    ServiceRequest.Slices for category This element must be supported. 0..* CodeableConcept Classification of service
    Slice: Unordered, Open by value:$this
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    ServiceRequest.Slices for category.category:us-core This element must be supported. 0..* CodeableConcept Classification of service
    Binding: US Core ServiceRequest Category Codes (required): Note that other codes are permitted in other slices, see Required Bindings When Slicing by Value Sets
    ServiceRequest.code This element must be supported. 1..1 CodeableConcept What is being requested/ordered
    Binding: US Core Procedure Codes (extensible)
    ServiceRequest.code.text 0..1 string 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The name of the test, procedure, or service to be performed.
    ServiceRequest.subject This element must be supported. 1..1 Reference(US Core Patient Profile This type must be supported. | Group | US Core Location Profile | US Core Device Profile) Individual or Entity the service is ordered for
    ServiceRequest.encounter This element must be supported. 0..1 Reference(US Core Encounter Profile) Encounter in which the request was created
    ServiceRequest.occurrence[x] This element must be supported. 0..1 When service should occur
    ServiceRequest.occurrence[x].occurrencePeriod Period This type must be supported.
    ServiceRequest.occurrence[x].occurrenceDateTime dateTime
    ServiceRequest.occurrence[x].occurrenceTiming Timing
    ServiceRequest.authoredOn This element must be supported. 0..1 dateTime Date request signed
    ServiceRequest.requester This element must be supported. 0..1 Reference(US Core Practitioner Profile This type must be supported. | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core RelatedPerson Profile | US Core Device Profile) Who/what is requesting service
    ServiceRequest.reasonCode 0..* CodeableConcept 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Explanation/Justification for procedure or service
    Binding: US Core Condition Codes (extensible)
    ServiceRequest.reasonReference 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Profile that supports the requested service

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    ServiceRequest.category:us-core Base required US Core ServiceRequest Category Codes 📦10.0.0-ballot This IG
    ServiceRequest.code Base extensible US Core Procedure Codes 📦10.0.0-ballot This IG
    ServiceRequest.reasonCode Base extensible US Core Condition Codes 📦10.0.0-ballot This IG

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    ServiceRequest C 0..* ServiceRequest A request for a service to be performed
    Constraints: prr-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.extension 0..* Extension Additional content defined by implementations
    ServiceRequest.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    ServiceRequest.identifier This element is included in summaries. 0..* Identifier 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Identifiers assigned to this order instance
    ServiceRequest.instantiatesCanonical This element is included in summaries. 0..* canonical(ActivityDefinition | PlanDefinition) Instantiates FHIR protocol or definition
    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.Slices for category This element must be supported. This element is included in summaries. 0..* CodeableConcept Classification of service
    Slice: Unordered, Open by value:$this
    Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    ServiceRequest.Slices for category.category:us-core This element must be supported. This element is included in summaries. 0..* CodeableConcept Classification of service
    Binding: US Core ServiceRequest Category Codes (required): Note that other codes are permitted in other slices, see Required Bindings When Slicing by Value Sets
    ServiceRequest.priority 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 is included in summaries. 0..1 boolean True if service/procedure should not be performed
    ServiceRequest.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept What is being requested/ordered
    Binding: US Core Procedure Codes (extensible)
    ServiceRequest.code.id 0..1 string Unique id for inter-element referencing
    ServiceRequest.code.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    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 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The name of the test, procedure, or service to be performed.
    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(US Core Patient Profile This type must be supported. | Group | US Core Location Profile | US Core Device Profile) Individual or Entity the service is ordered for
    ServiceRequest.encounter This element must be supported. This element is included in summaries. 0..1 Reference(US Core Encounter Profile) 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].occurrencePeriod Period This type must be supported.
    ServiceRequest.occurrence[x].occurrenceDateTime dateTime
    ServiceRequest.occurrence[x].occurrenceTiming Timing
    ServiceRequest.asNeeded[x] 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. 0..1 dateTime Date request signed
    ServiceRequest.requester This element must be supported. This element is included in summaries. 0..1 Reference(US Core Practitioner Profile This type must be supported. | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core RelatedPerson Profile | US Core Device Profile) 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 is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | 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: US Core Condition Codes (extensible)
    ServiceRequest.reasonReference This element is included in summaries. 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Profile that supports the requested service
    ServiceRequest.insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
    ServiceRequest.supportingInfo 0..* Reference(Resource) Additional clinical 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.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.category:us-core Base required US Core ServiceRequest Category Codes 📦10.0.0-ballot This IG
    ServiceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
    ServiceRequest.code Base extensible US Core Procedure Codes 📦10.0.0-ballot This IG
    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.4
    ServiceRequest.reasonCode Base extensible US Core Condition Codes 📦10.0.0-ballot This IG
    ServiceRequest.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression

     

    Other representations of profile: CSV, Excel, Schematron

    Notes:


    Quick Start


    Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the US Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only US Core Profiles (Profile Only Support) are not required to support these interactions. See the US Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.

    • See the Scopes Format section for a description of the SMART scopes syntax.
    • See the Search Syntax section for a description of the US Core search syntax.
    • See the General Requirements section for additional rules and expectations when a Server requires status parameters.
    • See the General Guidance section for additional guidance on searching for multiple patients.

    US Core Scopes

    Servers providing access to order and referral data SHALL support these US Core SMART Scopes:

    Servers providing access to order and referral data MAY support these US Core SMART Scopes:

    • granular scopes: <patient|user|system>/ServiceRequest.rs?category=http://hl7.org/fhir/us/core/CodeSystem/us-core-category|sdoh

    Mandatory Search Parameters:

    The following search parameters and search parameter combinations SHALL be supported:

    1. SHALL support both read ServiceRequest by id AND ServiceRequest search using the _id search parameter

      GET [base]/ServiceRequest?_id=[id]' or 'GET [base]/ServiceRequest/[id]

      Examples:

      1. GET [base]/ServiceRequest/1032702

      2. GET [base]/ServiceRequest?_id=1032702

      Implementation Notes: Fetches a US Core ServiceRequest Profile resource or a search Bundle containing a US Core ServiceRequest Profile resource matching the id (see Parameters for all resources).

    2. SHALL support searching for all servicerequests for a patient using the patient search parameter

      GET [base]/ServiceRequest?patient={Patient/}[id]

      Example:

      1. GET [base]/ServiceRequest?patient=Patient/1137192

      Implementation Notes: Fetches a bundle of all US Core ServiceRequest Profile resources for the specified patient ( see how to search by reference).

    3. SHALL support searching for all reports by category codes specified in US Core DiagnosticReport Category Codes using the combination of the patient and category search parameters

      GET [base]/ServiceRequest?patient={Patient/}[id]&category={system|}[search_code]

      Example:

      1. GET [base]/ServiceRequest?patient=Patient/1137192&category=http://loinc.org|LG41762-2

      Implementation Notes: Fetches a bundle of all US Core ServiceRequest Profile resources for the specified patient and a category code = "LG41762-2 (SDOH)" ( see how to search by reference and how to search by token).

    4. SHALL support searching for all reports by code using the combination of the patient and code search parameters

      • Including optional support OR search on code (e.g.code={system|}[code],{system|}[code],...)

      GET [base]/ServiceRequest?patient={Patient/}[id]&code={system|}[search_code]{,{system|}[code],...}

      Example:

      1. GET [base]/ServiceRequest?patient=Patient/1137192&code=http://snomed.info/sct|35637008

      Implementation Notes: Fetches a bundle of all US Core ServiceRequest Profile resources for the specified patient and report code(s). SHOULD support search by multiple codes. ( see how to search by reference and how to search by token).

    5. SHALL support searching for all reports by category codes specified in US Core DiagnosticReport Category Codes and date using the combination of the patient and category and authored search parameters

      • Including optional support for AND search on authored (e.g.authored=[date]&authored=[date]&...)

      • Including support for these authored comparators: "gt", "lt", "ge", "le"

      GET [base]/ServiceRequest?patient={Patient/}[id]&category={system|}[search_code]&authored={gt|lt|ge|le}[dateTime]{&date={gt|lt|ge|le}[dateTime]&...}

      Example:

      1. GET [base]/ServiceRequest?patient=Patient/1137192&category=http://loinc.org|LG41762-2&date=ge2010-01-14T00:00:00Z

      Implementation Notes: Fetches a bundle of all US Core ServiceRequest Profile resources for the specified patient and date and a category code = "LG41762-2 (SDOH)" ( see how to search by reference and how to search by token and how to search by date).

    Optional Search Parameters:

    The following search parameters and search parameter combinations SHOULD be supported

    1. SHOULD support searching for all orders for a patient by a business identifier using the combination of the patient and identifier search parameters

      GET [base]/ServiceRequest?patient={Patient/}[id]&identifier={system|}[search_code]

      Example:

      1. GET [base]/ServiceRequest?patient=Patient/1137192&identifier=http://example.org/radiology/accession|A20190203001

      Implementation Notes: Fetches a bundle of all US Core ServiceRequest Profile resources for the specified patient and identifier. This allows a known accession or business identifier to be used to locate the corresponding order. ( see how to search by reference and how to search by token).

    2. SHOULD support searching for all reports for a patient for a given status (for example completed reports ) using the combination of the patient and status search parameters

      • Including support OR search on status (e.g.status={system|}[code],{system|}[code],...)

      GET [base]/ServiceRequest?patient={Patient/}[id]&status={system|}[search_code]{,{system|}[code],...}

      Example:

      1. GET [base]/ServiceRequest?patient=Patient/1137192&status=completed

      Implementation Notes: Fetches a bundle of all US Core ServiceRequest Profile resources for the specified patient and status ( see how to search by reference and how to search by token).

    3. SHOULD support searching for reports by code and date using the combination of the patient and code and authored search parameters

      • Including optional support OR search on code (e.g.code={system|}[code],{system|}[code],...)

      • Including optional support for AND search on authored (e.g.authored=[date]&authored=[date]&...)

      • Including support for these authored comparators: "gt", "lt", "ge", "le"

      GET [base]/ServiceRequest?patient={Patient/}[id]&code={system|}[search_code]{,{system|}[code],...}&authored={gt|lt|ge|le}[dateTime]{&date={gt|lt|ge|le}[dateTime]&...}

      Example:

      1. GET [base]/ServiceRequest?patient=Patient/1137192&code=http://snomed.info/sct|35637008&date=ge2019-01-14T00:00:00Z

      Implementation Notes: Fetches a bundle of all US Core ServiceRequest Profile resources for the specified patient and date and service code(s). SHOULD support search by multiple codes. ( see how to search by reference and how to search by token and how to search by date).