Health Care Surveys Reporting
2.0.0 - STU 2

Health Care Surveys Reporting, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-health-care-surveys-reporting-ig/ and changes regularly. See the Directory of published versions

## Downloads

Page standards status: Informative

### Full Implementation Guide

The entire implementation guide (including the HTML files, definitions, validation information, etc.) may be downloaded here.

### Package File

The following package file includes an NPM package file used by many of the FHIR tools. It contains all the value sets, profiles, extensions, list of pages and urls in the IG, etc defined as part of this version of the Implementation Guides. This file should be the first choice whenever generating any implementation artifacts since it contains all of the rules about what makes the 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:

- Package

### Format Specific Definition Files

- XML
- JSON
- TTL

### Examples: all the examples that are used in this Implementation Guide available for download:

- XML
- JSON
- TTl

### 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.health-care-surveys-reporting.r4) and R4B (hl7.fhir.us.health-care-surveys-reporting.r4b) are available.

### Dependency Table

IG | Package | FHIR | Comment
--- | --- | --- | ---
Health Care Surveys Reporting | hl7.fhir.us.health-care-surveys-reporting#2.0.0 | R4 |
HL7 Terminology (THO) | hl7.terminology.r4#7.0.1 | R4 | Automatically added as a dependency - all IGs depend on HL7 Terminology
FHIR Extensions Pack | hl7.fhir.uv.extensions.r4#5.2.0 | R4 |
US Core Implementation Guide | hl7.fhir.us.core#6.1.0 | R4 |
HL7 Terminology (THO) | hl7.terminology.r4#5.0.0 | R4 |
FHIR Extensions Pack | hl7.fhir.uv.extensions.r4#1.0.0 | R4 |
Bulk Data Access IG | hl7.fhir.uv.bulkdata#2.0.0 | R4 |
SMART App Launch | hl7.fhir.uv.smart-app-launch#2.1.0 | R4 |
VSAC | us.nlm.vsac#0.11.0 | R4 |
Structured Data Capture | hl7.fhir.uv.sdc#3.0.0 | R4 |
PHINVads | us.cdc.phinvads#0.12.0 | R4 |
IHE FormatCode Vocabulary | ihe.formatcode.fhir#1.1.0 | R4 |
US Public Health Profiles Library | hl7.fhir.us.ph-library#1.0.0 | R4 |
US Core Implementation Guide | hl7.fhir.us.core#5.0.1 | R4 |
HL7 Terminology (THO) | hl7.terminology.r4#3.1.0 | R4 |
SMART App Launch | hl7.fhir.uv.smart-app-launch#2.0.0 | R4 |
VSAC | us.nlm.vsac#0.7.0 | R4 |
SMART App Launch | hl7.fhir.uv.smart-app-launch#2.2.0 | R4 |
HL7 Terminology (THO) | hl7.terminology#5.5.0 | R4 |
Subscriptions R5 Backport | hl7.fhir.uv.subscriptions-backport.r4#1.1.0 | R4 |
FHIR Tooling Extensions IG | hl7.fhir.uv.tools.r4#0.9.0 | R4 | for example references

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#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.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.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 ihe.formatcode.fhir#1.1.0 Implementation Guide for IHE defined FormatCode vocabulary. (built Thu, Feb 24, 2022 16:55-0600-06:00)

Package hl7.fhir.us.core#6.1.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 Fri, Jun 30, 2023 14:02+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)

Package hl7.fhir.uv.subscriptions-backport.r4#1.1.0 The Subscription R5 Backport Implementation Guide enables servers running versions of FHIR earlier than R5 to implement a subset of R5 Subscriptions in a standardized way. (built Wed, Jan 11, 2023 15:34+1100+11:00)

Package hl7.fhir.uv.tools.r4#0.9.0 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, Dec 16, 2025 23:18+1100+11:00)

### Global Profiles Table

There are no Global profiles defined

### IP Statements

This publication includes IP covered under the following statements.

