Skip to content

Changelog

This page tracks changes to the Open API 2.0, including new fields, deprecated fields, and other updates.

New Fields (3/25/2026)

  • service_request_web_url - URL to view the service request in the VectorCare web application. Included in webhook payloads and the create request response. The user following this link must be logged in to VectorCare.

Improvement (3/1/2026)

  • 13 fields now return boolean values (true/false/null) instead of organization-configured strings: can_ambulate, destination_is_home, escalated, has_own_wheelchair, hospice, is_dialysis_trip, is_inpatient, is_recent_onset, isolation_precaution, patient_is_ready, pickup_is_home, return_on_will_call, wait_and_return. A null value means the field is either not configured for the organization or no value was provided by the requester.

Improvement (2/20/2026)

  • event_id is now chronologically sortable. IDs generated later are lexicographically greater, so you can compare event IDs to determine ordering

New Webhook Actions (2/13/2026)

  • CHANGE_REQUEST_ACCEPTED - Sent when your change request is approved by the request creator
  • CHANGE_REQUEST_DECLINED - Sent when your change request is declined by the request creator

New Fields (2/12/2026)

  • change_request_enabled - Whether you can submit a change request for this request

New Endpoint (2/11/2026)

  • Change Request - Propose a different pickup time after accepting a request

Announcement (2/11/2026)

  • Open API 1.0 is retiring on August 12, 2026. After this date, all 1.0 endpoints and webhooks will no longer be available. Open API 2.0 is a completely new integration approach with webhook-driven architecture, a unified API URL, static payload structure, and new endpoints. Contact support@vectorcare.com if you need assistance with your Open API 2.0 integration.

New Fields (1/28/2026)

  • round_trip_other_service_request_id - Identifier for the other leg of a round trip

New Fields (1/19/2026)

  • additional_passenger_name - Name of additional passenger traveling with patient
  • additional_passenger_phone - Phone number of additional passenger
  • additional_passenger_relationship - Relationship of additional passenger to patient
  • additional_passenger_weight - Weight of additional passenger in pounds
  • additional_personnel - Additional personnel requirements for transport
  • destination_exact_location - Specific location details at destination
  • destination_is_home - Whether destination is patient’s home address
  • dry_run_reason - Reason transport was unsuccessful
  • escalated - Whether request has been escalated
  • hospice - Whether patient is under hospice care
  • is_inpatient - Whether patient is currently admitted as inpatient
  • is_recent_onset - Whether condition is recent onset
  • patient_is_ready - Whether patient is ready for pickup
  • payment_plan_primary - Primary payment plan type
  • payment_plan_secondary - Secondary payment plan type
  • pickup_exact_location - Specific location details at pickup
  • pickup_is_home - Whether pickup is patient’s home address
  • receiving_practitioner_2 - Secondary receiving practitioner
  • transporting_practitioner - Name of transporting practitioner

New Endpoints (12/15/2025)

  • Best Time - Propose an alternative pickup time for a broadcast request

New Endpoints (12/9/2025)

New Fields (12/12/2025)

  • action - Event type that triggered the webhook (top-level field)

New Fields (8/28/2025)

  • contact_name - Contact person’s name
  • contact_phone - Contact phone number
  • external_authorization - External authorization number
  • is_dialysis_trip - Whether this is a dialysis transport
  • note - General transport notes
  • other_requirements - Additional transport requirements
  • patient_bmi - Patient’s body mass index
  • payment_option_primary_group_number - Primary insurance group number
  • payment_option_primary_subscriber_id - Primary insurance subscriber ID
  • payment_option_secondary_group_number - Secondary insurance group number
  • payment_option_secondary_subscriber_id - Secondary insurance subscriber ID
  • return_date_time - Return trip date and time
  • transport_reason - Reasons for transport
  • trip_priority_level - Priority level of the trip

Initial Release (5/19/2025)

Open API 2.0 launched with webhook-driven architecture.

Top-Level Fields

  • event_id, event_timestamp, service_request_id, request_status, data

Core Request Fields

  • service_request_id, request_current_state, service_type, service_level_type, scheduling_option, scheduling_type

Organization Fields

  • account_name, organization_id, facility_name, collection_id

Patient Fields

  • patient_id, patient_first_name, patient_middle_name, patient_last_name, patient_date_of_birth, patient_age, patient_gender, patient_weight_lbs, patient_weight_kg, patient_height_inches, patient_girth_inches, patient_over_300p, patient_language_spoken, patient_language_written, patient_interpreter_required, patient_active_membership, patient_coverages

Membership Fields

  • patient_membership_primary_id, patient_membership_primary_prefix, patient_membership_secondary_id, patient_membership_secondary_prefix

Location Fields

  • pickup_location, destination_location (with address, city, country, lat, lng, name, state, street, zip)
  • pickup_facility_name, pickup_facility_type, pickup_phone_number, pickup_phone_number_extension, pickup_room_number, pickup_stair_steps
  • destination_facility_name, destination_facility_type, destination_phone_number, destination_phone_number_extension, destination_room_number, destination_stair_steps, destination_address_detail

Scheduling Fields

  • pickup_date_time, agreed_for_time, appointment_datetime, revised_eta

Round Trip Fields

  • is_round_trip_first_trip, is_round_trip_return_trip, return_on_will_call, wait_and_return

Personnel Fields

  • requester_email, requester_first_name, requester_last_name, requester_phone_number, requester_phone_number_extension
  • responder_user_email, responder_user_first_name, responder_user_last_name
  • authorizing_physician, receiving_practitioner

Medical Fields

  • diagnosis_notes, can_ambulate, cct_criteria, medications, intravenous_therapy, medical_supervision, mental_health_hold, o2, number_of_drips

Equipment Fields

  • required_equipment, special_equipment, has_own_wheelchair, isolation_precaution, under_isolation

Payment Fields

  • payment_option_primary, payment_option_secondary, pre_authorization_number

Administrative Fields

  • case_number, gl_code, travel_authorization_number, override_approver, override_reason

Airport Fields

  • departure_airport, arrival_airport

Fields are rarely removed, but when deprecated:

  1. Field will be marked as deprecated in this changelog
  2. Field will continue to be sent for a transition period
  3. Advance notice will be provided before removal