Vaccination

Vaccination messages communicate details related to vaccine administrations, such as the specific product administered, the site and route of administration, and which provider administered the vaccine.

Newlink

A New message is used to communicate a vaccine administration. Multiple vaccinations can be sent in a single message.

Fields

  • Meta
    • Meta.DataModel

      String

      Reliable
      Required

      Data model. E.g. Scheduling, Results

    • Meta.EventType

      String

      Reliable
      Required

      Type of event. E.g. New, Update

    • Meta.Test

      Boolean

      Reliable

      Flag as a test message

    • Meta.Source

      String

      Reliable

      Where the message originated. Included in messages from Redox

    • Meta.Source.ID

      String

      Reliable

      ID of the source. UUID

    • Meta.Source.Name

      String

      Reliable

      Name of the source

    • Meta.Destinations[]

      Array of Objects

      Reliable

      List of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination. Required when sending data to Redox

    • Meta.Destinations[].ID

      String

      Reliable

      ID of the destination. UUID

    • Meta.Destinations[].Name

      String

      Reliable

      Name of the destination

    • Meta.Message

      String

      Reliable

      Record in Redox that corresponds to the communication sent from the source to Redox. Included in messages from Redox

    • Meta.Message.ID

      Numeric

      Reliable

      ID of the message created in Redox

    • Meta.Transmission

      String

      Reliable

      Record in Redox that corresponds to the communication sent from Redox to your destination. Included in messages from Redox

    • Meta.Transmission.ID

      Numeric

      Reliable

      ID of the transmission created in Redox

    • Meta.FacilityCode

      String

      Possible

      Code for the facility related to the message. Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.

  • Patient
    • Patient.Identifiers[]

      Array of Objects

      Reliable

      List of IDs and ID types that identify the patient

    • Patient.Identifiers[].ID

      String

      Reliable
      Required

      ID for the patient

    • Patient.Identifiers[].IDType

      String

      Reliable
      Required

      Type of ID. E.g. MRN, EPI

    • Patient.Demographics.FirstName

      String

      Reliable

      Patient's first name

    • Patient.Demographics.MiddleName

      String

      Possible

      Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.

    • Patient.Demographics.LastName

      String

      Reliable

      Patient's last name

    • Patient.Demographics.DOB

      String

      Reliable

      Patient's date of birth. In ISO 8601 format

    • Patient.Demographics.SSN

      String

      Probable

      Patient's social security number

    • Patient.Demographics.Sex

      String

      Reliable

      Patient's sex. One of the following: Female, Male, Unknown, Other

    • Patient.Demographics.IsHispanic

      Boolean

      Possible

      Indicates if the patient is of hispanic origin.

    • Patient.Demographics.MaritalStatus

      String

      Possible

      Patient's marital status. Supported Values

    • Patient.Demographics.IsDeceased

      Boolean

      Possible

      Indicates if the patient is deceased

    • Patient.Demographics.DeathDateTime

      DateTime

      Possible

      Date and Time the patient was proclaimed deceased. ISO 8601 Format

    • Patient.Demographics.PhoneNumber.Home

      String

      Probable

      Patient's home phone number. In E. 164 Format. (e.g. +16085551234)

    • Patient.Demographics.PhoneNumber.Office

      String

      Probable

      Patient's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Patient.Demographics.PhoneNumber.Mobile

      String

      Probable

      Patient's mobile phone number. In E. 164 Format. (e.g. +16085551234)

    • Patient.Demographics.EmailAddresses[]

      Array of Strings

      Probable

      Patient's email address(es)

    • Patient.Demographics.Language

      String

      Possible

      Patient's primary spoken language. In ISO 639-1 alpha values (e.g. 'en'). Supported Values

    • Patient.Demographics.Citizenship[]

      Array of strings

      Possible

      Patient's nation(s) of citizenship. *In ISO 3166 alpha 2 format (e.g. 'US'). Reference Table.

      Note: The valid set of citizenships is a smaller list than the list of IS0 3166 country codes, and should be limited to the 193 United Nations countries plus 6 states: ROC Taiwan, Macao (SAR China), Hong Kong (SAR China), Kosovo, Palestinian Territory and the Vatican.*

    • Patient.Demographics.Address

      Object

      Probable

      Patient's home address

    • Patient.Demographics.Address.StreetAddress

      String

      Probable

      Street address

    • Patient.Demographics.Address.City

      String

      Probable

      City

    • Patient.Demographics.Address.State

      String

      Probable

      State

    • Patient.Demographics.Address.ZIP

      String

      Probable

      ZIP

    • Patient.Demographics.Address.County

      String

      Possible

      County

    • Patient.Demographics.Address.Country

      String

      Possible

      Country

    • Patient.Notes[]

      Array of strings

      Possible

      Patient-level notes

  • Visit
    • Visit.VisitNumber

      String

      Reliable

      Number for the appointment or visit in which the vaccine was administered. Although not required, VisitNumber is highly recommended so that the vaccination can be associated with a specific encounter/visit

  • Vaccinations
    • Vaccinations[]

      Array of Objects

      Reliable

      Array of vaccine administrations

    • Vaccinations[].DateTime

      String

      Reliable
      Required

      When the vaccine was administered, or if documenting a refusal, when the vaccination was refused. ISO 8601 Format

    • Vaccinations[].Product

      Object

      Reliable

      Vaccine that was administered

    • Vaccinations[].Product.Code

      String

      Reliable
      Required

      Code for the vaccine

    • Vaccinations[].Product.Codeset

      String

      Reliable

      Code set used to identify the vaccine. CVX or other code set used to identify the product

    • Vaccinations[].Product.Description

      String

      Reliable

      Description of the vaccine

    • Vaccinations[].Product.LotNumber

      String

      Probable

      Lot number of the vaccine

    • Vaccinations[].Product.ExpirationDate

      String

      Probable

      Expiration date of the vaccine. ISO 8601 Format

    • Vaccinations[].Product.Manufacturer

      Object

      Probable

      Organization that manufactured the vaccine

    • Vaccinations[].Product.Manufacturer.Code

      String

      Probable

      Code for the manufacturer

    • Vaccinations[].Product.Manufacturer.Codeset

      String

      Probable

      Code set used to identify the manufacturer. MVX Codeset

    • Vaccinations[].Product.Manufacturer.Name

      String

      Probable

      Name of the manufacturer

    • Vaccinations[].Route

      Object

      Probable

      Route by which the vaccine was administered

    • Vaccinations[].Route.Code

      String

      Probable

      Code for the route

    • Vaccinations[].Route.Name

      String

      Probable

      Name of the route

    • Vaccinations[].Site

      Object

      Probable

      Site where the vaccine was administered

    • Vaccinations[].Site.Code

      String

      Probable

      Code for the site

    • Vaccinations[].Site.Codeset

      String

      Probable

      Code set used to identify the site

    • Vaccinations[].Site.Name

      String

      Probable

      Name of the site

    • Vaccinations[].Dose.Quantity

      String

      Probable

      Size of the dose

    • Vaccinations[].Order.ID

      String

      Probable

      ID of the order in your system

    • Vaccinations[].Order.EHRID

      String

      Probable

      ID of the order from the EHR, if the order originated in the EHR

    • Vaccinations[].Notes[]

      Array of Strings

      Probable

      Notes on the vaccine administration, such as Vaccine Information Statement publication date

    • Vaccinations[].RefusalReason

      String

      Probable

      Reason the vaccination was refused

    • Vaccinations[].Provider.ID

      String

      Probable

      ID of the provider who administered the vaccine. This ID is required for Inpatient Visits

    • Vaccinations[].Provider.IDType

      String

      Probable

      ID type of the ID for the provider who administered the vaccine

    • Vaccinations[].Provider.FirstName

      String

      Possible

      First name of the provider who administered the vaccine

    • Vaccinations[].Provider.LastName

      String

      Possible

      Last name of the provider who administered the vaccine

    • Vaccinations[].Provider.Credentials[]

      Array of Strings

      Possible

      List of credentials for the provider who administered the vaccine. e.g. MD, PhD

    • Vaccinations[].Provider.Address

      Object

      Possible

      Provider's address

    • Vaccinations[].Provider.Address.StreetAddress

      String

      Possible

      Street address

    • Vaccinations[].Provider.Address.City

      String

      Possible

      City

    • Vaccinations[].Provider.Address.State

      String

      Possible

      State

    • Vaccinations[].Provider.Address.ZIP

      String

      Possible

      ZIP

    • Vaccinations[].Provider.Address.County

      String

      Possible

      County

    • Vaccinations[].Provider.Address.Country

      String

      Possible

      Country

    • Vaccinations[].Provider.Location

      Object

      Possible

      Provider's location

    • Vaccinations[].Provider.Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Vaccinations[].Provider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Vaccinations[].Provider.Location.Department

      String

      Possible

      Department

    • Vaccinations[].Provider.Location.Room

      String

      Possible

      Room. Example: 136

    • Vaccinations[].Provider.PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Vaccinations[].Location

      Object

      Probable

      Location of the visit in which the vaccine was administered

    • Vaccinations[].Location.Type

      String

      Probable

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Vaccinations[].Location.Facility

      String

      Probable

      Facility. Example: Community Hospital

    • Vaccinations[].Location.Department

      String

      Probable

      Department

    • Vaccinations[].Location.Room

      String

      Probable

      Room. Example: 136

