US Core Implementation Guide
10.0.0-ballot - STU 10 Ballot United States of America flag

US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 10.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/US-Core/ and changes regularly. See the Directory of published versions

US Core ImplementationGuide Resource

Page standards status: Informative

   
Official URL: http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core Version: 10.0.0-ballot
NPM package name: hl7.fhir.us.core ComputableName: USCore

The US Core Implementation Guide defines the minimum set of FHIR RESTful interactions for each of the US Core Profiles to access patient data. The Data Access Framework and the Argonaut DSTU2 guides initially formed the basis for US Core. The Profiles are updated annually to support the latest requirements from The Office of the National Coordinator for Health Information Technology (ONC) U.S. Core Data for Interoperability (USCDI). For a summary of significant changes and a detailed list of the changes between versions, see the Change Notes at https://hl7.org/fhir/us/core/changes.html

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.core.r4) and R4B (hl7.fhir.us.core.r4b) are available.

IG Dependencies

This IG Contains the following dependencies on other IGs.

IGPackageFHIRComment
.. US Core Implementation Guidehl7.fhir.us.core#10.0.0-ballotR4
... HL7 Terminology (THO)hl7.terminology.r4#7.3.0R4Automatically added as a dependency - all IGs depend on HL7 Terminology
.... FHIR Extensions Packhl7.fhir.uv.extensions.r4#5.3.0R4
..... HL7 Terminology (THO)hl7.terminology.r4#7.1.0R4
...... FHIR Extensions Packhl7.fhir.uv.extensions.r4#5.2.0R4
... SMART App Launchhl7.fhir.uv.smart-app-launch#2.2.0R4
.... HL7 Terminology (THO)hl7.terminology#5.5.0R4
..... FHIR Extensions Packhl7.fhir.uv.extensions.r4#1.0.0R4
... Structured Data Capturehl7.fhir.uv.sdc#4.0.0R4
.... Extensions for Using Data Elements from FHIR R5 in FHIR R4hl7.fhir.uv.xver-r5.r4#0.1.0R4
.... FHIR Tooling Extensions IGhl7.fhir.uv.tools.r4#1.1.2R4
.... FHIR Extensions Packhl7.fhir.uv.extensions.r4#5.3.0-ballot-tc1R4
..... HL7 Terminology (THO)hl7.terminology.r4#6.5.0R4
... PHINVadsus.cdc.phinvads#0.12.0R4

Package hl7.fhir.uv.extensions.r4#5.2.0

This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Mon, Feb 10, 2025 21:45+1100+11:00)

Package hl7.fhir.uv.extensions.r4#5.3.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, May 16, 2026 18:32+1000+10: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.xver-r5.r4#0.1.0

Extensions for Using Data Elements from FHIR R5 in FHIR R4 (built Fri, Mar 20, 2026 15:40+1100+11:00)

Package hl7.fhir.uv.tools.r4#1.1.2

This IG defines the extensions that the tools use internally. Some of these extensions are content that are being evaluated for elevation into the main spec, and others are tooling concerns (built Tue, Mar 24, 2026 11:13+1100+11:00)

Package hl7.fhir.uv.extensions.r4#5.3.0-ballot-tc1

This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Sun, Aug 3, 2025 06:28+1000+10:00)

Package hl7.fhir.uv.sdc#4.0.0

The SDC specification provides an infrastructure to standardize the capture and expanded use of patient-level data collected within an EHR. (built Tue, Mar 24, 2026 16:16+1100+11:00)

Global Profiles

There are no Global profiles defined

Copyrights

This publication includes IP covered under the following statements.

Expansion Parameters

In HL7 FHIR, expansion parameters are special query parameters that you can pass to a ValueSet $expand operation to control and customize how the ValueSet is expanded (i.e., how the full list of codes/concepts is generated from the ValueSet definition). US Core uses the following parameters.

