US Quality Core Implementation Guide
0.1.0 - cibuild
US Quality Core Implementation Guide
0.1.0 - cibuild
US Quality Core Implementation Guide, published by ASTP. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/FHIR/us-quality-core/ and changes regularly. See the Directory of published versions
| Official URL: http://fhir.org/guides/astp/us-quality-core/CapabilityStatement/us-quality-core-server | Version: 0.1.0 | |||
| Active as of 2026-03-31 | Computable Name: USQualityCoreServerCapabilityStatement | |||
This capability statement describes the expected capabilities of the US Quality Core Servers which is responsible for responding to USCDI+ Quality V1 queries submitted by US Quality Core Clients. It describes a minimum set of FHIR RESTful operations and search parameters necessary to enable access to the set of USCDI+ Quality V1 data that is in scope of this implementation guide. For more information about which USCDI+ Quality data elements are in scope, please review the USCDI+ Quality section of this implementation guide.
US Quality Core Servers SHALL support the capabilities described in the US Core Server CapabilityStatement STU6.1. Some RESTFUL operations and search parameters described in the US Quality Core Server CapabilityStatement are redundant to the US Core Server CapabilityStatement, but are listed here to highlight which capabilities are specifically relevant to USCDI+ Quality V1.
The US Quality Core Implementation Guide v1 is derived from the QI-Core Implementation Guide STU6. It adopts all profiles within the QI-Core Implementation Guide STU6 to enable a more seamless adoption of this implementation guide. However, only those profiles that contain USCDI+ Quality V1 data are required to be supported by US Quality Core Servers. The FHIR RESTful operations and search parameters in this capability statement reflects this scope.
Raw OpenAPI-Swagger Definition file | Download
jsonNote to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
serverThe US Quality Core Server SHALL:
NOTE: US Quality Core SearchParameters referenced in this CapabilityStatement that are derived from standard FHIR SearchParameters are only defined to document Server and Client expectations, such as comparator expectations, and to support generation tooling. They SHALL NOT be interpreted as search parameters for searching. Servers and Clients SHOULD use the standard FHIR SearchParameters.
transactioninteraction.batchinteraction.search-systeminteraction.history-systeminteraction.The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revincluderesolvesread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | subject | reference | The client SHALL provide an id value for the reference. |
| MAY | event | token | The client MAY provide a code value. |
| MAY | recordedDate | date | The client MAY provide a date value. |
| Conformance | Parameters | Types |
|---|---|---|
| SHALL | subject+event | reference+token |
| SHALL | subject+recordedDate | reference+date |
resolvesread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The client SHALL provide an id value for the reference. |
resolvesread, search-type.resolvesread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The client SHALL provide an id value for the reference. |
resolvesread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The client SHALL provide an id value for the reference. |
| MAY | category | token | The client MAY provide a category. |
| MAY | code | token | The client MAY provide a code value. |
| MAY | onset-date | date | The client MAY provide a date value. |
| MAY | abatement-date | date | The client MAY provide a date value. |
| Conformance | Parameters | Types |
|---|---|---|
| SHALL | patient+category | reference+token |
| SHOULD | patient+abatement-date | reference+date |
| SHOULD | patient+code | reference+token |
| SHOULD | patient+onset-date | reference+date |
resolvesread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The client SHALL provide an id value for the reference. |
resolvesread, search-type.US Quality Core DeviceRequest
US Quality Core Device Not Requested
resolvesread, search-type.resolvesread, search-type.resolvesread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The client SHALL provide an id value for the reference. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The client SHALL provide an id value for the reference. |
resolvesread, search-type.US Quality Core Immunization
US Quality Core Immunization Not Done
resolvesread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | The client SHALL provide an id value. |
resolvesread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | code | token | The client SHALL provide a code value. |
resolvesread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The client SHALL provide an id value for the reference. |
| MAY | status | token | The client MAY provide a status. |
| MAY | code | token | The client MAY provide a code value. |
| MAY | effective-time | date | The client MAY provide a date value. |
resolvesread, search-type.resolvesread, search-type.resolvesread, search-type.resolvesread.search-type.resolvesread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | The client SHALL provide an id value. |
resolvesread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | The client SHALL provide an id value. |
resolvesread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | The client SHALL provide an id value. |
resolvesread, search-type.resolvesread, search-type.resolvesread, search-type.US Quality Core ServiceRequest
US Quality Core Service Not Requested
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | The client SHALL provide an id value. |
| SHALL | patient | reference | The client SHALL provide an id value for the reference. |
| MAY | category | token | The client MAY provide a category. |
| MAY | code | token | The client MAY provide a code value. |
| MAY | authored | date | The client MAY provide a date value. |