Redox | PatientAdmin

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.

Data Château stores identifiers, basic demographics, and PCP information from all PatientAdmin messages.

PatientAdmin FAQ^

Arrival
Cancel
Discharge
NewPatient
PatientUpdate
PatientMerge
PreAdmit
Registration
Transfer
VisitMerge
VisitUpdate

ArrivalBETA

View R^FHIR Event Type

An Arrival message is generated when a patient shows up for their visit or when a patient is admitted to the hospital.

Fields

Show Required Fields Only

Meta
- Meta.DataModel
  String
  Reliable
  Required
  Data model.
  E.g. Scheduling, Results
- Meta.EventType
  String
  Reliable
  Required
  Type of event.
  E.g. New, Update
- Meta.EventDateTime
  DateTime
  Reliable
  DateTime of the event.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Flag as a test message
- Meta.Source
  String
  Reliable
  Where the message originated.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  ID of the source.
  UUID
- Meta.Source.Name
  String
  Reliable
  Name of the source
- Meta.Destinations[]
  Array of Objects
  Reliable
  List of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
  Required when sending data to Redox
- Meta.Destinations[].ID
  String
  Reliable
  ID of the destination.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Name of the destination
- Meta.Message
  String
  Reliable
  Record in Redox that corresponds to the communication sent from the source to Redox.
  Included in messages from Redox
- Meta.Message.ID
  Numeric
  Reliable
  ID of the message created in Redox
- Meta.Transmission
  String
  Reliable
  Record in Redox that corresponds to the communication sent from Redox to your destination.
  Included in messages from Redox
- Meta.Transmission.ID
  Numeric
  Reliable
  ID of the transmission created in Redox
- Meta.FacilityCode
  String
  Possible
  Code for the facility related to the message.
  Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
- Patient.Identifiers[]
  Array of Objects
  Reliable
  List of IDs and ID types that identify the patient
- Patient.Identifiers[].ID
  String
  Reliable
  Required
  ID for the patient
- Patient.Identifiers[].IDType
  String
  Reliable
  Required
  Type of ID.
  E.g. MRN, EPI
- Patient.Demographics.FirstName
  String
  Reliable
  Patient's first name
- Patient.Demographics.MiddleName
  String
  Possible
  Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
- Patient.Demographics.LastName
  String
  Reliable
  Patient's last name
- Patient.Demographics.DOB
  String
  Reliable
  Patient's date of birth.
  In ISO 8601 format
- Patient.Demographics.SSN
  String
  Probable
  Patient's social security number
- Patient.Demographics.Sex
  String
  Reliable
  Patient's sex
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Race
  String
  Possible
  Patient's race.
  Supported Values
- Patient.Demographics.IsHispanic
  Boolean
  Possible
  Indicates if the patient is of hispanic origin.
- Patient.Demographics.MaritalStatus
  String
  Possible
  Patient's marital status
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.IsDeceased
  Boolean
  Possible
  Indicates if the patient is deceased
- Patient.Demographics.DeathDateTime
  DateTime
  Possible
  Date and Time the patient was proclaimed deceased.
  ISO 8601 Format
- Patient.Demographics.PhoneNumber.Home
  String
  Probable
  Patient's home phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Office
  String
  Probable
  Patient's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Mobile
  String
  Probable
  Patient's mobile phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.EmailAddresses[]
  Array of Strings
  Probable
  Patient's email address(es)
- Patient.Demographics.Language
  String
  Possible
  Patient's primary spoken language.
  In ISO 639-1 alpha values (e.g. 'en'). Supported Values
- Patient.Demographics.Citizenship[]
  Array of strings
  Possible
  Patient's nation(s) of citizenship.
  *In ISO 3166 alpha 2 format (e.g. 'US'). Reference Table.
  
  Note: The valid set of citizenships is a smaller list than the list of IS0 3166 country codes, and should be limited to the 193 United Nations countries plus 6 states: ROC Taiwan, Macao (SAR China), Hong Kong (SAR China), Kosovo, Palestinian Territory and the Vatican.*
- Patient.Demographics.Address
  Object
  Probable
  Patient's home address
- Patient.Demographics.Address.StreetAddress
  String
  Probable
  Street address
- Patient.Demographics.Address.City
  String
  Probable
  City
- Patient.Demographics.Address.State
  String
  Probable
  State
- Patient.Demographics.Address.ZIP
  String
  Probable
  ZIP
- Patient.Demographics.Address.County
  String
  Possible
  County
- Patient.Demographics.Address.Country
  String
  Possible
  Country
- Patient.Notes[]
  Array of strings
  Possible
  Patient-level notes
- Patient.Contacts[].FirstName
  String
  Possible
  First name of the contact
- Patient.Contacts[].MiddleName
  String
  Possible
  Middle name of the contact
- Patient.Contacts[].LastName
  String
  Possible
  Last name of the contact
- Patient.Contacts[].Address
  Object
  Possible
  Address of the contact
- Patient.Contacts[].Address.StreetAddress
  String
  Possible
  Street address
- Patient.Contacts[].Address.City
  String
  Possible
  City
- Patient.Contacts[].Address.State
  String
  Possible
  State
- Patient.Contacts[].Address.ZIP
  String
  Possible
  ZIP
- Patient.Contacts[].Address.County
  String
  Possible
  County
- Patient.Contacts[].Address.Country
  String
  Possible
  Country
- Patient.Contacts[].PhoneNumber.Home
  String
  Possible
  Home phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Contacts[].PhoneNumber.Office
  String
  Possible
  Office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Contacts[].PhoneNumber.Mobile
  String
  Probable
  Mobile phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Contacts[].RelationToPatient
  String
  Possible
  Personal relationship to the patient.
  e.x. Father, Spouse
- Patient.Contacts[].EmailAddresses[]
  Array of string
  Possible
  Email address(es) of the contact person
- Patient.Contacts[].Roles[]
  Array of strings
  Possible
  Role of this contact for the patient.
  e.x. Employer, Emergency Contact
- Patient.Diagnoses[]
  Array of Objects
  Probable
  List of diagnoses associated with this visit
- Patient.Diagnoses[].Code
  String
  Probable
  Code for the diagnosis
- Patient.Diagnoses[].Codeset
  String
  Probable
  Code set used to identify the diagnosis.
  One of the following: ICD-9, ICD-10, HCPCS, CPT
- Patient.Diagnoses[].Name
  String
  Probable
  Name of the diagnosis
- Patient.Diagnoses[].Type
  String
  Possible
  Type of the diagnosis.
  One of the following: Admitting, Working, or Final
- Patient.Diagnoses[].DocumentedDateTime
  String
  Possible
  DateTime the diagnosis was documented.
  ISO 8601 Format
- Patient.Allergies[]
  Array of Objects
  Possible
  List of a patient's allergies
- Patient.Allergies[].Code
  String
  Possible
  Code for the allergy
- Patient.Allergies[].Codeset
  String
  Possible
  Code set used to identify the allergy.
  Typically RxNorm or SNOMED
- Patient.Allergies[].Name
  String
  Possible
  Name of the allergy
- Patient.Allergies[].Type
  Object
  Possible
  The type of allergy intolerance (food, drug, etc.)
- Patient.Allergies[].Type.Code
  String
  Possible
  Code for the allergy intolerance type
- Patient.Allergies[].Type.Codeset
  String
  Possible
  Code set used to identify the allergy intolerance type
- Patient.Allergies[].Type.Name
  String
  Possible
  Name of the allergy intolerance type
- Patient.Allergies[].OnsetDateTime
  String
  Possible
  DateTime the allergy was identified
- Patient.Allergies[].Reaction[]
  Array of Objects
  Possible
  The list of reactions caused by this particular allergy.
- Patient.Allergies[].Reaction[].Code
  String
  Possible
  Code for the reaction
- Patient.Allergies[].Reaction[].Codeset
  String
  Possible
  Code set used to identify the reaction
- Patient.Allergies[].Reaction[].Name
  String
  Possible
  Name of the reaction
- Patient.Allergies[].Severity
  Object
  Possible
  The severity of the reaction (moderate, severe, etc.).
- Patient.Allergies[].Severity.Code
  String
  Possible
  Code for the reaction severity
- Patient.Allergies[].Severity.Codeset
  String
  Possible
  Code set used to identify the reaction severity
- Patient.Allergies[].Severity.Name
  String
  Possible
  Name of the reaction severity
- Patient.Allergies[].Status
  string
  Possible
  The current status of the allergy.
  One of the following: "Active", "Inactive", "Resolved".
- Patient.PCP
  Object
  Reliable
  Primary Care Provider for the Patient
- Patient.PCP.NPI
  String
  Reliable
  NPI of the PCP
- Patient.PCP.ID
  String
  Reliable
  ID of the PCP.
  This ID is often required for Inpatient Visits.
- Patient.PCP.IDType
  String
  Reliable
  ID type of the ID for the PCP
- Patient.PCP.FirstName
  String
  Possible
  First name of the PCP
- Patient.PCP.LastName
  String
  Possible
  Last name of the PCP
- Patient.PCP.Credentials[]
  Array of Strings
  Possible
  List of credentials for the PCP.
  e.g. MD, PhD
- Patient.PCP.Address
  Object
  Possible
  Provider's address
- Patient.PCP.Address.StreetAddress
  String
  Possible
  Street address
- Patient.PCP.Address.City
  String
  Possible
  City
- Patient.PCP.Address.State
  String
  Possible
  State
- Patient.PCP.Address.ZIP
  String
  Possible
  ZIP
- Patient.PCP.Address.County
  String
  Possible
  County
- Patient.PCP.Address.Country
  String
  Possible
  Country
- Patient.PCP.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.PCP.Location
  Object
  Possible
  Provider's location
- Patient.PCP.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Patient.PCP.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Patient.PCP.Location.Department
  String
  Possible
  Department
- Patient.PCP.Location.Room
  String
  Possible
  Room.
  Example: 136
Visit
- Visit.VisitNumber
  String
  Reliable
  Visit Number.
  Unique ID of a single visit
- Visit.AccountNumber
  String
  Possible
  Account Number.
  An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
- Visit.PatientClass
  String
  Reliable
  Required
  Patient class is used in many EHRs to determine where to put the patient.
  Examples: Inpatient, Outpatient, Emergency
- Visit.VisitDateTime
  String
  Reliable
  DateTime of visit or the arrival time of the admission.
  ISO 8601 Format
- Visit.Duration
  Numeric
  Probable
  Length of visit.
  In minutes
- Visit.Reason
  String
  Probable
  Reason for visit
- Visit.Instructions[]
  Array of Strings
  Probable
  Appointment instructions
- Visit.Balance
  Numeric
  Possible
  Patient 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
  Possible
  Diagnosis Related Group for this visit
- Visit.DiagnosisRelatedGroupType
  Numeric
  Possible
  Type 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
  Reliable
  The provider primarily responsible for a patient's care during a visit
- Visit.AttendingProvider.ID
  String
  Probable
  ID of the attending provider.
  This ID is often required for Inpatient Visits.
- Visit.AttendingProvider.IDType
  String
  Probable
  ID type of the ID for the attending provider
- Visit.AttendingProvider.FirstName
  String
  Possible
  First name of the attending provider
- Visit.AttendingProvider.LastName
  String
  Possible
  Last name of the attending provider
- Visit.AttendingProvider.Credentials[]
  Array of Strings
  Possible
  List of credentials for the attending provider.
  e.g. MD, PhD
- Visit.AttendingProvider.Address
  Object
  Possible
  Provider's address
- Visit.AttendingProvider.Address.StreetAddress
  String
  Possible
  Street address
- Visit.AttendingProvider.Address.City
  String
  Possible
  City
- Visit.AttendingProvider.Address.State
  String
  Possible
  State
- Visit.AttendingProvider.Address.ZIP
  String
  Possible
  ZIP
- Visit.AttendingProvider.Address.County
  String
  Possible
  County
- Visit.AttendingProvider.Address.Country
  String
  Possible
  Country
- Visit.AttendingProvider.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Visit.AttendingProvider.Location
  Object
  Possible
  Provider's location
- Visit.AttendingProvider.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.AttendingProvider.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Visit.AttendingProvider.Location.Department
  String
  Possible
  Department
- Visit.AttendingProvider.Location.Room
  String
  Possible
  Room.
  Example: 136
- Visit.ConsultingProvider
  Object
  Reliable
  A provider, usually a specialist, that evaluates or treats a patient to address a specific problem
- Visit.ConsultingProvider.ID
  String
  Possible
  ID of the consulting provider.
  This ID is often required for Inpatient Visits.
- Visit.ConsultingProvider.IDType
  String
  Possible
  ID type of the ID for the consulting provider
- Visit.ConsultingProvider.FirstName
  String
  Possible
  First name of the consulting provider
- Visit.ConsultingProvider.LastName
  String
  Possible
  Last name of the consulting provider
- Visit.ConsultingProvider.Credentials[]
  Array of Strings
  Possible
  List of credentials for the consulting provider.
  e.g. MD, PhD
- Visit.ConsultingProvider.Address
  Object
  Possible
  Provider's address
- Visit.ConsultingProvider.Address.StreetAddress
  String
  Possible
  Street address
- Visit.ConsultingProvider.Address.City
  String
  Possible
  City
- Visit.ConsultingProvider.Address.State
  String
  Possible
  State
- Visit.ConsultingProvider.Address.ZIP
  String
  Possible
  ZIP
- Visit.ConsultingProvider.Address.County
  String
  Possible
  County
- Visit.ConsultingProvider.Address.Country
  String
  Possible
  Country
- Visit.ConsultingProvider.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Visit.ConsultingProvider.Location
  Object
  Possible
  Provider's location
- Visit.ConsultingProvider.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.ConsultingProvider.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Visit.ConsultingProvider.Location.Department
  String
  Possible
  Department
- Visit.ConsultingProvider.Location.Room
  String
  Possible
  Room.
  Example: 136
- Visit.ReferringProvider
  Object
  Reliable
  The provider that requested a patient to see a consulting provider
- Visit.ReferringProvider.ID
  String
  Possible
  ID of the referring provider.
  This ID is often required for Inpatient Visits.
- Visit.ReferringProvider.IDType
  String
  Possible
  ID type of the ID for the referring provider
- Visit.ReferringProvider.FirstName
  String
  Possible
  First name of the referring provider
- Visit.ReferringProvider.LastName
  String
  Possible
  Last name of the referring provider
- Visit.ReferringProvider.Credentials[]
  Array of Strings
  Possible
  List of credentials for the referring provider.
  e.g. MD, PhD
- Visit.ReferringProvider.Address
  Object
  Possible
  Provider's address
- Visit.ReferringProvider.Address.StreetAddress
  String
  Possible
  Street address
- Visit.ReferringProvider.Address.City
  String
  Possible
  City
- Visit.ReferringProvider.Address.State
  String
  Possible
  State
- Visit.ReferringProvider.Address.ZIP
  String
  Possible
  ZIP
- Visit.ReferringProvider.Address.County
  String
  Possible
  County
- Visit.ReferringProvider.Address.Country
  String
  Possible
  Country
- Visit.ReferringProvider.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Visit.ReferringProvider.Location
  Object
  Possible
  Provider's location
- Visit.ReferringProvider.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.ReferringProvider.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Visit.ReferringProvider.Location.Department
  String
  Possible
  Department
- Visit.ReferringProvider.Location.Room
  String
  Possible
  Room.
  Example: 136
- Visit.AdmittingProvider
  Object
  Reliable
  The MD/DO that made the decision to admit the patient. Not always the same as attending provider
- Visit.AdmittingProvider.ID
  String
  Reliable
  ID of the admitting provider.
  This ID is often required for Inpatient Visits.
- Visit.AdmittingProvider.IDType
  String
  Reliable
  ID type of the ID for the admitting provider
- Visit.AdmittingProvider.FirstName
  String
  Possible
  First name of the admitting provider
- Visit.AdmittingProvider.LastName
  String
  Possible
  Last name of the admitting provider
- Visit.AdmittingProvider.Credentials[]
  Array of Strings
  Possible
  List of credentials for the admitting provider.
  e.g. MD, PhD
- Visit.AdmittingProvider.Address
  Object
  Possible
  Provider's address
- Visit.AdmittingProvider.Address.StreetAddress
  String
  Possible
  Street address
- Visit.AdmittingProvider.Address.City
  String
  Possible
  City
- Visit.AdmittingProvider.Address.State
  String
  Possible
  State
- Visit.AdmittingProvider.Address.ZIP
  String
  Possible
  ZIP
- Visit.AdmittingProvider.Address.County
  String
  Possible
  County
- Visit.AdmittingProvider.Address.Country
  String
  Possible
  Country
- Visit.AdmittingProvider.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Visit.AdmittingProvider.Location
  Object
  Possible
  Provider's location
- Visit.AdmittingProvider.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.AdmittingProvider.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Visit.AdmittingProvider.Location.Department
  String
  Possible
  Department
- Visit.AdmittingProvider.Location.Room
  String
  Possible
  Room.
  Example: 136
- Visit.Location
  Object
  Probable
  Location of the appointment
- Visit.Location.Type
  String
  Probable
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.Location.Facility
  String
  Probable
  Facility.
  Example: Community Hospital
- Visit.Location.Department
  String
  Probable
  Department
- Visit.Location.Room
  String
  Probable
  Room.
  Example: 136
- Visit.Location.Bed
  String
  Probable
  Bed.
  Example: B
- Visit.Location.Address
  Object
  Probable
  Address of the appointment location
- Visit.Location.Address.StreetAddress
  String
  Probable
  Street address
- Visit.Location.Address.City
  String
  Probable
  City
- Visit.Location.Address.State
  String
  Probable
  State
- Visit.Location.Address.ZIP
  String
  Probable
  ZIP
- Visit.Location.Address.County
  String
  Possible
  County
- Visit.Location.Address.Country
  String
  Possible
  Country
- Visit.Guarantor
  Object
  Possible
  Person ultimately responsible for the bill of the appointment
- Visit.Guarantor.Number
  String
  Probable
  Number of the guarantor
- Visit.Guarantor.FirstName
  String
  Probable
  First name
- Visit.Guarantor.LastName
  String
  Probable
  Last name
- Visit.Guarantor.SSN
  String
  Possible
  Guarantor's social security number
- Visit.Guarantor.DOB
  String
  Possible
  Guarantor's date of birth.
  In ISO 8601 format
- Visit.Guarantor.Sex
  String
  Possible
  Guarantor's sex
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.Guarantor.Spouse.FirstName
  String
  Probable
  Spouse's first name
- Visit.Guarantor.Spouse.LastName
  String
  Probable
  Spouse's last name
- Visit.Guarantor.Address
  Object
  Probable
  Address of the guarantor
- Visit.Guarantor.Address.StreetAddress
  String
  Probable
  Street address
- Visit.Guarantor.Address.City
  String
  Probable
  City
- Visit.Guarantor.Address.State
  String
  Probable
  State
- Visit.Guarantor.Address.ZIP
  String
  Probable
  ZIP
- Visit.Guarantor.Address.County
  String
  Possible
  County
- Visit.Guarantor.Address.Country
  String
  Possible
  Country
- Visit.Guarantor.PhoneNumber.Home
  String
  Probable
  Home phone number.
  In E. 164 Format (i.e. +16085551234)
- Visit.Guarantor.PhoneNumber.Business
  String
  Probable
  Business phone number.
  In E. 164 Format (i.e. +16085551234)
- Visit.Guarantor.PhoneNumber.Mobile
  String
  Probable
  Mobile phone number.
  In E. 164 Format (i.e. +16085551234)
- Visit.Guarantor.EmailAddresses[]
  Array of Strings
  Probable
  Guarantor's email address(es)
- Visit.Guarantor.Type
  String
  Probable
  Type of guarantor.
  E.g. institution, individual
- Visit.Guarantor.RelationToPatient
  String
  Probable
  Relation to the patient.
  E.g. self, parent
- Visit.Guarantor.Employer.Name
  String
  Probable
  Employer's name
- Visit.Guarantor.Employer.Address
  Object
  Probable
  Employer's address
- Visit.Guarantor.Employer.Address.StreetAddress
  String
  Probable
  Street address
- Visit.Guarantor.Employer.Address.City
  String
  Probable
  City
- Visit.Guarantor.Employer.Address.State
  String
  Probable
  State
- Visit.Guarantor.Employer.Address.ZIP
  String
  Probable
  ZIP
- Visit.Guarantor.Employer.Address.County
  String
  Possible
  County
- Visit.Guarantor.Employer.Address.Country
  String
  Possible
  Country
- Visit.Guarantor.Employer.PhoneNumber
  String
  Probable
  Employer phone number.
  In E. 164 Format (i.e. +16085551234)
- Visit.Insurances[]
  Array of Objects
  Probable
  List of insurance coverages for the patient
- Visit.Insurances[].Plan.ID
  String
  Probable
  Identifier of insurance plan
- Visit.Insurances[].Plan.IDType
  String
  Probable
  ID type of insurance plan
- Visit.Insurances[].Plan.Name
  String
  Probable
  Name of insurance plan
- Visit.Insurances[].Plan.Type
  String
  Possible
  Type of insurance plan
- Visit.Insurances[].MemberNumber
  String
  Possible
  Patient member number
- Visit.Insurances[].Company.ID
  String
  Probable
  ID of insurance company (payor)
- Visit.Insurances[].Company.IDType
  String
  Probable
  ID type of insurance company (payor)
- Visit.Insurances[].Company.Name
  String
  Probable
  Name of insurance company (payor)
- Visit.Insurances[].Company.Address
  Object
  Probable
  Insurance company's address
- Visit.Insurances[].Company.Address.StreetAddress
  String
  Probable
  Street address
- Visit.Insurances[].Company.Address.City
  String
  Probable
  City
- Visit.Insurances[].Company.Address.State
  String
  Probable
  State
- Visit.Insurances[].Company.Address.ZIP
  String
  Probable
  ZIP
- Visit.Insurances[].Company.Address.County
  String
  Possible
  County
- Visit.Insurances[].Company.Address.Country
  String
  Possible
  Country
- Visit.Insurances[].Company.PhoneNumber
  String
  Probable
  Insurance companys phone number.
  In E. 164 Format (i.e. +16085551234)
- Visit.Insurances[].GroupNumber
  String
  Probable
  Insurance policy group number
- Visit.Insurances[].GroupName
  String
  Probable
  Insurance policy group name
- Visit.Insurances[].EffectiveDate
  String
  Probable
  Effect date of this insurance policy.
  In YYYY-MM-DD format
- Visit.Insurances[].ExpirationDate
  String
  Probable
  Expiration date of this insurance policy.
  In YYYY-MM-DD format
- Visit.Insurances[].PolicyNumber
  String
  Probable
  Insurance policy number
- Visit.Insurances[].AgreementType
  String
  Probable
  Type of insurance agreement.
  One of the following: "Standard", "Unified", "Maternity"
- Visit.Insurances[].CoverageType
  String
  Probable
  Type of insurance agreement.
  One of the following: "Patient", "Clinic", "Insurance", "Other". Indicates who will be receiving the bill for the service.
- Visit.Insurances[].Insured
  Object
  Possible
  Individual who has the agreement with the insurance company for the related policy
- Visit.Insurances[].Insured.Identifiers[]
  Array of Objects
  Possible
  List of IDs and ID types that identify the insured
- Visit.Insurances[].Insured.Identifiers[].ID
  String
  Possible
  ID for the insured
- Visit.Insurances[].Insured.Identifiers[].IDType
  String
  Possible
  Type of ID.
  E.g. MRN, EPI
- Visit.Insurances[].Insured.LastName
  String
  Possible
  Last name of the insured
- Visit.Insurances[].Insured.FirstName
  String
  Possible
  First name of the insured
- Visit.Insurances[].Insured.SSN
  String
  Possible
  Insured's social security number
- Visit.Insurances[].Insured.Relationship
  String
  Possible
  Relationship of the insured to the patient.
  One of the following: "Self", "Spouse", "Other".
- Visit.Insurances[].Insured.DOB
  String
  Possible
  Date of birth of the insured.
  In YYYY-MM-DD format
- Visit.Insurances[].Insured.Sex
  String
  Possible
  Sex of the insured
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.Insurances[].Insured.Address
  Object
  Probable
  Address of the insured
- Visit.Insurances[].Insured.Address.StreetAddress
  String
  Probable
  Street address
