This page is part of the HRSA Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+ or uds-plus) FHIR IG (v1.1.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Useful Downloads

Page standards status: Trial-use

Download

You can also download:

• this entire guide
• the definition resources in json, xml, ttl, or csv format, or
• the example resources in json, xml or ttl format.

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 (fhir.hrsa.uds-plus.r4) and R4B (fhir.hrsa.uds-plus.r4b) are available.

Dependency Table

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.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)

Globals Table

There are no Global profiles defined

IP Statements

This publication includes IP covered under the following statements.

• Copyright HL7. Licensed under creative commons public domain
  Show Usage
  • contactRole2: DeIdentifiedUDSPlusRelatedPerson
• 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/de-identified-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): Coverage/de-identified-example, Encounter/de-identified-example... Show 8 more, MedicationRequest/de-identified-example, MedicationStatement/de-identified-example, Observation/clinical-result-de-identified-example, Observation/de-identified-example, Observation/de-identified-income-with-quantity-example, Patient/de-identified-age89-example, Patient/de-identified-example and Patient/de-identified-smallpop-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: Observation/clinical-result-de-identified-example, Observation/de-identified-example... Show 10 more, Observation/de-identified-income-example, Observation/de-identified-income-with-quantity-example, Observation/de-identified-sexual-orientation-example, UDSPlusClinicalResultObservation, UDSPlusIncome, UDSPlusLabObservation, UDSPlusObservation, UDSPlusProcedure, UDSPlusServiceRequest and UDSPlusSexualOrientation
• 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/de-identified-example, AllergyIntolerance/de-identified-example... Show 9 more, Observation/de-identified-example, Observation/generic-observation-de-identified-example, Procedure/de-identified-example, ServiceRequest/de-identified-example, UDSPlusAllergyIntolerance, UDSPlusDiagnosis, UDSPlusEncounter, UDSPlusProcedure and UDSPlusServiceRequest
• 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
  • AdverseEventCategory: AdverseEvent/de-identified-example
  • AllergyIntolerance Clinical Status Codes: AllergyIntolerance/de-identified-example
  • AllergyIntolerance Verification Status: AllergyIntolerance/de-identified-example
  • Condition Category Codes: Condition/de-identified-example, Condition/example and Immunization/de-identified-example
  • ConditionVerificationStatus: Condition/de-identified-example and Condition/example
  • Observation Category Codes: Observation/clinical-result-de-identified-example, Observation/de-identified-example, Observation/generic-observation-de-identified-example and UDSPlusClinicalResultObservation
  • Organization type: Acme Health Plan and Holy Healthcare
• 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
  • Condition Clinical Status Codes: Condition/de-identified-example and Condition/example
  • identifierType: Patient/example and Patient/smallpop-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
  • ActCode: Encounter/de-identified-example and Encounter/example
  • AdministrativeGender: UDSPlusBirthSexExtension and UdsPlusBirthSexCodes
  • NullFlavor: Observation/de-identified-sexual-orientation-example, Patient/de-identified-age89-example... Show 8 more, Patient/de-identified-example, Patient/de-identified-smallpop-example, Patient/example, Patient/smallpop-example, UDSPlusGenderIdentityExtension, UDSPlusSexualOrientation, UdsPlusGenderIdentityCodes and UdsPlusSexualOrientationCodes
  • RoleCode: DeIdentifiedUDSPlusRelatedPerson and RelatedPerson/de-identified-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: MedicationRequest/de-identified-example, MedicationStatement/de-identified-example and UDSPlusAllergyIntolerance