Immunization Registry (WIR)

The Immunization Registry Integration allows SIS vendors to integrate with the Wisconsin Immunization Registry (WIR), which is operated by the Department of Health Services (DHS). SIS vendors that implement this optional integration provide a means for their schools and districts to automatically pull down immunization data from the WIR, including vaccine groups, vaccine codes, administration dates, and other details. This automation not only saves significant amounts of staff time but also improves the accuracy of immunization data entered in the SIS. The Immunization Registry Integration is an opt-in feature for LEAs, meaning LEAs have to actively take action in order to show their interest in using this feature. For more details, visit https://dpi.wi.gov/wisedata/help/wiseadmin-portal/immunization-opt-in.

This integration is only available to Choice and Public schools, Charter and Virtual Schools are limited to manual entry of immunization data.

This integration is optional for Choice schools.

Prerequisite:

Prerequisite Overview

This integration enables one-way data flow of immunization records from the Wisconsin Immunization Registry (WIR) to SIS vendors. There is no posting or updating of immunization data back to WIR or through the Ed-Fi API.

Opt-in/Opt-Out Configurations

Local Education Agencies (LEAs) manage immunization data sharing preferences via the WISEadmin application. The default setting is opt-out.

SIS vendors are encouraged to configure their systems so that the immunization integration is disabled by default. Users must explicitly enable the integration—first in WISEadmin, then within the SIS.

This integration is designed solely to allow immunization data to flow from WIR to SIS vendors. There is no posting or updating of data through the Ed-Fi API related to immunizations.
Local Education Agencies (LEAs) manage immunization data sharing preferences through the WISEadmin application. By default, the setting is opt-out.
Vendors are encouraged to configure their SIS so that the immunization integration is disabled by default. Users must explicitly enable it—first in WISEadmin, then in the SIS.

Integration Workflow

The Wisconsin Department of Public Instruction (DPI) facilitates this integration using the WISEdata API, allowing SIS users to:

Retrieve immunization data on demand for an individual student (bulk retrieval is not supported).
Ingest the returned data directly into the SIS.

SIS vendors will initiate a GET request to the WISEdata API using the student’s WISEid. The response will return the student’s immunization status.

The Department of Health Services (DHS) is responsible for the student matching process.

How the Integration Works

DPI facilitates this connection between SIS vendors and WIR using the WISEdata API. This allows SIS users to:

Retrieve immunization data on demand for an individual student (bulk retrieval is not supported).
Ingest the returned data directly into the SIS.

SIS vendors will make a GET request via the WISEdata API using the student’s WISEid. The response will include the immunization status for that student.

The Department of Health Services (DHS) handles the student matching process.

When to Send a GET Request

SIS vendors should only send a GET request under the following conditions:

New students for whom the school has no immunization records.
Students who are non-compliant with immunization requirements based on their grade level, as determined by the SIS.
(See page 5 of the DHS guide: Immunization Requirements)
Students entering a grade where state immunization requirements change, and the SIS determines the student is not compliant.

For technical implementation details, refer to the to the WISEdata Ed-Fi Immunization Programmer’s Guide for more information: Programmer's Guide for Immunization Registry Integration

