ImmuCast 5.17.4 User Guide

Message Elements

The following are the elements included in the schema.

Request a Forecast

Each request for a forecast is embedded in a set of personDetails.

<xsd:complexType name="ForecastRequestType">
    <xsd:sequence>
      <xsd:element maxOccurs="unbounded" name="personDetails" type="PersonDetailsType" />
    </xsd:sequence>
</xsd:complexType>

Each personDetails elements has a set of data related to the patient for whom the forecast is being requested. As indicated by the XSD details below, dateOfBirth is a required field. Gender, a list of vaccinations, and a list of contraindications are all optional. A person ID is not required, but may be included to assist you with a matching response to a request if you are sending multiple requests within the same message.

<xsd:complexType name="PersonDetailsType">
  <xsd:annotation>
    <xsd:documentation>
      A person has a date of birth and possibly: gender, a list of vaccinations, and contraindications. Any information sent in the "forecast" part of a request for forecast is ignored.
    </xsd:documentation>
  </xsd:annotation>
  <xsd:sequence>
    <xsd:element default="DEFAULT" minOccurs="0" name="scheduleType" type="stc:ScheduleType"/>
    <xsd:element name="dateOfBirth" type="stc:DateYYYYMMDDType"/>
    <xsd:element minOccurs="0" name="gender" type="stc:GenderType"/>
    <xsd:element maxOccurs="unbounded" minOccurs="0" name="vaccination" type="VaccinationType"/>
    <xsd:element maxOccurs="unbounded" minOccurs="0" name="contraindication" type="ContraindicationType"/>
  </xsd:sequence>
  <xsd:attribute name="personId" type="stc:Len20StringType"/>
  <xsd:attribute name="fullForecast" type="xsd:string"/>
  <xsd:attribute name="evaluationDate" type="stc:DateYYYYMMDDType"/>
  <xsd:attribute name="serologyDate" type="stc:DateYYYYMMDDType"/>
  <xsd:attribute name="pretermInfant" type="xsd:string"/>
</xsd:complexType>

GenderType: The GenderType is defined as either M or F
personalIdType: The personalIdType is defined as a string with a length of 20 characters. It is not required
fullForecast: This can be Y or N, is not required, and allows you to indicate whether you want to receive the patient’s complete forecast, including the recommended dates for doses that the patient has already received
evaluationDate: The v1.3 attribute evaluationDate is an optional date which allows you to specify the date on which forecasting begins for the patient. The default value is the date of the forecast request
serologyDate: The date serology testing was performed for a perinatal HepB patient
pretermInfant: Indicates the child was born prematurely and weighs less than 2,000 grams for perinatal HepB

<xsd:complexType name="VaccinationType">
  <xsd:annotation>
    <xsd:documentation>
      Vaccination messages are ignored by the SAF on incoming vaccination lists. On responses, messages may be included if the vaccination was determined to have a warning or was invalid.
    </xsd:documentation>
  </xsd:annotation>
  <xsd:sequence>
    <xsd:element minOccurs="0" name="id" type="xsd:long"/>
    <xsd:element name="vaccCode" type="stc:VaccCodeStringType"/>
    <xsd:element name="vaccDate" type="stc:DateYYYYMMDDType"/>
    <xsd:element default="1.0" name="doseSize" type="xsd:decimal"/>
    <xsd:element maxOccurs="unbounded" minOccurs="0" name="message" type="stc:VaccMessageType"/>
    <xsd:element minOccurs="0" name="compromisedCode" type="xsd:string"/>
    <xsd:element minOccurs="0" name="booster" type="xsd:boolean"/>
    <xsd:element minOccurs="0" name="isTDAP" type="xsd:boolean"/>
  </xsd:sequence>
  <xsd:attribute name="codeType" type="stc:VaccineCodeType" use="required"/>
</xsd:complexType>

VaccinationType is used to describe the type of vaccination given. All of the elements, as well as the single attribute, are required, except for the message element. The message element is not used when sending the request. It is described in the section on the forecast response.