- Visit.Insurances[].Insured.Address.City
  String
  Probable
  City
- Visit.Insurances[].Insured.Address.State
  String
  Probable
  State
- Visit.Insurances[].Insured.Address.ZIP
  String
  Probable
  ZIP
- Visit.Insurances[].Insured.Address.County
  String
  Possible
  County
- Visit.Insurances[].Insured.Address.Country
  String
  Possible
  Country

resourceType
- resourceType
  string
  Bundle
type
- type
  code
  Currently, Redox supports only the 'Message' Type
entry
- entry
  The entry field corresponds to an array of FHIR Resources. For PatientAdmin, the Message Header and Patient resources are required, and the Practitioner (representing the attending provider) and some Location resources are allowed.
- entry[].fullUrl
  uri
  Absolute URL for resource.
  Ex: server address or UUID/OID.
entry[].resource - MessageHeader
- entry[].resource
  MessageHeader Resource Information
- entry[].resource.id
  id
  Logical id of this artifact
- entry[].resource.resourceType
  string
  MessageHeader
- entry[].resource.event
  Coding
  Code for the event this message represents
- entry[].resource.event.code
  code
- entry[].resource.timestamp
  instant
  Time that the message was sent
- entry[].resource.source
  Message source application
- entry[].resource.source.name
  string
  Name of the source system
- entry[].resource.source.endpoint
  uri
  Actual message source address or id
- entry[].resource.focus
  Reference
  Pointers to the actual content of the message
- entry[].resource.focus[].reference
  string
  References to the rest of the bundle
entry[].resource - Patient
- entry[].resource.resourceType
  string
  Patient
- entry[].resource.identifier
  Identifier
  A list of identifiers for this patient
- entry[].resource.identifier[].value
  string
- entry[].resource.identifier[].system
  string
  Establishes the namespace for the value - that is, a URL that describes a set of values that are unique
- entry[].resource.birthdate
  date
  Data of birth for the patient
- entry[].resource.telecom
  ContactPoint
  A contact detail for the patient
- entry[].resource.telecom[].value
  string
- entry[].resource.telecom[].system
  string
  A contact detail for the patient.
  Redox currently only supports values of phone and email for this field.
- entry[].resource.telecom[].use
  string
  Purpose of the contact point
- entry[].resource.address
  Address
  Address(es) of the patient
- entry[].resource.address[].line[]
  string[]
  Street name, number, direction & P.O. Box etc.
- entry[].resource.address[].city
  string
  Name of city
- entry[].resource.address[].district
  string
  District (county) name
- entry[].resource.address[].state
  string
  Name, or abbreviation, of the state
- entry[].resource.address[].postalCode
  string
  Postal code for the area
- entry[].resource.address[].country
  string
  Country.
  Can be ISO 3166 2 or 3 letter code.
- entry[].resource.address[].use
  string
  The purpose of the address
- entry[].resource.name
  HumanName
  Required
  A list of names associated with the patient
- entry[].resource.name[].family
  string
  Often called 'Surname.'
- entry[].resource.name[].given[]
  string[]
- entry[].resource.gender
  string
  Required
  Administrative gender for the patient.
  The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. One of male, female, other, or unknown.
- entry[].resource.maritalStatus
  CodeableConcept
  Marital Status of a patient
- entry[].resource.maritalStatus.text
  string
- entry[].resource.extension
  Extension
  Additional Content defined by implementations
- entry[].resource.extension[].url
  string
- entry[].resource.extension[].extension
  Extension
- entry[].resource.extension[].extension[].url
  string
- entry[].resource.extension[].extension[].valueString
  string
- entry[].resource.communication
  A list of languages which may be used to communicate with the patient.
- entry[].resource.communication[].language
  CodeableConcept
- entry[].resource.communication[].language.text
  string
- entry[].resource.communication[].language.coding
  Coding
- entry[].resource.communication[].language.coding.code
  code
  Symbol defined by the system
- entry[].resource.communication[].language.coding.system
  uri
  Identity/namespace of the terminology system
- entry[].resource.communication[].language.coding.display
  string
  Display value of the code, as defined by the system
entry[].resource - Practitioner
- entry[].resource.resourceType
  string
  Practitioner
- entry[].resource.active
  boolean
  Whether this practitioner's record is in active use
- entry[].resource.identifier
  Identifier
  Required
  A list of identifiers that apply to this person in this role
- entry[].resource.identifier[].value
  string
  Unique value identifier
- entry[].resource.identifier[].system
  string
  Establishes the namespace for the value - that is, a URL that describes a set of values that are unique
- entry[].resource.telecom
  ContactPoint
  Contact information for the practitioner
- entry[].resource.telecom[].value
  string
  Actual contact point details
- entry[].resource.telecom[].system
  string
  A contact detail for the practitioner (that apply to all roles).
  Redox currently only supports values of phone and email for this field.
- entry[].resource.telecom[].use
  string
  Purpose of the contact point
- entry[].resource.address
  Address
  Address(es) of the practitioner.
  Address(es) are not role specific.
- entry[].resource.address[].line[]
  string[]
  Street name, number, direction & P.O. Box etc.
- entry[].resource.address[].city
  string
  Name of city
- entry[].resource.address[].district
  string
  District (county) name
- entry[].resource.address[].state
  string
  Name, or abbreviation, of the state
- entry[].resource.address[].postalCode
  string
  Postal code for the area
- entry[].resource.address[].country
  string
  Country.
  Can be ISO 3166 2 or 3 letter code.
- entry[].resource.address[].use
  string
  Required
  The purpose of the address
- entry[].resource.name
  HumanName
  Required
  The name(s) associated with the practitioner.
- entry[].resource.name[].family
  string
  Family name.
  Often called 'Surname.'
- entry[].resource.name[].given[]
  string[]
  Given names (not always 'first'). Includes middle names.
  Given names appear in the correct order for presenting the name.
- entry[].resource.qualification
  Qualifications obtained by training and certification.
- entry[].resource.qualification[].code
  CodeableConcept
  Coded representation of the qualification.
- entry[].resource.qualification[].code.text
  string
  Text representation of the qualification.
- entry[].resource.qualification[].code.coding
  Coding
- entry[].resource.qualification[].code.coding.code
  code
  Symbol defined by the system
- entry[].resource.qualification[].code.coding.system
  uri
  Identity/namespace of the terminology system
- entry[].resource.qualification[].code.coding.display
  string
  Display value of the code, as defined by the system

Sample MessageDownload JSON Schema

{
   "resourceType": "Bundle",
   "type": "message",
   "entry": [
      {
         "fullUrl": "urn:uuid:64288ed0-a47c-495a-b4d7-120aa3e68862",
         "resource": {
            "id": "transmission-12414",
            "resourceType": "MessageHeader",
            "event": {
               "code": "PatientAdmin-Arrival"
            },
            "timestamp": "2019-05-10T17:23:19.864Z",
            "source": {
               "name": "Redox Dev Tools",
               "endpoint": "urn:uuid:7ce6f387-c33c-417d-8682-81e83628cbd9"
            },
            "focus": [
               {
                  "reference": "urn:uuid:0004da24-c295-4b44-8f31-24f973522c1b"
               },
               {
                  "reference": "urn:uuid:42a77a26-fd28-4c47-bd21-6f8889ac7bca"
               }
            ]
         }
      },
      {
         "fullUrl": "urn:uuid:0004da24-c295-4b44-8f31-24f973522c1b",
         "resource": {
            "resourceType": "Patient",
            "identifier": [
               {
                  "value": "0000000001",
                  "system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:MR"
               },
               {
                  "value": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
                  "system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:EHRID"
               },
               {
                  "value": "a1d4ee8aba494ca",
                  "system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:NIST"
               },
               {
                  "value": "101-01-0001",
                  "system": "http://hl7.org/fhir/sid/us-ssn"
               }
            ],
            "birthDate": "2008-01-06",
            "telecom": [
               {
                  "value": "+18088675301",
                  "system": "phone",
                  "use": "home"
               }
            ],
            "address": [
               {
                  "line": [
                     "4762 Hickory Street"
                  ],
                  "city": "Monroe",
                  "district": "Green",
                  "state": "WI",
                  "postalCode": "53566",
                  "country": "US",
                  "use": "home"
               }
            ],
            "name": [
               {
                  "family": "Bixby",
                  "given": [
                     "Timothy",
                     "Paul"
                  ]
               }
            ],
            "gender": "male",
            "maritalStatus": {
               "text": "Married",
               "coding": [
                  {
                     "code": "M",
                     "system": "http://hl7.org/fhir/v3/MaritalStatus",
                     "display": "Married"
                  }
               ]
            },
            "extension": [
               {
                  "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
                  "extension": [
                     {
                        "url": "text",
                        "valueString": "White"
                     }
                  ]
               }
            ],
            "communication": [
               {
                  "language": {
                     "text": "en",
                     "coding": [
                        {
                           "code": "en",
                           "system": "urn:ietf:bcp:47"
                        }
                     ]
                  }
               }
            ],
            "contact": [
               {
                  "name": {
                     "family": "Bixby",
                     "given": [
                        "Barbara"
                     ]
                  },
                  "address": {
                     "line": [
                        "4762 Hickory Street"
                     ],
                     "city": "Monroe",
                     "district": "Green",
                     "state": "WI",
                     "postalCode": "53566",
                     "country": "US"
                  },
                  "telecom": [
                     {
                        "value": "+18088675303",
                        "system": "phone",
                        "use": "home"
                     },
                     {
                        "value": "+17077543758",
                        "system": "phone",
                        "use": "work"
                     },
                     {
                        "value": "+19189368865",
                        "system": "phone",
                        "use": "mobile"
                     },
                     {
                        "value": "barb.bixby@test.net",
                        "system": "email"
                     }
                  ],
                  "relationship": [
                     {
                        "text": "Mother",
                        "coding": [
                           {
                              "code": "MTH",
                              "system": "http://hl7.org/fhir/v3/RoleCode",
                              "display": "mother"
                           }
                        ]
                     },
                     {
                        "text": "Emergency Contact",
                        "coding": [
                           {
                              "code": "C",
                              "system": "http://hl7.org/fhir/v2/0131",
                              "display": "Emergency Contact"
                           }
                        ]
                     }
                  ]
               }
            ],
            "generalPractitioner": [
               {
                  "reference": "urn:uuid:42a77a26-fd28-4c47-bd21-6f8889ac7bca"
               }
            ]
         }
      },
      {
         "fullUrl": "urn:uuid:42a77a26-fd28-4c47-bd21-6f8889ac7bca",
         "resource": {
            "resourceType": "Practitioner",
            "active": true,
            "identifier": [
               {
                  "value": "4356789876",
                  "system": "http://hl7.org/fhir/sid/us-npi"
               }
            ],
            "telecom": [
               {
                  "value": "+16085551234",
                  "system": "phone",
                  "use": "work"
               }
            ],
            "address": [
               {
                  "line": [
                     "123 Main St."
                  ],
                  "city": "Madison",
                  "district": "Dane",
                  "state": "WI",
                  "postalCode": "53703",
                  "country": "USA"
               }
            ],
            "name": [
               {
                  "family": "Granite",
                  "given": [
                     "Pat"
                  ]
               }
            ],
            "qualification": [
               {
                  "code": {
                     "text": "MD",
                     "coding": [
                        {
                           "code": "MD",
                           "system": "http://hl7.org/fhir/v2/0360/2.7",
                           "display": "Doctor of Medicine"
                        }
                     ]
                  }
               }
            ]
         }
      }
   ]
}

{
   "Meta": {
      "DataModel": "PatientAdmin",
      "EventType": "Arrival",
      "EventDateTime": "2019-05-10T17:23:19.864Z",
      "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": [
               "barb.bixby@test.net"
            ],
            "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"
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         }
      }
   },
   "Visit": {
      "VisitNumber": "1234",
      "AccountNumber": null,
      "PatientClass": "Inpatient",
      "VisitDateTime": "2019-05-10T17:23:20.736Z",
      "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"
         },
         "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
         },
         "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
         },
         "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
         },
         "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",
         "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 Deductable 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,
               "FirstName": null,
               "SSN": null,
               "Relationship": null,
               "DOB": null,
               "Sex": null,
               "Address": {
                  "StreetAddress": null,
                  "City": null,
                  "State": null,
                  "ZIP": null,
                  "County": null,
                  "Country": null
               }
            }
         }
      ]
   }
}

CancelBETA

View R^FHIR Event Type

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

Show Required Fields Only

Meta
- Meta.DataModel
  String
  Reliable
  Required
  Data model.
  E.g. Scheduling, Results
- Meta.EventType
  String
  Reliable
  Required
  Type of event.
  Cancel
- Meta.EventDateTime
  DateTime
  Reliable
  DateTime of the event.
  DateTime of the cancelation
- Meta.CanceledEvent
  String
  Reliable
  Type of event being canceled.
  E.g. Arrival, Discharge, PreAdmit
- Meta.Test
  Boolean
  Reliable
  Flag as a test message
- Meta.Source
  String
  Reliable
  Where the message originated.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  ID of the source.
  UUID
- Meta.Source.Name
  String
  Reliable
  Name of the source
- Meta.Destinations[]
  Array of Objects
  Reliable
  List of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
  Required when sending data to Redox
- Meta.Destinations[].ID
  String
  Reliable
  ID of the destination.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Name of the destination
- Meta.Message
  String
  Reliable
  Record in Redox that corresponds to the communication sent from the source to Redox.
  Included in messages from Redox
- Meta.Message.ID
  Numeric
  Reliable
  ID of the message created in Redox
- Meta.Transmission
  String
  Reliable
  Record in Redox that corresponds to the communication sent from Redox to your destination.
  Included in messages from Redox
- Meta.Transmission.ID
  Numeric
  Reliable
  ID of the transmission created in Redox
- Meta.FacilityCode
  String
  Possible
  Code for the facility related to the message.
  Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
- Patient.Identifiers[]
  Array of Objects
  Reliable
  List of IDs and ID types that identify the patient
- Patient.Identifiers[].ID
  String
  Reliable
  Required
  ID for the patient
- Patient.Identifiers[].IDType
  String
  Reliable
  Required
  Type of ID.
  E.g. MRN, EPI
- Patient.Demographics.FirstName
  String
  Reliable
  Patient's first name
- Patient.Demographics.MiddleName
  String
  Possible
  Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
- Patient.Demographics.LastName
  String
  Reliable
  Patient's last name
- Patient.Demographics.DOB
  String
  Reliable
  Patient's date of birth.
  In ISO 8601 format
- Patient.Demographics.SSN
  String
  Probable
  Patient's social security number
- Patient.Demographics.Sex
  String
  Reliable
  Patient's sex
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Race
  String
  Possible
  Patient's race.
  Supported Values
- Patient.Demographics.IsHispanic
  Boolean
  Possible
  Indicates if the patient is of hispanic origin.
- Patient.Demographics.MaritalStatus
  String
  Possible
  Patient's marital status
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.IsDeceased
  Boolean
  Possible
  Indicates if the patient is deceased
- Patient.Demographics.DeathDateTime
  DateTime
  Possible
  Date and Time the patient was proclaimed deceased.
  ISO 8601 Format
- Patient.Demographics.PhoneNumber.Home
  String
  Probable
  Patient's home phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Office
  String
  Probable
  Patient's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Mobile
  String
  Probable
  Patient's mobile phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.EmailAddresses[]
  Array of Strings
  Probable
  Patient's email address(es)
- Patient.Demographics.Language
  String
  Possible
  Patient's primary spoken language.
  In ISO 639-1 alpha values (e.g. 'en'). Supported Values
- Patient.Demographics.Citizenship[]
  Array of strings
  Possible
  Patient's nation(s) of citizenship.
  *In ISO 3166 alpha 2 format (e.g. 'US'). Reference Table.
  
  Note: The valid set of citizenships is a smaller list than the list of IS0 3166 country codes, and should be limited to the 193 United Nations countries plus 6 states: ROC Taiwan, Macao (SAR China), Hong Kong (SAR China), Kosovo, Palestinian Territory and the Vatican.*
- Patient.Demographics.Address
  Object
  Probable
  Patient's home address
- Patient.Demographics.Address.StreetAddress
  String
  Probable
  Street address
- Patient.Demographics.Address.City
  String
  Probable
  City
- Patient.Demographics.Address.State
  String
  Probable
  State
- Patient.Demographics.Address.ZIP
  String
  Probable
  ZIP
- Patient.Demographics.Address.County
  String
  Possible
  County
- Patient.Demographics.Address.Country
  String
  Possible
  Country
- Patient.Notes[]
  Array of strings
  Possible
  Patient-level notes
- Patient.Contacts[].FirstName
  String
  Possible
  First name of the contact
- Patient.Contacts[].MiddleName
  String
  Possible
  Middle name of the contact
- Patient.Contacts[].LastName
  String
  Possible
  Last name of the contact
- Patient.Contacts[].Address
  Object
  Possible
  Address of the contact
- Patient.Contacts[].Address.StreetAddress
  String
  Possible
  Street address
- Patient.Contacts[].Address.City
  String
  Possible
  City
- Patient.Contacts[].Address.State
  String
  Possible
  State
- Patient.Contacts[].Address.ZIP
  String
  Possible
  ZIP
- Patient.Contacts[].Address.County
  String
  Possible
  County
- Patient.Contacts[].Address.Country
  String
  Possible
  Country
- Patient.Contacts[].PhoneNumber.Home
  String
  Possible
  Home phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Contacts[].PhoneNumber.Office
  String
  Possible
  Office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Contacts[].PhoneNumber.Mobile
  String
  Probable
  Mobile phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Contacts[].RelationToPatient
  String
  Possible
  Personal relationship to the patient.
  e.x. Father, Spouse
- Patient.Contacts[].EmailAddresses[]
  Array of string
  Possible
  Email address(es) of the contact person
- Patient.Contacts[].Roles[]
  Array of strings
  Possible
  Role of this contact for the patient.
  e.x. Employer, Emergency Contact
- Patient.Diagnoses[]
  Array of Objects
  Probable
  List of diagnoses associated with this visit
- Patient.Diagnoses[].Code
  String
  Probable
  Code for the diagnosis
- Patient.Diagnoses[].Codeset
  String
  Probable
  Code set used to identify the diagnosis.
  One of the following: ICD-9, ICD-10, HCPCS, CPT
- Patient.Diagnoses[].Name
  String
  Probable
  Name of the diagnosis
- Patient.Diagnoses[].Type
  String
  Possible
  Type of the diagnosis.
  One of the following: Admitting, Working, or Final
- Patient.Diagnoses[].DocumentedDateTime
  String
  Possible
  DateTime the diagnosis was documented.
  ISO 8601 Format
- Patient.Allergies[]
  Array of Objects
  Possible
  List of a patient's allergies
- Patient.Allergies[].Code
  String
  Possible
  Code for the allergy
- Patient.Allergies[].Codeset
  String
  Possible
  Code set used to identify the allergy.
  Typically RxNorm or SNOMED
- Patient.Allergies[].Name
  String
  Possible
  Name of the allergy
- Patient.Allergies[].Type
  Object
  Possible
  The type of allergy intolerance (food, drug, etc.)
- Patient.Allergies[].Type.Code
  String
  Possible
  Code for the allergy intolerance type
- Patient.Allergies[].Type.Codeset
  String
  Possible
  Code set used to identify the allergy intolerance type
- Patient.Allergies[].Type.Name
  String
  Possible
  Name of the allergy intolerance type
- Patient.Allergies[].OnsetDateTime
  String
  Possible
  DateTime the allergy was identified
- Patient.Allergies[].Reaction[]
  Array of Objects
  Possible
  The list of reactions caused by this particular allergy.
- Patient.Allergies[].Reaction[].Code
  String
  Possible
  Code for the reaction
- Patient.Allergies[].Reaction[].Codeset
  String
  Possible
  Code set used to identify the reaction
- Patient.Allergies[].Reaction[].Name
  String
  Possible
  Name of the reaction
- Patient.Allergies[].Severity
  Object
  Possible
  The severity of the reaction (moderate, severe, etc.).
- Patient.Allergies[].Severity.Code
  String
  Possible
  Code for the reaction severity
- Patient.Allergies[].Severity.Codeset
  String
  Possible
  Code set used to identify the reaction severity
- Patient.Allergies[].Severity.Name
  String
  Possible
  Name of the reaction severity
- Patient.Allergies[].Status
  string
  Possible
  The current status of the allergy.
  One of the following: "Active", "Inactive", "Resolved".
- Patient.PCP
  Object
  Reliable
  Primary Care Provider for the Patient
- Patient.PCP.NPI
  String
  Reliable
  NPI of the PCP
- Patient.PCP.ID
  String
  Reliable
  ID of the PCP.
  This ID is often required for Inpatient Visits.
- Patient.PCP.IDType
  String
  Reliable
  ID type of the ID for the PCP
- Patient.PCP.FirstName
  String
  Possible
  First name of the PCP
- Patient.PCP.LastName
  String
  Possible
  Last name of the PCP
- Patient.PCP.Credentials[]
  Array of Strings
  Possible
  List of credentials for the PCP.
  e.g. MD, PhD
- Patient.PCP.Address
  Object
  Possible
  Provider's address
- Patient.PCP.Address.StreetAddress
  String
  Possible
  Street address
- Patient.PCP.Address.City
  String
  Possible
  City
- Patient.PCP.Address.State
  String
  Possible
  State
- Patient.PCP.Address.ZIP
  String
  Possible
  ZIP
- Patient.PCP.Address.County
  String
  Possible
  County
- Patient.PCP.Address.Country
  String
  Possible
  Country
- Patient.PCP.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.PCP.Location
  Object
  Possible
  Provider's location
- Patient.PCP.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Patient.PCP.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Patient.PCP.Location.Department
  String
  Possible
  Department
- Patient.PCP.Location.Room
  String
  Possible
  Room.
  Example: 136
Visit
- Visit.VisitNumber
  String
  Reliable
  Visit Number.
  Unique ID of a single visit
- Visit.AccountNumber
  String
  Possible
  Account Number.
  An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
- Visit.PatientClass
  String
  Reliable
  Required
  Patient class is used in many EHRs to determine where to put the patient.
  Examples: Inpatient, Outpatient, Emergency
- Visit.VisitDateTime
  String
  Reliable
  DateTime of visit or the arrival time of the admission.
  ISO 8601 Format
- Visit.Duration
  Numeric
  Probable
  Length of visit.
  In minutes
- Visit.Reason
  String
  Probable
  Reason for visit
- Visit.Instructions[]
  Array of Strings
  Probable
  Appointment instructions
- Visit.Balance
  Numeric
  Possible
  Patient 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
  Possible
  Diagnosis Related Group for this visit
- Visit.DiagnosisRelatedGroupType
  Numeric
  Possible
  Type 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
  Reliable
  The provider primarily responsible for a patient's care during a visit
- Visit.AttendingProvider.ID
  String
  Probable
  ID of the attending provider.
  This ID is often required for Inpatient Visits.
- Visit.AttendingProvider.IDType
  String
  Probable
  ID type of the ID for the attending provider
- Visit.AttendingProvider.FirstName
  String
  Possible
  First name of the attending provider
- Visit.AttendingProvider.LastName
  String
  Possible
  Last name of the attending provider
- Visit.AttendingProvider.Credentials[]
  Array of Strings
  Possible
  List of credentials for the attending provider.
  e.g. MD, PhD
- Visit.AttendingProvider.Address
  Object
  Possible
  Provider's address
- Visit.AttendingProvider.Address.StreetAddress
  String
  Possible
  Street address
- Visit.AttendingProvider.Address.City
  String
  Possible
  City
- Visit.AttendingProvider.Address.State
  String
  Possible
  State
- Visit.AttendingProvider.Address.ZIP
  String
  Possible
  ZIP
- Visit.AttendingProvider.Address.County
  String
  Possible
  County
- Visit.AttendingProvider.Address.Country
  String
  Possible
  Country
- Visit.AttendingProvider.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Visit.AttendingProvider.Location
  Object
  Possible
  Provider's location
- Visit.AttendingProvider.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.AttendingProvider.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Visit.AttendingProvider.Location.Department
  String
  Possible
  Department
- Visit.AttendingProvider.Location.Room
  String
  Possible
  Room.
  Example: 136
- Visit.ConsultingProvider
  Object
  Reliable
  A provider, usually a specialist, that evaluates or treats a patient to address a specific problem
