GET api/v1/{EMRSystem}/Providers

Returns all of the Providers in the EMR that match the given search criteria. FHIR connectors use the following resources for R4: Practitioner.Search.

Status: Beta

URI Parameters

Name	Description	Type	Additional information
EMRSystem	The emr system.	EMRSystem	None.
UserId	The identifier of the user	string	Required
NPI	The NPI (National Provider Id) of the provider	string	None.
FirstName	Firstname of the provider	string	None.
LastName	Lastname of the provider	string	None.
GenderId	Identifier of the gender of the provider	string	None.
SpecialtyId	Identifier of the specialty of the provider	string	None.
LanguageId	Identifier of the language of the provider	string	None.
LocationId	Identifier of the location of the provider	string	None.

Header Parameters

Name	Description	Type	Additional information
LoginId	Gets or sets the login identifier. This Login Id will be encrypted and passed in Sansoro specific Http Request Headers.	string	Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox
Password	Gets or sets the password. This Password will be encrypted and passed in Sansoro specific Http Request Headers.	string	Data type: Password Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox
EmrInstance	Gets or sets the emr instance. This emr instance info will be encrypted and passed in Sansoro specific Http Request Headers.	string	None.
ApplicationName	Gets or sets the requesting application name. This requesting application name will be encrypted and passed in Sansoro specific Http Request Headers.	string	Required if using application keys
ApplicationKey	Gets or sets the requesting application key. This requesting application key will be encrypted and passed in Sansoro specific Http Request Headers.	string	Data type: Password Required if using application keys
AuthorizationToken	Gets or sets the custom authorization token. This requesting authorization token will be encrypted and passed in Sansoro specific Http Request Headers.	string	None.
RequestVerboseLogging	Enables verbose logging for a single request. When "true", verbose logging will occur. When "false", the configuration setting will be respected. This value will be passed in Sansoro specific Http Request Headers.	boolean	None.

Response Information

Collection of UdmProviderResponse

Name	Description	Type	Additional information
TaxId	Gets or sets the TaxId	string	None.
DEANumber	The provider's DEA number	string	None.
UserName	The provider's UserName	string	None.
Addresses	Gets or sets the Addresses	Collection of Address	None.
Phones	Gets or sets the Phones	Collection of Phone	None.
Specialties	Gets or sets the Specialties	Collection of CodedObject	None.
Identities	Gets or sets the Identities	Collection of Identity	None.
NPI	Gets or sets the national provider identifier.	string	None.
ProviderId	Gets or sets the provider identifier.	string	None.
ProviderName	Gets or sets the name of the provider.	string	None.

Response Codes

Http Status Code 200 - Indicates that the request was processed successfully.

Http Status Code 400 - Indicates that the request did not contain all the required fields or had an invalid value.

Http Status Code 401 - Indicates that authentication to the underlying EMR server using the provided LoginId and Password failed.

Http Status Code 403 - Indicates that there is an issue with the request UserId.

Http Status Code 408 - Indicates that the request to the underlying EMR server timed out.

Http Status Code 500 - Indicates that an internal server error occurred during processing of the request.

Http Status Code 502 - Indicates that a request made to the underlying EMR server could not be completed.

Response Formats

application/json

