GET /api/prescription_messages/:id — untitled-api

Clinical

Retrieve an existing prescription message

get/api/prescription_messages/{id}

Path parameters

idstring required

Query parameters

parent_messageinteger

sincestring

patientinteger

doctorinteger

Response

message_statusstring

Message status for Incoming and Outgoing values. Success message for message_type are: NewRx : Sent, RefillRequest : Received, RefillResponse : Sent.

patientinteger

An optional field which refers to a patient.

doctorinteger

message_typestring

Possible values are NewRx for outgoing new prescriptions, RefillRequest for incoming refill requests, RefillResponse for outgoing refill responses, Error for incoming errors, Status and Verify for incoming status reports from Surescripts.

created_atstring

parent_messagestring

Refers to the parent message, used for refill responses and incoming error/status reports.

message_direction'I' | 'O'

Possible values are Outgoing and Incoming.

pharmacystring

NCPDPID allocated #ID of the Pharmacy

json_datastring

Data sent along with NewRx, RefillRequest, and RefillResponses messages. The format varies, but most likely it will contain BenefitsCoordination section with insurance info and MedicationPrescribed with medication info. Patient, Pharmacy, and Prescriber are also usually present.

idinteger

Changes

No recorded changes to this endpoint across all 2 revisions of this API.