Action ended

Attributes

Signed with Vene-Signature. Verify it.

• idstring

  The event ID. Use it to drop duplicates. Starts with evt_.

• typeenum

  The event type.

  Possible values

  • action.endedThe action ended.
• created_attimestamp

  When it happened.

• dataobject

  What changed.

  Show child parameters

  • actionobject
    Show child parameters

    • idstring

      The action ID. Starts with act_.

    • typeenum

      The action type.

      Possible values

      • pharmacy_statusIs a prescription ready.
      • pharmacy_transferMove a prescription.
      • pharmacy_stock_checkWho has a drug in stock.
      • find_availabilityFind openings.
      • book_appointmentBook a visit.
      • reschedule_appointmentMove a visit.
      • cancel_appointmentCancel a visit.
    • statusenum

      Where the action stands.

      Possible values

      • queuedAccepted, not started.
      • in_progressLooking up numbers or on a call.
      • waiting_for_answerAsked you a question. Continues when you answer.
      • waiting_for_callbackWaiting to call again, or for a place to call back.
      • succeededThe place gave a definite answer.
      • failedNo definite answer. See failure_reason.
      • cancelledYou cancelled it.
    • inputobject

      What you sent. Its fields depend on type; see the action types.

    • questionsarray of objects

      Every question, oldest first.

      Show child parameters

      • questionstring

        Up to 500 characters.

      • helpstring, nullable
      • call_idstring

        Starts with call_.

      • typeenum

        Possible values

        • inputFill one optional input field.
        • textFree text.
        • numberA number, within any limits.
        • booleanYes or no.
        • dateA date.
        • choiceOne of the offered options.
        • slotPick an offered opening, or send new windows.
      • pathstring

        Up to 200 characters.

      • idstring

        Starts with q_.

      • asked_attimestamp
      • answered_attimestamp, nullable
      • answerobject, nullable
        Show child parameters

        • valueany
        • unavailableenum

          Possible values

          • true
        • notestring
      • max_lengthinteger

        1 to 2,000.

      • integerboolean
      • minnumber
      • maxnumber
      • optionsarray of objects
        Show child parameters

        • idstring
        • labelstring

          Up to 200 characters.

        • slotobject
          Show child parameters

          • starts_attimestamp

            When the visit starts.

          • duration_minutesinteger

            How long it runs. 1 to 1,440.

          • providerobject

            Who the visit is with.

            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

            Where. Always set in results.

            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.

        • held_untiltimestamp, nullable
      • multipleboolean
    • resultobject, nullable

      Set when it ends. These fields are shared; the rest depend on type (action types).

      Show child parameters

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

    • trailarray of objects

      Every call, oldest first.

      Show child parameters

      • idstring

        The call ID. Starts with call_.

      • call_typeenum

        Why Vene made the call.

        Possible values

        • ask_pharmacy_fill_statusAsk a pharmacy about a fill.
        • ask_prescriber_to_resolve_holdAsk a prescriber's office to act on a hold.
        • ask_pharmacy_to_transfer_prescriptionAsk a pharmacy to pull a transfer.
        • ask_pharmacy_stockAsk a pharmacy about stock.
        • ask_provider_availabilityAsk an office about openings.
        • book_provider_appointmentBook with an office.
        • reschedule_provider_appointmentReschedule with an office.
        • cancel_provider_appointmentCancel with an office.
        • inbound_callbackA place called Vene back.
      • placeobject

        Who was on the other end.

        Show child parameters

        • namestring
        • addressobject, nullable
          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

          The number dialed, or the one that called in. E.164 phone number.

      • started_attimestamp, nullable

        When it connected.

      • ended_attimestamp, nullable

        When it ended.

      • ended_reasonenum, nullable

        How it ended.

        Possible values

        • completedThe call ran to its end.
        • voicemailIt reached voicemail.
        • no_answerNobody picked up.
        • busyThe line was busy.
        • they_hung_upThe place hung up.
        • queue_callbackA phone queue took Vene's number to call back.
        • long_holdVene hung up after about ten minutes on hold.
    • created_attimestamp

      When you created it.

    • updated_attimestamp

      When it last changed.

    • ended_attimestamp, nullable

      When it ended.

  • callobject
    Show child parameters

    • idstring

      Starts with call_.

    • call_typeenum

      Possible values

      • ask_pharmacy_fill_statusAsk a pharmacy about a fill.
      • ask_prescriber_to_resolve_holdAsk a prescriber's office to act on a hold.
      • ask_pharmacy_to_transfer_prescriptionAsk a pharmacy to pull a transfer.
      • ask_pharmacy_stockAsk a pharmacy about stock.
      • ask_provider_availabilityAsk an office about openings.
      • book_provider_appointmentBook with an office.
      • reschedule_provider_appointmentReschedule with an office.
      • cancel_provider_appointmentCancel with an office.
      • inbound_callbackA place called Vene back.
    • placeobject
      Show child parameters

      • namestring
      • addressobject, nullable
        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

        E.164 phone number.

    • started_attimestamp, nullable
    • ended_attimestamp, nullable
    • ended_reasonenum, nullable

      Possible values

      • completedThe call ran to its end.
      • voicemailIt reached voicemail.
      • no_answerNobody picked up.
      • busyThe line was busy.
      • they_hung_upThe place hung up.
      • queue_callbackA phone queue took Vene's number to call back.
      • long_holdVene hung up after about ten minutes on hold.
    • resultobject, nullable