Provider

The Provider data model contains New, Update, Activate, and Deactivate events. Provider information such as demographics, qualifications, and roles can be sent with each of these events.

NewBETAlink

A New message is used to convey provider instances that have just been 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.

  • Providers
    • Providers[]

      Array of Objects

      Reliable

      The list of providers

    • Providers[].Identifiers[]

      Array of Objects

      Reliable

      List of IDs and ID types that identify the provider

    • Providers[].Identifiers[].ID

      String

      Reliable
      Required

      ID for the provider

    • Providers[].Identifiers[].IDType

      String

      Reliable

      Type of ID for the provider

    • Providers[].IsActive

      Boolean

      Reliable
      Required

      Whether the entry for this provider is active or inactive

    • Providers[].Demographics.FirstName

      String

      Reliable

      Provider's first name

    • Providers[].Demographics.LastName

      String

      Reliable

      Provider's last name

    • Providers[].Demographics.MiddleName

      String

      Possible

      Provider's middle name

    • Providers[].Demographics.Credentials[]

      Array of Strings

      Possible

      List of credentials for the provider. e.g. MD, PhD

    • Providers[].Demographics.Addresses[]

      Array of Objects

      Probable

      Provider's addresses

    • Providers[].Demographics.Addresses[].Use

      String

      Reliable

      The use for this address. e.g. Home, Office

    • Providers[].Demographics.Addresses[].StreetAddress

      String

      Reliable

      Street address

    • Providers[].Demographics.Addresses[].City

      String

      Reliable

      City

    • Providers[].Demographics.Addresses[].State

      String

      Reliable

      State

    • Providers[].Demographics.Addresses[].ZIP

      String

      Reliable

      Zip code

    • Providers[].Demographics.Addresses[].County

      String

      Reliable

      County

    • Providers[].Demographics.Addresses[].Country

      String

      Reliable

      Country

    • Providers[].Demographics.EmailAddresses[]

      Array of Strings

      Probable

      Email addresses for the provider

    • Providers[].Demographics.PhoneNumber.Home

      String

      Probable

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

    • Providers[].Demographics.PhoneNumber.Office

      String

      Reliable

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

    • Providers[].Demographics.PhoneNumber.Mobile

      String

      Probable

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

    • Providers[].Demographics.Sex

      String

      Reliable

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

    • Providers[].Demographics.DOB

      String

      Reliable

      Provider's date of birth. In ISO 8601 format

    • Providers[].Demographics.Languages[]

      Array of Strings

      Reliable

      Languages the provider is able to use in patient communication

    • Providers[].Qualifications[]

      Array of Objects

      Possible

      Provider's qualifications obtained by training and certification

    • Providers[].Qualifications[].Identifiers[]

      Array of Objects

      Reliable

      List of IDs and ID Types that identify the qualification

    • Providers[].Qualifications[].Identifiers[].ID

      String

      Reliable

      Identifier for the qualification

    • Providers[].Qualifications[].Identifiers[].IDType

      String

      Reliable

      Type of ID for the qualification

    • Providers[].Qualifications[]

      Array of Objects

      Probable

      Coded representation of the qualification

    • Providers[].Qualifications[].Code

      String

      Probable

      Code

    • Providers[].Qualifications[].Codeset

      String

      Probable

      Code set

    • Providers[].Qualifications[].Description

      String

      Probable

      Description

    • Providers[].Qualifications[].StartDate

      String

      Reliable

      Start date of the qualification. In ISO 8601 format

    • Providers[].Qualifications[].EndDate

      String

      Reliable

      End date of the qualification. In ISO 8601 format

    • Providers[].Roles[]

      Array of Objects

      Probable

      Roles that the provider is associated with

    • Providers[].Roles[].Identifiers[]

      Array of Objects

      Reliable

      List of IDs and ID Types that identify the role

    • Providers[].Roles[].Identifiers[].ID

      String

      Reliable

      Identifier for the role

    • Providers[].Roles[].Identifiers[].IDType

      String

      Reliable

      Type of ID for the role

    • Providers[].Roles[].Organization

      Object

      Reliable

      Organization where the role is available

    • Providers[].Roles[].Organization.Identifiers[]

      Array of Objects

      Reliable

      List of IDs and ID types that identify the organization

    • Providers[].Roles[].Organization.Identifiers[].ID

      String

      Reliable

      ID for the organization

    • Providers[].Roles[].Organization.Identifiers[].IDType

      String

      Reliable

      Type of ID for the organization

    • Providers[].Roles[].Organization.isActive

      String

      Reliable

      Whether this role is in active use

    • Providers[].Roles[].Organization.Type

      String

      Reliable

      Kind of organization

    • Providers[].Roles[].Organization.Name

      String

      Reliable

      Name of the organization

    • Providers[].Roles[].Organization.Address.StreetAddress

      String

      Reliable

      Street address

    • Providers[].Roles[].Organization.Address.City

      String

      Reliable

      City

    • Providers[].Roles[].Organization.Address.State

      String

      Reliable

      State

    • Providers[].Roles[].Organization.Address.ZIP

      String

      Reliable

      Zip code

    • Providers[].Roles[].Organization.Address.County

      String

      Reliable

      County

    • Providers[].Roles[].Organization.Address.Country

      String

      Reliable

      Country

    • Providers[].Roles[].Specialties[]

      Array of Objects

      Probable

      Coded representation of the specialty

    • Providers[].Roles[].Specialties[].Code

      String

      Probable

      Code

    • Providers[].Roles[].Specialties[].Codeset

      String

      Probable

      Code set

    • Providers[].Roles[].Specialties[].Description

      String

      Probable

      Description

    • Providers[].Roles[].Locations[]

      Array of Objects

      Reliable

      The location(s) at which the provider provides care

    • Providers[].Roles[].Locations[].Identifiers[]

      Array of Objects

      Reliable

      List of IDs and ID types that identify the location

    • Providers[].Roles[].Locations[].Identifiers[].ID

      String

      Reliable

      ID for the location

    • Providers[].Roles[].Locations[].Identifiers[].IDType

      String

      Reliable

      Type of ID for the location

    • Providers[].Roles[].Locations[].Status

      String

      Reliable

      Status of the location. One of Active, Suspended, Inactive

    • Providers[].Roles[].Locations[].Name

      String

      Reliable

      Name of the location

    • Providers[].Roles[].Locations[].Description

      String

      Reliable

      Additional details about the location

    • Providers[].Roles[].Locations[].Address.StreetAddress

      String

      Reliable

      Street address

    • Providers[].Roles[].Locations[].Address.City

      String

      Reliable

      City

    • Providers[].Roles[].Locations[].Address.State

      String

      Reliable

      State

    • Providers[].Roles[].Locations[].Address.ZIP

      String

      Reliable

      Zip code

    • Providers[].Roles[].Locations[].Address.County

      String

      Reliable

      County

    • Providers[].Roles[].Locations[].Address.Country

      String

      Reliable

      Country

    • Providers[].Roles[].Locations[].EmailAddresses[]

      Array of Strings

      Reliable

      List of email addresses for the location

    • Providers[].Roles[].Locations[].PhoneNumber.Office

      String

      Reliable

      Office phone number for the location. In E. 164 Format. (e.g. +16085551234)

    • Providers[].Roles[].Services[]

      Array of Objects

      Reliable

      The list of healthcare services that this worker provides for this role's Organization/Location(s)

    • Providers[].Roles[].Services[].Identifiers[]

      String

      Reliable

      List of IDs and ID types that identify the service

    • Providers[].Roles[].Services[].Identifiers[].ID

      String

      Reliable

      ID for the service

    • Providers[].Roles[].Services[].Identifiers[].IDType

      String

      Reliable

      Type of ID for the service

    • Providers[].Roles[].Services[].Type

      String

      Reliable

      Type of service that may be delivered or performed

    • Providers[].Roles[].Services[].Description

      String

      Reliable

      Description of the service

    • Providers[].Roles[].Services[].PhoneNumber.Office

      String

      Reliable

      Office phone number for information on the service. In E. 164 Format. (e.g. +16085551234)

    • Providers[].Roles[].Availability[]

      Array of Objects

      Possible

      Times the service location is available

    • Providers[].Roles[].Availability[].Days[]

      Array of Strings

      Reliable

      List of days that this availability schedule applies to. One of the following: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday

    • Providers[].Roles[].Availability[].AvailableStartTime

      Time

      Reliable

      Opening time of day. ISO 8601 Format

    • Providers[].Roles[].Availability[].AvailableEndTime

      Time

      Reliable

      Closing time of day. ISO 8601 Format

