Home
API reference
Redox Data Models
Vaccination
Administration

Vaccination

This data model communicates details like specific immunization administered, the site and route of administration, and which provider administered it. These messages are useful if you want to know when a vaccination has been administered since the messages are typically triggered at the time of administration, not ordering.

This data model has event types that allow you to:

  • receive a notification about vaccine administrations; or
  • query for and receive a patient's vaccination details.

Administration

Receive a notification when a new vaccine administration is created or an existing administration is updated or canceled. Cancellations are usually due to an input error.

One message may contain multiple administrations for a patient.

Beta

Request Body Schema

  • Meta
    required, object
    • DataModel
      required, string
      Reliable

      Vaccination

    • EventType
      required, string
      Reliable

      Administration

    • EventDateTime
      string, null
      Reliable

      Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
      ISO 8601 Format

    • Test
      boolean, null
      Reliable

      Indicates whether the request is a test or not.

    • Source
      object

      Contains the information for the system initiating the message, including the source ID and name.
      Included in messages from Redox

      • ID
        string, null
        Reliable

        Identifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
        UUID

      • Name
        string, null
        Reliable

        Displays the name of the system initiating the message.

    • Destinations
      Array of object

      Contains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
      Required when sending data to Redox.

      • ID
        string, null
        Reliable

        Identifies the endpoint that the request is directed to.
        UUID

      • Name
        string, null
        Reliable

        Displays the name of the endpoint that the request is directed to.

    • Logs
      Array of object

      Contains the log identifier(s) for the request.

      • ID
        string, null
        Reliable

        Identifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
        UUID

      • AttemptID
        string, null
        Reliable

        Identifies the request log attempt value, which is useful when retries are possible.
        UUID

    • FacilityCode
      string, null
      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
    required, object
    • Identifiers
      required, Array of object

      List of IDs and ID types that identify the patient

      • ID
        required, string
        Reliable

        ID for the patient

      • IDType
        required, string
        Reliable

        Type of ID.
        E.g. MRN, EPI

    • Demographics
      object
      • FirstName
        string, null
        Reliable

        Patient's first name

      • MiddleName
        string, null
        Possible

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

      • LastName
        string, null
        Reliable

        Patient's last name

      • DOB
        string, null
        Reliable

        Patient's date of birth.
        In ISO 8601 format

      • SSN
        string, null
        Probable

        Patient's social security number

      • Sex
        string, null
        Reliable
        Value Set

        Patient's sex

      • Race
        string, null
        Possible
        Value Set

        Patient's race

      • IsHispanic
        boolean, null
        Possible
        Value Set

        Indicates if the patient is of hispanic origin.

      • Religion
        string, null
        Possible
        Value Set

        Patient's religious affiliation

      • MaritalStatus
        string, null
        Possible
        Value Set

        Patient's marital status

      • IsDeceased
        boolean, null
        Possible

        Indicates if the patient is deceased

      • DeathDateTime
        string, null
        Possible

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

      • PhoneNumber
        object
        • Home
          string, null
          Probable

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

        • Office
          string, null
          Probable

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

        • Mobile
          string, null
          Probable

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

      • EmailAddresses
        Array of string

        Patient's email address(es)

      • Language
        string, null
        Possible
        Value Set

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

      • Citizenship
        Array of string

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

      • Address
        object

        Patient's home address

        • StreetAddress
          string, null
          Probable

          Street address

        • City
          string, null
          Probable

          City

        • State
          string, null
          Probable

          State

        • ZIP
          string, null
          Probable

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

    • Notes
      Array of string

      Patient-level notes

    • Contacts
      Array of object
      • FirstName
        string, null
        Possible

        First name of the contact

      • MiddleName
        string, null
        Possible

        Middle name of the contact

      • LastName
        string, null
        Possible

        Last name of the contact

      • Address
        object

        Address of the contact

        • StreetAddress
          string, null
          Possible

          Street address

        • City
          string, null
          Possible

          City

        • State
          string, null
          Possible

          State

        • ZIP
          string, null
          Possible

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

      • PhoneNumber
        object
        • Home
          string, null
          Possible

          Home phone number.
          In E. 164 Format. (e.g. +16085551234)

        • Office
          string, null
          Possible

          Office phone number.
          In E. 164 Format. (e.g. +16085551234)

        • Mobile
          string, null
          Probable

          Mobile phone number.
          In E. 164 Format. (e.g. +16085551234)

      • RelationToPatient
        string, null
        Possible
        Value Set

        Personal relationship to the patient.
        e.x. Father, Spouse

      • EmailAddresses
        Array of string

        Email address(es) of the contact person

      • Roles
        Array of string

        Role of this contact for the patient.
        e.x. Employer, Emergency Contact

    • Consent
      object
      • Status
        string, null
        Possible

        An indicator if the patient has provided consent.

      • EffectiveDate
        string, null
        Possible

        The date in which the consent is effective.

      • Notification
        string, null
        Possible

        An indication if the person has consented to communication for notifications.

  • Vaccinations
    required, Array of object

    Array of vaccine administrations

    • DateTime
      required, string
      Reliable

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

    • Product
      required, object

      Vaccine that was administered

      • Code
        required, string
        Reliable

        Code for the vaccine

      • Codeset
        string, null
        Reliable

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

      • Description
        string, null
        Reliable

        Description of the vaccine

      • LotNumber
        string, null
        Probable

        Lot number of the vaccine

      • ExpirationDate
        string, null
        Probable

        Expiration date of the vaccine.
        ISO 8601 Format

      • Manufacturer
        object

        Organization that manufactured the vaccine

        • Code
          string, null
          Probable

          Code for the manufacturer

        • Codeset
          string, null
          Probable

          Code set used to identify the manufacturer.
          MVX Codeset

        • Name
          string, null
          Probable

          Name of the manufacturer

    • Action
      required, string
      Reliable
      Value Set

      Administrative action

    • Route
      object

      Route by which the vaccine was administered

      • Code
        string, null
        Probable

        Code for the route

      • Codeset
        string, null
        Probable

        Code set used to identify the route.
        Medication Route FDA Value Set

      • Name
        string, null
        Probable

        Name of the route

    • Site
      object

      Site where the vaccine was administered

      • Code
        string, null
        Probable

        Code for the site

      • Codeset
        string, null
        Probable

        Code set used to identify the site

      • Name
        string, null
        Probable

        Name of the site

    • Dose
      object
      • Quantity
        string, null
        Probable

        Size of the dose

      • Units
        string, null
        Probable

        Units of the dose.
        UCUM Units of Measure

    • Order
      object
      • ID
        string, null
        Probable

        ID of the order in your system

      • EHRID
        string, null
        Probable

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

      • Provider
        object
        • NPI
          string, null
          Possible

          NPI of the ordering provider

        • ID
          string, null
          Possible

          ID of the ordering provider.
          This ID is often required for Inpatient Visits.

        • IDType
          string, null
          Possible

          ID type of the ID for the ordering provider

        • FirstName
          string, null
          Possible

          First name of the ordering provider

        • LastName
          string, null
          Possible

          Last name of the ordering provider

        • Credentials
          Array of string

          List of credentials for the ordering provider.
          e.g. MD, PhD

        • Address
          object

          Provider's address

          • StreetAddress
            string, null
            Possible

            Street address

          • City
            string, null
            Possible

            City

          • State
            string, null
            Possible

            State

          • ZIP
            string, null
            Possible

            ZIP

          • County
            string, null
            Possible

            County

          • Country
            string, null
            Possible
            Value Set

            Country

        • EmailAddresses
          Array of string

          Provider's email address(es)

        • PhoneNumber
          object
          • Office
            string, null
            Possible

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

        • Location
          object

          Provider's location

          • Type
            string, null
            Possible

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

          • Facility
            string, null
            Possible

            Facility.
            Example: Community Hospital

          • FacilityIdentifiers
            Array of object

            List of IDs specific to this facility

            • ID
              string, null
              Possible

              An ID specific to this facility

            • IDType
              string, null
              Possible

              The source or system to which this ID pertains.
              Could be an OID or a human-readable name

          • Department
            string, null
            Possible

            Department

          • DepartmentIdentifiers
            Array of object

            List of IDs specific to this department

            • ID
              string, null
              Possible

              An ID specific to this department

            • IDType
              string, null
              Possible

              The source or system to which this ID pertains.
              Could be an OID or a human-readable name

          • Room
            string, null
            Possible

            Room.
            Example: 136

    • ClinicalInfo
      Array of object

      List of supplementary information associated with the vaccination administration.

      • Code
        string, null
        Probable

        Code for the information element

      • Codeset
        string, null
        Probable

        Code set used to identify the information element.
        LOINC is typically used.

      • Description
        string, null
        Probable

        Description of the information element

      • Value
        string, null
        Reliable

        Value of the information element

      • ValueType
        string, null
        Reliable
        Value Set

        Value of the information element

      • Units
        string, null
        Possible

        Units of the value

      • Notes
        Array of string

        Notes related to the information element.

      • CompletionDateTime
        string, null
        Possible

        Date and time the clinical info was composed into a report and released.
        ISO 8601 Format

      • RelatedGroupID
        string, null
        Possible

        ID to group separate Clinical Info components

    • Notes
      Array of string

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

    • RefusalReason
      string, null
      Probable

      Reason the vaccination was refused

    • Provider
      object
      • ID
        string, null
        Probable

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

      • IDType
        string, null
        Probable

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

      • FirstName
        string, null
        Possible

        First name of the provider who administered the vaccine

      • LastName
        string, null
        Possible

        Last name of the provider who administered the vaccine

      • Credentials
        Array of string

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

      • Address
        object

        Provider's address

        • StreetAddress
          string, null
          Possible

          Street address

        • City
          string, null
          Possible

          City

        • State
          string, null
          Possible

          State

        • ZIP
          string, null
          Possible

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

      • EmailAddresses
        Array of string

        Provider's email address(es)

      • PhoneNumber
        object
        • Office
          string, null
          Possible

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

      • Location
        object

        Provider's location

        • Type
          string, null
          Possible

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

        • Facility
          string, null
          Possible

          Facility.
          Example: Community Hospital

        • FacilityIdentifiers
          Array of object

          List of IDs specific to this facility

          • ID
            string, null
            Possible

            An ID specific to this facility

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Department
          string, null
          Possible

          Department

        • DepartmentIdentifiers
          Array of object

          List of IDs specific to this department

          • ID
            string, null
            Possible

            An ID specific to this department

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Room
          string, null
          Possible

          Room.
          Example: 136

    • Location
      object

      Location of the visit in which the vaccine was administered

      • Type
        string, null
        Probable

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

      • Facility
        string, null
        Probable

        Facility.
        Example: Community Hospital

      • FacilityIdentifiers
        Array of object

        List of IDs specific to this facility

        • ID
          string, null
          Probable

          An ID specific to this facility

        • IDType
          string, null
          Probable

          The source or system to which this ID pertains.
          Could be an OID or a human-readable name

      • Department
        string, null
        Probable

        Department

      • DepartmentIdentifiers
        Array of object

        List of IDs specific to this department

        • ID
          string, null
          Probable

          An ID specific to this department

        • IDType
          string, null
          Probable

          The source or system to which this ID pertains.
          Could be an OID or a human-readable name

      • Room
        string, null
        Probable

        Room.
        Example: 136

  • Visit
    object
    • VisitNumber
      string, null
      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

    • AccountNumber
      string, null
      Possible

      Account Number.
      An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.

