Reschedule appointment

Input

• patientobjectRequired

  Who the visit 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.

• appointmentobjectRequired

  The current appointment.

  Show child parameters

  • starts_attimestampRequired
  • duration_minutesinteger

    1 to 1,440.

  • provideranyRequired

    Needs npi or practice, so Vene can find the office.

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

  • confirmation_numberstring

    Up to 64 characters.

  • arrival_instructionsstring

    Up to 2,000 characters.

• preferred_windowsarray of objectsRequired

  Times the patient can make. 1 to 10 items.

  Show child parameters

  • starttimestampRequired

    When the window opens.

  • endtimestampRequired

    When it closes. After start.

• max_feeobject

  The most the patient will pay to change it. Omit it and Vene goes ahead and reports any fee.

  Show child parameters

  • amount_centsintegerRequired

    Whole cents.

  • currencyenumRequired

    Always USD.

    Possible values

    • USDUS dollars.

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.

• appointmentobject, nullable

  The new visit.

  Show child parameters

  • starts_attimestamp
  • duration_minutesinteger

    1 to 1,440.

  • providerobject
    Show child parameters

    • first_namestring

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

    • last_namestring

      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.

      • addressobject
        Show child parameters

        • line1string

          Street address. Up to 255 characters.

        • line2string

          Suite or unit. Up to 255 characters.

        • citystring

          Up to 120 characters.

        • statestring

          Such as CA. Two-letter state code.

        • postal_codestring

          Five-digit ZIP code. 5 digits.

      • phonestring

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

  • locationobject
    Show child parameters

    • line1string

      Street address. Up to 255 characters.

    • line2string

      Suite or unit. Up to 255 characters.

    • citystring

      Up to 120 characters.

    • statestring

      Such as CA. Two-letter state code.

    • postal_codestring

      Five-digit ZIP code. 5 digits.

  • confirmation_numberstring

    Up to 64 characters.

  • arrival_instructionsstring

    Up to 2,000 characters.

• reschedule_feeobject, nullable

  What the office will charge to move it.

  Show child parameters

  • amount_centsinteger

    Whole cents.

  • currencyenum

    Always USD.

    Possible values

    • USDUS dollars.

Questions

inputtextnumberbooleandatechoiceslot

How to answer them

Calls

reschedule_provider_appointment

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.