{
   "Meta": {
      "DataModel": "Provider",
      "EventType": "New",
      "EventDateTime": "2018-02-19T17:19:16.947Z",
      "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
   },
   "Providers": [
      {
         "Identifiers": [
            {
               "ID": "4356789876",
               "IDType": "NPI"
            }
         ],
         "IsActive": true,
         "Demographics": {
            "FirstName": "Pat",
            "LastName": "Granite",
            "MiddleName": "Marie",
            "Credentials": [
               "MD"
            ],
            "Addresses": [
               {
                  "Use": "Office",
                  "StreetAddress": "123 Main St.",
                  "City": "Madison",
                  "State": "WI",
                  "ZIP": "53703",
                  "County": "Dane",
                  "Country": "USA"
               }
            ],
            "EmailAddresses": [
               "pat.granite@redoxengine.com"
            ],
            "PhoneNumber": {
               "Home": "+16085551235",
               "Office": "+16085551234",
               "Mobile": "+16085551236"
            },
            "Sex": "Female",
            "DOB": "1963-01-06",
            "Languages": [
               "English",
               "Spanish"
            ]
         },
         "Qualifications": [
            {
               "Identifiers": [
                  {
                     "ID": "5421",
                     "IDType": null
                  }
               ],
               "Code": "MD",
               "Codeset": "http://hl7.org/fhir/v2/0360/2.7",
               "Description": "Doctor of Medicine",
               "StartDate": "2000-02-01",
               "EndDate": null
            }
         ],
         "Roles": [
            {
               "Identifiers": [
                  {
                     "ID": "12",
                     "IDType": null
                  }
               ],
               "Organization": {
                  "Identifiers": [
                     {
                        "ID": "135",
                        "IDType": null
                     }
                  ],
                  "isActive": null,
                  "Type": "Provider",
                  "Name": "Redox Clinic",
                  "Address": {
                     "StreetAddress": "123 Main St.",
                     "City": "Madison",
                     "State": "WI",
                     "ZIP": "53703",
                     "County": "Dane",
                     "Country": "USA"
                  }
               },
               "Specialties": [
                  {
                     "Code": "394802001",
                     "Codeset": "SnomedCT",
                     "Description": "General Medicine"
                  }
               ],
               "Locations": [
                  {
                     "Identifiers": [
                        {
                           "ID": "123354",
                           "IDType": null
                        }
                     ],
                     "Status": "active",
                     "Name": "Redox Clinic",
                     "Description": null,
                     "Address": {
                        "StreetAddress": "123 Main St",
                        "City": "Madison",
                        "State": "WI",
                        "ZIP": "53703",
                        "County": "Dane",
                        "Country": "USA"
                     },
                     "EmailAddresses": [],
                     "PhoneNumber": {
                        "Office": "+16084455673"
                     }
                  }
               ],
               "Services": [
                  {
                     "Identifiers": [
                        {
                           "ID": "60",
                           "IDType": null
                        }
                     ],
                     "Type": "Nutrition",
                     "Description": "Nutrition",
                     "PhoneNumber": {
                        "Office": "+16083334985"
                     }
                  }
               ],
               "Availability": [
                  {
                     "Days": [
                        "Monday",
                        "Tuesday"
                     ],
                     "AvailableStartTime": "09:00",
                     "AvailableEndTime": "17:00"
                  }
               ]
            }
         ]
      }
   ]
}

