US Quality Core Implementation Guide
1.0.0-ballot - STU 1 - ballot United States of America flag

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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

US Quality Core Client CapabilityStatement

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.

US Quality Core Server CapabilityStatement

This capability statement describes the expected capabilities of US Quality Core Servers that respond to USCDI+ Quality V2 queries submitted by US Quality Core Clients. It describes a minimum set of FHIR RESTful operations and search parameters needed to enable access to the USCDI+ Quality data in scope for this implementation guide. This version of US Quality Core builds directly on US Core 9.0.0, and US Quality Core Servers SHALL support the capabilities described in the US Core Server CapabilityStatement for in-scope USCDI+ Quality data. RESTful operations and search parameters in this CapabilityStatement identify the capabilities specifically relevant to USCDI+ Quality V2 and may duplicate US Core Server capabilities. For more information about which USCDI+ Quality data elements are in scope, please review the USCDI+ Quality section of this implementation guide.

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

us-quality-core-adverse-event-event

US Quality Core AdverseEvent event Search Parameter

us-quality-core-adverse-event-recorded-date

US Quality Core AdverseEvent recorded-date Search Parameter

us-quality-core-adverse-event-subject

US Quality Core AdverseEvent subject Search Parameter

us-quality-core-allergy-intolerance-patient

US Quality Core AllergyIntolerance patient Search Parameter

us-quality-core-care-plan-category

US Quality Core CarePlan category Search Parameter

us-quality-core-care-plan-patient

US Quality Core CarePlan patient Search Parameter

us-quality-core-care-team-patient

US Quality Core CareTeam patient Search Parameter

us-quality-core-care-team-status

US Quality Core CareTeam status Search Parameter

us-quality-core-communication-status

US Quality Core Communication status Search Parameter

us-quality-core-communication-subject

US Quality Core Communication subject Search Parameter

us-quality-core-communication-topic

US Quality Core Communication topic Search Parameter

us-quality-core-condition-category

US Quality Core Condition category Search Parameter

us-quality-core-condition-code

US Quality Core Condition code Search Parameter

us-quality-core-condition-patient

US Quality Core Condition patient Search Parameter

us-quality-core-coverage-patient

US Quality Core Coverage patient Search Parameter

us-quality-core-device-request-code

US Quality Core DeviceRequest code Search Parameter

us-quality-core-device-request-do-not-perform

US Quality Core DeviceRequest do-not-perform Search Parameter

us-quality-core-device-request-patient

US Quality Core DeviceRequest patient Search Parameter

us-quality-core-diagnostic-report-category

US Quality Core DiagnosticReport category Search Parameter

us-quality-core-diagnostic-report-code

US Quality Core DiagnosticReport code Search Parameter

us-quality-core-diagnostic-report-date

US Quality Core DiagnosticReport date Search Parameter

us-quality-core-diagnostic-report-patient

US Quality Core DiagnosticReport patient Search Parameter

us-quality-core-encounter-date

US Quality Core Encounter date Search Parameter

us-quality-core-encounter-id

US Quality Core Encounter _id Search Parameter

us-quality-core-encounter-patient

US Quality Core Encounter patient Search Parameter

us-quality-core-encounter-type

US Quality Core Encounter type Search Parameter

us-quality-core-goal-patient

US Quality Core Goal patient Search Parameter

us-quality-core-imaging-study-subject

US Quality Core ImagingStudy subject Search Parameter

us-quality-core-immunization-patient

US Quality Core Immunization patient Search Parameter

us-quality-core-immunization-status

US Quality Core Immunization status Search Parameter

us-quality-core-medication-administration-code

US Quality Core MedicationAdministration code Search Parameter

us-quality-core-medication-administration-effective-time

US Quality Core MedicationAdministration effective-time Search Parameter

us-quality-core-medication-administration-patient

US Quality Core MedicationAdministration patient Search Parameter

us-quality-core-medication-administration-status

US Quality Core MedicationAdministration status Search Parameter

us-quality-core-medication-code

US Quality Core Medication code Search Parameter

us-quality-core-medication-dispense-patient

US Quality Core MedicationDispense patient Search Parameter

us-quality-core-medication-dispense-status

