This page is part of the Quality Improvement Core Framework (v7.0.0-ballot: STU7 (v7.0.0) Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 6.0.0. For a full list of available versions, see the Directory of published versions

QI-Core Downloads

Full Implementation Guide

The following file contains the complete, downloadable implementation guide:

• Full IG

IG Package

The following file is the FHIR IG Package NPM Subset

• package.tgz

Definitions

In addition to the above, we have provided format-specific definitions:

• XML
• JSON
• TTL

These files should be the first choice whenever generating any implementation artifacts since they contain all of the rules about what makes these US Core profiles valid. Implementers will still need to be familiar with the content of the specification and profiles that apply in order to make a conformant implementation. See the overview on validating FHIR profiles and resources for more information about validating profiles and how to use these artifacts.

Examples

All examples used in this Implementation Guide:

• XML
• JSON
• TTL

Dependencies

Package hl7.fhir.r4.examples#4.0.1 Example resources in the R4 version of the FHIR standard

Package hl7.fhir.uv.sdc#3.0.0 The SDC specification provides an infrastructure to standardize the capture and expanded use of patient-level data collected within an EHR. This includes two components: * Support more sophisticated questionnaire/form use-cases such as those needed for research, oncology, pathology and other clinical domains. *Support pre-population and auto-population of EHR data into forms/questionnaires for uses outside direct clinical care (patient safety, adverse event reporting, public health reporting, etc.). (built Tue, Mar 8, 2022 18:32+0000+00:00)

Package hl7.fhir.uv.extensions#5.1.0-cibuild This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Tue, Mar 12, 2024 13:29+1100+11:00)

Package hl7.fhir.us.core#7.0.0 The US Core Implementation Guide is based on FHIR Version R4 and defines the minimum conformance requirements for accessing patient data. The Argonaut pilot implementations, ONC 2015 Edition Common Clinical Data Set (CCDS), and ONC U.S. Core Data for Interoperability (USCDI) v1 provided the requirements for this guide. The prior Argonaut search and vocabulary requirements, based on FHIR DSTU2, are updated in this guide to support FHIR Version R4. This guide was used as the basis for further testing and guidance by the Argonaut Project Team to provide additional content and guidance specific to Data Query Access for purpose of ONC Certification testing. These profiles are the foundation for future US Realm FHIR implementation guides. In addition to Argonaut, they are used by DAF-Research, QI-Core, and CIMI. Under the guidance of HL7 and the HL7 US Realm Steering Committee, the content will expand in future versions to meet the needs specific to the US Realm. These requirements were originally developed, balloted, and published in FHIR DSTU2 as part of the Office of the National Coordinator for Health Information Technology (ONC) sponsored Data Access Framework (DAF) project. For more information on how DAF became US Core see the US Core change notes. (built Wed, May 8, 2024 15:33+0000+00:00)

Package hl7.fhir.uv.extensions.r5#5.1.0 This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Sat, Apr 27, 2024 18:39+1000+10:00)

Package hl7.fhir.uv.extensions#5.2.0-ballot This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Tue, Jul 30, 2024 06:42+0800+08:00)

Package hl7.fhir.uv.extensions.r4#1.0.0 This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Sun, Mar 26, 2023 08:46+1100+11:00)

Package hl7.fhir.uv.extensions.r4#5.1.0 This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Sat, Apr 27, 2024 18:39+1000+10:00)

Package hl7.fhir.uv.cql#1.0.0 This implementation guide defines profiles, operations and guidance for the use of CQL with FHIR, both as a mechanism for querying, as well as inline and integrated usage as part of knowledge artifacts. (built Fri, May 31, 2024 14:04+0000+00:00)

Cross Version Analysis

This is an R4 IG. None of the features it uses are changed in R4B, so it can be used as is with R4B systems. Packages for both R4 (hl7.fhir.us.qicore.r4) and R4B (hl7.fhir.us.qicore.r4b) are available.

Global Profiles

Global Profiles:

Type	Source	Profile
Encounter		QICore Encounter
Immunization		QICore Immunization
Observation		QICore Simple Observation
Organization		QICore Organization
Patient		QICore Patient
Practitioner		QICore Practitioner
PractitionerRole		QICore PractitionerRole

All resources of these types must conform to these profiles.

IP Statements

This publication includes IP covered under the following statements.

• Copyright HL7. Licensed under creative commons public domain
  Show Usage
  • diagnosticServiceSectionId: DiagnosticReport/example and QICoreDiagnosticReportLab
  • contactRole2: Patient/example, Patient/example-2 and RelatedPerson/example
  • providerRole: Immunization/example
• HL7 International.
  Show Usage
  • Financial Resource Status Codes: QICoreClaimResponse
• ISO maintains the copyright on the country codes, and controls its use carefully. For further details see the ISO 3166 web page: https://www.iso.org/iso-3166-country-codes.html
  Show Usage
  • ISO 3166-1 Codes for the representation of names of countries and their subdivisions — Part 1: Country code: NegationReasonCodes, NonNegativeEventStatus... Show 67 more, NonNegativeImmunizationStatus, NonNegativeMedicationAdministrationStatus, NonNegativeMedicationDispenseStatus, NonNegativeObservationStatus, NonNegativeTaskStatus, QICORE_KeyElement, QICore, QICoreAdverseEvent, QICoreAllergyIntolerance, QICoreBodyStructure, QICoreCarePlan, QICoreCareTeam, QICoreClaim, QICoreClaimResponse, QICoreCommunication, QICoreCommunicationNotDone, QICoreCommunicationRequest, QICoreConditionEncounterDiagnosis, QICoreConditionProblemsHealthConcerns, QICoreCoverage, QICoreDevice, QICoreDeviceNotRequested, QICoreDeviceRequest, QICoreDeviceUseStatement, QICoreDiagnosticReportLab, QICoreDiagnosticReportNote, QICoreEncounter, QICoreFamilyMemberHistory, QICoreFlag, QICoreGoal, QICoreImagingStudy, QICoreImmunization, QICoreImmunizationEvaluation, QICoreImmunizationNotDone, QICoreImmunizationRecommendation, QICoreLaboratoryResultObservation, QICoreLocation, QICoreMedication, QICoreMedicationAdministration, QICoreMedicationAdministrationNotDone, QICoreMedicationDispense, QICoreMedicationDispenseDeclined, QICoreMedicationDoseType, QICoreMedicationNotRequested, QICoreMedicationRequest, QICoreMedicationStatement, QICoreNonPatientObservation, QICoreNutritionOrder, QICoreObservationBodyPosition, QICoreObservationCancelled, QICoreObservationClinicalResult, QICoreObservationScreeningAssessment, QICoreOrganization, QICorePatient, QICorePractitioner, QICorePractitionerRole, QICorePresentOnAdmission, QICoreProcedure, QICoreProcedureNotDone, QICoreQuestionnaireResponse, QICoreRelatedPerson, QICoreServiceNotRequested, QICoreServiceRequest, QICoreSimpleObservation, QICoreSubstance, QICoreTask and QICoreTaskRejected
• Most of the information on the CDC and ATSDR websites is not subject to copyright, is in the public domain, and may be freely used or reproduced without obtaining copyright permission. For information and exceptions regarding use of CDC material please see https://www.cdc.gov/other/agencymaterials.html
  Show Usage
  • Vaccine Administered Code Set (CVX): Immunization/negation-example-code and QICoreImmunizationRecommendation
• The POA Indicator Codes are in the public domain and are free to use without restriction.
  Show Usage
  • CMS Present on Admission (POA) Indicator: QICoreClaim and QICorePresentOnAdmission
• The UCUM codes, UCUM table (regardless of format), and UCUM Specification are copyright 1999-2009, Regenstrief Institute, Inc. and the Unified Codes for Units of Measures (UCUM) Organization. All rights reserved. https://ucum.org/trac/wiki/TermsOfUse
  Show Usage
  • Unified Code for Units of Measure (UCUM): Goal/example, Immunization/example... Show 19 more, Medication/example, MedicationAdministration/cmd-example, MedicationAdministration/example, MedicationAdministration/negation-example, MedicationAdministration/negation-with-code-example, MedicationDispense/cmd-example, MedicationDispense/example, MedicationDispense/negation-example, MedicationDispense/negation-with-code-example, MedicationRequest/cmd-example, MedicationRequest/example, MedicationRequest/patient-reported-example, MedicationRequest/patient-requester-example, MedicationRequest/practitioner-ordered-example, MedicationStatement/example, NutritionOrder/example, Observation/example, Observation/example-gestation and Observation/laboratory-result-observation-example-blood-glucose
• These codes are excerpted from Digital Imaging and Communications in Medicine (DICOM) Standard, Part 16: Content Mapping Resource, Copyright © 2011 by the National Electrical Manufacturers Association.
  Show Usage
  • DICOM Controlled Terminology Definitions: ImagingStudy/example
• This is an example set.
  Show Usage
  • ICD-10 Procedure Codes: QICoreClaim
• This material contains content from LOINC. LOINC is copyright © 1995-2020, Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc.
  Show Usage
  • LOINC: DiagnosticReport/example, DiagnosticReport/note-example... Show 24 more, Goal/example, ImmunizationRecommendation/example, Observation/clinical-result-heart-rate-rhythm, Observation/example, Observation/example-births, Observation/example-delivery-date-estimate, Observation/example-frailty, Observation/example-gestation, Observation/example-obstetric-delivery, Observation/example-odh, Observation/example-parity, Observation/example-pregnancies, Observation/example-preterm-births, Observation/example-screening-assessment-10-minute-apgar-heart-rate, Observation/laboratory-result-observation-example-blood-glucose, Observation/negation-with-code-example, QICoreDiagnosticReportNote, QICoreLaboratoryResultObservation, QICoreNonPatientObservation, QICoreObservationClinicalResult, QICoreObservationScreeningAssessment, QICoreProcedure, QICoreProcedureNotDone and QICoreSimpleObservation
• This material contains content that is copyright of SNOMED International. Implementers of these specifications must have the appropriate SNOMED CT Affiliate license - for more information contact https://www.snomed.org/get-snomed or info@snomed.org.
  Show Usage
  • SNOMED Clinical Terms® (SNOMED CT®): AdverseEvent/example, AllergyIntolerance/example... Show 76 more, AllergyIntolerance/example-refuted, BodyStructure/example, CarePlan/example, Communication/negation-example, Condition/appendicitis-example, Condition/example, Condition/health-concern-example, Device/example, DeviceRequest/negation-with-code-example, FamilyMemberHistory/example, ImagingStudy/example, Immunization/example, Immunization/negation-example, Immunization/negation-example-code, ImmunizationEvaluation/example, ImmunizationRecommendation/example, Medication/example, MedicationAdministration/cmd-example, MedicationAdministration/example, MedicationAdministration/negation-example, MedicationAdministration/negation-with-code-example, MedicationDispense/cmd-example, MedicationDispense/example, MedicationDispense/negation-example, MedicationDispense/negation-with-code-example, MedicationRequest/cmd-example, MedicationRequest/example, MedicationRequest/negation-example, MedicationRequest/negation-example-code, MedicationRequest/patient-reported-example, MedicationRequest/patient-requester-example, MedicationRequest/practitioner-ordered-example, MedicationStatement/example, NutritionOrder/example, Observation/example, Observation/example-frailty, Observation/example-nonpatient-hemodialysis-machine, Observation/example-nonpatient-hospital-bed, Observation/example-nonpatient-mechanical-ventilator, Observation/negation-example, Observation/negation-with-code-example, Procedure/example, Procedure/negation-example, Procedure/negation-with-code-example, QICoreAdverseEvent, QICoreBodyStructure, QICoreCarePlan, QICoreDeviceNotRequested, QICoreDeviceRequest, QICoreDeviceUseStatement, QICoreFamilyMemberHistory, QICoreFlag, QICoreGoal, QICoreImmunization, QICoreImmunizationEvaluation, QICoreMedicationAdministration, QICoreMedicationDispenseDeclined, QICoreMedicationDoseType, QICoreMedicationStatement, QICoreNonPatientObservation, QICoreObservationBodyPosition, QICoreObservationCancelled, QICorePractitionerRole, QICoreProcedure, QICoreProcedureNotDone, QICoreServiceNotRequested, QICoreSimpleObservation, QICoreSubstance, ServiceRequest/appropriateness-example, ServiceRequest/elective-example, ServiceRequest/example, ServiceRequest/myringotomy-example, ServiceRequest/negation-example, ServiceRequest/negation-example-code, Task/negation-example and Task/negation-with-code-example
• This material derives from the HL7 Terminology (THO). THO is copyright ©1989+ Health Level Seven International and is made available under the CC0 designation. For more licensing information see: https://terminology.hl7.org/license
  Show Usage
  • Adjudication Value Codes: ClaimResponse/example and QICoreClaimResponse
  • AdverseEventSeriousness: AdverseEvent/example
  • AllergyIntolerance Clinical Status Codes: AllergyIntolerance/example and AllergyIntolerance/example-refuted
  • AllergyIntolerance Verification Status: AllergyIntolerance/example and AllergyIntolerance/example-refuted
  • Claim Type Codes: Claim/example, ClaimResponse/example and QICoreClaimResponse
  • CommunicationCategory: Communication/example, Communication/negation-example, CommunicationRequest/example and QICoreCommunicationRequest
  • CommunicationNotDoneReason: Communication/example
  • CommunicationTopic: Communication/negation-example, QICoreCommunication and QICoreCommunicationNotDone
  • Condition Category Codes: Condition/appendicitis-example, Condition/example and QICoreConditionEncounterDiagnosis
  • Condition Clinical Status Codes: Condition/appendicitis-example, Condition/example and Condition/health-concern-example
  • ConditionVerificationStatus: Condition/appendicitis-example, Condition/example and Condition/health-concern-example
  • Coverage Class Codes: QICoreCoverage
  • DataAbsentReason: QICoreObservationClinicalResult and QICoreObservationScreeningAssessment
  • Diet: NutritionOrder/example
  • Discharge disposition: QICoreEncounter
  • DoseAndRateType: MedicationDispense/cmd-example, MedicationDispense/example... Show 7 more, MedicationDispense/negation-example, MedicationDispense/negation-with-code-example, MedicationRequest/cmd-example, MedicationRequest/example, MedicationRequest/patient-reported-example, MedicationRequest/patient-requester-example and MedicationRequest/practitioner-ordered-example
  • Example Diagnosis Type Codes: QICoreClaim
  • Example Procedure Type Codes: QICoreClaim
  • Flag Category: Flag/example and QICoreFlag
  • Goal category: Goal/example
  • Goal priority: Goal/example
  • Immunization Evaluation Dose Status codes: ImmunizationEvaluation/example and QICoreImmunizationEvaluation
  • LibraryType: QICore
  • Location type: South Wing, second floor
  • MedicationRequest Category Codes: MedicationRequest/negation-example and MedicationRequest/negation-example-code
  • Observation Category Codes: Observation/clinical-result-heart-rate-rhythm, Observation/example... Show 16 more, Observation/example-births, Observation/example-delivery-date-estimate, Observation/example-frailty, Observation/example-gestation, Observation/example-obstetric-delivery, Observation/example-odh, Observation/example-parity, Observation/example-pregnancies, Observation/example-preterm-births, Observation/example-screening-assessment-10-minute-apgar-heart-rate, Observation/laboratory-result-observation-example-blood-glucose, Observation/negation-example, Observation/negation-with-code-example, QICoreLaboratoryResultObservation, QICoreObservationClinicalResult and QICoreObservationScreeningAssessment
  • Organization type: HENDRICKS COUNTY HOSPITAL, Health Level Seven International and QICoreOrganization
  • Payee Type Codes: Claim/example
  • Process Priority Codes: Claim/example
  • Observation Reference Range Meaning Codes: Observation/laboratory-result-observation-example-blood-glucose
  • SubscriberPolicyholder Relationship Codes: Coverage/example and Coverage/example-new
  • Substance Category Codes: Substance/example
  • identifierType: Coverage/example, Coverage/example-new... Show 5 more, Device/example, Patient/example, Patient/example-2, Patient/infant-example and QICoreCoverage
• This material derives from the HL7 Terminology THO. THO is copyright ©1989+ Health Level Seven International and is made available under the CC0 designation. For more licensing information see: https://terminology.hl7.org/license
  Show Usage
  • ActCode: Encounter/encounter-ed-example, Encounter/example and QICoreMedicationDispense
  • ActSite: Immunization/example
  • ObservationInterpretation: QICoreLaboratoryResultObservation, QICoreNonPatientObservation, QICoreObservationCancelled, QICoreObservationScreeningAssessment and QICoreSimpleObservation
  • ParticipationFunction: CareTeam/example and QICorePractitionerRole
  • ParticipationMode: Communication/example, Communication/negation-example and CommunicationRequest/example
  • RoleCode: FamilyMemberHistory/example, QICoreFamilyMemberHistory and South Wing, second floor
  • RouteOfAdministration: Immunization/example
  • Substance Admin Substitution: MedicationDispense/example
• This material derives from the HL7 Terminology THO. THO is copyright ©1989+ Health Level Seven International and is made available under the CC0 designation. For more licensing information see: https://terminology.hl7.org/license.html
  Show Usage
  • ActReason: QICoreImmunization
• Used by permission of HL7 International, all rights reserved Creative Commons License
  Show Usage
  • US Core CarePlan Category Extension Codes: CarePlan/example and QICoreCarePlan
  • US Core Condition Category Extension Codes: Condition/health-concern-example
  • US Core Category: QICoreObservationScreeningAssessment
• Using RxNorm codes of type SAB=RXNORM as this specification describes does not require a UMLS license. Access to the full set of RxNorm definitions, and/or additional use of other RxNorm structures and information requires a UMLS license. The use of RxNorm in this specification is pursuant to HL7's status as a licensee of the NLM UMLS. HL7's license does not convey the right to use RxNorm to any users of this specification; implementers must acquire a license to use RxNorm in their own right.
  Show Usage
  • RxNorm: AllergyIntolerance/example, Medication/example... Show 8 more, MedicationAdministration/negation-with-code-example, MedicationDispense/negation-with-code-example, QICoreMedicationAdministration, QICoreMedicationAdministrationNotDone, QICoreMedicationDispense, QICoreMedicationDispenseDeclined, QICoreMedicationNotRequested and QICoreMedicationStatement