Parameter Value
system-version SNOMED CT[US]
system-version Observation Category Codes v2.0.0
system-version US Core DocumentReferences Category Codes v10.0.0-ballot
system-version NullFlavor v4.0.0
default-valueset-version ServiceDeliveryLocationRoleType v3.0.0
default-valueset-version CMS Place of Service Codes (POS) v1.0.0
system-version NarrativeStatus v4.0.1
system-version ObservationStatus v4.0.1
default-valueset-version Practice Setting Code Value Set v4.0.1
system-version US Core Category v10.0.0-ballot
default-valueset-version hl7VS-specimenCondition v3.0.0
system-version Condition Category Codes v2.0.0
system-version US Core Condition Category Extension Codes v10.0.0-ballot
default-valueset-version Service Request Category Codes v4.0.1
default-valueset-version Document Type Value Set v4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/AllergyIntolerance-clinical-status|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/clinical-patient|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/CarePlan-category|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/clinical-date|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/CarePlan-status|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/CareTeam-status|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Condition-abatement-date|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Condition-category|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Condition-clinical-status|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/clinical-code|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Condition-encounter|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Resource-lastUpdated|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Condition-onset-date|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Condition-recorded-date|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Coverage-patient|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Device-patient|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Device-status|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Device-type|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/DiagnosticReport-category|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/DiagnosticReport-status|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/DocumentReference-category|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/DocumentReference-date|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Resource-id|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/DocumentReference-period|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/DocumentReference-status|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/clinical-type|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Encounter-class|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/clinical-identifier|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Encounter-location|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Encounter-status|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Goal-lifecycle-status|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Goal-target-date|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Immunization-status|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Location-address-city|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Location-address-postalcode|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Location-address-state|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Location-address|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Location-name|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/medications-status|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/MedicationDispense-type|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/MedicationRequest-authoredon|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/medications-encounter|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/MedicationRequest-intent|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Observation-category|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Observation-status|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Organization-address|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Organization-name|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/individual-birthdate|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Patient-death-date|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/individual-family|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/individual-given|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Patient-identifier|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Patient-name|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Practitioner-identifier|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Practitioner-name|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/PractitionerRole-practitioner|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/PractitionerRole-specialty|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Procedure-status|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-authored|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-patient|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-questionnaire|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-status|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/RelatedPerson-name|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/RelatedPerson-patient|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/ServiceRequest-authored|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/ServiceRequest-category|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/ServiceRequest-status|4.0.1
default-canonical-version http://hl7.org/fhir/SearchParameter/Specimen-patient|4.0.1
default-canonical-version SMART App Launch
default-canonical-version SDC Base Questionnaire
default-canonical-version http://hl7.org/fhir/OperationDefinition/ValueSet-expand|4.0.1

Parameter Settings

