PatientAdminPowered by Data Château

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.

Arrivallink

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

Fields

  • Meta
    • Meta.DataModel

      String

      Reliable
      Required

      Data model. E.g. Scheduling, Results

    • Meta.EventType

      String

      Reliable
      Required

      Type of event. E.g. New, Update

    • 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. One of the following: Female, Male, Unknown, Other

    • Patient.Demographics.IsHispanic

      Boolean

      Possible

      Indicates if the patient is of hispanic origin.

    • Patient.Demographics.MaritalStatus

      String

      Possible

      Patient's marital status. Supported Values

    • 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: ICD9, ICD10, HCPCS, CPT

    • Patient.Diagnoses[].Name

      String

      Probable

      Name of the diagnosis

    • Patient.Diagnoses[].Type

      String

      Possible

      List of diagnoses associated with this visit. One of the following: Admitting, Working, or Final

    • 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[].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.PCP

      Object

      Reliable

      Primary Care Provider for the Patient

    • Patient.PCP.NPI

      String

      Reliable

      NPI of 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.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.PCP.PhoneNumber.Office

      String

      Possible

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

    • Patient.PCP.PhoneNumber

      String

      Probable

      PCP's phone number. In E. 164 Format. (i.e. +16085551234)

    • Patient.PCP.ID

      String

      Possible

      PCP's identifier

    • Patient.PCP.IDType

      String

      Possible

      PCP's identifier type

    • Patient.PCP.Address

      Object

      Probable

      PCP's address

    • Patient.PCP.Address.StreetAddress

      String

      Probable

      Street address

    • Patient.PCP.Address.City

      String

      Probable

      City

    • Patient.PCP.Address.State

      String

      Probable

      State

    • Patient.PCP.Address.ZIP

      String

      Probable

      ZIP

    • Patient.PCP.Address.County

      String

      Possible

      County

    • Patient.PCP.Address.Country

      String

      Possible

      Country

  • Visit
    • Visit.VisitNumber

      String

      Reliable

      Visit Number

    • 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.AttendingProvider.ID

      String

      Probable

      ID of the attending provider. This ID is 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.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.AttendingProvider.PhoneNumber.Office

      String

      Possible

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

    • Visit.ConsultingProvider.ID

      String

      Possible

      ID of the consulting provider. This ID is 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.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.ConsultingProvider.PhoneNumber.Office

      String

      Possible

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

    • Visit.ReferringProvider.ID

      String

      Possible

      ID of the referring provider. This ID is 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.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.ReferringProvider.PhoneNumber.Office

      String

      Possible

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

    • 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.DOB

      String

      Possible

      Guarantor's date of birth. In ISO 8601 format

    • Visit.Guarantor.Sex

      String

      Possible

      Guarantor's sex. One of the following: Female, Male, Unknown, Other

    • 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.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.LastName

      String

      Possible

      Last name of the insured

    • Visit.Insurances[].Insured.FirstName

      String

      Possible

      First name of the insured

    • 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.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

{
   "Meta": {
      "DataModel": "PatientAdmin",
      "EventType": "Arrival",
      "EventDateTime": "2017-12-06T00:28:28.775Z",
      "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": "Asian",
         "IsHispanic": null,
         "MaritalStatus": "Single",
         "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
         }
      ],
      "Allergies": [
         {
            "Code": "7982",
            "Codeset": "RxNorm",
            "Name": "Penicillin",
            "OnsetDateTime": null,
            "Reaction": [
               {
                  "Code": "28926001",
                  "Codeset": "SNOMED CT",
                  "Name": "Rash"
               },
               {
                  "Code": "247472004",
                  "Codeset": "SNOMED CT",
                  "Name": "Hives"
               }
            ]
         }
      ],
      "PCP": {
         "NPI": "4356789876",
         "FirstName": "Pat",
         "LastName": "Granite",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "Madison",
            "State": "WI",
            "ZIP": "53703",
            "County": "Dane",
            "Country": "USA"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "ID": "4356789876",
         "IDType": "NPI"
      }
   },
   "Visit": {
      "VisitNumber": "1234",
      "PatientClass": "Inpatient",
      "VisitDateTime": "2017-12-06T00:28:29.468Z",
      "Duration": 15,
      "Reason": "Check up",
      "Instructions": [],
      "Balance": 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"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         }
      },
      "ConsultingProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": null
         }
      },
      "ReferringProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": 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",
         "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
         },
         "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": {
               "LastName": null,
               "FirstName": null,
               "Relationship": null,
               "DOB": null,
               "Address": {
                  "StreetAddress": null,
                  "City": null,
                  "State": null,
                  "ZIP": null,
                  "County": null,
                  "Country": null
               }
            }
         }
      ]
   }
}

Cancellink

A Cancel message is generated when a PatientAdmin event is canceled. The Meta.CanceledEvent field indicates which type of event the message cancels (e.g. Arrival, Discharge). For example, set Meta.EventType to "Cancel" and Meta.CanceledEvent to "Arrival" to cancel an arrival event.

