Pharmacy status

Input

• patientobjectRequired

  Who the prescription is for.

  Show child parameters

  • 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.

• pharmacyobjectRequired

  Where it was sent.

  Show child parameters

  • namestringRequired

    Such as CVS Pharmacy. Up to 255 characters.

  • addressobjectRequired

    The exact store.

    Show child parameters

    • 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.

• prescriptionobjectRequired

  What to ask about.

  Show child parameters

  • 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.

    Show child parameters

    • 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.

      Show child parameters

      • namestring

        Such as Oakland Heart Center. Up to 255 characters.

      • addressobjectRequired
        Show child parameters

        • 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.

• include_cash_priceboolean

  Also ask the cash price.

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.

• fill_statusenum, nullable

  The state of the fill.

  Possible values

  • readyReady for pickup now.
  • in_progressBeing filled.
  • not_startedReceived, not worked on yet.
  • on_holdStuck. See hold_reason.
  • out_of_stockThe pharmacy is out of the drug.
  • transferred_outMoved to another pharmacy.
  • not_foundNo record at this pharmacy.
• ready_attimestamp, nullable

  When it will be ready.

• hold_reasonenum, nullable

  Why it is on hold.

  Possible values

  • prior_authorization_requiredThe plan needs a prior authorization.
  • refill_too_soonToo early for a refill.
  • needs_prescriber_approvalThe prescriber has to approve it.
  • insurance_rejectedThe plan rejected the claim.
  • otherAnother reason. See hold_detail.
• hold_detailstring, nullable

  What the pharmacy said about the hold. Up to 1,000 characters.

• cash_priceobject, nullable

  The cash price, when you asked.

  Show child parameters

  • priceobject
    Show child parameters

    • amount_centsinteger

      Whole cents.

    • currencyenum

      Always USD.

      Possible values

      • USDUS dollars.
  • quantityinteger

    At least 1.

Questions

inputtextnumberbooleandatechoice

How to answer them

Calls

ask_pharmacy_fill_statusask_prescriber_to_resolve_hold

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.