UpdateBETAlink

An Update message is used to convey changes in information for a provider.

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.

  • Providers
    • Providers[]

      Array of Objects

      Reliable

      The list of providers

    • Providers[].Identifiers[]

      Array of Objects

      Reliable

      List of IDs and ID types that identify the provider

    • Providers[].Identifiers[].ID

      String

      Reliable
      Required

      ID for the provider

    • Providers[].Identifiers[].IDType

      String

      Reliable

      Type of ID for the provider

    • Providers[].IsActive

      Boolean

      Reliable
      Required

      Whether the entry for this provider is active or inactive

    • Providers[].Demographics.FirstName

      String

      Reliable

      Provider's first name

    • Providers[].Demographics.LastName

      String

      Reliable

      Provider's last name

    • Providers[].Demographics.MiddleName

      String

      Possible

      Provider's middle name

    • Providers[].Demographics.Credentials[]

      Array of Strings

      Possible

      List of credentials for the provider. e.g. MD, PhD

    • Providers[].Demographics.Addresses[]

      Array of Objects

      Probable

      Provider's addresses

    • Providers[].Demographics.Addresses[].Use

      String

      Reliable

      The use for this address. e.g. Home, Office

    • Providers[].Demographics.Addresses[].StreetAddress

      String

      Reliable

      Street address

    • Providers[].Demographics.Addresses[].City

      String

      Reliable

      City

    • Providers[].Demographics.Addresses[].State

      String

      Reliable

      State

    • Providers[].Demographics.Addresses[].ZIP

      String

      Reliable

      Zip code

    • Providers[].Demographics.Addresses[].County

      String

      Reliable

      County

    • Providers[].Demographics.Addresses[].Country

      String

      Reliable

      Country

    • Providers[].Demographics.EmailAddresses[]

      Array of Strings

      Probable

      Email addresses for the provider

    • Providers[].Demographics.PhoneNumber.Home

      String

      Probable

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

    • Providers[].Demographics.PhoneNumber.Office

      String

      Reliable

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

    • Providers[].Demographics.PhoneNumber.Mobile

      String

      Probable

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

    • Providers[].Demographics.Sex

      String

      Reliable

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

    • Providers[].Demographics.DOB

      String

      Reliable

      Provider's date of birth. In ISO 8601 format

    • Providers[].Demographics.Languages[]

      Array of Strings

      Reliable

      Languages the provider is able to use in patient communication

    • Providers[].Qualifications[]

      Array of Objects

      Possible

      Provider's qualifications obtained by training and certification

    • Providers[].Qualifications[].Identifiers[]

      Array of Objects

      Reliable

      List of IDs and ID Types that identify the qualification

    • Providers[].Qualifications[].Identifiers[].ID

      String

      Reliable

      Identifier for the qualification

    • Providers[].Qualifications[].Identifiers[].IDType

      String

      Reliable

      Type of ID for the qualification

    • Providers[].Qualifications[]

      Array of Objects

      Probable

      Coded representation of the qualification

    • Providers[].Qualifications[].Code

      String

      Probable

      Code

    • Providers[].Qualifications[].Codeset

      String

      Probable

      Code set

    • Providers[].Qualifications[].Description

      String

      Probable

      Description

    • Providers[].Qualifications[].StartDate

      String

      Reliable

      Start date of the qualification. In ISO 8601 format

    • Providers[].Qualifications[].EndDate

      String

      Reliable

      End date of the qualification. In ISO 8601 format

    • Providers[].Roles[]

      Array of Objects

      Probable

      Roles that the provider is associated with

    • Providers[].Roles[].Identifiers[]

      Array of Objects

      Reliable

      List of IDs and ID Types that identify the role

    • Providers[].Roles[].Identifiers[].ID

      String

      Reliable

      Identifier for the role

    • Providers[].Roles[].Identifiers[].IDType

      String

      Reliable

      Type of ID for the role

    • Providers[].Roles[].Organization

      Object

      Reliable

      Organization where the role is available

    • Providers[].Roles[].Organization.Identifiers[]

      Array of Objects

      Reliable

      List of IDs and ID types that identify the organization

    • Providers[].Roles[].Organization.Identifiers[].ID

      String

      Reliable

      ID for the organization

    • Providers[].Roles[].Organization.Identifiers[].IDType

      String

      Reliable

      Type of ID for the organization

    • Providers[].Roles[].Organization.isActive

      String

      Reliable

      Whether this role is in active use

    • Providers[].Roles[].Organization.Type

      String

      Reliable

      Kind of organization

    • Providers[].Roles[].Organization.Name

      String

      Reliable

      Name of the organization

    • Providers[].Roles[].Organization.Address.StreetAddress

      String

      Reliable

      Street address

    • Providers[].Roles[].Organization.Address.City

      String

      Reliable

      City

    • Providers[].Roles[].Organization.Address.State

      String

      Reliable

      State

    • Providers[].Roles[].Organization.Address.ZIP

      String

      Reliable

      Zip code

    • Providers[].Roles[].Organization.Address.County

      String

      Reliable

      County

    • Providers[].Roles[].Organization.Address.Country

      String

      Reliable

      Country

    • Providers[].Roles[].Specialties[]

      Array of Objects

      Probable

      Coded representation of the specialty

    • Providers[].Roles[].Specialties[].Code

      String

      Probable

      Code

    • Providers[].Roles[].Specialties[].Codeset

      String

      Probable

      Code set

    • Providers[].Roles[].Specialties[].Description

      String

      Probable

      Description

    • Providers[].Roles[].Locations[]

      Array of Objects

      Reliable

      The location(s) at which the provider provides care

    • Providers[].Roles[].Locations[].Identifiers[]

      Array of Objects

      Reliable

      List of IDs and ID types that identify the location

    • Providers[].Roles[].Locations[].Identifiers[].ID

      String

      Reliable

      ID for the location

    • Providers[].Roles[].Locations[].Identifiers[].IDType

      String

      Reliable

      Type of ID for the location

    • Providers[].Roles[].Locations[].Status

      String

      Reliable

      Status of the location. One of Active, Suspended, Inactive

    • Providers[].Roles[].Locations[].Name

      String

      Reliable

      Name of the location

    • Providers[].Roles[].Locations[].Description

      String

      Reliable

      Additional details about the location

    • Providers[].Roles[].Locations[].Address.StreetAddress

      String

      Reliable

      Street address

    • Providers[].Roles[].Locations[].Address.City

      String

      Reliable

      City

    • Providers[].Roles[].Locations[].Address.State

      String

      Reliable

      State

    • Providers[].Roles[].Locations[].Address.ZIP

      String

      Reliable

      Zip code

    • Providers[].Roles[].Locations[].Address.County

      String

      Reliable

      County

    • Providers[].Roles[].Locations[].Address.Country

      String

      Reliable

      Country

    • Providers[].Roles[].Locations[].EmailAddresses[]

      Array of Strings

      Reliable

      List of email addresses for the location

    • Providers[].Roles[].Locations[].PhoneNumber.Office

      String

      Reliable

      Office phone number for the location. In E. 164 Format. (e.g. +16085551234)

    • Providers[].Roles[].Services[]

      Array of Objects

      Reliable

      The list of healthcare services that this worker provides for this role's Organization/Location(s)

    • Providers[].Roles[].Services[].Identifiers[]

      String

      Reliable

      List of IDs and ID types that identify the service

    • Providers[].Roles[].Services[].Identifiers[].ID

      String

      Reliable

      ID for the service

    • Providers[].Roles[].Services[].Identifiers[].IDType

      String

      Reliable

      Type of ID for the service

    • Providers[].Roles[].Services[].Type

      String

      Reliable

      Type of service that may be delivered or performed

    • Providers[].Roles[].Services[].Description

      String

      Reliable

      Description of the service

    • Providers[].Roles[].Services[].PhoneNumber.Office

      String

      Reliable

      Office phone number for information on the service. In E. 164 Format. (e.g. +16085551234)

    • Providers[].Roles[].Availability[]

      Array of Objects

      Possible

      Times the service location is available

    • Providers[].Roles[].Availability[].Days[]

      Array of Strings

      Reliable

      List of days that this availability schedule applies to. One of the following: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday

    • Providers[].Roles[].Availability[].AvailableStartTime

      Time

      Reliable

      Opening time of day. ISO 8601 Format

    • Providers[].Roles[].Availability[].AvailableEndTime

      Time

      Reliable

      Closing time of day. ISO 8601 Format