Fields

  • Meta
    • Meta.DataModel

      String

      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. One of the following: Female, Male, Unknown, Other

    • Patient.Demographics.IsHispanic

      Boolean

      Possible

      Indicates if the patient is of hispanic origin.

    • Patient.Demographics.MaritalStatus

      String

      Possible

      Patient's marital status. Supported Values

    • 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: ICD9, ICD10, HCPCS, CPT

    • Patient.Diagnoses[].Name

      String

      Probable

      Name of the diagnosis

    • Patient.Diagnoses[].Type

      String

      Possible

      List of diagnoses associated with this visit. One of the following: Admitting, Working, or Final

    • 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[].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.PCP

      Object

      Reliable

      Primary Care Provider for the Patient

    • Patient.PCP.NPI

      String

      Reliable

      NPI of 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.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.PCP.PhoneNumber.Office

      String

      Possible

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

    • Patient.PCP.PhoneNumber

      String

      Probable

      PCP's phone number. In E. 164 Format. (i.e. +16085551234)

    • Patient.PCP.ID

      String

      Possible

      PCP's identifier

    • Patient.PCP.IDType

      String

      Possible

      PCP's identifier type

    • Patient.PCP.Address

      Object

      Probable

      PCP's address

    • Patient.PCP.Address.StreetAddress

      String

      Probable

      Street address

    • Patient.PCP.Address.City

      String

      Probable

      City

    • Patient.PCP.Address.State

      String

      Probable

      State

    • Patient.PCP.Address.ZIP

      String

      Probable

      ZIP

    • Patient.PCP.Address.County

      String

      Possible

      County

    • Patient.PCP.Address.Country

      String

      Possible

      Country

  • Visit
    • Visit.VisitNumber

      String

      Reliable

      Visit Number

    • 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.AttendingProvider.ID

      String

      Probable

      ID of the attending provider. This ID is 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.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.AttendingProvider.PhoneNumber.Office

      String

      Possible

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

    • Visit.ConsultingProvider.ID

      String

      Possible

      ID of the consulting provider. This ID is 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.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.ConsultingProvider.PhoneNumber.Office

      String

      Possible

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

    • Visit.ReferringProvider.ID

      String

      Possible

      ID of the referring provider. This ID is 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.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.ReferringProvider.PhoneNumber.Office

      String

      Possible

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

    • 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.DOB

      String

      Possible

      Guarantor's date of birth. In ISO 8601 format

    • Visit.Guarantor.Sex

      String

      Possible

      Guarantor's sex. One of the following: Female, Male, Unknown, Other

    • 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.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.LastName

      String

      Possible

      Last name of the insured

    • Visit.Insurances[].Insured.FirstName

      String

      Possible

      First name of the insured

    • 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.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

{
   "Meta": {
      "DataModel": "PatientAdmin",
      "EventType": "Cancel",
      "EventDateTime": "2017-12-06T00:28:28.775Z",
      "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": "Asian",
         "IsHispanic": null,
         "MaritalStatus": "Single",
         "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
         }
      ],
      "Allergies": [
         {
            "Code": "7982",
            "Codeset": "RxNorm",
            "Name": "Penicillin",
            "OnsetDateTime": null,
            "Reaction": [
               {
                  "Code": "28926001",
                  "Codeset": "SNOMED CT",
                  "Name": "Rash"
               },
               {
                  "Code": "247472004",
                  "Codeset": "SNOMED CT",
                  "Name": "Hives"
               }
            ]
         }
      ],
      "PCP": {
         "NPI": "4356789876",
         "FirstName": "Pat",
         "LastName": "Granite",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "Madison",
            "State": "WI",
            "ZIP": "53703",
            "County": "Dane",
            "Country": "USA"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "ID": "4356789876",
         "IDType": "NPI"
      }
   },
   "Visit": {
      "VisitNumber": "1234",
      "PatientClass": "Inpatient",
      "VisitDateTime": "2017-12-06T00:28:29.483Z",
      "Duration": 15,
      "Reason": "Check up",
      "Instructions": [],
      "Balance": 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"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         }
      },
      "ConsultingProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": null
         }
      },
      "ReferringProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": 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",
         "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
         },
         "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": {
               "LastName": null,
               "FirstName": null,
               "Relationship": null,
               "DOB": null,
               "Address": {
                  "StreetAddress": null,
                  "City": null,
                  "State": null,
                  "ZIP": null,
                  "County": null,
                  "Country": null
               }
            }
         }
      ]
   }
}

Dischargelink

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

