HRSA 2023 Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+) FHIR IG
1.0.1 - STU1 Release 1 - Standard for Trial-Use International flag

This page is part of the HRSA Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+ or uds-plus) FHIR IG (v1.0.1: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

Uds Plus Data Receiver CapabilityStatement

This is a CapabilityStatement that defines the expected capabilities of the Data Receiver actor as a Server.

Uds Plus Data Source CapabilityStatement

This is a CapabilityStatement that defines the expected capabilities of the Data Source actor.

Uds Plus Data Submitter CapabilityStatement

This is a CapabilityStatement that defines the expected capabilities of the Data Submitter actor.

Uds Plus Trust Service Provider CapabilityStatement

This is a CapabilityStatement that defines the expected capabilities of the Trust Service Provider actor.

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.

Generate De-Identified data

Generates de-identified data from identifiable data. The de-identification algorithm to be used is left to the implementers of the operation. Errors during the execution of the operation can be returned as OperationOutcome per the FHIR spec as a return parameter.

UDS Plus Import

Notification from a Health Center about the availability of the data to HRSA using Bulk Import mechanism.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

De-Identified UDS Plus AdverseEvent

The UDS+ profile is based on the AdverseEvent resource and establishes the core elements, extensions, vocabularies and value sets for representing Allergies and Intolerances for UDS+ program.

De-Identified UDS Plus AllergyIntolerance

The UDS+ profile is based on the AllergyIntolerance resource and establishes the core elements, extensions, vocabularies and value sets for representing Allergies and Intolerances for UDS+ program.

De-Identified UDS Plus Clinical Result Observation

The UDS+ profile is based on the Observation resource and establishes the core elements, extensions, vocabularies and value sets for representing clinical result observations for UDS+ program.

De-Identified UDS Plus Diagnosis

The UDS+ profile is based on the Condition resource and establishes the core elements, extensions, vocabularies and value sets for representing Diagnosis for UDS+ program.

De-Identified UDS Plus Encounter

The UDS+ profile is based on the Encounter resource and establishes the core elements, extensions, vocabularies and value sets for representing encounters,visit information for UDS+ program.

De-Identified UDS Plus Immunization

The UDS+ profile is based on the Immunization resource and establishes the core elements, extensions, vocabularies and value sets for representing immunizations for UDS+ program.

De-Identified UDS Plus Income

The UDS+ profile is based on the Observation resource and establishes the core elements, extensions, vocabularies and value sets for representing Income ranges for UDS+ program.

De-Identified UDS Plus Lab Observation

The UDS+ profile is based on the Observation resource and establishes the core elements, extensions, vocabularies and value sets for representing lab observations for UDS+ program.

De-Identified UDS Plus MedicationRequest

The UDS+ profile is based on the MedicationRequest resource and establishes the core elements, extensions, vocabularies and value sets for representing MedicationRequest for UDS+ program.

De-Identified UDS Plus MedicationStatement

The UDS+ profile is based on the MedicationStatement resource and establishes the core elements, extensions, vocabularies and value sets for representing MedicationStatement for UDS+ program.

De-Identified UDS Plus Patient

This Patient profile represents a Patient availing HRSA services.

De-Identified UDS Plus Procedure

The UDS+ profile is based on the Procedure resource and establishes the core elements, extensions, vocabularies and value sets for representing procedures for UDS+ program.

De-Identified UDS Plus RelatedPerson

This Patient profile represents a RelatedPerson of a Patient availing HRSA services.

De-Identified UDS Plus ServiceRequest

The UDS+ profile is based on the ServiceRequest resource and establishes the core elements, extensions, vocabularies and value sets for representing ServiceRequest for UDS+ program.

De-Identified UDS Plus Sexual Orientation

The UDS+ profile is based on the **US Core Sexual Orientation Observation profile and establishes the core elements, extensions, vocabularies and value sets for representing Sexual Orientation for UDS+ program.

DeIdentified UDS Plus Coverage

The UDS+ profile establishes the core elements, extensions, vocabularies and value sets for representing Coverage for UDS+ program.

UDS Plus DeIdentify Data Urls Parameter

The UDS+ profile is based on the **Parameters FHIR Resource and establishes the core elements, extensions, vocabularies and value sets for representing the data for sending input and receiving output for the DeIdentify operation of UDS+ .

UDS Plus Import Manifest

The UDS+ profile is based on the **Parameters FHIR Resource and establishes the core elements, extensions, vocabularies and value sets for representing the Manifest for UDS+ import FHIR Operations.

UDS Plus Location

Indicates the location where the care was provided

UDS Plus Patient Reporting Parameters

The UDS+ profile is based on the **Parameters FHIR Resource and establishes the core elements, extensions, vocabularies and value sets for representing the Patients and if they are counted for the various reports.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

UDS Plus Age Extension

Indicates the age of the patient at a specific time

UDS Plus Agriculture Worker Status Extension

Indicates the agriculture worker status of the patient at a specific time

UDS Plus Birth Sex Extension

Indicates the birth sex of the patient

UDS Plus Capitated Member Months Extension

Indicates the number of capitated member months of the patient for the reporting year

UDS Plus Ethnicity Extension

Indicates the ethnicity of the patient.

UDS Plus FeeForService Member Months Extension

Indicates the number of FeeForService member months of the patient for the reporting year

UDS Plus Gender Identity Extension

Indicates the gender identity of the patient at a specific time

UDS Plus Housing Status Extension

Indicates the housing status of the patient at a specific time

UDS Plus Race Extension

Indicates the race of the patient.

UDS Plus RecordedDate Extension

Indicates the recorded date of a clinical event

UDS Plus Veteran Status Extension

Indicates the Veteran status of the patient.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Uds Plus Agriculture Worker Status Codes

The Uds Plus Agriculture Worker Status Codes is a ‘starter set’ of codes for specifying agriculture worker status for Patients.

Uds Plus Birth Sex Codes

The Uds Plus Birth Sex Codes is a set of codes for identifying the birth sex of Patients.

Uds Plus Gender Identity Codes

The Uds Plus Gender Identity Codes is a ‘starter set’ of codes for identifying the gender identity of Patients.

Uds Plus Housing Status Codes

The Uds Plus Housing Status Codes is a ‘starter set’ of codes for identifying the Patient’s housing status.

Uds Plus Insurance Codes

The Uds Plus Insurance Codes is a ‘starter set’ of codes for identifying the source of the insurance for Patients.

Uds Plus Service Delivery Codes

The UDS Plus CodeSystem is an ‘addition set’ of one code to the existing Location Service Delivery Codes value set for UDS+ purposes.

Uds Plus Sexual Orientation Codes

The Uds Plus Sexual Orientation Codes is a ‘starter set’ of codes for identifying the sexual orientation of Patients.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

UDS Plus Agriculter Worker Status Codes

The UDS Plus CodeSystem is a ‘starter set’ of codes supported for identifying agriculture worker status for UDS+ program.

UDS Plus Housing Service Delivery Codes

The UDS Plus CodeSystem is an ‘addition set’ of one code to the existing Location Service Delivery Codes value set for UDS+ purposes.

UDS Plus Housing Status Codes

The UDS Plus CodeSystem is a ‘starter set’ of codes supported for identifying Housing status of patients in UDS+ program.

UDS Plus Insurance Codes

The UDS Plus CodeSystem is a ‘starter set’ of codes supported for identifying insurance types used by patients in UDS+ program.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

Example of a Manifest file used for multiple operations in the context of HRSA UDS+ FHIR IG

An Example of a conformant UDS+ Parameters resource representing a manifest file used by the $import and the $de-identify operation.

UDS Plus AdverseEvent Example

An Example of a conformant UDS Plus AdverseEvent resource with de-identified information.

UDS Plus AllergyIntolerance Example

An Example of a conformant UDS Plus AllergyIntolerance resource with de-identified information.

UDS Plus ClinicalResult Example

An Example of a conformant UDS Plus ClincialResult resource profile with de-identified information.

UDS Plus Parameters Example for $deidentify operation

An Example of a conformant UDS Plus Parameters resource for sending input and receiving output from $deidentify operation.

UDS Plus RelatedPerson Example

An Example of a conformant UDS Plus Related Person resource with de-identified information.

UDS Plus Reporting Parameters Example

An Example of a conformant UDS Plus Reporting Parameters resource with de-identifeid information.

US Core Condition Example

An Example of a conformant US Core Condition resource with identifiable information capturing a Problem List Item.

US Core Encounter Example

An Example of a conformant US Core Encounter resource with identifiable information capturing a visit.

US Core Healthcare Organization Example

An Example of a conformant US Core Healthcare Organization resource with identifiable information.

US Core Location Example

An Example of a conformant US Core Location resource with identifiable information.

US Core Organization Example for a Payer

An Example of a conformant US Core Organization resource for a Payor entity.

US Core Patient Example

An Example of a conformant US Core Patient resource with identifiable information.

US Core Patient Example of a patient residing in a zip code with small population (<20000 people)

An Example of a conformant US Core Patient resource with identifiable information.

US Core Practitioner Example

An Example of a conformant US Core Practitioner resource with identifiable information.

Uds Plus Coverage Example

An Example of a conformant UDS Plus Coverage resource with de-identified information.

Uds Plus De-Identified Condition Example

An Example of a conformant UDS+ Condition resource with de-identified information capturing a Problem List Item.

Uds Plus De-Identified Encounter Example

An Example of a conformant UDS+ Encounter resource with de-identified information capturing the visit information.

Uds Plus Immunization Example

An Example of a conformant UDS Plus Immunization resource with de-identified information.

Uds Plus Income Observation Example

An Example of a conformant UDS Plus Observation resource with de-identified income information.

Uds Plus Income Observation Example using Quantity

An Example of a conformant UDS Plus Observation resource with de-identified income information showing the usage of Quantity.

Uds Plus MedicationRequest Example

An Example of a conformant UDS Plus MedicationRequest resource with de-identified information.

Uds Plus MedicationStatement Example

An Example of a conformant UDS Plus MedicationStatement resource with de-identified information.

Uds Plus Observation Lab Result Example

An Example of a conformant UDS Plus Observation resource with de-identified information for a Lab Result.

Uds Plus Patient Example

An Example of a conformant UDS+ Patient resource which has been de-identified and is based on the US Core Patient small population example resource.

Uds Plus Patient Example for a patient residing in a zip code with small population (<20000 people)

An Example of a conformant UDS+ Patient resource which has been de-identified and is based on the US Core Patient example resource.

Uds Plus Procedure Example

An Example of a conformant UDS Plus Procedure resource with de-identified information.

Uds Plus ServiceRequest Example

An Example of a conformant UDS Plus ServiceRequest resource with de-identified information.

Uds Plus Sexual Orientation Observation Example

An Example of a conformant UDS Plus Observation resource with de-identified sexual orientation information.