{
   "Meta": {
      "DataModel": "Provider",
      "EventType": "Update",
      "EventDateTime": "2018-02-19T17:19:16.947Z",
      "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
   },
   "Providers": [
      {
         "Identifiers": [
            {
               "ID": "4356789876",
               "IDType": "NPI"
            }
         ],
         "IsActive": true,
         "Demographics": {
            "FirstName": "Pat",
            "LastName": "Granite",
            "MiddleName": "Marie",
            "Credentials": [
               "MD"
            ],
            "Addresses": [
               {
                  "Use": "Office",
                  "StreetAddress": "123 Main St.",
                  "City": "Madison",
                  "State": "WI",
                  "ZIP": "53703",
                  "County": "Dane",
                  "Country": "USA"
               }
            ],
            "EmailAddresses": [
               "pat.granite@redoxengine.com"
            ],
            "PhoneNumber": {
               "Home": "+16085551235",
               "Office": "+16085551234",
               "Mobile": "+16085551236"
            },
            "Sex": "Female",
            "DOB": "1963-01-06",
            "Languages": [
               "English",
               "Spanish"
            ]
         },
         "Qualifications": [
            {
               "Identifiers": [
                  {
                     "ID": "5421",
                     "IDType": null
                  }
               ],
               "Code": "MD",
               "Codeset": "http://hl7.org/fhir/v2/0360/2.7",
               "Description": "Doctor of Medicine",
               "StartDate": "2000-02-01",
               "EndDate": null
            }
         ],
         "Roles": [
            {
               "Identifiers": [
                  {
                     "ID": "12",
                     "IDType": null
                  }
               ],
               "Organization": {
                  "Identifiers": [
                     {
                        "ID": "135",
                        "IDType": null
                     }
                  ],
                  "isActive": null,
                  "Type": "Provider",
                  "Name": "Redox Clinic",
                  "Address": {
                     "StreetAddress": "123 Main St.",
                     "City": "Madison",
                     "State": "WI",
                     "ZIP": "53703",
                     "County": "Dane",
                     "Country": "USA"
                  }
               },
               "Specialties": [
                  {
                     "Code": "394802001",
                     "Codeset": "SnomedCT",
                     "Description": "General Medicine"
                  }
               ],
               "Locations": [
                  {
                     "Identifiers": [
                        {
                           "ID": "123354",
                           "IDType": null
                        }
                     ],
                     "Status": "active",
                     "Name": "Redox Clinic",
                     "Description": null,
                     "Address": {
                        "StreetAddress": "123 Main St",
                        "City": "Madison",
                        "State": "WI",
                        "ZIP": "53703",
                        "County": "Dane",
                        "Country": "USA"
                     },
                     "EmailAddresses": [],
                     "PhoneNumber": {
                        "Office": "+16084455673"
                     }
                  }
               ],
               "Services": [
                  {
                     "Identifiers": [
                        {
                           "ID": "60",
                           "IDType": null
                        }
                     ],
                     "Type": "Nutrition",
                     "Description": "Nutrition",
                     "PhoneNumber": {
                        "Office": "+16083334985"
                     }
                  }
               ],
               "Availability": [
                  {
                     "Days": [
                        "Monday",
                        "Tuesday"
                     ],
                     "AvailableStartTime": "09:00",
                     "AvailableEndTime": "17:00"
                  }
               ]
            }
         ]
      }
   ]
}