Fields

  • Meta
    • Meta.DataModel

      String

      Reliable
      Required

      Data model. E.g. Scheduling, Results

    • Meta.EventType

      String

      Reliable
      Required

      Type of event. Discharge

    • 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. One of the following: Female, Male, Unknown, Other

    • Patient.Demographics.IsHispanic

      Boolean

      Possible

      Indicates if the patient is of hispanic origin.

    • Patient.Demographics.MaritalStatus

      String

      Possible

      Patient's marital status. Supported Values

    • 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: ICD9, ICD10, HCPCS, CPT

    • Patient.Diagnoses[].Name

      String

      Probable

      Name of the diagnosis

    • Patient.Diagnoses[].Type

      String

      Possible

      List of diagnoses associated with this visit. One of the following: Admitting, Working, or Final

    • 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[].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.PCP

      Object

      Reliable

      Primary Care Provider for the Patient

    • Patient.PCP.NPI

      String

      Reliable

      NPI of 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.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.PCP.PhoneNumber.Office

      String

      Possible

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

    • Patient.PCP.PhoneNumber

      String

      Probable

      PCP's phone number. In E. 164 Format. (i.e. +16085551234)

    • Patient.PCP.ID

      String

      Possible

      PCP's identifier

    • Patient.PCP.IDType

      String

      Possible

      PCP's identifier type

    • Patient.PCP.Address

      Object

      Probable

      PCP's address

    • Patient.PCP.Address.StreetAddress

      String

      Probable

      Street address

    • Patient.PCP.Address.City

      String

      Probable

      City

    • Patient.PCP.Address.State

      String

      Probable

      State

    • Patient.PCP.Address.ZIP

      String

      Probable

      ZIP

    • Patient.PCP.Address.County

      String

      Possible

      County

    • Patient.PCP.Address.Country

      String

      Possible

      Country

  • Visit
    • Visit.VisitNumber

      String

      Reliable

      Visit Number

    • 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.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.AttendingProvider.ID

      String

      Probable

      ID of the attending provider. This ID is 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.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.AttendingProvider.PhoneNumber.Office

      String

      Possible

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

    • Visit.ConsultingProvider.ID

      String

      Possible

      ID of the consulting provider. This ID is 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.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.ConsultingProvider.PhoneNumber.Office

      String

      Possible

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

    • Visit.ReferringProvider.ID

      String

      Possible

      ID of the referring provider. This ID is 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.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.ReferringProvider.PhoneNumber.Office

      String

      Possible

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

    • 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.DOB

      String

      Possible

      Guarantor's date of birth. In ISO 8601 format

    • Visit.Guarantor.Sex

      String

      Possible

      Guarantor's sex. One of the following: Female, Male, Unknown, Other

    • 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.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.LastName

      String

      Possible

      Last name of the insured

    • Visit.Insurances[].Insured.FirstName

      String

      Possible

      First name of the insured

    • 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.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

{
   "Meta": {
      "DataModel": "PatientAdmin",
      "EventType": "Discharge",
      "EventDateTime": "2017-12-06T00:28:28.775Z",
      "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": "Asian",
         "IsHispanic": null,
         "MaritalStatus": "Single",
         "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
         }
      ],
      "Allergies": [
         {
            "Code": "7982",
            "Codeset": "RxNorm",
            "Name": "Penicillin",
            "OnsetDateTime": null,
            "Reaction": [
               {
                  "Code": "28926001",
                  "Codeset": "SNOMED CT",
                  "Name": "Rash"
               },
               {
                  "Code": "247472004",
                  "Codeset": "SNOMED CT",
                  "Name": "Hives"
               }
            ]
         }
      ],
      "PCP": {
         "NPI": "4356789876",
         "FirstName": "Pat",
         "LastName": "Granite",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "Madison",
            "State": "WI",
            "ZIP": "53703",
            "County": "Dane",
            "Country": "USA"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "ID": "4356789876",
         "IDType": "NPI"
      }
   },
   "Visit": {
      "VisitNumber": "1234",
      "PatientClass": "Inpatient",
      "VisitDateTime": "2017-12-05T00:28:29.499Z",
      "DischargeDateTime": "2017-12-06T00:28:29.499Z",
      "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,
      "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"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         }
      },
      "ConsultingProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": null
         }
      },
      "ReferringProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": 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",
         "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
         },
         "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": {
               "LastName": null,
               "FirstName": null,
               "Relationship": null,
               "DOB": null,
               "Address": {
                  "StreetAddress": null,
                  "City": null,
                  "State": null,
                  "ZIP": null,
                  "County": null,
                  "Country": null
               }
            }
         }
      ]
   }
}

NewPatientlink

The NewPatient event signals that a new patient has been created in the source system. Typically this will be followed with a more specific message such as a VisitUpdate message when a visit is created.

