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
BETAA New message is used to communicate a vaccine administration. Multiple vaccinations can be sent in a single message.
Fields
Meta
Meta.DataModel
String
ReliableRequiredVaccination
Meta.EventType
String
ReliableRequiredNew
Meta.EventDateTime
DateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.Test
Boolean
ReliableFlag as a test message
Meta.Source
String
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.ID
String
ReliableID of the source.
UUID
Meta.Source.Name
String
ReliableName of the source
Meta.Destinations[]
Array of Objects
ReliableList 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
ReliableID of the destination.
UUID
Meta.Destinations[].Name
String
ReliableName of the destination
Meta.Message
String
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.ID
Numeric
ReliableID of the message created in Redox
Meta.Transmission
String
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.ID
Numeric
ReliableID of the transmission created in Redox
Meta.FacilityCode
String
PossibleCode 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
ReliableList of IDs and ID types that identify the patient
Patient.Identifiers[].ID
String
ReliableRequiredID for the patient
Patient.Identifiers[].IDType
String
ReliableRequiredType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstName
String
ReliablePatient's first name
Patient.Demographics.MiddleName
String
PossiblePatient'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
ReliablePatient's last name
Patient.Demographics.DOB
String
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSN
String
ProbablePatient's social security number
Patient.Demographics.Sex
String
ReliableValueSetPatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Race
String
PossibleValueSetPatient's race
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsHispanic
Boolean
PossibleValueSetIndicates if the patient is of hispanic origin.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.MaritalStatus
String
PossibleValueSetPatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceased
Boolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTime
DateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.Home
String
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Office
String
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Mobile
String
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]
Array of Strings
ProbablePatient's email address(es)
Patient.Demographics.Language
String
PossibleValueSetPatient's primary spoken language
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Citizenship[]
Array of strings
PossibleValueSetPatient's nation(s) of citizenship
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Address
Object
ProbablePatient's home address
Patient.Demographics.Address.StreetAddress
String
ProbableStreet address
Patient.Demographics.Address.City
String
ProbableCity
Patient.Demographics.Address.State
String
ProbableState
Patient.Demographics.Address.ZIP
String
ProbableZIP
Patient.Demographics.Address.County
String
PossibleCounty
Patient.Demographics.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Notes[]
Array of strings
PossiblePatient-level notes
Patient.Consent.Status
String
PossibleAn indicator if the patient has provided consent.
Patient.Consent.EffectiveDate
String
PossibleThe date in which the consent is effective.
Patient.Consent.Notification
String
PossibleAn indication if the person has consented to communication for notifications.
Visit
Visit.VisitNumber
String
ReliableNumber 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
Visit.AccountNumber
String
PossibleAccount Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
Vaccinations
Vaccinations[]
Array of Objects
ReliableArray of vaccine administrations
Vaccinations[].DateTime
String
ReliableRequiredWhen the vaccine was administered, or if documenting a refusal, when the vaccination was refused.
ISO 8601 Format
Vaccinations[].Product
Object
ReliableVaccine that was administered
Vaccinations[].Product.Code
String
ReliableRequiredCode for the vaccine
Vaccinations[].Product.Codeset
String
ReliableCode set used to identify the vaccine.
CVX or other code set used to identify the product
Vaccinations[].Product.Description
String
ReliableDescription of the vaccine
Vaccinations[].Product.LotNumber
String
ProbableLot number of the vaccine
Vaccinations[].Product.ExpirationDate
String
ProbableExpiration date of the vaccine.
ISO 8601 Format
Vaccinations[].Product.Manufacturer
Object
ProbableOrganization that manufactured the vaccine
Vaccinations[].Product.Manufacturer.Code
String
ProbableCode for the manufacturer
Vaccinations[].Product.Manufacturer.Codeset
String
ProbableCode set used to identify the manufacturer.
MVX Codeset
Vaccinations[].Product.Manufacturer.Name
String
ProbableName of the manufacturer
Vaccinations[].Route
Object
ProbableRoute by which the vaccine was administered
Vaccinations[].Route.Code
String
ProbableCode for the route
Vaccinations[].Route.Codeset
String
ProbableCode set used to identify the route.
Medication Route FDA Value Set
Vaccinations[].Route.Name
String
ProbableName of the route
Vaccinations[].Site
Object
ProbableSite where the vaccine was administered
Vaccinations[].Site.Code
String
ProbableCode for the site
Vaccinations[].Site.Codeset
String
ProbableCode set used to identify the site
Vaccinations[].Site.Name
String
ProbableName of the site
Vaccinations[].Dose.Quantity
String
ProbableSize of the dose
Vaccinations[].Dose.Units
String
ProbableUnits of the dose.
UCUM Units of Measure
Vaccinations[].Order.ID
String
ProbableID of the order in your system
Vaccinations[].Order.EHRID
String
ProbableID of the order from the EHR, if the order originated in the EHR
Vaccinations[].Order.Provider.NPI
String
PossibleNPI of the ordering provider
Vaccinations[].Order.Provider.ID
String
PossibleID of the ordering provider.
This ID is often required for Inpatient Visits.
Vaccinations[].Order.Provider.IDType
String
PossibleID type of the ID for the ordering provider
Vaccinations[].Order.Provider.FirstName
String
PossibleFirst name of the ordering provider
Vaccinations[].Order.Provider.LastName
String
PossibleLast name of the ordering provider
Vaccinations[].Order.Provider.Credentials[]
Array of Strings
PossibleList of credentials for the ordering provider.
e.g. MD, PhD
Vaccinations[].Order.Provider.Address
Object
PossibleProvider's address
Vaccinations[].Order.Provider.Address.StreetAddress
String
PossibleStreet address
Vaccinations[].Order.Provider.Address.City
String
PossibleCity
Vaccinations[].Order.Provider.Address.State
String
PossibleState
Vaccinations[].Order.Provider.Address.ZIP
String
PossibleZIP
Vaccinations[].Order.Provider.Address.County
String
PossibleCounty
Vaccinations[].Order.Provider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Vaccinations[].Order.Provider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Vaccinations[].Order.Provider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Vaccinations[].Order.Provider.Location
Object
PossibleProvider's location
Vaccinations[].Order.Provider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Vaccinations[].Order.Provider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Vaccinations[].Order.Provider.Location.Department
String
PossibleDepartment
Vaccinations[].Order.Provider.Location.Room
String
PossibleRoom.
Example: 136
Vaccinations[].ClinicalInfo[]
Array of Objects
ProbableList of supplimentary information associated with the vaccination administration.
Vaccinations[].ClinicalInfo[].Code
String
ProbableCode for the information element
Vaccinations[].ClinicalInfo[].Codeset
String
ProbableCode set used to identify the information element.
LOINC is typically used.
Vaccinations[].ClinicalInfo[].Description
String
ProbableDescription of the information element
Vaccinations[].ClinicalInfo[].Value
String
ReliableValue of the information element
Vaccinations[].ClinicalInfo[].ValueType
String
ReliableValueSetValue of the information element
-
Additional values may be added by Redox in the future.
-
Vaccinations[].ClinicalInfo[].Units
String
PossibleUnits of the value
Vaccinations[].ClinicalInfo[].Notes[]
Array of Strings
PossibleNotes related to the information element.
Vaccinations[].Notes[]
Array of Strings
ProbableNotes on the vaccine administration, such as Vaccine Information Statement publication date
Vaccinations[].RefusalReason
String
ProbableReason the vaccination was refused
Vaccinations[].Provider.ID
String
ProbableID of the provider who administered the vaccine.
This ID is often required for Inpatient Visits.
Vaccinations[].Provider.IDType
String
ProbableID type of the ID for the provider who administered the vaccine
Vaccinations[].Provider.FirstName
String
PossibleFirst name of the provider who administered the vaccine
Vaccinations[].Provider.LastName
String
PossibleLast name of the provider who administered the vaccine
Vaccinations[].Provider.Credentials[]
Array of Strings
PossibleList of credentials for the provider who administered the vaccine.
e.g. MD, PhD
Vaccinations[].Provider.Address
Object
PossibleProvider's address
Vaccinations[].Provider.Address.StreetAddress
String
PossibleStreet address
Vaccinations[].Provider.Address.City
String
PossibleCity
Vaccinations[].Provider.Address.State
String
PossibleState
Vaccinations[].Provider.Address.ZIP
String
PossibleZIP
Vaccinations[].Provider.Address.County
String
PossibleCounty
Vaccinations[].Provider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Vaccinations[].Provider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Vaccinations[].Provider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Vaccinations[].Provider.Location
Object
PossibleProvider's location
Vaccinations[].Provider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Vaccinations[].Provider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Vaccinations[].Provider.Location.Department
String
PossibleDepartment
Vaccinations[].Provider.Location.Room
String
PossibleRoom.
Example: 136
Vaccinations[].Location
Object
ProbableLocation of the visit in which the vaccine was administered
Vaccinations[].Location.Type
String
ProbableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Vaccinations[].Location.Facility
String
ProbableFacility.
Example: Community Hospital
Vaccinations[].Location.Department
String
ProbableDepartment
Vaccinations[].Location.Room
String
ProbableRoom.
Example: 136
{
"Meta": {
"DataModel": "Vaccination",
"EventType": "New",
"EventDateTime": "2021-01-22T22:13:17.891Z",
"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": "White",
"IsHispanic": null,
"MaritalStatus": "Married",
"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": [],
"Consent": {
"Status": null,
"EffectiveDate": null,
"Notification": null
}
},
"Visit": {
"VisitNumber": "98765",
"AccountNumber": null
},
"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",
"Provider": {
"NPI": null,
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
}
},
"ClinicalInfo": [],
"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
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"Location": {
"Type": "Clinic",
"Facility": "Rolling Oaks Outpatient Center",
"Department": "Rolling Oaks Pediatrics",
"Room": null
}
}
]
}
PatientQuerylink
BETAThis query is used to find a patient's vaccinations based off of demographic data. If a single patient is not found, it will result in the demographics (no vaccinations) of potential matches. The format of the response is specified by the PatientQueryResponse event type.
Fields
Meta
Meta.DataModel
String
ReliableRequiredVaccination
Meta.EventType
String
ReliableRequiredPatientQuery
Meta.EventDateTime
DateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.Test
Boolean
ReliableFlag as a test message
Meta.Source
String
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.ID
String
ReliableID of the source.
UUID
Meta.Source.Name
String
ReliableName of the source
Meta.Destinations[]
Array of Objects
ReliableList 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
ReliableID of the destination.
UUID
Meta.Destinations[].Name
String
ReliableName of the destination
Meta.Message
String
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.ID
Numeric
ReliableID of the message created in Redox
Meta.Transmission
String
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.ID
Numeric
ReliableID of the transmission created in Redox
Meta.FacilityCode
String
PossibleCode 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
ReliableList of IDs and ID types that identify the patient
Patient.Identifiers[].ID
String
ReliableID for the patient
Patient.Identifiers[].IDType
String
ReliableType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstName
String
ReliablePatient's first name
Patient.Demographics.MiddleName
String
PossiblePatient'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
ReliablePatient's last name
Patient.Demographics.DOB
String
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSN
String
ProbablePatient's social security number
Patient.Demographics.Sex
String
ReliableValueSetPatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Race
String
PossibleValueSetPatient's race
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsHispanic
Boolean
PossibleValueSetIndicates if the patient is of hispanic origin.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.MaritalStatus
String
PossibleValueSetPatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceased
Boolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTime
DateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.Home
String
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Office
String
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Mobile
String
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]
Array of Strings
ProbablePatient's email address(es)
Patient.Demographics.Language
String
PossibleValueSetPatient's primary spoken language
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Citizenship[]
Array of strings
PossibleValueSetPatient's nation(s) of citizenship
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Address
Object
ProbablePatient's home address
Patient.Demographics.Address.StreetAddress
String
ProbableStreet address
Patient.Demographics.Address.City
String
ProbableCity
Patient.Demographics.Address.State
String
ProbableState
Patient.Demographics.Address.ZIP
String
ProbableZIP
Patient.Demographics.Address.County
String
PossibleCounty
Patient.Demographics.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Notes[]
Array of strings
PossiblePatient-level notes
{
"Meta": {
"DataModel": "Vaccination",
"EventType": "PatientQuery",
"EventDateTime": "2021-01-22T22:13:17.891Z",
"Test": true,
"Destinations": [
{
"ID": "0f4bd1d1-451d-4351-8cfd-b767d1b488d6",
"Name": "Vaccination Endpoint"
}
],
"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": "White",
"IsHispanic": null,
"MaritalStatus": "Married",
"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": []
}
}
This is the response to the Vaccination PatientQuery. If the queried system successfully matches one existing patient based on the fields provided, the query will return available demographics in the Patient object and vaccination fields in the Vaccinations object. If the queried system finds no patients or multiple matches, the Patient object will be empty and potential matches may be returned in the PotentialMatches array.
Fields
Meta
Meta.DataModel
String
ReliableRequiredVaccination
Meta.EventType
String
ReliableRequiredPatientQueryResponse
Meta.EventDateTime
DateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.Test
Boolean
ReliableFlag as a test message
Meta.Source
String
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.ID
String
ReliableID of the source.
UUID
Meta.Source.Name
String
ReliableName of the source
Meta.Destinations[]
Array of Objects
ReliableList 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
ReliableID of the destination.
UUID
Meta.Destinations[].Name
String
ReliableName of the destination
Meta.Message
String
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.ID
Numeric
ReliableID of the message created in Redox
Meta.Transmission
String
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.ID
Numeric
ReliableID of the transmission created in Redox
Meta.FacilityCode
String
PossibleCode 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
Object
PossibleIn the event a single patient is identified, their demographic information and vaccination history will be included here. PotentialMatches will be an empty array.
Patient.Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the patient
Patient.Identifiers[].ID
String
ReliableID for the patient
Patient.Identifiers[].IDType
String
ReliableType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstName
String
ReliablePatient's first name
Patient.Demographics.MiddleName
String
PossiblePatient'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
ReliablePatient's last name
Patient.Demographics.DOB
String
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSN
String
ProbablePatient's social security number
Patient.Demographics.Sex
String
ReliableValueSetPatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Race
String
PossibleValueSetPatient's race
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsHispanic
Boolean
PossibleValueSetIndicates if the patient is of hispanic origin.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.MaritalStatus
String
PossibleValueSetPatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceased
Boolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTime
DateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.Home
String
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Office
String
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Mobile
String
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]
Array of Strings
ProbablePatient's email address(es)
Patient.Demographics.Language
String
PossibleValueSetPatient's primary spoken language
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Citizenship[]
Array of strings
PossibleValueSetPatient's nation(s) of citizenship
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Address
Object
ProbablePatient's home address
Patient.Demographics.Address.StreetAddress
String
ProbableStreet address
Patient.Demographics.Address.City
String
ProbableCity
Patient.Demographics.Address.State
String
ProbableState
Patient.Demographics.Address.ZIP
String
ProbableZIP
Patient.Demographics.Address.County
String
PossibleCounty
Patient.Demographics.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Notes[]
Array of strings
PossiblePatient-level notes
Patient.Contacts[].FirstName
String
PossibleFirst name of the contact
Patient.Contacts[].MiddleName
String
PossibleMiddle name of the contact
Patient.Contacts[].LastName
String
PossibleLast name of the contact
Patient.Contacts[].Address
Object
PossibleAddress of the contact
Patient.Contacts[].Address.StreetAddress
String
PossibleStreet address
Patient.Contacts[].Address.City
String
PossibleCity
Patient.Contacts[].Address.State
String
PossibleState
Patient.Contacts[].Address.ZIP
String
PossibleZIP
Patient.Contacts[].Address.County
String
PossibleCounty
Patient.Contacts[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Contacts[].PhoneNumber.Home
String
PossibleHome phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].PhoneNumber.Office
String
PossibleOffice phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].PhoneNumber.Mobile
String
ProbableMobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].RelationToPatient
String
PossibleValueSetPersonal relationship to the patient
-
Additional values may be added by Redox in the future.
-
Patient.Contacts[].EmailAddresses[]
Array of string
PossibleEmail address(es) of the contact person
Patient.Contacts[].Roles[]
Array of strings
PossibleRole of this contact for the patient.
e.x. Employer, Emergency Contact
Patient.PCP
Object
ReliablePrimary Care Provider for the Patient
Patient.PCP.NPI
String
ReliableNPI of the PCP
Patient.PCP.ID
String
ReliableID of the PCP.
This ID is often required for Inpatient Visits.
Patient.PCP.IDType
String
ReliableID type of the ID for the PCP
Patient.PCP.FirstName
String
PossibleFirst name of the PCP
Patient.PCP.LastName
String
PossibleLast name of the PCP
Patient.PCP.Credentials[]
Array of Strings
PossibleList of credentials for the PCP.
e.g. MD, PhD
Patient.PCP.Address
Object
PossibleProvider's address
Patient.PCP.Address.StreetAddress
String
PossibleStreet address
Patient.PCP.Address.City
String
PossibleCity
Patient.PCP.Address.State
String
PossibleState
Patient.PCP.Address.ZIP
String
PossibleZIP
Patient.PCP.Address.County
String
PossibleCounty
Patient.PCP.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.PCP.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Patient.PCP.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.PCP.Location
Object
PossibleProvider's location
Patient.PCP.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Patient.PCP.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Patient.PCP.Location.Department
String
PossibleDepartment
Patient.PCP.Location.Room
String
PossibleRoom.
Example: 136
Patient.Vaccinations[]
Array of Objects
ReliableArray of vaccine administrations
Patient.Vaccinations[].DateTime
String
ReliableWhen the vaccine was administered, or if documenting a refusal, when the vaccination was refused.
ISO 8601 Format
Patient.Vaccinations[].Product
Object
ReliableVaccine that was administered
Patient.Vaccinations[].Product.Code
String
ReliableCode for the vaccine
Patient.Vaccinations[].Product.Codeset
String
ReliableCode set used to identify the vaccine.
CVX or other code set used to identify the product
Patient.Vaccinations[].Product.Description
String
ReliableDescription of the vaccine
Patient.Vaccinations[].Product.LotNumber
String
ProbableLot number of the vaccine
Patient.Vaccinations[].Product.ExpirationDate
String
ProbableExpiration date of the vaccine.
ISO 8601 Format
Patient.Vaccinations[].Product.Manufacturer
Object
ProbableOrganization that manufactured the vaccine
Patient.Vaccinations[].Product.Manufacturer.Code
String
ProbableCode for the manufacturer
Patient.Vaccinations[].Product.Manufacturer.Codeset
String
ProbableCode set used to identify the manufacturer.
MVX Codeset
Patient.Vaccinations[].Product.Manufacturer.Name
String
ProbableName of the manufacturer
Patient.Vaccinations[].Route
Object
ProbableRoute by which the vaccine was administered
Patient.Vaccinations[].Route.Code
String
ProbableCode for the route
Patient.Vaccinations[].Route.Codeset
String
ProbableCode set used to identify the route.
Medication Route FDA Value Set
Patient.Vaccinations[].Route.Name
String
ProbableName of the route
Patient.Vaccinations[].Site
Object
ProbableSite where the vaccine was administered
Patient.Vaccinations[].Site.Code
String
ProbableCode for the site
Patient.Vaccinations[].Site.Codeset
String
ProbableCode set used to identify the site
Patient.Vaccinations[].Site.Name
String
ProbableName of the site
Patient.Vaccinations[].Dose.Quantity
String
ProbableSize of the dose
Patient.Vaccinations[].Dose.Units
String
ProbableUnits of the dose.
UCUM Units of Measure
Patient.Vaccinations[].Order.ID
String
ProbableID of the order in your system
Patient.Vaccinations[].Order.EHRID
String
ProbableID of the order from the EHR, if the order originated in the EHR
Patient.Vaccinations[].Order.Provider.NPI
String
PossibleNPI of the ordering provider
Patient.Vaccinations[].Order.Provider.ID
String
PossibleID of the ordering provider.
This ID is often required for Inpatient Visits.
Patient.Vaccinations[].Order.Provider.IDType
String
PossibleID type of the ID for the ordering provider
Patient.Vaccinations[].Order.Provider.FirstName
String
PossibleFirst name of the ordering provider
Patient.Vaccinations[].Order.Provider.LastName
String
PossibleLast name of the ordering provider
Patient.Vaccinations[].Order.Provider.Credentials[]
Array of Strings
PossibleList of credentials for the ordering provider.
e.g. MD, PhD
Patient.Vaccinations[].Order.Provider.Address
Object
PossibleProvider's address
Patient.Vaccinations[].Order.Provider.Address.StreetAddress
String
PossibleStreet address
Patient.Vaccinations[].Order.Provider.Address.City
String
PossibleCity
Patient.Vaccinations[].Order.Provider.Address.State
String
PossibleState
Patient.Vaccinations[].Order.Provider.Address.ZIP
String
PossibleZIP
Patient.Vaccinations[].Order.Provider.Address.County
String
PossibleCounty
Patient.Vaccinations[].Order.Provider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Vaccinations[].Order.Provider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Patient.Vaccinations[].Order.Provider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Vaccinations[].Order.Provider.Location
Object
PossibleProvider's location
Patient.Vaccinations[].Order.Provider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Patient.Vaccinations[].Order.Provider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Patient.Vaccinations[].Order.Provider.Location.Department
String
PossibleDepartment
Patient.Vaccinations[].Order.Provider.Location.Room
String
PossibleRoom.
Example: 136
Patient.Vaccinations[].ClinicalInfo[]
Array of Objects
ProbableList of supplimentary information associated with the vaccination administration.
Patient.Vaccinations[].ClinicalInfo[].Code
String
ProbableCode for the information element
Patient.Vaccinations[].ClinicalInfo[].Codeset
String
ProbableCode set used to identify the information element.
LOINC is typically used.
Patient.Vaccinations[].ClinicalInfo[].Description
String
ProbableDescription of the information element
Patient.Vaccinations[].ClinicalInfo[].Value
String
ReliableValue of the information element
Patient.Vaccinations[].ClinicalInfo[].ValueType
String
ReliableValueSetValue of the information element
-
Additional values may be added by Redox in the future.
-
Patient.Vaccinations[].ClinicalInfo[].Units
String
PossibleUnits of the value
Patient.Vaccinations[].ClinicalInfo[].Notes[]
Array of Strings
PossibleNotes related to the information element.
Patient.Vaccinations[].Notes[]
Array of Strings
ProbableNotes on the vaccine administration, such as Vaccine Information Statement publication date
Patient.Vaccinations[].RefusalReason
String
ProbableReason the vaccination was refused
Patient.Vaccinations[].Provider.ID
String
ProbableID of the provider who administered the vaccine.
This ID is often required for Inpatient Visits.
Patient.Vaccinations[].Provider.IDType
String
ProbableID type of the ID for the provider who administered the vaccine
Patient.Vaccinations[].Provider.FirstName
String
PossibleFirst name of the provider who administered the vaccine
Patient.Vaccinations[].Provider.LastName
String
PossibleLast name of the provider who administered the vaccine
Patient.Vaccinations[].Provider.Credentials[]
Array of Strings
PossibleList of credentials for the provider who administered the vaccine.
e.g. MD, PhD
Patient.Vaccinations[].Provider.Address
Object
PossibleProvider's address
Patient.Vaccinations[].Provider.Address.StreetAddress
String
PossibleStreet address
Patient.Vaccinations[].Provider.Address.City
String
PossibleCity
Patient.Vaccinations[].Provider.Address.State
String
PossibleState
Patient.Vaccinations[].Provider.Address.ZIP
String
PossibleZIP
Patient.Vaccinations[].Provider.Address.County
String
PossibleCounty
Patient.Vaccinations[].Provider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Vaccinations[].Provider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Patient.Vaccinations[].Provider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Vaccinations[].Provider.Location
Object
PossibleProvider's location
Patient.Vaccinations[].Provider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Patient.Vaccinations[].Provider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Patient.Vaccinations[].Provider.Location.Department
String
PossibleDepartment
Patient.Vaccinations[].Provider.Location.Room
String
PossibleRoom.
Example: 136
Patient.Vaccinations[].Location
Object
ProbableLocation of the visit in which the vaccine was administered
Patient.Vaccinations[].Location.Type
String
ProbableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Patient.Vaccinations[].Location.Facility
String
ProbableFacility.
Example: Community Hospital
Patient.Vaccinations[].Location.Department
String
ProbableDepartment
Patient.Vaccinations[].Location.Room
String
ProbableRoom.
Example: 136
PotentialMatches
PotentialMatches[]
Array of Objects
PossibleIn 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.
PotentialMatches[].Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the patient
PotentialMatches[].Identifiers[].ID
String
ReliableID for the patient
PotentialMatches[].Identifiers[].IDType
String
ReliableType of ID.
E.g. MRN, EPI
PotentialMatches[].Demographics.FirstName
String
ReliablePatient's first name
PotentialMatches[].Demographics.MiddleName
String
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
PotentialMatches[].Demographics.LastName
String
ReliablePatient's last name
PotentialMatches[].Demographics.DOB
String
ReliablePatient's date of birth.
In ISO 8601 format
PotentialMatches[].Demographics.SSN
String
ProbablePatient's social security number
PotentialMatches[].Demographics.Sex
String
ReliableValueSetPatient's sex
-
Additional values may be added by Redox in the future.
-
PotentialMatches[].Demographics.Race
String
PossibleValueSetPatient's race
-
Additional values may be added by Redox in the future.
-
PotentialMatches[].Demographics.IsHispanic
Boolean
PossibleValueSetIndicates if the patient is of hispanic origin.
-
Additional values may be added by Redox in the future.
-
PotentialMatches[].Demographics.MaritalStatus
String
PossibleValueSetPatient's marital status
-
Additional values may be added by Redox in the future.
-
PotentialMatches[].Demographics.IsDeceased
Boolean
PossibleIndicates if the patient is deceased
PotentialMatches[].Demographics.DeathDateTime
DateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
PotentialMatches[].Demographics.PhoneNumber.Home
String
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
PotentialMatches[].Demographics.PhoneNumber.Office
String
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
PotentialMatches[].Demographics.PhoneNumber.Mobile
String
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
PotentialMatches[].Demographics.EmailAddresses[]
Array of Strings
ProbablePatient's email address(es)
PotentialMatches[].Demographics.Language
String
PossibleValueSetPatient's primary spoken language
-
Additional values may be added by Redox in the future.
-
PotentialMatches[].Demographics.Citizenship[]
Array of strings
PossibleValueSetPatient's nation(s) of citizenship
-
Additional values may be added by Redox in the future.
-
PotentialMatches[].Demographics.Address
Object
ProbablePatient's home address
PotentialMatches[].Demographics.Address.StreetAddress
String
ProbableStreet address
PotentialMatches[].Demographics.Address.City
String
ProbableCity
PotentialMatches[].Demographics.Address.State
String
ProbableState
PotentialMatches[].Demographics.Address.ZIP
String
ProbableZIP
PotentialMatches[].Demographics.Address.County
String
PossibleCounty
PotentialMatches[].Demographics.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
PotentialMatches[].Notes[]
Array of strings
PossiblePatient-level notes
PotentialMatches[].Contacts[].FirstName
String
PossibleFirst name of the contact
PotentialMatches[].Contacts[].MiddleName
String
PossibleMiddle name of the contact
PotentialMatches[].Contacts[].LastName
String
PossibleLast name of the contact
PotentialMatches[].Contacts[].Address
Object
PossibleAddress of the contact
PotentialMatches[].Contacts[].Address.StreetAddress
String
PossibleStreet address
PotentialMatches[].Contacts[].Address.City
String
PossibleCity
PotentialMatches[].Contacts[].Address.State
String
PossibleState
PotentialMatches[].Contacts[].Address.ZIP
String
PossibleZIP
PotentialMatches[].Contacts[].Address.County
String
PossibleCounty
PotentialMatches[].Contacts[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
PotentialMatches[].Contacts[].PhoneNumber.Home
String
PossibleHome phone number.
In E. 164 Format. (e.g. +16085551234)
PotentialMatches[].Contacts[].PhoneNumber.Office
String
PossibleOffice phone number.
In E. 164 Format. (e.g. +16085551234)
PotentialMatches[].Contacts[].PhoneNumber.Mobile
String
ProbableMobile phone number.
In E. 164 Format. (e.g. +16085551234)
PotentialMatches[].Contacts[].RelationToPatient
String
PossibleValueSetPersonal relationship to the patient
-
Additional values may be added by Redox in the future.
-
PotentialMatches[].Contacts[].EmailAddresses[]
Array of string
PossibleEmail address(es) of the contact person
PotentialMatches[].Contacts[].Roles[]
Array of strings
PossibleRole of this contact for the patient.
e.x. Employer, Emergency Contact
PotentialMatches[].PCP
Object
ReliablePrimary Care Provider for the potentially matching patient
PotentialMatches[].PCP.NPI
String
ReliableNPI of the PCP
PotentialMatches[].PCP.ID
String
ReliableID of the PCP.
This ID is often required for Inpatient Visits.
PotentialMatches[].PCP.IDType
String
ReliableID type of the ID for the PCP
PotentialMatches[].PCP.FirstName
String
PossibleFirst name of the PCP
PotentialMatches[].PCP.LastName
String
PossibleLast name of the PCP
PotentialMatches[].PCP.Credentials[]
Array of Strings
PossibleList of credentials for the PCP.
e.g. MD, PhD
PotentialMatches[].PCP.Address
Object
PossibleProvider's address
PotentialMatches[].PCP.Address.StreetAddress
String
PossibleStreet address
PotentialMatches[].PCP.Address.City
String
PossibleCity
PotentialMatches[].PCP.Address.State
String
PossibleState
PotentialMatches[].PCP.Address.ZIP
String
PossibleZIP
PotentialMatches[].PCP.Address.County
String
PossibleCounty
PotentialMatches[].PCP.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
PotentialMatches[].PCP.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
PotentialMatches[].PCP.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
PotentialMatches[].PCP.Location
Object
PossibleProvider's location
PotentialMatches[].PCP.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
PotentialMatches[].PCP.Location.Facility
String
PossibleFacility.
Example: Community Hospital
PotentialMatches[].PCP.Location.Department
String
PossibleDepartment
PotentialMatches[].PCP.Location.Room
String
PossibleRoom.
Example: 136
{
"Meta": {
"DataModel": "Vaccination",
"EventType": "PatientQueryResponse",
"EventDateTime": "2021-01-22T22:13:17.891Z",
"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": "White",
"IsHispanic": null,
"MaritalStatus": "Married",
"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": [],
"Contacts": [
{
"FirstName": "Barbara",
"MiddleName": null,
"LastName": "Bixby",
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
},
"PhoneNumber": {
"Home": "+18088675303",
"Office": "+17077543758",
"Mobile": "+19189368865"
},
"RelationToPatient": "Mother",
"EmailAddresses": [
"[email protected]"
],
"Roles": [
"Emergency Contact"
]
}
],
"PCP": {
"NPI": "4356789876",
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"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",
"Provider": {
"NPI": null,
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
}
},
"ClinicalInfo": [],
"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
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"Location": {
"Type": "Clinic",
"Facility": "Rolling Oaks Outpatient Center",
"Department": "Rolling Oaks Pediatrics",
"Room": null
}
}
]
},
"PotentialMatches": []
}