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.
Receive a patient record with vaccination details based on the query parameters defined in Vaccination.PatientQuery.
If either no patients or multiple matches are found, the Patient and Vaccinations arrays are empty. Instead, the PotentialMatches array contains possible patient matches.
Request Body Schema
- Metarequired, object
- DataModelrequired, stringReliable
Vaccination
- EventTyperequired, stringReliable
PatientQueryResponse
- EventDateTimestring, nullReliable
Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format - Testboolean, nullReliable
Indicates whether the request is a test or not.
- Sourceobject
Contains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox- IDstring, nullReliable
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 - Namestring, nullReliable
Displays the name of the system initiating the message.
- DestinationsArray 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.- IDstring, nullReliable
Identifies the endpoint that the request is directed to.
UUID - Namestring, nullReliable
Displays the name of the endpoint that the request is directed to.
- LogsArray of object
Contains the log identifier(s) for the request.
- IDstring, nullReliable
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 - AttemptIDstring, nullReliable
Identifies the request log attempt value, which is useful when retries are possible.
UUID
- FacilityCodestring, nullPossible
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.
- Patientobject
In the event a single patient is identified, their demographic information and vaccination history will be included here. PotentialMatches will be an empty array.
- IdentifiersArray of object
List of IDs and ID types that identify the patient
- IDstring, nullReliable
ID for the patient
- IDTypestring, nullReliable
Type of ID.
E.g. MRN, EPI
- Demographicsobject
- FirstNamestring, nullReliable
Patient's first name
- MiddleNamestring, nullPossible
Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
- LastNamestring, nullReliable
Patient's last name
- DOBstring, nullReliable
Patient's date of birth.
In ISO 8601 format - SSNstring, nullProbable
Patient's social security number
- Sexstring, nullReliableValue Set
Patient's sex
- Racestring, nullPossibleValue Set
Patient's race
- IsHispanicboolean, nullPossibleValue Set
Indicates if the patient is of hispanic origin.
- Religionstring, nullPossibleValue Set
Patient's religious affiliation
- MaritalStatusstring, nullPossibleValue Set
Patient's marital status
- IsDeceasedboolean, nullPossible
Indicates if the patient is deceased
- DeathDateTimestring, nullPossible
Date and Time the patient was proclaimed deceased.
ISO 8601 Format - PhoneNumberobject
- Homestring, nullProbable
Patient's home phone number.
In E. 164 Format. (e.g. +16085551234) - Officestring, nullProbable
Patient's office phone number.
In E. 164 Format. (e.g. +16085551234) - Mobilestring, nullProbable
Patient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
- EmailAddressesArray of string
Patient's email address(es)
- Languagestring, nullPossibleValue Set
Patient's primary spoken language.
In ISO 639-1 alpha values (e.g. 'en'). Supported Values - CitizenshipArray of string
Patient's nation(s) of citizenship.
In ISO 3166 alpha 2 format (e.g. 'US'). - Addressobject
Patient's home address
- StreetAddressstring, nullProbable
Street address
- Citystring, nullProbable
City
- Statestring, nullProbable
State
- ZIPstring, nullProbable
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- NotesArray of string
Patient-level notes
- ContactsArray of object
- FirstNamestring, nullPossible
First name of the contact
- MiddleNamestring, nullPossible
Middle name of the contact
- LastNamestring, nullPossible
Last name of the contact
- Addressobject
Address of the contact
- StreetAddressstring, nullPossible
Street address
- Citystring, nullPossible
City
- Statestring, nullPossible
State
- ZIPstring, nullPossible
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- PhoneNumberobject
- Homestring, nullPossible
Home phone number.
In E. 164 Format. (e.g. +16085551234) - Officestring, nullPossible
Office phone number.
In E. 164 Format. (e.g. +16085551234) - Mobilestring, nullProbable
Mobile phone number.
In E. 164 Format. (e.g. +16085551234)
- RelationToPatientstring, nullPossibleValue Set
Personal relationship to the patient.
e.x. Father, Spouse - EmailAddressesArray of string
Email address(es) of the contact person
- RolesArray of string
Role of this contact for the patient.
e.x. Employer, Emergency Contact
- PCPobject
Primary Care Provider for the Patient
- NPIstring, nullReliable
NPI of the PCP
- IDstring, nullReliable
ID of the PCP.
This ID is often required for Inpatient Visits. - IDTypestring, nullReliable
ID type of the ID for the PCP
- FirstNamestring, nullPossible
First name of the PCP
- LastNamestring, nullPossible
Last name of the PCP
- CredentialsArray of string
List of credentials for the PCP.
e.g. MD, PhD - Addressobject
Provider's address
- StreetAddressstring, nullPossible
Street address
- Citystring, nullPossible
City
- Statestring, nullPossible
State
- ZIPstring, nullPossible
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- EmailAddressesArray of string
Provider's email address(es)
- PhoneNumberobject
- Officestring, nullPossible
Provider's office phone number.
In E. 164 Format. (e.g. +16085551234)
- Locationobject
Provider's location
- Typestring, nullPossible
Type of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone - Facilitystring, nullPossible
Facility.
Example: Community Hospital - FacilityIdentifiersArray of object
List of IDs specific to this facility
- IDstring, nullPossible
An ID specific to this facility
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Departmentstring, nullPossible
Department
- DepartmentIdentifiersArray of object
List of IDs specific to this department
- IDstring, nullPossible
An ID specific to this department
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Roomstring, nullPossible
Room.
Example: 136
- VaccinationsArray of object
Array of vaccine administrations
- DateTimestring, nullReliable
When the vaccine was administered, or if documenting a refusal, when the vaccination was refused.
ISO 8601 Format - Productobject
Vaccine that was administered
- Codestring, nullReliable
Code for the vaccine
- Codesetstring, nullReliable
Code set used to identify the vaccine.
CVX or other code set used to identify the product - Descriptionstring, nullReliable
Description of the vaccine
- LotNumberstring, nullProbable
Lot number of the vaccine
- ExpirationDatestring, nullProbable
Expiration date of the vaccine.
ISO 8601 Format - Manufacturerobject
Organization that manufactured the vaccine
- Codestring, nullProbable
Code for the manufacturer
- Codesetstring, nullProbable
Code set used to identify the manufacturer.
MVX Codeset - Namestring, nullProbable
Name of the manufacturer
- Routeobject
Route by which the vaccine was administered
- Codestring, nullProbable
Code for the route
- Codesetstring, nullProbable
Code set used to identify the route.
Medication Route FDA Value Set - Namestring, nullProbable
Name of the route
- Siteobject
Site where the vaccine was administered
- Codestring, nullProbable
Code for the site
- Codesetstring, nullProbable
Code set used to identify the site
- Namestring, nullProbable
Name of the site
- Doseobject
- Quantitystring, nullProbable
Size of the dose
- Unitsstring, nullProbable
Units of the dose.
UCUM Units of Measure
- Orderobject
- IDstring, nullProbable
ID of the order in your system
- EHRIDstring, nullProbable
ID of the order from the EHR, if the order originated in the EHR
- Providerobject
- NPIstring, nullPossible
NPI of the ordering provider
- IDstring, nullPossible
ID of the ordering provider.
This ID is often required for Inpatient Visits. - IDTypestring, nullPossible
ID type of the ID for the ordering provider
- FirstNamestring, nullPossible
First name of the ordering provider
- LastNamestring, nullPossible
Last name of the ordering provider
- CredentialsArray of string
List of credentials for the ordering provider.
e.g. MD, PhD - Addressobject
Provider's address
- StreetAddressstring, nullPossible
Street address
- Citystring, nullPossible
City
- Statestring, nullPossible
State
- ZIPstring, nullPossible
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- EmailAddressesArray of string
Provider's email address(es)
- PhoneNumberobject
- Officestring, nullPossible
Provider's office phone number.
In E. 164 Format. (e.g. +16085551234)
- Locationobject
Provider's location
- Typestring, nullPossible
Type of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone - Facilitystring, nullPossible
Facility.
Example: Community Hospital - FacilityIdentifiersArray of object
List of IDs specific to this facility
- IDstring, nullPossible
An ID specific to this facility
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Departmentstring, nullPossible
Department
- DepartmentIdentifiersArray of object
List of IDs specific to this department
- IDstring, nullPossible
An ID specific to this department
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Roomstring, nullPossible
Room.
Example: 136
- ClinicalInfoArray of object
List of supplementary information associated with the vaccination administration.
- Codestring, nullProbable
Code for the information element
- Codesetstring, nullProbable
Code set used to identify the information element.
LOINC is typically used. - Descriptionstring, nullProbable
Description of the information element
- Valuestring, nullReliable
Value of the information element
- ValueTypestring, nullReliableValue Set
Value of the information element
- Unitsstring, nullPossible
Units of the value
- NotesArray of string
Notes related to the information element.
- CompletionDateTimestring, nullPossible
Date and time the clinical info was composed into a report and released.
ISO 8601 Format ID to group separate Clinical Info components
- NotesArray of string
Notes on the vaccine administration, such as Vaccine Information Statement publication date
- RefusalReasonstring, nullProbable
Reason the vaccination was refused
- Providerobject
- IDstring, nullProbable
ID of the provider who administered the vaccine.
This ID is often required for Inpatient Visits. - IDTypestring, nullProbable
ID type of the ID for the provider who administered the vaccine
- FirstNamestring, nullPossible
First name of the provider who administered the vaccine
- LastNamestring, nullPossible
Last name of the provider who administered the vaccine
- CredentialsArray of string
List of credentials for the provider who administered the vaccine.
e.g. MD, PhD - Addressobject
Provider's address
- StreetAddressstring, nullPossible
Street address
- Citystring, nullPossible
City
- Statestring, nullPossible
State
- ZIPstring, nullPossible
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- EmailAddressesArray of string
Provider's email address(es)
- PhoneNumberobject
- Officestring, nullPossible
Provider's office phone number.
In E. 164 Format. (e.g. +16085551234)
- Locationobject
Provider's location
- Typestring, nullPossible
Type of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone - Facilitystring, nullPossible
Facility.
Example: Community Hospital - FacilityIdentifiersArray of object
List of IDs specific to this facility
- IDstring, nullPossible
An ID specific to this facility
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Departmentstring, nullPossible
Department
- DepartmentIdentifiersArray of object
List of IDs specific to this department
- IDstring, nullPossible
An ID specific to this department
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Roomstring, nullPossible
Room.
Example: 136
- Locationobject
Location of the visit in which the vaccine was administered
- Typestring, nullProbable
Type of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone - Facilitystring, nullProbable
Facility.
Example: Community Hospital - FacilityIdentifiersArray of object
List of IDs specific to this facility
- IDstring, nullProbable
An ID specific to this facility
- IDTypestring, nullProbable
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Departmentstring, nullProbable
Department
- DepartmentIdentifiersArray of object
List of IDs specific to this department
- IDstring, nullProbable
An ID specific to this department
- IDTypestring, nullProbable
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Roomstring, nullProbable
Room.
Example: 136
- PotentialMatchesArray of object
In the event a single patient is not identified, this array will contain the possible patient matches and their demographics. You can use these data to make a more specific query to obtain an exact patient match including vaccinations. Patient will be undefined.
- IdentifiersArray of object
List of IDs and ID types that identify the patient
- IDstring, nullReliable
ID for the patient
- IDTypestring, nullReliable
Type of ID.
E.g. MRN, EPI
- Demographicsobject
- FirstNamestring, nullReliable
Patient's first name
- MiddleNamestring, nullPossible
Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
- LastNamestring, nullReliable
Patient's last name
- DOBstring, nullReliable
Patient's date of birth.
In ISO 8601 format - SSNstring, nullProbable
Patient's social security number
- Sexstring, nullReliableValue Set
Patient's sex
- Racestring, nullPossibleValue Set
Patient's race
- IsHispanicboolean, nullPossibleValue Set
Indicates if the patient is of hispanic origin.
- Religionstring, nullPossibleValue Set
Patient's religious affiliation
- MaritalStatusstring, nullPossibleValue Set
Patient's marital status
- IsDeceasedboolean, nullPossible
Indicates if the patient is deceased
- DeathDateTimestring, nullPossible
Date and Time the patient was proclaimed deceased.
ISO 8601 Format - PhoneNumberobject
- Homestring, nullProbable
Patient's home phone number.
In E. 164 Format. (e.g. +16085551234) - Officestring, nullProbable
Patient's office phone number.
In E. 164 Format. (e.g. +16085551234) - Mobilestring, nullProbable
Patient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
- EmailAddressesArray of string
Patient's email address(es)
- Languagestring, nullPossibleValue Set
Patient's primary spoken language.
In ISO 639-1 alpha values (e.g. 'en'). Supported Values - CitizenshipArray of string
Patient's nation(s) of citizenship.
In ISO 3166 alpha 2 format (e.g. 'US'). - Addressobject
Patient's home address
- StreetAddressstring, nullProbable
Street address
- Citystring, nullProbable
City
- Statestring, nullProbable
State
- ZIPstring, nullProbable
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- NotesArray of string
Patient-level notes
- ContactsArray of object
- FirstNamestring, nullPossible
First name of the contact
- MiddleNamestring, nullPossible
Middle name of the contact
- LastNamestring, nullPossible
Last name of the contact
- Addressobject
Address of the contact
- StreetAddressstring, nullPossible
Street address
- Citystring, nullPossible
City
- Statestring, nullPossible
State
- ZIPstring, nullPossible
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- PhoneNumberobject
- Homestring, nullPossible
Home phone number.
In E. 164 Format. (e.g. +16085551234) - Officestring, nullPossible
Office phone number.
In E. 164 Format. (e.g. +16085551234) - Mobilestring, nullProbable
Mobile phone number.
In E. 164 Format. (e.g. +16085551234)
- RelationToPatientstring, nullPossibleValue Set
Personal relationship to the patient.
e.x. Father, Spouse - EmailAddressesArray of string
Email address(es) of the contact person
- RolesArray of string
Role of this contact for the patient.
e.x. Employer, Emergency Contact
- PCPobject
Primary Care Provider for the potentially matching patient
- NPIstring, nullReliable
NPI of the PCP
- IDstring, nullReliable
ID of the PCP.
This ID is often required for Inpatient Visits. - IDTypestring, nullReliable
ID type of the ID for the PCP
- FirstNamestring, nullPossible
First name of the PCP
- LastNamestring, nullPossible
Last name of the PCP
- CredentialsArray of string
List of credentials for the PCP.
e.g. MD, PhD - Addressobject
Provider's address
- StreetAddressstring, nullPossible
Street address
- Citystring, nullPossible
City
- Statestring, nullPossible
State
- ZIPstring, nullPossible
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- EmailAddressesArray of string
Provider's email address(es)
- PhoneNumberobject
- Officestring, nullPossible
Provider's office phone number.
In E. 164 Format. (e.g. +16085551234)
- Locationobject
Provider's location
- Typestring, nullPossible
Type of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone - Facilitystring, nullPossible
Facility.
Example: Community Hospital - FacilityIdentifiersArray of object
List of IDs specific to this facility
- IDstring, nullPossible
An ID specific to this facility
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Departmentstring, nullPossible
Department
- DepartmentIdentifiersArray of object
List of IDs specific to this department
- IDstring, nullPossible
An ID specific to this department
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Roomstring, nullPossible
Room.
Example: 136