GET Providers

GET api/v1/{EMRSystem}/Providers/{ProviderId}

Returns a provider.

HTTP Method

GET

Applicable Emissary Products

Chart Retrieval
Analytics
Interactive

Allscripts

In Dev

Athena

Released

Cerner

Released

Epic

Released

Meditech

Released

Sandbox

In Dev

Don't see the data field you are looking for?

Request Information

URI Parameters

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

EMRSystem

The emr system.

EMRsystem

Required

UserId

Gets or sets the user identifier.

string

Required

ProviderId

Gets or sets the provider identifier.

string

Required

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing Provider Response View Model.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

TaxId

Gets or sets the TaxId

string

None.

DEANumber

The provider's DEA number

string

None.

Addresses

Gets or sets the Addresses

Collection of AddressViewModel

None.

Phones

Gets or sets the Phones

Collection of PhoneViewModel

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 – Returns Sansoro.Shared.SansoroServiceBus.Models.ProviderResponseViewModel

Http Status Code 400 – Indicates that the request did not contain all the required fields.

Http Status Code 404 – Indicates that the resource to get could not be found.

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
Sample Message
Download Json Schema
{
  "TaxId": "sample string 1",
  "DEANumber": "sample string 2",
  "Addresses": [
    {
      "AddressId": "sample string 1",
      "Address1": "sample string 2",
      "Address2": "sample string 3",
      "City": "sample string 4",
      "State": "sample string 5",
      "ZIP": "sample string 6",
      "Type": "sample string 7",
      "Country": "sample string 8"
    },
    {
      "AddressId": "sample string 1",
      "Address1": "sample string 2",
      "Address2": "sample string 3",
      "City": "sample string 4",
      "State": "sample string 5",
      "ZIP": "sample string 6",
      "Type": "sample string 7",
      "Country": "sample string 8"
    }
  ],
  "Phones": [
    {
      "PhoneId": "sample string 1",
      "Number": "sample string 2",
      "SequenceNumber": "sample string 3",
      "Type": "sample string 4"
    },
    {
      "PhoneId": "sample string 1",
      "Number": "sample string 2",
      "SequenceNumber": "sample string 3",
      "Type": "sample string 4"
    }
  ],
  "NPI": "sample string 3",
  "ProviderId": "sample string 4",
  "ProviderName": "sample string 5"
}
Sample Message
<ProviderResponseViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <ProviderId xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 4</ProviderId>
  <ProviderName xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 5</ProviderName>
  <NPI xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">sample string 3</NPI>
  <Addresses xmlns:d2p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <d2p1:AddressViewModel>
      <d2p1:Address1>sample string 2</d2p1:Address1>
      <d2p1:Address2>sample string 3</d2p1:Address2>
      <d2p1:AddressId>sample string 1</d2p1:AddressId>
      <d2p1:City>sample string 4</d2p1:City>
      <d2p1:Country>sample string 8</d2p1:Country>
      <d2p1:State>sample string 5</d2p1:State>
      <d2p1:Type>sample string 7</d2p1:Type>
      <d2p1:ZIP>sample string 6</d2p1:ZIP>
    </d2p1:AddressViewModel>
    <d2p1:AddressViewModel>
      <d2p1:Address1>sample string 2</d2p1:Address1>
      <d2p1:Address2>sample string 3</d2p1:Address2>
      <d2p1:AddressId>sample string 1</d2p1:AddressId>
      <d2p1:City>sample string 4</d2p1:City>
      <d2p1:Country>sample string 8</d2p1:Country>
      <d2p1:State>sample string 5</d2p1:State>
      <d2p1:Type>sample string 7</d2p1:Type>
      <d2p1:ZIP>sample string 6</d2p1:ZIP>
    </d2p1:AddressViewModel>
  </Addresses>
  <DEANumber>sample string 2</DEANumber>
  <Phones xmlns:d2p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <d2p1:PhoneViewModel>
      <d2p1:Number>sample string 2</d2p1:Number>
      <d2p1:PhoneId>sample string 1</d2p1:PhoneId>
      <d2p1:SequenceNumber>sample string 3</d2p1:SequenceNumber>
      <d2p1:Type>sample string 4</d2p1:Type>
    </d2p1:PhoneViewModel>
    <d2p1:PhoneViewModel>
      <d2p1:Number>sample string 2</d2p1:Number>
      <d2p1:PhoneId>sample string 1</d2p1:PhoneId>
      <d2p1:SequenceNumber>sample string 3</d2p1:SequenceNumber>
      <d2p1:Type>sample string 4</d2p1:Type>
    </d2p1:PhoneViewModel>
  </Phones>
  <TaxId>sample string 1</TaxId>
</ProviderResponseViewModel>

Submit a Comment

Your email address will not be published. Required fields are marked *

 

Don't see the data field you are looking for?