ActivateBETAlink

An Activate message is used to convey that a provider's status has changed from Inactive to Active.

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.

  • Providers
    • Providers[]

      Array of Objects

      Reliable

      The list of providers

    • Providers[].Identifiers[]

      Array of Objects

      Reliable

      List of IDs and ID types that identify the provider

    • Providers[].Identifiers[].ID

      String

      Reliable
      Required

      ID for the provider

    • Providers[].Identifiers[].IDType

      String

      Reliable

      Type of ID for the provider

    • Providers[].Demographics.FirstName

      String

      Reliable

      Provider's first name

    • Providers[].Demographics.LastName

      String

      Reliable

      Provider's last name

    • Providers[].Demographics.MiddleName

      String

      Possible

      Provider's middle name

    • Providers[].Demographics.Credentials[]

      Array of Strings

      Possible

      List of credentials for the provider. e.g. MD, PhD

    • Providers[].Demographics.Addresses[]

      Array of Objects

      Probable

      Provider's addresses

    • Providers[].Demographics.Addresses[].Use

      String

      Reliable

      The use for this address. e.g. Home, Office

    • Providers[].Demographics.Addresses[].StreetAddress

      String

      Reliable

      Street address

    • Providers[].Demographics.Addresses[].City

      String

      Reliable

      City

    • Providers[].Demographics.Addresses[].State

      String

      Reliable

      State

    • Providers[].Demographics.Addresses[].ZIP

      String

      Reliable

      Zip code

    • Providers[].Demographics.Addresses[].County

      String

      Reliable

      County

    • Providers[].Demographics.Addresses[].Country

      String

      Reliable

      Country

    • Providers[].Demographics.EmailAddresses[]

      Array of Strings

      Probable

      Email addresses for the provider

    • Providers[].Demographics.PhoneNumber.Home

      String

      Probable

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

    • Providers[].Demographics.PhoneNumber.Office

      String

      Reliable

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

    • Providers[].Demographics.PhoneNumber.Mobile

      String

      Probable

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

    • Providers[].Demographics.Sex

      String

      Reliable

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

    • Providers[].Demographics.DOB

      String

      Reliable

      Provider's date of birth. In ISO 8601 format

    • Providers[].Demographics.Languages[]

      Array of Strings

      Reliable

      Languages the provider is able to use in patient communication

    • Providers[].Qualifications[]

      Array of Objects

      Possible

      Provider's qualifications obtained by training and certification

    • Providers[].Qualifications[].Identifiers[]

      Array of Objects

      Reliable

      List of IDs and ID Types that identify the qualification

    • Providers[].Qualifications[].Identifiers[].ID

      String

      Reliable

      Identifier for the qualification

    • Providers[].Qualifications[].Identifiers[].IDType

      String

      Reliable

      Type of ID for the qualification

    • Providers[].Qualifications[]

      Array of Objects

      Probable

      Coded representation of the qualification

    • Providers[].Qualifications[].Code

      String

      Probable

      Code

    • Providers[].Qualifications[].Codeset

      String

      Probable

      Code set

    • Providers[].Qualifications[].Description

      String

      Probable

      Description

    • Providers[].Qualifications[].StartDate

      String

      Reliable

      Start date of the qualification. In ISO 8601 format

    • Providers[].Qualifications[].EndDate

      String

      Reliable

      End date of the qualification. In ISO 8601 format

    • Providers[].Roles[]

      Array of Objects

      Probable

      Roles that the provider is associated with

    • Providers[].Roles[].Identifiers[]

      Array of Objects

      Reliable

      List of IDs and ID Types that identify the role

    • Providers[].Roles[].Identifiers[].ID

      String

      Reliable

      Identifier for the role

    • Providers[].Roles[].Identifiers[].IDType

      String

      Reliable

      Type of ID for the role

    • Providers[].Roles[].Organization

      Object

      Reliable

      Organization where the role is available

    • Providers[].Roles[].Organization.Identifiers[]

      Array of Objects

      Reliable

      List of IDs and ID types that identify the organization

    • Providers[].Roles[].Organization.Identifiers[].ID

      String

      Reliable

      ID for the organization

    • Providers[].Roles[].Organization.Identifiers[].IDType

      String

      Reliable

      Type of ID for the organization

    • Providers[].Roles[].Organization.isActive

      String

      Reliable

      Whether this role is in active use

    • Providers[].Roles[].Organization.Type

      String

      Reliable

      Kind of organization

    • Providers[].Roles[].Organization.Name

      String

      Reliable

      Name of the organization

    • Providers[].Roles[].Organization.Address.StreetAddress

      String

      Reliable

      Street address

    • Providers[].Roles[].Organization.Address.City

      String

      Reliable

      City

    • Providers[].Roles[].Organization.Address.State

      String

      Reliable

      State

    • Providers[].Roles[].Organization.Address.ZIP

      String

      Reliable

      Zip code

    • Providers[].Roles[].Organization.Address.County

      String

      Reliable

      County

    • Providers[].Roles[].Organization.Address.Country

      String

      Reliable

      Country

    • Providers[].Roles[].Specialties[]

      Array of Objects

      Probable

      Coded representation of the specialty

    • Providers[].Roles[].Specialties[].Code

      String

      Probable

      Code

    • Providers[].Roles[].Specialties[].Codeset

      String

      Probable

      Code set

    • Providers[].Roles[].Specialties[].Description

      String

      Probable

      Description

    • Providers[].Roles[].Locations[]

      Array of Objects

      Reliable

      The location(s) at which the provider provides care

    • Providers[].Roles[].Locations[].Identifiers[]

      Array of Objects

      Reliable

      List of IDs and ID types that identify the location

    • Providers[].Roles[].Locations[].Identifiers[].ID

      String

      Reliable

      ID for the location

    • Providers[].Roles[].Locations[].Identifiers[].IDType

      String

      Reliable

      Type of ID for the location

    • Providers[].Roles[].Locations[].Status

      String

      Reliable

      Status of the location. One of Active, Suspended, Inactive

    • Providers[].Roles[].Locations[].Name

      String

      Reliable

      Name of the location

    • Providers[].Roles[].Locations[].Description

      String

      Reliable

      Additional details about the location

    • Providers[].Roles[].Locations[].Address.StreetAddress

      String

      Reliable

      Street address

    • Providers[].Roles[].Locations[].Address.City

      String

      Reliable

      City

    • Providers[].Roles[].Locations[].Address.State

      String

      Reliable

      State

    • Providers[].Roles[].Locations[].Address.ZIP

      String

      Reliable

      Zip code

    • Providers[].Roles[].Locations[].Address.County

      String

      Reliable

      County

    • Providers[].Roles[].Locations[].Address.Country

      String

      Reliable

      Country

    • Providers[].Roles[].Locations[].EmailAddresses[]

      Array of Strings

      Reliable

      List of email addresses for the location

    • Providers[].Roles[].Locations[].PhoneNumber.Office

      String

      Reliable

      Office phone number for the location. In E. 164 Format. (e.g. +16085551234)

    • Providers[].Roles[].Services[]

      Array of Objects

      Reliable

      The list of healthcare services that this worker provides for this role's Organization/Location(s)

    • Providers[].Roles[].Services[].Identifiers[]

      String

      Reliable

      List of IDs and ID types that identify the service

    • Providers[].Roles[].Services[].Identifiers[].ID

      String

      Reliable

      ID for the service

    • Providers[].Roles[].Services[].Identifiers[].IDType

      String

      Reliable

      Type of ID for the service

    • Providers[].Roles[].Services[].Type

      String

      Reliable

      Type of service that may be delivered or performed

    • Providers[].Roles[].Services[].Description

      String

      Reliable

      Description of the service

    • Providers[].Roles[].Services[].PhoneNumber.Office

      String

      Reliable

      Office phone number for information on the service. In E. 164 Format. (e.g. +16085551234)

    • Providers[].Roles[].Availability[]

      Array of Objects

      Possible

      Times the service location is available

    • Providers[].Roles[].Availability[].Days[]

      Array of Strings

      Reliable

      List of days that this availability schedule applies to. One of the following: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday

    • Providers[].Roles[].Availability[].AvailableStartTime

      Time

      Reliable

      Opening time of day. ISO 8601 Format

    • Providers[].Roles[].Availability[].AvailableEndTime

      Time

      Reliable

      Closing time of day. ISO 8601 Format