Fields

  • Meta
    • Meta.DataModel

      String

      Reliable
      Required

      Data model. E.g. Scheduling, Results

    • Meta.EventType

      String

      Reliable
      Required

      Type of event. E.g. New, Update

    • 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. One of the following: Female, Male, Unknown, Other

    • Patient.Demographics.IsHispanic

      Boolean

      Possible

      Indicates if the patient is of hispanic origin.

    • Patient.Demographics.MaritalStatus

      String

      Possible

      Patient's marital status. Supported Values

    • 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[].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.PCP

      Object

      Reliable

      Primary Care Provider for the Patient

    • Patient.PCP

      Object

      Reliable

      Primary Care Provider for the Patient

    • Patient.PCP.NPI

      String

      Reliable

      NPI of 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.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.PCP.PhoneNumber.Office

      String

      Possible

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

    • Patient.PCP.ID

      String

      Possible

      PCP's identifier

    • Patient.PCP.IDType

      String

      Possible

      PCP's identifier type

    • 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.DOB

      String

      Possible

      Guarantor's date of birth. In ISO 8601 format

    • Patient.Guarantor.Sex

      String

      Possible

      Guarantor's sex. One of the following: Female, Male, Unknown, Other

    • 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.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.LastName

      String

      Possible

      Last name of the insured

    • Patient.Insurances[].Insured.FirstName

      String

      Possible

      First name of the insured

    • 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.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

{
   "Meta": {
      "DataModel": "PatientAdmin",
      "EventType": "NewPatient",
      "EventDateTime": "2017-12-06T00:28:28.775Z",
      "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": "Asian",
         "IsHispanic": null,
         "MaritalStatus": "Single",
         "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",
            "OnsetDateTime": null,
            "Reaction": [
               {
                  "Code": "28926001",
                  "Codeset": "SNOMED CT",
                  "Name": "Rash"
               },
               {
                  "Code": "247472004",
                  "Codeset": "SNOMED CT",
                  "Name": "Hives"
               }
            ]
         }
      ],
      "PCP": {
         "NPI": "4356789876",
         "FirstName": "Pat",
         "LastName": "Granite",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "Madison",
            "State": "WI",
            "ZIP": "53703",
            "County": "Dane",
            "Country": "USA"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         },
         "ID": "4356789876",
         "IDType": "NPI"
      },
      "Guarantor": {
         "Number": "10001910",
         "FirstName": "Kent",
         "LastName": "Bixby",
         "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
         },
         "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": {
               "LastName": null,
               "FirstName": null,
               "Relationship": null,
               "DOB": null,
               "Address": {
                  "StreetAddress": null,
                  "City": null,
                  "State": null,
                  "ZIP": null,
                  "County": null,
                  "Country": null
               }
            }
         }
      ]
   }
}

PatientUpdatelink

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

Fields

  • Meta
    • Meta.DataModel

      String

      Reliable
      Required

      Data model. E.g. Scheduling, Results

    • Meta.EventType

      String

      Reliable
      Required

      Type of event. Patient Update

    • 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. One of the following: Female, Male, Unknown, Other

    • Patient.Demographics.IsHispanic

      Boolean

      Possible

      Indicates if the patient is of hispanic origin.

    • Patient.Demographics.MaritalStatus

      String

      Possible

      Patient's marital status. Supported Values

    • 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: ICD9, ICD10, HCPCS, CPT

    • Patient.Diagnoses[].Name

      String

      Probable

      Name of the diagnosis

    • Patient.Diagnoses[].Type

      String

      Possible

      List of diagnoses associated with this visit. One of the following: Admitting, Working, or Final

    • 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[].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.PCP

      Object

      Reliable

      Primary Care Provider for the Patient

    • Patient.PCP.NPI

      String

      Reliable

      NPI of 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.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.PCP.PhoneNumber.Office

      String

      Possible

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

    • Patient.PCP.PhoneNumber

      String

      Probable

      PCP's phone number. In E. 164 Format. (i.e. +16085551234)

    • Patient.PCP.ID

      String

      Possible

      PCP's identifier

    • Patient.PCP.IDType

      String

      Possible

      PCP's identifier type

    • Patient.PCP.Address

      Object

      Probable

      PCP's address

    • Patient.PCP.Address.StreetAddress

      String

      Probable

      Street address

    • Patient.PCP.Address.City

      String

      Probable

      City

    • Patient.PCP.Address.State

      String

      Probable

      State

    • Patient.PCP.Address.ZIP

      String

      Probable

      ZIP

    • Patient.PCP.Address.County

      String

      Possible

      County

    • Patient.PCP.Address.Country

      String

      Possible

      Country

    • 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.LastName

      String

      Possible

      Last name of the insured

    • Patient.Insurances[].Insured.FirstName

      String

      Possible

      First name of the insured

    • 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.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

