Generated Narrative: CapabilityStatement us-quality-core-client
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 quality reporting. This US Quality Core-specific search is needed because AdverseEvent is in scope for USCDI+ Quality but is not profiled by US Core 6.1.0. subject+eventAdded in US Quality Core. Supports subject-scoped retrieval filtered by adverse event concept. This US Quality Core-specific combination makes the adverse event concept available as a primary retrieval path for quality logic. subject+recorded-dateAdded in US Quality Core. Supports subject-scoped retrieval filtered by recorded date so quality workflows can constrain adverse events 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 allergy and intolerance data needed for in-scope USCDI+ Quality data access.
| 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 care plans filtered to the category relevant for USCDI+ Quality data access.
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 care teams filtered by status for 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 conditions needed for in-scope USCDI+ Quality data access. patient+categoryRequired by US Core. Supports patient-scoped retrieval filtered by condition category, including problem, health concern, and encounter diagnosis use cases. patient+codeAdded in US Quality Core. Supports patient-scoped retrieval filtered by condition code. US Quality Core makes this combination explicit as a primary retrieval path for quality logic that filters by diagnosis, problem, or health concern code.
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 data needed for in-scope USCDI+ Quality data access.
| 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
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 device requests for quality reporting. This US Quality Core-specific search is needed because DeviceRequest is in scope for USCDI+ Quality but is not profiled by US Core 6.1.0. patient+codeAdded in US Quality Core. Supports patient-scoped retrieval filtered by requested device code. This US Quality Core-specific combination makes the device code available as a primary retrieval path for quality logic. patient+do-not-performAdded in US Quality Core. Supports negation workflows by enabling retrieval of device requests that indicate the requested action should not be performed.
| 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 diagnostic reports needed for in-scope USCDI+ Quality data access. patient+categoryRequired by US Core. Supports patient-scoped retrieval filtered by report category, including laboratory and clinical-note report categories. patient+category+dateRequired by US Core. Supports patient-scoped retrieval filtered by report category and date so quality workflows can constrain reports to relevant reporting periods. patient+codeRequired by US Core. Supports patient-scoped retrieval filtered by report code, including code-oriented retrieval paths used by quality logic.
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 search retrieval of a known DocumentReference by resource id. patientRequired by US Core. Supports patient-scoped retrieval of document references needed for in-scope USCDI+ Quality data access. patient+typeRequired by US Core. Supports patient-scoped retrieval filtered by document type, including clinical note type retrieval. patient+categoryRequired by US Core. Supports patient-scoped retrieval filtered by document category. patient+category+dateRequired by US Core. Supports patient-scoped retrieval filtered by document category and date so quality workflows can constrain documents 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 search retrieval of a known Encounter by resource id. patientRequired by US Core. Supports patient-scoped retrieval of encounters needed for in-scope USCDI+ Quality data access. patient+typeAdded in US Quality Core. Supports patient-scoped retrieval filtered by encounter type. US Quality Core makes this combination explicit as a primary retrieval path for quality logic that filters by visit or service type. patient+dateRequired by US Core. Supports patient-scoped retrieval filtered by encounter date so quality workflows can constrain encounters 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 patientAdded in US Quality Core. Supports patient-scoped retrieval of family member history for quality reporting. This US Quality Core-specific search is needed because FamilyMemberHistory is in scope for USCDI+ Quality but is not profiled by US Core 6.1.0.
| 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 goals needed for in-scope USCDI+ Quality data access.
| 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
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 immunizations needed for in-scope USCDI+ Quality data access. patient+statusAdded in US Quality Core. Supports patient-scoped retrieval filtered by immunization status. US Quality Core makes this combination explicit for status-sensitive quality workflows, including not-done immunization cases.
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 by clinical code. This search is included as a primary code path for quality logic when Medication is represented as a referenced resource.
| 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 medication administrations for quality reporting. This US Quality Core-specific search is needed because MedicationAdministration is in scope for USCDI+ Quality but is not profiled by US Core 6.1.0. patient+statusAdded in US Quality Core. Supports patient-scoped retrieval filtered by administration status for status-sensitive quality workflows. patient+codeAdded in US Quality Core. Supports patient-scoped retrieval filtered by medication code. This US Quality Core-specific combination makes the medication code available as a primary retrieval path for quality logic. patient+effective-timeAdded in US Quality Core. Supports patient-scoped retrieval filtered by administration time so quality workflows can constrain administrations 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 medication dispenses needed for in-scope USCDI+ Quality data access. patient+statusAdded in US Quality Core. Supports patient-scoped retrieval filtered by dispense status. US Quality Core makes this combination explicit for status-sensitive quality workflows, including declined dispense cases.
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 negation workflows by enabling retrieval of medication requests that indicate the requested medication should not be performed, while preserving the patient and intent context. patient+intentRequired by US Core. Supports patient-scoped retrieval of medication requests filtered by intent, including medication orders relevant to quality reporting.
| 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.US Quality Core Observation Clinical Result
US Quality Core Simple Observation
US Quality Core Observation Screening Assessment
US Quality Core Observation Cancelled
US Core Observation Pregnancy Intent Profileversion: 6.1.0)
US Core Observation Pregnancy Status Profileversion: 6.1.0)
US Core Smoking Status Observation Profileversion: 6.1.0)
US Quality Core Laboratory Result Observation
US Core Observation Occupation Profileversion: 6.1.0)
US Core Blood Pressure Profileversion: 6.1.0)
US Core BMI Profileversion: 6.1.0)
US Core Pediatric BMI for Age Observation Profileversion: 6.1.0)
US Core Body Height Profileversion: 6.1.0)
US Core Body Temperature Profileversion: 6.1.0)
US Core Body Weight Profileversion: 6.1.0)
US Core Pediatric Head Occipital Frontal Circumference Percentile Profileversion: 6.1.0)
US Core Heart Rate Profileversion: 6.1.0)
US Core Pulse Oximetry Profileversion: 6.1.0)
US Core Respiratory Rate Profileversion: 6.1.0)
US Core Pediatric Weight for Height Observation Profileversion: 6.1.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+statusAdded in US Quality Core. Supports patient-scoped retrieval filtered by observation category and status. US Quality Core makes this combination explicit for status-sensitive quality workflows, including cancelled or otherwise not-final observations. patient+categoryRequired by US Core. Supports patient-scoped retrieval filtered by observation category for in-scope USCDI+ Quality data access. patient+category+dateRequired by US Core. Supports patient-scoped retrieval filtered by category and date so quality workflows can constrain observations to relevant reporting periods. patient+codeRequired by US Core. Supports patient-scoped retrieval filtered by observation code, including primary code paths used by quality logic.
| 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 by resource id, which is the normal starting point for patient-scoped USCDI+ Quality data access.
| 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 procedures needed for in-scope USCDI+ Quality data access. patient+statusAdded in US Quality Core. Supports patient-scoped retrieval filtered by procedure status. US Quality Core makes this combination explicit for status-sensitive quality workflows, including not-done procedure cases. patient+dateRequired by US Core. Supports patient-scoped retrieval filtered by procedure date so quality workflows can constrain procedures 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 _idRequired by US Core. Supports search retrieval of a known RelatedPerson by resource id. patientAdded in US Quality Core. Supports retrieval of related persons associated with a patient for in-scope USCDI+ Quality data access.
resolvesread, search-type.US Quality Core ServiceRequest
US Quality Core Service Not Requested
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 search retrieval of a known ServiceRequest by resource id. patientRequired by US Core. Supports patient-scoped retrieval of service requests needed for in-scope USCDI+ Quality data access. patient+categoryRequired by US Core. Supports patient-scoped retrieval filtered by service request category. patient+category+authoredRequired by US Core. Supports patient-scoped retrieval filtered by category and authored date so quality workflows can constrain service requests to relevant reporting periods. patient+codeRequired by US Core. Supports patient-scoped retrieval filtered by service request code, including primary code paths used by quality logic. patient+do-not-performAdded in US Quality Core. Supports negation workflows by enabling retrieval of service requests that indicate the requested action should not be performed.
| 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 search retrieval of a known Specimen by resource id, including specimens referenced by quality-relevant observations and diagnostic reports.
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 tasks for quality reporting. This US Quality Core-specific search is needed because Task is in scope for USCDI+ Quality but is not profiled by US Core 6.1.0. patient+statusAdded in US Quality Core. Supports patient-scoped retrieval filtered by task status for status-sensitive quality workflows. patient+codeAdded in US Quality Core. Supports patient-scoped retrieval filtered by task code. This US Quality Core-specific combination makes the task code available as a primary retrieval path for quality logic.