[
  {
    "TaxId": "sample string 1",
    "DEANumber": "sample string 2",
    "UserName": "sample string 3",
    "Addresses": [
      {
        "AddressId": "sample string 1",
        "Address1": "sample string 2",
        "Address2": "sample string 3",
        "Address3": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "ZIP": "sample string 7",
        "Type": "sample string 8",
        "TypeId": "sample string 9",
        "SequenceNumber": "sample string 10",
        "Country": "sample string 11",
        "County": "sample string 12",
        "EndEffectiveDateTime": "2025-12-12T21:06:41.4283619+00:00"
      },
      {
        "AddressId": "sample string 1",
        "Address1": "sample string 2",
        "Address2": "sample string 3",
        "Address3": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "ZIP": "sample string 7",
        "Type": "sample string 8",
        "TypeId": "sample string 9",
        "SequenceNumber": "sample string 10",
        "Country": "sample string 11",
        "County": "sample string 12",
        "EndEffectiveDateTime": "2025-12-12T21:06:41.4283619+00:00"
      }
    ],
    "Phones": [
      {
        "PhoneId": "sample string 1",
        "Number": "sample string 2",
        "SequenceNumber": "sample string 3",
        "Type": "sample string 4",
        "TypeId": "sample string 5",
        "Extension": "sample string 6",
        "EndEffectiveDateTime": "2025-12-12T21:06:41.4285169+00:00",
        "Format": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      },
      {
        "PhoneId": "sample string 1",
        "Number": "sample string 2",
        "SequenceNumber": "sample string 3",
        "Type": "sample string 4",
        "TypeId": "sample string 5",
        "Extension": "sample string 6",
        "EndEffectiveDateTime": "2025-12-12T21:06:41.4285169+00:00",
        "Format": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      }
    ],
    "Specialties": [
      {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    ],
    "Identities": [
      {
        "Code": "sample string 1",
        "Description": "sample string 2",
        "Value": "sample string 3"
      },
      {
        "Code": "sample string 1",
        "Description": "sample string 2",
        "Value": "sample string 3"
      }
    ],
    "NPI": "sample string 4",
    "ProviderId": "sample string 5",
    "ProviderName": "sample string 6"
  },
  {
    "TaxId": "sample string 1",
    "DEANumber": "sample string 2",
    "UserName": "sample string 3",
    "Addresses": [
      {
        "AddressId": "sample string 1",
        "Address1": "sample string 2",
        "Address2": "sample string 3",
        "Address3": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "ZIP": "sample string 7",
        "Type": "sample string 8",
        "TypeId": "sample string 9",
        "SequenceNumber": "sample string 10",
        "Country": "sample string 11",
        "County": "sample string 12",
        "EndEffectiveDateTime": "2025-12-12T21:06:41.4283619+00:00"
      },
      {
        "AddressId": "sample string 1",
        "Address1": "sample string 2",
        "Address2": "sample string 3",
        "Address3": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "ZIP": "sample string 7",
        "Type": "sample string 8",
        "TypeId": "sample string 9",
        "SequenceNumber": "sample string 10",
        "Country": "sample string 11",
        "County": "sample string 12",
        "EndEffectiveDateTime": "2025-12-12T21:06:41.4283619+00:00"
      }
    ],
    "Phones": [
      {
        "PhoneId": "sample string 1",
        "Number": "sample string 2",
        "SequenceNumber": "sample string 3",
        "Type": "sample string 4",
        "TypeId": "sample string 5",
        "Extension": "sample string 6",
        "EndEffectiveDateTime": "2025-12-12T21:06:41.4285169+00:00",
        "Format": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      },
      {
        "PhoneId": "sample string 1",
        "Number": "sample string 2",
        "SequenceNumber": "sample string 3",
        "Type": "sample string 4",
        "TypeId": "sample string 5",
        "Extension": "sample string 6",
        "EndEffectiveDateTime": "2025-12-12T21:06:41.4285169+00:00",
        "Format": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      }
    ],
    "Specialties": [
      {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    ],
    "Identities": [
      {
        "Code": "sample string 1",
        "Description": "sample string 2",
        "Value": "sample string 3"
      },
      {
        "Code": "sample string 1",
        "Description": "sample string 2",
        "Value": "sample string 3"
      }
    ],
    "NPI": "sample string 4",
    "ProviderId": "sample string 5",
    "ProviderName": "sample string 6"
  }
]

GET api/v1/{EMRSystem}/Providers

Returns all of the Providers in the EMR that match the given search criteria. FHIR connectors use the following resources for R4: Practitioner.Search.

Status: Beta

URI Parameters

EMRSystem

Required

UserId

Required

NPI

FirstName

LastName

GenderId

SpecialtyId

LanguageId

LocationId

Header Parameters

LoginId

Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox

Password

Data type: Password , Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox

EmrInstance

ApplicationName

Required if using application keys

ApplicationKey

Data type: Password , Required if using application keys

AuthorizationToken

RequestVerboseLogging

Request: {{ method }} {{ url }}

Http Request Headers
{{header.name}} : {{header.value}} ******

Http Request Body
```
{{httpRequestBody}}
```

Http Status Code: {{httpResponseStatus}}

Http Response Headers
{{header.name}} : {{header.value}} ******

Http Response Data
```
{{httpResponseData}}
```