Skip to content

TransferRequest

metadataobject(RequestMetadata)required

additional information about the request and response data

patientobject(Patient)required

Patient details

prescriberobject(Prescriber)required

a licensed healthcare professional who authorized the prescription for the patient

prescriptionobject(Prescription)required
sendingPharmacyobject(Pharmacy)required

pharamcy details used for sending pharmacy (PHIL) or receiving pharmacy (partner pharmacies)

receivingPharmacyobject(Pharmacy)required

pharamcy details used for sending pharmacy (PHIL) or receiving pharmacy (partner pharmacies)

primaryInsuranceobject or null(Insurance)required
secondaryInsuranceobject or null(Insurance)required
{ "metadata": { "requestID": "string", "patientReferenceID": "string", "requestTimestamp": "2019-08-24T14:15:22Z", "retryCount": 0 }, "patient": { "name": { … }, "dateOfBirth": "1992-03-20", "gender": "M", "address": { … }, "email": "patient@example.com", "contactInfo": { … }, "allergyDetails": { … } }, "prescriber": { "dea": "string", "npi": "string", "name": { … }, "address": { … }, "faxNumber": "string", "email": "doctor@example.com", "contactInfo": { … } }, "prescription": { "rxNumber": "string", "prescribedNDC": "47335050696", "dispensedNDC": "string", "medicationName": "string", "drugForm": "string", "drugStrength": "0.03 MG", "daysSupply": 30, "dawCode": 0, "sig": "string", "faxImageURL": "string", "quantityWritten": 8.4, "quantityDispensed": 0, "refillsAuthorized": 0, "refillsRemaining": 0, "writtenDate": "2024-09-11T12:00:00.000Z", "firstFilledDate": "2019-08-24T14:15:22Z", "lastFilledDate": "2019-08-24T14:15:22Z", "expirationDate": "2025-09-15T12:00:00.000Z", "canSubstitute": true, "icdCode": "string" }, "sendingPharmacy": { "dea": "string", "npi": "string", "name": "string", "pharmacist": { … }, "address": { … }, "email": "pharmacy@example.com", "contactInfo": { … } }, "receivingPharmacy": { "dea": "string", "npi": "string", "name": "string", "pharmacist": { … }, "address": { … }, "email": "pharmacy@example.com", "contactInfo": { … } }, "primaryInsurance": { "planName": "string", "cardHolderID": "string", "cardHolderName": { … }, "groupNumber": "string", "bin": "string", "pcn": "string", "personCode": "string" }, "secondaryInsurance": { "planName": "string", "cardHolderID": "string", "cardHolderName": { … }, "groupNumber": "string", "bin": "string", "pcn": "string", "personCode": "string" } }