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

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: The following search parameters SHALL NOT be interpreted as server requirements. The CapabilityStatement defines the search capabilities expectations for the US Core Server. This section lists the search parameter definitions used within the CapabilityStatement. It 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. 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

The following search parameters have been defined without explicit categorization as either Mandatory or Optional. They are provided to assist implementers who may find them relevant to their specific use cases.

• race
• ethnicity
• gender-identity

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

For search operations, Servers and Clients SHOULD use the standard FHIR SearchParameter.

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

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
• 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