- Visit.ConsultingProvider.ID
  String
  Possible
  ID of the consulting provider.
  This ID is often required for Inpatient Visits.
- Visit.ConsultingProvider.IDType
  String
  Possible
  ID type of the ID for the consulting provider
- Visit.ConsultingProvider.FirstName
  String
  Possible
  First name of the consulting provider
- Visit.ConsultingProvider.LastName
  String
  Possible
  Last name of the consulting provider
- Visit.ConsultingProvider.Credentials[]
  Array of Strings
  Possible
  List of credentials for the consulting provider.
  e.g. MD, PhD
- Visit.ConsultingProvider.Address
  Object
  Possible
  Provider's address
- Visit.ConsultingProvider.Address.StreetAddress
  String
  Possible
  Street address
- Visit.ConsultingProvider.Address.City
  String
  Possible
  City
- Visit.ConsultingProvider.Address.State
  String
  Possible
  State
- Visit.ConsultingProvider.Address.ZIP
  String
  Possible
  ZIP
- Visit.ConsultingProvider.Address.County
  String
  Possible
  County
- Visit.ConsultingProvider.Address.Country
  String
  Possible
  Country
- Visit.ConsultingProvider.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Visit.ConsultingProvider.Location
  Object
  Possible
  Provider's location
- Visit.ConsultingProvider.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.ConsultingProvider.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Visit.ConsultingProvider.Location.Department
  String
  Possible
  Department
- Visit.ConsultingProvider.Location.Room
  String
  Possible
  Room.
  Example: 136
- Visit.ReferringProvider
  Object
  Reliable
  The provider that requested a patient to see a consulting provider
- Visit.ReferringProvider.ID
  String
  Possible
  ID of the referring provider.
  This ID is often required for Inpatient Visits.
- Visit.ReferringProvider.IDType
  String
  Possible
  ID type of the ID for the referring provider
- Visit.ReferringProvider.FirstName
  String
  Possible
  First name of the referring provider
- Visit.ReferringProvider.LastName
  String
  Possible
  Last name of the referring provider
- Visit.ReferringProvider.Credentials[]
  Array of Strings
  Possible
  List of credentials for the referring provider.
  e.g. MD, PhD
- Visit.ReferringProvider.Address
  Object
  Possible
  Provider's address
- Visit.ReferringProvider.Address.StreetAddress
  String
  Possible
  Street address
- Visit.ReferringProvider.Address.City
  String
  Possible
  City
- Visit.ReferringProvider.Address.State
  String
  Possible
  State
- Visit.ReferringProvider.Address.ZIP
  String
  Possible
  ZIP
- Visit.ReferringProvider.Address.County
  String
  Possible
  County
- Visit.ReferringProvider.Address.Country
  String
  Possible
  Country
- Visit.ReferringProvider.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Visit.ReferringProvider.Location
  Object
  Possible
  Provider's location
- Visit.ReferringProvider.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.ReferringProvider.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Visit.ReferringProvider.Location.Department
  String
  Possible
  Department
- Visit.ReferringProvider.Location.Room
  String
  Possible
  Room.
  Example: 136
- Visit.AdmittingProvider
  Object
  Reliable
  The MD/DO that made the decision to admit the patient. Not always the same as attending provider
- Visit.AdmittingProvider.ID
  String
  Reliable
  ID of the admitting provider.
  This ID is often required for Inpatient Visits.
- Visit.AdmittingProvider.IDType
  String
  Reliable
  ID type of the ID for the admitting provider
- Visit.AdmittingProvider.FirstName
  String
  Possible
  First name of the admitting provider
- Visit.AdmittingProvider.LastName
  String
  Possible
  Last name of the admitting provider
- Visit.AdmittingProvider.Credentials[]
  Array of Strings
  Possible
  List of credentials for the admitting provider.
  e.g. MD, PhD
- Visit.AdmittingProvider.Address
  Object
  Possible
  Provider's address
- Visit.AdmittingProvider.Address.StreetAddress
  String
  Possible
  Street address
- Visit.AdmittingProvider.Address.City
  String
  Possible
  City
- Visit.AdmittingProvider.Address.State
  String
  Possible
  State
- Visit.AdmittingProvider.Address.ZIP
  String
  Possible
  ZIP
- Visit.AdmittingProvider.Address.County
  String
  Possible
  County
- Visit.AdmittingProvider.Address.Country
  String
  Possible
  Country
- Visit.AdmittingProvider.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Visit.AdmittingProvider.Location
  Object
  Possible
  Provider's location
- Visit.AdmittingProvider.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.AdmittingProvider.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Visit.AdmittingProvider.Location.Department
  String
  Possible
  Department
- Visit.AdmittingProvider.Location.Room
  String
  Possible
  Room.
  Example: 136
- Visit.Location
  Object
  Probable
  Location of the appointment
- Visit.Location.Type
  String
  Probable
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.Location.Facility
  String
  Probable
  Facility.
  Example: Community Hospital
- Visit.Location.Department
  String
  Probable
  Department
- Visit.Location.Room
  String
  Probable
  Room.
  Example: 136
- Visit.Location.Bed
  String
  Probable
  Bed.
  Example: B
- Visit.Location.Address
  Object
  Probable
  Address of the appointment location
- Visit.Location.Address.StreetAddress
  String
  Probable
  Street address
- Visit.Location.Address.City
  String
  Probable
  City
- Visit.Location.Address.State
  String
  Probable
  State
- Visit.Location.Address.ZIP
  String
  Probable
  ZIP
- Visit.Location.Address.County
  String
  Possible
  County
- Visit.Location.Address.Country
  String
  Possible
  Country
- Visit.Guarantor
  Object
  Possible
  Person ultimately responsible for the bill of the appointment
- Visit.Guarantor.Number
  String
  Probable
  Number of the guarantor
- Visit.Guarantor.FirstName
  String
  Probable
  First name
- Visit.Guarantor.LastName
  String
  Probable
  Last name
- Visit.Guarantor.SSN
  String
  Possible
  Guarantor's social security number
- Visit.Guarantor.DOB
  String
  Possible
  Guarantor's date of birth.
  In ISO 8601 format
- Visit.Guarantor.Sex
  String
  Possible
  Guarantor's sex
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.Guarantor.Spouse.FirstName
  String
  Probable
  Spouse's first name
- Visit.Guarantor.Spouse.LastName
  String
  Probable
  Spouse's last name
- Visit.Guarantor.Address
  Object
  Probable
  Address of the guarantor
- Visit.Guarantor.Address.StreetAddress
  String
  Probable
  Street address
- Visit.Guarantor.Address.City
  String
  Probable
  City
- Visit.Guarantor.Address.State
  String
  Probable
  State
- Visit.Guarantor.Address.ZIP
  String
  Probable
  ZIP
- Visit.Guarantor.Address.County
  String
  Possible
  County
- Visit.Guarantor.Address.Country
  String
  Possible
  Country
- Visit.Guarantor.PhoneNumber.Home
  String
  Probable
  Home phone number.
  In E. 164 Format (i.e. +16085551234)
- Visit.Guarantor.PhoneNumber.Business
  String
  Probable
  Business phone number.
  In E. 164 Format (i.e. +16085551234)
- Visit.Guarantor.PhoneNumber.Mobile
  String
  Probable
  Mobile phone number.
  In E. 164 Format (i.e. +16085551234)
- Visit.Guarantor.EmailAddresses[]
  Array of Strings
  Probable
  Guarantor's email address(es)
- Visit.Guarantor.Type
  String
  Probable
  Type of guarantor.
  E.g. institution, individual
- Visit.Guarantor.RelationToPatient
  String
  Probable
  Relation to the patient.
  E.g. self, parent
- Visit.Guarantor.Employer.Name
  String
  Probable
  Employer's name
- Visit.Guarantor.Employer.Address
  Object
  Probable
  Employer's address
- Visit.Guarantor.Employer.Address.StreetAddress
  String
  Probable
  Street address
- Visit.Guarantor.Employer.Address.City
  String
  Probable
  City
- Visit.Guarantor.Employer.Address.State
  String
  Probable
  State
- Visit.Guarantor.Employer.Address.ZIP
  String
  Probable
  ZIP
- Visit.Guarantor.Employer.Address.County
  String
  Possible
  County
- Visit.Guarantor.Employer.Address.Country
  String
  Possible
  Country
- Visit.Guarantor.Employer.PhoneNumber
  String
  Probable
  Employer phone number.
  In E. 164 Format (i.e. +16085551234)
- Visit.Insurances[]
  Array of Objects
  Probable
  List of insurance coverages for the patient
- Visit.Insurances[].Plan.ID
  String
  Probable
  Identifier of insurance plan
- Visit.Insurances[].Plan.IDType
  String
  Probable
  ID type of insurance plan
- Visit.Insurances[].Plan.Name
  String
  Probable
  Name of insurance plan
- Visit.Insurances[].Plan.Type
  String
  Possible
  Type of insurance plan
- Visit.Insurances[].MemberNumber
  String
  Possible
  Patient member number
- Visit.Insurances[].Company.ID
  String
  Probable
  ID of insurance company (payor)
- Visit.Insurances[].Company.IDType
  String
  Probable
  ID type of insurance company (payor)
- Visit.Insurances[].Company.Name
  String
  Probable
  Name of insurance company (payor)
- Visit.Insurances[].Company.Address
  Object
  Probable
  Insurance company's address
- Visit.Insurances[].Company.Address.StreetAddress
  String
  Probable
  Street address
- Visit.Insurances[].Company.Address.City
  String
  Probable
  City
- Visit.Insurances[].Company.Address.State
  String
  Probable
  State
- Visit.Insurances[].Company.Address.ZIP
  String
  Probable
  ZIP
- Visit.Insurances[].Company.Address.County
  String
  Possible
  County
- Visit.Insurances[].Company.Address.Country
  String
  Possible
  Country
- Visit.Insurances[].Company.PhoneNumber
  String
  Probable
  Insurance companys phone number.
  In E. 164 Format (i.e. +16085551234)
- Visit.Insurances[].GroupNumber
  String
  Probable
  Insurance policy group number
- Visit.Insurances[].GroupName
  String
  Probable
  Insurance policy group name
- Visit.Insurances[].EffectiveDate
  String
  Probable
  Effect date of this insurance policy.
  In YYYY-MM-DD format
- Visit.Insurances[].ExpirationDate
  String
  Probable
  Expiration date of this insurance policy.
  In YYYY-MM-DD format
- Visit.Insurances[].PolicyNumber
  String
  Probable
  Insurance policy number
- Visit.Insurances[].AgreementType
  String
  Probable
  Type of insurance agreement.
  One of the following: "Standard", "Unified", "Maternity"
- Visit.Insurances[].CoverageType
  String
  Probable
  Type of insurance agreement.
  One of the following: "Patient", "Clinic", "Insurance", "Other". Indicates who will be receiving the bill for the service.
- Visit.Insurances[].Insured
  Object
  Possible
  Individual who has the agreement with the insurance company for the related policy
- Visit.Insurances[].Insured.Identifiers[]
  Array of Objects
  Possible
  List of IDs and ID types that identify the insured
- Visit.Insurances[].Insured.Identifiers[].ID
  String
  Possible
  ID for the insured
- Visit.Insurances[].Insured.Identifiers[].IDType
  String
  Possible
  Type of ID.
  E.g. MRN, EPI
- Visit.Insurances[].Insured.LastName
  String
  Possible
  Last name of the insured
- Visit.Insurances[].Insured.FirstName
  String
  Possible
  First name of the insured
- Visit.Insurances[].Insured.SSN
  String
  Possible
  Insured's social security number
- Visit.Insurances[].Insured.Relationship
  String
  Possible
  Relationship of the insured to the patient.
  One of the following: "Self", "Spouse", "Other".
- Visit.Insurances[].Insured.DOB
  String
  Possible
  Date of birth of the insured.
  In YYYY-MM-DD format
- Visit.Insurances[].Insured.Sex
  String
  Possible
  Sex of the insured
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.Insurances[].Insured.Address
  Object
  Probable
  Address of the insured
- Visit.Insurances[].Insured.Address.StreetAddress
  String
  Probable
  Street address
- Visit.Insurances[].Insured.Address.City
  String
  Probable
  City
- Visit.Insurances[].Insured.Address.State
  String
  Probable
  State
- Visit.Insurances[].Insured.Address.ZIP
  String
  Probable
  ZIP
- Visit.Insurances[].Insured.Address.County
  String
  Possible
  County
- Visit.Insurances[].Insured.Address.Country
  String
  Possible
  Country

resourceType
- resourceType
  string
  Bundle
type
- type
  code
  Currently, Redox supports only the 'Message' Type
entry
- entry
  The entry field corresponds to an array of FHIR Resources. For PatientAdmin, the Message Header and Patient resources are required, and the Practitioner (representing the attending provider) and some Location resources are allowed.
- entry[].fullUrl
  uri
  Absolute URL for resource.
  Ex: server address or UUID/OID.
entry[].resource - MessageHeader
- entry[].resource
  MessageHeader Resource Information
- entry[].resource.id
  id
  Logical id of this artifact
- entry[].resource.resourceType
  string
  MessageHeader
- entry[].resource.event
  Coding
  Code for the event this message represents
- entry[].resource.event.code
  code
- entry[].resource.timestamp
  instant
  Time that the message was sent
- entry[].resource.source
  Message source application
- entry[].resource.source.name
  string
  Name of the source system
- entry[].resource.source.endpoint
  uri
  Actual message source address or id
- entry[].resource.focus
  Reference
  Pointers to the actual content of the message
- entry[].resource.focus[].reference
  string
  References to the rest of the bundle
entry[].resource - Patient
- entry[].resource.resourceType
  string
  Patient
- entry[].resource.identifier
  Identifier
  A list of identifiers for this patient
- entry[].resource.identifier[].value
  string
- entry[].resource.identifier[].system
  string
  Establishes the namespace for the value - that is, a URL that describes a set of values that are unique
- entry[].resource.birthdate
  date
  Data of birth for the patient
- entry[].resource.telecom
  ContactPoint
  A contact detail for the patient
- entry[].resource.telecom[].value
  string
- entry[].resource.telecom[].system
  string
  A contact detail for the patient.
  Redox currently only supports values of phone and email for this field.
- entry[].resource.telecom[].use
  string
  Purpose of the contact point
- entry[].resource.address
  Address
  Address(es) of the patient
- entry[].resource.address[].line[]
  string[]
  Street name, number, direction & P.O. Box etc.
- entry[].resource.address[].city
  string
  Name of city
- entry[].resource.address[].district
  string
  District (county) name
- entry[].resource.address[].state
  string
  Name, or abbreviation, of the state
- entry[].resource.address[].postalCode
  string
  Postal code for the area
- entry[].resource.address[].country
  string
  Country.
  Can be ISO 3166 2 or 3 letter code.
- entry[].resource.address[].use
  string
  The purpose of the address
- entry[].resource.name
  HumanName
  Required
  A list of names associated with the patient
- entry[].resource.name[].family
  string
  Often called 'Surname.'
- entry[].resource.name[].given[]
  string[]
- entry[].resource.gender
  string
  Required
  Administrative gender for the patient.
  The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. One of male, female, other, or unknown.
- entry[].resource.maritalStatus
  CodeableConcept
  Marital Status of a patient
- entry[].resource.maritalStatus.text
  string
- entry[].resource.extension
  Extension
  Additional Content defined by implementations
- entry[].resource.extension[].url
  string
- entry[].resource.extension[].extension
  Extension
- entry[].resource.extension[].extension[].url
  string
- entry[].resource.extension[].extension[].valueString
  string
- entry[].resource.communication
  A list of languages which may be used to communicate with the patient.
- entry[].resource.communication[].language
  CodeableConcept
- entry[].resource.communication[].language.text
  string
- entry[].resource.communication[].language.coding
  Coding
- entry[].resource.communication[].language.coding.code
  code
  Symbol defined by the system
- entry[].resource.communication[].language.coding.system
  uri
  Identity/namespace of the terminology system
- entry[].resource.communication[].language.coding.display
  string
  Display value of the code, as defined by the system
entry[].resource - Practitioner
- entry[].resource.resourceType
  string
  Practitioner
- entry[].resource.active
  boolean
  Whether this practitioner's record is in active use
- entry[].resource.identifier
  Identifier
  Required
  A list of identifiers that apply to this person in this role
- entry[].resource.identifier[].value
  string
  Unique value identifier
- entry[].resource.identifier[].system
  string
  Establishes the namespace for the value - that is, a URL that describes a set of values that are unique
- entry[].resource.telecom
  ContactPoint
  Contact information for the practitioner
- entry[].resource.telecom[].value
  string
  Actual contact point details
- entry[].resource.telecom[].system
  string
  A contact detail for the practitioner (that apply to all roles).
  Redox currently only supports values of phone and email for this field.
- entry[].resource.telecom[].use
  string
  Purpose of the contact point
- entry[].resource.address
  Address
  Address(es) of the practitioner.
  Address(es) are not role specific.
- entry[].resource.address[].line[]
  string[]
  Street name, number, direction & P.O. Box etc.
- entry[].resource.address[].city
  string
  Name of city
- entry[].resource.address[].district
  string
  District (county) name
- entry[].resource.address[].state
  string
  Name, or abbreviation, of the state
- entry[].resource.address[].postalCode
  string
  Postal code for the area
- entry[].resource.address[].country
  string
  Country.
  Can be ISO 3166 2 or 3 letter code.
- entry[].resource.address[].use
  string
  Required
  The purpose of the address
- entry[].resource.name
  HumanName
  Required
  The name(s) associated with the practitioner.
- entry[].resource.name[].family
  string
  Family name.
  Often called 'Surname.'
- entry[].resource.name[].given[]
  string[]
  Given names (not always 'first'). Includes middle names.
  Given names appear in the correct order for presenting the name.
- entry[].resource.qualification
  Qualifications obtained by training and certification.
- entry[].resource.qualification[].code
  CodeableConcept
  Coded representation of the qualification.
- entry[].resource.qualification[].code.text
  string
  Text representation of the qualification.
- entry[].resource.qualification[].code.coding
  Coding
- entry[].resource.qualification[].code.coding.code
  code
  Symbol defined by the system
- entry[].resource.qualification[].code.coding.system
  uri
  Identity/namespace of the terminology system
- entry[].resource.qualification[].code.coding.display
  string
  Display value of the code, as defined by the system

Sample MessageDownload JSON Schema

{
   "resourceType": "Bundle",
   "type": "message",
   "entry": [
      {
         "fullUrl": "urn:uuid:0eb2ced0-3b7d-4167-aee5-643491026124",
         "resource": {
            "id": "transmission-12414",
            "resourceType": "MessageHeader",
            "event": {
               "code": "PatientAdmin-Cancel"
            },
            "timestamp": "2019-05-10T17:23:19.864Z",
            "source": {
               "name": "Redox Dev Tools",
               "endpoint": "urn:uuid:7ce6f387-c33c-417d-8682-81e83628cbd9"
            },
            "focus": [
               {
                  "reference": "urn:uuid:d22ac116-1d18-4d21-a4a3-8eb5feef7a73"
               },
               {
                  "reference": "urn:uuid:073fb4ac-ede8-4704-b92d-6ff6311314b7"
               }
            ]
         }
      },
      {
         "fullUrl": "urn:uuid:d22ac116-1d18-4d21-a4a3-8eb5feef7a73",
         "resource": {
            "resourceType": "Patient",
            "identifier": [
               {
                  "value": "0000000001",
                  "system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:MR"
               },
               {
                  "value": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
                  "system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:EHRID"
               },
               {
                  "value": "a1d4ee8aba494ca",
                  "system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:NIST"
               },
               {
                  "value": "101-01-0001",
                  "system": "http://hl7.org/fhir/sid/us-ssn"
               }
            ],
            "birthDate": "2008-01-06",
            "telecom": [
               {
                  "value": "+18088675301",
                  "system": "phone",
                  "use": "home"
               }
            ],
            "address": [
               {
                  "line": [
                     "4762 Hickory Street"
                  ],
                  "city": "Monroe",
                  "district": "Green",
                  "state": "WI",
                  "postalCode": "53566",
                  "country": "US",
                  "use": "home"
               }
            ],
            "name": [
               {
                  "family": "Bixby",
                  "given": [
                     "Timothy",
                     "Paul"
                  ]
               }
            ],
            "gender": "male",
            "maritalStatus": {
               "text": "Married",
               "coding": [
                  {
                     "code": "M",
                     "system": "http://hl7.org/fhir/v3/MaritalStatus",
                     "display": "Married"
                  }
               ]
            },
            "extension": [
               {
                  "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
                  "extension": [
                     {
                        "url": "text",
                        "valueString": "White"
                     }
                  ]
               }
            ],
            "communication": [
               {
                  "language": {
                     "text": "en",
                     "coding": [
                        {
                           "code": "en",
                           "system": "urn:ietf:bcp:47"
                        }
                     ]
                  }
               }
            ],
            "contact": [
               {
                  "name": {
                     "family": "Bixby",
                     "given": [
                        "Barbara"
                     ]
                  },
                  "address": {
                     "line": [
                        "4762 Hickory Street"
                     ],
                     "city": "Monroe",
                     "district": "Green",
                     "state": "WI",
                     "postalCode": "53566",
                     "country": "US"
                  },
                  "telecom": [
                     {
                        "value": "+18088675303",
                        "system": "phone",
                        "use": "home"
                     },
                     {
                        "value": "+17077543758",
                        "system": "phone",
                        "use": "work"
                     },
                     {
                        "value": "+19189368865",
                        "system": "phone",
                        "use": "mobile"
                     },
                     {
                        "value": "barb.bixby@test.net",
                        "system": "email"
                     }
                  ],
                  "relationship": [
                     {
                        "text": "Mother",
                        "coding": [
                           {
                              "code": "MTH",
                              "system": "http://hl7.org/fhir/v3/RoleCode",
                              "display": "mother"
                           }
                        ]
                     },
                     {
                        "text": "Emergency Contact",
                        "coding": [
                           {
                              "code": "C",
                              "system": "http://hl7.org/fhir/v2/0131",
                              "display": "Emergency Contact"
                           }
                        ]
                     }
                  ]
               }
            ],
            "generalPractitioner": [
               {
                  "reference": "urn:uuid:073fb4ac-ede8-4704-b92d-6ff6311314b7"
               }
            ]
         }
      },
      {
         "fullUrl": "urn:uuid:073fb4ac-ede8-4704-b92d-6ff6311314b7",
         "resource": {
            "resourceType": "Practitioner",
            "active": true,
            "identifier": [
               {
                  "value": "4356789876",
                  "system": "http://hl7.org/fhir/sid/us-npi"
               }
            ],
            "telecom": [
               {
                  "value": "+16085551234",
                  "system": "phone",
                  "use": "work"
               }
            ],
            "address": [
               {
                  "line": [
                     "123 Main St."
                  ],
                  "city": "Madison",
                  "district": "Dane",
                  "state": "WI",
                  "postalCode": "53703",
                  "country": "USA"
               }
            ],
            "name": [
               {
                  "family": "Granite",
                  "given": [
                     "Pat"
                  ]
               }
            ],
            "qualification": [
               {
                  "code": {
                     "text": "MD",
                     "coding": [
                        {
                           "code": "MD",
                           "system": "http://hl7.org/fhir/v2/0360/2.7",
                           "display": "Doctor of Medicine"
                        }
                     ]
                  }
               }
            ]
         }
      }
   ]
}

{
   "Meta": {
      "DataModel": "PatientAdmin",
      "EventType": "Cancel",
      "EventDateTime": "2019-05-10T17:23:19.864Z",
      "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": [
               "barb.bixby@test.net"
            ],
            "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"
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         }
      }
   },
   "Visit": {
      "VisitNumber": "1234",
      "AccountNumber": null,
      "PatientClass": "Inpatient",
      "VisitDateTime": "2019-05-10T17:23:20.749Z",
      "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"
         },
         "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
         },
         "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
         },
         "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
         },
         "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",
         "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 Deductable 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,
               "FirstName": null,
               "SSN": null,
               "Relationship": null,
               "DOB": null,
               "Sex": null,
               "Address": {
                  "StreetAddress": null,
                  "City": null,
                  "State": null,
                  "ZIP": null,
                  "County": null,
                  "Country": null
               }
            }
         }
      ]
   }
}

