CIR: How to Report

There are two ways to exchange immunization data with the CIR: Electronically with your EHR or Online with the CIR’s Online Registry.

Electronic data exchange with your EHR Vendor

Health Level 7 Standard, version 2.5.1

The Center of Disease Control and Prevention (CDC) together with public and private healthcare professionals and software developers have defined a set of electronic messages that support the national standards for exchanging immunization data. Using Health Level 7 (HL7) standards (PDF) enables interoperability between EHRs, administrative and billing systems.

Since the CIR’s HL7 Web Service specifications were designed in 2009, over 3,363 successful HL7 connections have been made. Web Service is a software that is used over the internet to support interoperable connections between CIR and your facility or practice. Health care practices may choose from over 70 certified EHR vendors who use the standards. For technical specifications, see the CIR HL7 Web Service 2.5.1 Integration Guide. (PDF)

The CIR’s HL7 Web Service data exchange includes the ability for both reporting immunization data with Vaccination Information Update (VXU) messages and querying for patient immunization historical data with Query By Parameter (QBP) messages via an EHR.

Meaningful Use requires adoption of HL7. CIR only supports HL7 2.5.1 format it. For more information about CIR HL7 2.5.1 standards review CIR HL7 Implementation Guide (PDF)

Health Level 7 Vaccine Codes

To report immunizations administered, the CIR requires CVX codes alone or with NDC sale. The CIR does not accept the full list of CDC CVX codes, the following link will contain the most up to date list:

Health Level 7 Testing and Onboarding Process

If your organization administers vaccines within New York City’s five boroughs and are interested in exchanging data with the CIR, review the following steps:

  1. CIR Facility Codes

    Each facility, hospital or practice location that administers vaccinations must have a CIR facility code to exchange data with the CIR. The CIR facility code is a unique identifier based on address location and can be obtained by registering with the CIR. If your facility hospital or practice has more than one location that administers immunization within New York City’s five boroughs, each of those locations should have its own CIR facility code.

    The CIR facility code is also used to track vaccine administrations, verify compliance for programs like Vaccines for Children and EHR incentivized program active engagement levels.

    If you think you may be registered and have forgotten your facility code, enter your information on the registration page for verification to obtain your facility code.


  2. Confidentiality Forms
    Prior to exchanging data with the CIR, a completed confidentiality form is required from the following two data exchange partners:

  3. Email the CIR Interoperability Team
    Email the confidentiality form along with the following details to the CIR Interoperability Team at cir_interop@health.nyc.gov.
    • Health Care Practice Name Requesting HL7 Connection (Required)
    • Health Care Practice Address (Required)
    • EHR Software Name: (indicate if product is a 2014 or 2015 edition CEHRT) (Required)
    • CIR Facility Code(s) (Required)
    • Primary Contact Name (Required)
    • Primary Contact Email (Required)
    • Primary Contact Phone Number (Required)

    Once this information is completed, the CIR Interopability Team will schedule a “kick-off call.”

  4. Open ticket with EHR Vendor
    Open a ticket with your EHR Vendor to request an HL7 connection to the CIR and ensure they are on the kick-off call to discuss testing requirements for establishing an HL7 data exchange connection to the CIR.
    • Participate in Kick-off call and establish testing plan
    • EHR Vendor / CIR HL7 will perform testing and validation
    • Deployment plan
    • Close-out call and production deployment

    For more information regarding the onboarding process, send an e-mail to cir_interop@health.nyc.gov.

Helpful Information for EHR Vendors

The CIR Interoperability team supports EHR vendors and data exchange partners with the HL7 testing and onboarding process. If you have any questions regarding the Onboarding process, send an e-mail to cir_interop@health.nyc.gov. For more support, reference the following EHR Vendor links:

EHR immunization data exchange issues

The CIR Interoperability Team supports EHR vendors and data exchange partners with understanding HL7 errors and data exchange issues.

  1. Open a ticket with your EHR Vendor. If you are experiencing EHR data exchange issues with CIR open a ticket with your EHR Vendor.
  2. Email the CIR Interoperability Team. After opening a ticket with your EHR Vendor for the HL7 error or data exchange issue email the CIR interoperability team the following information to cir_interop@health.nyc.gov for assistance. Do not send any protected health information (PHI) like first name, last name or DOB.
  • Select description of the issue/error encountered from the following list:
    • Immunization data reported from EHR but missing from CIR
    • Immunization data reported from EHR is incorrect in CIR
    • CVX Code Error
    • HL7 Errors
  • Your affiliated organization (EHR vendor or health care provider)
  • CIR facility code(s) impacted
  • Time the issue/errors started
  • Error message(s), if received
  • For EHR Vendor, provide the MSH-10 Message Control IDs
  • EHR Vendor ticket number and contact

Universal Provider Interface Format (UPIF) (PDF)

If you have a programmer, you may compile a file from your electronic system and send it to CIR through a secure website. Request the Universal Provider Interface Format (UPIF) specification document for the format of the file. Send an email with the subject line “UPIF document, WFR account request” to cir-facility-manager@health.nyc.gov for the latest version of UPIF and to obtain access to the secure site to submit your test file.