{
   "Meta": {
      "DataModel": "PatientAdmin",
      "EventType": "PatientUpdate",
      "EventDateTime": "2017-12-06T00:28:28.775Z",
      "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": "Asian",
         "IsHispanic": null,
         "MaritalStatus": "Single",
         "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
         }
      ],
      "Allergies": [
         {
            "Code": "7982",
            "Codeset": "RxNorm",
            "Name": "Penicillin",
            "OnsetDateTime": null,
            "Reaction": [
               {
                  "Code": "28926001",
                  "Codeset": "SNOMED CT",
                  "Name": "Rash"
               },
               {
                  "Code": "247472004",
                  "Codeset": "SNOMED CT",
                  "Name": "Hives"
               }
            ]
         }
      ],
      "PCP": {
         "NPI": "4356789876",
         "FirstName": "Pat",
         "LastName": "Granite",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "Madison",
            "State": "WI",
            "ZIP": "53703",
            "County": "Dane",
            "Country": "USA"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "ID": "4356789876",
         "IDType": "NPI"
      },
      "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": {
               "LastName": null,
               "FirstName": null,
               "Relationship": null,
               "DOB": null,
               "Address": {
                  "StreetAddress": null,
                  "City": null,
                  "State": null,
                  "ZIP": null,
                  "County": null,
                  "Country": null
               }
            }
         }
      ]
   }
}

PatientMergelink

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

  • 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.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. One of the following: Female, Male, Unknown, Other

    • Patient.Demographics.IsHispanic

      Boolean

      Possible

      Indicates if the patient is of hispanic origin.

    • Patient.Demographics.MaritalStatus

      String

      Possible

      Patient's marital status. Supported Values

    • 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

{
   "Meta": {
      "DataModel": "PatientAdmin",
      "EventType": "PatientMerge",
      "EventDateTime": "2017-12-06T00:28:28.775Z",
      "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": "Asian",
         "IsHispanic": null,
         "MaritalStatus": "Single",
         "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": []
   }
}

PreAdmitlink

A Pre-Admit event is used to prepare an admission or encounter. This event may allow for creating a patient, as well as creating a visit. For example, a pre-admit may be used prior to surgery so that lab tests can be performed. It may also be used to update the Emergency Department with an expected patient.

Fields

  • Meta
    • Meta.DataModel

      String

      Reliable
      Required

      Data model. E.g. Scheduling, Results

    • Meta.EventType

      String

      Reliable
      Required

      Type of event. Registration

    • 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. One of the following: Female, Male, Unknown, Other

    • Patient.Demographics.IsHispanic

      Boolean

      Possible

      Indicates if the patient is of hispanic origin.

    • Patient.Demographics.MaritalStatus

      String

      Possible

      Patient's marital status. Supported Values

    • 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: ICD9, ICD10, HCPCS, CPT

    • Patient.Diagnoses[].Name

      String

      Probable

      Name of the diagnosis

    • Patient.Diagnoses[].Type

      String

      Possible

      List of diagnoses associated with this visit. One of the following: Admitting, Working, or Final

    • 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[].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.PCP

      Object

      Reliable

      Primary Care Provider for the Patient

    • Patient.PCP.NPI

      String

      Reliable

      NPI of 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.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.PCP.PhoneNumber.Office

      String

      Possible

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

    • Patient.PCP.PhoneNumber

      String

      Probable

      PCP's phone number. In E. 164 Format. (i.e. +16085551234)

    • Patient.PCP.ID

      String

      Possible

      PCP's identifier

    • Patient.PCP.IDType

      String

      Possible

      PCP's identifier type

    • Patient.PCP.Address

      Object

      Probable

      PCP's address

    • Patient.PCP.Address.StreetAddress

      String

      Probable

      Street address

    • Patient.PCP.Address.City

      String

      Probable

      City

    • Patient.PCP.Address.State

      String

      Probable

      State

    • Patient.PCP.Address.ZIP

      String

      Probable

      ZIP

    • Patient.PCP.Address.County

      String

      Possible

      County

    • Patient.PCP.Address.Country

      String

      Possible

      Country

  • Visit
    • Visit.VisitNumber

      String

      Reliable

      Visit Number

    • 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.AttendingProvider.ID

      String

      Probable

      ID of the attending provider. This ID is 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.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.AttendingProvider.PhoneNumber.Office

      String

      Possible

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

    • Visit.ConsultingProvider.ID

      String

      Possible

      ID of the consulting provider. This ID is 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.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.ConsultingProvider.PhoneNumber.Office

      String

      Possible

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

    • Visit.ReferringProvider.ID

      String

      Possible

      ID of the referring provider. This ID is 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.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.ReferringProvider.PhoneNumber.Office

      String

      Possible

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

    • 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.DOB

      String

      Possible

      Guarantor's date of birth. In ISO 8601 format

    • Visit.Guarantor.Sex

      String

      Possible

      Guarantor's sex. One of the following: Female, Male, Unknown, Other

    • 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.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.LastName

      String

      Possible

      Last name of the insured

    • Visit.Insurances[].Insured.FirstName

      String

      Possible

      First name of the insured

    • 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.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

