Programmer's Guide for Immunization Registry Integration

Preface:

Wisconsin schools and districts need access to student immunization records. These Immunization records are stored in the Wisconsin DHS HL7 system called Wisconsin Immunization Registry (WIR). Wisconsin DPI extended the EdFi API with an endpoint called immunizations which will act as a passthrough to the WiR (similar to identity works as a passthrough to the WISEid system).

District SIS → Wisconsin DPI EdFi API → Wisconsin DHS HL7 WiR

Wisconsin DPI is the first to implement the immunization domain. The endpoints will be RESTful and a subset of functionality compared to similar domains (ex. Identity pass-thru to WISEid had an async paradigm).

The student immunization currently only supports getting a student's immunization history synchronously to keep development simple and agile. If vendors identify the need for an asynchronous pattern - a similar pattern to identity will need to be implemented. In the same vein, (simple and agile) the student immunization will only support getting one student at a time, which is consistent with Wisconsin DPI Ed-Fi implementation primarily using the transactional paradigm, as opposed to bulk. Additionally, WiR doesn’t support bulk which would make it less feasible. Finally, I believe most district use cases will be on a per-student basis.

A final note about the immunization domain is the immunization history is unfiltered. In other words, the entire student immunization history will be returned with a get. The vendor software should filter the immunization history if that is a requirement by the district or vendor.

GET

REQUEST

NOTES
- The immunizations student endpoint takes a studentUniqueId (WISEid) as a parameter. The EdFi API will grab the related student information (name, birthdate, gender, address) and make a HL7 request message to WiR for the student immunization history. The EdFi API maps the HL7 response from the WiR into the JSON response below.
URL: https://apps.dpi.wi.gov/EdFiWebApi/Immunizations/v1/2021/immunizations/students/{uniqueId}
HTTP METHOD: GET

RESPONSE

EXAMPLE

REQUEST

URL: https://apps.dpi.wi.gov/EdFiWebApi/Immunizations/v1/2021/immunizations/students/1001052923

RESPONSE