SIS vendors should only send a GET call when:
- New students for whom the school does not have any immunization information.
- Students when assessed by the SIS are not compliant per the student’s grade and required immunization. (see page #5 - https://www.dhs.wisconsin.gov/publications/p4/p44545.pdf)
- Students who are moving into a grade at which the State immunization requirements change and when assessed by the SIS the student is not compliant.

Vaccine List:

The latest vaccine list may be found in WIR [ FORMS > Data Exchange Specs > Vaccine Code List].

Updates to the Vaccine Code list are managed by DHS. If you would like to be added to the DHS data exchange communication that address vaccine code updates, scheduled system downtime, etc. -- submit a request via email to the WIR Help Desk (dhswirhelp@dhs.wisconsin.gov). Please include this information:

Vendor name
Name – e.g. John Smith
Email – e.g. john.smith@sisvendor.com
Phone # - 715-555-1212

Data Properties:

#	Property Name	Data Type	Public (Required/ Optional/ Conditional)	Choice (Required/ Optional/ Conditional)	Business Definition
1.0	statusCode	string	OPT	OPT	0=Reject (WiR found an error with the DPI request - contact DPI); 1=Success; 2=MultipleMatches (If there are multiple matches please make sure the students information match in both EdFi and WiR); 3=NotFound (If there are no matches please make sure the students information match in both EdFi and WiR)
2.0	statusMessage	string	OPT	OPT	The message corresponding to the status.
	data. ImmunizationsStudentHistory	array	OPT	OPT	This array includes patient identifier, student information, student demographics submitted to DHS, Immunization records from DHS ImmunizationStudentResponse patientIdentifier studentReference studentEducationOrganizationReference PharmacyTreatmentAdministrations
3.0	patientIdentifier	array	OPT	OPT	Components 1 (ID Number), 4 (Assigning Authority) and 5 (Identifier Type Code) are required in the PID-3 field. When a Provider Organization is sending to WIR, use the sending system’s Chart Number or other identifier if available. If a Provider Organization sends the client’s WIR ID (use “SR” as the identifier type code) in addition to a chart number, the WIR ID will be used to locate the client. ImmunizationsPatientIdentifier id (string) assigningAuthority (string) identifierTypeCode (string)
4.0	studentReference	array	OPT	OPT	studentUniqueid
5.0	studentEducationOrganizationReference	array	OPT	OPT	edfi_studentOrganizationAssociationReference studentUniqueid (string) educationOrganizationId (integer)
6.0	PharmacyTreatmentAdminitrations	array	OPT	OPT	ImmunizationPharmacyTreatmentAdministration AdministeredDate (string) AdministeredCode.ImmunizationEncodedElement Identifier (string): Sequence of characters (the code) that uniquely identifies the item being referenced Text (string): The descriptive or textual name of the identifier, e.g., DTaP. This is not used by the sending or receiving system, but rather facilitates human interpretation of the code. NameOfCodingSyste (string): Identifies the coding scheme being used in the identifier component. The combination of the identifier and name of coding system components will be a unique code for a data item. Each system has a unique identifier. AlternateIdentifier (string): An alternate sequence of characters (the code) that uniquely identifies the item being referenced. See usage note in section introduction AlternateText (string): The descriptive or textual name of the alternate identifier, e.g., DTaP. This is not used by the sending or receiving system, but rather facilitates human interpretation of the code. AlternateNameOfCodingSystem (string): Identifies the coding scheme being used in the alternate identifier component. Waiver (string): The student's reason for not getting the treatment.

Use Cases:

#	Use Case Title	Use Case Description	What to Submit/retrieve

#	Use Case Title	Use Case Description	What to Submit/retrieve
1.0	Search for a student who has a primary enrollment in the LEA requesting Immunization record, and an exact match in WIR.	Via API submit a student a primary enrollment and demographics records (SSA and SEOA) for WISEid [2488013423]	Successfully submits student enrollment and demographic records Last name: ADJTESTB First name: BERTRAND Middle name: B DOB:2/28/2012 Gender: M Local Person ID: 2345 Note: SIS vendors should restrict users from editing immunization data (that comes from WIR through the Immunization endpoint) after it's pulled from the API into the SIS. This is because when SIS compare against API for updates or deletes, the records edited by SIS users will not match with WIR and it could be treated as update which is incorrect.
1.1		Via API submit a GET request on /immunizations for WISEid [2488013423] that has an SSA from in the requesting LEA.	All immunization data associated with the WISEid are returned Status Code: 1 (=Success) Data: Patient Identifier, Assigning Authority: e.g. WIA, Identifier Type Code: e.g. SR Student Reference: Student Unique ID: 2488013423 Student Education Organization AssociationReference: Education Organization ID, Student Unique ID: "2488013423, Pharmacy Treatment Administrations: Administered Date: 2014-12-12 Administered Code: Identifier: 141, Text: Influenza, Name of Coding System: CVX, Alternate Identifier: AFLURIA, Alternate Text": Influenza, Alternate Name of Coding System: WVTN. Administered Date: 2013-12-12 Administered Code: Identifier: e.g. 150, Text: e.g. Influenza Quadrivalent P-Free, Name of Coding System: e.g. CVX, Alternate Identifier: e.g. Fluzone Quadrivalent, P-Free, AlternateText: e.g. Influenza Quadrivalent P-Free, Alternate Name of CodingSystem: e.g. WVTN Administered Date: 2020-05-29, Administered Code: Identifier: 28, Text: DT-Peds, Name of Coding System: CVX, Alternate Identifier: DT, Alternate Text: DT-Peds, Alternate Name of Coding System: WVTN
2.0	Search for a student who has a non-primary (PPP or coursework) enrollment in the LEA requesting Immunization record, and an exact match in WIR.	Via API submit a student non-primary enrollment and demographics records (SSA and SEOA) for WISEid [6844685075]	Successfully submits student enrollment and demographic records Last name: PPP First name: Match DOB:6/1/2018 Gender: F Local Person ID: Imm-567
2.1		Via API submit a GET request for WISEid [6844685075] that has an SSA from in the requesting LEA.	All immunization data associated with the WISEid are returned, and statusCode: 1 (=Success) statusCode: 1, data: patientIdentifier: id: 3218534, assigningAuthority: WIA, identifierTypeCode: SR studentReference: studentUniqueId: 6844685075, studentEducationOrganizationAssociationReference: educationOrganizationId: , studentUniqueId: 6844685075, pharmacyTreatmentAdministrations: administeredDate: 2018-06-16, administeredCode: identifier: 02, text: Polio-Oral, nameOfCodingSystem: CVX, alternateIdentifier: ORIMUNE, alternateText: Polio-Oral, alternateNameOfCodingSystem: WVTN, waiver:
3.0	Search for a student who does NOT have an enrollment in the LEA requesting Immunization record, and an exact match in WIR.	Delete SSA amd SEOA for WISEid [2488013423]	Successfully delete student enrollment and demographic records
3.1		Via API submit a GET request with a single valid WISEid [2488013423], but SSA is held by a different LEA.	No immunization data is returned for the WISEid; and SIS should display a response that says: "The student does not exist or this ApiKey is not authorized for the student (no StudentSchoolAssociation for the student associated with LocalEduacationAgencyId(s)"
Student has multiple matches in WIR
4.0	Search for a student who has an enrollment in the LEA requesting Immunization record, but multiple matches found in WIR.	Via API submit a student a primary enrollment and demographics records (SSA and SEOA) for WISEid [6425857361]	Successfully submits student enrollment and demographic records Last name: Client First name: Multiple DOB:2/4/2011 Gender: M Local Person ID: 56789
4.1		Via API submit a GET request with a single valid WISEid [6425857361] that has an SSA from in the requesting LEA.	No immunization data is returned and statusCode: 2 (=MultipleMatches) SIS should display a response that says: "Multiple matches found in WIR. You need to log into WIR to see available matches"
Student has NO matches in WIR
5.0	Search for a student who has an enrollment in the LEA requesting Immunization record, but no match is in WIR.	Via API submit a student a primary enrollment and demographics records (SSA and SEOA) for WISEid [4750081734]	Successfully submits student enrollment and demographic records Last name: DPI First name: Nomatch DOB:2/4/2011 Gender: M Local Person ID: imm-9988
5.1		Via API submit a GET request with a single valid WISEid with an SSA from in the requesting LEA.	No immunization data is returned for the WISEid, and statusCode: 3 (=NotFound) SIS should display a response that says: "No matches found"
Single vs. Multi-Component Vaccines
6.0	Immunization user interface in SIS	Demo how SIS interface and how student's immunization information are displayed	Minimum required immunizations, which each student should have received since birth for the age or grade of the student, are displayed correctly, including vaccinations info and the date vaccine administered. Vendors may display all returned vaccinations not only the required ones.
7.0	Search for a student who has a single component vaccines	Via API submit a student a primary enrollment and demographics records (SSA and SEOA) for WISEid [2488013423]	Successfully submits student enrollment and demographic records Last name: ADJTESTB First name: BERTRAND Middle name: B DOB:2/28/2012 Gender: M Local Person ID: 2345
7,1		Via API submit a GET request with a single valid WISEid [2488013423]	Example response: "administeredDate": "2020-05-29T00:00:00Z", "administeredCode": { "identifier": "28", "text": "DT-Peds", "nameOfCodingSystem": "CVX", "alternateIdentifier": "DT", "alternateText": "DT-Peds", "alternateNameOfCodingSystem": "WVTN" If the immunization is NOT a multi-component vaccine, only one CVX code identifying the immunization will be returned . This a straightforward use case.
8.0	Search for a student who has vaccines that contain multiple components vaccines (combination vaccines) Combination Vaccines: Combination vaccines merge equivalent component vaccines into single products to prevent more than one disease or to protect against multiple strains of infectious agents causing the same disease.	Via API submit a student a primary enrollment and demographics records (SSA and SEOA) for WISEid [8145188149]	Successfully submits student enrollment and demographic records Last name: Test First name: Multicomp Middle name: N DOB: 2/10/2015 Gender: M Local Person ID: Imm-1234
8.1		Via API submit a GET request with a single valid WISEid [8145188149]	Example: "administeredDate": "2018-04-10", "administeredCode": { "identifier": "120", ---> 'CVX' from vaccine list "text": "DtaP-Hib-IPV", ----> 'Vaccine' from vaccine list, or whichever value returned from WIR "nameOfCodingSystem": "CVX", "alternateIdentifier": "Pentacel", ----> 'Trade Name' from vaccine list "alternateText": "DtaP-Hib-IPV", ----> 'Vaccine' from vaccine list "alternateNameOfCodingSystem": "WVTN" "waiver": "" When a combination vaccine covering more than one series is administered, vendors should handle as following: if SIS has combination vaccines code, then link the CVX code to the combination vaccine; if SIS does NOT have combination vaccines: a) use the 'Vaccine Group Code' from the Vaccine List to record each vaccine separately, e.g. use Vaccine Group 'DTaP' and 'Hib' when 'DTaP-Hib' is returned; or b) generate a report for end-user so they can manually review and enter combination vaccines appropriately.
9.0	Immunizations with unspecified formulation	Via API submit a student a primary enrollment and demographics records (SSA and SEOA) for WISEid [2488013423]	Successfully submits student enrollment and demographic records
9.1		Via API submit a GET request with a single valid WISEid [2488013423]	Example response: "administeredDate": "2014-05-29T00:00:00Z", "administeredCode": { "identifier": "17", "text": "Hib, unspecified formulation", "nameOfCodingSystem": "CVX", "alternateIdentifier": "90737", "alternateText": "Hib, unspecified formulation", "alternateNameOfCodingSystem": "C4"
Other Use Cases
10.0	Search for a student who has an enrollment in the LEA requesting Immunization record, an exact match in WIR, but WISEid is invalid	Via API submit a GET request with an invalid WISEid (invalid format, missing digits, etc.)	The SIS should display an appropriate response when the WISEid is invalid
11.0	SIS deduplication process and manual resolution	Via API submit a student a primary enrollment and demographics records (SSA and SEOA) for WISEid [8145188149]	Successfully submits student enrollment and demographic records
12.0	Vaccine record is already entered in the SIS. API response inculdes the same vaccine and same administered date	Via API submit a GET request with a single valid WISEid [8145188149]	SIS should identifies when records have previously been entered in SIS, and prevents overrides and redundant record creation.
13.0	Vaccine record is already entered in the SIS. API response includes the same vaccine but different administered date	Via API submit a GET request with a single valid WISEid [8145188149]	Example: pharmacyTreatmentAdministrations: administeredDate: "2017-02-10", administeredCode: identifier: "50", text: "DTaP-Hib", nameOfCodingSystem: "CVX", alternateIdentifier: "TriHIBit", alternateText: "DTaP-Hib", alternateNameOfCodingSystem: “WVTN"waiver: