US Core Implementation Guide
8.0.0-ballot - STU8 Ballot United States of America flag

This page is part of the US Core (v8.0.0-ballot: STU8 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 7.0.0. For a full list of available versions, see the Directory of published versions

Search Parameters and Operations

Page standards status: Trial-use

Operations

The following operation has been defined for the US Core Implementation Guide. For more information on FHIR RESTful operations, see the FHIR specification.

  • US Core Fetch DocumentReference


    • Search Parameters

    The following search parameters have been defined for the US Core Implementation Guide. The FHIR specification provides more information on the FHIR RESTful search API and the standard Search Parameter Registry.

    SEE IMPLEMENTER NOTES BELOW

    Optional Search Parameters

    The following search parameters have been defined as optional search parameters for search. US Core does not define any Server or Client expectations for their use.

    Search Parameters defined by this Implementation Guide

    The following search parameters have been defined by US Core. They are defined to be used for search and to document Server and Client expectations. Unlike the search parameter in the next section, they are not derived from the standard FHIR SearchParameters.

    CareTeam
    Condition
    Encounter
    Goal
    Patient

    Search Parameters derived from the Base FHIR Specification

    These SearchParameter are used solely to document Server and Client expectations. Their definitions are derived from the standard FHIR SearchParameter and define additional expectations for the following SearchParameter elements:

    • multipleAnd
    • multipleOr
    • comparator
    • modifier
    • chain

    They SHALL NOT be interpreted as search parameters for search. Servers and Clients SHOULD use the standard FHIR SearchParameters.

    AllergyIntolerance
    CarePlan
    CareTeam
    Condition
    Coverage
    Device
    DiagnosticReport
    DocumentReference
    Encounter
    Goal
    Immunization
    Location
    MedicationDispense
    MedicationRequest
    Observation
    Organization
    Patient
    Practitioner
    PractitionerRole
    Procedure
    QuestionnaireResponse
    RelatedPerson
    ServiceRequest
    Specimen