Docs

Pharmacy transfer

Move a prescription from one pharmacy to another.

POST/v1/actions

typepharmacy_transfer

Input

  • patientobjectRequired

    Who the prescription is for.

    • refstringRequired

      Your ID for the patient. Vene uses it to match callbacks. Up to 255 characters.

    • first_namestringRequired

      As the place has it on file. Up to 120 characters.

    • last_namestringRequired

      As the place has it on file. Up to 120 characters.

    • date_of_birthdateRequired

      Places check it with the name.

  • prescriptionobjectRequired

    Send rx_number when you have it.

    • drug_namestringRequired

      Such as lisinopril. Up to 255 characters.

    • strengthstring

      Such as 10 mg. Up to 64 characters.

    • formstring

      Such as tablet. Up to 64 characters.

    • quantityinteger

      Units in the fill. 1 to 10,000.

    • rx_numberstring

      The pharmacy's number for it. Makes every call faster. Up to 64 characters.

    • prescriberobject

      Who wrote it.

      • first_namestringRequired

        The clinician's first name. Up to 120 characters.

      • last_namestringRequired

        The clinician's last name. Up to 120 characters.

      • credentialstring

        Such as MD or NP. Up to 32 characters.

      • npistring

        The clinician's NPI. The surest way to find the office. 10 digits.

      • specialtystring

        Such as cardiology. Up to 120 characters.

      • practiceobject

        Where the patient is seen.

        • namestring

          Such as Oakland Heart Center. Up to 255 characters.

        • addressobjectRequired
          • line1stringRequired

            Street address. Up to 255 characters.

          • line2string

            Suite or unit. Up to 255 characters.

          • citystringRequired

            Up to 120 characters.

          • statestringRequired

            Such as CA. Two-letter state code.

          • postal_codestringRequired

            Five-digit ZIP code. 5 digits.

        • phonestring

          A hint. Vene checks the number before it dials. E.164 phone number.

  • from_pharmacyobjectRequired

    Where it is now.

    • namestringRequired

      Such as CVS Pharmacy. Up to 255 characters.

    • addressobjectRequired

      The exact store.

      • line1stringRequired

        Street address. Up to 255 characters.

      • line2string

        Suite or unit. Up to 255 characters.

      • citystringRequired

        Up to 120 characters.

      • statestringRequired

        Such as CA. Two-letter state code.

      • postal_codestringRequired

        Five-digit ZIP code. 5 digits.

    • npistring

      The pharmacy NPI. 10 digits.

    • phonestring

      A hint. Vene checks the number before it dials. E.164 phone number.

  • to_pharmacyobjectRequired

    Where it should go. Vene calls this one.

    • namestringRequired

      Such as CVS Pharmacy. Up to 255 characters.

    • addressobjectRequired

      The exact store.

      • line1stringRequired

        Street address. Up to 255 characters.

      • line2string

        Suite or unit. Up to 255 characters.

      • citystringRequired

        Up to 120 characters.

      • statestringRequired

        Such as CA. Two-letter state code.

      • postal_codestringRequired

        Five-digit ZIP code. 5 digits.

    • npistring

      The pharmacy NPI. 10 digits.

    • phonestring

      A hint. Vene checks the number before it dials. E.164 phone number.

  • insuranceobject

    The receiving pharmacy usually asks for it.

    • payer_namestringRequired

      Up to 255 characters.

    • plan_namestring

      Up to 255 characters.

    • member_idstringRequired

      From the card. Up to 64 characters.

    • group_numberstring

      From the card. Up to 64 characters.

    • rx_binstring

      Pharmacy BIN from the card. Up to 32 characters.

    • rx_pcnstring

      Pharmacy PCN from the card. Up to 32 characters.

    • rx_groupstring

      Pharmacy group from the card. Up to 64 characters.

Returns

The action, with this result once it ends.

  • summarystring

    What happened, in a sentence or two. Up to 2,000 characters.

  • failure_reasonenum, nullable

    Why it failed. Null unless failed.

    Possible values

    • patient_authorization_requiredThe place needs the patient herself to authorize it.
    • place_would_not_helpThe place would not discuss it with Vene.
    • place_unreachableClosed, never answered, or no working number.
    • declined_by_youYou declined something the action needed.
    • fee_over_maxThe fee was over max_fee. The result names it.
    • internal_errorA Vene fault.
  • next_stepstring, nullable

    What you could do next. Up to 1,000 characters.

  • transfer_statusenum, nullable

    Where the transfer stands.

    Possible values

    • completedThe receiving pharmacy has it.
    • in_progressRequested, not received yet.
    • refusedRefused. See refusal_reason.
  • ready_attimestamp, nullable

    When the new pharmacy will have it ready.

  • new_rx_numberstring, nullable

    The new pharmacy's number for it. Up to 64 characters.

  • refusal_reasonenum, nullable

    Why it was refused.

    Possible values

    • controlled_substanceControlled substances cannot be transferred this way.
    • no_refills_remainingNo refills are left.
    • transfer_limit_reachedThe prescription was already transferred the allowed number of times.
    • otherAnother reason.

Questions

inputtextnumberbooleandatechoice

How to answer them

Calls

ask_pharmacy_to_transfer_prescription

Errors

  • 400invalid_request

    The body or query failed validation.

  • 401unauthorized

    The API key is missing, unknown, or revoked.

  • 403forbidden

    The key lacks the scope.

  • 409idempotency_conflict

    The key was used with a different body.

  • 429rate_limited

    Over a limit. Wait for Retry-After.

  • 500internal_error

    A Vene fault.