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 ONC. 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/onc/us-quality-core/CapabilityStatement/us-quality-core-client | Version: 0.1.0 | |||
| Active as of 2026-03-31 | Computable Name: USQualityCoreClientCapabilityStatement | |||
This capability statement describes the expected capabilities of the US Quality Core Client which is responsible for initiating queries for USCDI+ Quality V1 data from US Quality Core Servers. The set of FHIR RESTful operations and search parameters required to be supported by US Quality Core Servers is provided in the US Quality Core Server Capability Statement. US Quality Core Clients have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.
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.
clientThe US Quality Core Client SHALL:
NOTE: US 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_revinclude| Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|
| AdverseEvent | Supported Profiles US Quality Core AdverseEvent | Y | Y | subject, event, recordedDate, subject+event, subject+recordedDate | |||||
| AllergyIntolerance | Supported Profiles US Quality Core AllergyIntolerance | Y | Y | patient | |||||
| CarePlan | Supported Profiles US Quality Core CarePlan | Y | Y | patient, category, patient+category | |||||
| CareTeam | Supported Profiles US Quality Core CareTeam | Y | Y | patient, status, patient+status | |||||
| Claim | Supported Profiles US Quality Core Claim | Y | Y | patient | |||||
| Condition | Supported Profiles US Quality Core Condition Encounter Diagnosis US Quality Core Condition Problems Health Concerns | Y | Y | patient, category, code, onset-date, abatement-date, patient+abatement-date, patient+category, patient+code, patient+onset-date | |||||
| Coverage | Supported Profiles US Quality Core Coverage | Y | Y | patient | |||||
| DeviceRequest | Supported Profiles US Quality Core DeviceRequest US Quality Core Device Not Requested | Y | Y | patient, code, do-not-perform, patient+code, patient+do-not-perform | |||||
| DiagnosticReport | Supported Profiles US Quality Core DiagnosticReport Profile for Report and Note Exchange US Quality Core DiagnosticReport Profile for Laboratory Results Reporting | Y | Y | patient, category, code, date, patient+category, patient+category+date, patient+code | |||||
| Encounter | Supported Profiles US Quality Core Encounter | Y | Y | _id, patient, type, date, patient+type, patient+date | |||||
| FamilyMemberHistory | Supported Profiles US Quality Core FamilyMemberHistory | Y | Y | patient | |||||
| Goal | Supported Profiles US Quality Core Goal | Y | Y | patient | |||||
| Immunization | Supported Profiles US Quality Core Immunization US Quality Core Immunization Not Done | Y | Y | patient, status, date, patient+date, patient+status | |||||
| Location | Supported Profiles US Quality Core Location | Y | Y | _id | |||||
| Medication | Supported Profiles US Quality Core Medication | Y | Y | code | |||||
| MedicationAdministration | Supported Profiles US Quality Core MedicationAdministration US Quality Core MedicationAdministration Not Done | Y | Y | patient, status, code, effective-time, patient+status, patient+code, patient+effective-time | |||||
| MedicationDispense | Supported Profiles US Quality Core MedicationDispense US Quality Core MedicationDispense Declined | Y | Y | patient, status, patient+status | |||||
| MedicationRequest | Supported Profiles US Quality Core MedicationRequest US Quality Core Medication Not Requested | Y | Y | patient, intent, do-not-perform, patient+intent, patient+do-not-perform | |||||
| Observation | Supported Profiles US Quality Core Observation Clinical Result US Quality Core Simple Observation US Quality Core Observation Screening Assessment US Quality Core Observation Cancelled US Quality Core Laboratory Result Observation | Y | Y | patient, category, status, code, date, patient+category, patient+category+date, patient+code, patient+status | |||||
| Organization | Supported Profiles US Quality Core Organization | Y | y? | ||||||
| Patient | Supported Profiles US Quality Core Patient | Y | Y | _id | |||||
| Practitioner | Supported Profiles US Quality Core Practitioner | Y | Y | _id | |||||
| PractitionerRole | Supported Profiles US Quality Core PractitionerRole | Y | Y | _id | |||||
| Procedure | Supported Profiles US Quality Core Procedure US Quality Core Procedure Not Done | Y | Y | patient, status, date, patient+status, patient+date | |||||
| RelatedPerson | Supported Profiles US Quality Core RelatedPerson | Y | Y | _id, patient | |||||
| ServiceRequest | Supported Profiles US Quality Core ServiceRequest US Quality Core Service Not Requested | Y | Y | _id, patient, category, code, authored, do-not-perform, patient+category, patient+category+authored, patient+code, patient+do-not-perform | |||||
| Task | Supported Profiles US Quality Core Task US Quality Core Task Rejected | Y | Y | patient, status, code, patient+status, patient+code |
resolvesread, 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
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The client SHALL provide an id value for the reference. |
| MAY | code | token | The client MAY provide a code value. |
| MAY | do-not-perform | token | The client MAY provide a token value. |
| Conformance | Parameters | Types |
|---|---|---|
| SHALL | patient+code | reference+token |
| SHALL | patient+do-not-perform | reference+token |
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.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| MAY | patient | reference | The client SHALL provide an id value for the reference. |
| MAY | intent | token | The client MAY provide a token value. |
| MAY | do-not-perform | token | The client MAY provide a token value. |
| Conformance | Parameters | Types |
|---|---|---|
| SHALL | patient+intent | reference+token |
| SHALL | patient+do-not-perform | reference+token |
resolvesread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| MAY | patient | reference | The client SHALL provide an id value for the reference. |
| MAY | category | token | The client MAY provide a category. |
| MAY | status | token | The client MAY provide a status. |
| MAY | code | token | The client MAY provide a code value. |
| MAY | date | date | The client MAY provide a date value. |
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. |
| MAY | do-not-perform | token | The client MAY provide a token value. |