The following IG Parameters are set for this Implementation Guide:

  • code: copyrightyear
    value: 2027+
  • code: releaselabel
    value: STU 10 Ballot
  • code: path-pages
    value: input/pagecontent
  • code: path-pages
    value: input/intro-notes
  • code: path-liquid
    value: input/liquid
  • code: active-tables
    value: false
  • code: apply-contact
    value: true
  • code: apply-jurisdiction
    value: true
  • code: apply-publisher
    value: true
  • code: apply-version
    value: true
  • code: show-inherited-invariants
    value: false
  • code: usage-stats-opt-out
    value: true
  • code: suppressed-ids
    value: DocumentReference/discharge-summary
  • code: tabbed-snapshots
    value: true
  • code: no-narrative
    value: DocumentReference/discharge-summary
  • code: no-narrative
    value: Bundle/docref-example-1
  • code: no-narrative
    value: Bundle/docref-example-2
  • code: version-comparison-master
    value: 9.0.0
  • code: version-comparison
    value: 9.0.0
  • code: version-comparison
    value: 8.0.1
  • code: version-comparison
    value: 7.0.0
  • code: version-comparison
    value: 6.1.0
  • code: version-comparison
    value: 5.0.1
  • code: version-comparison
    value: 4.0.0
  • code: version-comparison
    value: 3.1.1
  • code: html-exempt
    value: comparison-argo/vs-manifestation-or-symptom-manifestation-or-symptom.html
  • code: html-exempt
    value: comparison-argo/vs-observation-status-us-core-observation-smoking-status-status.html
  • code: html-exempt
    value: comparison-argo/sd-argo-diagnosticreport-us-core-diagnosticreport-note.html
  • code: html-exempt
    value: comparison-argo/vs-c80-doc-typecodes-us-core-documentreference-type.html
  • code: html-exempt
    value: comparison-argo/vs-c80-practice-codes-c80-practice-codes.html
  • code: html-exempt
    value: comparison-argo/vs-observation-methods-observation-methods.html
  • code: html-exempt
    value: comparison-argo/sd-argo-procedure-us-core-procedure.html
  • code: html-exempt
    value: comparison-argo/vs-procedure-followup-procedure-followup.html
  • code: html-exempt
    value: comparison-argo/vs-procedure-category-procedure-category.html
  • code: html-exempt
    value: comparison-argo/vs-condition-category-condition-category.html
  • code: html-exempt
    value: comparison-argo/index.html
  • code: html-exempt
    value: comparison-argo/vs-route-codes-route-codes.html
  • code: html-exempt
    value: comparison-argo/sd-argo-goal-us-core-goal.html
  • code: html-exempt
    value: comparison-argo/sd-argo-medication-us-core-medication.html
  • code: html-exempt
    value: comparison-argo/sd-argo-allergyintolerance-us-core-allergyintolerance.html
  • code: html-exempt
    value: comparison-argo/vs-medication-codes-medication-codes.html
  • code: html-exempt
    value: comparison-argo/sd-argo-condition-us-core-condition-encounter-diagnosis.html
  • code: html-exempt
    value: comparison-argo/vs-diagnostic-service-sections-diagnostic-service-sections.html
  • code: html-exempt
    value: comparison-argo/sd-argo-documentreference-us-core-documentreference.html
  • code: html-exempt
    value: comparison-argo/vs-formatcodes-v3-HL7FormatCodes.html
  • code: html-exempt
    value: comparison-argo/sd-argo-birthsex-us-core-birthsex.html
  • code: html-exempt
    value: comparison-argo/vs-goal-category-goal-category.html
  • code: html-exempt
    value: comparison-argo/sd-argo-immunization-us-core-immunization.html
  • code: html-exempt
    value: comparison-argo/vs-goal-start-event-goal-start-event.html
  • code: html-exempt
    value: comparison-argo/sd-argo-diagnosticreport-us-core-diagnosticreport-lab.html
  • code: html-exempt
    value: comparison-argo/vs-observation-category-observation-category.html
  • code: html-exempt
    value: comparison-argo/vs-report-codes-us-core-diagnosticreport-report-and-note-codes.html
  • code: html-exempt
    value: comparison-argo/sd-argo-condition-us-core-condition-problems-health-concerns.html
  • code: html-exempt
    value: comparison-argo/vs-observation-codes-us-core-laboratory-test-codes.html
  • code: html-exempt
    value: comparison-argo/vs-procedure-type-us-core-procedure-code.html
  • code: html-exempt
    value: comparison-argo/vs-body-site-body-site.html
  • code: html-exempt
    value: comparison-argo/vs-goal-priority-goal-priority.html
  • code: html-exempt
    value: comparison-argo/sd-argo-careplan-us-core-careplan.html
  • code: html-exempt
    value: comparison-argo/vs-c80-facilitycodes-c80-facilitycodes.html
  • code: html-exempt
    value: comparison-argo/vs-immunization-site-immunization-site.html
  • code: html-exempt
    value: comparison-argo/vs-substance-code-substance-code.html
  • code: html-exempt
    value: comparison-argo/vs-observation-codes-observation-codes.html
  • code: html-exempt
    value: comparison-argo/vs-immunization-route-immunization-route.html
  • code: html-exempt
    value: comparison-argo/vs-condition-code-condition-code.html
  • code: html-exempt
    value: comparison-argo/vs-procedure-outcome-procedure-outcome.html
  • code: html-exempt
    value: comparison-argo/vs-condition-stage-condition-stage.html
  • code: html-exempt
    value: comparison-argo/vs-condition-severity-condition-severity.html
  • code: html-exempt
    value: comparison-argo/vs-report-codes-us-core-laboratory-test-codes.html
  • code: html-exempt
    value: comparison-argo/vs-vacc-status-immunization-status.html
  • code: html-exempt
    value: comparison-argo/vs-device-action-device-action.html
  • code: html-exempt
    value: comparison-argo/vs-narrative-status-us-core-narrative-status.html
  • code: ipa-comparison
    value: {current}
  • code: ips-comparison
    value: {current}
  • code: path-expansion-params
    value: input/resources/Parameters-manifest.json
  • code: pin-canonicals
    value: pin-all
  • code: pin-manifest
    value: manifest
  • code: auto-oid-root
    value: 2.16.840.1.113883.4.642.40.2
  • code: fmm-definition
    value: changes-between-versions.html#us-core-maturity-levels
  • code: path-history
    value: http://hl7.org/fhir/us/core/history.html