Redox | Insurance

Insurance

The Insurance data model contains New and Update event types. Insurance information such as payer and plan information can be sent with each of these events.

New
Update

New

BETA

A new message is used to convey insurance instances that have just been created.

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  Insurance
- Meta.EventType
  String
  Reliable
  Required
  Update
- Meta.EventDateTime
  DateTime
  Reliable
  Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Indicates whether the request is a test or not.
- Meta.Source
  String
  Reliable
  Contains the information for the system initiating the message, including the source ID and name.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  Identifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
  UUID
- Meta.Source.Name
  String
  Reliable
  Displays the name of the system initiating the message.
- Meta.Destinations[]
  Array of Objects
  Reliable
  Contains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
  Required when sending data to Redox.
- Meta.Destinations[].ID
  String
  Reliable
  Identifies the endpoint that the request is directed to.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Displays the name of the endpoint that the request is directed to.
- Meta.Logs[]
  Array of Objects
  Reliable
  Contains the log identifier(s) for the request.
- Meta.Logs[].ID
  String
  Reliable
  Identifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
  UUID
- Meta.Logs[].AttemptID
  String
  Reliable
  Identifies the request log attempt value, which is useful when retries are possible.
  UUID
- 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.
Insurances
- Insurances[].Plan.ID
  String
  Probable
  Identifier of insurance plan
- Insurances[].Plan.IDType
  String
  Probable
  ID type of insurance plan
- Insurances[].Plan.Name
  String
  Probable
  Name of insurance plan
- Insurances[].Plan.Type
  String
  Possible
  Type of insurance plan
- Insurances[].Payer.ID
  String
  Probable
  Identifer of the payer.
  A unique ID number that is assigned to a payer for the purpose of transmitting claims
- Insurances[].Payer.IDType
  String
  Probable
  ID type of the payer
- Insurances[].Payer.Name
  String
  Probable
  Name of the payer
- Insurances[].Payer.Alias
  String
  Possible
  Payer alias
- Insurances[].Payer.Address
  Object
  Probable
  Insurance company's address
- Insurances[].Payer.Address.StreetAddress
  String
  Probable
  Street address
- Insurances[].Payer.Address.City
  String
  Probable
  City
- Insurances[].Payer.Address.State
  String
  Probable
  State
- Insurances[].Payer.Address.ZIP
  String
  Probable
  ZIP
- Insurances[].Payer.Address.County
  String
  Possible
  County
- Insurances[].Payer.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.

Sample MessageDownload JSON Schema

{
   "Meta": {
      "DataModel": "Insurance",
      "EventType": "New",
      "EventDateTime": "2024-07-29T16:55:22.999Z",
      "Test": true,
      "Source": {
         "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
         "Name": "Redox Dev Tools"
      },
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "Logs": [
         {
            "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
            "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
         }
      ],
      "FacilityCode": null
   },
   "Insurances": [
      {
         "Plan": {
            "ID": "31572",
            "IDType": "Payor ID",
            "Name": "HMO Deductible Plan",
            "Type": null
         },
         "Payer": {
            "ID": "60054",
            "IDType": null,
            "Name": "Aetna (60054 0131)",
            "Alias": "AET",
            "Address": {
               "StreetAddress": "PO Box 14080",
               "City": "Lexington",
               "State": "KY",
               "ZIP": "40512-4079",
               "County": "Fayette",
               "Country": "US"
            }
         }
      }
   ]
}

Update

BETA

A update message is used to convey changes in information for an insurance.

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  Insurance
- Meta.EventType
  String
  Reliable
  Required
  Update
- Meta.EventDateTime
  DateTime
  Reliable
  Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Indicates whether the request is a test or not.
- Meta.Source
  String
  Reliable
  Contains the information for the system initiating the message, including the source ID and name.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  Identifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
  UUID
- Meta.Source.Name
  String
  Reliable
  Displays the name of the system initiating the message.
- Meta.Destinations[]
  Array of Objects
  Reliable
  Contains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
  Required when sending data to Redox.
- Meta.Destinations[].ID
  String
  Reliable
  Identifies the endpoint that the request is directed to.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Displays the name of the endpoint that the request is directed to.
- Meta.Logs[]
  Array of Objects
  Reliable
  Contains the log identifier(s) for the request.
- Meta.Logs[].ID
  String
  Reliable
  Identifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
  UUID
- Meta.Logs[].AttemptID
  String
  Reliable
  Identifies the request log attempt value, which is useful when retries are possible.
  UUID
- 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.
Insurances
- Insurances[].Plan.ID
  String
  Probable
  Identifier of insurance plan
- Insurances[].Plan.IDType
  String
  Probable
  ID type of insurance plan
- Insurances[].Plan.Name
  String
  Probable
  Name of insurance plan
- Insurances[].Plan.Type
  String
  Possible
  Type of insurance plan
- Insurances[].Payer.ID
  String
  Probable
  Identifer of the payer.
  A unique ID number that is assigned to a payer for the purpose of transmitting claims
- Insurances[].Payer.IDType
  String
  Probable
  ID type of the payer
- Insurances[].Payer.Name
  String
  Probable
  Name of the payer
- Insurances[].Payer.Alias
  String
  Possible
  Payer alias
- Insurances[].Payer.Address
  Object
  Probable
  Insurance company's address
- Insurances[].Payer.Address.StreetAddress
  String
  Probable
  Street address
- Insurances[].Payer.Address.City
  String
  Probable
  City
- Insurances[].Payer.Address.State
  String
  Probable
  State
- Insurances[].Payer.Address.ZIP
  String
  Probable
  ZIP
- Insurances[].Payer.Address.County
  String
  Possible
  County
- Insurances[].Payer.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.

Sample MessageDownload JSON Schema

{
   "Meta": {
      "DataModel": "Insurance",
      "EventType": "Update",
      "EventDateTime": "2024-07-29T16:55:22.999Z",
      "Test": true,
      "Source": {
         "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
         "Name": "Redox Dev Tools"
      },
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "Logs": [
         {
            "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
            "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
         }
      ],
      "FacilityCode": null
   },
   "Insurances": [
      {
         "Plan": {
            "ID": "31572",
            "IDType": "Payor ID",
            "Name": "HMO Deductible Plan",
            "Type": null
         },
         "Payer": {
            "ID": "60054",
            "IDType": null,
            "Name": "Aetna (60054 0131)",
            "Alias": "AET",
            "Address": {
               "StreetAddress": "PO Box 14080",
               "City": "Lexington",
               "State": "KY",
               "ZIP": "40512-4079",
               "County": "Fayette",
               "Country": "US"
            }
         }
      }
   ]
}

Insurance

Newlink

Fields

Meta

Insurances

Updatelink

Fields

Meta

Insurances

New

Update