{
   "Meta": {
      "DataModel": "Provider",
      "EventType": "Activate",
      "EventDateTime": "2018-02-19T17:19:16.947Z",
      "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
   },
   "Providers": [
      {
         "Identifiers": [
            {
               "ID": "4356789876",
               "IDType": "NPI"
            }
         ],
         "Demographics": {
            "FirstName": "Pat",
            "LastName": "Granite",
            "MiddleName": "Marie",
            "Credentials": [
               "MD"
            ],
            "Addresses": [
               {
                  "Use": "Office",
                  "StreetAddress": "123 Main St.",
                  "City": "Madison",
                  "State": "WI",
                  "ZIP": "53703",
                  "County": "Dane",
                  "Country": "USA"
               }
            ],
            "EmailAddresses": [
               "pat.granite@redoxengine.com"
            ],
            "PhoneNumber": {
               "Home": "+16085551235",
               "Office": "+16085551234",
               "Mobile": "+16085551236"
            },
            "Sex": "Female",
            "DOB": "1963-01-06",
            "Languages": [
               "English",
               "Spanish"
            ]
         },
         "Qualifications": [
            {
               "Identifiers": [
                  {
                     "ID": "5421",
                     "IDType": null
                  }
               ],
               "Code": "MD",
               "Codeset": "http://hl7.org/fhir/v2/0360/2.7",
               "Description": "Doctor of Medicine",
               "StartDate": "2000-02-01",
               "EndDate": null
            }
         ],
         "Roles": [
            {
               "Identifiers": [
                  {
                     "ID": "12",
                     "IDType": null
                  }
               ],
               "Organization": {
                  "Identifiers": [
                     {
                        "ID": "135",
                        "IDType": null
                     }
                  ],
                  "isActive": null,
                  "Type": "Provider",
                  "Name": "Redox Clinic",
                  "Address": {
                     "StreetAddress": "123 Main St.",
                     "City": "Madison",
                     "State": "WI",
                     "ZIP": "53703",
                     "County": "Dane",
                     "Country": "USA"
                  }
               },
               "Specialties": [
                  {
                     "Code": "394802001",
                     "Codeset": "SnomedCT",
                     "Description": "General Medicine"
                  }
               ],
               "Locations": [
                  {
                     "Identifiers": [
                        {
                           "ID": "123354",
                           "IDType": null
                        }
                     ],
                     "Status": "active",
                     "Name": "Redox Clinic",
                     "Description": null,
                     "Address": {
                        "StreetAddress": "123 Main St",
                        "City": "Madison",
                        "State": "WI",
                        "ZIP": "53703",
                        "County": "Dane",
                        "Country": "USA"
                     },
                     "EmailAddresses": [],
                     "PhoneNumber": {
                        "Office": "+16084455673"
                     }
                  }
               ],
               "Services": [
                  {
                     "Identifiers": [
                        {
                           "ID": "60",
                           "IDType": null
                        }
                     ],
                     "Type": "Nutrition",
                     "Description": "Nutrition",
                     "PhoneNumber": {
                        "Office": "+16083334985"
                     }
                  }
               ],
               "Availability": [
                  {
                     "Days": [
                        "Monday",
                        "Tuesday"
                     ],
                     "AvailableStartTime": "09:00",
                     "AvailableEndTime": "17:00"
                  }
               ]
            }
         ]
      }
   ]
}