{
  "statusCode": 1,
  "data": {
    "patientIdentifier": {
      "id": "2851486",
      "assigningAuthority": "WIA",
      "identifierTypeCode": "SR",
      "name": {
        "firstName": "BERTRAND",
        "middleName": "B",
        "lastSurname": "ADJTESTB",
        "generationCodeSuffix": "",
        "prefix": ""
      },
      "mothersMaidenName": {
        "firstName": "BETTY",
        "lastSurname": "BOYLE"
      },
      "birthDate": "2012-02-28T00:00:00Z",
      "sex": "M",
      "race": "",
      "address": {
        "street": "1131 N Sherman Ave",
        "other": "",
        "city": "MADISON",
        "state": "WI",
        "zip": "53704",
        "country": ""
      },
      "multipleBirthIndicator": false,
      "birthOrder": "",
      "extendedTelephoneNumber": {}
    },
    "studentReference": {
      "studentUniqueId": "1003734049",
      "link": {
        "rel": "Student",
        "href": "/ed-fi/students/dc3e2aebe76844b180691204f1e1d1e4"
      }
    },
    "studentEducationOrganizationAssociationReference": {
      "educationOrganizationId": 7525,
      "studentUniqueId": "1003734049",
      "link": {
        "rel": "StudentEducationOrganizationAssociation",
        "href": "/ed-fi/studentEducationOrganizationAssociations/c7064da436ed4357bfcd87c33ef7a083"
      }
    },
    "pharmacyTreatmentAdministrations": [
      {
        "administeredDate": "2020-05-29",
        "administeredCode": {
          "identifier": "28",
          "text": "DT-Peds",
          "nameOfCodingSystem": "CVX",
          "alternateIdentifier": "DT",
          "alternateText": "DT-Peds",
          "alternateNameOfCodingSystem": "WVTN"
        },
        "waiver": ""
      },
      {
        "administeredDate": "2020-05-29",
        "administeredCode": {
          "identifier": "02",
          "text": "Polio-Oral",
          "nameOfCodingSystem": "CVX",
          "alternateIdentifier": "ORIMUNE",
          "alternateText": "Polio-Oral",
          "alternateNameOfCodingSystem": "WVTN"
        },
        "waiver": ""
      },
      {
        "administeredDate": "2020-05-29",
        "administeredCode": {
          "identifier": "45",
          "text": "Hep B, unspecified formulation",
          "nameOfCodingSystem": "CVX",
          "alternateIdentifier": "90731",
          "alternateText": "Hep B, unspecified formulation",
          "alternateNameOfCodingSystem": "C4"
        },
        "waiver": ""
      },
      {
        "administeredDate": "2020-05-29",
        "administeredCode": {
          "identifier": "03",
          "text": "MMR",
          "nameOfCodingSystem": "CVX",
          "alternateIdentifier": "MMR II",
          "alternateText": "MMR",
          "alternateNameOfCodingSystem": "WVTN"
        },
        "waiver": ""
      },
      {
        "administeredDate": "2014-12-19",
        "administeredCode": {
          "identifier": "141",
          "text": "Influenza",
          "nameOfCodingSystem": "CVX",
          "alternateIdentifier": "AFLURIA",
          "alternateText": "Influenza",
          "alternateNameOfCodingSystem": "WVTN"
        },
        "waiver": ""
      },
      {
        "administeredDate": "2014-12-19",
        "administeredCode": {
          "identifier": "141",
          "text": "Influenza",
          "nameOfCodingSystem": "CVX",
          "alternateIdentifier": "AFLURIA",
          "alternateText": "Influenza",
          "alternateNameOfCodingSystem": "WVTN"
        },
        "waiver": ""
      },
      {
        "administeredDate": "2014-12-19",
        "administeredCode": {
          "identifier": "904",
          "text": "Adjuvant, unspecified formulation",
          "nameOfCodingSystem": "CVX",
          "alternateIdentifier": "Adjuvant",
          "alternateText": "Adjuvant",
          "alternateNameOfCodingSystem": "WVGC"
        },
        "waiver": ""
      },
      {
        "administeredDate": "2014-12-12",
        "administeredCode": {
          "identifier": "141",
          "text": "Influenza",
          "nameOfCodingSystem": "CVX",
          "alternateIdentifier": "AFLURIA",
          "alternateText": "Influenza",
          "alternateNameOfCodingSystem": "WVTN"
        },
        "waiver": ""
      },
      {
        "administeredDate": "2014-12-12",
        "administeredCode": {
          "identifier": "94",
          "text": "MMRV",
          "nameOfCodingSystem": "CVX",
          "alternateIdentifier": "Proquad",
          "alternateText": "MMRV",
          "alternateNameOfCodingSystem": "WVTN"
        },
        "waiver": ""
      },
      {
        "administeredDate": "2014-11-12",
        "administeredCode": {
          "identifier": "21",
          "text": "Varicella",
          "nameOfCodingSystem": "CVX",
          "alternateIdentifier": "Varivax",
          "alternateText": "Varicella",
          "alternateNameOfCodingSystem": "WVTN"
        },
        "waiver": ""
      },
      {
        "administeredDate": "2013-12-19",
        "administeredCode": {
          "identifier": "141",
          "text": "Influenza",
          "nameOfCodingSystem": "CVX",
          "alternateIdentifier": "AFLURIA",
          "alternateText": "Influenza",
          "alternateNameOfCodingSystem": "WVTN"
        },
        "waiver": ""
      },
      {
        "administeredDate": "2013-12-12",
        "administeredCode": {
          "identifier": "150",
          "text": "Influenza Quadrivalent P-Free",
          "nameOfCodingSystem": "CVX",
          "alternateIdentifier": "Fluzone Quadrivalent, P-Free",
          "alternateText": "Influenza Quadrivalent P-Free",
          "alternateNameOfCodingSystem": "WVTN"
        },
        "waiver": ""
      }
    ]
  }
}