Example
json
1
{
2
  "Meta": {
3
    "DataModel": "Vaccination",
4
    "EventType": "Administration",
5
    "EventDateTime": "2024-11-18T21:23:08.746Z",
6
    "Test": true,
7
    "Source": {
8
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
9
      "Name": "Redox Dev Tools"
10
    },
11
    "Destinations": [
12
      {
13
        "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
14
        "Name": "Redox EMR"
15
      }
16
    ],
17
    "Logs": [
18
      {
19
        "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
20
        "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
21
      }
22
    ],
23
    "FacilityCode": null
24
  },
25
  "Patient": {
26
    "Identifiers": [
27
      {
28
        "ID": "0000000001",
29
        "IDType": "MR"
30
      },
31
      {
32
        "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
33
        "IDType": "EHRID"
34
      },
35
      {
36
        "ID": "a1d4ee8aba494ca",
37
        "IDType": "NIST"
38
      }
39
    ],
40
    "Demographics": {
41
      "FirstName": "Timothy",
42
      "MiddleName": "Paul",
43
      "LastName": "Bixby",
44
      "DOB": "2008-01-06",
45
      "SSN": "101-01-0001",
46
      "Sex": "Male",
47
      "Race": "White",
48
      "IsHispanic": null,
49
      "Religion": null,
50
      "MaritalStatus": "Single",
51
      "IsDeceased": null,
52
      "DeathDateTime": null,
53
      "PhoneNumber": {
54
        "Home": "+18088675301",
55
        "Office": null,
56
        "Mobile": null
57
      },
58
      "EmailAddresses": [],
59
      "Language": "en",
60
      "Citizenship": [],
61
      "Address": {
62
        "StreetAddress": "4762 Hickory Street",
63
        "City": "Monroe",
64
        "State": "WI",
65
        "ZIP": "53566",
66
        "County": "Green",
67
        "Country": "US"
68
      }
69
    },
70
    "Notes": [],
71
    "Contacts": [
72
      {
73
        "FirstName": "Barbara",
74
        "MiddleName": null,
75
        "LastName": "Bixby",
76
        "Address": {
77
          "StreetAddress": "4762 Hickory Street",
78
          "City": "Monroe",
79
          "State": "WI",
80
          "ZIP": "53566",
81
          "County": "Green",
82
          "Country": "US"
83
        },
84
        "PhoneNumber": {
85
          "Home": "+18088675303",
86
          "Office": "+17077543758",
87
          "Mobile": "+19189368865"
88
        },
89
        "RelationToPatient": "Mother",
90
        "EmailAddresses": [
91
          "barb.bixby@test.net"
92
        ],
93
        "Roles": [
94
          "Emergency Contact"
95
        ]
96
      }
97
    ],
98
    "Consent": {
99
      "Status": null,
100
      "EffectiveDate": null,
101
      "Notification": null
102
    }
103
  },
104
  "Visit": {
105
    "VisitNumber": "98765",
106
    "AccountNumber": null
107
  },
108
  "Vaccinations": [
109
    {
110
      "DateTime": "2015-08-13T21:08:57.581Z",
111
      "Product": {
112
        "Code": "20",
113
        "Codeset": "CVX",
114
        "Description": null,
115
        "LotNumber": "123456789",
116
        "ExpirationDate": null,
117
        "Manufacturer": {
118
          "Code": null,
119
          "Codeset": null,
120
          "Name": null
121
        }
122
      },
123
      "Route": {
124
        "Code": "Intramuscular",
125
        "Codeset": null,
126
        "Name": null
127
      },
128
      "Site": {
129
        "Code": "Left arm",
130
        "Codeset": null,
131
        "Name": null
132
      },
133
      "Dose": {
134
        "Quantity": "0.5",
135
        "Units": null
136
      },
137
      "Order": {
138
        "ID": "123",
139
        "EHRID": "456",
140
        "Provider": {
141
          "NPI": null,
142
          "ID": null,
143
          "IDType": null,
144
          "FirstName": null,
145
          "LastName": null,
146
          "Credentials": [],
147
          "Address": {
148
            "StreetAddress": null,
149
            "City": null,
150
            "State": null,
151
            "ZIP": null,
152
            "County": null,
153
            "Country": null
154
          },
155
          "EmailAddresses": [],
156
          "PhoneNumber": {
157
            "Office": null
158
          },
159
          "Location": {
160
            "Type": null,
161
            "Facility": null,
162
            "FacilityIdentifiers": [],
163
            "Department": null,
164
            "DepartmentIdentifiers": [],
165
            "Room": null
166
          }
167
        }
168
      },
169
      "ClinicalInfo": [],
170
      "Notes": [
171
        "VIS date: May 17 2007"
172
      ],
173
      "RefusalReason": null,
174
      "Provider": {
175
        "ID": "4356789876",
176
        "IDType": "NPI",
177
        "FirstName": "Pat",
178
        "LastName": "Granite",
179
        "Credentials": [],
180
        "Address": {
181
          "StreetAddress": null,
182
          "City": null,
183
          "State": null,
184
          "ZIP": null,
185
          "County": null,
186
          "Country": null
187
        },
188
        "EmailAddresses": [],
189
        "PhoneNumber": {
190
          "Office": null
191
        },
192
        "Location": {
193
          "Type": null,
194
          "Facility": null,
195
          "FacilityIdentifiers": [],
196
          "Department": null,
197
          "DepartmentIdentifiers": [],
198
          "Room": null
199
        }
200
      },
201
      "Location": {
202
        "Type": "Clinic",
203
        "Facility": "Rolling Oaks Outpatient Center",
204
        "FacilityIdentifiers": [],
205
        "Department": "Rolling Oaks Pediatrics",
206
        "DepartmentIdentifiers": [],
207
        "Room": null
208
      },
209
      "Action": "New"
210
    }
211
  ]
212
}