- 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: HealthCareSurveysComposition, HealthCareSurveysMedicationAdministration... Show 6 more, HealthCareSurveysPlanDefinition, HealthcareSurveysContentBundle, HealthcareSurveysReporting, HealthcareSurveysReportingBundle, HealthcareSurveysReportingEHRCapabilityStatement and PlanDefinitionNationalHealthCareSurveysExample
- 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/immunization-example
- 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): MedicationAdministration/medicationadministration-example, Observation/observation-bp-example... Show 9 more, Observation/observation-clinical-example, Observation/observation-clinical-result-example, Observation/observation-heartrate-example, Observation/observation-height-example, Observation/observation-lab-example, Observation/observation-oximetry-example, Observation/observation-resprate-example, Observation/observation-temperature-example and Observation/observation-weight-example
- 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: Bundle/hcs-content-bundle-example, Bundle/healthcare-surveys-reporting-bundle... Show 24 more, Composition/hcs-composition-example, DiagnosticReport/diagnosticreport-lab-example, DiagnosticReport/diagnosticreport-note-example, DocumentReference/documentreference-example, HealthCareSurveysComposition, Observation/observation-bp-example, Observation/observation-clinical-example, Observation/observation-clinical-result-example, Observation/observation-clinical-result-xray-example, Observation/observation-heartrate-example, Observation/observation-height-example, Observation/observation-lab-example, Observation/observation-occupation-example, Observation/observation-oximetry-example, Observation/observation-pregnancy-intent-example, Observation/observation-pregnancy-status-example, Observation/observation-resprate-example, Observation/observation-screening-assessment-example, Observation/observation-screening-example, Observation/observation-smoking-example, Observation/observation-temperature-example, Observation/observation-weight-example, ServiceRequest/example and ServiceRequest/servicerequest-example
- 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&reg; (SNOMED CT&reg;): AllergyIntolerance/allergyintolerance-sulfonamide-example, Condition/condition-encounter-diagnosis-example... Show 16 more, Condition/condition-problem-liveborn-example, Condition/condition-problem-pharyngitis-example, Device/device-example, Encounter/encounter-ambulatory, Goal/goal-example, Immunization/immunization-example, MedicationAdministration/medicationadministration-example, MedicationAdministration/medicationadministrationone-example, MedicationRequest/MedicationRequest-example, Observation/observation-pregnancy-status-example, Observation/observation-smoking-example, Patient/patient-ledner, Procedure/procedure-example, Respiratory Care Team, ServiceRequest/example and ServiceRequest/servicerequest-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
  - AllergyIntolerance Clinical Status Codes: AllergyIntolerance/allergyintolerance-sulfonamide-example
  - AllergyIntolerance Verification Status: AllergyIntolerance/allergyintolerance-sulfonamide-example
  - Condition Category Codes: Condition/condition-encounter-diagnosis-example, Condition/condition-problem-liveborn-example and Condition/condition-problem-pharyngitis-example
  - Condition Clinical Status Codes: Condition/condition-encounter-diagnosis-example, Condition/condition-problem-liveborn-example and Condition/condition-problem-pharyngitis-example
  - ConditionVerificationStatus: Condition/condition-encounter-diagnosis-example, Condition/condition-problem-liveborn-example and Condition/condition-problem-pharyngitis-example
  - Coverage Class Codes: Coverage/coverage-bcbs-example and Coverage/coverage-upmc-example
  - Endpoint Connection Type: Bundle/healthcare-surveys-reporting-bundle, HealthCareSenderAndReceiver and PHAReceiver
  - Goal achievement status: Goal/goal-example
  - Location type: General Hospital - Main Campus
  - Observation Category Codes: Observation/observation-bp-example, Observation/observation-clinical-example... Show 15 more, Observation/observation-clinical-result-example, Observation/observation-clinical-result-xray-example, Observation/observation-heartrate-example, Observation/observation-height-example, Observation/observation-lab-example, Observation/observation-occupation-example, Observation/observation-oximetry-example, Observation/observation-pregnancy-intent-example, Observation/observation-pregnancy-status-example, Observation/observation-resprate-example, Observation/observation-screening-assessment-example, Observation/observation-screening-example, Observation/observation-smoking-example, Observation/observation-temperature-example and Observation/observation-weight-example
  - Organization type: Blue Cross Blue Shield
  - PlanDefinitionType: HealthCareSurveysPlanDefinition and PlanDefinitionNationalHealthCareSurveysExample
  - SubscriberPolicyholder Relationship Codes: Coverage/coverage-bcbs-example and Coverage/coverage-upmc-example
  - diagnosticServiceSectionId: DiagnosticReport/diagnosticreport-lab-example
  - identifierType: Coverage/coverage-upmc-example and Patient/patient-baxter
  - ActCode: Encounter/encounter-ambulatory
  - MaritalStatus: Patient/patient-ledner
  - ObservationInterpretation: Observation/observation-clinical-example, Observation/observation-clinical-result-example, Observation/observation-lab-example, Observation/observation-screening-assessment-example and Observation/observation-screening-example
  - RoleCode: General Hospital - Main Campus
  - TribalEntityUS: Patient/patient-baxter
- Used by permission of HL7 International, all rights reserved Creative Commons License
  Show Usage
  - US Core DocumentReferences Category Codes: DocumentReference/documentreference-example
- 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: MedicationAdministration/medicationadministration-example and MedicationAdministration/medicationadministrationone-example

### Expansion Parameters

Parameter | Value
--- | ---
profile-url | dc8fd4bd-091a-424a-8a3b-6198ef136891
system-version | SNOMED CT[US]