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 9.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

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.

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.

• race
• ethnicity

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

• role

Condition

• asserted-date

Encounter

• discharge-disposition

Goal

• description

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

• clinical-status
• patient

CarePlan

• category
• date
• patient
• status

CareTeam

• patient
• status

Condition

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

Coverage

• patient

Device

• patient
• status
• type

DiagnosticReport

• _lastUpdated
• category
• code
• date
• patient
• status

DocumentReference

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

Encounter

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

FamilyMemberHistory

• code
• patient

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

• _lastUpdated
• category
• code
• date
• patient
• status

Organization

• address
• name

Patient

• _id
• birthdate
• death-date
• family
• 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