Record of vaccine administration.

Data Element

Applicable Vocabulary Standard(s)
Immunizations

  • CDC IIS: Current HL7 Standard Code Set, CVX -- Vaccines Administered, updates through January 31, 2020
  • CDC National Drug Code (NDC) Directory – Vaccine NDC Linker Table, updates through January 31, 2020

Data Element

Applicable Vocabulary Standard(s)
Immunizations

  • IIS: Current HL7 Standard Code Set, CVX -- Vaccines Administered, updates through April 6, 2021
  • Vaccine National Drug Code (NDC) Directory – Vaccine NDC Linker Table, updates through May 18, 2021

Data Element

Applicable Vocabulary Standard(s)
Immunizations

Vaccine product administered, planned, or reported.

Both standards are required

  • IIS: Current HL7 Standard Code Set, CVX – Vaccines Administered, updates through June 15, 2022
  • Vaccine National Drug Code (NDC) Directory – Vaccine NDC Linker Table, updates through June 16, 2022

Data Element

Applicable Vocabulary Standard(s)
Immunizations

Vaccine product administered, planned, or reported.

Both standards are required

  • IIS: Current HL7 Standard Code Set, CVX – Vaccines Administered, updates through June 15, 2022
  • Vaccine National Drug Code (NDC) Directory – Vaccine NDC Linker Table, updates through June 16, 2022

Data Element

Applicable Vocabulary Standard(s)
Immunizations

Vaccine product administered, planned, or reported.

Both standards are required:

  • IIS: Current HL7 Standard Code Set, CVX –
    Vaccines Administered, updates through June 6, 2023
  • Vaccine National Drug Code (NDC) Directory – Vaccine
    NDC Linker Table, updates through June 7, 2023

Data Element

Applicable Vocabulary Standard(s)
Immunizations

Vaccine product administered, planned, or reported.

Both standards are required:

  • CVX – Vaccines Administered, updates through June 12, 2024
  • National Drug Code (NDC), updates through July 12, 2024
Lot Number

Sequence of characters representing a specific quantity of manufactured material within a batch of a vaccine product.

Data Element

Applicable Vocabulary Standard(s)
Immunizations

Vaccine product administered, planned, or reported.

Both standards are required:

  • CVX – Vaccines Administered, updates through July 23, 2025
  • National Drug Code (NDC), updates through July 23, 2025
Lot Number

Sequence of characters representing a specific quantity of manufactured material within a batch of a vaccine product.

Data Element

Applicable Vocabulary Standard(s)
Immunization

Vaccine product administered, planned, or reported.

Both standards are required:

  • CVX – Vaccines Administered
  • National Drug Code (NDC)
Immunization Lot Number

Sequence of characters representing a specific quantity of manufactured material within a batch of a vaccine product.
Immunization Status

State of an immunization event.
Immunization Record Source

Immunization event information source.

Examples include but are not limited to facility administering the immunization and an external record.

Comment

Submitted by csnewman on

Clarify data element descriptions

Examples (or better yet defined values) should be given for Immunization Status (presumably at least "complete" and "not performed" should be called out assuming that the scope of "record of a vaccine administration" includes refusals of vaccines)

The description of lot number is odd in its use of "specific quantity of manufactured material of a batch of vaccine product" - Quantity doesn't seem quite right and may cause confusion regarding the amount of vaccine administered. Perhaps "instance" would be better than "quantity".

Submitted by david_rocha on

"Immunizations" listed as a data class and data element

"Immunizations" listed as a data class and data element 

This would be an issue if ASTP decided to transform USCDI into an ontology.

The data element should be more specific than the data class.

Data element example would be "Immunizations Details"  - subject to stakeholder feedback and working group committee decision.

Submitted by CDC_DSMH_WG on

Rename the data element Immunizations to Vaccine Code

The inclusion of the vaccine code in USCDI v6 is essential for enhancing the clarity and effectiveness of immunization data management across healthcare platforms. Currently, within the immunizations data class, there exists an immunizations data element that captures information about the type of vaccine administered, using CVX or NDC codes. However, the term immunizations has often led to confusion, as it does not intuitively refer to vaccine code for those working with vaccination data. 

 To address this issue, CDC proposes renaming the immunizations data element to vaccine code. This change will resolve the ambiguity associated with the term “Immunizations” and ensure that discussions about immunization data within USCDI are clear and precise.                                                                                                                                       

