GET References Pharmacies

Developer Tools

GET api/v1/{EMRSystem}/References/Pharmacies

Returns the Pharmacies built in the EMR.

HTTP Method

GET

Applicable Emissary Products

Chart Retrieval
Clinical Analytics
Interactive Workflow

Allscripts

In Dev

Athena

In Dev

Cerner

Released

Meditech

In Dev

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

The identifier of the user requesting the list of pharmacies

string

None

TypeIds

Comma delimited list of pharmacy type identifiers to search for.

Collection of string

None

Name

Pharmacy name to search for

string

None

NCPDP

Pharmacy NCPDP (National Council for Prescription Drug Programs) number to search for

string

None

City

City in which to search for pharmacies

string

None

State

State in which to search for pharmacies

string

None

Zip

Zip code in which to search for pharmacies

string

None

 
Body Parameters
None
 

Response Information

 
Resource Description

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

Id

The pharmacy identifier

string

None

Name

The pharmacy name

string

None

NCPDP

The pharmacy NCPDP (National Council for Prescription Drug Programs) number

string

None

PharmacyTypes

List of pharmacy types for this pharmacy

Collection of CodedObjectViewModel

None

IsEPrescribing

Is the pharamcy capable of e-prescribing

boolean

None

Address

The phamacy's address

AddressViewModel

None

Phones

List of the pharmacy's phone numbers

Collection of PhoneViewModel

None

 
Response Codes

Http Status Code 200 – Returns Sansoro.Shared.SansoroServiceBus.Models.ReferenceDiscoveryResponseViewModel

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
[
  {
    "Id": "sample string 1",
    "Name": "sample string 2",
    "NCPDP": "sample string 3",
    "PharmacyTypes": [
      {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    ],
    "IsEPrescribing": true,
    "Address": {
      "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"
      }
    ]
  },
  {
    "Id": "sample string 1",
    "Name": "sample string 2",
    "NCPDP": "sample string 3",
    "PharmacyTypes": [
      {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    ],
    "IsEPrescribing": true,
    "Address": {
      "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"
      }
    ]
  }
]
Sample Message
<ArrayOfPharmacyDiscoveryResponseViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <PharmacyDiscoveryResponseViewModel>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:Address1>sample string 2</d3p1:Address1>
      <d3p1:Address2>sample string 3</d3p1:Address2>
      <d3p1:AddressId>sample string 1</d3p1:AddressId>
      <d3p1:City>sample string 4</d3p1:City>
      <d3p1:Country>sample string 8</d3p1:Country>
      <d3p1:State>sample string 5</d3p1:State>
      <d3p1:Type>sample string 7</d3p1:Type>
      <d3p1:ZIP>sample string 6</d3p1:ZIP>
    </Address>
    <Id>sample string 1</Id>
    <IsEPrescribing>true</IsEPrescribing>
    <NCPDP>sample string 3</NCPDP>
    <Name>sample string 2</Name>
    <PharmacyTypes xmlns:d3p1="http://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:CodedObjectViewModel>
        <d3p1:Id>sample string 1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:CodedObjectViewModel>
      <d3p1:CodedObjectViewModel>
        <d3p1:Id>sample string 1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:CodedObjectViewModel>
    </PharmacyTypes>
    <Phones xmlns:d3p1="http://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:PhoneViewModel>
        <d3p1:Number>sample string 2</d3p1:Number>
        <d3p1:PhoneId>sample string 1</d3p1:PhoneId>
        <d3p1:SequenceNumber>sample string 3</d3p1:SequenceNumber>
        <d3p1:Type>sample string 4</d3p1:Type>
      </d3p1:PhoneViewModel>
      <d3p1:PhoneViewModel>
        <d3p1:Number>sample string 2</d3p1:Number>
        <d3p1:PhoneId>sample string 1</d3p1:PhoneId>
        <d3p1:SequenceNumber>sample string 3</d3p1:SequenceNumber>
        <d3p1:Type>sample string 4</d3p1:Type>
      </d3p1:PhoneViewModel>
    </Phones>
  </PharmacyDiscoveryResponseViewModel>
  <PharmacyDiscoveryResponseViewModel>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:Address1>sample string 2</d3p1:Address1>
      <d3p1:Address2>sample string 3</d3p1:Address2>
      <d3p1:AddressId>sample string 1</d3p1:AddressId>
      <d3p1:City>sample string 4</d3p1:City>
      <d3p1:Country>sample string 8</d3p1:Country>
      <d3p1:State>sample string 5</d3p1:State>
      <d3p1:Type>sample string 7</d3p1:Type>
      <d3p1:ZIP>sample string 6</d3p1:ZIP>
    </Address>
    <Id>sample string 1</Id>
    <IsEPrescribing>true</IsEPrescribing>
    <NCPDP>sample string 3</NCPDP>
    <Name>sample string 2</Name>
    <PharmacyTypes xmlns:d3p1="http://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:CodedObjectViewModel>
        <d3p1:Id>sample string 1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:CodedObjectViewModel>
      <d3p1:CodedObjectViewModel>
        <d3p1:Id>sample string 1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:CodedObjectViewModel>
    </PharmacyTypes>
    <Phones xmlns:d3p1="http://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
      <d3p1:PhoneViewModel>
        <d3p1:Number>sample string 2</d3p1:Number>
        <d3p1:PhoneId>sample string 1</d3p1:PhoneId>
        <d3p1:SequenceNumber>sample string 3</d3p1:SequenceNumber>
        <d3p1:Type>sample string 4</d3p1:Type>
      </d3p1:PhoneViewModel>
      <d3p1:PhoneViewModel>
        <d3p1:Number>sample string 2</d3p1:Number>
        <d3p1:PhoneId>sample string 1</d3p1:PhoneId>
        <d3p1:SequenceNumber>sample string 3</d3p1:SequenceNumber>
        <d3p1:Type>sample string 4</d3p1:Type>
      </d3p1:PhoneViewModel>
    </Phones>
  </PharmacyDiscoveryResponseViewModel>
</ArrayOfPharmacyDiscoveryResponseViewModel>

Submit a Comment

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

 

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