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

Search Parameters and Operations

Page standards status: Informative

The following operations and search parameters have been defined for the US Core Implementation Guide. For more information on the FHIR RESTful operations, FHIR RESTful search api, and the standard Search Parameter Registry, see the FHIR specification.

Operations

US Core Fetch DocumentReference

Search Parameters

NOTE: The following search parameters SHALL NOT be interpreted on their own as requirements for the server. The CapabilityStatement defines the search capabilities expectations for the US Core Server. This section lists the search parameters definitions that are used within the CapabilityStatement. This is not a list of search requirements for the client or server. Certain search parameters have been defined without explicit categorization as either Mandatory or Optional search parameters. They are provided to assist implementers who may find them relevant to their specific use cases.

Search Parameters defined by this Implementation Guide

CareTeam

• role

Condition

• asserted-date

Encounter

• discharge-disposition

Goal

• description

Patient

• race
• ethnicity
• gender-identity

Search Parameters derived from the Base FHIR Specification

These US Core SearchParameters are derived from the Base FHIR Specification to define the expectations for the following SearchParameter elements:

• multipleAnd
• multipleOr
• comparator
• modifier
• chain

AllergyIntolerance

• clinical-status
• patient

CarePlan

• category
• date
• patient
• status

CareTeam

• patient
• status

Condition

• abatement-date
• category
• clinical-status
• code
• encounter
• onset-date
• patient
• recorded-date

Coverage

• patient

Device

• patient
• status
• type

DiagnosticReport

• category
• code
• date
• patient
• status

DocumentReference

• _id
• category
• date
• patient
• period
• status
• type

Encounter

• _id
• class
• date
• identifier
• location
• patient
• status
• type

Goal

• lifecycle-status
• patient
• target-date

Immunization

• date
• patient
• status

Location

• address
• address-city
• address-postalcode
• address-state
• name

MedicationDispense

• patient
• status
• type

MedicationRequest

• authoredon
• encounter
• intent
• patient
• status

Observation

• category
• code
• date
• patient
• status

Organization

• address
• name

Patient

• _id
• birthdate
• death-date
• family
• gender
• given
• identifier
• name

Practitioner

• _id
• identifier
• name

PractitionerRole

• practitioner
• specialty

Procedure

• code
• date
• patient
• status

QuestionnaireResponse

• _id
• authored
• patient
• questionnaire
• status

RelatedPerson

• _id
• name
• patient

ServiceRequest

• _id
• authored
• category
• code
• patient
• status

Specimen

• _id
• patient