{
   "Meta": {
      "DataModel": "Vaccination",
      "EventType": "New",
      "EventDateTime": "2017-12-06T00:28:28.775Z",
      "Test": true,
      "Source": {
         "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
         "Name": "Redox Dev Tools"
      },
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "0000000001",
            "IDType": "MR"
         },
         {
            "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
            "IDType": "EHRID"
         },
         {
            "ID": "a1d4ee8aba494ca",
            "IDType": "NIST"
         }
      ],
      "Demographics": {
         "FirstName": "Timothy",
         "MiddleName": "Paul",
         "LastName": "Bixby",
         "DOB": "2008-01-06",
         "SSN": "101-01-0001",
         "Sex": "Male",
         "Race": "Asian",
         "IsHispanic": null,
         "MaritalStatus": "Single",
         "IsDeceased": null,
         "DeathDateTime": null,
         "PhoneNumber": {
            "Home": "+18088675301",
            "Office": null,
            "Mobile": null
         },
         "EmailAddresses": [],
         "Language": "en",
         "Citizenship": [],
         "Address": {
            "StreetAddress": "4762 Hickory Street",
            "City": "Monroe",
            "State": "WI",
            "ZIP": "53566",
            "County": "Green",
            "Country": "US"
         }
      },
      "Notes": []
   },
   "Visit": {
      "VisitNumber": "98765"
   },
   "Vaccinations": [
      {
         "DateTime": "2015-08-13T21:08:57.581Z",
         "Product": {
            "Code": "20",
            "Codeset": "CVX",
            "Description": null,
            "LotNumber": "123456789",
            "ExpirationDate": null,
            "Manufacturer": {
               "Code": null,
               "Codeset": null,
               "Name": null
            }
         },
         "Route": {
            "Code": "Intramuscular",
            "Codeset": null,
            "Name": null
         },
         "Site": {
            "Code": "Left arm",
            "Codeset": null,
            "Name": null
         },
         "Dose": {
            "Quantity": "0.5",
            "Units": null
         },
         "Order": {
            "ID": "123",
            "EHRID": "456"
         },
         "Notes": [
            "VIS date: May 17 2007"
         ],
         "RefusalReason": null,
         "Provider": {
            "ID": "4356789876",
            "IDType": "NPI",
            "FirstName": "Pat",
            "LastName": "Granite",
            "Credentials": [],
            "Address": {
               "StreetAddress": null,
               "City": null,
               "State": null,
               "ZIP": null,
               "County": null,
               "Country": null
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            },
            "PhoneNumber": {
               "Office": null
            }
         },
         "Location": {
            "Type": "Clinic",
            "Facility": "Rolling Oaks Outpatient Center",
            "Department": "Rolling Oaks Pediatrics",
            "Room": null
         }
      }
   ]
}