The vaccine code data element will provide a more descriptive and accurate representation of the type of vaccine administered, aligning with common terminology used in public health and healthcare settings. This adjustment will also eliminate the confusion caused by the duplicate use of the term immunizations, which currently refers both to a data class and a data element. 

By adopting vaccine code as the standardized term, we also ensure consistency with US Core, further promoting interoperability and clarity across different health information systems. 

In summary, renaming the data element immunizations to vaccine code will enhance the precision, understanding, and consistency of immunization data within USCDI, ultimately supporting better public health outcomes. 

Submitted by kelly.clarke@j… on

Comment

Recommend adding Lot Number as a data element. This will ensure patient safety in the effect of a recall. This will also support FHIR resources, data exchange, and immunization registry tracking.

Submitted by aphillips@imoh… on

Data Class: Immunizations

Level 2 Data Element: Vaccination Administration Date

Level 2 Data Element: Vaccination Event Record Type

Level 2 Data Element: Immunization Status

Level 2 Data Element: Reason Immunization Not Performed

Level 2 Data Element: Immunization Code

IMO supports the inclusion of the proposed Level 2 data elements in USCDI V3.  Many technical specifications with a wide range of maturity were cited for inclusion of this data class and data elements. This information is routinely exchanged between clinical environments and state, tribal, local, or territorial (STLT) public health agencies, and are supported by ONC Certified HIT.

Submitted by CDC_DSMH_WG on

USCDI defines this as “the…

USCDI defines this as “the record of an administration of a vaccination or a record of a vaccination as reported by a patient, a clinician, or another party.” The HL7 Event code DE Immunization Status addresses a single visit that is fulfilled by the following value set:
• completed
• entered-in-error
• not-done
The last valid value “not-done” might benefit from having a reason why not done and offering ‘entered-in-error’ as one of the reasons. The expanded valid values in the HL7 Immunization Status Reason Codes for the reason immunization not performed does not capture most reasons why the patient might have declined the vaccine. The CDC message mapping guide (MMG) for case notifications uses a larger value set as seen in this here.  
Additionally, the USCDI Immunization Data Class does not capture critical information regarding a vaccine series or booster status which are available in immunization registries. MMGs with vaccine information captures a patient’s vaccine history including booster shots, dose number, and whether a series was completed by the appropriate date.  These vaccine data elements used by CDC for case notification include:
• Vaccine Dose Number
• Vaccine Manufacturer
• Vaccine Lot Number
• Vaccine Expiration Date
We recommend assessing if more information such as boosters and additional series information can be captured to fulfill a more complete use case for Immunization Status. The other DEs from this data class are compatible with the current DEs CDC requests for case notifications. 

This field is for general comments on this specific data class. To submit new USCDI data classes and/or data elements, please use the USCDI ONDEC system: https://healthit.gov/ONDEC

USCDI_Version_2_DSAT_Comments_20210413.docx

Submitted by priti singh on

a status reason why the vaccine was not given; When the vaccine

This field is for general comments on this specific data class. To submit new USCDI data classes and/or data elements, please use the USCDI ONDEC system: https://healthit.gov/ONDEC

Hi,

My question is related to the Immunizations data class. If the "status" is - "not done". How do we find out the "date" when the vaccine was not given? I am asking this since both "Status" & "Date" are mandatory fields in the FHIR data model.

Thanks,

Priti

Log in or register to post comments

FormGuide

Help

1. Optional: Background Text / Cover Letter

The "Optional Background Text / Cover Letter" field provides space for additional context or introductory information related to your comment.

If you wish to provide context, explanation, or an introduction to your comment, enter this information in the field labeled "Optional Background Text / Cover Letter." This is entirely optional and is most useful when submitting multiple related comments or when additional background would help reviewers understand your feedback.

If you are only commenting on a single data class or element, you may leave this field blank.

2. Select the Data Class

To specify which data class your comment addresses:

  1. In the "Data Class" drop-down menu, select the appropriate data class you want to comment on.
  2. If you are providing a general comment that is not specific to a data element, select "General" from the options. Comments with this designation will be displayed on the USCDI landing page.
  3. Note that the Data Class field will automatically populate based on your current location in the platform:
    1. If you are on a data class page, the field will be set to that specific data class
    2. If you are on a data element page, the corresponding data class will be pre-selected
       

3. Select the Data Element