DischargeBETA

View R^FHIR Event Type

A Discharge message is generated when a patient is discharged or checked out from a clinical stay or visit.

Fields

Show Required Fields Only

Meta
- Meta.DataModel
  String
  Reliable
  Required
  Data model.
  E.g. Scheduling, Results
- Meta.EventType
  String
  Reliable
  Required
  Type of event.
  Discharge
- Meta.EventDateTime
  DateTime
  Reliable
  DateTime of the event.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Flag as a test message
- Meta.Source
  String
  Reliable
  Where the message originated.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  ID of the source.
  UUID
- Meta.Source.Name
  String
  Reliable
  Name of the source
- Meta.Destinations[]
  Array of Objects
  Reliable
  List of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
  Required when sending data to Redox
- Meta.Destinations[].ID
  String
  Reliable
  ID of the destination.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Name of the destination
- Meta.Message
  String
  Reliable
  Record in Redox that corresponds to the communication sent from the source to Redox.
  Included in messages from Redox
- Meta.Message.ID
  Numeric
  Reliable
  ID of the message created in Redox
- Meta.Transmission
  String
  Reliable
  Record in Redox that corresponds to the communication sent from Redox to your destination.
  Included in messages from Redox
- Meta.Transmission.ID
  Numeric
  Reliable
  ID of the transmission created in Redox
- Meta.FacilityCode
  String
  Possible
  Code for the facility related to the message.
  Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
- Patient.Identifiers[]
  Array of Objects
  Reliable
  List of IDs and ID types that identify the patient
- Patient.Identifiers[].ID
  String
  Reliable
  Required
  ID for the patient
- Patient.Identifiers[].IDType
  String
  Reliable
  Required
  Type of ID.
  E.g. MRN, EPI
- Patient.Demographics.FirstName
  String
  Reliable
  Patient's first name
- Patient.Demographics.MiddleName
  String
  Possible
  Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
- Patient.Demographics.LastName
  String
  Reliable
  Patient's last name
- Patient.Demographics.DOB
  String
  Reliable
  Patient's date of birth.
  In ISO 8601 format
- Patient.Demographics.SSN
  String
  Probable
  Patient's social security number
- Patient.Demographics.Sex
  String
  Reliable
  Patient's sex
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Race
  String
  Possible
  Patient's race.
  Supported Values
- Patient.Demographics.IsHispanic
  Boolean
  Possible
  Indicates if the patient is of hispanic origin.
- Patient.Demographics.MaritalStatus
  String
  Possible
  Patient's marital status
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.IsDeceased
  Boolean
  Possible
  Indicates if the patient is deceased
- Patient.Demographics.DeathDateTime
  DateTime
  Possible
  Date and Time the patient was proclaimed deceased.
  ISO 8601 Format
- Patient.Demographics.PhoneNumber.Home
  String
  Probable
  Patient's home phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Office
  String
  Probable
  Patient's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Mobile
  String
  Probable
  Patient's mobile phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.EmailAddresses[]
  Array of Strings
  Probable
  Patient's email address(es)
- Patient.Demographics.Language
  String
  Possible
  Patient's primary spoken language.
  In ISO 639-1 alpha values (e.g. 'en'). Supported Values
- Patient.Demographics.Citizenship[]
  Array of strings
  Possible
  Patient's nation(s) of citizenship.
  *In ISO 3166 alpha 2 format (e.g. 'US'). Reference Table.
  
  Note: The valid set of citizenships is a smaller list than the list of IS0 3166 country codes, and should be limited to the 193 United Nations countries plus 6 states: ROC Taiwan, Macao (SAR China), Hong Kong (SAR China), Kosovo, Palestinian Territory and the Vatican.*
- Patient.Demographics.Address
  Object
  Probable
  Patient's home address
- Patient.Demographics.Address.StreetAddress
  String
  Probable
  Street address
- Patient.Demographics.Address.City
  String
  Probable
  City
- Patient.Demographics.Address.State
  String
  Probable
  State
- Patient.Demographics.Address.ZIP
  String
  Probable
  ZIP
- Patient.Demographics.Address.County
  String
  Possible
  County
- Patient.Demographics.Address.Country
  String
  Possible
  Country
- Patient.Notes[]
  Array of strings
  Possible
  Patient-level notes
- Patient.Contacts[].FirstName
  String
  Possible
  First name of the contact
- Patient.Contacts[].MiddleName
  String
  Possible
  Middle name of the contact
- Patient.Contacts[].LastName
  String
  Possible
  Last name of the contact
- Patient.Contacts[].Address
  Object
  Possible
  Address of the contact
- Patient.Contacts[].Address.StreetAddress
  String
  Possible
  Street address
- Patient.Contacts[].Address.City
  String
  Possible
  City
- Patient.Contacts[].Address.State
  String
  Possible
  State
- Patient.Contacts[].Address.ZIP
  String
  Possible
  ZIP
- Patient.Contacts[].Address.County
  String
  Possible
  County
- Patient.Contacts[].Address.Country
  String
  Possible
  Country
- Patient.Contacts[].PhoneNumber.Home
  String
  Possible
  Home phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Contacts[].PhoneNumber.Office
  String
  Possible
  Office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Contacts[].PhoneNumber.Mobile
  String
  Probable
  Mobile phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Contacts[].RelationToPatient
  String
  Possible
  Personal relationship to the patient.
  e.x. Father, Spouse
- Patient.Contacts[].EmailAddresses[]
  Array of string
  Possible
  Email address(es) of the contact person
- Patient.Contacts[].Roles[]
  Array of strings
  Possible
  Role of this contact for the patient.
  e.x. Employer, Emergency Contact
- Patient.Diagnoses[]
  Array of Objects
  Probable
  List of diagnoses associated with this visit
- Patient.Diagnoses[].Code
  String
  Probable
  Code for the diagnosis
- Patient.Diagnoses[].Codeset
  String
  Probable
  Code set used to identify the diagnosis.
  One of the following: ICD-9, ICD-10, HCPCS, CPT
- Patient.Diagnoses[].Name
  String
  Probable
  Name of the diagnosis
- Patient.Diagnoses[].Type
  String
  Possible
  Type of the diagnosis.
  One of the following: Admitting, Working, or Final
- Patient.Diagnoses[].DocumentedDateTime
  String
  Possible
  DateTime the diagnosis was documented.
  ISO 8601 Format
- Patient.Allergies[]
  Array of Objects
  Possible
  List of a patient's allergies
- Patient.Allergies[].Code
  String
  Possible
  Code for the allergy
- Patient.Allergies[].Codeset
  String
  Possible
  Code set used to identify the allergy.
  Typically RxNorm or SNOMED
- Patient.Allergies[].Name
  String
  Possible
  Name of the allergy
- Patient.Allergies[].Type
  Object
  Possible
  The type of allergy intolerance (food, drug, etc.)
- Patient.Allergies[].Type.Code
  String
  Possible
  Code for the allergy intolerance type
- Patient.Allergies[].Type.Codeset
  String
  Possible
  Code set used to identify the allergy intolerance type
- Patient.Allergies[].Type.Name
  String
  Possible
  Name of the allergy intolerance type
- Patient.Allergies[].OnsetDateTime
  String
  Possible
  DateTime the allergy was identified
- Patient.Allergies[].Reaction[]
  Array of Objects
  Possible
  The list of reactions caused by this particular allergy.
- Patient.Allergies[].Reaction[].Code
  String
  Possible
  Code for the reaction
- Patient.Allergies[].Reaction[].Codeset
  String
  Possible
  Code set used to identify the reaction
- Patient.Allergies[].Reaction[].Name
  String
  Possible
  Name of the reaction
- Patient.Allergies[].Severity
  Object
  Possible
  The severity of the reaction (moderate, severe, etc.).
- Patient.Allergies[].Severity.Code
  String
  Possible
  Code for the reaction severity
- Patient.Allergies[].Severity.Codeset
  String
  Possible
  Code set used to identify the reaction severity
- Patient.Allergies[].Severity.Name
  String
  Possible
  Name of the reaction severity
- Patient.Allergies[].Status
  string
  Possible
  The current status of the allergy.
  One of the following: "Active", "Inactive", "Resolved".
- Patient.PCP
  Object
  Reliable
  Primary Care Provider for the Patient
- Patient.PCP.NPI
  String
  Reliable
  NPI of the PCP
- Patient.PCP.ID
  String
  Reliable
  ID of the PCP.
  This ID is often required for Inpatient Visits.
- Patient.PCP.IDType
  String
  Reliable
  ID type of the ID for the PCP
- Patient.PCP.FirstName
  String
  Possible
  First name of the PCP
- Patient.PCP.LastName
  String
  Possible
  Last name of the PCP
- Patient.PCP.Credentials[]
  Array of Strings
  Possible
  List of credentials for the PCP.
  e.g. MD, PhD
- Patient.PCP.Address
  Object
  Possible
  Provider's address
- Patient.PCP.Address.StreetAddress
  String
  Possible
  Street address
- Patient.PCP.Address.City
  String
  Possible
  City
- Patient.PCP.Address.State
  String
  Possible
  State
- Patient.PCP.Address.ZIP
  String
  Possible
  ZIP
- Patient.PCP.Address.County
  String
  Possible
  County
- Patient.PCP.Address.Country
  String
  Possible
  Country
- Patient.PCP.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.PCP.Location
  Object
  Possible
  Provider's location
- Patient.PCP.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Patient.PCP.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Patient.PCP.Location.Department
  String
  Possible
  Department
- Patient.PCP.Location.Room
  String
  Possible
  Room.
  Example: 136
Visit
- Visit.VisitNumber
  String
  Reliable
  Visit Number.
  Unique ID of a single visit
- Visit.AccountNumber
  String
  Possible
  Account Number.
  An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
- Visit.PatientClass
  String
  Reliable
  Required
  Patient class is used in many EHRs to determine where to put the patient.
  Examples: Inpatient, Outpatient, Emergency
- Visit.VisitDateTime
  String
  Reliable
  DateTime of visit or the arrival time of the admission.
  ISO 8601 Format
- Visit.DischargeDateTime
  String
  Reliable
  DateTime of Patient Discharge.
  ISO 8601 Format
- Visit.DischargeStatus
  Object
  Probable
  A code indicating the disposition or status of the patient at the end of the visit.
- Visit.DischargeStatus.Code
  String
  Probable
  Code for the discharge status
- Visit.DischargeStatus.Codeset
  String
  Probable
  Code set used to identify the discharge status.
  Coded using the UB04 FL17 codes
- Visit.DischargeStatus.Description
  String
  Probable
  Description of the discharge status
- Visit.DischargeLocation
  Object
  Probable
  Location to which the patient was discharged.
- Visit.DischargeLocation.Type
  String
  Probable
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.DischargeLocation.Facility
  String
  Probable
  Facility.
  Example: Community Hospital
- Visit.DischargeLocation.Department
  String
  Probable
  Department
- Visit.DischargeLocation.Room
  String
  Probable
  Room.
  Example: 136
- Visit.Duration
  Numeric
  Probable
  Length of visit.
  In minutes
- Visit.Reason
  String
  Probable
  Reason for visit
- Visit.Instructions[]
  Array of Strings
  Probable
  Appointment instructions
- Visit.Balance
  Numeric
  Possible
  Patient 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
  Possible
  Diagnosis Related Group for this visit
- Visit.DiagnosisRelatedGroupType
  Numeric
  Possible
  Type 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
  Reliable
  The provider primarily responsible for a patient's care during a visit
- Visit.AttendingProvider.ID
  String
  Probable
  ID of the attending provider.
  This ID is often required for Inpatient Visits.
- Visit.AttendingProvider.IDType
  String
  Probable
  ID type of the ID for the attending provider
- Visit.AttendingProvider.FirstName
  String
  Possible
  First name of the attending provider
- Visit.AttendingProvider.LastName
  String
  Possible
  Last name of the attending provider
- Visit.AttendingProvider.Credentials[]
  Array of Strings
  Possible
  List of credentials for the attending provider.
  e.g. MD, PhD
- Visit.AttendingProvider.Address
  Object
  Possible
  Provider's address
- Visit.AttendingProvider.Address.StreetAddress
  String
  Possible
  Street address
- Visit.AttendingProvider.Address.City
  String
  Possible
  City
- Visit.AttendingProvider.Address.State
  String
  Possible
  State
- Visit.AttendingProvider.Address.ZIP
  String
  Possible
  ZIP
- Visit.AttendingProvider.Address.County
  String
  Possible
  County
- Visit.AttendingProvider.Address.Country
  String
  Possible
  Country
- Visit.AttendingProvider.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Visit.AttendingProvider.Location
  Object
  Possible
  Provider's location
- Visit.AttendingProvider.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.AttendingProvider.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Visit.AttendingProvider.Location.Department
  String
  Possible
  Department
- Visit.AttendingProvider.Location.Room
  String
  Possible
  Room.
  Example: 136
- Visit.ConsultingProvider
  Object
  Reliable
  A provider, usually a specialist, that evaluates or treats a patient to address a specific problem
- Visit.ConsultingProvider.ID
  String
  Possible
  ID of the consulting provider.
  This ID is often required for Inpatient Visits.
- Visit.ConsultingProvider.IDType
  String
  Possible
  ID type of the ID for the consulting provider
- Visit.ConsultingProvider.FirstName
  String
  Possible
  First name of the consulting provider
- Visit.ConsultingProvider.LastName
  String
  Possible
  Last name of the consulting provider
- Visit.ConsultingProvider.Credentials[]
  Array of Strings
  Possible
  List of credentials for the consulting provider.
  e.g. MD, PhD
- Visit.ConsultingProvider.Address
  Object
  Possible
  Provider's address
- Visit.ConsultingProvider.Address.StreetAddress
  String
  Possible
  Street address
- Visit.ConsultingProvider.Address.City
  String
  Possible
  City
- Visit.ConsultingProvider.Address.State
  String
  Possible
  State
- Visit.ConsultingProvider.Address.ZIP
  String
  Possible
  ZIP
- Visit.ConsultingProvider.Address.County
  String
  Possible
  County
- Visit.ConsultingProvider.Address.Country
  String
  Possible
  Country
- Visit.ConsultingProvider.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Visit.ConsultingProvider.Location
  Object
  Possible
  Provider's location
- Visit.ConsultingProvider.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.ConsultingProvider.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Visit.ConsultingProvider.Location.Department
  String
  Possible
  Department
- Visit.ConsultingProvider.Location.Room
  String
  Possible
  Room.
  Example: 136
- Visit.ReferringProvider
  Object
  Reliable
  The provider that requested a patient to see a consulting provider
- Visit.ReferringProvider.ID
  String
  Possible
  ID of the referring provider.
  This ID is often required for Inpatient Visits.
- Visit.ReferringProvider.IDType
  String
  Possible
  ID type of the ID for the referring provider
- Visit.ReferringProvider.FirstName
  String
  Possible
  First name of the referring provider
- Visit.ReferringProvider.LastName
  String
  Possible
  Last name of the referring provider
- Visit.ReferringProvider.Credentials[]
  Array of Strings
  Possible
  List of credentials for the referring provider.
  e.g. MD, PhD
- Visit.ReferringProvider.Address
  Object
  Possible
  Provider's address
- Visit.ReferringProvider.Address.StreetAddress
  String
  Possible
  Street address
- Visit.ReferringProvider.Address.City
  String
  Possible
  City
- Visit.ReferringProvider.Address.State
  String
  Possible
  State
- Visit.ReferringProvider.Address.ZIP
  String
  Possible
  ZIP
- Visit.ReferringProvider.Address.County
  String
  Possible
  County
- Visit.ReferringProvider.Address.Country
  String
  Possible
  Country
- Visit.ReferringProvider.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Visit.ReferringProvider.Location
  Object
  Possible
  Provider's location
- Visit.ReferringProvider.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.ReferringProvider.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Visit.ReferringProvider.Location.Department
  String
  Possible
  Department
- Visit.ReferringProvider.Location.Room
  String
  Possible
  Room.
  Example: 136
- Visit.AdmittingProvider
  Object
  Reliable
  The MD/DO that made the decision to admit the patient. Not always the same as attending provider
- Visit.AdmittingProvider.ID
  String
  Reliable
  ID of the admitting provider.
  This ID is often required for Inpatient Visits.
- Visit.AdmittingProvider.IDType
  String
  Reliable
  ID type of the ID for the admitting provider
- Visit.AdmittingProvider.FirstName
  String
  Possible
  First name of the admitting provider
- Visit.AdmittingProvider.LastName
  String
  Possible
  Last name of the admitting provider
- Visit.AdmittingProvider.Credentials[]
  Array of Strings
  Possible
  List of credentials for the admitting provider.
  e.g. MD, PhD
- Visit.AdmittingProvider.Address
  Object
  Possible
  Provider's address
- Visit.AdmittingProvider.Address.StreetAddress
  String
  Possible
  Street address
- Visit.AdmittingProvider.Address.City
  String
  Possible
  City
- Visit.AdmittingProvider.Address.State
  String
  Possible
  State
- Visit.AdmittingProvider.Address.ZIP
  String
  Possible
  ZIP
- Visit.AdmittingProvider.Address.County
  String
  Possible
  County
- Visit.AdmittingProvider.Address.Country
  String
  Possible
  Country
- Visit.AdmittingProvider.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Visit.AdmittingProvider.Location
  Object
  Possible
  Provider's location
- Visit.AdmittingProvider.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.AdmittingProvider.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Visit.AdmittingProvider.Location.Department
  String
  Possible
  Department
- Visit.AdmittingProvider.Location.Room
  String
  Possible
  Room.
  Example: 136
- Visit.Location
  Object
  Probable
  Location of the appointment
- Visit.Location.Type
  String
  Probable
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.Location.Facility
  String
  Probable
  Facility.
  Example: Community Hospital
- Visit.Location.Department
  String
  Probable
  Department
- Visit.Location.Room
  String
  Probable
  Room.
  Example: 136
- Visit.Location.Bed
  String
  Probable
  Bed.
  Example: B
- Visit.Location.Address
  Object
  Probable
  Address of the appointment location
- Visit.Location.Address.StreetAddress
  String
  Probable
  Street address
- Visit.Location.Address.City
  String
  Probable
  City
- Visit.Location.Address.State
  String
  Probable
  State
- Visit.Location.Address.ZIP
  String
  Probable
  ZIP
- Visit.Location.Address.County
  String
  Possible
  County
- Visit.Location.Address.Country
  String
  Possible
  Country
- Visit.Guarantor
  Object
  Possible
  Person ultimately responsible for the bill of the appointment
- Visit.Guarantor.Number
  String
  Probable
  Number of the guarantor
- Visit.Guarantor.FirstName
  String
  Probable
  First name
- Visit.Guarantor.LastName
  String
  Probable
  Last name
- Visit.Guarantor.SSN
  String
  Possible
  Guarantor's social security number
- Visit.Guarantor.DOB
  String
  Possible
  Guarantor's date of birth.
  In ISO 8601 format
- Visit.Guarantor.Sex
  String
  Possible
  Guarantor's sex
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.Guarantor.Spouse.FirstName
  String
  Probable
  Spouse's first name
- Visit.Guarantor.Spouse.LastName
  String
  Probable
  Spouse's last name
- Visit.Guarantor.Address
  Object
  Probable
  Address of the guarantor
- Visit.Guarantor.Address.StreetAddress
  String
  Probable
  Street address
- Visit.Guarantor.Address.City
  String
  Probable
  City
- Visit.Guarantor.Address.State
  String
  Probable
  State
- Visit.Guarantor.Address.ZIP
  String
  Probable
  ZIP
- Visit.Guarantor.Address.County
  String
  Possible
  County
- Visit.Guarantor.Address.Country
  String
  Possible
  Country
- Visit.Guarantor.PhoneNumber.Home
  String
  Probable
  Home phone number.
  In E. 164 Format (i.e. +16085551234)
- Visit.Guarantor.PhoneNumber.Business
  String
  Probable
  Business phone number.
  In E. 164 Format (i.e. +16085551234)
- Visit.Guarantor.PhoneNumber.Mobile
  String
  Probable
  Mobile phone number.
  In E. 164 Format (i.e. +16085551234)
- Visit.Guarantor.EmailAddresses[]
  Array of Strings
  Probable
  Guarantor's email address(es)
- Visit.Guarantor.Type
  String
  Probable
  Type of guarantor.
  E.g. institution, individual
- Visit.Guarantor.RelationToPatient
  String
  Probable
  Relation to the patient.
  E.g. self, parent
- Visit.Guarantor.Employer.Name
  String
  Probable
  Employer's name
- Visit.Guarantor.Employer.Address
  Object
  Probable
  Employer's address
- Visit.Guarantor.Employer.Address.StreetAddress
  String
  Probable
  Street address
- Visit.Guarantor.Employer.Address.City
  String
  Probable
  City
- Visit.Guarantor.Employer.Address.State
  String
  Probable
  State
- Visit.Guarantor.Employer.Address.ZIP
  String
  Probable
  ZIP
- Visit.Guarantor.Employer.Address.County
  String
  Possible
  County
- Visit.Guarantor.Employer.Address.Country
  String
  Possible
  Country
- Visit.Guarantor.Employer.PhoneNumber
  String
  Probable
  Employer phone number.
  In E. 164 Format (i.e. +16085551234)
- Visit.Insurances[]
  Array of Objects
  Probable
  List of insurance coverages for the patient
- Visit.Insurances[].Plan.ID
  String
  Probable
  Identifier of insurance plan
- Visit.Insurances[].Plan.IDType
  String
  Probable
  ID type of insurance plan
- Visit.Insurances[].Plan.Name
  String
  Probable
  Name of insurance plan
- Visit.Insurances[].Plan.Type
  String
  Possible
  Type of insurance plan
- Visit.Insurances[].MemberNumber
  String
  Possible
  Patient member number
- Visit.Insurances[].Company.ID
  String
  Probable
  ID of insurance company (payor)
- Visit.Insurances[].Company.IDType
  String
  Probable
  ID type of insurance company (payor)
- Visit.Insurances[].Company.Name
  String
  Probable
  Name of insurance company (payor)
- Visit.Insurances[].Company.Address
  Object
  Probable
  Insurance company's address
- Visit.Insurances[].Company.Address.StreetAddress
  String
  Probable
  Street address
- Visit.Insurances[].Company.Address.City
  String
  Probable
  City
- Visit.Insurances[].Company.Address.State
  String
  Probable
  State
- Visit.Insurances[].Company.Address.ZIP
  String
  Probable
  ZIP
- Visit.Insurances[].Company.Address.County
  String
  Possible
  County
- Visit.Insurances[].Company.Address.Country
  String
  Possible
  Country
- Visit.Insurances[].Company.PhoneNumber
  String
  Probable
  Insurance companys phone number.
  In E. 164 Format (i.e. +16085551234)
- Visit.Insurances[].GroupNumber
  String
  Probable
  Insurance policy group number
- Visit.Insurances[].GroupName
  String
  Probable
  Insurance policy group name
- Visit.Insurances[].EffectiveDate
  String
  Probable
  Effect date of this insurance policy.
  In YYYY-MM-DD format
- Visit.Insurances[].ExpirationDate
  String
  Probable
  Expiration date of this insurance policy.
  In YYYY-MM-DD format
- Visit.Insurances[].PolicyNumber
  String
  Probable
  Insurance policy number
- Visit.Insurances[].AgreementType
  String
  Probable
  Type of insurance agreement.
  One of the following: "Standard", "Unified", "Maternity"
- Visit.Insurances[].CoverageType
  String
  Probable
  Type of insurance agreement.
  One of the following: "Patient", "Clinic", "Insurance", "Other". Indicates who will be receiving the bill for the service.
- Visit.Insurances[].Insured
  Object
  Possible
  Individual who has the agreement with the insurance company for the related policy
- Visit.Insurances[].Insured.Identifiers[]
  Array of Objects
  Possible
  List of IDs and ID types that identify the insured
- Visit.Insurances[].Insured.Identifiers[].ID
  String
  Possible
  ID for the insured
- Visit.Insurances[].Insured.Identifiers[].IDType
  String
  Possible
  Type of ID.
  E.g. MRN, EPI
- Visit.Insurances[].Insured.LastName
  String
  Possible
  Last name of the insured
- Visit.Insurances[].Insured.FirstName
  String
  Possible
  First name of the insured