US Quality Core MedicationDispense status Search Parameter

us-quality-core-medication-request-do-not-perform

US Quality Core MedicationRequest do-not-perform Search Parameter

us-quality-core-medication-request-intent

US Quality Core MedicationRequest intent Search Parameter

us-quality-core-medication-request-patient

US Quality Core MedicationRequest patient Search Parameter

us-quality-core-nutrition-order-patient

US Quality Core NutritionOrder patient Search Parameter

us-quality-core-observation-category

US Quality Core Observation category Search Parameter

us-quality-core-observation-code

US Quality Core Observation code Search Parameter

us-quality-core-observation-date

US Quality Core Observation date Search Parameter

us-quality-core-observation-patient

US Quality Core Observation patient Search Parameter

us-quality-core-observation-status

US Quality Core Observation status Search Parameter

us-quality-core-patient-id

US Quality Core Patient _id Search Parameter

us-quality-core-procedure-date

US Quality Core Procedure date Search Parameter

us-quality-core-procedure-patient

US Quality Core Procedure patient Search Parameter

us-quality-core-procedure-status

US Quality Core Procedure status Search Parameter

us-quality-core-questionnaire-response-patient

US Quality Core QuestionnaireResponse patient Search Parameter

us-quality-core-questionnaire-response-questionnaire

US Quality Core QuestionnaireResponse questionnaire Search Parameter

us-quality-core-related-person-id

US Quality Core RelatedPerson _id Search Parameter

us-quality-core-related-person-patient

US Quality Core RelatedPerson patient Search Parameter

us-quality-core-service-request-authored

US Quality Core ServiceRequest authored Search Parameter

us-quality-core-service-request-category

US Quality Core ServiceRequest category Search Parameter

us-quality-core-service-request-code

US Quality Core ServiceRequest code Search Parameter

us-quality-core-service-request-do-not-perform

US Quality Core ServiceRequest do-not-perform Search Parameter

us-quality-core-service-request-id

US Quality Core ServiceRequest _id Search Parameter

us-quality-core-service-request-patient

US Quality Core ServiceRequest patient Search Parameter

us-quality-core-task-code

US Quality Core Task code Search Parameter

us-quality-core-task-patient

US Quality Core Task patient Search Parameter

us-quality-core-task-status

US Quality Core Task status Search Parameter

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

US Quality Core AdverseEvent

Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.

US Quality Core AllergyIntolerance

Profile of AllergyIntolerance for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core CarePlan

Defines constraints and extensions on the CarePlan resource for the minimal set of data to query and retrieve a patient's Care Plan.

US Quality Core CareTeam

Profile of CareTeam for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core Communication

Profile of Communication for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core Communication Not Done

Negation profile of Communication for decision support/quality metrics. Indicates that the communication was not performed for a reason.

US Quality Core CommunicationDone

Positive profile of Communication for decision support/quality metrics. Indicates that the communication was performed (as opposed to the not done profile).

US Quality Core Condition Encounter Diagnosis

The US Quality Core Condition Encounter Diagnosis Profile is based upon the US Core Condition Encounter Diagnosis Profile. In version 5.0.0, the US Quality Core Condition Profile has been split into the US Quality Core Condition Encounter Diagnosis Profile and US Quality Core Condition Problems and Health Concerns Profile. To promote interoperability and adoption through consistent implementation, this profile defines constraints and extensions on the Condition resource for the minimal set of data to record, search, and retrieve information about an encounter diagnosis. It defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core Condition Problems Health Concerns

Profile of Condition for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core Coverage

Profile of Coverage for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core Device Prohibited

Negation profile of DeviceRequest for decision support/quality metrics. Indicates a proposal, plan, or order not to provide a device.

US Quality Core DeviceRequest

Profile of DeviceRequest for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core DeviceRequested

Positive profile of DeviceRequest for decision support/quality metrics. Indicates a proposal, plan, or order for a device.

US Quality Core DiagnosticReport Profile for Laboratory Results Reporting

Profile of DiagnosticReport for laboratory results for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core DiagnosticReport Profile for Report and Note Exchange

Profile of DiagnosticReport for Note exchange for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core Encounter

