ProviderQueryResponse
Description
A Provider QueryResponse message is used in response to a Provider Query.
API endpoints for Provider Query Response
Sync REST API Endpoint to call the API: https://{base_url}/api/v1/provider/provider-query-response.
Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.
Intraconnect Unified Model
| Event Type | IntraConnects Response | Data Type | Athena Response |
|---|---|---|---|
| ProviderQueryResponse | Meta.DataModel | String | Provider |
| ProviderQueryResponse | Meta.EventType | String | ProviderQueryResponse |
| ProviderQueryResponse | Meta.Raw | Array | |
| ProviderQueryResponse | Meta.Source | String | |
| ProviderQueryResponse | Meta.Source.ID | String | |
| ProviderQueryResponse | Meta.Source.Name | String | |
| ProviderQueryResponse | Providers[] | Array of Objects | |
| ProviderQueryResponse | Providers[].Identifiers[] | Array of Objects | |
| ProviderQueryResponse | Providers[].Identifiers[].ID | String | providerid |
| ProviderQueryResponse | Providers[].Identifiers[].IDType | String | EHRID |
| ProviderQueryResponse | Providers[].Identifiers[].ID | String | |
| ProviderQueryResponse | Providers[].Identifiers[].IDType | String | |
| ProviderQueryResponse | Providers[].IsActive | Boolean | |
| ProviderQueryResponse | Providers[].Demographics | Object | |
| ProviderQueryResponse | Providers[].Demographics.FirstName | String | firstname |
| ProviderQueryResponse | Providers[].Demographics.LastName | String | lastname |
| ProviderQueryResponse | Providers[].Demographics.MiddleName | String | |
| ProviderQueryResponse | Providers[].Demographics.Credentials[] | Array of Objects | |
| ProviderQueryResponse | Providers[].Demographics.Credentials[].ID | String | |
| ProviderQueryResponse | Providers[].Demographics.Credentials[].Name | String | providertype |
| ProviderQueryResponse | Providers[].Demographics.Addresses[] | Array of Objects | |
| ProviderQueryResponse | Providers[].Demographics.Addresses[].Use | String | |
| ProviderQueryResponse | Providers[].Demographics.Addresses[].StreetAddress | String | |
| ProviderQueryResponse | Providers[].Demographics.Addresses[].City | String | |
| ProviderQueryResponse | Providers[].Demographics.Addresses[].State | String | |
| ProviderQueryResponse | Providers[].Demographics.Addresses[].ZIP | String | |
| ProviderQueryResponse | Providers[].Demographics.Addresses[].County | String | |
| ProviderQueryResponse | Providers[].Demographics.Addresses[].Country | String | |
| ProviderQueryResponse | Providers[].Demographics.EmailAddresses[] | Array of Strings | |
| ProviderQueryResponse | Providers[].Demographics.PhoneNumber | Object | |
| ProviderQueryResponse | Providers[].Demographics.PhoneNumber.Home | String | |
| ProviderQueryResponse | Providers[].Demographics.PhoneNumber.Office | String | |
| ProviderQueryResponse | Providers[].Demographics.PhoneNumber.Mobile | String | |
| ProviderQueryResponse | Providers[].Demographics.Sex | String | sex |
| ProviderQueryResponse | Providers[].Demographics.DOB | String | |
| ProviderQueryResponse | Providers[].Demographics.Languages | Array of Strings | |
| ProviderQueryResponse | Providers[].Qualifications[] | Array of Objects | |
| ProviderQueryResponse | Providers[].Qualifications[].Identifiers[] | Array of objects | |
| ProviderQueryResponse | Providers[].Qualifications[].Identifiers[].ID | String | |
| ProviderQueryResponse | Providers[].Qualifications[].Identifiers[].IDType | String | |
| ProviderQueryResponse | Providers[].Qualifications[].Code | String | |
| ProviderQueryResponse | Providers[].Qualifications[].Codeset | String | |
| ProviderQueryResponse | Providers[].Qualifications[].Description | String | |
| ProviderQueryResponse | Providers[].Qualifications[].StartDate | String | |
| ProviderQueryResponse | Providers[].Qualifications[].EndDate | String | |
| ProviderQueryResponse | Providers[].Roles[] | Array of Objects | |
| ProviderQueryResponse | Providers[].Roles[].Identifiers[] | Array of Objects | |
| ProviderQueryResponse | Providers[].Roles[].Identifiers[].ID | String | specialtyid |
| ProviderQueryResponse | Providers[].Roles[].Identifiers[].IDType | String | SpecialtyID |
| ProviderQueryResponse | Providers[].Roles[].Organization | Object | |
| ProviderQueryResponse | Providers[].Roles[].Organization.Identifiers[] | Array of Objects | |
| ProviderQueryResponse | Providers[].Roles[].Organization.Identifiers[].ID | String | |
| ProviderQueryResponse | Providers[].Roles[].Organization.Identifiers[].IDType | String | |
| ProviderQueryResponse | Providers[].Roles[].Organization.IsActive | Boolean | |
| ProviderQueryResponse | Providers[].Roles[].Organization.Type | String | |
| ProviderQueryResponse | Providers[].Roles[].Organization.Name | String | |
| ProviderQueryResponse | Providers[].Roles[].Organization.Address | String | |
| ProviderQueryResponse | Providers[].Roles[].Organization.Address.StreetAddress | String | |
| ProviderQueryResponse | Providers[].Roles[].Organization.Address.City | String | |
| ProviderQueryResponse | Providers[].Roles[].Organization.Address.State | String | |
| ProviderQueryResponse | Providers[].Roles[].Organization.Address.ZIP | String | |
| ProviderQueryResponse | Providers[].Roles[].Organization.Address.County | String | |
| ProviderQueryResponse | Providers[].Roles[].Organization.Address.Country | String | |
| ProviderQueryResponse | Providers[].Roles[].Specialties[] | Array of Objects | |
| ProviderQueryResponse | Providers[].Roles[].Specialties[].Code | String | |
| ProviderQueryResponse | Providers[].Roles[].Specialties[].Codeset | String | |
| ProviderQueryResponse | Providers[].Roles[].Specialties[].Description | String | |
| ProviderQueryResponse | Providers[].Roles[].Locations[] | Array of Objects | |
| ProviderQueryResponse | Providers[].Roles[].Locations[].Identifiers[] | Array of Objects | |
| ProviderQueryResponse | Providers[].Roles[].Locations[].Identifiers[].ID | String | departmentid |
| ProviderQueryResponse | Providers[].Roles[].Locations[].Identifiers[].IDType | String | DepartmentID |
| ProviderQueryResponse | Providers[].Roles[].Locations[].Status | String | |
| ProviderQueryResponse | Providers[].Roles[].Locations[].Name | String | |
| ProviderQueryResponse | Providers[].Roles[].Locations[].Description | String | |
| ProviderQueryResponse | Providers[].Roles[].Locations[].Address | Object | |
| ProviderQueryResponse | Providers[].Roles[].Locations[].Address.StreetAddress | String | |
| ProviderQueryResponse | Providers[].Roles[].Locations[].Address.City | String | |
| ProviderQueryResponse | Providers[].Roles[].Locations[].Address.State | String | |
| ProviderQueryResponse | Providers[].Roles[].Locations[].Address.ZIP | String | |
| ProviderQueryResponse | Providers[].Roles[].Locations[].Address.County | String | |
| ProviderQueryResponse | Providers[].Roles[].Locations[].Address.Country | String | |
| ProviderQueryResponse | Providers[].Roles[].Locations[].EmailAddresses[] | Array of Strings | |
| ProviderQueryResponse | Providers[].Roles[].Locations[].PhoneNumber | Object | |
| ProviderQueryResponse | Providers[].Roles[].Locations[].PhoneNumber.Office | String | |
| ProviderQueryResponse | Providers[].Roles[].Services[] | Array of Objects | |
| ProviderQueryResponse | Providers[].Roles[].Services[].Identifiers[] | Array of Objects | |
| ProviderQueryResponse | Providers[].Roles[].Services[].Identifiers[].ID | String | |
| ProviderQueryResponse | Providers[].Roles[].Services[].Identifiers[].IDType | String | |
| ProviderQueryResponse | Providers[].Roles[].Services[].Type | String | |
| ProviderQueryResponse | Providers[].Roles[].Services[].Description | String | |
| ProviderQueryResponse | Providers[].Roles[].Services[].PhoneNumber | Object | |
| ProviderQueryResponse | Providers[].Roles[].Services[].PhoneNumber.Office | String | |
| ProviderQueryResponse | Providers[].Roles[].Availability[] | Array of Objects | |
| ProviderQueryResponse | Providers[].Roles[].Availability[].Days[] | Array of Strings | |
| ProviderQueryResponse | Providers[].Roles[].Availability[].AvailableStartTime | String | |
| ProviderQueryResponse | Providers[].Roles[].Availability[].AvailableEndTime | String | |
| ProviderQueryResponse | Providers[].Roles[].Name | String | specialty |
| ProviderQueryResponse | Providers[].Billable | Boolean | billable |