- Visit.Insurances[].Insured.SSN
  String
  Possible
  Insured's social security number
- Visit.Insurances[].Insured.Relationship
  String
  Possible
  Relationship of the insured to the patient.
  One of the following: "Self", "Spouse", "Other".
- Visit.Insurances[].Insured.DOB
  String
  Possible
  Date of birth of the insured.
  In YYYY-MM-DD format
- Visit.Insurances[].Insured.Sex
  String
  Possible
  Sex of the insured
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.Insurances[].Insured.Address
  Object
  Probable
  Address of the insured
- Visit.Insurances[].Insured.Address.StreetAddress
  String
  Probable
  Street address
- Visit.Insurances[].Insured.Address.City
  String
  Probable
  City
- Visit.Insurances[].Insured.Address.State
  String
  Probable
  State
- Visit.Insurances[].Insured.Address.ZIP
  String
  Probable
  ZIP
- Visit.Insurances[].Insured.Address.County
  String
  Possible
  County
- Visit.Insurances[].Insured.Address.Country
  String
  Possible
  Country

resourceType
- resourceType
  string
  Bundle
type
- type
  code
  Currently, Redox supports only the 'Message' Type
entry
- entry
  The entry field corresponds to an array of FHIR Resources. For PatientAdmin, the Message Header and Patient resources are required, and the Practitioner (representing the attending provider) and some Location resources are allowed.
- entry[].fullUrl
  uri
  Absolute URL for resource.
  Ex: server address or UUID/OID.
entry[].resource - MessageHeader
- entry[].resource
  MessageHeader Resource Information
- entry[].resource.id
  id
  Logical id of this artifact
- entry[].resource.resourceType
  string
  MessageHeader
- entry[].resource.event
  Coding
  Code for the event this message represents
- entry[].resource.event.code
  code
- entry[].resource.timestamp
  instant
  Time that the message was sent
- entry[].resource.source
  Message source application
- entry[].resource.source.name
  string
  Name of the source system
- entry[].resource.source.endpoint
  uri
  Actual message source address or id
- entry[].resource.focus
  Reference
  Pointers to the actual content of the message
- entry[].resource.focus[].reference
  string
  References to the rest of the bundle
entry[].resource - Patient
- entry[].resource.resourceType
  string
  Patient
- entry[].resource.identifier
  Identifier
  A list of identifiers for this patient
- entry[].resource.identifier[].value
  string
- entry[].resource.identifier[].system
  string
  Establishes the namespace for the value - that is, a URL that describes a set of values that are unique
- entry[].resource.birthdate
  date
  Data of birth for the patient
- entry[].resource.telecom
  ContactPoint
  A contact detail for the patient
- entry[].resource.telecom[].value
  string
- entry[].resource.telecom[].system
  string
  A contact detail for the patient.
  Redox currently only supports values of phone and email for this field.
- entry[].resource.telecom[].use
  string
  Purpose of the contact point
- entry[].resource.address
  Address
  Address(es) of the patient
- entry[].resource.address[].line[]
  string[]
  Street name, number, direction & P.O. Box etc.
- entry[].resource.address[].city
  string
  Name of city
- entry[].resource.address[].district
  string
  District (county) name
- entry[].resource.address[].state
  string
  Name, or abbreviation, of the state
- entry[].resource.address[].postalCode
  string
  Postal code for the area
- entry[].resource.address[].country
  string
  Country.
  Can be ISO 3166 2 or 3 letter code.
- entry[].resource.address[].use
  string
  The purpose of the address
- entry[].resource.name
  HumanName
  Required
  A list of names associated with the patient
- entry[].resource.name[].family
  string
  Often called 'Surname.'
- entry[].resource.name[].given[]
  string[]
- entry[].resource.gender
  string
  Required
  Administrative gender for the patient.
  The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. One of male, female, other, or unknown.
- entry[].resource.maritalStatus
  CodeableConcept
  Marital Status of a patient
- entry[].resource.maritalStatus.text
  string
- entry[].resource.extension
  Extension
  Additional Content defined by implementations
- entry[].resource.extension[].url
  string
- entry[].resource.extension[].extension
  Extension
- entry[].resource.extension[].extension[].url
  string
- entry[].resource.extension[].extension[].valueString
  string
- entry[].resource.communication
  A list of languages which may be used to communicate with the patient.
- entry[].resource.communication[].language
  CodeableConcept
- entry[].resource.communication[].language.text
  string
- entry[].resource.communication[].language.coding
  Coding
- entry[].resource.communication[].language.coding.code
  code
  Symbol defined by the system
- entry[].resource.communication[].language.coding.system
  uri
  Identity/namespace of the terminology system
- entry[].resource.communication[].language.coding.display
  string
  Display value of the code, as defined by the system
entry[].resource - Practitioner
- entry[].resource.resourceType
  string
  Practitioner
- entry[].resource.active
  boolean
  Whether this practitioner's record is in active use
- entry[].resource.identifier
  Identifier
  Required
  A list of identifiers that apply to this person in this role
- entry[].resource.identifier[].value
  string
  Unique value identifier
- entry[].resource.identifier[].system
  string
  Establishes the namespace for the value - that is, a URL that describes a set of values that are unique
- entry[].resource.telecom
  ContactPoint
  Contact information for the practitioner
- entry[].resource.telecom[].value
  string
  Actual contact point details
- entry[].resource.telecom[].system
  string
  A contact detail for the practitioner (that apply to all roles).
  Redox currently only supports values of phone and email for this field.
- entry[].resource.telecom[].use
  string
  Purpose of the contact point
- entry[].resource.address
  Address
  Address(es) of the practitioner.
  Address(es) are not role specific.
- entry[].resource.address[].line[]
  string[]
  Street name, number, direction & P.O. Box etc.
- entry[].resource.address[].city
  string
  Name of city
- entry[].resource.address[].district
  string
  District (county) name
- entry[].resource.address[].state
  string
  Name, or abbreviation, of the state
- entry[].resource.address[].postalCode
  string
  Postal code for the area
- entry[].resource.address[].country
  string
  Country.
  Can be ISO 3166 2 or 3 letter code.
- entry[].resource.address[].use
  string
  Required
  The purpose of the address
- entry[].resource.name
  HumanName
  Required
  The name(s) associated with the practitioner.
- entry[].resource.name[].family
  string
  Family name.
  Often called 'Surname.'
- entry[].resource.name[].given[]
  string[]
  Given names (not always 'first'). Includes middle names.
  Given names appear in the correct order for presenting the name.
- entry[].resource.qualification
  Qualifications obtained by training and certification.
- entry[].resource.qualification[].code
  CodeableConcept
  Coded representation of the qualification.
- entry[].resource.qualification[].code.text
  string
  Text representation of the qualification.
- entry[].resource.qualification[].code.coding
  Coding
- entry[].resource.qualification[].code.coding.code
  code
  Symbol defined by the system
- entry[].resource.qualification[].code.coding.system
  uri
  Identity/namespace of the terminology system
- entry[].resource.qualification[].code.coding.display
  string
  Display value of the code, as defined by the system

Sample MessageDownload JSON Schema

{
   "resourceType": "Bundle",
   "type": "message",
   "entry": [
      {
         "fullUrl": "urn:uuid:23d696c3-9d07-42d7-8d73-674693674ab8",
         "resource": {
            "id": "transmission-12414",
            "resourceType": "MessageHeader",
            "event": {
               "code": "PatientAdmin-Discharge"
            },
            "timestamp": "2019-05-10T17:23:19.864Z",
            "source": {
               "name": "Redox Dev Tools",
               "endpoint": "urn:uuid:7ce6f387-c33c-417d-8682-81e83628cbd9"
            },
            "focus": [
               {
                  "reference": "urn:uuid:bd220f65-baf6-44f0-b345-49a1b59625cb"
               },
               {
                  "reference": "urn:uuid:4401a918-a006-4f46-b1a3-7a566c63ac05"
               }
            ]
         }
      },
      {
         "fullUrl": "urn:uuid:bd220f65-baf6-44f0-b345-49a1b59625cb",
         "resource": {
            "resourceType": "Patient",
            "identifier": [
               {
                  "value": "0000000001",
                  "system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:MR"
               },
               {
                  "value": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
                  "system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:EHRID"
               },
               {
                  "value": "a1d4ee8aba494ca",
                  "system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:NIST"
               },
               {
                  "value": "101-01-0001",
                  "system": "http://hl7.org/fhir/sid/us-ssn"
               }
            ],
            "birthDate": "2008-01-06",
            "telecom": [
               {
                  "value": "+18088675301",
                  "system": "phone",
                  "use": "home"
               }
            ],
            "address": [
               {
                  "line": [
                     "4762 Hickory Street"
                  ],
                  "city": "Monroe",
                  "district": "Green",
                  "state": "WI",
                  "postalCode": "53566",
                  "country": "US",
                  "use": "home"
               }
            ],
            "name": [
               {
                  "family": "Bixby",
                  "given": [
                     "Timothy",
                     "Paul"
                  ]
               }
            ],
            "gender": "male",
            "maritalStatus": {
               "text": "Married",
               "coding": [
                  {
                     "code": "M",
                     "system": "http://hl7.org/fhir/v3/MaritalStatus",
                     "display": "Married"
                  }
               ]
            },
            "extension": [
               {
                  "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
                  "extension": [
                     {
                        "url": "text",
                        "valueString": "White"
                     }
                  ]
               }
            ],
            "communication": [
               {
                  "language": {
                     "text": "en",
                     "coding": [
                        {
                           "code": "en",
                           "system": "urn:ietf:bcp:47"
                        }
                     ]
                  }
               }
            ],
            "contact": [
               {
                  "name": {
                     "family": "Bixby",
                     "given": [
                        "Barbara"
                     ]
                  },
                  "address": {
                     "line": [
                        "4762 Hickory Street"
                     ],
                     "city": "Monroe",
                     "district": "Green",
                     "state": "WI",
                     "postalCode": "53566",
                     "country": "US"
                  },
                  "telecom": [
                     {
                        "value": "+18088675303",
                        "system": "phone",
                        "use": "home"
                     },
                     {
                        "value": "+17077543758",
                        "system": "phone",
                        "use": "work"
                     },
                     {
                        "value": "+19189368865",
                        "system": "phone",
                        "use": "mobile"
                     },
                     {
                        "value": "barb.bixby@test.net",
                        "system": "email"
                     }
                  ],
                  "relationship": [
                     {
                        "text": "Mother",
                        "coding": [
                           {
                              "code": "MTH",
                              "system": "http://hl7.org/fhir/v3/RoleCode",
                              "display": "mother"
                           }
                        ]
                     },
                     {
                        "text": "Emergency Contact",
                        "coding": [
                           {
                              "code": "C",
                              "system": "http://hl7.org/fhir/v2/0131",
                              "display": "Emergency Contact"
                           }
                        ]
                     }
                  ]
               }
            ],
            "generalPractitioner": [
               {
                  "reference": "urn:uuid:4401a918-a006-4f46-b1a3-7a566c63ac05"
               }
            ]
         }
      },
      {
         "fullUrl": "urn:uuid:4401a918-a006-4f46-b1a3-7a566c63ac05",
         "resource": {
            "resourceType": "Practitioner",
            "active": true,
            "identifier": [
               {
                  "value": "4356789876",
                  "system": "http://hl7.org/fhir/sid/us-npi"
               }
            ],
            "telecom": [
               {
                  "value": "+16085551234",
                  "system": "phone",
                  "use": "work"
               }
            ],
            "address": [
               {
                  "line": [
                     "123 Main St."
                  ],
                  "city": "Madison",
                  "district": "Dane",
                  "state": "WI",
                  "postalCode": "53703",
                  "country": "USA"
               }
            ],
            "name": [
               {
                  "family": "Granite",
                  "given": [
                     "Pat"
                  ]
               }
            ],
            "qualification": [
               {
                  "code": {
                     "text": "MD",
                     "coding": [
                        {
                           "code": "MD",
                           "system": "http://hl7.org/fhir/v2/0360/2.7",
                           "display": "Doctor of Medicine"
                        }
                     ]
                  }
               }
            ]
         }
      }
   ]
}

{
   "Meta": {
      "DataModel": "PatientAdmin",
      "EventType": "Discharge",
      "EventDateTime": "2019-05-10T17:23:19.864Z",
      "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": [
               "barb.bixby@test.net"
            ],
            "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"
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         }
      }
   },
   "Visit": {
      "VisitNumber": "1234",
      "AccountNumber": null,
      "PatientClass": "Inpatient",
      "VisitDateTime": "2019-05-09T17:23:20.761Z",
      "DischargeDateTime": "2019-05-10T17:23:20.761Z",
      "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": "Discharged to home",
      "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"
         },
         "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
         },
         "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
         },
         "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
         },
         "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",
         "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 Deductable 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,
               "FirstName": null,
               "SSN": null,
               "Relationship": null,
               "DOB": null,
               "Sex": null,
               "Address": {
                  "StreetAddress": null,
                  "City": null,
                  "State": null,
                  "ZIP": null,
                  "County": null,
                  "Country": null
               }
            }
         }
      ]
   }
}

NewPatientBETA

View R^FHIR Event Type

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

Show Required Fields Only

Meta
- Meta.DataModel
  String
  Reliable
  Required
  Data model.
  E.g. Scheduling, Results
- Meta.EventType
  String
  Reliable
  Required
  Type of event.
  E.g. New, Update
- Meta.EventDateTime
  DateTime
  Reliable
  DateTime of the event.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Flag as a test message
- Meta.Source
  String
  Reliable
  Where the message originated.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  ID of the source.
  UUID
- Meta.Source.Name
  String
  Reliable
  Name of the source
- Meta.Destinations[]
  Array of Objects
  Reliable
  List of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
  Required when sending data to Redox
- Meta.Destinations[].ID
  String
  Reliable
  ID of the destination.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Name of the destination
- Meta.Message
  String
  Reliable
  Record in Redox that corresponds to the communication sent from the source to Redox.
  Included in messages from Redox
- Meta.Message.ID
  Numeric
  Reliable
  ID of the message created in Redox
- Meta.Transmission
  String
  Reliable
  Record in Redox that corresponds to the communication sent from Redox to your destination.
  Included in messages from Redox
- Meta.Transmission.ID
  Numeric
  Reliable
  ID of the transmission created in Redox
- Meta.FacilityCode
  String
  Possible
  Code for the facility related to the message.
  Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
- Patient.Identifiers[]
  Array of Objects
  Reliable
  List of IDs and ID types that identify the patient
- Patient.Identifiers[].ID
  String
  Reliable
  Required
  ID for the patient
- Patient.Identifiers[].IDType
  String
  Reliable
  Required
  Type of ID.
  E.g. MRN, EPI
- Patient.Demographics.FirstName
  String
  Reliable
  Patient's first name
- Patient.Demographics.MiddleName
  String
  Possible
  Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
- Patient.Demographics.LastName
  String
  Reliable
  Patient's last name
- Patient.Demographics.DOB
  String
  Reliable
  Patient's date of birth.
  In ISO 8601 format
- Patient.Demographics.SSN
  String
  Probable
  Patient's social security number
- Patient.Demographics.Sex
  String
  Reliable
  Patient's sex
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Race
  String
  Possible
  Patient's race.
  Supported Values
- Patient.Demographics.IsHispanic
  Boolean
  Possible
  Indicates if the patient is of hispanic origin.
- Patient.Demographics.MaritalStatus
  String
  Possible
  Patient's marital status
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.IsDeceased
  Boolean
  Possible
  Indicates if the patient is deceased
- Patient.Demographics.DeathDateTime
  DateTime
  Possible
  Date and Time the patient was proclaimed deceased.
  ISO 8601 Format
- Patient.Demographics.PhoneNumber.Home
  String
  Probable
  Patient's home phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Office
  String
  Probable
  Patient's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Mobile
  String
  Probable
  Patient's mobile phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.EmailAddresses[]
  Array of Strings
  Probable
  Patient's email address(es)
- Patient.Demographics.Language
  String
  Possible
  Patient's primary spoken language.
  In ISO 639-1 alpha values (e.g. 'en'). Supported Values
- Patient.Demographics.Citizenship[]
  Array of strings
  Possible
  Patient's nation(s) of citizenship.
  *In ISO 3166 alpha 2 format (e.g. 'US'). Reference Table.
  
  Note: The valid set of citizenships is a smaller list than the list of IS0 3166 country codes, and should be limited to the 193 United Nations countries plus 6 states: ROC Taiwan, Macao (SAR China), Hong Kong (SAR China), Kosovo, Palestinian Territory and the Vatican.*
- Patient.Demographics.Address
  Object
  Probable
  Patient's home address
- Patient.Demographics.Address.StreetAddress
  String
  Probable
  Street address
- Patient.Demographics.Address.City
  String
  Probable
  City
- Patient.Demographics.Address.State
  String
  Probable
  State
- Patient.Demographics.Address.ZIP
  String
  Probable
  ZIP
- Patient.Demographics.Address.County
  String
  Possible
  County
- Patient.Demographics.Address.Country
  String
  Possible
  Country
- Patient.Notes[]
  Array of strings
  Possible
  Patient-level notes
- Patient.Contacts[].FirstName
  String
  Possible
  First name of the contact
- Patient.Contacts[].MiddleName
  String
  Possible
  Middle name of the contact
- Patient.Contacts[].LastName
  String
  Possible
  Last name of the contact
- Patient.Contacts[].Address
  Object
  Possible
  Address of the contact
- Patient.Contacts[].Address.StreetAddress
  String
  Possible
  Street address
- Patient.Contacts[].Address.City
  String
  Possible
  City
- Patient.Contacts[].Address.State
  String
  Possible
  State
- Patient.Contacts[].Address.ZIP
  String
  Possible
  ZIP
- Patient.Contacts[].Address.County
  String
  Possible
  County
- Patient.Contacts[].Address.Country
  String
  Possible
  Country
- Patient.Contacts[].PhoneNumber.Home
  String
  Possible
  Home phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Contacts[].PhoneNumber.Office
  String
  Possible
  Office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Contacts[].PhoneNumber.Mobile
  String
  Probable
  Mobile phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Contacts[].RelationToPatient
  String
  Possible
  Personal relationship to the patient.
  e.x. Father, Spouse
- Patient.Contacts[].EmailAddresses[]
  Array of string
  Possible
  Email address(es) of the contact person
- Patient.Contacts[].Roles[]
  Array of strings
  Possible
  Role of this contact for the patient.
  e.x. Employer, Emergency Contact
- Patient.Allergies[]
  Array of Objects
  Possible
  List of a patient's allergies
- Patient.Allergies[].Code
  String
  Possible
  Code for the allergy
- Patient.Allergies[].Codeset
  String
  Possible
  Code set used to identify the allergy.
  Typically RxNorm or SNOMED
- Patient.Allergies[].Name
  String
  Possible
  Name of the allergy
- Patient.Allergies[].Type
  Object
  Possible
  The type of allergy intolerance (food, drug, etc.)
- Patient.Allergies[].Type.Code
  String
  Possible
  Code for the allergy intolerance type
- Patient.Allergies[].Type.Codeset
  String
  Possible
  Code set used to identify the allergy intolerance type
- Patient.Allergies[].Type.Name
  String
  Possible
  Name of the allergy intolerance type
- Patient.Allergies[].OnsetDateTime
  String
  Possible
  DateTime the allergy was identified
- Patient.Allergies[].Reaction[]
  Array of Objects
  Possible
  The list of reactions caused by this particular allergy.
- Patient.Allergies[].Reaction[].Code
  String
  Possible
  Code for the reaction
- Patient.Allergies[].Reaction[].Codeset
  String
  Possible
  Code set used to identify the reaction
- Patient.Allergies[].Reaction[].Name
  String
  Possible
  Name of the reaction
- Patient.Allergies[].Severity
  Object
  Possible
  The severity of the reaction (moderate, severe, etc.).
- Patient.Allergies[].Severity.Code
  String
  Possible
  Code for the reaction severity
- Patient.Allergies[].Severity.Codeset
  String
  Possible
  Code set used to identify the reaction severity
- Patient.Allergies[].Severity.Name
  String
  Possible
  Name of the reaction severity
- Patient.Allergies[].Status
  string
  Possible
  The current status of the allergy.
  One of the following: "Active", "Inactive", "Resolved".
- Patient.PCP
  Object
  Reliable
  Primary Care Provider for the Patient
- Patient.PCP.NPI
  String
  Reliable
  NPI of the PCP
- Patient.PCP.ID
  String
  Reliable
  ID of the PCP.
  This ID is often required for Inpatient Visits.
- Patient.PCP.IDType
  String
  Reliable
  ID type of the ID for the PCP
- Patient.PCP.FirstName
  String
  Possible
  First name of the PCP
- Patient.PCP.LastName
  String
  Possible
  Last name of the PCP
- Patient.PCP.Credentials[]
  Array of Strings
  Possible
  List of credentials for the PCP.
  e.g. MD, PhD
- Patient.PCP.Address
  Object
  Possible
  Provider's address
- Patient.PCP.Address.StreetAddress
  String
  Possible
  Street address
- Patient.PCP.Address.City
  String
  Possible
  City
- Patient.PCP.Address.State
  String
  Possible
  State
- Patient.PCP.Address.ZIP
  String
  Possible
  ZIP
- Patient.PCP.Address.County
  String
  Possible
  County
- Patient.PCP.Address.Country
  String
  Possible
  Country
- Patient.PCP.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.PCP.Location
  Object
  Possible
  Provider's location
- Patient.PCP.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Patient.PCP.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Patient.PCP.Location.Department
  String
  Possible
  Department
- Patient.PCP.Location.Room
  String
  Possible
  Room.
  Example: 136
- Patient.Guarantor
  Object
  Possible
  Person ultimately responsible for the bill of the appointment
- Patient.Guarantor.Number
  String
  Probable
  Number of the guarantor
- Patient.Guarantor.FirstName
  String
  Probable
  First name
- Patient.Guarantor.LastName
  String
  Probable
  Last name
- Patient.Guarantor.SSN
  String
  Possible
  Guarantor's social security number
- Patient.Guarantor.DOB
  String
  Possible
  Guarantor's date of birth.
  In ISO 8601 format
- Patient.Guarantor.Sex
  String
  Possible
  Guarantor's sex
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Guarantor.Spouse.FirstName
  String
  Probable
  Spouse's first name
- Patient.Guarantor.Spouse.LastName
  String
  Probable
  Spouse's last name
- Patient.Guarantor.Address
  Object
  Probable
  Address of the guarantor
- Patient.Guarantor.Address.StreetAddress
  String
  Probable
  Street address
- Patient.Guarantor.Address.City
  String
  Probable
  City
- Patient.Guarantor.Address.State
  String
  Probable
  State
- Patient.Guarantor.Address.ZIP
  String
  Probable
  ZIP
- Patient.Guarantor.Address.County
  String
  Possible
  County
- Patient.Guarantor.Address.Country
  String
  Possible
  Country
- Patient.Guarantor.PhoneNumber.Home
  String
  Probable
  Home phone number.
  In E. 164 Format (i.e. +16085551234)
- Patient.Guarantor.PhoneNumber.Business
  String
  Probable
  Business phone number.
  In E. 164 Format (i.e. +16085551234)
- Patient.Guarantor.PhoneNumber.Mobile
  String
  Probable
  Mobile phone number.
  In E. 164 Format (i.e. +16085551234)
- Patient.Guarantor.EmailAddresses[]
  Array of Strings
  Probable
  Guarantor's email address(es)
- Patient.Guarantor.Type
  String
  Probable
  Type of guarantor.
  E.g. institution, individual
- Patient.Guarantor.RelationToPatient
  String
  Probable
  Relation to the patient.
  E.g. self, parent
- Patient.Guarantor.Employer.Name
  String
  Probable
  Employer's name
- Patient.Guarantor.Employer.Address
  Object
  Probable
  Employer's address
- Patient.Guarantor.Employer.Address.StreetAddress
  String
  Probable
  Street address
- Patient.Guarantor.Employer.Address.City
  String
  Probable
  City
- Patient.Guarantor.Employer.Address.State
  String
  Probable
  State
- Patient.Guarantor.Employer.Address.ZIP
  String
  Probable
  ZIP
- Patient.Guarantor.Employer.Address.County
  String
  Possible
  County
