Prescription Transfer

For detailed description of the data fields, see API Reference.

Request

Here's a sample request we would send to your API.

{
  "metadata": {
    "requestID": "6a742tg3aof9f94t35270",
    "retryCount": 0,
    "requestTimestamp": "2024-09-11T12:12:00Z",
    "patientReferenceID": "some-patient-id"
  },
  "patient": {
    "name": {
      "firstName": "John",
      "middleName": null,
      "lastName": "Doe",
      "prefix": null,
      "suffix": "Jr."
    },
    "dateOfBirth": "1992-03-20",
    "gender": "M",
    "address": {
      "addressLine1": "410 Terry Ave N",
      "addressLine2": null,
      "city": "Seattle",
      "state": "WA",
      "postalCode": "74729",
      "countryCode": "US"
    },
    "email": "patient@example.com",
    "contactInfo": {
      "countryCode": "+1",
      "phoneNumber": "3231234532"
    },
    "allergyDetails": {
      "allergiesDescriptor": "KNOWN_ALLERGIES_INCLUDED",
      "allergies": [
        "Peanuts",
        "soybeans",
        "crustacean shellfish"
      ]
    }
  },
  "prescriber": {
    "dea": "F91234563",
    "npi": "0987654321",
    "name": {
      "firstName": "Dorothy",
      "middleName": "Andrews",
      "lastName": "Stevens",
      "prefix": "Dr.",
      "suffix": null
    },
    "address": {
      "addressLine1": "5372 W Common St",
      "addressLine2": "Ste 210",
      "city": "Seattle",
      "state": "WA",
      "postalCode": "74729",
      "countryCode": "US"
    },
    "faxNumber": "7732229999",
    "email": "doctor@example.com",
    "contactInfo": {
      "countryCode": "+1",
      "phoneNumber": "3236461133"
    }
  },
  "prescription": {
    "rxNumber": "rx1234",
    "prescribedNDC": "82667090002",
    "dispensedNDC": null,
    "medicationName": "TYRVAYA® (VARENICLINE SOLUTION) NASAL SPRAY 0.03 MG",
    "drugForm": "Nasal spray",
    "drugStrength": "0.03 MG",
    "daysSupply": 30,
    "dawCode": 1,
    "icdCode": null,
    "sig": "TAKE 1 TABLET DAILY|TOME 1 TABLETA AL DIA",
    "faxImageURL": null,
    "quantityWritten": 8.4,
    "quantityDispensed": 8.4,
    "refillsAuthorized": 5,
    "refillsRemaining": 3,
    "canSubstitute": false,
    "firstFilledDate": null,
    "lastFilledDate": null,
    "writtenDate": "2024-09-11T12:00:00Z",
    "expirationDate": "2025-09-11T12:00:00Z"
  },
  "sendingPharmacy": {
    "dea": "1M34URHXA",
    "npi": "0987654321",
    "name": "PhilRx, LLC",
    "address": {
      "addressLine1": "1234 Common St",
      "addressLine2": null,
      "city": "Scottsdale",
      "state": "AZ",
      "postalCode": "12345",
      "countryCode": "US"
    },
    "pharmacist": {
      "firstName": "Kyle",
      "middleName": null,
      "lastName": "Abrams",
      "prefix": null,
      "suffix": null
    },
    "email": "phil-user@phil.us",
    "contactInfo": {
      "countryCode": "+1",
      "phoneNumber": "3433548364"
    }
  },
  "receivingPharmacy": {
    "npi": "1234567890",
    "name": "ABC Pharmacy",
    "dea": "CW1184915",
    "address": {
      "addressLine1": "123 Turn st",
      "addressLine2": null,
      "city": "Atlanta",
      "state": "GA",
      "postalCode": "12346",
      "countryCode": "US"
    },
    "pharmacist": {
      "firstName": "Georgina",
      "middleName": null,
      "lastName": "Kade",
      "prefix": null,
      "suffix": null
    },
    "email": "partner-user@partner.com",
    "contactInfo": {
      "countryCode": "+1",
      "phoneNumber": "4347231846"
    }
  },
  "primaryInsurance": {
    "planName": "0600CASHPAY",
    "cardHolderID": "44444444",
    "cardHolderName": {
      "firstName": "John",
      "middleName": null,
      "lastName": "Doe",
      "prefix": null,
      "suffix": "Jr."
    },
    "groupNumber": "GROUP1234332",
    "bin": "600428",
    "pcn": "06000001",
    "personCode": null
  },
  "secondaryInsurance": null
}

Response

Here are sample responses we expect to receive.

Received Request

{
  "requestID": "6a742tg3aof9f94t35270",
  "metadata": {
    "referenceID": "a83sad719545352gsv721",
    "responseType": "RECEIVED",
    "responseID": "ga1t6291sg6310374gs73",
    "responseTimestamp": "2024-09-11T12:26:00Z"
  }
}

Transfer Confirmed

{
  "requestID": "6a742tg3aof9f94t35270",
  "metadata": {
    "referenceID": "a83sad719545352gsv721",
    "responseType": "CONFIRMED",
    "responseID": "32803hfas13dth82a4712",
    "responseTimestamp": "2024-09-11T13:55:00Z"
  },
  "prescription": {
    "rxNumber": "rx1234",
    "prescribedNDC": "82667090002",
    "dispensedNDC": null,
    "medicationName": "TYRVAYA® (VARENICLINE SOLUTION) NASAL SPRAY 0.03 MG",
    "drugForm": "Nasal spray",
    "drugStrength": "0.03 MG",
    "daysSupply": 30,
    "dawCode": 1,
    "icdCode": null,
    "sig": "TAKE 1 TABLET DAILY|TOME 1 TABLETA AL DIA",
    "faxImageURL": null,
    "quantityWritten": 8.4,
    "quantityDispensed": 8.4,
    "refillsAuthorized": 5,
    "refillsRemaining": 3,
    "canSubstitute": false,
    "firstFilledDate": null,
    "lastFilledDate": null,
    "writtenDate": "2024-09-11T12:00:00Z",
    "expirationDate": "2025-09-11T12:00:00Z"
  }
}

Transfer Error

See Error Handling section for a list of possible error types.

{
  "requestID": "6a742tg3aof9f94t35270",
  "metadata": {
    "referenceID": "a83sad719545352gsv721",
    "responseType": "ERROR",
    "responseID": "ga1t6291sg6310374gs73",
    "responseTimestamp": "2024-09-11T12:26:00Z"
  },
  "error": {
    "type": "INVALID_INFO",
    "description": "quantityDispensed amount exceeds the quantityWritten"
  }
}