Profile of Encounter for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core Goal

Profile of Goal for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core ImagingStudy

Profile of ImagingStudy for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core Immunization

Profile of Immunization for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core Immunization Done

Positive profile of Immunization for decision support/quality metrics. Indicates that the immunization is being or was performed (as opposed to the not done profile).

US Quality Core Immunization Not Done

Negation profile of Communication for decision support/quality metrics. Indicates that the communication was not performed for a reason.

US Quality Core Laboratory Result Observation

The US Quality Core Laboratory Result Observation Profile is based upon the US Laboratory Result Observation Resource. Defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core Location

Profile of Location for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core Medication

Profile of Medication for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core Medication Prohibited

Negation profile of MedicationRequest for decision support/quality metrics. Indicates a proposal, plan, or order not to provide a medication.

US Quality Core MedicationAdministration

Profile of MedicationAdministration for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core MedicationAdministration Done

Positive profile of MedicationAdministration for decision support/quality metrics. Indicates that a medication administration is being or was performed (as opposed to the negative profile)

US Quality Core MedicationAdministration Not Done

Negation profile of MedicationAdministration for decision support/quality metrics. Indicates that a medication was not administered for a reason.

US Quality Core MedicationDispense

Profile of MedicationDispense for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core MedicationDispense Declined

Negation profile of MedicationDispense for decision support/quality metrics. Indicates that a medication dispense was declined for a reason.

US Quality Core MedicationDispense Done

Positive profile of MedicationDispense for decision support/quality metrics. Indicates that a medication is being or was dispensed

US Quality Core MedicationRequest

Profile of MedicationRequest for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core MedicationRequested

Positive profile of MedicationRequest for decision support/quality metrics. Indicates that a medication was proposed, planned, or ordered.

US Quality Core NutritionOrder

Defines constraints and extensions on the NutritionOrder resource for the minimal set of data to query and retrieve a patient's Nutrition Order.

US Quality Core Observation Clinical Result

This profile sets minimum expectations for the Observation resource to record and search non-laboratory clinical test results (e.g., radiology and other clinical observations generated from procedures). An example would be when a gastroenterologist reports the size of a polyp observed during a colonoscopy. This profile is the basis for the US Core Clinical Result Profile, which defines additional data elements to record and search laboratory test results.

US Quality Core Observation Screening Assessment

The US Quality Core Observation Screening Assessment Profile is based upon the US Core Observation Screening Assessment Profile which can be used to represent individual responses, panels of multi-question surveys, and multi-select responses to “check all that apply” questions. The US Quality Core Observation Survey Profile sets minimum expectations for the Observation Resource to record, search, and fetch retrieve observations that represent the questions and responses to form/survey and defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core Organization

Profile of Organization for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core Patient

Profile of Patient for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core Practitioner

Profile of Practitioner for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core PractitionerRole

Profile of PractitionerRole for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core Procedure

Profile of Procedure for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core Procedure Done

Positive profile of Procedure for decision support/quality metrics. Indicates that a procedure is being or was performed.

US Quality Core Procedure Not Done

Negative profile of Procedure for decision support/quality metrics. Indicates that a procedure was not done for a reason.

US Quality Core QuestionnaireResponse

The US Quality Core QuestionnaireResponse Profile is based upon the US Core QuestionnaireResponse Profile and sets minimum expectations for the QuestionnaireResponse resource to record, search, and fetch retrieve captures the responses to form/survey and defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core RelatedPerson

Profile of RelatedPerson for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core Service Prohibited

Negation profile of ServiceRequest for decision support/quality metrics. Indicates a request not to provide a service

US Quality Core ServiceRequest

Profile of ServiceRequest for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core ServiceRequested

Positive profile of ServiceRequest for decision support/quality metrics. Indicates that a service is proposed, planned, or ordered.

US Quality Core Simple Observation

Profile of Simple Observation for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core Task

Profile of Task for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

US Quality Core Task Done

Positive profile of Task for decision support/quality metrics. Indicates a task that with a positive status

US Quality Core Task Rejected

Profile of TaskRejected for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

US Quality Core Diagnosis Present on Admission

Indicator of whether the Encounter diagnosis was present at the time of admission.