{
   "Meta": {
      "DataModel": "PatientAdmin",
      "EventType": "PreAdmit",
      "EventDateTime": "2017-12-06T00:28:28.775Z",
      "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": "Asian",
         "IsHispanic": null,
         "MaritalStatus": "Single",
         "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
         }
      ],
      "Allergies": [
         {
            "Code": "7982",
            "Codeset": "RxNorm",
            "Name": "Penicillin",
            "OnsetDateTime": null,
            "Reaction": [
               {
                  "Code": "28926001",
                  "Codeset": "SNOMED CT",
                  "Name": "Rash"
               },
               {
                  "Code": "247472004",
                  "Codeset": "SNOMED CT",
                  "Name": "Hives"
               }
            ]
         }
      ],
      "PCP": {
         "NPI": "4356789876",
         "FirstName": "Pat",
         "LastName": "Granite",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "Madison",
            "State": "WI",
            "ZIP": "53703",
            "County": "Dane",
            "Country": "USA"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "ID": "4356789876",
         "IDType": "NPI"
      }
   },
   "Visit": {
      "VisitNumber": "1234",
      "PatientClass": "Inpatient",
      "VisitDateTime": "2017-12-06T00:28:29.523Z",
      "Duration": 15,
      "Reason": "Check up",
      "Instructions": [],
      "Balance": 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"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         }
      },
      "ConsultingProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": null
         }
      },
      "ReferringProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": 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",
         "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
         },
         "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": {
               "LastName": null,
               "FirstName": null,
               "Relationship": null,
               "DOB": null,
               "Address": {
                  "StreetAddress": null,
                  "City": null,
                  "State": null,
                  "ZIP": null,
                  "County": null,
                  "Country": null
               }
            }
         }
      ]
   }
}

Registrationlink

A Registration message is generated when a patient is checked into a specific visit or registered for a Hospital Outpatient Visit.

Fields

  • Meta
    • Meta.DataModel

      String

      Reliable
      Required

      Data model. E.g. Scheduling, Results

    • Meta.EventType

      String

      Reliable
      Required

      Type of event. Registration

    • 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. One of the following: Female, Male, Unknown, Other

    • Patient.Demographics.IsHispanic

      Boolean

      Possible

      Indicates if the patient is of hispanic origin.

    • Patient.Demographics.MaritalStatus

      String

      Possible

      Patient's marital status. Supported Values

    • 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: ICD9, ICD10, HCPCS, CPT

    • Patient.Diagnoses[].Name

      String

      Probable

      Name of the diagnosis

    • Patient.Diagnoses[].Type

      String

      Possible

      List of diagnoses associated with this visit. One of the following: Admitting, Working, or Final

    • 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[].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.PCP

      Object

      Reliable

      Primary Care Provider for the Patient

    • Patient.PCP.NPI

      String

      Reliable

      NPI of 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.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.PCP.PhoneNumber.Office

      String

      Possible

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

    • Patient.PCP.PhoneNumber

      String

      Probable

      PCP's phone number. In E. 164 Format. (i.e. +16085551234)

    • Patient.PCP.ID

      String

      Possible

      PCP's identifier

    • Patient.PCP.IDType

      String

      Possible

      PCP's identifier type

    • Patient.PCP.Address

      Object

      Probable

      PCP's address

    • Patient.PCP.Address.StreetAddress

      String

      Probable

      Street address

    • Patient.PCP.Address.City

      String

      Probable

      City

    • Patient.PCP.Address.State

      String

      Probable

      State

    • Patient.PCP.Address.ZIP

      String

      Probable

      ZIP

    • Patient.PCP.Address.County

      String

      Possible

      County

    • Patient.PCP.Address.Country

      String

      Possible

      Country

  • Visit
    • Visit.VisitNumber

      String

      Reliable

      Visit Number

    • 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.AttendingProvider.ID

      String

      Probable

      ID of the attending provider. This ID is 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.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.AttendingProvider.PhoneNumber.Office

      String

      Possible

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

    • Visit.ConsultingProvider.ID

      String

      Possible

      ID of the consulting provider. This ID is 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.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.ConsultingProvider.PhoneNumber.Office

      String

      Possible

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

    • Visit.ReferringProvider.ID

      String

      Possible

      ID of the referring provider. This ID is 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.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.ReferringProvider.PhoneNumber.Office

      String

      Possible

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

    • 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.DOB

      String

      Possible

      Guarantor's date of birth. In ISO 8601 format

    • Visit.Guarantor.Sex

      String

      Possible

      Guarantor's sex. One of the following: Female, Male, Unknown, Other

    • 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.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.LastName

      String

      Possible

      Last name of the insured

    • Visit.Insurances[].Insured.FirstName

      String

      Possible

      First name of the insured

    • 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.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