DeactivateBETAlink

An Deactivate message is used to convey that a provider's status has changed from Active to Inactive.

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.

  • Providers
    • Providers[]

      Array of Objects

      Reliable

      The list of providers

    • Providers[].Identifiers[]

      Array of Objects

      Reliable

      List of IDs and ID types that identify the provider

    • Providers[].Identifiers[].ID

      String

      Reliable
      Required

      ID for the provider

    • Providers[].Identifiers[].IDType

      String

      Reliable

      Type of ID for the provider

    • Providers[].Demographics.FirstName

      String

      Reliable

      Provider's first name

    • Providers[].Demographics.LastName

      String

      Reliable

      Provider's last name

    • Providers[].Demographics.MiddleName

      String

      Possible

      Provider's middle name

    • Providers[].Demographics.Credentials[]

      Array of Strings

      Possible

      List of credentials for the provider. e.g. MD, PhD

    • Providers[].Demographics.Addresses[]

      Array of Objects

      Probable

      Provider's addresses

    • Providers[].Demographics.Addresses[].Use

      String

      Reliable

      The use for this address. e.g. Home, Office

    • Providers[].Demographics.Addresses[].StreetAddress

      String

      Reliable

      Street address

    • Providers[].Demographics.Addresses[].City

      String

      Reliable

      City

    • Providers[].Demographics.Addresses[].State

      String

      Reliable

      State

    • Providers[].Demographics.Addresses[].ZIP

      String

      Reliable

      Zip code

    • Providers[].Demographics.Addresses[].County

      String

      Reliable

      County

    • Providers[].Demographics.Addresses[].Country

      String

      Reliable

      Country

    • Providers[].Demographics.EmailAddresses[]

      Array of Strings

      Probable

      Email addresses for the provider

    • Providers[].Demographics.PhoneNumber.Home

      String

      Probable

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

    • Providers[].Demographics.PhoneNumber.Office

      String

      Reliable

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

    • Providers[].Demographics.PhoneNumber.Mobile

      String

      Probable

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

    • Providers[].Demographics.Sex

      String

      Reliable

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

    • Providers[].Demographics.DOB

      String

      Reliable

      Provider's date of birth. In ISO 8601 format

    • Providers[].Demographics.Languages[]

      Array of Strings

      Reliable

      Languages the provider is able to use in patient communication

    • Providers[].Qualifications[]

      Array of Objects

      Possible

      Provider's qualifications obtained by training and certification

    • Providers[].Qualifications[].Identifiers[]

      Array of Objects

      Reliable

      List of IDs and ID Types that identify the qualification

    • Providers[].Qualifications[].Identifiers[].ID

      String

      Reliable

      Identifier for the qualification

    • Providers[].Qualifications[].Identifiers[].IDType

      String

      Reliable

      Type of ID for the qualification

    • Providers[].Qualifications[]

      Array of Objects

      Probable

      Coded representation of the qualification

    • Providers[].Qualifications[].Code

      String

      Probable

      Code

    • Providers[].Qualifications[].Codeset

      String

      Probable

      Code set

    • Providers[].Qualifications[].Description

      String

      Probable

      Description

    • Providers[].Qualifications[].StartDate

      String

      Reliable

      Start date of the qualification. In ISO 8601 format

    • Providers[].Qualifications[].EndDate

      String

      Reliable

      End date of the qualification. In ISO 8601 format

    • Providers[].Roles[]

      Array of Objects

      Probable

      Roles that the provider is associated with

    • Providers[].Roles[].Identifiers[]

      Array of Objects

      Reliable

      List of IDs and ID Types that identify the role

    • Providers[].Roles[].Identifiers[].ID

      String

      Reliable

      Identifier for the role

    • Providers[].Roles[].Identifiers[].IDType

      String

      Reliable

      Type of ID for the role

    • Providers[].Roles[].Organization

      Object

      Reliable

      Organization where the role is available

    • Providers[].Roles[].Organization.Identifiers[]

      Array of Objects

      Reliable

      List of IDs and ID types that identify the organization

    • Providers[].Roles[].Organization.Identifiers[].ID

      String

      Reliable

      ID for the organization

    • Providers[].Roles[].Organization.Identifiers[].IDType

      String

      Reliable

      Type of ID for the organization

    • Providers[].Roles[].Organization.isActive

      String

      Reliable

      Whether this role is in active use

    • Providers[].Roles[].Organization.Type

      String

      Reliable

      Kind of organization

    • Providers[].Roles[].Organization.Name

      String

      Reliable

      Name of the organization

    • Providers[].Roles[].Organization.Address.StreetAddress

      String

      Reliable

      Street address

    • Providers[].Roles[].Organization.Address.City

      String

      Reliable

      City

    • Providers[].Roles[].Organization.Address.State

      String

      Reliable

      State

    • Providers[].Roles[].Organization.Address.ZIP

      String

      Reliable

      Zip code

    • Providers[].Roles[].Organization.Address.County

      String

      Reliable

      County

    • Providers[].Roles[].Organization.Address.Country

      String

      Reliable

      Country

    • Providers[].Roles[].Specialties[]

      Array of Objects

      Probable

      Coded representation of the specialty

    • Providers[].Roles[].Specialties[].Code

      String

      Probable

      Code

    • Providers[].Roles[].Specialties[].Codeset

      String

      Probable

      Code set

    • Providers[].Roles[].Specialties[].Description

      String

      Probable

      Description

    • Providers[].Roles[].Locations[]

      Array of Objects

      Reliable

      The location(s) at which the provider provides care

    • Providers[].Roles[].Locations[].Identifiers[]

      Array of Objects

      Reliable

      List of IDs and ID types that identify the location

    • Providers[].Roles[].Locations[].Identifiers[].ID

      String

      Reliable

      ID for the location

    • Providers[].Roles[].Locations[].Identifiers[].IDType

      String

      Reliable

      Type of ID for the location

    • Providers[].Roles[].Locations[].Status

      String

      Reliable

      Status of the location. One of Active, Suspended, Inactive

    • Providers[].Roles[].Locations[].Name

      String

      Reliable

      Name of the location

    • Providers[].Roles[].Locations[].Description

      String

      Reliable

      Additional details about the location

    • Providers[].Roles[].Locations[].Address.StreetAddress

      String

      Reliable

      Street address

    • Providers[].Roles[].Locations[].Address.City

      String

      Reliable

      City

    • Providers[].Roles[].Locations[].Address.State

      String

      Reliable

      State

    • Providers[].Roles[].Locations[].Address.ZIP

      String

      Reliable

      Zip code

    • Providers[].Roles[].Locations[].Address.County

      String

      Reliable

      County

    • Providers[].Roles[].Locations[].Address.Country

      String

      Reliable

      Country

    • Providers[].Roles[].Locations[].EmailAddresses[]

      Array of Strings

      Reliable

      List of email addresses for the location

    • Providers[].Roles[].Locations[].PhoneNumber.Office

      String

      Reliable

      Office phone number for the location. In E. 164 Format. (e.g. +16085551234)

    • Providers[].Roles[].Services[]

      Array of Objects

      Reliable

      The list of healthcare services that this worker provides for this role's Organization/Location(s)

    • Providers[].Roles[].Services[].Identifiers[]

      String

      Reliable

      List of IDs and ID types that identify the service

    • Providers[].Roles[].Services[].Identifiers[].ID

      String

      Reliable

      ID for the service

    • Providers[].Roles[].Services[].Identifiers[].IDType

      String

      Reliable

      Type of ID for the service

    • Providers[].Roles[].Services[].Type

      String

      Reliable

      Type of service that may be delivered or performed

    • Providers[].Roles[].Services[].Description

      String

      Reliable

      Description of the service

    • Providers[].Roles[].Services[].PhoneNumber.Office

      String

      Reliable

      Office phone number for information on the service. In E. 164 Format. (e.g. +16085551234)

    • Providers[].Roles[].Availability[]

      Array of Objects

      Possible

      Times the service location is available

    • Providers[].Roles[].Availability[].Days[]

      Array of Strings

      Reliable

      List of days that this availability schedule applies to. One of the following: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday

    • Providers[].Roles[].Availability[].AvailableStartTime

      Time

      Reliable

      Opening time of day. ISO 8601 Format

    • Providers[].Roles[].Availability[].AvailableEndTime

      Time

      Reliable

      Closing time of day. ISO 8601 Format

