HRSA 2023 Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+) FHIR IG
1.1.0 - STU1 Release 1.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.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

Resource Profile: UDSPlusImmunization - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 2

Definitions for the uds-plus-immunization resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Immunization
Definition

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.

ShortDe-Identified UDS Plus Immunization
2. Immunization.id
Definition

De-dentified immunization resource identifier.

ShortThe de-identified Immunization identifier created by the health center to send data to UDS+ Data Receiver
Must Supporttrue
4. Immunization.text
ShortCannot include any text in the resource as part of the de-identified data.
Control0..0
Must Supportfalse
6. Immunization.contained
ShortCannot include any contained resources in the resource as part of the de-identified data.
Control0..0
Must Supportfalse
8. Immunization.status
Control1..1
Must Supporttrue
10. Immunization.statusReason
Control0..1
Must Supporttrue
12. Immunization.vaccineCode
Control1..1
Must Supporttrue
14. Immunization.patient
Control1..1
TypeReference(De-Identified UDS Plus Patient)
Must Supporttrue
16. Immunization.patient.display
Control0..0
Must Supportfalse
18. Immunization.occurrence[x]
Control1..1
TypedateTime, string
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Invariantsuds-plus-imm-1: All dateTime data elements should be truncated to a year only for de-identified resources. ($this is DateTime implies $this.toString().length() = 4)
20. Immunization.recorded
Control0..1
Must Supporttrue
Invariantsuds-plus-iimm-2: All dateTime data elements should be truncated to a year only for de-identified resources. ($this is DateTime implies $this.toString().length() = 4)
22. Immunization.primarySource
Control1..1
Must Supporttrue
24. Immunization.expirationDate
Control0..1
Must Supportfalse
Invariantsuds-plus-iimm-3: All date data elements should be truncated to a year only for de-identified resources. ($this is date implies $this.toString().length() = 4)
26. Immunization.note
Control0..0
Must Supportfalse
28. Immunization.reaction
30. Immunization.reaction.date
Control0..1
Must Supportfalse
Invariantsuds-plus-iimm-4: All dateTime data elements should be truncated to a year only for de-identified resources. ($this is dateTime implies $this.toString().length() = 4)