{
   "Meta": {
      "DataModel": "PatientAdmin",
      "EventType": "Registration",
      "EventDateTime": "2017-12-06T00:28:28.775Z",
      "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": "Asian",
         "IsHispanic": null,
         "MaritalStatus": "Single",
         "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
         }
      ],
      "Allergies": [
         {
            "Code": "7982",
            "Codeset": "RxNorm",
            "Name": "Penicillin",
            "OnsetDateTime": null,
            "Reaction": [
               {
                  "Code": "28926001",
                  "Codeset": "SNOMED CT",
                  "Name": "Rash"
               },
               {
                  "Code": "247472004",
                  "Codeset": "SNOMED CT",
                  "Name": "Hives"
               }
            ]
         }
      ],
      "PCP": {
         "NPI": "4356789876",
         "FirstName": "Pat",
         "LastName": "Granite",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "Madison",
            "State": "WI",
            "ZIP": "53703",
            "County": "Dane",
            "Country": "USA"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "ID": "4356789876",
         "IDType": "NPI"
      }
   },
   "Visit": {
      "VisitNumber": "1234",
      "PatientClass": "Inpatient",
      "VisitDateTime": "2017-12-06T00:28:29.531Z",
      "Duration": 15,
      "Reason": "Check up",
      "Instructions": [],
      "Balance": 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"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         }
      },
      "ConsultingProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": null
         }
      },
      "ReferringProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": 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",
         "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
         },
         "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": {
               "LastName": null,
               "FirstName": null,
               "Relationship": null,
               "DOB": null,
               "Address": {
                  "StreetAddress": null,
                  "City": null,
                  "State": null,
                  "ZIP": null,
                  "County": null,
                  "Country": null
               }
            }
         }
      ]
   }
}

Transferlink

A Transfer message is generated when a patient is tranferred from one unit to another.

Fields

  • Meta
    • Meta.DataModel

      String

      Reliable
      Required

      Data model. E.g. Scheduling, Results

    • Meta.EventType

      String

      Reliable
      Required

      Type of event. Transfer

    • 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. One of the following: Female, Male, Unknown, Other

    • Patient.Demographics.IsHispanic

      Boolean

      Possible

      Indicates if the patient is of hispanic origin.

    • Patient.Demographics.MaritalStatus

      String

      Possible

      Patient's marital status. Supported Values

    • 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: ICD9, ICD10, HCPCS, CPT

    • Patient.Diagnoses[].Name

      String

      Probable

      Name of the diagnosis

    • Patient.Diagnoses[].Type

      String

      Possible

      List of diagnoses associated with this visit. One of the following: Admitting, Working, or Final

    • 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[].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.PCP

      Object

      Reliable

      Primary Care Provider for the Patient

    • Patient.PCP.NPI

      String

      Reliable

      NPI of 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.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.PCP.PhoneNumber.Office

      String

      Possible

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

    • Patient.PCP.PhoneNumber

      String

      Probable

      PCP's phone number. In E. 164 Format. (i.e. +16085551234)

    • Patient.PCP.ID

      String

      Possible

      PCP's identifier

    • Patient.PCP.IDType

      String

      Possible

      PCP's identifier type

    • Patient.PCP.Address

      Object

      Probable

      PCP's address

    • Patient.PCP.Address.StreetAddress

      String

      Probable

      Street address

    • Patient.PCP.Address.City

      String

      Probable

      City

    • Patient.PCP.Address.State

      String

      Probable

      State

    • Patient.PCP.Address.ZIP

      String

      Probable

      ZIP

    • Patient.PCP.Address.County

      String

      Possible

      County

    • Patient.PCP.Address.Country

      String

      Possible

      Country

  • Visit
    • Visit.VisitNumber

      String

      Reliable

      Visit Number

    • 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

      Probable

      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.Description

      String

      Probable

      Description of the discharge status

    • 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.AttendingProvider.ID

      String

      Probable

      ID of the attending provider. This ID is 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.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.AttendingProvider.PhoneNumber.Office

      String

      Possible

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

    • Visit.ConsultingProvider.ID

      String

      Possible

      ID of the consulting provider. This ID is 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.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.ConsultingProvider.PhoneNumber.Office

      String

      Possible

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

    • Visit.ReferringProvider.ID

      String

      Possible

      ID of the referring provider. This ID is 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.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.ReferringProvider.PhoneNumber.Office

      String

      Possible

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

    • 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.PreviousLocation

      Object

      Probable

      Previous location of the appointment

    • Visit.PreviousLocation.Type

      String

      Probable

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

    • Visit.PreviousLocation.Facility

      String

      Probable

      Facility. Example: Community Hospital

    • Visit.PreviousLocation.Department

      String

      Probable

      Department

    • Visit.PreviousLocation.Room

      String

      Probable

      Room. Example: 136

    • Visit.PreviousLocation.Bed

      String

      Probable

      Bed. Example: B

    • Visit.PreviousLocation.Address

      Object

      Probable

      Address of the previous location

    • Visit.PreviousLocation.Address.StreetAddress

      String

      Probable

      Street address

    • Visit.PreviousLocation.Address.City

      String

      Probable

      City

    • Visit.PreviousLocation.Address.State

      String

      Probable

      State

    • Visit.PreviousLocation.Address.ZIP

      String

      Probable

      ZIP

    • Visit.PreviousLocation.Address.County

      String

      Possible

      County

    • Visit.PreviousLocation.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.DOB

      String

      Possible

      Guarantor's date of birth. In ISO 8601 format

    • Visit.Guarantor.Sex

      String

      Possible

      Guarantor's sex. One of the following: Female, Male, Unknown, Other

    • 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.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.LastName

      String

      Possible

      Last name of the insured

    • Visit.Insurances[].Insured.FirstName

      String

      Possible

      First name of the insured

    • 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.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