To specify which data element your comment addresses:

  1. In the "Data Element" drop-down menu, select the specific data element you want to comment on.
  2. The drop-down menu will display only the elements available under the data class you selected in the previous step.
  3. You can use the search function within the drop-down to quickly locate a specific data element.
  4. If you are commenting on the data class itself rather than a specific element, you may leave this field blank.

Note: Comments on a specific data element will appear on the respective data element page, while comments on a data class (without a specific element selected) will appear on the landing page for that data class.
 

Data Class and Data Element

Fig 1 The "Data Class" and "Data Element" dropdown menus allow users to specify the exact content they wish to comment on.

4. Optional: Propose New Data Class or Element

If you cannot find the appropriate data class or element for your comment:

  1. Instead of clicking the "Comment On An Existing Data Class Or Element" button, click the adjacent button labeled "Propose a New Data Class or Data Element."
  2. This will redirect you to the ONDEC (ONC New Data Element and Class) Submission System.
  3. In the ONDEC system, follow the provided instructions to submit your proposal for a new data class or element.
  4. Once your proposal is submitted through ONDEC, it will be reviewed separately from the commenting process.
Propose New Data Class or Element

Fig 2 The "Propose a New Data Class or Data Element" button redirects users to the ONDEC Submission System for proposing new data elements not currently available in the system.

5. Complete the Comment Form

Fill out the required fields in the comment form:

Subject: Enter a brief, descriptive title that summarizes your comment. This helps reviewers quickly understand the nature of your feedback.

Comment: In this field, provide the full details of your comment or feedback. Be as clear and specific as possible about your suggestions, concerns, or observations. Include any relevant details that support your position.

6. Optional: Add Additional Comments

If you need to comment on multiple data classes or elements:

  1. After completing your first comment, click the link labeled "Comment on another data element" at the bottom of the form.
  2. A new comment section will appear, allowing you to enter details for your additional comment.
  3. For each additional comment, you must select the appropriate data class and data element from the drop-down menus.
  4. Complete the Subject and Comment fields for your additional comment.
  5. Repeat this process for each additional comment you wish to submit.

Fig 3 The "Comment on another data element" link enables users to create multiple comments addressing different elements within a single submission.

7. Optional: Upload Supporting Files

The platform allows you to upload supporting documentation to enhance your comment:

  • Locate the "File Upload" section at the bottom of the comment form.
  • Click to upload any files (such as PDFs or documents) that provide additional context, evidence, or clarification for your comment.

Important: If you have already entered your comments using the form fields, there is no need to upload duplicate content in PDF format. The file upload feature is intended for supplementary materials only. Please avoid uploading files that contain the same information already provided in your comment text.

Upload Supporting Files

Fig 4 The "File Upload" section permits users to attach supporting documentation that supplements their written comments.

8. Optional: Save and Exit

If you need to pause your work and return to complete your comment later:

  1. Click the "Save and Exit" button at the bottom of the form.
  2. Your comment will be saved as a draft that you can access and complete later.
  3. When you return to the platform, you will see a red triangle with an exclamation mark next to the “Return to saved Comment” button, indicating that you have saved comments in draft status.
  4. Click this button to continue working on your draft.
  5. You will be taken to a review page where you can:
    1. Select "Submit Comment" to officially submit your feedback.
    2. Click "Edit" to return to the comment form and make changes
    3. Select "Discard Draft" to delete the saved draft and start fresh

Fig 5 A red triangle with exclamation mark indicator appears next to the “Return to saved Comment” button when draft comments are saved in the system.

9. Review and Submit

Once you have completed your comment:

  1. Click the "Review and Submit" button at the bottom of the form.
  2. This will take you to a review screen displaying your comment(s) in full.
  3. Review all information for accuracy and completeness.
  4. On this review screen, you have three options: 
    1. Click "Submit Comment" to officially submit your feedback
    2. Click "Edit" to return to the comment form and make changes
    3. Click "Discard Draft" to delete the comment and start fresh
  5. The review screen also includes a "Print" button that allows you to create a printed copy of your comments for your records. 
  6. If you choose to submit, your comment will be recorded in the system and made available for review by the appropriate stakeholders.
Review and Submit

Fig 6 The review screen allows users to verify comment content and make any necessary modifications before final submission.

USCDI Comments

Close

Add a New Comment

Review comment and Submit

Edit
Comment #1