- Patient.Guarantor.Employer.Address.Country
  String
  Possible
  Country
- Patient.Guarantor.Employer.PhoneNumber
  String
  Probable
  Employer phone number.
  In E. 164 Format (i.e. +16085551234)
- Patient.Insurances[]
  Array of Objects
  Probable
  List of insurance coverages for the patient
- Patient.Insurances[].Plan.ID
  String
  Probable
  Identifier of insurance plan
- Patient.Insurances[].Plan.IDType
  String
  Probable
  ID type of insurance plan
- Patient.Insurances[].Plan.Name
  String
  Probable
  Name of insurance plan
- Patient.Insurances[].Plan.Type
  String
  Possible
  Type of insurance plan
- Patient.Insurances[].MemberNumber
  String
  Possible
  Patient member number
- Patient.Insurances[].Company.ID
  String
  Probable
  ID of insurance company (payor)
- Patient.Insurances[].Company.IDType
  String
  Probable
  ID type of insurance company (payor)
- Patient.Insurances[].Company.Name
  String
  Probable
  Name of insurance company (payor)
- Patient.Insurances[].Company.Address
  Object
  Probable
  Insurance company's address
- Patient.Insurances[].Company.Address.StreetAddress
  String
  Probable
  Street address
- Patient.Insurances[].Company.Address.City
  String
  Probable
  City
- Patient.Insurances[].Company.Address.State
  String
  Probable
  State
- Patient.Insurances[].Company.Address.ZIP
  String
  Probable
  ZIP
- Patient.Insurances[].Company.Address.County
  String
  Possible
  County
- Patient.Insurances[].Company.Address.Country
  String
  Possible
  Country
- Patient.Insurances[].Company.PhoneNumber
  String
  Probable
  Insurance companys phone number.
  In E. 164 Format (i.e. +16085551234)
- Patient.Insurances[].GroupNumber
  String
  Probable
  Insurance policy group number
- Patient.Insurances[].GroupName
  String
  Probable
  Insurance policy group name
- Patient.Insurances[].EffectiveDate
  String
  Probable
  Effect date of this insurance policy.
  In YYYY-MM-DD format
- Patient.Insurances[].ExpirationDate
  String
  Probable
  Expiration date of this insurance policy.
  In YYYY-MM-DD format
- Patient.Insurances[].PolicyNumber
  String
  Probable
  Insurance policy number
- Patient.Insurances[].AgreementType
  String
  Probable
  Type of insurance agreement.
  One of the following: "Standard", "Unified", "Maternity"
- Patient.Insurances[].CoverageType
  String
  Probable
  Type of insurance agreement.
  One of the following: "Patient", "Clinic", "Insurance", "Other". Indicates who will be receiving the bill for the service.
- Patient.Insurances[].Insured
  Object
  Possible
  Individual who has the agreement with the insurance company for the related policy
- Patient.Insurances[].Insured.Identifiers[]
  Array of Objects
  Possible
  List of IDs and ID types that identify the insured
- Patient.Insurances[].Insured.Identifiers[].ID
  String
  Possible
  ID for the insured
- Patient.Insurances[].Insured.Identifiers[].IDType
  String
  Possible
  Type of ID.
  E.g. MRN, EPI
- Patient.Insurances[].Insured.LastName
  String
  Possible
  Last name of the insured
- Patient.Insurances[].Insured.FirstName
  String
  Possible
  First name of the insured
- Patient.Insurances[].Insured.SSN
  String
  Possible
  Insured's social security number
- Patient.Insurances[].Insured.Relationship
  String
  Possible
  Relationship of the insured to the patient.
  One of the following: "Self", "Spouse", "Other".
- Patient.Insurances[].Insured.DOB
  String
  Possible
  Date of birth of the insured.
  In YYYY-MM-DD format
- Patient.Insurances[].Insured.Sex
  String
  Possible
  Sex of the insured
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Insurances[].Insured.Address
  Object
  Probable
  Address of the insured
- Patient.Insurances[].Insured.Address.StreetAddress
  String
  Probable
  Street address
- Patient.Insurances[].Insured.Address.City
  String
  Probable
  City
- Patient.Insurances[].Insured.Address.State
  String
  Probable
  State
- Patient.Insurances[].Insured.Address.ZIP
  String
  Probable
  ZIP
- Patient.Insurances[].Insured.Address.County
  String
  Possible
  County
- Patient.Insurances[].Insured.Address.Country
  String
  Possible
  Country

resourceType
- resourceType
  string
  Bundle
type
- type
  code
  Currently, Redox supports only the 'Message' Type
entry
- entry
  The entry field corresponds to an array of FHIR Resources. For PatientAdmin, the Message Header and Patient resources are required, and the Practitioner (representing the attending provider) and some Location resources are allowed.
- entry[].fullUrl
  uri
  Absolute URL for resource.
  Ex: server address or UUID/OID.
entry[].resource - MessageHeader
- entry[].resource
  MessageHeader Resource Information
- entry[].resource.id
  id
  Logical id of this artifact
- entry[].resource.resourceType
  string
  MessageHeader
- entry[].resource.event
  Coding
  Code for the event this message represents
- entry[].resource.event.code
  code
- entry[].resource.timestamp
  instant
  Time that the message was sent
- entry[].resource.source
  Message source application
- entry[].resource.source.name
  string
  Name of the source system
- entry[].resource.source.endpoint
  uri
  Actual message source address or id
- entry[].resource.focus
  Reference
  Pointers to the actual content of the message
- entry[].resource.focus[].reference
  string
  References to the rest of the bundle
entry[].resource - Patient
- entry[].resource.resourceType
  string
  Patient
- entry[].resource.identifier
  Identifier
  A list of identifiers for this patient
- entry[].resource.identifier[].value
  string
- entry[].resource.identifier[].system
  string
  Establishes the namespace for the value - that is, a URL that describes a set of values that are unique
- entry[].resource.birthdate
  date
  Data of birth for the patient
- entry[].resource.telecom
  ContactPoint
  A contact detail for the patient
- entry[].resource.telecom[].value
  string
- entry[].resource.telecom[].system
  string
  A contact detail for the patient.
  Redox currently only supports values of phone and email for this field.
- entry[].resource.telecom[].use
  string
  Purpose of the contact point
- entry[].resource.address
  Address
  Address(es) of the patient
- entry[].resource.address[].line[]
  string[]
  Street name, number, direction & P.O. Box etc.
- entry[].resource.address[].city
  string
  Name of city
- entry[].resource.address[].district
  string
  District (county) name
- entry[].resource.address[].state
  string
  Name, or abbreviation, of the state
- entry[].resource.address[].postalCode
  string
  Postal code for the area
- entry[].resource.address[].country
  string
  Country.
  Can be ISO 3166 2 or 3 letter code.
- entry[].resource.address[].use
  string
  The purpose of the address
- entry[].resource.name
  HumanName
  Required
  A list of names associated with the patient
- entry[].resource.name[].family
  string
  Often called 'Surname.'
- entry[].resource.name[].given[]
  string[]
- entry[].resource.gender
  string
  Required
  Administrative gender for the patient.
  The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. One of male, female, other, or unknown.
- entry[].resource.maritalStatus
  CodeableConcept
  Marital Status of a patient
- entry[].resource.maritalStatus.text
  string
- entry[].resource.extension
  Extension
  Additional Content defined by implementations
- entry[].resource.extension[].url
  string
- entry[].resource.extension[].extension
  Extension
- entry[].resource.extension[].extension[].url
  string
- entry[].resource.extension[].extension[].valueString
  string
- entry[].resource.communication
  A list of languages which may be used to communicate with the patient.
- entry[].resource.communication[].language
  CodeableConcept
- entry[].resource.communication[].language.text
  string
- entry[].resource.communication[].language.coding
  Coding
- entry[].resource.communication[].language.coding.code
  code
  Symbol defined by the system
- entry[].resource.communication[].language.coding.system
  uri
  Identity/namespace of the terminology system
- entry[].resource.communication[].language.coding.display
  string
  Display value of the code, as defined by the system
entry[].resource - Practitioner
- entry[].resource.resourceType
  string
  Practitioner
- entry[].resource.active
  boolean
  Whether this practitioner's record is in active use
- entry[].resource.identifier
  Identifier
  Required
  A list of identifiers that apply to this person in this role
- entry[].resource.identifier[].value
  string
  Unique value identifier
- entry[].resource.identifier[].system
  string
  Establishes the namespace for the value - that is, a URL that describes a set of values that are unique
- entry[].resource.telecom
  ContactPoint
  Contact information for the practitioner
- entry[].resource.telecom[].value
  string
  Actual contact point details
- entry[].resource.telecom[].system
  string
  A contact detail for the practitioner (that apply to all roles).
  Redox currently only supports values of phone and email for this field.
- entry[].resource.telecom[].use
  string
  Purpose of the contact point
- entry[].resource.address
  Address
  Address(es) of the practitioner.
  Address(es) are not role specific.
- entry[].resource.address[].line[]
  string[]
  Street name, number, direction & P.O. Box etc.
- entry[].resource.address[].city
  string
  Name of city
- entry[].resource.address[].district
  string
  District (county) name
- entry[].resource.address[].state
  string
  Name, or abbreviation, of the state
- entry[].resource.address[].postalCode
  string
  Postal code for the area
- entry[].resource.address[].country
  string
  Country.
  Can be ISO 3166 2 or 3 letter code.
- entry[].resource.address[].use
  string
  Required
  The purpose of the address
- entry[].resource.name
  HumanName
  Required
  The name(s) associated with the practitioner.
- entry[].resource.name[].family
  string
  Family name.
  Often called 'Surname.'
- entry[].resource.name[].given[]
  string[]
  Given names (not always 'first'). Includes middle names.
  Given names appear in the correct order for presenting the name.
- entry[].resource.qualification
  Qualifications obtained by training and certification.
- entry[].resource.qualification[].code
  CodeableConcept
  Coded representation of the qualification.
- entry[].resource.qualification[].code.text
  string
  Text representation of the qualification.
- entry[].resource.qualification[].code.coding
  Coding
- entry[].resource.qualification[].code.coding.code
  code
  Symbol defined by the system
- entry[].resource.qualification[].code.coding.system
  uri
  Identity/namespace of the terminology system
- entry[].resource.qualification[].code.coding.display
  string
  Display value of the code, as defined by the system
entry[].resource - Coverage
- entry[].resource.resourceType
  string
  Coverage
- entry[].resource.identifier
  Identifier
  A list of identifiers for this coverage
- entry[].resource.identifier[].value
  id
- entry[].resource.identifier[].system
  string
  Establishes the namespace for the value - that is, a URL that describes a set of values that are unique
- entry[].resource.status
  code
  active | cancelled | draft | entered-in-error
- entry[].resource.grouping
  Additional coverage classifications
- entry[].resource.grouping.group
  string
  An identifier for the group
- entry[].resource.grouping.groupDisplay
  string
  Display name for the group
- entry[].resource.grouping.plan
  string
  An identifier for the plan
- entry[].resource.grouping.planDisplay
  string
  Display name for the plan
- entry[].resource.beneficiary
  Reference
  Subscriber to the policy
- entry[].resource.beneficiary.reference
  string
  Pointer to the patient who is the beneficiary
- entry[].resource.period
  Period
  Coverage start and end dates
- entry[].resource.period.start
  dateTime
  Coverage start date
- entry[].resource.period.end
  dateTime
  Coverage end date
- entry[].resource.payor
  Reference
  Identifier for the plan or agreement issuer
- entry[].resource.payor.reference
  string
  Pointer to the payor (will be a contained resource)
- entry[].resource.contained[]
  []
  Organization resource for the payor
- entry[].resource.contained[].resourceType
  string
  Organization
- entry[].resource.contained[].identifier
  Identifier
  A list of identifiers for this organization
- entry[].resource.contained[].identifier[].value
  string
- entry[].resource.contained[].identifier[].system
  string
  Establishes the namespace for the value - that is, a URL that describes a set of values that are unique
- entry[].resource.contained[].telecom
  ContactPoint
  A contact detail for the patient
- entry[].resource.contained[].telecom[].value
  string
- entry[].resource.contained[].telecom[].system
  string
  Contact information for the organization.
  Redox currently only supports values of phone and email for this field.
- entry[].resource.contained[].telecom[].use
  string
  Purpose of the contact point
- entry[].resource.contained[].name
  string
  Name of the organization
- entry[].resource.contained[].address[]
  Address[]
  Address(es) of the of the organization
- entry[].resource.contained[].address[].line[]
  string[]
  Street name, number, direction & P.O. Box etc.
- entry[].resource.contained[].address[].city
  string
  Name of city
- entry[].resource.contained[].address[].district
  string
  District (county) name
- entry[].resource.contained[].address[].state
  string
  Name, or abbreviation, of the state
- entry[].resource.contained[].address[].postalCode
  string
  Postal code for the area
- entry[].resource.contained[].address[].country
  string
  Country.
  Can be ISO 3166 2 or 3 letter code.
- entry[].resource.contained[].address[].use
  string
  The purpose of the address

Sample MessageDownload JSON Schema

{
   "resourceType": "Bundle",
   "type": "message",
   "entry": [
      {
         "fullUrl": "urn:uuid:e2a360e3-a712-4bae-a04d-6c42fed7c8c6",
         "resource": {
            "id": "transmission-12414",
            "resourceType": "MessageHeader",
            "event": {
               "code": "PatientAdmin-NewPatient"
            },
            "timestamp": "2019-05-10T17:23:19.864Z",
            "source": {
               "name": "Redox Dev Tools",
               "endpoint": "urn:uuid:7ce6f387-c33c-417d-8682-81e83628cbd9"
            },
            "focus": [
               {
                  "reference": "urn:uuid:2a9cdeda-1979-4c90-8248-702e6fa3a569"
               },
               {
                  "reference": "urn:uuid:9a623a89-1b17-40bc-b155-754d44cf78ba"
               },
               {
                  "reference": "urn:uuid:23f2b873-6605-44d9-97e0-7ef4290c562a"
               },
               {
                  "reference": "urn:uuid:4e596424-0e65-4722-9b93-80e6f6cb37cb"
               }
            ]
         }
      },
      {
         "fullUrl": "urn:uuid:2a9cdeda-1979-4c90-8248-702e6fa3a569",
         "resource": {
            "resourceType": "Patient",
            "identifier": [
               {
                  "value": "0000000001",
                  "system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:MR"
               },
               {
                  "value": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
                  "system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:EHRID"
               },
               {
                  "value": "a1d4ee8aba494ca",
                  "system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:NIST"
               },
               {
                  "value": "101-01-0001",
                  "system": "http://hl7.org/fhir/sid/us-ssn"
               }
            ],
            "birthDate": "2008-01-06",
            "telecom": [
               {
                  "value": "+18088675301",
                  "system": "phone",
                  "use": "home"
               }
            ],
            "address": [
               {
                  "line": [
                     "4762 Hickory Street"
                  ],
                  "city": "Monroe",
                  "district": "Green",
                  "state": "WI",
                  "postalCode": "53566",
                  "country": "US",
                  "use": "home"
               }
            ],
            "name": [
               {
                  "family": "Bixby",
                  "given": [
                     "Timothy",
                     "Paul"
                  ]
               }
            ],
            "gender": "male",
            "maritalStatus": {
               "text": "Married",
               "coding": [
                  {
                     "code": "M",
                     "system": "http://hl7.org/fhir/v3/MaritalStatus",
                     "display": "Married"
                  }
               ]
            },
            "extension": [
               {
                  "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
                  "extension": [
                     {
                        "url": "text",
                        "valueString": "White"
                     }
                  ]
               }
            ],
            "communication": [
               {
                  "language": {
                     "text": "en",
                     "coding": [
                        {
                           "code": "en",
                           "system": "urn:ietf:bcp:47"
                        }
                     ]
                  }
               }
            ],
            "contact": [
               {
                  "name": {
                     "family": "Bixby",
                     "given": [
                        "Barbara"
                     ]
                  },
                  "address": {
                     "line": [
                        "4762 Hickory Street"
                     ],
                     "city": "Monroe",
                     "district": "Green",
                     "state": "WI",
                     "postalCode": "53566",
                     "country": "US"
                  },
                  "telecom": [
                     {
                        "value": "+18088675303",
                        "system": "phone",
                        "use": "home"
                     },
                     {
                        "value": "+17077543758",
                        "system": "phone",
                        "use": "work"
                     },
                     {
                        "value": "+19189368865",
                        "system": "phone",
                        "use": "mobile"
                     },
                     {
                        "value": "barb.bixby@test.net",
                        "system": "email"
                     }
                  ],
                  "relationship": [
                     {
                        "text": "Mother",
                        "coding": [
                           {
                              "code": "MTH",
                              "system": "http://hl7.org/fhir/v3/RoleCode",
                              "display": "mother"
                           }
                        ]
                     },
                     {
                        "text": "Emergency Contact",
                        "coding": [
                           {
                              "code": "C",
                              "system": "http://hl7.org/fhir/v2/0131",
                              "display": "Emergency Contact"
                           }
                        ]
                     }
                  ]
               }
            ],
            "generalPractitioner": [
               {
                  "reference": "urn:uuid:9a623a89-1b17-40bc-b155-754d44cf78ba"
               }
            ]
         }
      },
      {
         "fullUrl": "urn:uuid:9a623a89-1b17-40bc-b155-754d44cf78ba",
         "resource": {
            "resourceType": "Practitioner",
            "active": true,
            "identifier": [
               {
                  "value": "4356789876",
                  "system": "http://hl7.org/fhir/sid/us-npi"
               }
            ],
            "telecom": [
               {
                  "value": "+16085551234",
                  "system": "phone",
                  "use": "work"
               }
            ],
            "address": [
               {
                  "line": [
                     "123 Main St."
                  ],
                  "city": "Madison",
                  "district": "Dane",
                  "state": "WI",
                  "postalCode": "53703",
                  "country": "USA"
               }
            ],
            "name": [
               {
                  "family": "Granite",
                  "given": [
                     "Pat"
                  ]
               }
            ],
            "qualification": [
               {
                  "code": {
                     "text": "MD",
                     "coding": [
                        {
                           "code": "MD",
                           "system": "http://hl7.org/fhir/v2/0360/2.7",
                           "display": "Doctor of Medicine"
                        }
                     ]
                  }
               }
            ]
         }
      },
      {
         "fullUrl": "urn:uuid:23f2b873-6605-44d9-97e0-7ef4290c562a",
         "resource": {
            "identifier": [
               {
                  "value": "9140860055",
                  "system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:POLNUM"
               }
            ],
            "resourceType": "Coverage",
            "status": "active",
            "grouping": {
               "group": "847025-024-0009",
               "groupDisplay": "Accelerator Labs",
               "plan": "31572",
               "planDisplay": "HMO Deductable Plan"
            },
            "beneficiary": {
               "reference": "urn:uuid:2a9cdeda-1979-4c90-8248-702e6fa3a569"
            },
            "period": {
               "start": "2015-01-01",
               "end": "2020-12-31"
            },
            "contained": [
               {
                  "resourceType": "Organization",
                  "id": "company",
                  "identifier": [
                     {
                        "value": "60054"
                     }
                  ],
                  "telecom": [
                     {
                        "value": "+18089541123",
                        "system": "phone"
                     }
                  ],
                  "name": "aetna (60054 0131)",
                  "address": [
                     {
                        "line": [
                           "PO Box 14080"
                        ],
                        "city": "Lexington",
                        "district": "Fayette",
                        "state": "KY",
                        "postalCode": "40512-4079",
                        "country": "US"
                     }
                  ]
               }
            ],
            "payor": [
               {
                  "reference": "#company"
               }
            ]
         }
      },
      {
         "fullUrl": "urn:uuid:4e596424-0e65-4722-9b93-80e6f6cb37cb",
         "resource": {
            "resourceType": "Account",
            "subject": {
               "reference": "urn:uuid:2a9cdeda-1979-4c90-8248-702e6fa3a569"
            },
            "status": "active",
            "contained": [
               {
                  "resourceType": "RelatedPerson",
                  "id": "5a5c9d27-ada0-4897-aaf2-cdb0e87a1c2c",
                  "identifier": [
                     {
                        "value": "10001910"
                     }
                  ],
                  "patient": {
                     "reference": "urn:uuid:2a9cdeda-1979-4c90-8248-702e6fa3a569"
                  },
                  "relationship": {
                     "text": "Father"
                  },
                  "name": [
                     {
                        "given": [
                           "Kent"
                        ],
                        "family": "Bixby"
                     }
                  ],
                  "address": [
                     {
                        "line": [
                           "4762 Hickory Street"
                        ],
                        "city": "Monroe",
                        "district": "Green",
                        "state": "WI",
                        "postalCode": "53566",
                        "country": "USA"
                     }
                  ],
                  "extension": [
                     {
                        "url": "https://fhir.redoxengine.com/StructureDefinition/relatedperson-spousename",
                        "valueHumanName": {
                           "given": [
                              "Barbara"
                           ],
                           "family": "Bixby"
                        }
                     },
                     {
                        "url": "https://fhir.redoxengine.com/StructureDefinition/relatedperson-employer",
                        "valueReference": {
                           "reference": "#18241dab-ccf2-428e-a447-9d80ffbb0f59"
                        }
                     }
                  ]
               },
               {
                  "resourceType": "Organization",
                  "id": "18241dab-ccf2-428e-a447-9d80ffbb0f59",
                  "name": "Accelerator Labs",
                  "address": [
                     {
                        "line": [
                           "1456 Old Sauk Road"
                        ],
                        "city": "Madison",
                        "district": "Dane",
                        "state": "WI",
                        "postalCode": "53719",
                        "country": "USA"
                     }
                  ],
                  "telecom": [
                     {
                        "value": "+18083451121",
                        "system": "phone",
                        "use": "work"
                     }
                  ]
               }
            ],
            "guarantor": [
               {
                  "party": {
                     "reference": "#5a5c9d27-ada0-4897-aaf2-cdb0e87a1c2c"
                  }
               }
            ]
         }
      }
   ]
}

{
   "Meta": {
      "DataModel": "PatientAdmin",
      "EventType": "NewPatient",
      "EventDateTime": "2019-05-10T17:23:19.864Z",
      "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": [
               "barb.bixby@test.net"
            ],
            "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"
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         }
      },
      "Guarantor": {
         "Number": "10001910",
         "FirstName": "Kent",
         "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 Deductable 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,
               "FirstName": null,
               "SSN": null,
               "Relationship": null,
               "DOB": null,
               "Sex": null,
               "Address": {
                  "StreetAddress": null,
                  "City": null,
                  "State": null,
                  "ZIP": null,
                  "County": null,
                  "Country": null
               }
            }
         }
      ]
   }
}

PatientUpdateBETA

View R^FHIR Event Type

A Patient Update message is generated when any patient or registration information changes while the patient is not currently admitted.

Fields

Show Required Fields Only

Meta
- Meta.DataModel
  String
  Reliable
  Required
  Data model.
  E.g. Scheduling, Results
- Meta.EventType
  String
  Reliable
  Required
  Type of event.
  Patient Update
- Meta.EventDateTime
  DateTime
  Reliable
  DateTime of the event.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Flag as a test message
- Meta.Source
  String
  Reliable
  Where the message originated.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  ID of the source.
  UUID
- Meta.Source.Name
  String
  Reliable
  Name of the source
- Meta.Destinations[]
  Array of Objects
  Reliable
  List of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
  Required when sending data to Redox
- Meta.Destinations[].ID
  String
  Reliable
  ID of the destination.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Name of the destination
- Meta.Message
  String
  Reliable
  Record in Redox that corresponds to the communication sent from the source to Redox.
  Included in messages from Redox
- Meta.Message.ID
  Numeric
  Reliable
  ID of the message created in Redox
- Meta.Transmission
  String
  Reliable
  Record in Redox that corresponds to the communication sent from Redox to your destination.
  Included in messages from Redox
- Meta.Transmission.ID
  Numeric
  Reliable
  ID of the transmission created in Redox
- Meta.FacilityCode
  String
  Possible
  Code for the facility related to the message.
  Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
- Patient.Identifiers[]
  Array of Objects
  Reliable
  List of IDs and ID types that identify the patient
- Patient.Identifiers[].ID
  String
  Reliable
  Required
  ID for the patient
- Patient.Identifiers[].IDType
  String
  Reliable
  Required
  Type of ID.
  E.g. MRN, EPI