vaccCode: This should be 1-5 numeric characters
vaccDate: The date the vaccination was given
doseSize: The size of dose in decimal form. Of note, ImmuCast does not currently take dose size into consideration when forecasting. This is a feature planned for a future release
message: The message field is ignored by ImmuCast on incoming vaccination lists. On responses, the message contains additional information if the vaccination had a warning or was invalid
compromisedCode: Indicates that the dose was compromised because of vaccine recall or improper refrigeration. The compromisedCode can be specified for incoming vaccination lists, or may be indicated in the response
booster: The booster field is ignored by ImmuCast on incoming vaccination lists. On responses, the booster field indicates whether ImmuCast considers the dose to have been a booster dose
isTDAP: Indicates this dose satisfies the adolescent Tdap booster dose
codeType: The vaccine code type, either CPT or CVX. Refer to Vaccine Codes for a list of codes and descriptions

<xsd:complexType name="ContraindicationType">
  <xsd:sequence>
    <xsd:element name="vaccCode" type="stc:VaccCodeStringType"/>
  </xsd:sequence>
  <xsd:attribute name="codeType" type="stc:VaccineCodeType" use="required"/>
</xsd:complexType>

ContraindicationType is used to describe a contraindication. Both the element and attribute are required.

vaccCode: This should be 1-5 numeric characters
codeType: The vaccine code type, either CPT or CVX. Refer to Vaccine Codes for a list of codes and descriptions

Forecasted Results

<xsd:complexType name="ResponseDetailType">
  <xsd:annotation>
    <xsd:documentation>
    If there was any error in processing the person detail, the problem or description is embedded in the information element.
    </xsd:documentation>
  </xsd:annotation>
  <xsd:sequence>
    <xsd:element name="personDetails" type="PersonDetailsType"/>
    <xsd:element maxOccurs="unbounded" minOccurs="0" name="forecastDetails" type="ForecastDetailsType"/>
    <xsd:element minOccurs="0" name="information" type="xsd:string"/>
    <xsd:element minOccurs="0" name="releaseVersion" type="xsd:string"/>
  </xsd:sequence>
</xsd:complexType>

The forecast results include the updated personDetails. The personDetails element matches the information that was originally supplied when the forecast was requested, with the exception that individual vaccination elements may be updated with a message if the vaccination was invalid or if there was a warning about the vaccination.

<xsd:complexType name="VaccMessageType">
  <xsd:sequence>
    <xsd:element name="message" type="Len500StringType"/>
  </xsd:sequence>
  <xsd:attribute name="messageType" type="MessageTypes" use="required"/>
  <xsd:attribute name="familyCode" type="xsd:integer"/>
  <xsd:attribute name="doseNumber" type="xsd:integer"/>
  <xsd:attribute name="seriesComplete" type="xsd:string"/>
</xsd:complexType>

messages: Messages can have up to 500 characters describing the warnings/invalid reasons
messageType: This can be one or more, WARNING or INVALID-VACC. Messages are returned with a vaccine group name to distinguish what component of the vaccine (in a multi-family vaccine) the message applies to. Refer to Vaccination Warnings and Invalid Reason Descriptions for a complete list
familyCode: The familyCode is the family code of the vaccine
doseNumber: The dose number in the series which this dose satisfies
seriesComplete: Indicates this dose satisfies the completion of a primary series

<xsd:complexType name="ForecastDetailsType">
  <xsd:sequence>
    <xsd:element name="familyCode" type="xsd:string"/>
    <xsd:element name="doseNumber" type="xsd:int"/>
    <xsd:element name="maxAllowableDate" type="stc:DateYYYYMMDDType"/>
    <xsd:element name="minAllowableDate" type="stc:DateYYYYMMDDType"/>
    <xsd:element name="recommendedDate" type="stc:DateYYYYMMDDType"/>
    <xsd:element name="pastDueDate" type="stc:DateYYYYMMDDType"/>
    <xsd:element name="forecastCVXCode" type="xsd:int"/>
    <xsd:element name="doseCount" type="xsd:int"/>
    <xsd:element name="booster" type="xsd:boolean"/>
  </xsd:sequence>
</xsd:complexType>

The forecast is described as a set of ForecastDetailsType. Each of these is composed of the following elements:

familyCode: The forecasted vaccine family
doseNumber: The forecasted dose
maxAllowableDate: The maximum allowable date for this forecasted vaccination to be considered valid
minAllowableDate: The earliest allowable date for this forecasted vaccination to be considered valid
recommendedDate: The preferred date for giving this forecasted vaccination
pastDueDate: The date at which the patient is considered past due for receiving this forecasted vaccination
forecastCVXCode: The CVX code of the forecasted vaccine
doseCount: The total number of doses in the series
booster: Indicates whether or not the forecasted dose is considered a booster