This page is part of the Quality Improvement Core Framework (v5.0.0: STU5 (v5.0.0)) based on FHIR R4. The current version which supercedes this version is 4.1.1. 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.uv.bulkdata#2.0.0 FHIR based approach for exporting large data sets from a FHIR server to a client application (built Fri, Nov 26, 2021 05:56+1100+11:00)

Package hl7.fhir.uv.smart-app-launch#2.0.0

Package us.nlm.vsac#0.7.0

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.us.core#5.0.1 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, Jun 22, 2022 19:44+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
Encounter		QICore Encounter
Immunization		QICore Immunization
Immunization		QICore Immunization
Observation		QICore Observation
Observation		QICore Observation
Organization		QICore Organization
Organization		QICore Organization
Patient		QICore Patient
Patient		QICore Patient
Practitioner		QICore Practitioner
Practitioner		QICore Practitioner
PractitionerRole		QICore PractitionerRole
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
  • PH_VaccinesAdministeredCVX_CDC_NIP: Immunization/negation-example-code and QICoreImmunizationRecommendation
  • diagnosticServiceSectionId: DiagnosticReport/example and QICoreDiagnosticReportLab
  • contactRole2: Patient/example, Patient/example-2 and RelatedPerson/example
  • identifierType: Device/example, Patient/example, Patient/example-2 and Patient/infant-example
  • treatment: QICoreSpecimen and Specimen/example
  • providerRole: Immunization/example
  • specimenType: QICoreSpecimen
• HL7 Inc.
  Show Usage
  • Claim Type Codes: Claim/example, ClaimResponse/example and QICoreClaimResponse
• HL7 International.
  Show Usage
  • Financial Resource Status Codes: QICoreClaimResponse
• ISO Maintains the copyright on the country codes, and controls it's use carefully. For futher 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 75 more, NonNegativeImmunizationStatus, NonNegativeMedicationAdministrationStatus, NonNegativeMedicationDispenseStatus, NonNegativeObservationStatus, NonNegativeTaskStatus, QICore, QICoreAdverseEvent, QICoreAllergyIntolerance, QICoreBodyStructure, QICoreCarePlan, QICoreCareTeam, QICoreClaim, QICoreClaimResponse, QICoreCommunication, QICoreCommunicationNotDone, QICoreCommunicationRequest, QICoreConditionEncounterDiagnosis, QICoreConditionProblemsHealthConcerns, QICoreCoverage, QICoreDevice, QICoreDeviceNotRequested, QICoreDeviceRequest, QICoreDeviceUseStatement, QICoreDiagnosisPresentOnAdmission, QICoreDiagnosticReportLab, QICoreDiagnosticReportNote, QICoreDoNotPerformReason, QICoreEncounter, QICoreFamilyMemberHistory, QICoreFlag, QICoreGoal, QICoreGoalReasonRejected, QICoreImagingStudy, QICoreImmunization, QICoreImmunizationEvaluation, QICoreImmunizationNotDone, QICoreImmunizationRecommendation, QICoreIsElective, QICoreLaboratoryResultObservation, QICoreLocation, QICoreMedication, QICoreMedicationAdministration, QICoreMedicationAdministrationNotDone, QICoreMedicationDispense, QICoreMedicationDispenseDeclined, QICoreMedicationDoseType, QICoreMedicationNotRequested, QICoreMedicationRequest, QICoreMedicationStatement, QICoreNotDoneReason, QICoreNotDoneRecorded, QICoreNotDoneValueSet, QICoreNutritionOrder, QICoreObservation, QICoreObservationBodyPosition, QICoreObservationCancelled, QICoreObservationClinicalTestResult, QICoreObservationImagingResult, QICoreObservationSurvey, QICoreOrganization, QICorePatient, QICorePractitioner, QICorePractitionerRole, QICorePresentOnAdmission, QICoreProcedure, QICoreProcedureNotDone, QICoreQuestionnaireResponse, QICoreRelatedPerson, QICoreServiceNotRequested, QICoreServiceRequest, QICoreServiceRequestAppropriatenessScore, QICoreSpecimen, QICoreSubstance, QICoreTask and QICoreTaskRejected
• The POA Indicator Codes are in the public domain and are free to use without restriction.
  Show Usage
  • CMS Present on Admission (POA) Indicator: Encounter/example, QICoreDiagnosisPresentOnAdmission, QICoreEncounter 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
  • Adjudication Value Codes: ClaimResponse/example and QICoreClaimResponse
  • Claim Payee Type Codes: Claim/example
  • Process Priority Codes: Claim/example
• This is an extensible set.
  Show Usage
  • SubscriberPolicyholder Relationship Codes: Coverage/example and Coverage/example-new
• 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 16 more, Goal/example, ImmunizationRecommendation/example, Observation/clinical-test-heart-rate-rhythm, Observation/example, Observation/example-frailty, Observation/example-gestation, Observation/example-odh, Observation/example-survey-10-minute-apgar-heart-rate, Observation/imaging-result-xray-chest-findings, Observation/laboratory-result-observation-example-blood-glucose, Observation/negation-with-code-example, QICoreDiagnosticReportNote, QICoreGoal, QICoreLaboratoryResultObservation, QICoreObservation and QICoreObservationClinicalTestResult
• 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 http://www.snomed.org/snomed-ct/get-snomed-ct or info@snomed.org.
  Show Usage
  • SNOMED Clinical Terms® (SNOMED CT®): AdverseEvent/example, AllergyIntolerance/example... Show 82 more, AllergyIntolerance/example-refuted, BodyStructure/example, CarePlan/example, Communication/negation-example, Condition/appendicitis-example, Condition/example, Condition/health-concern-example, Device/example, DeviceRequest/negation-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/negation-example, Observation/negation-with-code-example, Procedure/example, Procedure/negation-example, Procedure/negation-with-code-example, QICoreAdverseEvent, QICoreBodyStructure, QICoreCarePlan, QICoreConditionEncounterDiagnosis, QICoreConditionProblemsHealthConcerns, QICoreDeviceNotRequested, QICoreDeviceRequest, QICoreDeviceUseStatement, QICoreDiagnosticReportLab, QICoreDiagnosticReportNote, QICoreFamilyMemberHistory, QICoreFlag, QICoreGoal, QICoreGoalReasonRejected, QICoreImmunization, QICoreImmunizationEvaluation, QICoreMedicationAdministration, QICoreMedicationAdministrationNotDone, QICoreMedicationDispense, QICoreMedicationDispenseDeclined, QICoreMedicationDoseType, QICoreMedicationNotRequested, QICoreMedicationStatement, QICoreObservation, QICoreObservationBodyPosition, QICoreObservationImagingResult, QICoreProcedure, QICoreServiceNotRequested, QICoreServiceRequest, QICoreSpecimen, QICoreSubstance, ServiceRequest/appropriateness-example, ServiceRequest/elective-example, ServiceRequest/example, ServiceRequest/myringotomy-example, ServiceRequest/negation-example, ServiceRequest/negation-example-code, Specimen/example, Task/negation-example and Task/negation-with-code-example
• 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 Observation Category Extension Codes: Observation/clinical-test-heart-rate-rhythm and QICoreObservationClinicalTestResult
  • US Core Tags CodeSystem: QICoreConditionProblemsHealthConcerns and QICoreQuestionnaireResponse
• 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 4 more, MedicationAdministration/negation-with-code-example, MedicationDispense/negation-with-code-example, QICoreMedication and QICoreMedicationAdministration