PHC Hub logo  PHC Hub Administrator User Guide (v. July 2018)

Master Client Index (MCI) Web Service Interface

To support an electronic interface between the immunization registry (such as VacTrAK) and the Master Client Index (MCI), MultiView, a web service is available at <context path>/soa/getPatientListingRequest/getPatientListing.wsdl. This web service allows user accounts with the PHC Hub Run Web Service Export permission to query the registry for all patient demographic updates that have occurred since the last time a query was made from that account. Optionally, a date can be passed to the web service causing the query to return all updates that have occurred since that date rather than since the last time a query was made.

MCI Patient Information Request

Patient information request parameters are:

  1. Date (optional; YYYYMMDD format)
  2. Username (user account created in VakTrAK)
  3. Password

MCI Patient Information Returned

The returned patient information consists of:

In addition to the patient information, a reply code may be returned if there is a problem processing the request. The possible reply codes are Invalid username or password and Internal error.

MCI Restrictions on Patient Data Returned

The MCI restrictions placed on returned patient data are as follows:

Patient Data Restrictions
Medicaid ID Maximum length of 16 characters.
SSN Maximum length of 11 and must be a valid SSN.
First, last, and middle names Maximum length of 48 characters.
Suffix Maximum length of 5 characters.
Birth date Returned in YYYYMMDD format.
Gender Must match one of the following codes: M, F, U, O
Mother's maiden name Maximum length of 48 characters.
Race Must match one of the following codes:
  • Multi-racial
  • Native Hawaiian or Other Pacific Islander
  • Other
  • Unknown
  • American Indian*
  • Alaskan Native*
  • Asian
  • Black or African American
  • White
  • Hispanic-Latino
*Separated for AK, but combined for all other states.
Inactive code Must match one of the following values: ACTIVE, REMOVED, MERGE
Addresses Consists of the following components:
  • Address line 1 - Maximum length of 45 characters.
  • Address line 2 - Maximum length of 45 characters.
  • City name - Maximum length of 30 characters.
  • State - Is a 2-character postal code.
  • Zip code - Must be between 5 and 10 characters and must consist of only numbers.

 


STC | One logo