US Quality Core USCDI+ Quality Extension

This extension is used only in US Quality Core profile StructureDefinitions. It flags elements, types, and target profiles that represent USCDI+ Quality data elements. Systems are expected to support flagged content as applicable to their role in US Quality Core data exchange. See the Must Support and USCDI+ Quality pages for more information.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Positive Event Status

This value set defines the set of codes that indicate a positive event status (i.e. codes that indicate an event is in preparation, progress, on-hold, stopped, or has completed)

Positive MedicationAdministration Status

This value set defines the set of codes that indicate a positive medication administration status (i.e. codes that indicate at least some medication is being or was administered)

Positive MedicationDispense Status

This value set defines the set of codes that indicate a positive medication dispense status (i.e. codes that indicate at least some medication was dispensed)

Positive MedicationRequest Status

This value set defines the set of codes that indicate a positive medication request status (i.e. codes that a medication is proposed, planned, or ordered)

Positive Request Status

This value set defines the set of codes that indicate a positive request status (i.e. codes that indicate an activity is proposed, planned, or ordered).

Positive Task Status

This value set defines the set of codes that indicate a positive task status

US Quality Core Negation Reason Codes

This value set defines the set of codes that can be used to indicate the reason an action was not taken

US Quality Core Observation Body Position

SNOMED CT code system values descending from the following:'body position finding' 9851009

US Quality Core Present On Admission Codes

Value Set for US Quality Core Present On Admission.

US Quality Core SNOMED CT Dosage Codes

This value set includes all the "Dosages" SNOMED CT codes (i.e. codes with an is-a relationship with 277406006: Dosages).

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

10 minute Apgar Heart Rate Observation Screening Assessment Example

Example of a 10 minute Apgar Heart Rate Observation Screening Assessment

AdverseEvent example

Example of an allergic reaction adverse event

AllergyIntolerance example

Example of a clinical assessment record of an allergy

AllergyIntolerance refuted example

Example of a clinical assessment record of an allergy that has been refuted

CarePlan example

Example of an assessment and care plan for a pregnancy

CareTeam example

Example of a CareTeam involved in the delivery of care for a pregnancy

Communication example

Example of a notification sent to a patient about an abnormal test result (using the General Communication profile)

Communication negation example

Example of a notification that was not sent to a patient and reason why

CommunicationDone example

Example of a notification sent to a patient about an abnormal test result (using the Positive Communication profile)

Condition Encounter Diagnosis example

Example of a condition encounter diagnosis resource used to record information about a burn of the left ear

Condition Problems Health Concerns example

Example of a patient with a health concern regarding fear of blood

Condition example - appendicitis

Example of a condition resource used to record information about an appendicitis

Coverage example

Example of a coverage resource used to provide information about an individual's specific plan

Date and time of obstetric delivery example

Example of a obstetric delivery datetime Observation

Delivery date estimated example

Example of a delivery date estimate Observation

DeviceRequest general example

Request to employ a medical device (using the General Profile)

DeviceRequest negation with code example

Example of a request not to employ a specific medical device

DeviceRequest negation with value set example

Example of a request not to employ any of a class of medical devices

DeviceRequest positive example

Example of a request to employ a medical device (using the Positive Profile)

DiagnosticReportLab example

Example of a final blood glucose laboratory report

DiagnosticReportNote example

Example of a DiagnosticReport Note

Encounter example

Example of an Encounter

Gestation age at birth observation example

Example of a gestation age at birth observation

Glucose Laboratory Result Observation Example

Example of a glucose laboratory result observation

Goal example

Example of a patient-defined weight-management goal

Heart rate rhythm clinical result observation example

Example of a Heart rate rhythm clinical result observation

Hospital Organization example

Example hospital organization

ImagingStudy example

Example of ImagingStudy based on CT imaging study

Immunization general example

Immunization example (using the General Profile)

Immunization negation with code example

Example of an immunization that was not administered, with the vaccine identified by code

Immunization negation with value set example

Example of an immunization that was not administered, with the vaccine identified by value set

Immunization positive example

Immunization example (using the Positive Profile)

Infant patient example

Infant patient example

Location example

