Preferred Pharmacy

The Preferred Pharmacy feature allows the user to view, update or delete the preferred Pharmacy associated with a patient.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

Endpoints

Get patient's preferred pharmacy

GET
/v1/{practiceid}/chart/{patientid}/pharmacies/preferred
Retrieve preferred pharmacy for a specific patient chart
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
patientid integer patientid
departmentid integer The athenaNet department id.
limit integer Number of entries to return (default 100, max 1000)Please note that this endpoint has a different default and max than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
acceptfax string Flag representing if the pharmacy accepts fax
address1 string Address line 1 of the pharmacy
address2 string Address line 2 of the pharmacy
city string City of the pharmacy
clinicalproviderid integer The athenaNet clinical provider ID.
clinicalprovidername string The pharmacy name
defaultpharmacy string If flagged true, this is the default pharmacy for the patient
faxnumber string Fax number of the pharmacy
pharmacytype string Type of pharmacy (retail, mailorder)
phonenumber string Phone number of the pharmacy
receivertype string Receiver type
state string State of the pharmacy
zip string Zip code of the pharmacy
Example Code

Update patient's preferred pharmacy

PUT
/v1/{practiceid}/chart/{patientid}/pharmacies/preferred
Modifies preferred pharmacy for a specific patient chart
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
patientid integer patientid
Content-Type string Content type of the payload

❙ Request Body

Expand all
clinicalproviderid integer The clinical provider ID that you wish to set as the default pharmacy or add as a preferred pharmacy. This or the NCPDPID must be provided.
departmentid integer The athenaNet department id.
ncpdpid integer The <a href="http://www.ncpdp.org">NCPDP</a> ID of the clinical provider. Can be used instead of clinicalproviderid. Only one can be used.

Output Parameters

Expand all
errormessage string If the operation failed, this will contain any error messages.
success string Whether the operation was successful.
Example Code

Delete patient's preferred pharmacy

DELETE
/v1/{practiceid}/chart/{patientid}/pharmacies/preferred
Deletes the preferred pharmacy for a specific patient chart
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
patientid integer patientid
clinicalproviderid integer The clinical provider ID that you wish to set as the default pharmacy or add as a preferred pharmacy. This or the NCPDPID must be provided.
departmentid integer The athenaNet department id.
ncpdpid integer The NCPDP ID of the clinical provider. Can be used instead of clinicalproviderid. Only one can be used.

Output Parameters

Expand all
errormessage string If the operation failed, this will contain any error messages.
success string Whether the operation was successful.
Example Code