HL7.FHIR.US.CORE\US Core Service Request - FHIR v4.0.1 (2024)

This page is part of the US Core (v4.1.0: STU5 Ballot 1) based on FHIR R4. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions HL7.FHIR.US.CORE\US Core Service Request - FHIR v4.0.1 (1)

This profile sets minimum expectations for searching and fetching using the ServiceRequest resource. This profile identifies the mandatory core elements, extensions, vocabularies and value sets which SHALL be present in the ServiceRequest when using this profile.

Example Usage Scenarios:

The following are example usage scenarios for the Service Request 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 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 Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each Service Request must have:

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

Each Service Request must support:

  1. a category
  2. when requested service should happen
  3. when request was made
  4. the requester

Profile specific implementation guidance:

  • See SDOH Guidance for more information when exchanging Social Determinants of Health (SDOH) Service Requests.
  • The ServiceRequest.category binding must support at a minimum the US Core ServiceRequestCategory Codes. Within this categorization scheme/axis, other categories codes may be supported and alternate codes may be provided in addition to the standard codes. See Using multiple codes with CodeableConcept Datatype for examples. Other categorization schemes to be used as well.

Examples

  • Foodpantry Referral

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.

  • The syntax used to describe the interactions is described here.
  • See the General Guidance 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.

Mandatory Search Parameters:

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

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

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

    Example:

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

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

  2. SHALL support fetching a ServiceRequest using the _id search parameter:

    GET [base]/ServiceRequest[id]

    Example:

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

    Implementation Notes: (how to search by the logical id of the resource)

  3. SHALL support searching using the combination of the patient and category search parameters:

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

    Example:

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

    Implementation Notes: Fetches a bundle of all ServiceRequest resources for the specified patient and a category code (how to search by reference and how to search by token)

  4. SHALL support searching using the combination of the patient and code search parameters:
    • including optional support for OR search on code (e.g.code={system|}[code],{system|}[code],...)

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

    Example:

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

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

  5. SHALL support searching using the combination of the patient and category and authored search parameters:
    • including support for these authored comparators: gt,lt,ge,le
    • including optional support for AND search on authored (e.g.authored=[date]&authored=[date]]&...)

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

    Example:

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

    Implementation Notes: Fetches a bundle of all ServiceRequest resources for the specified patient and date and a category code (how to search by reference and how to search by token and how to search by date)

Optional Search Parameters:

The following search parameter combinations SHOULD be supported:

  1. SHOULD support searching using the combination of the patient and status search parameters:
    • including support for OR search on status (e.g.status={system|}[code],{system|}[code],...)

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

    Example:

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

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

  2. SHOULD support searching using the combination of the patient and code and authored search parameters:
    • including optional support for OR search on code (e.g.code={system|}[code],{system|}[code],...)
    • including support for these authored comparators: gt,lt,ge,le
    • including optional support for AND search on authored (e.g.authored=[date]&authored=[date]]&...)

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

    Example:

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

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

HL7.FHIR.US.CORE\US Core Service Request - FHIR v4.0.1 (2024)

FAQs

What is FHIR US Core? ›

US Core and how it relates to USCDI

They focus on a subset of FHIR resources and data elements that are considered essential for interoperability and support common use cases. These specify the content, structure, and format of the data to be exchanged to achieve interoperability and align systems and implementations.

What are the HL7 FHIR standards? ›

The HL7® FHIR® (Fast Healthcare Interoperability Resources 1 ) standard defines how healthcare information can be exchanged between different computer systems regardless of how it is stored in those systems.

What is the difference between HL7 and FHIR API? ›

The main difference between FHIR and HL7 is that FHIR leverages RESTful web services and open web technologies such as XML, JSON, and RDF, while HL7 only supports XML. FHIR builds on previous standards, including HL7 CDA, V2, and V3, but is easier to use since it covers a broader range of technologies.

What is a FHIR implementation guide? ›

National standards, vendor consortiums, clinical societies, etc publish "implementation guides" that define how the capabilities defined by the FHIR specification are used in particular data exchanges, or to solve particular problems.

What is an example of HL7 in healthcare? ›

Example HL7 Message:

Every HL7 message specifies MSH as its first segment. The PID (Patient Information) segment contains demographic information about the patient, such as name, patient ID and address. The NK1 (Next of Kin) segment contains contact information for the patient's next of kin.

Why is HL7 used in healthcare? ›

HL7 is a set of international standards used to transfer and share data between various healthcare providers. More specifically, HL7 helps bridge the gap between health IT applications and makes sharing healthcare data easier and more efficient when compared to older methods.

Do all hospitals use HL7? ›

In the U.S., more than 90% of medical institutions use HL7 in their work. These are mainly hospitals, private clinics, public health agencies, health care software vendors, laboratories, pharmaceutical companies, and other patient care and medical facilities. There are other categories of professionals who use HL7.

Is HL7 outdated? ›

HL7 v2. x is becoming outdated in the face of new technologies and data exchange requirements, suggesting that HL7 is indeed outdated.

Does FHIR replace HL7? ›

FHIR is the standard developed by Health Level Seven International, as well as other standards whose names start with HL7. FHIR is an innovative healthcare standard that summarizes strong points, fills gaps in previous HL7 standards, and employs existing web technologies that simplify its implementation.

What is the purpose of a FHIR server? ›

FHIR servers facilitate healthcare data exchange between different apps and computer systems. They support data transmission using the FHIR standard, allowing disparate healthcare IT systems and platforms to communicate with one another.

What companies are using FHIR? ›

What companies use FHIR? Some of the companies that use FHIR include Bitcare GmbH, Smile Digital Health, Dice, Omnicell, 1upHealth, CVS Health, Deloitte, Andor Health, Olympus Corporation, GE HealthCare and many more. You can find a complete list of 4,342 companies that use FHIR on TheirStack.com.

What is the purpose of the FHIR program? ›

Electronic health records (EHRs) represent patient data in different ways (e.g., medications, encounters) and FHIR provides a means for representing and sharing information among clinicians and organizations in a standard way regardless of the ways local EHRs represent or store the data.

What is the difference between Uscdi and US core? ›

ONC's USCDI and FHIR US Core are complementary initiatives, with USCDI defining high-level data requirements and FHIR US Core providing detailed FHIR-based profiles for meeting those requirements.

What is the use of FHIR in digital health? ›

Unlike previous standards, FHIR lets you easily build innovative applications that efficiently gather, aggregate, and analyze diverse healthcare and administrative data from disparate sources.

References

Top Articles
Latest Posts
Recommended Articles
Article information

Author: Gregorio Kreiger

Last Updated:

Views: 5299

Rating: 4.7 / 5 (77 voted)

Reviews: 84% of readers found this page helpful

Author information

Name: Gregorio Kreiger

Birthday: 1994-12-18

Address: 89212 Tracey Ramp, Sunside, MT 08453-0951

Phone: +9014805370218

Job: Customer Designer

Hobby: Mountain biking, Orienteering, Hiking, Sewing, Backpacking, Mushroom hunting, Backpacking

Introduction: My name is Gregorio Kreiger, I am a tender, brainy, enthusiastic, combative, agreeable, gentle, gentle person who loves writing and wants to share my knowledge and understanding with you.