US Quality Core Implementation Guide
1.0.0-ballot - STU 1 - ballot
US Quality Core Implementation Guide
1.0.0-ballot - STU 1 - ballot
US Quality Core Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 1.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/fhir-us-quality-core/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/quality-core/CapabilityStatement/us-quality-core-client | Version: 1.0.0-ballot | ||||
| Standards status: Trial-use | Maturity Level: 4 | Computable Name: USQualityCoreClientCapabilityStatement | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.78.13.1 | |||||
This capability statement describes the expected capabilities of the US Quality Core Client, which is responsible for initiating queries for USCDI+ Quality V2 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
Language: en
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 Quality Core and 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. Actual searches 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.Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale subjectAdded in US Quality Core. Supports subject-scoped retrieval of AdverseEvent resources for USCDI+ Quality workflows. subject+eventAdded in US Quality Core. Supports subject-scoped retrieval of AdverseEvent resources filtered by event for USCDI+ Quality workflows. subject+recorded-dateAdded in US Quality Core. Supports subject-scoped retrieval of AdverseEvent resources filtered by recorded date so quality workflows can constrain results to relevant reporting periods.
| 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 | recorded-date | date | The client MAY provide a date value. |
| Conformance | Parameters | Types |
|---|---|---|
| SHALL | subject+event | reference+token |
| SHALL | subject+recorded-date | reference+date |
resolvesread, search-type.Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale patientRequired by US Core. Supports patient-scoped retrieval of AllergyIntolerance resources for USCDI+ Quality workflows.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The client SHALL provide an id value for the reference. |
resolvesread, search-type.Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale patient+categoryRequired by US Core. Supports patient-scoped retrieval of CarePlan resources filtered by category for USCDI+ Quality workflows.
resolvesread, search-type.Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale patient+statusRequired by US Core. Supports patient-scoped retrieval of CareTeam resources filtered by status for status-sensitive quality workflows.
resolvesread, search-type.Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale subjectAdded in US Quality Core. Supports subject-scoped retrieval of Communication resources for USCDI+ Quality workflows. subject+topicAdded in US Quality Core. Supports subject-scoped retrieval of Communication resources filtered by topic for USCDI+ Quality workflows. subject+statusAdded in US Quality Core. Supports subject-scoped retrieval of Communication resources filtered by status; status is used to indicate negation.
resolvesread, search-type.Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale patientRequired by US Core. Supports patient-scoped retrieval of Condition resources for USCDI+ Quality workflows. patient+categoryRequired by US Core. Supports patient-scoped retrieval of Condition resources filtered by category for USCDI+ Quality workflows. patient+codeRecommended by US Core; US Quality Core strengthens this to SHALL. Supports patient-scoped retrieval of Condition resources filtered by code for USCDI+ Quality workflows.
resolvesread, search-type.Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale patientRequired by US Core. Supports patient-scoped retrieval of Coverage resources for USCDI+ Quality workflows.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The client SHALL provide an id value for the reference. |
Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale patientRequired by US Core. Supports patient-scoped retrieval of Device resources for USCDI+ Quality workflows. patient+typeRecommended by US Core; US Quality Core strengthens this to SHALL. Supports patient-scoped retrieval of Device resources filtered by type for USCDI+ Quality workflows.
resolvesread, search-type.Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale patientAdded in US Quality Core. Supports patient-scoped retrieval of DeviceRequest resources for USCDI+ Quality workflows. patient+codeAdded in US Quality Core. Supports patient-scoped retrieval of DeviceRequest resources filtered by code for USCDI+ Quality workflows. patient+do-not-performAdded in US Quality Core. Supports patient-scoped retrieval of DeviceRequest resources filtered by a do-not-perform indicator to support negation workflows.
| 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.Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale patientRequired by US Core. Supports patient-scoped retrieval of DiagnosticReport resources for USCDI+ Quality workflows. patient+categoryRequired by US Core. Supports patient-scoped retrieval of DiagnosticReport resources filtered by category for USCDI+ Quality workflows. patient+category+dateRequired by US Core. Supports patient-scoped retrieval of DiagnosticReport resources filtered by category and date so quality workflows can constrain results to relevant reporting periods. patient+codeRequired by US Core. Supports patient-scoped retrieval of DiagnosticReport resources filtered by code for USCDI+ Quality workflows.
resolvesread, search-type.Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale _idRequired by US Core. Supports retrieval of a known DocumentReference resource by id. patientRequired by US Core. Supports patient-scoped retrieval of DocumentReference resources for USCDI+ Quality workflows. patient+typeRequired by US Core. Supports patient-scoped retrieval of DocumentReference resources filtered by type for USCDI+ Quality workflows. patient+categoryRequired by US Core. Supports patient-scoped retrieval of DocumentReference resources filtered by category for USCDI+ Quality workflows. patient+category+dateRequired by US Core. Supports patient-scoped retrieval of DocumentReference resources filtered by category and date so quality workflows can constrain results to relevant reporting periods.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The client SHALL provide an id value for the reference. |
| SHALL | _id | token | The client SHALL provide a token value. |
| MAY | category | token | The client MAY provide a token value. |
| MAY | date | date | The client MAY provide a date value. |
| MAY | type | token | The client MAY provide a token value. |
resolvesread, search-type.Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale _idRequired by US Core. Supports retrieval of a known Encounter resource by id. patientRequired by US Core. Supports patient-scoped retrieval of Encounter resources for USCDI+ Quality workflows. patient+typeRecommended by US Core; US Quality Core strengthens this to SHALL. Supports patient-scoped retrieval of Encounter resources filtered by type for USCDI+ Quality workflows. patient+dateRequired by US Core. Supports patient-scoped retrieval of Encounter resources filtered by date so quality workflows can constrain results to relevant reporting periods.
resolvesread, search-type.Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale patientRequired by US Core. Supports patient-scoped retrieval of FamilyMemberHistory resources for USCDI+ Quality workflows.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The client SHALL provide an id value for the reference. |
Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale patientRequired by US Core. Supports patient-scoped retrieval of Goal resources for USCDI+ Quality workflows.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The client SHALL provide an id value for the reference. |
resolvesread, search-type.Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale subjectAdded in US Quality Core. Supports subject-scoped retrieval of ImagingStudy resources for USCDI+ Quality workflows.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | subject | reference | The client SHALL provide an id value for the reference. |
resolvesread, search-type.Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale patientRequired by US Core. Supports patient-scoped retrieval of Immunization resources for USCDI+ Quality workflows. patient+statusRecommended by US Core; US Quality Core strengthens this to SHALL. Supports patient-scoped retrieval of Immunization resources filtered by status; status is used to indicate negation.
Search requirements are selected according to the rules described in Search Requirement Selection. US Quality Core does not define additional required individual search parameters or required search parameter combinations for this resource. Implementations still support the required interactions in this CapabilityStatement and any applicable US Core requirements independently.
resolvesread, search-type.Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale codeAdded in US Quality Core. Supports retrieval of Medication resources filtered by code for USCDI+ Quality workflows.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | code | token | The client SHALL provide a code value. |
resolvesread, search-type.Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale patientAdded in US Quality Core. Supports patient-scoped retrieval of MedicationAdministration resources for USCDI+ Quality workflows. patient+statusAdded in US Quality Core. Supports patient-scoped retrieval of MedicationAdministration resources filtered by status; status is used to indicate negation. patient+codeAdded in US Quality Core. Supports patient-scoped retrieval of MedicationAdministration resources filtered by code for USCDI+ Quality workflows. patient+effective-timeAdded in US Quality Core. Supports patient-scoped retrieval of MedicationAdministration resources filtered by effective time so quality workflows can constrain results to relevant reporting periods.
| 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.Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale patientRequired by US Core. Supports patient-scoped retrieval of MedicationDispense resources for USCDI+ Quality workflows. patient+statusRecommended by US Core; US Quality Core strengthens this to SHALL. Supports patient-scoped retrieval of MedicationDispense resources filtered by status; status is used to indicate negation.
resolvesread, search-type.Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale patient+intent+do-not-performAdded in US Quality Core. Supports patient-scoped retrieval of MedicationRequest resources filtered by intent and a do-not-perform indicator to support negation workflows. patient+intentRequired by US Core. Supports patient-scoped retrieval of MedicationRequest resources filtered by intent for USCDI+ Quality workflows.
| 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+do-not-perform | reference+token+token |
| SHALL | patient+intent | reference+token |
resolvesread, search-type.Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale patientAdded in US Quality Core. Supports patient-scoped retrieval of NutritionOrder resources for USCDI+ Quality workflows.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The client SHALL provide an id value for the reference. |
resolvesread, search-type.US Quality Core Observation Clinical Result
US Core Observation ADI Documentation Profileversion: 9.0.0)
US Core Treatment Intervention Preference Profileversion: 9.0.0)
US Quality Core Simple Observation
US Quality Core Observation Screening Assessment
US Core Observation Pregnancy Status Profileversion: 9.0.0)
US Core Observation Pregnancy Intent Profileversion: 9.0.0)
US Core Smoking Status Observation Profileversion: 9.0.0)
US Quality Core Laboratory Result Observation
US Core Observation Occupation Profileversion: 9.0.0)
US Core Blood Pressure Profileversion: 9.0.0)
US Core BMI Profileversion: 9.0.0)
US Core Pediatric BMI for Age Observation Profileversion: 9.0.0)
US Core Body Height Profileversion: 9.0.0)
US Core Body Temperature Profileversion: 9.0.0)
US Core Body Weight Profileversion: 9.0.0)
US Core Pediatric Head Occipital Frontal Circumference Percentile Profileversion: 9.0.0)
US Core Heart Rate Profileversion: 9.0.0)
US Core Pulse Oximetry Profileversion: 9.0.0)
US Core Respiratory Rate Profileversion: 9.0.0)
US Core Pediatric Weight for Height Observation Profileversion: 9.0.0)
Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale patient+category+statusRecommended by US Core; US Quality Core strengthens this to SHALL. Supports patient-scoped retrieval of Observation resources filtered by category and status for status-sensitive quality workflows. patient+categoryRequired by US Core. Supports patient-scoped retrieval of Observation resources filtered by category for USCDI+ Quality workflows. patient+category+dateRequired by US Core. Supports patient-scoped retrieval of Observation resources filtered by category and date so quality workflows can constrain results to relevant reporting periods. patient+codeRequired by US Core. Supports patient-scoped retrieval of Observation resources filtered by code for USCDI+ Quality workflows.
| 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.Search requirements are selected according to the rules described in Search Requirement Selection. US Quality Core does not define additional required individual search parameters or required search parameter combinations for this resource. Implementations still support the required interactions in this CapabilityStatement and any applicable US Core requirements independently.
resolvesread, search-type.Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale _idRequired by US Core. Supports retrieval of a known Patient resource by id.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | The client SHALL provide an id value. |
Search requirements are selected according to the rules described in Search Requirement Selection. US Quality Core does not define additional required individual search parameters or required search parameter combinations for this resource. Implementations still support the required interactions in this CapabilityStatement and any applicable US Core requirements independently.
Search requirements are selected according to the rules described in Search Requirement Selection. US Quality Core does not define additional required individual search parameters or required search parameter combinations for this resource. Implementations still support the required interactions in this CapabilityStatement and any applicable US Core requirements independently.
resolvesread, search-type.Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale patientRequired by US Core. Supports patient-scoped retrieval of Procedure resources for USCDI+ Quality workflows. patient+statusRecommended by US Core; US Quality Core strengthens this to SHALL. Supports patient-scoped retrieval of Procedure resources filtered by status; status is used to indicate negation. patient+dateRequired by US Core. Supports patient-scoped retrieval of Procedure resources filtered by date so quality workflows can constrain results to relevant reporting periods.
resolvesread.search-type.Search requirements are selected according to the rules described in Search Requirement Selection. US Quality Core does not define additional required individual search parameters or required search parameter combinations for this resource. Implementations still support the required interactions in this CapabilityStatement and any applicable US Core requirements independently.
resolvesread, search-type.Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale patientRequired by US Core. Supports patient-scoped retrieval of QuestionnaireResponse resources for USCDI+ Quality workflows. patient+questionnaireRecommended by US Core; US Quality Core strengthens this to SHALL. Supports patient-scoped retrieval of QuestionnaireResponse resources filtered by questionnaire for USCDI+ Quality workflows.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The client SHALL provide an id value for the reference. |
| MAY | questionnaire | reference | The client MAY provide a reference value. |
| Conformance | Parameters | Types |
|---|---|---|
| SHALL | patient+questionnaire | reference+reference |
resolvesread, search-type.Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale _idRequired by US Core. Supports retrieval of a known RelatedPerson resource by id. patientRecommended by US Core; US Quality Core strengthens this to SHALL. Supports patient-scoped retrieval of RelatedPerson resources for USCDI+ Quality workflows.
resolvesread, search-type.Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale _idRequired by US Core. Supports retrieval of a known ServiceRequest resource by id. patientRequired by US Core. Supports patient-scoped retrieval of ServiceRequest resources for USCDI+ Quality workflows. patient+categoryRequired by US Core. Supports patient-scoped retrieval of ServiceRequest resources filtered by category for USCDI+ Quality workflows. patient+category+authoredRequired by US Core. Supports patient-scoped retrieval of ServiceRequest resources filtered by category and authored date so quality workflows can constrain results to relevant reporting periods. patient+codeRequired by US Core. Supports patient-scoped retrieval of ServiceRequest resources filtered by code for USCDI+ Quality workflows. patient+do-not-performAdded in US Quality Core. Supports patient-scoped retrieval of ServiceRequest resources filtered by a do-not-perform indicator to support negation workflows.
| 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. |
resolvesread, search-type.Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale _idRequired by US Core. Supports retrieval of a known Specimen resource by id.
Search requirements are selected according to the rules described in Search Requirement Selection. The table below summarizes why each required individual search or required search parameter combination is included for this resource.
Required search US Core alignment Rationale patientAdded in US Quality Core. Supports patient-scoped retrieval of Task resources for USCDI+ Quality workflows. patient+statusAdded in US Quality Core. Supports patient-scoped retrieval of Task resources filtered by status; status is used to indicate negation. patient+codeAdded in US Quality Core. Supports patient-scoped retrieval of Task resources filtered by code for USCDI+ Quality workflows.
IG © 2026 HL7 International / Clinical Quality Information.
Package hl7.fhir.us.quality-core#1.0.0-ballot based on FHIR 4.0.1.
Generated
2026-08-14
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change