PatientAdmin
PatientAdmin messages are used for many things. They are based off the ADT (Admission/Discharge/Transfer) feed at a health system, but they are used for more than just patient tracking. Registration information is one of the main components of PatientAdmin messages, which contain demographics, guarantor and insurance information. It is the most used real time feed in most health systems.
An Arrival message is generated when a patient shows up for their visit or when a patient is admitted to the hospital.
Fields
Meta
Meta.DataModel
String
ReliableRequiredPatientAdmin
Meta.EventType
String
ReliableRequiredArrival
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.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.Diagnoses[]
Array of Objects
ProbableList of diagnoses associated with this visit
Patient.Diagnoses[].Code
String
ProbableCode for the diagnosis
Patient.Diagnoses[].Codeset
String
ProbableValueSetCode set used to identify the diagnosis
-
Additional values may be added by Redox in the future.
-
Patient.Diagnoses[].Name
String
ProbableName of the diagnosis
Patient.Diagnoses[].Type
String
PossibleValueSetType of the diagnosis
-
Additional values may be added by Redox in the future.
-
Patient.Diagnoses[].DocumentedDateTime
String
PossibleDateTime the diagnosis was documented.
ISO 8601 Format
Patient.Allergies[]
Array of Objects
PossibleList of a patient's allergies
Patient.Allergies[].Code
String
PossibleCode for the allergy
Patient.Allergies[].Codeset
String
PossibleCode set used to identify the allergy.
Typically RxNorm or SNOMED
Patient.Allergies[].Name
String
PossibleName of the allergy
Patient.Allergies[].Type
Object
PossibleThe type of allergy intolerance (food, drug, etc.)
Patient.Allergies[].Type.Code
String
PossibleCode for the allergy intolerance type
Patient.Allergies[].Type.Codeset
String
PossibleCode set used to identify the allergy intolerance type
Patient.Allergies[].Type.Name
String
PossibleName of the allergy intolerance type
Patient.Allergies[].OnsetDateTime
String
PossibleDateTime the allergy was identified
Patient.Allergies[].Reaction[]
Array of Objects
PossibleThe list of reactions caused by this particular allergy.
Patient.Allergies[].Reaction[].Code
String
PossibleCode for the reaction
Patient.Allergies[].Reaction[].Codeset
String
PossibleCode set used to identify the reaction
Patient.Allergies[].Reaction[].Name
String
PossibleName of the reaction
Patient.Allergies[].Severity
Object
PossibleThe severity of the reaction (moderate, severe, etc.).
Patient.Allergies[].Severity.Code
String
PossibleCode for the reaction severity
Patient.Allergies[].Severity.Codeset
String
PossibleCode set used to identify the reaction severity
Patient.Allergies[].Severity.Name
String
PossibleName of the reaction severity
Patient.Allergies[].Status
string
PossibleThe current status of the allergy.
One of the following: "Active", "Inactive", "Resolved".
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
Visit
Visit.VisitNumber
String
ReliableVisit Number.
Unique ID of a single visit
Visit.AccountNumber
String
PossibleAccount Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
Visit.PatientClass
String
ReliablePatient class is used in many EHRs to determine where to put the patient.
Examples: Inpatient, Outpatient, Emergency
Visit.VisitDateTime
String
ReliableDateTime of visit or the arrival time of the admission.
ISO 8601 Format
Visit.Duration
Numeric
ProbableLength of visit.
In minutes
Visit.Reason
String
ProbableReason for visit
Visit.Instructions[]
Array of Strings
ProbableAppointment instructions
Visit.Balance
Numeric
PossiblePatient balance due for this visit.
This field depends on whether or not the sending system has billing functionality, and whether they calculate this field.
Visit.DiagnosisRelatedGroup
Numeric
PossibleDiagnosis Related Group for this visit
Visit.DiagnosisRelatedGroupType
Numeric
PossibleType or System of Diagnosis Related Group for this visit.
Examples include Medicare (CMS-DRG), Refined (R-D DRG), All Patient (AP-DRG), etc
Visit.AttendingProvider
Object
ReliableThe provider primarily responsible for a patient's care during a visit
Visit.AttendingProvider.ID
String
ProbableID of the attending provider.
This ID is often required for Inpatient Visits.
Visit.AttendingProvider.IDType
String
ProbableID type of the ID for the attending provider
Visit.AttendingProvider.FirstName
String
PossibleFirst name of the attending provider
Visit.AttendingProvider.LastName
String
PossibleLast name of the attending provider
Visit.AttendingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the attending provider.
e.g. MD, PhD
Visit.AttendingProvider.Address
Object
PossibleProvider's address
Visit.AttendingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.AttendingProvider.Address.City
String
PossibleCity
Visit.AttendingProvider.Address.State
String
PossibleState
Visit.AttendingProvider.Address.ZIP
String
PossibleZIP
Visit.AttendingProvider.Address.County
String
PossibleCounty
Visit.AttendingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AttendingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AttendingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AttendingProvider.Location
Object
PossibleProvider's location
Visit.AttendingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AttendingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AttendingProvider.Location.Department
String
PossibleDepartment
Visit.AttendingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ConsultingProvider
Object
ReliableA provider, usually a specialist, that evaluates or treats a patient to address a specific problem
Visit.ConsultingProvider.ID
String
PossibleID of the consulting provider.
This ID is often required for Inpatient Visits.
Visit.ConsultingProvider.IDType
String
PossibleID type of the ID for the consulting provider
Visit.ConsultingProvider.FirstName
String
PossibleFirst name of the consulting provider
Visit.ConsultingProvider.LastName
String
PossibleLast name of the consulting provider
Visit.ConsultingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the consulting provider.
e.g. MD, PhD
Visit.ConsultingProvider.Address
Object
PossibleProvider's address
Visit.ConsultingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ConsultingProvider.Address.City
String
PossibleCity
Visit.ConsultingProvider.Address.State
String
PossibleState
Visit.ConsultingProvider.Address.ZIP
String
PossibleZIP
Visit.ConsultingProvider.Address.County
String
PossibleCounty
Visit.ConsultingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ConsultingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ConsultingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ConsultingProvider.Location
Object
PossibleProvider's location
Visit.ConsultingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ConsultingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ConsultingProvider.Location.Department
String
PossibleDepartment
Visit.ConsultingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ReferringProvider
Object
ReliableThe provider that requested a patient to see a consulting provider
Visit.ReferringProvider.ID
String
PossibleID of the referring provider.
This ID is often required for Inpatient Visits.
Visit.ReferringProvider.IDType
String
PossibleID type of the ID for the referring provider
Visit.ReferringProvider.FirstName
String
PossibleFirst name of the referring provider
Visit.ReferringProvider.LastName
String
PossibleLast name of the referring provider
Visit.ReferringProvider.Credentials[]
Array of Strings
PossibleList of credentials for the referring provider.
e.g. MD, PhD
Visit.ReferringProvider.Address
Object
PossibleProvider's address
Visit.ReferringProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ReferringProvider.Address.City
String
PossibleCity
Visit.ReferringProvider.Address.State
String
PossibleState
Visit.ReferringProvider.Address.ZIP
String
PossibleZIP
Visit.ReferringProvider.Address.County
String
PossibleCounty
Visit.ReferringProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ReferringProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ReferringProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ReferringProvider.Location
Object
PossibleProvider's location
Visit.ReferringProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ReferringProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ReferringProvider.Location.Department
String
PossibleDepartment
Visit.ReferringProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.AdmittingProvider
Object
ReliableThe MD/DO that made the decision to admit the patient. Not always the same as attending provider
Visit.AdmittingProvider.ID
String
ReliableID of the admitting provider.
This ID is often required for Inpatient Visits.
Visit.AdmittingProvider.IDType
String
ReliableID type of the ID for the admitting provider
Visit.AdmittingProvider.FirstName
String
PossibleFirst name of the admitting provider
Visit.AdmittingProvider.LastName
String
PossibleLast name of the admitting provider
Visit.AdmittingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the admitting provider.
e.g. MD, PhD
Visit.AdmittingProvider.Address
Object
PossibleProvider's address
Visit.AdmittingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.AdmittingProvider.Address.City
String
PossibleCity
Visit.AdmittingProvider.Address.State
String
PossibleState
Visit.AdmittingProvider.Address.ZIP
String
PossibleZIP
Visit.AdmittingProvider.Address.County
String
PossibleCounty
Visit.AdmittingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AdmittingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AdmittingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AdmittingProvider.Location
Object
PossibleProvider's location
Visit.AdmittingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AdmittingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AdmittingProvider.Location.Department
String
PossibleDepartment
Visit.AdmittingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.Location
Object
ProbableLocation of the appointment
Visit.Location.Type
String
ProbableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.Location.Facility
String
ProbableFacility.
Example: Community Hospital
Visit.Location.Department
String
ProbableDepartment
Visit.Location.Room
String
ProbableRoom.
Example: 136
Visit.Location.Bed
String
ProbableBed.
Example: B
Visit.Location.Address
Object
ProbableAddress of the appointment location
Visit.Location.Address.StreetAddress
String
ProbableStreet address
Visit.Location.Address.City
String
ProbableCity
Visit.Location.Address.State
String
ProbableState
Visit.Location.Address.ZIP
String
ProbableZIP
Visit.Location.Address.County
String
PossibleCounty
Visit.Location.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.Guarantor
Object
PossiblePerson ultimately responsible for the bill of the appointment
Visit.Guarantor.Number
String
ProbableNumber of the guarantor
Visit.Guarantor.FirstName
String
ProbableFirst name
Visit.Guarantor.MiddleName
String
PossibleMiddle name
Visit.Guarantor.LastName
String
ProbableLast name
Visit.Guarantor.SSN
String
PossibleGuarantor's social security number
Visit.Guarantor.DOB
String
PossibleGuarantor's date of birth.
In ISO 8601 format
Visit.Guarantor.Sex
String
PossibleValueSetGuarantor's sex
-
Additional values may be added by Redox in the future.
-
Visit.Guarantor.Spouse.FirstName
String
ProbableSpouse's first name
Visit.Guarantor.Spouse.LastName
String
ProbableSpouse's last name
Visit.Guarantor.Address
Object
ProbableAddress of the guarantor
Visit.Guarantor.Address.StreetAddress
String
ProbableStreet address
Visit.Guarantor.Address.City
String
ProbableCity
Visit.Guarantor.Address.State
String
ProbableState
Visit.Guarantor.Address.ZIP
String
ProbableZIP
Visit.Guarantor.Address.County
String
PossibleCounty
Visit.Guarantor.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.Guarantor.PhoneNumber.Home
String
ProbableHome phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Guarantor.PhoneNumber.Business
String
ProbableBusiness phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Guarantor.PhoneNumber.Mobile
String
ProbableMobile phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Guarantor.EmailAddresses[]
Array of Strings
ProbableGuarantor's email address(es)
Visit.Guarantor.Type
String
ProbableType of guarantor.
E.g. institution, individual
Visit.Guarantor.RelationToPatient
String
ProbableValueSetRelation to the patient
-
Additional values may be added by Redox in the future.
-
Visit.Guarantor.Employer.Name
String
ProbableEmployer's name
Visit.Guarantor.Employer.Address
Object
ProbableEmployer's address
Visit.Guarantor.Employer.Address.StreetAddress
String
ProbableStreet address
Visit.Guarantor.Employer.Address.City
String
ProbableCity
Visit.Guarantor.Employer.Address.State
String
ProbableState
Visit.Guarantor.Employer.Address.ZIP
String
ProbableZIP
Visit.Guarantor.Employer.Address.County
String
PossibleCounty
Visit.Guarantor.Employer.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.Guarantor.Employer.PhoneNumber
String
ProbableEmployer phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Insurances[]
Array of Objects
ProbableList of insurance coverages for the patient
Visit.Insurances[].Plan.ID
String
ProbableIdentifier of insurance plan
Visit.Insurances[].Plan.IDType
String
ProbableID type of insurance plan
Visit.Insurances[].Plan.Name
String
ProbableName of insurance plan
Visit.Insurances[].Plan.Type
String
PossibleType of insurance plan
Visit.Insurances[].MemberNumber
String
PossiblePatient member number
Visit.Insurances[].Company.ID
String
ProbableID of insurance company (payor)
Visit.Insurances[].Company.IDType
String
ProbableID type of insurance company (payor)
Visit.Insurances[].Company.Name
String
ProbableName of insurance company (payor)
Visit.Insurances[].Company.Address
Object
ProbableInsurance company's address
Visit.Insurances[].Company.Address.StreetAddress
String
ProbableStreet address
Visit.Insurances[].Company.Address.City
String
ProbableCity
Visit.Insurances[].Company.Address.State
String
ProbableState
Visit.Insurances[].Company.Address.ZIP
String
ProbableZIP
Visit.Insurances[].Company.Address.County
String
PossibleCounty
Visit.Insurances[].Company.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Company.PhoneNumber
String
ProbableInsurance companys phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Insurances[].GroupNumber
String
ProbableInsurance policy group number
Visit.Insurances[].GroupName
String
ProbableInsurance policy group name
Visit.Insurances[].EffectiveDate
String
ProbableEffect date of this insurance policy.
In YYYY-MM-DD format
Visit.Insurances[].ExpirationDate
String
ProbableExpiration date of this insurance policy.
In YYYY-MM-DD format
Visit.Insurances[].PolicyNumber
String
ProbableInsurance policy number
Visit.Insurances[].AgreementType
String
ProbableValueSetType of insurance agreement.
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].CoverageType
String
ProbableValueSetType of insurance agreement.
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Insured
Object
PossibleIndividual who has the agreement with the insurance company for the related policy
Visit.Insurances[].Insured.Identifiers[]
Array of Objects
PossibleList of IDs and ID types that identify the insured
Visit.Insurances[].Insured.Identifiers[].ID
String
PossibleID for the insured
Visit.Insurances[].Insured.Identifiers[].IDType
String
PossibleType of ID.
E.g. MRN, EPI
Visit.Insurances[].Insured.LastName
String
PossibleLast name of the insured
Visit.Insurances[].Insured.MiddleName
String
PossibleMiddle name of the insured
Visit.Insurances[].Insured.FirstName
String
PossibleFirst name of the insured
Visit.Insurances[].Insured.SSN
String
PossibleInsured's social security number
Visit.Insurances[].Insured.Relationship
String
PossibleValueSetRelationship of the insured to the patient
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Insured.DOB
String
PossibleDate of birth of the insured.
In YYYY-MM-DD format
Visit.Insurances[].Insured.Sex
String
PossibleValueSetSex of the insured
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Insured.Address
Object
ProbableAddress of the insured
Visit.Insurances[].Insured.Address.StreetAddress
String
ProbableStreet address
Visit.Insurances[].Insured.Address.City
String
ProbableCity
Visit.Insurances[].Insured.Address.State
String
ProbableState
Visit.Insurances[].Insured.Address.ZIP
String
ProbableZIP
Visit.Insurances[].Insured.Address.County
String
PossibleCounty
Visit.Insurances[].Insured.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
{
"Meta": {
"DataModel": "PatientAdmin",
"EventType": "Arrival",
"EventDateTime": "2021-02-16T13:48:36.779Z",
"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"
]
}
],
"Diagnoses": [
{
"Code": "R07.0",
"Codeset": "ICD-10",
"Name": "Pain in throat",
"Type": null,
"DocumentedDateTime": null
}
],
"Allergies": [
{
"Code": "7982",
"Codeset": "RxNorm",
"Name": "Penicillin",
"Type": {
"Code": null,
"Codeset": null,
"Name": null
},
"OnsetDateTime": null,
"Reaction": [
{
"Code": "28926001",
"Codeset": "SNOMED CT",
"Name": "Rash"
},
{
"Code": "247472004",
"Codeset": "SNOMED CT",
"Name": "Hives"
}
],
"Severity": {
"Code": null,
"Codeset": null,
"Name": null
},
"Status": null
}
],
"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
}
}
},
"Visit": {
"VisitNumber": "1234",
"AccountNumber": null,
"PatientClass": "Inpatient",
"VisitDateTime": "2021-02-16T13:48:37.387Z",
"Duration": 15,
"Reason": "Check up",
"Instructions": [],
"Balance": null,
"DiagnosisRelatedGroup": null,
"DiagnosisRelatedGroupType": null,
"AttendingProvider": {
"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
}
},
"ConsultingProvider": {
"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
}
},
"ReferringProvider": {
"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
}
},
"AdmittingProvider": {
"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
}
},
"Location": {
"Type": "Inpatient",
"Facility": "RES General Hospital",
"Department": "3N",
"Room": "136",
"Bed": "B",
"Address": {
"StreetAddress": "9509 Integration Ln",
"City": "Madison",
"State": "WI",
"ZIP": "53719",
"County": "Dane",
"Country": "US"
}
},
"Guarantor": {
"Number": "10001910",
"FirstName": "Kent",
"MiddleName": null,
"LastName": "Bixby",
"SSN": null,
"DOB": null,
"Sex": null,
"Spouse": {
"FirstName": "Barbara",
"LastName": "Bixby"
},
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "USA"
},
"PhoneNumber": {
"Home": null,
"Business": null,
"Mobile": null
},
"EmailAddresses": [],
"Type": null,
"RelationToPatient": "Father",
"Employer": {
"Name": "Accelerator Labs",
"Address": {
"StreetAddress": "1456 Old Sauk Road",
"City": "Madison",
"State": "WI",
"ZIP": "53719",
"County": "Dane",
"Country": "USA"
},
"PhoneNumber": "+18083451121"
}
},
"Insurances": [
{
"Plan": {
"ID": "31572",
"IDType": "Payor ID",
"Name": "HMO Deductible Plan",
"Type": null
},
"MemberNumber": null,
"Company": {
"ID": "60054",
"IDType": null,
"Name": "aetna (60054 0131)",
"Address": {
"StreetAddress": "PO Box 14080",
"City": "Lexington",
"State": "KY",
"ZIP": "40512-4079",
"County": "Fayette",
"Country": "US"
},
"PhoneNumber": "+18089541123"
},
"GroupNumber": "847025-024-0009",
"GroupName": "Accelerator Labs",
"EffectiveDate": "2015-01-01",
"ExpirationDate": "2020-12-31",
"PolicyNumber": "9140860055",
"AgreementType": null,
"CoverageType": null,
"Insured": {
"Identifiers": [],
"LastName": null,
"MiddleName": null,
"FirstName": null,
"SSN": null,
"Relationship": null,
"DOB": null,
"Sex": null,
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
}
}
}
]
}
}
A Cancel message is generated when a PatientAdmin event is canceled. The Meta.CanceledEvent field indicates which type of event the message cancels (e.g. Arrival, Discharge). For example, set Meta.EventType to "Cancel" and Meta.CanceledEvent to "Arrival" to cancel an arrival event.
Fields
Meta
Meta.DataModel
String
ReliableRequiredPatientAdmin
Meta.EventType
String
ReliableRequiredCancel
Meta.EventDateTime
DateTime
ReliableDateTime of the event.
DateTime of the cancelation
Meta.CanceledEvent
String
ReliableType of event being canceled.
E.g. Arrival, Discharge, PreAdmit
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.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.Diagnoses[]
Array of Objects
ProbableList of diagnoses associated with this visit
Patient.Diagnoses[].Code
String
ProbableCode for the diagnosis
Patient.Diagnoses[].Codeset
String
ProbableValueSetCode set used to identify the diagnosis
-
Additional values may be added by Redox in the future.
-
Patient.Diagnoses[].Name
String
ProbableName of the diagnosis
Patient.Diagnoses[].Type
String
PossibleValueSetType of the diagnosis
-
Additional values may be added by Redox in the future.
-
Patient.Diagnoses[].DocumentedDateTime
String
PossibleDateTime the diagnosis was documented.
ISO 8601 Format
Patient.Allergies[]
Array of Objects
PossibleList of a patient's allergies
Patient.Allergies[].Code
String
PossibleCode for the allergy
Patient.Allergies[].Codeset
String
PossibleCode set used to identify the allergy.
Typically RxNorm or SNOMED
Patient.Allergies[].Name
String
PossibleName of the allergy
Patient.Allergies[].Type
Object
PossibleThe type of allergy intolerance (food, drug, etc.)
Patient.Allergies[].Type.Code
String
PossibleCode for the allergy intolerance type
Patient.Allergies[].Type.Codeset
String
PossibleCode set used to identify the allergy intolerance type
Patient.Allergies[].Type.Name
String
PossibleName of the allergy intolerance type
Patient.Allergies[].OnsetDateTime
String
PossibleDateTime the allergy was identified
Patient.Allergies[].Reaction[]
Array of Objects
PossibleThe list of reactions caused by this particular allergy.
Patient.Allergies[].Reaction[].Code
String
PossibleCode for the reaction
Patient.Allergies[].Reaction[].Codeset
String
PossibleCode set used to identify the reaction
Patient.Allergies[].Reaction[].Name
String
PossibleName of the reaction
Patient.Allergies[].Severity
Object
PossibleThe severity of the reaction (moderate, severe, etc.).
Patient.Allergies[].Severity.Code
String
PossibleCode for the reaction severity
Patient.Allergies[].Severity.Codeset
String
PossibleCode set used to identify the reaction severity
Patient.Allergies[].Severity.Name
String
PossibleName of the reaction severity
Patient.Allergies[].Status
string
PossibleThe current status of the allergy.
One of the following: "Active", "Inactive", "Resolved".
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
Visit
Visit.VisitNumber
String
ReliableVisit Number.
Unique ID of a single visit
Visit.AccountNumber
String
PossibleAccount Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
Visit.PatientClass
String
ReliablePatient class is used in many EHRs to determine where to put the patient.
Examples: Inpatient, Outpatient, Emergency
Visit.VisitDateTime
String
ReliableDateTime of visit or the arrival time of the admission.
ISO 8601 Format
Visit.Duration
Numeric
ProbableLength of visit.
In minutes
Visit.Reason
String
ProbableReason for visit
Visit.Instructions[]
Array of Strings
ProbableAppointment instructions
Visit.Balance
Numeric
PossiblePatient balance due for this visit.
This field depends on whether or not the sending system has billing functionality, and whether they calculate this field.
Visit.DiagnosisRelatedGroup
Numeric
PossibleDiagnosis Related Group for this visit
Visit.DiagnosisRelatedGroupType
Numeric
PossibleType or System of Diagnosis Related Group for this visit.
Examples include Medicare (CMS-DRG), Refined (R-D DRG), All Patient (AP-DRG), etc
Visit.AttendingProvider
Object
ReliableThe provider primarily responsible for a patient's care during a visit
Visit.AttendingProvider.ID
String
ProbableID of the attending provider.
This ID is often required for Inpatient Visits.
Visit.AttendingProvider.IDType
String
ProbableID type of the ID for the attending provider
Visit.AttendingProvider.FirstName
String
PossibleFirst name of the attending provider
Visit.AttendingProvider.LastName
String
PossibleLast name of the attending provider
Visit.AttendingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the attending provider.
e.g. MD, PhD
Visit.AttendingProvider.Address
Object
PossibleProvider's address
Visit.AttendingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.AttendingProvider.Address.City
String
PossibleCity
Visit.AttendingProvider.Address.State
String
PossibleState
Visit.AttendingProvider.Address.ZIP
String
PossibleZIP
Visit.AttendingProvider.Address.County
String
PossibleCounty
Visit.AttendingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AttendingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AttendingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AttendingProvider.Location
Object
PossibleProvider's location
Visit.AttendingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AttendingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AttendingProvider.Location.Department
String
PossibleDepartment
Visit.AttendingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ConsultingProvider
Object
ReliableA provider, usually a specialist, that evaluates or treats a patient to address a specific problem
Visit.ConsultingProvider.ID
String
PossibleID of the consulting provider.
This ID is often required for Inpatient Visits.
Visit.ConsultingProvider.IDType
String
PossibleID type of the ID for the consulting provider
Visit.ConsultingProvider.FirstName
String
PossibleFirst name of the consulting provider
Visit.ConsultingProvider.LastName
String
PossibleLast name of the consulting provider
Visit.ConsultingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the consulting provider.
e.g. MD, PhD
Visit.ConsultingProvider.Address
Object
PossibleProvider's address
Visit.ConsultingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ConsultingProvider.Address.City
String
PossibleCity
Visit.ConsultingProvider.Address.State
String
PossibleState
Visit.ConsultingProvider.Address.ZIP
String
PossibleZIP
Visit.ConsultingProvider.Address.County
String
PossibleCounty
Visit.ConsultingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ConsultingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ConsultingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ConsultingProvider.Location
Object
PossibleProvider's location
Visit.ConsultingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ConsultingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ConsultingProvider.Location.Department
String
PossibleDepartment
Visit.ConsultingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ReferringProvider
Object
ReliableThe provider that requested a patient to see a consulting provider
Visit.ReferringProvider.ID
String
PossibleID of the referring provider.
This ID is often required for Inpatient Visits.
Visit.ReferringProvider.IDType
String
PossibleID type of the ID for the referring provider
Visit.ReferringProvider.FirstName
String
PossibleFirst name of the referring provider
Visit.ReferringProvider.LastName
String
PossibleLast name of the referring provider
Visit.ReferringProvider.Credentials[]
Array of Strings
PossibleList of credentials for the referring provider.
e.g. MD, PhD
Visit.ReferringProvider.Address
Object
PossibleProvider's address
Visit.ReferringProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ReferringProvider.Address.City
String
PossibleCity
Visit.ReferringProvider.Address.State
String
PossibleState
Visit.ReferringProvider.Address.ZIP
String
PossibleZIP
Visit.ReferringProvider.Address.County
String
PossibleCounty
Visit.ReferringProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ReferringProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ReferringProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ReferringProvider.Location
Object
PossibleProvider's location
Visit.ReferringProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ReferringProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ReferringProvider.Location.Department
String
PossibleDepartment
Visit.ReferringProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.AdmittingProvider
Object
ReliableThe MD/DO that made the decision to admit the patient. Not always the same as attending provider
Visit.AdmittingProvider.ID
String
ReliableID of the admitting provider.
This ID is often required for Inpatient Visits.
Visit.AdmittingProvider.IDType
String
ReliableID type of the ID for the admitting provider
Visit.AdmittingProvider.FirstName
String
PossibleFirst name of the admitting provider
Visit.AdmittingProvider.LastName
String
PossibleLast name of the admitting provider
Visit.AdmittingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the admitting provider.
e.g. MD, PhD
Visit.AdmittingProvider.Address
Object
PossibleProvider's address
Visit.AdmittingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.AdmittingProvider.Address.City
String
PossibleCity
Visit.AdmittingProvider.Address.State
String
PossibleState
Visit.AdmittingProvider.Address.ZIP
String
PossibleZIP
Visit.AdmittingProvider.Address.County
String
PossibleCounty
Visit.AdmittingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AdmittingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AdmittingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AdmittingProvider.Location
Object
PossibleProvider's location
Visit.AdmittingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AdmittingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AdmittingProvider.Location.Department
String
PossibleDepartment
Visit.AdmittingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.Location
Object
ProbableLocation of the appointment
Visit.Location.Type
String
ProbableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.Location.Facility
String
ProbableFacility.
Example: Community Hospital
Visit.Location.Department
String
ProbableDepartment
Visit.Location.Room
String
ProbableRoom.
Example: 136
Visit.Location.Bed
String
ProbableBed.
Example: B
Visit.Location.Address
Object
ProbableAddress of the appointment location
Visit.Location.Address.StreetAddress
String
ProbableStreet address
Visit.Location.Address.City
String
ProbableCity
Visit.Location.Address.State
String
ProbableState
Visit.Location.Address.ZIP
String
ProbableZIP
Visit.Location.Address.County
String
PossibleCounty
Visit.Location.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.Guarantor
Object
PossiblePerson ultimately responsible for the bill of the appointment
Visit.Guarantor.Number
String
ProbableNumber of the guarantor
Visit.Guarantor.FirstName
String
ProbableFirst name
Visit.Guarantor.MiddleName
String
PossibleMiddle name
Visit.Guarantor.LastName
String
ProbableLast name
Visit.Guarantor.SSN
String
PossibleGuarantor's social security number
Visit.Guarantor.DOB
String
PossibleGuarantor's date of birth.
In ISO 8601 format
Visit.Guarantor.Sex
String
PossibleValueSetGuarantor's sex
-
Additional values may be added by Redox in the future.
-
Visit.Guarantor.Spouse.FirstName
String
ProbableSpouse's first name
Visit.Guarantor.Spouse.LastName
String
ProbableSpouse's last name
Visit.Guarantor.Address
Object
ProbableAddress of the guarantor
Visit.Guarantor.Address.StreetAddress
String
ProbableStreet address
Visit.Guarantor.Address.City
String
ProbableCity
Visit.Guarantor.Address.State
String
ProbableState
Visit.Guarantor.Address.ZIP
String
ProbableZIP
Visit.Guarantor.Address.County
String
PossibleCounty
Visit.Guarantor.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.Guarantor.PhoneNumber.Home
String
ProbableHome phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Guarantor.PhoneNumber.Business
String
ProbableBusiness phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Guarantor.PhoneNumber.Mobile
String
ProbableMobile phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Guarantor.EmailAddresses[]
Array of Strings
ProbableGuarantor's email address(es)
Visit.Guarantor.Type
String
ProbableType of guarantor.
E.g. institution, individual
Visit.Guarantor.RelationToPatient
String
ProbableValueSetRelation to the patient
-
Additional values may be added by Redox in the future.
-
Visit.Guarantor.Employer.Name
String
ProbableEmployer's name
Visit.Guarantor.Employer.Address
Object
ProbableEmployer's address
Visit.Guarantor.Employer.Address.StreetAddress
String
ProbableStreet address
Visit.Guarantor.Employer.Address.City
String
ProbableCity
Visit.Guarantor.Employer.Address.State
String
ProbableState
Visit.Guarantor.Employer.Address.ZIP
String
ProbableZIP
Visit.Guarantor.Employer.Address.County
String
PossibleCounty
Visit.Guarantor.Employer.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.Guarantor.Employer.PhoneNumber
String
ProbableEmployer phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Insurances[]
Array of Objects
ProbableList of insurance coverages for the patient
Visit.Insurances[].Plan.ID
String
ProbableIdentifier of insurance plan
Visit.Insurances[].Plan.IDType
String
ProbableID type of insurance plan
Visit.Insurances[].Plan.Name
String
ProbableName of insurance plan
Visit.Insurances[].Plan.Type
String
PossibleType of insurance plan
Visit.Insurances[].MemberNumber
String
PossiblePatient member number
Visit.Insurances[].Company.ID
String
ProbableID of insurance company (payor)
Visit.Insurances[].Company.IDType
String
ProbableID type of insurance company (payor)
Visit.Insurances[].Company.Name
String
ProbableName of insurance company (payor)
Visit.Insurances[].Company.Address
Object
ProbableInsurance company's address
Visit.Insurances[].Company.Address.StreetAddress
String
ProbableStreet address
Visit.Insurances[].Company.Address.City
String
ProbableCity
Visit.Insurances[].Company.Address.State
String
ProbableState
Visit.Insurances[].Company.Address.ZIP
String
ProbableZIP
Visit.Insurances[].Company.Address.County
String
PossibleCounty
Visit.Insurances[].Company.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Company.PhoneNumber
String
ProbableInsurance companys phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Insurances[].GroupNumber
String
ProbableInsurance policy group number
Visit.Insurances[].GroupName
String
ProbableInsurance policy group name
Visit.Insurances[].EffectiveDate
String
ProbableEffect date of this insurance policy.
In YYYY-MM-DD format
Visit.Insurances[].ExpirationDate
String
ProbableExpiration date of this insurance policy.
In YYYY-MM-DD format
Visit.Insurances[].PolicyNumber
String
ProbableInsurance policy number
Visit.Insurances[].AgreementType
String
ProbableValueSetType of insurance agreement.
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].CoverageType
String
ProbableValueSetType of insurance agreement.
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Insured
Object
PossibleIndividual who has the agreement with the insurance company for the related policy
Visit.Insurances[].Insured.Identifiers[]
Array of Objects
PossibleList of IDs and ID types that identify the insured
Visit.Insurances[].Insured.Identifiers[].ID
String
PossibleID for the insured
Visit.Insurances[].Insured.Identifiers[].IDType
String
PossibleType of ID.
E.g. MRN, EPI
Visit.Insurances[].Insured.LastName
String
PossibleLast name of the insured
Visit.Insurances[].Insured.MiddleName
String
PossibleMiddle name of the insured
Visit.Insurances[].Insured.FirstName
String
PossibleFirst name of the insured
Visit.Insurances[].Insured.SSN
String
PossibleInsured's social security number
Visit.Insurances[].Insured.Relationship
String
PossibleValueSetRelationship of the insured to the patient
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Insured.DOB
String
PossibleDate of birth of the insured.
In YYYY-MM-DD format
Visit.Insurances[].Insured.Sex
String
PossibleValueSetSex of the insured
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Insured.Address
Object
ProbableAddress of the insured
Visit.Insurances[].Insured.Address.StreetAddress
String
ProbableStreet address
Visit.Insurances[].Insured.Address.City
String
ProbableCity
Visit.Insurances[].Insured.Address.State
String
ProbableState
Visit.Insurances[].Insured.Address.ZIP
String
ProbableZIP
Visit.Insurances[].Insured.Address.County
String
PossibleCounty
Visit.Insurances[].Insured.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
{
"Meta": {
"DataModel": "PatientAdmin",
"EventType": "Cancel",
"EventDateTime": "2021-02-16T13:48:36.779Z",
"CanceledEvent": "Arrival",
"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"
]
}
],
"Diagnoses": [
{
"Code": "R07.0",
"Codeset": "ICD-10",
"Name": "Pain in throat",
"Type": null,
"DocumentedDateTime": null
}
],
"Allergies": [
{
"Code": "7982",
"Codeset": "RxNorm",
"Name": "Penicillin",
"Type": {
"Code": null,
"Codeset": null,
"Name": null
},
"OnsetDateTime": null,
"Reaction": [
{
"Code": "28926001",
"Codeset": "SNOMED CT",
"Name": "Rash"
},
{
"Code": "247472004",
"Codeset": "SNOMED CT",
"Name": "Hives"
}
],
"Severity": {
"Code": null,
"Codeset": null,
"Name": null
},
"Status": null
}
],
"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
}
}
},
"Visit": {
"VisitNumber": "1234",
"AccountNumber": null,
"PatientClass": "Inpatient",
"VisitDateTime": "2021-02-16T13:48:37.393Z",
"Duration": 15,
"Reason": "Check up",
"Instructions": [],
"Balance": null,
"DiagnosisRelatedGroup": null,
"DiagnosisRelatedGroupType": null,
"AttendingProvider": {
"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
}
},
"ConsultingProvider": {
"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
}
},
"ReferringProvider": {
"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
}
},
"AdmittingProvider": {
"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
}
},
"Location": {
"Type": "Inpatient",
"Facility": "RES General Hospital",
"Department": "3N",
"Room": "136",
"Bed": "B",
"Address": {
"StreetAddress": "9509 Integration Ln",
"City": "Madison",
"State": "WI",
"ZIP": "53719",
"County": "Dane",
"Country": "US"
}
},
"Guarantor": {
"Number": "10001910",
"FirstName": "Kent",
"MiddleName": null,
"LastName": "Bixby",
"SSN": null,
"DOB": null,
"Sex": null,
"Spouse": {
"FirstName": "Barbara",
"LastName": "Bixby"
},
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "USA"
},
"PhoneNumber": {
"Home": null,
"Business": null,
"Mobile": null
},
"EmailAddresses": [],
"Type": null,
"RelationToPatient": "Father",
"Employer": {
"Name": "Accelerator Labs",
"Address": {
"StreetAddress": "1456 Old Sauk Road",
"City": "Madison",
"State": "WI",
"ZIP": "53719",
"County": "Dane",
"Country": "USA"
},
"PhoneNumber": "+18083451121"
}
},
"Insurances": [
{
"Plan": {
"ID": "31572",
"IDType": "Payor ID",
"Name": "HMO Deductible Plan",
"Type": null
},
"MemberNumber": null,
"Company": {
"ID": "60054",
"IDType": null,
"Name": "aetna (60054 0131)",
"Address": {
"StreetAddress": "PO Box 14080",
"City": "Lexington",
"State": "KY",
"ZIP": "40512-4079",
"County": "Fayette",
"Country": "US"
},
"PhoneNumber": "+18089541123"
},
"GroupNumber": "847025-024-0009",
"GroupName": "Accelerator Labs",
"EffectiveDate": "2015-01-01",
"ExpirationDate": "2020-12-31",
"PolicyNumber": "9140860055",
"AgreementType": null,
"CoverageType": null,
"Insured": {
"Identifiers": [],
"LastName": null,
"MiddleName": null,
"FirstName": null,
"SSN": null,
"Relationship": null,
"DOB": null,
"Sex": null,
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
}
}
}
]
}
}
A Discharge message is generated when a patient is discharged or checked out from a clinical stay or visit.
Fields
Meta
Meta.DataModel
String
ReliableRequiredPatientAdmin
Meta.EventType
String
ReliableRequiredDischarge
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.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.Diagnoses[]
Array of Objects
ProbableList of diagnoses associated with this visit
Patient.Diagnoses[].Code
String
ProbableCode for the diagnosis
Patient.Diagnoses[].Codeset
String
ProbableValueSetCode set used to identify the diagnosis
-
Additional values may be added by Redox in the future.
-
Patient.Diagnoses[].Name
String
ProbableName of the diagnosis
Patient.Diagnoses[].Type
String
PossibleValueSetType of the diagnosis
-
Additional values may be added by Redox in the future.
-
Patient.Diagnoses[].DocumentedDateTime
String
PossibleDateTime the diagnosis was documented.
ISO 8601 Format
Patient.Allergies[]
Array of Objects
PossibleList of a patient's allergies
Patient.Allergies[].Code
String
PossibleCode for the allergy
Patient.Allergies[].Codeset
String
PossibleCode set used to identify the allergy.
Typically RxNorm or SNOMED
Patient.Allergies[].Name
String
PossibleName of the allergy
Patient.Allergies[].Type
Object
PossibleThe type of allergy intolerance (food, drug, etc.)
Patient.Allergies[].Type.Code
String
PossibleCode for the allergy intolerance type
Patient.Allergies[].Type.Codeset
String
PossibleCode set used to identify the allergy intolerance type
Patient.Allergies[].Type.Name
String
PossibleName of the allergy intolerance type
Patient.Allergies[].OnsetDateTime
String
PossibleDateTime the allergy was identified
Patient.Allergies[].Reaction[]
Array of Objects
PossibleThe list of reactions caused by this particular allergy.
Patient.Allergies[].Reaction[].Code
String
PossibleCode for the reaction
Patient.Allergies[].Reaction[].Codeset
String
PossibleCode set used to identify the reaction
Patient.Allergies[].Reaction[].Name
String
PossibleName of the reaction
Patient.Allergies[].Severity
Object
PossibleThe severity of the reaction (moderate, severe, etc.).
Patient.Allergies[].Severity.Code
String
PossibleCode for the reaction severity
Patient.Allergies[].Severity.Codeset
String
PossibleCode set used to identify the reaction severity
Patient.Allergies[].Severity.Name
String
PossibleName of the reaction severity
Patient.Allergies[].Status
string
PossibleThe current status of the allergy.
One of the following: "Active", "Inactive", "Resolved".
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
Visit
Visit.VisitNumber
String
ReliableVisit Number.
Unique ID of a single visit
Visit.AccountNumber
String
PossibleAccount Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
Visit.PatientClass
String
ReliablePatient class is used in many EHRs to determine where to put the patient.
Examples: Inpatient, Outpatient, Emergency
Visit.VisitDateTime
String
ReliableDateTime of visit or the arrival time of the admission.
ISO 8601 Format
Visit.DischargeDateTime
String
ReliableDateTime of Patient Discharge.
ISO 8601 Format
Visit.DischargeStatus
Object
ProbableA code indicating the disposition or status of the patient at the end of the visit.
Visit.DischargeStatus.Code
String
ProbableValueSetCode for the discharge status
-
Additional values may be added by Redox in the future.
-
Visit.DischargeStatus.Codeset
String
ProbableCode set used to identify the discharge status.
Coded using the UB04 FL17 codes
Visit.DischargeStatus.Description
String
ProbableDescription of the discharge status
Visit.DischargeLocation
Object
ProbableLocation to which the patient was discharged.
Visit.DischargeLocation.Type
String
ProbableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.DischargeLocation.Facility
String
ProbableFacility.
Example: Community Hospital
Visit.DischargeLocation.Department
String
ProbableDepartment
Visit.DischargeLocation.Room
String
ProbableRoom.
Example: 136
Visit.Duration
Numeric
ProbableLength of visit.
In minutes
Visit.Reason
String
ProbableReason for visit
Visit.Instructions[]
Array of Strings
ProbableAppointment instructions
Visit.Balance
Numeric
PossiblePatient balance due for this visit.
This field depends on whether or not the sending system has billing functionality, and whether they calculate this field.
Visit.DiagnosisRelatedGroup
Numeric
PossibleDiagnosis Related Group for this visit
Visit.DiagnosisRelatedGroupType
Numeric
PossibleType or System of Diagnosis Related Group for this visit.
Examples include Medicare (CMS-DRG), Refined (R-D DRG), All Patient (AP-DRG), etc
Visit.AttendingProvider
Object
ReliableThe provider primarily responsible for a patient's care during a visit
Visit.AttendingProvider.ID
String
ProbableID of the attending provider.
This ID is often required for Inpatient Visits.
Visit.AttendingProvider.IDType
String
ProbableID type of the ID for the attending provider
Visit.AttendingProvider.FirstName
String
PossibleFirst name of the attending provider
Visit.AttendingProvider.LastName
String
PossibleLast name of the attending provider
Visit.AttendingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the attending provider.
e.g. MD, PhD
Visit.AttendingProvider.Address
Object
PossibleProvider's address
Visit.AttendingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.AttendingProvider.Address.City
String
PossibleCity
Visit.AttendingProvider.Address.State
String
PossibleState
Visit.AttendingProvider.Address.ZIP
String
PossibleZIP
Visit.AttendingProvider.Address.County
String
PossibleCounty
Visit.AttendingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AttendingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AttendingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AttendingProvider.Location
Object
PossibleProvider's location
Visit.AttendingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AttendingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AttendingProvider.Location.Department
String
PossibleDepartment
Visit.AttendingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ConsultingProvider
Object
ReliableA provider, usually a specialist, that evaluates or treats a patient to address a specific problem
Visit.ConsultingProvider.ID
String
PossibleID of the consulting provider.
This ID is often required for Inpatient Visits.
Visit.ConsultingProvider.IDType
String
PossibleID type of the ID for the consulting provider
Visit.ConsultingProvider.FirstName
String
PossibleFirst name of the consulting provider
Visit.ConsultingProvider.LastName
String
PossibleLast name of the consulting provider
Visit.ConsultingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the consulting provider.
e.g. MD, PhD
Visit.ConsultingProvider.Address
Object
PossibleProvider's address
Visit.ConsultingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ConsultingProvider.Address.City
String
PossibleCity
Visit.ConsultingProvider.Address.State
String
PossibleState
Visit.ConsultingProvider.Address.ZIP
String
PossibleZIP
Visit.ConsultingProvider.Address.County
String
PossibleCounty
Visit.ConsultingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ConsultingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ConsultingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ConsultingProvider.Location
Object
PossibleProvider's location
Visit.ConsultingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ConsultingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ConsultingProvider.Location.Department
String
PossibleDepartment
Visit.ConsultingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ReferringProvider
Object
ReliableThe provider that requested a patient to see a consulting provider
Visit.ReferringProvider.ID
String
PossibleID of the referring provider.
This ID is often required for Inpatient Visits.
Visit.ReferringProvider.IDType
String
PossibleID type of the ID for the referring provider
Visit.ReferringProvider.FirstName
String
PossibleFirst name of the referring provider
Visit.ReferringProvider.LastName
String
PossibleLast name of the referring provider
Visit.ReferringProvider.Credentials[]
Array of Strings
PossibleList of credentials for the referring provider.
e.g. MD, PhD
Visit.ReferringProvider.Address
Object
PossibleProvider's address
Visit.ReferringProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ReferringProvider.Address.City
String
PossibleCity
Visit.ReferringProvider.Address.State
String
PossibleState
Visit.ReferringProvider.Address.ZIP
String
PossibleZIP
Visit.ReferringProvider.Address.County
String
PossibleCounty
Visit.ReferringProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ReferringProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ReferringProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ReferringProvider.Location
Object
PossibleProvider's location
Visit.ReferringProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ReferringProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ReferringProvider.Location.Department
String
PossibleDepartment
Visit.ReferringProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.AdmittingProvider
Object
ReliableThe MD/DO that made the decision to admit the patient. Not always the same as attending provider
Visit.AdmittingProvider.ID
String
ReliableID of the admitting provider.
This ID is often required for Inpatient Visits.
Visit.AdmittingProvider.IDType
String
ReliableID type of the ID for the admitting provider
Visit.AdmittingProvider.FirstName
String
PossibleFirst name of the admitting provider
Visit.AdmittingProvider.LastName
String
PossibleLast name of the admitting provider
Visit.AdmittingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the admitting provider.
e.g. MD, PhD
Visit.AdmittingProvider.Address
Object
PossibleProvider's address
Visit.AdmittingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.AdmittingProvider.Address.City
String
PossibleCity
Visit.AdmittingProvider.Address.State
String
PossibleState
Visit.AdmittingProvider.Address.ZIP
String
PossibleZIP
Visit.AdmittingProvider.Address.County
String
PossibleCounty
Visit.AdmittingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AdmittingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AdmittingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AdmittingProvider.Location
Object
PossibleProvider's location
Visit.AdmittingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AdmittingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AdmittingProvider.Location.Department
String
PossibleDepartment
Visit.AdmittingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.Location
Object
ProbableLocation of the appointment
Visit.Location.Type
String
ProbableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.Location.Facility
String
ProbableFacility.
Example: Community Hospital
Visit.Location.Department
String
ProbableDepartment
Visit.Location.Room
String
ProbableRoom.
Example: 136
Visit.Location.Bed
String
ProbableBed.
Example: B
Visit.Location.Address
Object
ProbableAddress of the appointment location
Visit.Location.Address.StreetAddress
String
ProbableStreet address
Visit.Location.Address.City
String
ProbableCity
Visit.Location.Address.State
String
ProbableState
Visit.Location.Address.ZIP
String
ProbableZIP
Visit.Location.Address.County
String
PossibleCounty
Visit.Location.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.Guarantor
Object
PossiblePerson ultimately responsible for the bill of the appointment
Visit.Guarantor.Number
String
ProbableNumber of the guarantor
Visit.Guarantor.FirstName
String
ProbableFirst name
Visit.Guarantor.MiddleName
String
PossibleMiddle name
Visit.Guarantor.LastName
String
ProbableLast name
Visit.Guarantor.SSN
String
PossibleGuarantor's social security number
Visit.Guarantor.DOB
String
PossibleGuarantor's date of birth.
In ISO 8601 format
Visit.Guarantor.Sex
String
PossibleValueSetGuarantor's sex
-
Additional values may be added by Redox in the future.
-
Visit.Guarantor.Spouse.FirstName
String
ProbableSpouse's first name
Visit.Guarantor.Spouse.LastName
String
ProbableSpouse's last name
Visit.Guarantor.Address
Object
ProbableAddress of the guarantor
Visit.Guarantor.Address.StreetAddress
String
ProbableStreet address
Visit.Guarantor.Address.City
String
ProbableCity
Visit.Guarantor.Address.State
String
ProbableState
Visit.Guarantor.Address.ZIP
String
ProbableZIP
Visit.Guarantor.Address.County
String
PossibleCounty
Visit.Guarantor.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.Guarantor.PhoneNumber.Home
String
ProbableHome phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Guarantor.PhoneNumber.Business
String
ProbableBusiness phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Guarantor.PhoneNumber.Mobile
String
ProbableMobile phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Guarantor.EmailAddresses[]
Array of Strings
ProbableGuarantor's email address(es)
Visit.Guarantor.Type
String
ProbableType of guarantor.
E.g. institution, individual
Visit.Guarantor.RelationToPatient
String
ProbableValueSetRelation to the patient
-
Additional values may be added by Redox in the future.
-
Visit.Guarantor.Employer.Name
String
ProbableEmployer's name
Visit.Guarantor.Employer.Address
Object
ProbableEmployer's address
Visit.Guarantor.Employer.Address.StreetAddress
String
ProbableStreet address
Visit.Guarantor.Employer.Address.City
String
ProbableCity
Visit.Guarantor.Employer.Address.State
String
ProbableState
Visit.Guarantor.Employer.Address.ZIP
String
ProbableZIP
Visit.Guarantor.Employer.Address.County
String
PossibleCounty
Visit.Guarantor.Employer.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.Guarantor.Employer.PhoneNumber
String
ProbableEmployer phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Insurances[]
Array of Objects
ProbableList of insurance coverages for the patient
Visit.Insurances[].Plan.ID
String
ProbableIdentifier of insurance plan
Visit.Insurances[].Plan.IDType
String
ProbableID type of insurance plan
Visit.Insurances[].Plan.Name
String
ProbableName of insurance plan
Visit.Insurances[].Plan.Type
String
PossibleType of insurance plan
Visit.Insurances[].MemberNumber
String
PossiblePatient member number
Visit.Insurances[].Company.ID
String
ProbableID of insurance company (payor)
Visit.Insurances[].Company.IDType
String
ProbableID type of insurance company (payor)
Visit.Insurances[].Company.Name
String
ProbableName of insurance company (payor)
Visit.Insurances[].Company.Address
Object
ProbableInsurance company's address
Visit.Insurances[].Company.Address.StreetAddress
String
ProbableStreet address
Visit.Insurances[].Company.Address.City
String
ProbableCity
Visit.Insurances[].Company.Address.State
String
ProbableState
Visit.Insurances[].Company.Address.ZIP
String
ProbableZIP
Visit.Insurances[].Company.Address.County
String
PossibleCounty
Visit.Insurances[].Company.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Company.PhoneNumber
String
ProbableInsurance companys phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Insurances[].GroupNumber
String
ProbableInsurance policy group number
Visit.Insurances[].GroupName
String
ProbableInsurance policy group name
Visit.Insurances[].EffectiveDate
String
ProbableEffect date of this insurance policy.
In YYYY-MM-DD format
Visit.Insurances[].ExpirationDate
String
ProbableExpiration date of this insurance policy.
In YYYY-MM-DD format
Visit.Insurances[].PolicyNumber
String
ProbableInsurance policy number
Visit.Insurances[].AgreementType
String
ProbableValueSetType of insurance agreement.
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].CoverageType
String
ProbableValueSetType of insurance agreement.
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Insured
Object
PossibleIndividual who has the agreement with the insurance company for the related policy
Visit.Insurances[].Insured.Identifiers[]
Array of Objects
PossibleList of IDs and ID types that identify the insured
Visit.Insurances[].Insured.Identifiers[].ID
String
PossibleID for the insured
Visit.Insurances[].Insured.Identifiers[].IDType
String
PossibleType of ID.
E.g. MRN, EPI
Visit.Insurances[].Insured.LastName
String
PossibleLast name of the insured
Visit.Insurances[].Insured.MiddleName
String
PossibleMiddle name of the insured
Visit.Insurances[].Insured.FirstName
String
PossibleFirst name of the insured
Visit.Insurances[].Insured.SSN
String
PossibleInsured's social security number
Visit.Insurances[].Insured.Relationship
String
PossibleValueSetRelationship of the insured to the patient
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Insured.DOB
String
PossibleDate of birth of the insured.
In YYYY-MM-DD format
Visit.Insurances[].Insured.Sex
String
PossibleValueSetSex of the insured
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Insured.Address
Object
ProbableAddress of the insured
Visit.Insurances[].Insured.Address.StreetAddress
String
ProbableStreet address
Visit.Insurances[].Insured.Address.City
String
ProbableCity
Visit.Insurances[].Insured.Address.State
String
ProbableState
Visit.Insurances[].Insured.Address.ZIP
String
ProbableZIP
Visit.Insurances[].Insured.Address.County
String
PossibleCounty
Visit.Insurances[].Insured.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
{
"Meta": {
"DataModel": "PatientAdmin",
"EventType": "Discharge",
"EventDateTime": "2021-02-16T13:48:36.779Z",
"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"
]
}
],
"Diagnoses": [
{
"Code": "R07.0",
"Codeset": "ICD-10",
"Name": "Pain in throat",
"Type": null,
"DocumentedDateTime": null
}
],
"Allergies": [
{
"Code": "7982",
"Codeset": "RxNorm",
"Name": "Penicillin",
"Type": {
"Code": null,
"Codeset": null,
"Name": null
},
"OnsetDateTime": null,
"Reaction": [
{
"Code": "28926001",
"Codeset": "SNOMED CT",
"Name": "Rash"
},
{
"Code": "247472004",
"Codeset": "SNOMED CT",
"Name": "Hives"
}
],
"Severity": {
"Code": null,
"Codeset": null,
"Name": null
},
"Status": null
}
],
"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
}
}
},
"Visit": {
"VisitNumber": "1234",
"AccountNumber": null,
"PatientClass": "Inpatient",
"VisitDateTime": "2021-02-15T13:48:37.398Z",
"DischargeDateTime": "2021-02-16T13:48:37.398Z",
"DischargeStatus": {
"Code": "01",
"Codeset": "UB04FL17",
"Description": "Discharged to home care or self care (routine discharge)"
},
"DischargeLocation": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
},
"Duration": null,
"Reason": "Acute post traumatic headache",
"Instructions": [],
"Balance": null,
"DiagnosisRelatedGroup": null,
"DiagnosisRelatedGroupType": null,
"AttendingProvider": {
"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
}
},
"ConsultingProvider": {
"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
}
},
"ReferringProvider": {
"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
}
},
"AdmittingProvider": {
"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
}
},
"Location": {
"Type": "Inpatient",
"Facility": "RES General Hospital",
"Department": "3N",
"Room": "136",
"Bed": "B",
"Address": {
"StreetAddress": "9509 Integration Ln",
"City": "Madison",
"State": "WI",
"ZIP": "53719",
"County": "Dane",
"Country": "US"
}
},
"Guarantor": {
"Number": "10001910",
"FirstName": "Kent",
"MiddleName": null,
"LastName": "Bixby",
"SSN": null,
"DOB": null,
"Sex": null,
"Spouse": {
"FirstName": "Barbara",
"LastName": "Bixby"
},
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "USA"
},
"PhoneNumber": {
"Home": null,
"Business": null,
"Mobile": null
},
"EmailAddresses": [],
"Type": null,
"RelationToPatient": "Father",
"Employer": {
"Name": "Accelerator Labs",
"Address": {
"StreetAddress": "1456 Old Sauk Road",
"City": "Madison",
"State": "WI",
"ZIP": "53719",
"County": "Dane",
"Country": "USA"
},
"PhoneNumber": "+18083451121"
}
},
"Insurances": [
{
"Plan": {
"ID": "31572",
"IDType": "Payor ID",
"Name": "HMO Deductible Plan",
"Type": null
},
"MemberNumber": null,
"Company": {
"ID": "60054",
"IDType": null,
"Name": "aetna (60054 0131)",
"Address": {
"StreetAddress": "PO Box 14080",
"City": "Lexington",
"State": "KY",
"ZIP": "40512-4079",
"County": "Fayette",
"Country": "US"
},
"PhoneNumber": "+18089541123"
},
"GroupNumber": "847025-024-0009",
"GroupName": "Accelerator Labs",
"EffectiveDate": "2015-01-01",
"ExpirationDate": "2020-12-31",
"PolicyNumber": "9140860055",
"AgreementType": null,
"CoverageType": null,
"Insured": {
"Identifiers": [],
"LastName": null,
"MiddleName": null,
"FirstName": null,
"SSN": null,
"Relationship": null,
"DOB": null,
"Sex": null,
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
}
}
}
]
}
}
The NewPatient event signals that a new patient has been created in the source system. Typically this will be followed with a more specific message such as a VisitUpdate message when a visit is created.
Fields
Meta
Meta.DataModel
String
ReliableRequiredPatientAdmin
Meta.EventType
String
ReliableRequiredNewPatient
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.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.Allergies[]
Array of Objects
PossibleList of a patient's allergies
Patient.Allergies[].Code
String
PossibleCode for the allergy
Patient.Allergies[].Codeset
String
PossibleCode set used to identify the allergy.
Typically RxNorm or SNOMED
Patient.Allergies[].Name
String
PossibleName of the allergy
Patient.Allergies[].Type
Object
PossibleThe type of allergy intolerance (food, drug, etc.)
Patient.Allergies[].Type.Code
String
PossibleCode for the allergy intolerance type
Patient.Allergies[].Type.Codeset
String
PossibleCode set used to identify the allergy intolerance type
Patient.Allergies[].Type.Name
String
PossibleName of the allergy intolerance type
Patient.Allergies[].OnsetDateTime
String
PossibleDateTime the allergy was identified
Patient.Allergies[].Reaction[]
Array of Objects
PossibleThe list of reactions caused by this particular allergy.
Patient.Allergies[].Reaction[].Code
String
PossibleCode for the reaction
Patient.Allergies[].Reaction[].Codeset
String
PossibleCode set used to identify the reaction
Patient.Allergies[].Reaction[].Name
String
PossibleName of the reaction
Patient.Allergies[].Severity
Object
PossibleThe severity of the reaction (moderate, severe, etc.).
Patient.Allergies[].Severity.Code
String
PossibleCode for the reaction severity
Patient.Allergies[].Severity.Codeset
String
PossibleCode set used to identify the reaction severity
Patient.Allergies[].Severity.Name
String
PossibleName of the reaction severity
Patient.Allergies[].Status
string
PossibleThe current status of the allergy.
One of the following: "Active", "Inactive", "Resolved".
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.Guarantor
Object
PossiblePerson ultimately responsible for the bill of the appointment
Patient.Guarantor.Number
String
ProbableNumber of the guarantor
Patient.Guarantor.FirstName
String
ProbableFirst name
Patient.Guarantor.MiddleName
String
PossibleMiddle name
Patient.Guarantor.LastName
String
ProbableLast name
Patient.Guarantor.SSN
String
PossibleGuarantor's social security number
Patient.Guarantor.DOB
String
PossibleGuarantor's date of birth.
In ISO 8601 format
Patient.Guarantor.Sex
String
PossibleValueSetGuarantor's sex
-
Additional values may be added by Redox in the future.
-
Patient.Guarantor.Spouse.FirstName
String
ProbableSpouse's first name
Patient.Guarantor.Spouse.LastName
String
ProbableSpouse's last name
Patient.Guarantor.Address
Object
ProbableAddress of the guarantor
Patient.Guarantor.Address.StreetAddress
String
ProbableStreet address
Patient.Guarantor.Address.City
String
ProbableCity
Patient.Guarantor.Address.State
String
ProbableState
Patient.Guarantor.Address.ZIP
String
ProbableZIP
Patient.Guarantor.Address.County
String
PossibleCounty
Patient.Guarantor.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Guarantor.PhoneNumber.Home
String
ProbableHome phone number.
In E. 164 Format (i.e. +16085551234)
Patient.Guarantor.PhoneNumber.Business
String
ProbableBusiness phone number.
In E. 164 Format (i.e. +16085551234)
Patient.Guarantor.PhoneNumber.Mobile
String
ProbableMobile phone number.
In E. 164 Format (i.e. +16085551234)
Patient.Guarantor.EmailAddresses[]
Array of Strings
ProbableGuarantor's email address(es)
Patient.Guarantor.Type
String
ProbableType of guarantor.
E.g. institution, individual
Patient.Guarantor.RelationToPatient
String
ProbableValueSetRelation to the patient
-
Additional values may be added by Redox in the future.
-
Patient.Guarantor.Employer.Name
String
ProbableEmployer's name
Patient.Guarantor.Employer.Address
Object
ProbableEmployer's address
Patient.Guarantor.Employer.Address.StreetAddress
String
ProbableStreet address
Patient.Guarantor.Employer.Address.City
String
ProbableCity
Patient.Guarantor.Employer.Address.State
String
ProbableState
Patient.Guarantor.Employer.Address.ZIP
String
ProbableZIP
Patient.Guarantor.Employer.Address.County
String
PossibleCounty
Patient.Guarantor.Employer.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Guarantor.Employer.PhoneNumber
String
ProbableEmployer phone number.
In E. 164 Format (i.e. +16085551234)
Patient.Insurances[]
Array of Objects
ProbableList of insurance coverages for the patient
Patient.Insurances[].Plan.ID
String
ProbableIdentifier of insurance plan
Patient.Insurances[].Plan.IDType
String
ProbableID type of insurance plan
Patient.Insurances[].Plan.Name
String
ProbableName of insurance plan
Patient.Insurances[].Plan.Type
String
PossibleType of insurance plan
Patient.Insurances[].MemberNumber
String
PossiblePatient member number
Patient.Insurances[].Company.ID
String
ProbableID of insurance company (payor)
Patient.Insurances[].Company.IDType
String
ProbableID type of insurance company (payor)
Patient.Insurances[].Company.Name
String
ProbableName of insurance company (payor)
Patient.Insurances[].Company.Address
Object
ProbableInsurance company's address
Patient.Insurances[].Company.Address.StreetAddress
String
ProbableStreet address
Patient.Insurances[].Company.Address.City
String
ProbableCity
Patient.Insurances[].Company.Address.State
String
ProbableState
Patient.Insurances[].Company.Address.ZIP
String
ProbableZIP
Patient.Insurances[].Company.Address.County
String
PossibleCounty
Patient.Insurances[].Company.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Insurances[].Company.PhoneNumber
String
ProbableInsurance companys phone number.
In E. 164 Format (i.e. +16085551234)
Patient.Insurances[].GroupNumber
String
ProbableInsurance policy group number
Patient.Insurances[].GroupName
String
ProbableInsurance policy group name
Patient.Insurances[].EffectiveDate
String
ProbableEffect date of this insurance policy.
In YYYY-MM-DD format
Patient.Insurances[].ExpirationDate
String
ProbableExpiration date of this insurance policy.
In YYYY-MM-DD format
Patient.Insurances[].PolicyNumber
String
ProbableInsurance policy number
Patient.Insurances[].AgreementType
String
ProbableValueSetType of insurance agreement.
-
Additional values may be added by Redox in the future.
-
Patient.Insurances[].CoverageType
String
ProbableValueSetType of insurance agreement.
-
Additional values may be added by Redox in the future.
-
Patient.Insurances[].Insured
Object
PossibleIndividual who has the agreement with the insurance company for the related policy
Patient.Insurances[].Insured.Identifiers[]
Array of Objects
PossibleList of IDs and ID types that identify the insured
Patient.Insurances[].Insured.Identifiers[].ID
String
PossibleID for the insured
Patient.Insurances[].Insured.Identifiers[].IDType
String
PossibleType of ID.
E.g. MRN, EPI
Patient.Insurances[].Insured.LastName
String
PossibleLast name of the insured
Patient.Insurances[].Insured.MiddleName
String
PossibleMiddle name of the insured
Patient.Insurances[].Insured.FirstName
String
PossibleFirst name of the insured
Patient.Insurances[].Insured.SSN
String
PossibleInsured's social security number
Patient.Insurances[].Insured.Relationship
String
PossibleValueSetRelationship of the insured to the patient
-
Additional values may be added by Redox in the future.
-
Patient.Insurances[].Insured.DOB
String
PossibleDate of birth of the insured.
In YYYY-MM-DD format
Patient.Insurances[].Insured.Sex
String
PossibleValueSetSex of the insured
-
Additional values may be added by Redox in the future.
-
Patient.Insurances[].Insured.Address
Object
ProbableAddress of the insured
Patient.Insurances[].Insured.Address.StreetAddress
String
ProbableStreet address
Patient.Insurances[].Insured.Address.City
String
ProbableCity
Patient.Insurances[].Insured.Address.State
String
ProbableState
Patient.Insurances[].Insured.Address.ZIP
String
ProbableZIP
Patient.Insurances[].Insured.Address.County
String
PossibleCounty
Patient.Insurances[].Insured.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
{
"Meta": {
"DataModel": "PatientAdmin",
"EventType": "NewPatient",
"EventDateTime": "2021-02-16T13:48:36.779Z",
"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"
]
}
],
"Allergies": [
{
"Code": "7982",
"Codeset": "RxNorm",
"Name": "Penicillin",
"Type": {
"Code": null,
"Codeset": null,
"Name": null
},
"OnsetDateTime": null,
"Reaction": [
{
"Code": "28926001",
"Codeset": "SNOMED CT",
"Name": "Rash"
},
{
"Code": "247472004",
"Codeset": "SNOMED CT",
"Name": "Hives"
}
],
"Severity": {
"Code": null,
"Codeset": null,
"Name": null
},
"Status": null
}
],
"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
}
},
"Guarantor": {
"Number": "10001910",
"FirstName": "Kent",
"MiddleName": null,
"LastName": "Bixby",
"SSN": null,
"DOB": null,
"Sex": null,
"Spouse": {
"FirstName": "Barbara",
"LastName": "Bixby"
},
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "USA"
},
"PhoneNumber": {
"Home": null,
"Business": null,
"Mobile": null
},
"EmailAddresses": [],
"Type": null,
"RelationToPatient": "Father",
"Employer": {
"Name": "Accelerator Labs",
"Address": {
"StreetAddress": "1456 Old Sauk Road",
"City": "Madison",
"State": "WI",
"ZIP": "53719",
"County": "Dane",
"Country": "USA"
},
"PhoneNumber": "+18083451121"
}
},
"Insurances": [
{
"Plan": {
"ID": "31572",
"IDType": "Payor ID",
"Name": "HMO Deductible Plan",
"Type": null
},
"MemberNumber": null,
"Company": {
"ID": "60054",
"IDType": null,
"Name": "aetna (60054 0131)",
"Address": {
"StreetAddress": "PO Box 14080",
"City": "Lexington",
"State": "KY",
"ZIP": "40512-4079",
"County": "Fayette",
"Country": "US"
},
"PhoneNumber": "+18089541123"
},
"GroupNumber": "847025-024-0009",
"GroupName": "Accelerator Labs",
"EffectiveDate": "2015-01-01",
"ExpirationDate": "2020-12-31",
"PolicyNumber": "9140860055",
"AgreementType": null,
"CoverageType": null,
"Insured": {
"Identifiers": [],
"LastName": null,
"MiddleName": null,
"FirstName": null,
"SSN": null,
"Relationship": null,
"DOB": null,
"Sex": null,
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
}
}
}
]
}
}
A Patient Update message is generated when any patient or registration information changes while the patient is not currently admitted.
Fields
Meta
Meta.DataModel
String
ReliableRequiredPatientAdmin
Meta.EventType
String
ReliableRequiredPatientUpdate
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.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.Diagnoses[]
Array of Objects
ProbableList of diagnoses associated with this visit
Patient.Diagnoses[].Code
String
ProbableCode for the diagnosis
Patient.Diagnoses[].Codeset
String
ProbableValueSetCode set used to identify the diagnosis
-
Additional values may be added by Redox in the future.
-
Patient.Diagnoses[].Name
String
ProbableName of the diagnosis
Patient.Diagnoses[].Type
String
PossibleValueSetType of the diagnosis
-
Additional values may be added by Redox in the future.
-
Patient.Diagnoses[].DocumentedDateTime
String
PossibleDateTime the diagnosis was documented.
ISO 8601 Format
Patient.Allergies[]
Array of Objects
PossibleList of a patient's allergies
Patient.Allergies[].Code
String
PossibleCode for the allergy
Patient.Allergies[].Codeset
String
PossibleCode set used to identify the allergy.
Typically RxNorm or SNOMED
Patient.Allergies[].Name
String
PossibleName of the allergy
Patient.Allergies[].Type
Object
PossibleThe type of allergy intolerance (food, drug, etc.)
Patient.Allergies[].Type.Code
String
PossibleCode for the allergy intolerance type
Patient.Allergies[].Type.Codeset
String
PossibleCode set used to identify the allergy intolerance type
Patient.Allergies[].Type.Name
String
PossibleName of the allergy intolerance type
Patient.Allergies[].OnsetDateTime
String
PossibleDateTime the allergy was identified
Patient.Allergies[].Reaction[]
Array of Objects
PossibleThe list of reactions caused by this particular allergy.
Patient.Allergies[].Reaction[].Code
String
PossibleCode for the reaction
Patient.Allergies[].Reaction[].Codeset
String
PossibleCode set used to identify the reaction
Patient.Allergies[].Reaction[].Name
String
PossibleName of the reaction
Patient.Allergies[].Severity
Object
PossibleThe severity of the reaction (moderate, severe, etc.).
Patient.Allergies[].Severity.Code
String
PossibleCode for the reaction severity
Patient.Allergies[].Severity.Codeset
String
PossibleCode set used to identify the reaction severity
Patient.Allergies[].Severity.Name
String
PossibleName of the reaction severity
Patient.Allergies[].Status
string
PossibleThe current status of the allergy.
One of the following: "Active", "Inactive", "Resolved".
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.Insurances[]
Array of Objects
ProbableList of insurance coverages for the patient
Patient.Insurances[].Plan.ID
String
ProbableIdentifier of insurance plan
Patient.Insurances[].Plan.IDType
String
ProbableID type of insurance plan
Patient.Insurances[].Plan.Name
String
ProbableName of insurance plan
Patient.Insurances[].Plan.Type
String
PossibleType of insurance plan
Patient.Insurances[].MemberNumber
String
PossiblePatient member number
Patient.Insurances[].Company.ID
String
ProbableID of insurance company (payor)
Patient.Insurances[].Company.IDType
String
ProbableID type of insurance company (payor)
Patient.Insurances[].Company.Name
String
ProbableName of insurance company (payor)
Patient.Insurances[].Company.Address
Object
ProbableInsurance company's address
Patient.Insurances[].Company.Address.StreetAddress
String
ProbableStreet address
Patient.Insurances[].Company.Address.City
String
ProbableCity
Patient.Insurances[].Company.Address.State
String
ProbableState
Patient.Insurances[].Company.Address.ZIP
String
ProbableZIP
Patient.Insurances[].Company.Address.County
String
PossibleCounty
Patient.Insurances[].Company.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Insurances[].Company.PhoneNumber
String
ProbableInsurance companys phone number.
In E. 164 Format (i.e. +16085551234)
Patient.Insurances[].GroupNumber
String
ProbableInsurance policy group number
Patient.Insurances[].GroupName
String
ProbableInsurance policy group name
Patient.Insurances[].EffectiveDate
String
ProbableEffect date of this insurance policy.
In YYYY-MM-DD format
Patient.Insurances[].ExpirationDate
String
ProbableExpiration date of this insurance policy.
In YYYY-MM-DD format
Patient.Insurances[].PolicyNumber
String
ProbableInsurance policy number
Patient.Insurances[].AgreementType
String
ProbableValueSetType of insurance agreement.
-
Additional values may be added by Redox in the future.
-
Patient.Insurances[].CoverageType
String
ProbableValueSetType of insurance agreement.
-
Additional values may be added by Redox in the future.
-
Patient.Insurances[].Insured
Object
PossibleIndividual who has the agreement with the insurance company for the related policy
Patient.Insurances[].Insured.Identifiers[]
Array of Objects
PossibleList of IDs and ID types that identify the insured
Patient.Insurances[].Insured.Identifiers[].ID
String
PossibleID for the insured
Patient.Insurances[].Insured.Identifiers[].IDType
String
PossibleType of ID.
E.g. MRN, EPI
Patient.Insurances[].Insured.LastName
String
PossibleLast name of the insured
Patient.Insurances[].Insured.MiddleName
String
PossibleMiddle name of the insured
Patient.Insurances[].Insured.FirstName
String
PossibleFirst name of the insured
Patient.Insurances[].Insured.SSN
String
PossibleInsured's social security number
Patient.Insurances[].Insured.Relationship
String
PossibleValueSetRelationship of the insured to the patient
-
Additional values may be added by Redox in the future.
-
Patient.Insurances[].Insured.DOB
String
PossibleDate of birth of the insured.
In YYYY-MM-DD format
Patient.Insurances[].Insured.Sex
String
PossibleValueSetSex of the insured
-
Additional values may be added by Redox in the future.
-
Patient.Insurances[].Insured.Address
Object
ProbableAddress of the insured
Patient.Insurances[].Insured.Address.StreetAddress
String
ProbableStreet address
Patient.Insurances[].Insured.Address.City
String
ProbableCity
Patient.Insurances[].Insured.Address.State
String
ProbableState
Patient.Insurances[].Insured.Address.ZIP
String
ProbableZIP
Patient.Insurances[].Insured.Address.County
String
PossibleCounty
Patient.Insurances[].Insured.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Guarantor
Object
PossiblePerson ultimately responsible for the bill for the patient.
Patient.Guarantor.Number
String
ProbableNumber of the guarantor
Patient.Guarantor.FirstName
String
ProbableFirst name
Patient.Guarantor.MiddleName
String
PossibleMiddle name
Patient.Guarantor.LastName
String
ProbableLast name
Patient.Guarantor.SSN
String
PossibleGuarantor's social security number
Patient.Guarantor.DOB
String
PossibleGuarantor's date of birth.
In ISO 8601 format
Patient.Guarantor.Sex
String
PossibleValueSetGuarantor's sex
-
Additional values may be added by Redox in the future.
-
Patient.Guarantor.Spouse.FirstName
String
ProbableSpouse's first name
Patient.Guarantor.Spouse.LastName
String
ProbableSpouse's last name
Patient.Guarantor.Address
Object
ProbableAddress of the guarantor
Patient.Guarantor.Address.StreetAddress
String
ProbableStreet address
Patient.Guarantor.Address.City
String
ProbableCity
Patient.Guarantor.Address.State
String
ProbableState
Patient.Guarantor.Address.ZIP
String
ProbableZIP
Patient.Guarantor.Address.County
String
PossibleCounty
Patient.Guarantor.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Guarantor.PhoneNumber.Home
String
ProbableHome phone number.
In E. 164 Format (i.e. +16085551234)
Patient.Guarantor.PhoneNumber.Business
String
ProbableBusiness phone number.
In E. 164 Format (i.e. +16085551234)
Patient.Guarantor.PhoneNumber.Mobile
String
ProbableMobile phone number.
In E. 164 Format (i.e. +16085551234)
Patient.Guarantor.EmailAddresses[]
Array of Strings
ProbableGuarantor's email address(es)
Patient.Guarantor.Type
String
ProbableType of guarantor.
E.g. institution, individual
Patient.Guarantor.RelationToPatient
String
ProbableValueSetRelation to the patient
-
Additional values may be added by Redox in the future.
-
Patient.Guarantor.Employer.Name
String
ProbableEmployer's name
Patient.Guarantor.Employer.Address
Object
ProbableEmployer's address
Patient.Guarantor.Employer.Address.StreetAddress
String
ProbableStreet address
Patient.Guarantor.Employer.Address.City
String
ProbableCity
Patient.Guarantor.Employer.Address.State
String
ProbableState
Patient.Guarantor.Employer.Address.ZIP
String
ProbableZIP
Patient.Guarantor.Employer.Address.County
String
PossibleCounty
Patient.Guarantor.Employer.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Guarantor.Employer.PhoneNumber
String
ProbableEmployer phone number.
In E. 164 Format (i.e. +16085551234)
{
"Meta": {
"DataModel": "PatientAdmin",
"EventType": "PatientUpdate",
"EventDateTime": "2021-02-16T13:48:36.779Z",
"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": "4435 Victoria Ln",
"City": "Madison",
"State": "WI",
"ZIP": "53719",
"County": "Dane",
"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"
]
}
],
"Diagnoses": [
{
"Code": "R07.0",
"Codeset": "ICD-10",
"Name": "Pain in throat",
"Type": null,
"DocumentedDateTime": null
}
],
"Allergies": [
{
"Code": "7982",
"Codeset": "RxNorm",
"Name": "Penicillin",
"Type": {
"Code": null,
"Codeset": null,
"Name": null
},
"OnsetDateTime": null,
"Reaction": [
{
"Code": "28926001",
"Codeset": "SNOMED CT",
"Name": "Rash"
},
{
"Code": "247472004",
"Codeset": "SNOMED CT",
"Name": "Hives"
}
],
"Severity": {
"Code": null,
"Codeset": null,
"Name": null
},
"Status": null
}
],
"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
}
},
"Insurances": [
{
"Plan": {
"ID": "31572",
"IDType": "Payor ID",
"Name": "HMO Deductible Plan",
"Type": null
},
"MemberNumber": null,
"Company": {
"ID": "60054",
"IDType": null,
"Name": "aetna (60054 0131)",
"Address": {
"StreetAddress": "PO Box 14080",
"City": "Lexington",
"State": "KY",
"ZIP": "40512-4079",
"County": "Fayette",
"Country": "US"
},
"PhoneNumber": "+18089541123"
},
"GroupNumber": "847025-024-0009",
"GroupName": "Accelerator Labs",
"EffectiveDate": "2015-01-01",
"ExpirationDate": "2020-12-31",
"PolicyNumber": "9140860055",
"AgreementType": null,
"CoverageType": null,
"Insured": {
"Identifiers": [],
"LastName": null,
"MiddleName": null,
"FirstName": null,
"SSN": null,
"Relationship": null,
"DOB": null,
"Sex": null,
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
}
}
}
],
"Guarantor": {
"Number": "10001910",
"FirstName": "Kent",
"MiddleName": null,
"LastName": "Bixby",
"SSN": null,
"DOB": null,
"Sex": null,
"Spouse": {
"FirstName": "Barbara",
"LastName": "Bixby"
},
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "USA"
},
"PhoneNumber": {
"Home": null,
"Business": null,
"Mobile": null
},
"EmailAddresses": [],
"Type": null,
"RelationToPatient": "Father",
"Employer": {
"Name": "Accelerator Labs",
"Address": {
"StreetAddress": "1456 Old Sauk Road",
"City": "Madison",
"State": "WI",
"ZIP": "53719",
"County": "Dane",
"Country": "USA"
},
"PhoneNumber": "+18083451121"
}
}
}
}
The PatientMerge event type indicates that two patient records should be combined. This typically occurs when a health system determines that documentation for the same patient has occurred on two separate patient records.
Patient.Identifiers
contains the identifiers for the record that will be used going forward. The identifiers inPatient.PreviousIdentifiers
should be retired and the patient they refer to combined into the record indicated byPatient.Identifiers
.The logic for combining records will be specific to your app. If you have a record for only one of the patients in the message, update the identifiers to match the identifiers in
Patient.Identifiers
.The full
Patient
object is included in the message to provide extra context when available.
Fields
Meta
Meta.DataModel
String
ReliableRequiredPatientAdmin
Meta.EventType
String
ReliableRequiredPatientMerge
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.PreviousIdentifiers[]
Array of Objects
ReliableList of identifiers for the patient record that should be merged into the record identified by
Patient.Identifiers
. These identifiers should be deprecated.
Patient.PreviousIdentifiers[].ID
String
ReliableRequired
Patient.PreviousIdentifiers[].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
{
"Meta": {
"DataModel": "PatientAdmin",
"EventType": "PatientMerge",
"EventDateTime": "2021-02-16T13:48:36.779Z",
"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"
}
],
"PreviousIdentifiers": [
{
"ID": "53700",
"IDType": "MR"
}
],
"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": []
}
}
A Pre-Admit event is used to prepare an admission or encounter. This event may allow for creating a patient, as well as creating a visit. For example, a pre-admit may be used prior to surgery so that lab tests can be performed. It may also be used to update the Emergency Department with an expected patient.
Fields
Meta
Meta.DataModel
String
ReliableRequiredPatientAdmin
Meta.EventType
String
ReliableRequiredPreAdmit
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.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.Diagnoses[]
Array of Objects
ProbableList of diagnoses associated with this visit
Patient.Diagnoses[].Code
String
ProbableCode for the diagnosis
Patient.Diagnoses[].Codeset
String
ProbableValueSetCode set used to identify the diagnosis
-
Additional values may be added by Redox in the future.
-
Patient.Diagnoses[].Name
String
ProbableName of the diagnosis
Patient.Diagnoses[].Type
String
PossibleValueSetType of the diagnosis
-
Additional values may be added by Redox in the future.
-
Patient.Diagnoses[].DocumentedDateTime
String
PossibleDateTime the diagnosis was documented.
ISO 8601 Format
Patient.Allergies[]
Array of Objects
PossibleList of a patient's allergies
Patient.Allergies[].Code
String
PossibleCode for the allergy
Patient.Allergies[].Codeset
String
PossibleCode set used to identify the allergy.
Typically RxNorm or SNOMED
Patient.Allergies[].Name
String
PossibleName of the allergy
Patient.Allergies[].Type
Object
PossibleThe type of allergy intolerance (food, drug, etc.)
Patient.Allergies[].Type.Code
String
PossibleCode for the allergy intolerance type
Patient.Allergies[].Type.Codeset
String
PossibleCode set used to identify the allergy intolerance type
Patient.Allergies[].Type.Name
String
PossibleName of the allergy intolerance type
Patient.Allergies[].OnsetDateTime
String
PossibleDateTime the allergy was identified
Patient.Allergies[].Reaction[]
Array of Objects
PossibleThe list of reactions caused by this particular allergy.
Patient.Allergies[].Reaction[].Code
String
PossibleCode for the reaction
Patient.Allergies[].Reaction[].Codeset
String
PossibleCode set used to identify the reaction
Patient.Allergies[].Reaction[].Name
String
PossibleName of the reaction
Patient.Allergies[].Severity
Object
PossibleThe severity of the reaction (moderate, severe, etc.).
Patient.Allergies[].Severity.Code
String
PossibleCode for the reaction severity
Patient.Allergies[].Severity.Codeset
String
PossibleCode set used to identify the reaction severity
Patient.Allergies[].Severity.Name
String
PossibleName of the reaction severity
Patient.Allergies[].Status
string
PossibleThe current status of the allergy.
One of the following: "Active", "Inactive", "Resolved".
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
Visit
Visit.VisitNumber
String
ReliableVisit Number.
Unique ID of a single visit
Visit.AccountNumber
String
PossibleAccount Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
Visit.PatientClass
String
ReliablePatient class is used in many EHRs to determine where to put the patient.
Examples: Inpatient, Outpatient, Emergency
Visit.VisitDateTime
String
ReliableDateTime of visit or the arrival time of the admission.
ISO 8601 Format
Visit.Duration
Numeric
ProbableLength of visit.
In minutes
Visit.Reason
String
ProbableReason for visit
Visit.Instructions[]
Array of Strings
ProbableAppointment instructions
Visit.Balance
Numeric
PossiblePatient balance due for this visit.
This field depends on whether or not the sending system has billing functionality, and whether they calculate this field.
Visit.DiagnosisRelatedGroup
Numeric
PossibleDiagnosis Related Group for this visit
Visit.DiagnosisRelatedGroupType
Numeric
PossibleType or System of Diagnosis Related Group for this visit.
Examples include Medicare (CMS-DRG), Refined (R-D DRG), All Patient (AP-DRG), etc
Visit.AttendingProvider
Object
ReliableThe provider primarily responsible for a patient's care during a visit
Visit.AttendingProvider.ID
String
ProbableID of the attending provider.
This ID is often required for Inpatient Visits.
Visit.AttendingProvider.IDType
String
ProbableID type of the ID for the attending provider
Visit.AttendingProvider.FirstName
String
PossibleFirst name of the attending provider
Visit.AttendingProvider.LastName
String
PossibleLast name of the attending provider
Visit.AttendingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the attending provider.
e.g. MD, PhD
Visit.AttendingProvider.Address
Object
PossibleProvider's address
Visit.AttendingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.AttendingProvider.Address.City
String
PossibleCity
Visit.AttendingProvider.Address.State
String
PossibleState
Visit.AttendingProvider.Address.ZIP
String
PossibleZIP
Visit.AttendingProvider.Address.County
String
PossibleCounty
Visit.AttendingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AttendingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AttendingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AttendingProvider.Location
Object
PossibleProvider's location
Visit.AttendingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AttendingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AttendingProvider.Location.Department
String
PossibleDepartment
Visit.AttendingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ConsultingProvider
Object
ReliableA provider, usually a specialist, that evaluates or treats a patient to address a specific problem
Visit.ConsultingProvider.ID
String
PossibleID of the consulting provider.
This ID is often required for Inpatient Visits.
Visit.ConsultingProvider.IDType
String
PossibleID type of the ID for the consulting provider
Visit.ConsultingProvider.FirstName
String
PossibleFirst name of the consulting provider
Visit.ConsultingProvider.LastName
String
PossibleLast name of the consulting provider
Visit.ConsultingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the consulting provider.
e.g. MD, PhD
Visit.ConsultingProvider.Address
Object
PossibleProvider's address
Visit.ConsultingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ConsultingProvider.Address.City
String
PossibleCity
Visit.ConsultingProvider.Address.State
String
PossibleState
Visit.ConsultingProvider.Address.ZIP
String
PossibleZIP
Visit.ConsultingProvider.Address.County
String
PossibleCounty
Visit.ConsultingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ConsultingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ConsultingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ConsultingProvider.Location
Object
PossibleProvider's location
Visit.ConsultingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ConsultingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ConsultingProvider.Location.Department
String
PossibleDepartment
Visit.ConsultingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ReferringProvider
Object
ReliableThe provider that requested a patient to see a consulting provider
Visit.ReferringProvider.ID
String
PossibleID of the referring provider.
This ID is often required for Inpatient Visits.
Visit.ReferringProvider.IDType
String
PossibleID type of the ID for the referring provider
Visit.ReferringProvider.FirstName
String
PossibleFirst name of the referring provider
Visit.ReferringProvider.LastName
String
PossibleLast name of the referring provider
Visit.ReferringProvider.Credentials[]
Array of Strings
PossibleList of credentials for the referring provider.
e.g. MD, PhD
Visit.ReferringProvider.Address
Object
PossibleProvider's address
Visit.ReferringProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ReferringProvider.Address.City
String
PossibleCity
Visit.ReferringProvider.Address.State
String
PossibleState
Visit.ReferringProvider.Address.ZIP
String
PossibleZIP
Visit.ReferringProvider.Address.County
String
PossibleCounty
Visit.ReferringProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ReferringProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ReferringProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ReferringProvider.Location
Object
PossibleProvider's location
Visit.ReferringProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ReferringProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ReferringProvider.Location.Department
String
PossibleDepartment
Visit.ReferringProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.AdmittingProvider
Object
ReliableThe MD/DO that made the decision to admit the patient. Not always the same as attending provider
Visit.AdmittingProvider.ID
String
ReliableID of the admitting provider.
This ID is often required for Inpatient Visits.
Visit.AdmittingProvider.IDType
String
ReliableID type of the ID for the admitting provider
Visit.AdmittingProvider.FirstName
String
PossibleFirst name of the admitting provider
Visit.AdmittingProvider.LastName
String
PossibleLast name of the admitting provider
Visit.AdmittingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the admitting provider.
e.g. MD, PhD
Visit.AdmittingProvider.Address
Object
PossibleProvider's address
Visit.AdmittingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.AdmittingProvider.Address.City
String
PossibleCity
Visit.AdmittingProvider.Address.State
String
PossibleState
Visit.AdmittingProvider.Address.ZIP
String
PossibleZIP
Visit.AdmittingProvider.Address.County
String
PossibleCounty
Visit.AdmittingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AdmittingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AdmittingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AdmittingProvider.Location
Object
PossibleProvider's location
Visit.AdmittingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AdmittingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AdmittingProvider.Location.Department
String
PossibleDepartment
Visit.AdmittingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.Location
Object
ProbableLocation of the appointment
Visit.Location.Type
String
ProbableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.Location.Facility
String
ProbableFacility.
Example: Community Hospital
Visit.Location.Department
String
ProbableDepartment
Visit.Location.Room
String
ProbableRoom.
Example: 136
Visit.Location.Bed
String
ProbableBed.
Example: B
Visit.Location.Address
Object
ProbableAddress of the appointment location
Visit.Location.Address.StreetAddress
String
ProbableStreet address
Visit.Location.Address.City
String
ProbableCity
Visit.Location.Address.State
String
ProbableState
Visit.Location.Address.ZIP
String
ProbableZIP
Visit.Location.Address.County
String
PossibleCounty
Visit.Location.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.Guarantor
Object
PossiblePerson ultimately responsible for the bill of the appointment
Visit.Guarantor.Number
String
ProbableNumber of the guarantor
Visit.Guarantor.FirstName
String
ProbableFirst name
Visit.Guarantor.MiddleName
String
PossibleMiddle name
Visit.Guarantor.LastName
String
ProbableLast name
Visit.Guarantor.SSN
String
PossibleGuarantor's social security number
Visit.Guarantor.DOB
String
PossibleGuarantor's date of birth.
In ISO 8601 format
Visit.Guarantor.Sex
String
PossibleValueSetGuarantor's sex
-
Additional values may be added by Redox in the future.
-
Visit.Guarantor.Spouse.FirstName
String
ProbableSpouse's first name
Visit.Guarantor.Spouse.LastName
String
ProbableSpouse's last name
Visit.Guarantor.Address
Object
ProbableAddress of the guarantor
Visit.Guarantor.Address.StreetAddress
String
ProbableStreet address
Visit.Guarantor.Address.City
String
ProbableCity
Visit.Guarantor.Address.State
String
ProbableState
Visit.Guarantor.Address.ZIP
String
ProbableZIP
Visit.Guarantor.Address.County
String
PossibleCounty
Visit.Guarantor.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.Guarantor.PhoneNumber.Home
String
ProbableHome phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Guarantor.PhoneNumber.Business
String
ProbableBusiness phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Guarantor.PhoneNumber.Mobile
String
ProbableMobile phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Guarantor.EmailAddresses[]
Array of Strings
ProbableGuarantor's email address(es)
Visit.Guarantor.Type
String
ProbableType of guarantor.
E.g. institution, individual
Visit.Guarantor.RelationToPatient
String
ProbableValueSetRelation to the patient
-
Additional values may be added by Redox in the future.
-
Visit.Guarantor.Employer.Name
String
ProbableEmployer's name
Visit.Guarantor.Employer.Address
Object
ProbableEmployer's address
Visit.Guarantor.Employer.Address.StreetAddress
String
ProbableStreet address
Visit.Guarantor.Employer.Address.City
String
ProbableCity
Visit.Guarantor.Employer.Address.State
String
ProbableState
Visit.Guarantor.Employer.Address.ZIP
String
ProbableZIP
Visit.Guarantor.Employer.Address.County
String
PossibleCounty
Visit.Guarantor.Employer.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.Guarantor.Employer.PhoneNumber
String
ProbableEmployer phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Insurances[]
Array of Objects
ProbableList of insurance coverages for the patient
Visit.Insurances[].Plan.ID
String
ProbableIdentifier of insurance plan
Visit.Insurances[].Plan.IDType
String
ProbableID type of insurance plan
Visit.Insurances[].Plan.Name
String
ProbableName of insurance plan
Visit.Insurances[].Plan.Type
String
PossibleType of insurance plan
Visit.Insurances[].MemberNumber
String
PossiblePatient member number
Visit.Insurances[].Company.ID
String
ProbableID of insurance company (payor)
Visit.Insurances[].Company.IDType
String
ProbableID type of insurance company (payor)
Visit.Insurances[].Company.Name
String
ProbableName of insurance company (payor)
Visit.Insurances[].Company.Address
Object
ProbableInsurance company's address
Visit.Insurances[].Company.Address.StreetAddress
String
ProbableStreet address
Visit.Insurances[].Company.Address.City
String
ProbableCity
Visit.Insurances[].Company.Address.State
String
ProbableState
Visit.Insurances[].Company.Address.ZIP
String
ProbableZIP
Visit.Insurances[].Company.Address.County
String
PossibleCounty
Visit.Insurances[].Company.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Company.PhoneNumber
String
ProbableInsurance companys phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Insurances[].GroupNumber
String
ProbableInsurance policy group number
Visit.Insurances[].GroupName
String
ProbableInsurance policy group name
Visit.Insurances[].EffectiveDate
String
ProbableEffect date of this insurance policy.
In YYYY-MM-DD format
Visit.Insurances[].ExpirationDate
String
ProbableExpiration date of this insurance policy.
In YYYY-MM-DD format
Visit.Insurances[].PolicyNumber
String
ProbableInsurance policy number
Visit.Insurances[].AgreementType
String
ProbableValueSetType of insurance agreement.
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].CoverageType
String
ProbableValueSetType of insurance agreement.
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Insured
Object
PossibleIndividual who has the agreement with the insurance company for the related policy
Visit.Insurances[].Insured.Identifiers[]
Array of Objects
PossibleList of IDs and ID types that identify the insured
Visit.Insurances[].Insured.Identifiers[].ID
String
PossibleID for the insured
Visit.Insurances[].Insured.Identifiers[].IDType
String
PossibleType of ID.
E.g. MRN, EPI
Visit.Insurances[].Insured.LastName
String
PossibleLast name of the insured
Visit.Insurances[].Insured.MiddleName
String
PossibleMiddle name of the insured
Visit.Insurances[].Insured.FirstName
String
PossibleFirst name of the insured
Visit.Insurances[].Insured.SSN
String
PossibleInsured's social security number
Visit.Insurances[].Insured.Relationship
String
PossibleValueSetRelationship of the insured to the patient
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Insured.DOB
String
PossibleDate of birth of the insured.
In YYYY-MM-DD format
Visit.Insurances[].Insured.Sex
String
PossibleValueSetSex of the insured
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Insured.Address
Object
ProbableAddress of the insured
Visit.Insurances[].Insured.Address.StreetAddress
String
ProbableStreet address
Visit.Insurances[].Insured.Address.City
String
ProbableCity
Visit.Insurances[].Insured.Address.State
String
ProbableState
Visit.Insurances[].Insured.Address.ZIP
String
ProbableZIP
Visit.Insurances[].Insured.Address.County
String
PossibleCounty
Visit.Insurances[].Insured.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
{
"Meta": {
"DataModel": "PatientAdmin",
"EventType": "PreAdmit",
"EventDateTime": "2021-02-16T13:48:36.779Z",
"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"
]
}
],
"Diagnoses": [
{
"Code": "R07.0",
"Codeset": "ICD-10",
"Name": "Pain in throat",
"Type": null,
"DocumentedDateTime": null
}
],
"Allergies": [
{
"Code": "7982",
"Codeset": "RxNorm",
"Name": "Penicillin",
"Type": {
"Code": null,
"Codeset": null,
"Name": null
},
"OnsetDateTime": null,
"Reaction": [
{
"Code": "28926001",
"Codeset": "SNOMED CT",
"Name": "Rash"
},
{
"Code": "247472004",
"Codeset": "SNOMED CT",
"Name": "Hives"
}
],
"Severity": {
"Code": null,
"Codeset": null,
"Name": null
},
"Status": null
}
],
"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
}
}
},
"Visit": {
"VisitNumber": "1234",
"AccountNumber": null,
"PatientClass": "Inpatient",
"VisitDateTime": "2021-02-16T13:48:37.414Z",
"Duration": 15,
"Reason": "Check up",
"Instructions": [],
"Balance": null,
"DiagnosisRelatedGroup": null,
"DiagnosisRelatedGroupType": null,
"AttendingProvider": {
"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
}
},
"ConsultingProvider": {
"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
}
},
"ReferringProvider": {
"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
}
},
"AdmittingProvider": {
"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
}
},
"Location": {
"Type": "Inpatient",
"Facility": "RES General Hospital",
"Department": "3N",
"Room": "136",
"Bed": "B",
"Address": {
"StreetAddress": "9509 Integration Ln",
"City": "Madison",
"State": "WI",
"ZIP": "53719",
"County": "Dane",
"Country": "US"
}
},
"Guarantor": {
"Number": "10001910",
"FirstName": "Kent",
"MiddleName": null,
"LastName": "Bixby",
"SSN": null,
"DOB": null,
"Sex": null,
"Spouse": {
"FirstName": "Barbara",
"LastName": "Bixby"
},
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "USA"
},
"PhoneNumber": {
"Home": null,
"Business": null,
"Mobile": null
},
"EmailAddresses": [],
"Type": null,
"RelationToPatient": "Father",
"Employer": {
"Name": "Accelerator Labs",
"Address": {
"StreetAddress": "1456 Old Sauk Road",
"City": "Madison",
"State": "WI",
"ZIP": "53719",
"County": "Dane",
"Country": "USA"
},
"PhoneNumber": "+18083451121"
}
},
"Insurances": [
{
"Plan": {
"ID": "31572",
"IDType": "Payor ID",
"Name": "HMO Deductible Plan",
"Type": null
},
"MemberNumber": null,
"Company": {
"ID": "60054",
"IDType": null,
"Name": "aetna (60054 0131)",
"Address": {
"StreetAddress": "PO Box 14080",
"City": "Lexington",
"State": "KY",
"ZIP": "40512-4079",
"County": "Fayette",
"Country": "US"
},
"PhoneNumber": "+18089541123"
},
"GroupNumber": "847025-024-0009",
"GroupName": "Accelerator Labs",
"EffectiveDate": "2015-01-01",
"ExpirationDate": "2020-12-31",
"PolicyNumber": "9140860055",
"AgreementType": null,
"CoverageType": null,
"Insured": {
"Identifiers": [],
"LastName": null,
"MiddleName": null,
"FirstName": null,
"SSN": null,
"Relationship": null,
"DOB": null,
"Sex": null,
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
}
}
}
]
}
}
A Registration message is generated when a patient is checked into a specific visit or registered for a Hospital Outpatient Visit.
Fields
Meta
Meta.DataModel
String
ReliableRequiredPatientAdmin
Meta.EventType
String
ReliableRequiredRegistration
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.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.Diagnoses[]
Array of Objects
ProbableList of diagnoses associated with this visit
Patient.Diagnoses[].Code
String
ProbableCode for the diagnosis
Patient.Diagnoses[].Codeset
String
ProbableValueSetCode set used to identify the diagnosis
-
Additional values may be added by Redox in the future.
-
Patient.Diagnoses[].Name
String
ProbableName of the diagnosis
Patient.Diagnoses[].Type
String
PossibleValueSetType of the diagnosis
-
Additional values may be added by Redox in the future.
-
Patient.Diagnoses[].DocumentedDateTime
String
PossibleD