{
   "Meta": {
      "DataModel": "Provider",
      "EventType": "Deactivate",
      "EventDateTime": "2018-02-19T17:19:16.947Z",
      "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
   },
   "Providers": [
      {
         "Identifiers": [
            {
               "ID": "4356789876",
               "IDType": "NPI"
            }
         ],
         "Demographics": {
            "FirstName": "Pat",
            "LastName": "Granite",
            "MiddleName": "Marie",
            "Credentials": [
               "MD"
            ],
            "Addresses": [
               {
                  "Use": "Office",
                  "StreetAddress": "123 Main St.",
                  "City": "Madison",
                  "State": "WI",
                  "ZIP": "53703",
                  "County": "Dane",
                  "Country": "USA"
               }
            ],
            "EmailAddresses": [
               "pat.granite@redoxengine.com"
            ],
            "PhoneNumber": {
               "Home": "+16085551235",
               "Office": "+16085551234",
               "Mobile": "+16085551236"
            },
            "Sex": "Female",
            "DOB": "1963-01-06",
            "Languages": [
               "English",
               "Spanish"
            ]
         },
         "Qualifications": [
            {
               "Identifiers": [
                  {
                     "ID": "5421",
                     "IDType": null
                  }
               ],
               "Code": "MD",
               "Codeset": "http://hl7.org/fhir/v2/0360/2.7",
               "Description": "Doctor of Medicine",
               "StartDate": "2000-02-01",
               "EndDate": null
            }
         ],
         "Roles": [
            {
               "Identifiers": [
                  {
                     "ID": "12",
                     "IDType": null
                  }
               ],
               "Organization": {
                  "Identifiers": [
                     {
                        "ID": "135",
                        "IDType": null
                     }
                  ],
                  "isActive": null,
                  "Type": "Provider",
                  "Name": "Redox Clinic",
                  "Address": {
                     "StreetAddress": "123 Main St.",
                     "City": "Madison",
                     "State": "WI",
                     "ZIP": "53703",
                     "County": "Dane",
                     "Country": "USA"
                  }
               },
               "Specialties": [
                  {
                     "Code": "394802001",
                     "Codeset": "SnomedCT",
                     "Description": "General Medicine"
                  }
               ],
               "Locations": [
                  {
                     "Identifiers": [
                        {
                           "ID": "123354",
                           "IDType": null
                        }
                     ],
                     "Status": "active",
                     "Name": "Redox Clinic",
                     "Description": null,
                     "Address": {
                        "StreetAddress": "123 Main St",
                        "City": "Madison",
                        "State": "WI",
                        "ZIP": "53703",
                        "County": "Dane",
                        "Country": "USA"
                     },
                     "EmailAddresses": [],
                     "PhoneNumber": {
                        "Office": "+16084455673"
                     }
                  }
               ],
               "Services": [
                  {
                     "Identifiers": [
                        {
                           "ID": "60",
                           "IDType": null
                        }
                     ],
                     "Type": "Nutrition",
                     "Description": "Nutrition",
                     "PhoneNumber": {
                        "Office": "+16083334985"
                     }
                  }
               ],
               "Availability": [
                  {
                     "Days": [
                        "Monday",
                        "Tuesday"
                     ],
                     "AvailableStartTime": "09:00",
                     "AvailableEndTime": "17:00"
                  }
               ]
            }
         ]
      }
   ]
}