Example of a hospital location on the second floor of the South Wing

Medication example

Example of Alemtuzumab Medication

MedicationAdministration general example

Intravenous example of MedicationAdministration (using the General Profile)

MedicationAdministration negation with code example

Example of medication not administered using a code to indicate that a particular medication was not administered

MedicationAdministration negation with value set example

Example of medication not administered using a value set to indicate what was not administered

MedicationAdministration positive example

Intravenous example of MedicationAdministration (using the Positive Profile)

MedicationDispense general example

Penicillin MedicationDispense Example (using the General Profile)

MedicationDispense negation with code example

Example of medication not dispensed using a code to indicate the reason

MedicationDispense negation with value set example

Example of medication not dispensed using a value set to indicate the reason

MedicationDispense positive example

Penicillin MedicationDispense Example (using the Positive Profile)

MedicationProhibited using code example

Example of request not to provide a medication using a code

MedicationProhibited using value set example

Example of request not to provide a medication using a value set

MedicationRequest Patient Reported Example

Patient Reported Example

MedicationRequest Patient Requester Example

Patient Requester Example

MedicationRequest Practitioner Ordered Example

Practitioner Ordered Example

MedicationRequest general example

Penicillin MedicationRequest Example (using the General Profile)

MedicationRequest positive example

Penicillin MedicationRequest Example (using the Positive Profile)

Mobility aid use observation example

Example of an observation documenting regular mobility-aid use

Number of full-term births observation example

Example number of full-term births Observation

Number of parity observation example

Example number of parity Observation

Number of pregnancies observation example

Example number of pregnancies Observation

Number of preterm births observation example

Example number of preterm births Observation

NutritionOrder example

Example of a NutritionOrder for a consistent carbohydrate diet

ODH Observation example

Example of occupational data added to observation measure

Observation example

Example of Decreased Hemoglobin Observation

Older adult patient example

Older adult patient example

Organization example

Example organization

PHQ-9 QuestionnaireResponse Example

Example of a PHQ-9 Questionnaire Response

Patient example

Basic Patient example

Portable chest X-ray DICOM study example

Example of a portable chest X-ray imaging study

Portable chest X-ray lung fields finding example

Example of a narrative radiology finding for a portable chest X-ray

Practitioner example

Referring Practitioner example

PractitionerRole example

PractitionerRole example

Procedure general example

Appendectomy Procedure example (using the General Profile)

Procedure positive example

Appendectomy Procedure example (using the Positive Profile)

ProcedureNotDone with code example

Example of procedure not done using a code

ProcedureNotDone with value set example

Example of procedure not done using a value set

RelatedPerson example

Emergency contact example

Reproductive health patient example

Patient example used by pregnancy and obstetric observations

ServiceProhibited with code example

Example of request not to provide a service using a code

ServiceProhibited with value set example

Example of request not to provide a service using a value set

ServiceRequest Myringotomy Procedure example

ServiceRequest for Myringotomy Procedure example

ServiceRequest appropriateness example

ServiceRequest appropriateness example

ServiceRequest elective example

Elective procedure ServiceRequest example

ServiceRequest general example

Request for Appendectomy ServiceRequest example (using the General Profile)

ServiceRequest positive example with a code

Request for Graduated compression elastic hosiery using a code example (using the Positive Profile)

ServiceRequest positive example with a value set

Request for Intermittent pneumatic compression devices using a value set example (using the Positive Profile)

ServiceRequested appendix example

Appendectomy ServiceRequested example

Task Rejected example rejecting a proposal using a code

Example of a task rejecting a proposal that identifies the requested activity with a code

Task Rejected example rejecting a proposal using a value set

Example of a task rejecting a proposal that identifies the requested activity with a value set

Task general example

Task example (using the General Profile)

Task positive example

Task example (using the Positive Profile)

Whole Blood Specimen Example

Example of a whole blood specimen collected for a laboratory result

Other

These are resources that are used within this implementation guide that do not fit into one of the other categories.

Expansion Parameters

This Parameters resource represents a manifest to the versions of the canonical artifacts, such as CodeSystem, ValueSet, StructureDefinition and SearchParameter used in this IG. It also specifies the SNOMED CT Edition.