- Patient.Demographics.FirstName
  String
  Reliable
  Patient's first name
- Patient.Demographics.MiddleName
  String
  Possible
  Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
- Patient.Demographics.LastName
  String
  Reliable
  Patient's last name
- Patient.Demographics.DOB
  String
  Reliable
  Patient's date of birth.
  In ISO 8601 format
- Patient.Demographics.SSN
  String
  Probable
  Patient's social security number
- Patient.Demographics.Sex
  String
  Reliable
  Patient's sex
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Race
  String
  Possible
  Patient's race.
  Supported Values
- Patient.Demographics.IsHispanic
  Boolean
  Possible
  Indicates if the patient is of hispanic origin.
- Patient.Demographics.MaritalStatus
  String
  Possible
  Patient's marital status
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.IsDeceased
  Boolean
  Possible
  Indicates if the patient is deceased
- Patient.Demographics.DeathDateTime
  DateTime
  Possible
  Date and Time the patient was proclaimed deceased.
  ISO 8601 Format
- Patient.Demographics.PhoneNumber.Home
  String
  Probable
  Patient's home phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Office
  String
  Probable
  Patient's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Mobile
  String
  Probable
  Patient's mobile phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.EmailAddresses[]
  Array of Strings
  Probable
  Patient's email address(es)
- Patient.Demographics.Language
  String
  Possible
  Patient's primary spoken language.
  In ISO 639-1 alpha values (e.g. 'en'). Supported Values
- Patient.Demographics.Citizenship[]
  Array of strings
  Possible
  Patient's nation(s) of citizenship.
  *In ISO 3166 alpha 2 format (e.g. 'US'). Reference Table.
  
  Note: The valid set of citizenships is a smaller list than the list of IS0 3166 country codes, and should be limited to the 193 United Nations countries plus 6 states: ROC Taiwan, Macao (SAR China), Hong Kong (SAR China), Kosovo, Palestinian Territory and the Vatican.*
- Patient.Demographics.Address
  Object
  Probable
  Patient's home address
- Patient.Demographics.Address.StreetAddress
  String
  Probable
  Street address
- Patient.Demographics.Address.City
  String
  Probable
  City
- Patient.Demographics.Address.State
  String
  Probable
  State
- Patient.Demographics.Address.ZIP
  String
  Probable
  ZIP
- Patient.Demographics.Address.County
  String
  Possible
  County
- Patient.Demographics.Address.Country
  String
  Possible
  Country
- Patient.Notes[]
  Array of strings
  Possible
  Patient-level notes
- Patient.Contacts[].FirstName
  String
  Possible
  First name of the contact
- Patient.Contacts[].MiddleName
  String
  Possible
  Middle name of the contact
- Patient.Contacts[].LastName
  String
  Possible
  Last name of the contact
- Patient.Contacts[].Address
  Object
  Possible
  Address of the contact
- Patient.Contacts[].Address.StreetAddress
  String
  Possible
  Street address
- Patient.Contacts[].Address.City
  String
  Possible
  City
- Patient.Contacts[].Address.State
  String
  Possible
  State
- Patient.Contacts[].Address.ZIP
  String
  Possible
  ZIP
- Patient.Contacts[].Address.County
  String
  Possible
  County
- Patient.Contacts[].Address.Country
  String
  Possible
  Country
- Patient.Contacts[].PhoneNumber.Home
  String
  Possible
  Home phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Contacts[].PhoneNumber.Office
  String
  Possible
  Office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Contacts[].PhoneNumber.Mobile
  String
  Probable
  Mobile phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Contacts[].RelationToPatient
  String
  Possible
  Personal relationship to the patient.
  e.x. Father, Spouse
- Patient.Contacts[].EmailAddresses[]
  Array of string
  Possible
  Email address(es) of the contact person
- Patient.Contacts[].Roles[]
  Array of strings
  Possible
  Role of this contact for the patient.
  e.x. Employer, Emergency Contact
- Patient.Diagnoses[]
  Array of Objects
  Probable
  List of diagnoses associated with this visit
- Patient.Diagnoses[].Code
  String
  Probable
  Code for the diagnosis
- Patient.Diagnoses[].Codeset
  String
  Probable
  Code set used to identify the diagnosis.
  One of the following: ICD-9, ICD-10, HCPCS, CPT
- Patient.Diagnoses[].Name
  String
  Probable
  Name of the diagnosis
- Patient.Diagnoses[].Type
  String
  Possible
  Type of the diagnosis.
  One of the following: Admitting, Working, or Final
- Patient.Diagnoses[].DocumentedDateTime
  String
  Possible
  DateTime the diagnosis was documented.
  ISO 8601 Format
- Patient.Allergies[]
  Array of Objects
  Possible
  List of a patient's allergies
- Patient.Allergies[].Code
  String
  Possible
  Code for the allergy
- Patient.Allergies[].Codeset
  String
  Possible
  Code set used to identify the allergy.
  Typically RxNorm or SNOMED
- Patient.Allergies[].Name
  String
  Possible
  Name of the allergy
- Patient.Allergies[].Type
  Object
  Possible
  The type of allergy intolerance (food, drug, etc.)
- Patient.Allergies[].Type.Code
  String
  Possible
  Code for the allergy intolerance type
- Patient.Allergies[].Type.Codeset
  String
  Possible
  Code set used to identify the allergy intolerance type
- Patient.Allergies[].Type.Name
  String
  Possible
  Name of the allergy intolerance type
- Patient.Allergies[].OnsetDateTime
  String
  Possible
  DateTime the allergy was identified
- Patient.Allergies[].Reaction[]
  Array of Objects
  Possible
  The list of reactions caused by this particular allergy.
- Patient.Allergies[].Reaction[].Code
  String
  Possible
  Code for the reaction
- Patient.Allergies[].Reaction[].Codeset
  String
  Possible
  Code set used to identify the reaction
- Patient.Allergies[].Reaction[].Name
  String
  Possible
  Name of the reaction
- Patient.Allergies[].Severity
  Object
  Possible
  The severity of the reaction (moderate, severe, etc.).
- Patient.Allergies[].Severity.Code
  String
  Possible
  Code for the reaction severity
- Patient.Allergies[].Severity.Codeset
  String
  Possible
  Code set used to identify the reaction severity
- Patient.Allergies[].Severity.Name
  String
  Possible
  Name of the reaction severity
- Patient.Allergies[].Status
  string
  Possible
  The current status of the allergy.
  One of the following: "Active", "Inactive", "Resolved".
- Patient.PCP
  Object
  Reliable
  Primary Care Provider for the Patient
- Patient.PCP.NPI
  String
  Reliable
  NPI of the PCP
- Patient.PCP.ID
  String
  Reliable
  ID of the PCP.
  This ID is often required for Inpatient Visits.
- Patient.PCP.IDType
  String
  Reliable
  ID type of the ID for the PCP
- Patient.PCP.FirstName
  String
  Possible
  First name of the PCP
- Patient.PCP.LastName
  String
  Possible
  Last name of the PCP
- Patient.PCP.Credentials[]
  Array of Strings
  Possible
  List of credentials for the PCP.
  e.g. MD, PhD
- Patient.PCP.Address
  Object
  Possible
  Provider's address
- Patient.PCP.Address.StreetAddress
  String
  Possible
  Street address
- Patient.PCP.Address.City
  String
  Possible
  City
- Patient.PCP.Address.State
  String
  Possible
  State
- Patient.PCP.Address.ZIP
  String
  Possible
  ZIP
- Patient.PCP.Address.County
  String
  Possible
  County
- Patient.PCP.Address.Country
  String
  Possible
  Country
- Patient.PCP.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.PCP.Location
  Object
  Possible
  Provider's location
- Patient.PCP.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Patient.PCP.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Patient.PCP.Location.Department
  String
  Possible
  Department
- Patient.PCP.Location.Room
  String
  Possible
  Room.
  Example: 136
- Patient.Insurances[]
  Array of Objects
  Probable
  List of insurance coverages for the patient
- Patient.Insurances[].Plan.ID
  String
  Probable
  Identifier of insurance plan
- Patient.Insurances[].Plan.IDType
  String
  Probable
  ID type of insurance plan
- Patient.Insurances[].Plan.Name
  String
  Probable
  Name of insurance plan
- Patient.Insurances[].Plan.Type
  String
  Possible
  Type of insurance plan
- Patient.Insurances[].MemberNumber
  String
  Possible
  Patient member number
- Patient.Insurances[].Company.ID
  String
  Probable
  ID of insurance company (payor)
- Patient.Insurances[].Company.IDType
  String
  Probable
  ID type of insurance company (payor)
- Patient.Insurances[].Company.Name
  String
  Probable
  Name of insurance company (payor)
- Patient.Insurances[].Company.Address
  Object
  Probable
  Insurance company's address
- Patient.Insurances[].Company.Address.StreetAddress
  String
  Probable
  Street address
- Patient.Insurances[].Company.Address.City
  String
  Probable
  City
- Patient.Insurances[].Company.Address.State
  String
  Probable
  State
- Patient.Insurances[].Company.Address.ZIP
  String
  Probable
  ZIP
- Patient.Insurances[].Company.Address.County
  String
  Possible
  County
- Patient.Insurances[].Company.Address.Country
  String
  Possible
  Country
- Patient.Insurances[].Company.PhoneNumber
  String
  Probable
  Insurance companys phone number.
  In E. 164 Format (i.e. +16085551234)
- Patient.Insurances[].GroupNumber
  String
  Probable
  Insurance policy group number
- Patient.Insurances[].GroupName
  String
  Probable
  Insurance policy group name
- Patient.Insurances[].EffectiveDate
  String
  Probable
  Effect date of this insurance policy.
  In YYYY-MM-DD format
- Patient.Insurances[].ExpirationDate
  String
  Probable
  Expiration date of this insurance policy.
  In YYYY-MM-DD format
- Patient.Insurances[].PolicyNumber
  String
  Probable
  Insurance policy number
- Patient.Insurances[].AgreementType
  String
  Probable
  Type of insurance agreement.
  One of the following: "Standard", "Unified", "Maternity"
- Patient.Insurances[].CoverageType
  String
  Probable
  Type of insurance agreement.
  One of the following: "Patient", "Clinic", "Insurance", "Other". Indicates who will be receiving the bill for the service.
- Patient.Insurances[].Insured
  Object
  Possible
  Individual who has the agreement with the insurance company for the related policy
- Patient.Insurances[].Insured.Identifiers[]
  Array of Objects
  Possible
  List of IDs and ID types that identify the insured
- Patient.Insurances[].Insured.Identifiers[].ID
  String
  Possible
  ID for the insured
- Patient.Insurances[].Insured.Identifiers[].IDType
  String
  Possible
  Type of ID.
  E.g. MRN, EPI
- Patient.Insurances[].Insured.LastName
  String
  Possible
  Last name of the insured
- Patient.Insurances[].Insured.FirstName
  String
  Possible
  First name of the insured
- Patient.Insurances[].Insured.SSN
  String
  Possible
  Insured's social security number
- Patient.Insurances[].Insured.Relationship
  String
  Possible
  Relationship of the insured to the patient.
  One of the following: "Self", "Spouse", "Other".
- Patient.Insurances[].Insured.DOB
  String
  Possible
  Date of birth of the insured.
  In YYYY-MM-DD format
- Patient.Insurances[].Insured.Sex
  String
  Possible
  Sex of the insured
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Insurances[].Insured.Address
  Object
  Probable
  Address of the insured
- Patient.Insurances[].Insured.Address.StreetAddress
  String
  Probable
  Street address
- Patient.Insurances[].Insured.Address.City
  String
  Probable
  City
- Patient.Insurances[].Insured.Address.State
  String
  Probable
  State
- Patient.Insurances[].Insured.Address.ZIP
  String
  Probable
  ZIP
- Patient.Insurances[].Insured.Address.County
  String
  Possible
  County
- Patient.Insurances[].Insured.Address.Country
  String
  Possible
  Country
- Patient.Guarantor
  Object
  Possible
  Person ultimately responsible for the bill for the patient.
- Patient.Guarantor.Number
  String
  Probable
  Number of the guarantor
- Patient.Guarantor.FirstName
  String
  Probable
  First name
- Patient.Guarantor.LastName
  String
  Probable
  Last name
- Patient.Guarantor.SSN
  String
  Possible
  Guarantor's social security number
- Patient.Guarantor.DOB
  String
  Possible
  Guarantor's date of birth.
  In ISO 8601 format
- Patient.Guarantor.Sex
  String
  Possible
  Guarantor's sex
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Guarantor.Spouse.FirstName
  String
  Probable
  Spouse's first name
- Patient.Guarantor.Spouse.LastName
  String
  Probable
  Spouse's last name
- Patient.Guarantor.Address
  Object
  Probable
  Address of the guarantor
- Patient.Guarantor.Address.StreetAddress
  String
  Probable
  Street address
- Patient.Guarantor.Address.City
  String
  Probable
  City
- Patient.Guarantor.Address.State
  String
  Probable
  State
- Patient.Guarantor.Address.ZIP
  String
  Probable
  ZIP
- Patient.Guarantor.Address.County
  String
  Possible
  County
- Patient.Guarantor.Address.Country
  String
  Possible
  Country
- Patient.Guarantor.PhoneNumber.Home
  String
  Probable
  Home phone number.
  In E. 164 Format (i.e. +16085551234)
- Patient.Guarantor.PhoneNumber.Business
  String
  Probable
  Business phone number.
  In E. 164 Format (i.e. +16085551234)
- Patient.Guarantor.PhoneNumber.Mobile
  String
  Probable
  Mobile phone number.
  In E. 164 Format (i.e. +16085551234)
- Patient.Guarantor.EmailAddresses[]
  Array of Strings
  Probable
  Guarantor's email address(es)
- Patient.Guarantor.Type
  String
  Probable
  Type of guarantor.
  E.g. institution, individual
- Patient.Guarantor.RelationToPatient
  String
  Probable
  Relation to the patient.
  E.g. self, parent
- Patient.Guarantor.Employer.Name
  String
  Probable
  Employer's name
- Patient.Guarantor.Employer.Address
  Object
  Probable
  Employer's address
- Patient.Guarantor.Employer.Address.StreetAddress
  String
  Probable
  Street address
- Patient.Guarantor.Employer.Address.City
  String
  Probable
  City
- Patient.Guarantor.Employer.Address.State
  String
  Probable
  State
- Patient.Guarantor.Employer.Address.ZIP
  String
  Probable
  ZIP
- Patient.Guarantor.Employer.Address.County
  String
  Possible
  County
- Patient.Guarantor.Employer.Address.Country
  String
  Possible
  Country
- Patient.Guarantor.Employer.PhoneNumber
  String
  Probable
  Employer phone number.
  In E. 164 Format (i.e. +16085551234)

resourceType
- resourceType
  string
  Bundle
type
- type
  code
  Currently, Redox supports only the 'Message' Type
entry
- entry
  The entry field corresponds to an array of FHIR Resources. For PatientAdmin, the Message Header and Patient resources are required, and the Practitioner (representing the attending provider) and some Location resources are allowed.
- entry[].fullUrl
  uri
  Absolute URL for resource.
  Ex: server address or UUID/OID.
entry[].resource - MessageHeader
- entry[].resource
  MessageHeader Resource Information
- entry[].resource.id
  id
  Logical id of this artifact
- entry[].resource.resourceType
  string
  MessageHeader
- entry[].resource.event
  Coding
  Code for the event this message represents
- entry[].resource.event.code
  code
- entry[].resource.timestamp
  instant
  Time that the message was sent
- entry[].resource.source
  Message source application
- entry[].resource.source.name
  string
  Name of the source system
- entry[].resource.source.endpoint
  uri
  Actual message source address or id
- entry[].resource.focus
  Reference
  Pointers to the actual content of the message
- entry[].resource.focus[].reference
  string
  References to the rest of the bundle
entry[].resource - Patient
- entry[].resource.resourceType
  string
  Patient
- entry[].resource.identifier
  Identifier
  A list of identifiers for this patient
- entry[].resource.identifier[].value
  string
- entry[].resource.identifier[].system
  string
  Establishes the namespace for the value - that is, a URL that describes a set of values that are unique
- entry[].resource.birthdate
  date
  Data of birth for the patient
- entry[].resource.telecom
  ContactPoint
  A contact detail for the patient
- entry[].resource.telecom[].value
  string
- entry[].resource.telecom[].system
  string
  A contact detail for the patient.
  Redox currently only supports values of phone and email for this field.
- entry[].resource.telecom[].use
  string
  Purpose of the contact point
- entry[].resource.address
  Address
  Address(es) of the patient
- entry[].resource.address[].line[]
  string[]
  Street name, number, direction & P.O. Box etc.
- entry[].resource.address[].city
  string
  Name of city
- entry[].resource.address[].district
  string
  District (county) name
- entry[].resource.address[].state
  string
  Name, or abbreviation, of the state
- entry[].resource.address[].postalCode
  string
  Postal code for the area
- entry[].resource.address[].country
  string
  Country.
  Can be ISO 3166 2 or 3 letter code.
- entry[].resource.address[].use
  string
  The purpose of the address
- entry[].resource.name
  HumanName
  Required
  A list of names associated with the patient
- entry[].resource.name[].family
  string
  Often called 'Surname.'
- entry[].resource.name[].given[]
  string[]
- entry[].resource.gender
  string
  Required
  Administrative gender for the patient.
  The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. One of male, female, other, or unknown.
- entry[].resource.maritalStatus
  CodeableConcept
  Marital Status of a patient
- entry[].resource.maritalStatus.text
  string
- entry[].resource.extension
  Extension
  Additional Content defined by implementations
- entry[].resource.extension[].url
  string
- entry[].resource.extension[].extension
  Extension
- entry[].resource.extension[].extension[].url
  string
- entry[].resource.extension[].extension[].valueString
  string
- entry[].resource.communication
  A list of languages which may be used to communicate with the patient.
- entry[].resource.communication[].language
  CodeableConcept
- entry[].resource.communication[].language.text
  string
- entry[].resource.communication[].language.coding
  Coding
- entry[].resource.communication[].language.coding.code
  code
  Symbol defined by the system
- entry[].resource.communication[].language.coding.system
  uri
  Identity/namespace of the terminology system
- entry[].resource.communication[].language.coding.display
  string
  Display value of the code, as defined by the system
entry[].resource - Practitioner
- entry[].resource.resourceType
  string
  Practitioner
- entry[].resource.active
  boolean
  Whether this practitioner's record is in active use
- entry[].resource.identifier
  Identifier
  Required
  A list of identifiers that apply to this person in this role
- entry[].resource.identifier[].value
  string
  Unique value identifier
- entry[].resource.identifier[].system
  string
  Establishes the namespace for the value - that is, a URL that describes a set of values that are unique
- entry[].resource.telecom
  ContactPoint
  Contact information for the practitioner
- entry[].resource.telecom[].value
  string
  Actual contact point details
- entry[].resource.telecom[].system
  string
  A contact detail for the practitioner (that apply to all roles).
  Redox currently only supports values of phone and email for this field.
- entry[].resource.telecom[].use
  string
  Purpose of the contact point
- entry[].resource.address
  Address
  Address(es) of the practitioner.
  Address(es) are not role specific.
- entry[].resource.address[].line[]
  string[]
  Street name, number, direction & P.O. Box etc.
- entry[].resource.address[].city
  string
  Name of city
- entry[].resource.address[].district
  string
  District (county) name
- entry[].resource.address[].state
  string
  Name, or abbreviation, of the state
- entry[].resource.address[].postalCode
  string
  Postal code for the area
- entry[].resource.address[].country
  string
  Country.
  Can be ISO 3166 2 or 3 letter code.
- entry[].resource.address[].use
  string
  Required
  The purpose of the address
- entry[].resource.name
  HumanName
  Required
  The name(s) associated with the practitioner.
- entry[].resource.name[].family
  string
  Family name.
  Often called 'Surname.'
- entry[].resource.name[].given[]
  string[]
  Given names (not always 'first'). Includes middle names.
  Given names appear in the correct order for presenting the name.
- entry[].resource.qualification
  Qualifications obtained by training and certification.
- entry[].resource.qualification[].code
  CodeableConcept
  Coded representation of the qualification.
- entry[].resource.qualification[].code.text
  string
  Text representation of the qualification.
- entry[].resource.qualification[].code.coding
  Coding
- entry[].resource.qualification[].code.coding.code
  code
  Symbol defined by the system
- entry[].resource.qualification[].code.coding.system
  uri
  Identity/namespace of the terminology system
- entry[].resource.qualification[].code.coding.display
  string
  Display value of the code, as defined by the system
entry[].resource - Coverage
- entry[].resource.resourceType
  string
  Coverage
- entry[].resource.identifier
  Identifier
  A list of identifiers for this coverage
- entry[].resource.identifier[].value
  id
- entry[].resource.identifier[].system
  string
  Establishes the namespace for the value - that is, a URL that describes a set of values that are unique
- entry[].resource.status
  code
  active | cancelled | draft | entered-in-error
- entry[].resource.grouping
  Additional coverage classifications
- entry[].resource.grouping.group
  string
  An identifier for the group
- entry[].resource.grouping.groupDisplay
  string
  Display name for the group
- entry[].resource.grouping.plan
  string
  An identifier for the plan
- entry[].resource.grouping.planDisplay
  string
  Display name for the plan
- entry[].resource.beneficiary
  Reference
  Subscriber to the policy
- entry[].resource.beneficiary.reference
  string
  Pointer to the patient who is the beneficiary
- entry[].resource.period
  Period
  Coverage start and end dates
- entry[].resource.period.start
  dateTime
  Coverage start date
- entry[].resource.period.end
  dateTime
  Coverage end date
- entry[].resource.payor
  Reference
  Identifier for the plan or agreement issuer
- entry[].resource.payor.reference
  string
  Pointer to the payor (will be a contained resource)
- entry[].resource.contained[]
  []
  Organization resource for the payor
- entry[].resource.contained[].resourceType
  string
  Organization
- entry[].resource.contained[].identifier
  Identifier
  A list of identifiers for this organization
- entry[].resource.contained[].identifier[].value
  string
- entry[].resource.contained[].identifier[].system
  string
  Establishes the namespace for the value - that is, a URL that describes a set of values that are unique
- entry[].resource.contained[].telecom
  ContactPoint
  A contact detail for the patient
- entry[].resource.contained[].telecom[].value
  string
- entry[].resource.contained[].telecom[].system
  string
  Contact information for the organization.
  Redox currently only supports values of phone and email for this field.
- entry[].resource.contained[].telecom[].use
  string
  Purpose of the contact point
- entry[].resource.contained[].name
  string
  Name of the organization
- entry[].resource.contained[].address[]
  Address[]
  Address(es) of the of the organization
- entry[].resource.contained[].address[].line[]
  string[]
  Street name, number, direction & P.O. Box etc.
- entry[].resource.contained[].address[].city
  string
  Name of city
- entry[].resource.contained[].address[].district
  string
  District (county) name
- entry[].resource.contained[].address[].state
  string
  Name, or abbreviation, of the state
- entry[].resource.contained[].address[].postalCode
  string
  Postal code for the area
- entry[].resource.contained[].address[].country
  string
  Country.
  Can be ISO 3166 2 or 3 letter code.
- entry[].resource.contained[].address[].use
  string
  The purpose of the address
- entry[].resource.resourceType
  string
  Coverage
- entry[].resource.identifier
  Identifier
  A list of identifiers for this coverage
- entry[].resource.identifier[].value
  id
- entry[].resource.identifier[].system
  string
  Establishes the namespace for the value - that is, a URL that describes a set of values that are unique
- entry[].resource.status
  code
  active | cancelled | draft | entered-in-error
- entry[].resource.grouping
  Additional coverage classifications
- entry[].resource.grouping.group
  string
  An identifier for the group
- entry[].resource.grouping.groupDisplay
  string
  Display name for the group
- entry[].resource.grouping.plan
  string
  An identifier for the plan
- entry[].resource.grouping.planDisplay
  string
  Display name for the plan
- entry[].resource.beneficiary
  Reference
  Subscriber to the policy
- entry[].resource.beneficiary.reference
  string
  Pointer to the patient who is the beneficiary
- entry[].resource.period
  Period
  Coverage start and end dates
- entry[].resource.period.start
  dateTime
  Coverage start date