{
   "Meta": {
      "DataModel": "PatientAdmin",
      "EventType": "Transfer",
      "EventDateTime": "2017-12-06T00:28:28.775Z",
      "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": "Asian",
         "IsHispanic": null,
         "MaritalStatus": "Single",
         "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
         }
      ],
      "Allergies": [
         {
            "Code": "7982",
            "Codeset": "RxNorm",
            "Name": "Penicillin",
            "OnsetDateTime": null,
            "Reaction": [
               {
                  "Code": "28926001",
                  "Codeset": "SNOMED CT",
                  "Name": "Rash"
               },
               {
                  "Code": "247472004",
                  "Codeset": "SNOMED CT",
                  "Name": "Hives"
               }
            ]
         }
      ],
      "PCP": {
         "NPI": "4356789876",
         "FirstName": "Pat",
         "LastName": "Granite",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "Madison",
            "State": "WI",
            "ZIP": "53703",
            "County": "Dane",
            "Country": "USA"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "ID": "4356789876",
         "IDType": "NPI"
      }
   },
   "Visit": {
      "VisitNumber": "1234",
      "PatientClass": "Inpatient",
      "VisitDateTime": "2017-12-06T00:28:29.540Z",
      "DischargeDateTime": null,
      "DischargeStatus": {
         "Code": "09",
         "Codeset": "UB04FL17",
         "Description": "Admitted as an inpatient to this hospital"
      },
      "Duration": 30,
      "Reason": "Check up",
      "Instructions": [],
      "Balance": 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"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         }
      },
      "ConsultingProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": null
         }
      },
      "ReferringProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": 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"
         }
      },
      "PreviousLocation": {
         "Type": null,
         "Facility": null,
         "Department": null,
         "Room": null,
         "Bed": null,
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         }
      },
      "Guarantor": {
         "Number": "10001910",
         "FirstName": "Kent",
         "LastName": "Bixby",
         "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
         },
         "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": {
               "LastName": null,
               "FirstName": null,
               "Relationship": null,
               "DOB": null,
               "Address": {
                  "StreetAddress": null,
                  "City": null,
                  "State": null,
                  "ZIP": null,
                  "County": null,
                  "Country": null
               }
            }
         }
      ]
   }
}

VisitMergeBETAlink

Patient.Identifiers contains the identifiers for the record that the visit should be moved to.

The full Patient object is included in the message to provide extra context when available.

Fields

  • 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.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. One of the following: Female, Male, Unknown, Other

    • Patient.Demographics.IsHispanic

      Boolean

      Possible

      Indicates if the patient is of hispanic origin.

    • Patient.Demographics.MaritalStatus

      String

      Possible

      Patient's marital status. Supported Values

    • 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

  • Visit
    • Visit.VisitNumber

      String

      Reliable
      Required

      Visit Number

{
   "Meta": {
      "DataModel": "PatientAdmin",
      "EventType": "VisitMerge",
      "EventDateTime": "2017-12-06T00:28:28.775Z",
      "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": "Asian",
         "IsHispanic": null,
         "MaritalStatus": "Single",
         "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": []
   },
   "Visit": {
      "VisitNumber": "123456"
   }
}

VisitUpdatelink

A VisitUpdate message is generated when any patient or registration information changes.

Fields

  • Meta
    • Meta.DataModel

      String

      Reliable
      Required

      Data model. E.g. Scheduling, Results

    • Meta.EventType

      String

      Reliable
      Required

      Type of event. Registration

    • 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. One of the following: Female, Male, Unknown, Other

    • Patient.Demographics.IsHispanic

      Boolean

      Possible

      Indicates if the patient is of hispanic origin.

    • Patient.Demographics.MaritalStatus

      String

      Possible

      Patient's marital status. Supported Values

    • 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: ICD9, ICD10, HCPCS, CPT

    • Patient.Diagnoses[].Name

      String

      Probable

      Name of the diagnosis

    • Patient.Diagnoses[].Type

      String

      Possible

      List of diagnoses associated with this visit. One of the following: Admitting, Working, or Final

    • 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[].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.PCP

      Object

      Reliable

      Primary Care Provider for the Patient

    • Patient.PCP.NPI

      String

      Reliable

      NPI of the PCP

    • Patient.PCP.FirstName

      String

      Possible