- entry[].resource.period.end
  dateTime
  Coverage end date
- entry[].resource.payor
  Reference
  Identifier for the plan or agreement issuer
- entry[].resource.payor.reference
  string
  Pointer to the payor (will be a contained resource)
- entry[].resource.contained[]
  []
  Organization resource for the payor
- entry[].resource.contained[].resourceType
  string
  Organization
- entry[].resource.contained[].identifier
  Identifier
  A list of identifiers for this organization
- entry[].resource.contained[].identifier[].value
  string
- entry[].resource.contained[].identifier[].system
  string
  Establishes the namespace for the value - that is, a URL that describes a set of values that are unique
- entry[].resource.contained[].telecom
  ContactPoint
  A contact detail for the patient
- entry[].resource.contained[].telecom[].value
  string
- entry[].resource.contained[].telecom[].system
  string
  Contact information for the organization.
  Redox currently only supports values of phone and email for this field.
- entry[].resource.contained[].telecom[].use
  string
  Purpose of the contact point
- entry[].resource.contained[].name
  string
  Name of the organization
- entry[].resource.contained[].address[]
  Address[]
  Address(es) of the of the organization
- entry[].resource.contained[].address[].line[]
  string[]
  Street name, number, direction & P.O. Box etc.
- entry[].resource.contained[].address[].city
  string
  Name of city
- entry[].resource.contained[].address[].district
  string
  District (county) name
- entry[].resource.contained[].address[].state
  string
  Name, or abbreviation, of the state
- entry[].resource.contained[].address[].postalCode
  string
  Postal code for the area
- entry[].resource.contained[].address[].country
  string
  Country.
  Can be ISO 3166 2 or 3 letter code.
- entry[].resource.contained[].address[].use
  string
  The purpose of the address

Sample MessageDownload JSON Schema

{
   "resourceType": "Bundle",
   "type": "message",
   "entry": [
      {
         "fullUrl": "urn:uuid:25cefc53-8d56-4c4c-bb5b-971664b59ce0",
         "resource": {
            "id": "transmission-12414",
            "resourceType": "MessageHeader",
            "event": {
               "code": "PatientAdmin-PatientUpdate"
            },
            "timestamp": "2019-05-10T17:23:19.864Z",
            "source": {
               "name": "Redox Dev Tools",
               "endpoint": "urn:uuid:7ce6f387-c33c-417d-8682-81e83628cbd9"
            },
            "focus": [
               {
                  "reference": "urn:uuid:29a71173-84b2-48a8-a0d0-e2d1a3923182"
               },
               {
                  "reference": "urn:uuid:c04b55bc-93cf-45a2-8171-24e0b41218a5"
               },
               {
                  "reference": "urn:uuid:d9dba861-3660-49c2-a49d-6ef331d84ad3"
               },
               {
                  "reference": "urn:uuid:9805f278-84f0-40fd-945b-cd50023f8f23"
               }
            ]
         }
      },
      {
         "fullUrl": "urn:uuid:29a71173-84b2-48a8-a0d0-e2d1a3923182",
         "resource": {
            "resourceType": "Patient",
            "identifier": [
               {
                  "value": "0000000001",
                  "system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:MR"
               },
               {
                  "value": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
                  "system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:EHRID"
               },
               {
                  "value": "a1d4ee8aba494ca",
                  "system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:NIST"
               },
               {
                  "value": "101-01-0001",
                  "system": "http://hl7.org/fhir/sid/us-ssn"
               }
            ],
            "birthDate": "2008-01-06",
            "telecom": [
               {
                  "value": "+18088675301",
                  "system": "phone",
                  "use": "home"
               }
            ],
            "address": [
               {
                  "line": [
                     "4435 Victoria Ln"
                  ],
                  "city": "Madison",
                  "district": "Dane",
                  "state": "WI",
                  "postalCode": "53719",
                  "country": "US",
                  "use": "home"
               }
            ],
            "name": [
               {
                  "family": "Bixby",
                  "given": [
                     "Timothy",
                     "Paul"
                  ]
               }
            ],
            "gender": "male",
            "maritalStatus": {
               "text": "Married",
               "coding": [
                  {
                     "code": "M",
                     "system": "http://hl7.org/fhir/v3/MaritalStatus",
                     "display": "Married"
                  }
               ]
            },
            "extension": [
               {
                  "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
                  "extension": [
                     {
                        "url": "text",
                        "valueString": "White"
                     }
                  ]
               }
            ],
            "communication": [
               {
                  "language": {
                     "text": "en",
                     "coding": [
                        {
                           "code": "en",
                           "system": "urn:ietf:bcp:47"
                        }
                     ]
                  }
               }
            ],
            "contact": [
               {
                  "name": {
                     "family": "Bixby",
                     "given": [
                        "Barbara"
                     ]
                  },
                  "address": {
                     "line": [
                        "4762 Hickory Street"
                     ],
                     "city": "Monroe",
                     "district": "Green",
                     "state": "WI",
                     "postalCode": "53566",
                     "country": "US"
                  },
                  "telecom": [
                     {
                        "value": "+18088675303",
                        "system": "phone",
                        "use": "home"
                     },
                     {
                        "value": "+17077543758",
                        "system": "phone",
                        "use": "work"
                     },
                     {
                        "value": "+19189368865",
                        "system": "phone",
                        "use": "mobile"
                     },
                     {
                        "value": "barb.bixby@test.net",
                        "system": "email"
                     }
                  ],
                  "relationship": [
                     {
                        "text": "Mother",
                        "coding": [
                           {
                              "code": "MTH",
                              "system": "http://hl7.org/fhir/v3/RoleCode",
                              "display": "mother"
                           }
                        ]
                     },
                     {
                        "text": "Emergency Contact",
                        "coding": [
                           {
                              "code": "C",
                              "system": "http://hl7.org/fhir/v2/0131",
                              "display": "Emergency Contact"
                           }
                        ]
                     }
                  ]
               }
            ],
            "generalPractitioner": [
               {
                  "reference": "urn:uuid:c04b55bc-93cf-45a2-8171-24e0b41218a5"
               }
            ]
         }
      },
      {
         "fullUrl": "urn:uuid:c04b55bc-93cf-45a2-8171-24e0b41218a5",
         "resource": {
            "resourceType": "Practitioner",
            "active": true,
            "identifier": [
               {
                  "value": "4356789876",
                  "system": "http://hl7.org/fhir/sid/us-npi"
               }
            ],
            "telecom": [
               {
                  "value": "+16085551234",
                  "system": "phone",
                  "use": "work"
               }
            ],
            "address": [
               {
                  "line": [
                     "123 Main St."
                  ],
                  "city": "Madison",
                  "district": "Dane",
                  "state": "WI",
                  "postalCode": "53703",
                  "country": "USA"
               }
            ],
            "name": [
               {
                  "family": "Granite",
                  "given": [
                     "Pat"
                  ]
               }
            ],
            "qualification": [
               {
                  "code": {
                     "text": "MD",
                     "coding": [
                        {
                           "code": "MD",
                           "system": "http://hl7.org/fhir/v2/0360/2.7",
                           "display": "Doctor of Medicine"
                        }
                     ]
                  }
               }
            ]
         }
      },
      {
         "fullUrl": "urn:uuid:d9dba861-3660-49c2-a49d-6ef331d84ad3",
         "resource": {
            "identifier": [
               {
                  "value": "9140860055",
                  "system": "urn:redox:7ce6f387-c33c-417d-8682-81e83628cbd9:POLNUM"
               }
            ],
            "resourceType": "Coverage",
            "status": "active",
            "grouping": {
               "group": "847025-024-0009",
               "groupDisplay": "Accelerator Labs",
               "plan": "31572",
               "planDisplay": "HMO Deductable Plan"
            },
            "beneficiary": {
               "reference": "urn:uuid:29a71173-84b2-48a8-a0d0-e2d1a3923182"
            },
            "period": {
               "start": "2015-01-01",
               "end": "2020-12-31"
            },
            "contained": [
               {
                  "resourceType": "Organization",
                  "id": "company",
                  "identifier": [
                     {
                        "value": "60054"
                     }
                  ],
                  "telecom": [
                     {
                        "value": "+18089541123",
                        "system": "phone"
                     }
                  ],
                  "name": "aetna (60054 0131)",
                  "address": [
                     {
                        "line": [
                           "PO Box 14080"
                        ],
                        "city": "Lexington",
                        "district": "Fayette",
                        "state": "KY",
                        "postalCode": "40512-4079",
                        "country": "US"
                     }
                  ]
               }
            ],
            "payor": [
               {
                  "reference": "#company"
               }
            ]
         }
      },
      {
         "fullUrl": "urn:uuid:9805f278-84f0-40fd-945b-cd50023f8f23",
         "resource": {
            "resourceType": "Account",
            "subject": {
               "reference": "urn:uuid:29a71173-84b2-48a8-a0d0-e2d1a3923182"
            },
            "status": "active",
            "contained": [
               {
                  "resourceType": "RelatedPerson",
                  "id": "88180eb3-1399-4e1c-9283-c74e107bd6f9",
                  "identifier": [
                     {
                        "value": "10001910"
                     }
                  ],
                  "patient": {
                     "reference": "urn:uuid:29a71173-84b2-48a8-a0d0-e2d1a3923182"
                  },
                  "relationship": {
                     "text": "Father"
                  },
                  "name": [
                     {
                        "given": [
                           "Kent"
                        ],
                        "family": "Bixby"
                     }
                  ],
                  "address": [
                     {
                        "line": [
                           "4762 Hickory Street"
                        ],
                        "city": "Monroe",
                        "district": "Green",
                        "state": "WI",
                        "postalCode": "53566",
                        "country": "USA"
                     }
                  ],
                  "extension": [
                     {
                        "url": "https://fhir.redoxengine.com/StructureDefinition/relatedperson-spousename",
                        "valueHumanName": {
                           "given": [
                              "Barbara"
                           ],
                           "family": "Bixby"
                        }
                     },
                     {
                        "url": "https://fhir.redoxengine.com/StructureDefinition/relatedperson-employer",
                        "valueReference": {
                           "reference": "#b81cdbc6-0ff9-4bae-92b0-f8bf4c0b7516"
                        }
                     }
                  ]
               },
               {
                  "resourceType": "Organization",
                  "id": "b81cdbc6-0ff9-4bae-92b0-f8bf4c0b7516",
                  "name": "Accelerator Labs",
                  "address": [
                     {
                        "line": [
                           "1456 Old Sauk Road"
                        ],
                        "city": "Madison",
                        "district": "Dane",
                        "state": "WI",
                        "postalCode": "53719",
                        "country": "USA"
                     }
                  ],
                  "telecom": [
                     {
                        "value": "+18083451121",
                        "system": "phone",
                        "use": "work"
                     }
                  ]
               }
            ],
            "guarantor": [
               {
                  "party": {
                     "reference": "#88180eb3-1399-4e1c-9283-c74e107bd6f9"
                  }
               }
            ]
         }
      }
   ]
}

{
   "Meta": {
      "DataModel": "PatientAdmin",
      "EventType": "PatientUpdate",
      "EventDateTime": "2019-05-10T17:23:19.864Z",
      "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": [
               "barb.bixby@test.net"
            ],
            "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"
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         }
      },
      "Insurances": [
         {
            "Plan": {
               "ID": "31572",
               "IDType": "Payor ID",
               "Name": "HMO Deductable 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,
               "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",
         "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"
         }
      }
   }
}

PatientMerge

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 in Patient.PreviousIdentifiers should be retired and the patient they refer to combined into the record indicated by Patient.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

Show Required Fields Only

Meta
- Meta.DataModel
  String
  Reliable
  Required
  Data model.
  E.g. Scheduling, Results
- Meta.EventType
  String
  Reliable
  Required
  Type of event.
  E.g. New, Update
- Meta.EventDateTime
  DateTime
  Reliable
  DateTime of the event.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Flag as a test message
- Meta.Source
  String
  Reliable
  Where the message originated.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  ID of the source.
  UUID
- Meta.Source.Name
  String
  Reliable
  Name of the source
- Meta.Destinations[]
  Array of Objects
  Reliable
  List of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
  Required when sending data to Redox
- Meta.Destinations[].ID
  String
  Reliable
  ID of the destination.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Name of the destination
- Meta.Message
  String
  Reliable
  Record in Redox that corresponds to the communication sent from the source to Redox.
  Included in messages from Redox
- Meta.Message.ID
  Numeric
  Reliable
  ID of the message created in Redox
- Meta.Transmission
  String
  Reliable
  Record in Redox that corresponds to the communication sent from Redox to your destination.
  Included in messages from Redox
- Meta.Transmission.ID
  Numeric
  Reliable
  ID of the transmission created in Redox
- Meta.FacilityCode
  String
  Possible
  Code for the facility related to the message.
  Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
- Patient.Identifiers[]
  Array of Objects
  Reliable
  List of IDs and ID types that identify the patient
- Patient.Identifiers[].ID
  String
  Reliable
  Required
  ID for the patient
- Patient.Identifiers[].IDType
  String
  Reliable
  Required
  Type of ID.
  E.g. MRN, EPI
- Patient.PreviousIdentifiers[]
  Array of Objects
  Reliable
  List 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
  Reliable
  Required
- Patient.PreviousIdentifiers[].IDType
  String
  Reliable
  Required
  Type of ID.
  E.g. MRN, EPI
- Patient.Demographics.FirstName
  String
  Reliable
  Patient's first name
- Patient.Demographics.MiddleName
  String
  Possible
  Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
- Patient.Demographics.LastName
  String
  Reliable
  Patient's last name
- Patient.Demographics.DOB
  String
  Reliable
  Patient's date of birth.
  In ISO 8601 format
- Patient.Demographics.SSN
  String
  Probable
  Patient's social security number
- Patient.Demographics.Sex
  String
  Reliable
  Patient's sex
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Race
  String
  Possible
  Patient's race.
  Supported Values
- Patient.Demographics.IsHispanic
  Boolean
  Possible
  Indicates if the patient is of hispanic origin.
- Patient.Demographics.MaritalStatus
  String
  Possible
  Patient's marital status
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.IsDeceased
  Boolean
  Possible
  Indicates if the patient is deceased
- Patient.Demographics.DeathDateTime
  DateTime
  Possible
  Date and Time the patient was proclaimed deceased.
  ISO 8601 Format
- Patient.Demographics.PhoneNumber.Home
  String
  Probable
  Patient's home phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Office
  String
  Probable
  Patient's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Mobile
  String
  Probable
  Patient's mobile phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.EmailAddresses[]
  Array of Strings
  Probable
  Patient's email address(es)
- Patient.Demographics.Language
  String
  Possible
  Patient's primary spoken language.
  In ISO 639-1 alpha values (e.g. 'en'). Supported Values
- Patient.Demographics.Citizenship[]
  Array of strings
  Possible
  Patient's nation(s) of citizenship.
  *In ISO 3166 alpha 2 format (e.g. 'US'). Reference Table.
  
  Note: The valid set of citizenships is a smaller list than the list of IS0 3166 country codes, and should be limited to the 193 United Nations countries plus 6 states: ROC Taiwan, Macao (SAR China), Hong Kong (SAR China), Kosovo, Palestinian Territory and the Vatican.*
- Patient.Demographics.Address
  Object
  Probable
  Patient's home address
- Patient.Demographics.Address.StreetAddress
  String
  Probable
  Street address
- Patient.Demographics.Address.City
  String
  Probable
  City
- Patient.Demographics.Address.State
  String
  Probable
  State
- Patient.Demographics.Address.ZIP
  String
  Probable
  ZIP
- Patient.Demographics.Address.County
  String
  Possible
  County
- Patient.Demographics.Address.Country
  String
  Possible
  Country
- Patient.Notes[]
  Array of strings
  Possible
  Patient-level notes

Sample MessageDownload JSON Schema

{
   "Meta": {
      "DataModel": "PatientAdmin",
      "EventType": "PatientMerge",
      "EventDateTime": "2019-05-10T17:23:19.864Z",
      "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": []
   }
}

PreAdmitBETA

View R^FHIR Event Type

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

Show Required Fields Only

Meta
- Meta.DataModel
  String
  Reliable
  Required
  Data model.
  E.g. Scheduling, Results
- Meta.EventType
  String
  Reliable
  Required
  Type of event.
  Registration
- Meta.EventDateTime
  DateTime
  Reliable
  DateTime of the event.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Flag as a test message
- Meta.Source
  String
  Reliable
  Where the message originated.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  ID of the source.
  UUID
- Meta.Source.Name
  String
  Reliable
  Name of the source
- Meta.Destinations[]
  Array of Objects
  Reliable
  List of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
  Required when sending data to Redox
- Meta.Destinations[].ID
  String
  Reliable
  ID of the destination.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Name of the destination
- Meta.Message
  String
  Reliable
  Record in Redox that corresponds to the communication sent from the source to Redox.
  Included in messages from Redox
- Meta.Message.ID
  Numeric
  Reliable
  ID of the message created in Redox
- Meta.Transmission
  String
  Reliable
  Record in Redox that corresponds to the communication sent from Redox to your destination.
  Included in messages from Redox
- Meta.Transmission.ID
  Numeric
  Reliable
  ID of the transmission created in Redox
- Meta.FacilityCode
  String
  Possible
  Code for the facility related to the message.
  Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
- Patient.Identifiers[]
  Array of Objects
  Reliable
  List of IDs and ID types that identify the patient
- Patient.Identifiers[].ID
  String
  Reliable
  Required
  ID for the patient
- Patient.Identifiers[].IDType
  String
  Reliable
  Required
  Type of ID.
  E.g. MRN, EPI
- Patient.Demographics.FirstName
  String
  Reliable
  Patient's first name
- Patient.Demographics.MiddleName
  String
  Possible
  Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
- Patient.Demographics.LastName
  String
  Reliable
  Patient's last name
- Patient.Demographics.DOB
  String
  Reliable
  Patient's date of birth.
  In ISO 8601 format
- Patient.Demographics.SSN
  String
  Probable
  Patient's social security number
- Patient.Demographics.Sex
  String
  Reliable
  Patient's sex
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Race
  String
  Possible
  Patient's race.
  Supported Values
- Patient.Demographics.IsHispanic
  Boolean
  Possible
  Indicates if the patient is of hispanic origin.
- Patient.Demographics.MaritalStatus
  String
  Possible
  Patient's marital status
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.IsDeceased
  Boolean
  Possible
  Indicates if the patient is deceased
- Patient.Demographics.DeathDateTime
  DateTime
  Possible
  Date and Time the patient was proclaimed deceased.
  ISO 8601 Format
- Patient.Demographics.PhoneNumber.Home
  String
  Probable
  Patient's home phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Office
  String
  Probable
  Patient's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Mobile
  String
  Probable
  Patient's mobile phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.EmailAddresses[]
  Array of Strings
  Probable
  Patient's email address(es)
- Patient.Demographics.Language
  String
  Possible
  Patient's primary spoken language.
  In ISO 639-1 alpha values (e.g. 'en'). Supported Values
- Patient.Demographics.Citizenship[]
  Array of strings
  Possible
  Patient's nation(s) of citizenship.
  *In ISO 3166 alpha 2 format (e.g. 'US'). Reference Table.
  
  Note: The valid set of citizenships is a smaller list than the list of IS0 3166 country codes, and should be limited to the 193 United Nations countries plus 6 states: ROC Taiwan, Macao (SAR China), Hong Kong (SAR China), Kosovo, Palestinian Territory and the Vatican.*
- Patient.Demographics.Address
  Object
  Probable
  Patient's home address
- Patient.Demographics.Address.StreetAddress
  String
  Probable
  Street address
- Patient.Demographics.Address.City
  String
  Probable
  City
- Patient.Demographics.Address.State
  String
  Probable
  State
- Patient.Demographics.Address.ZIP
  String
  Probable
  ZIP
- Patient.Demographics.Address.County
  String
  Possible
  County
- Patient.Demographics.Address.Country
  String
  Possible
  Country
- Patient.Notes[]
  Array of strings
  Possible
  Patient-level notes
- Patient.Contacts[].FirstName
  String
  Possible
  First name of the contact
- Patient.Contacts[].MiddleName
  String
  Possible
  Middle name of the contact
- Patient.Contacts[].LastName
  String
  Possible
  Last name of the contact
- Patient.Contacts[].Address
  Object
  Possible
  Address of the contact
- Patient.Contacts[].Address.StreetAddress
  String
  Possible
  Street address
- Patient.Contacts[].Address.City
  String
  Possible
  City
- Patient.Contacts[].Address.State
  String
  Possible
  State
- Patient.Contacts[].Address.ZIP
  String
  Possible
  ZIP
- Patient.Contacts[].Address.County
  String
  Possible
  County
- Patient.Contacts[].Address.Country
  String
  Possible
  Country
- Patient.Contacts[].PhoneNumber.Home
  String
  Possible
  Home phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Contacts[].PhoneNumber.Office
  String
  Possible
  Office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Contacts[].PhoneNumber.Mobile
  String
  Probable
  Mobile phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Contacts[].RelationToPatient
  String
  Possible
  Personal relationship to the patient.
  e.x. Father, Spouse
- Patient.Contacts[].EmailAddresses[]
  Array of string
  Possible
  Email address(es) of the contact person
- Patient.Contacts[].Roles[]
  Array of strings
  Possible
  Role of this contact for the patient.
  e.x. Employer, Emergency Contact
- Patient.Diagnoses[]
  Array of Objects
  Probable
  List of diagnoses associated with this visit
- Patient.Diagnoses[].Code
  String
  Probable
  Code for the diagnosis
- Patient.Diagnoses[].Codeset
  String
  Probable
  Code set used to identify the diagnosis.
  One of the following: ICD-9, ICD-10, HCPCS, CPT
- Patient.Diagnoses[].Name
  String
  Probable
  Name of the diagnosis
- Patient.Diagnoses[].Type
  String
  Possible
  Type of the diagnosis.
  One of the following: Admitting, Working, or Final
- Patient.Diagnoses[].DocumentedDateTime
  String
  Possible
  DateTime the diagnosis was documented.
  ISO 8601 Format
- Patient.Allergies[]
  Array of Objects
  Possible
  List of a patient's allergies
- Patient.Allergies[].Code
  String
  Possible
  Code for the allergy
- Patient.Allergies[].Codeset
  String
  Possible
  Code set used to identify the allergy.
  Typically RxNorm or SNOMED
- Patient.Allergies[].Name
  String
  Possible
  Name of the allergy
- Patient.Allergies[].Type
  Object
  Possible
  The type of allergy intolerance (food, drug, etc.)
- Patient.Allergies[].Type.Code
  String
  Possible
  Code for the allergy intolerance type
- Patient.Allergies[].Type.Codeset
  String
  Possible
  Code set used to identify the allergy intolerance type
- Patient.Allergies[].Type.Name
  String
  Possible
  Name of the allergy intolerance type
- Patient.Allergies[].OnsetDateTime
  String
  Possible
  DateTime the allergy was identified
- Patient.Allergies[].Reaction[]
  Array of Objects
  Possible
  The list of reactions caused by this particular allergy.

PatientAdmin

ArrivalBETAlink

Fields

Meta

Patient

Visit

resourceType

type

entry

entry[].resource - MessageHeader

entry[].resource - Patient

entry[].resource - Practitioner

CancelBETAlink

Fields

Meta

Patient

Visit

resourceType

type

entry

entry[].resource - MessageHeader

entry[].resource - Patient

entry[].resource - Practitioner

DischargeBETAlink

Fields

Meta

Patient

Visit

resourceType

type

entry

entry[].resource - MessageHeader

entry[].resource - Patient

entry[].resource - Practitioner

NewPatientBETAlink

Fields

Meta

Patient

resourceType

type

entry

entry[].resource - MessageHeader

entry[].resource - Patient

entry[].resource - Practitioner

entry[].resource - Coverage

PatientUpdateBETAlink

Fields

Meta

Patient

resourceType

type

entry

entry[].resource - MessageHeader

entry[].resource - Patient

entry[].resource - Practitioner

entry[].resource - Coverage

PatientMergelink

Fields

Meta

Patient

PreAdmitBETAlink

Fields

Meta

Patient

ArrivalBETA

CancelBETA

DischargeBETA

NewPatientBETA

PatientUpdateBETA

PatientMerge

PreAdmitBETA