JOjoincandidhealth
v1

Get Eligibility Timeline

Changed on

Gets a patient's eligibility audit timeline, newest-first. Org-scoped and keyset-paginated.

get/patients/v1/{id}/eligibility-timeline

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/patients/v1/{id}/eligibility-timeline
  • Auth
    HTTP bearer

Path parameters

idstring required

The unique identifier for a Patient

Query parameters

event_types'APPOINTMENT_STATUS_CHANGED' | 'APPOINTMENT_WORK_QUEUE_CHANGED' | 'APPOINTMENT_COPAY_UPDATED' | 'COVERAGE_CREATED' | 'COVERAGE_UPDATED' | 'ELIG_CHECK_COMPLETED' | 'PATIENT_TAGS_UPDATED' | 'PATIENT_SELF_PAY_UPDATED'
coverage_idstring uuid

The unique identifier for a Coverage in the database

appointment_idstring

The unique identifier for an Appointment.

page_tokenstring

A token that can be used to retrieve the next or previous page of results

limitinteger

Response

Response with status 200

next_page_tokenstring

A token that can be used to retrieve the next or previous page of results

prev_page_tokenstring

A token that can be used to retrieve the next or previous page of results

totalinteger required

Changes

  • d8b0a61873e2Revision changes
    • warning

      added the new PATIENT_SELF_PAY_UPDATED enum value to the // response property for the response status

    • info

      added the new enum value PATIENT_SELF_PAY_UPDATED to the query request parameter event_types

  • 24b2d80d577aRevision changes
    • breaking

      the query request parameter event_types was restricted to a list of enum values

    • breaking

      the response's body type changed from no type to object for status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security OAuthScheme was added to the API

    • info

      added the new enum value APPOINTMENT_COPAY_UPDATED to the query request parameter event_types

    • info

      added the new enum value APPOINTMENT_STATUS_CHANGED to the query request parameter event_types

    • info

      added the new enum value APPOINTMENT_WORK_QUEUE_CHANGED to the query request parameter event_types

    • info

      added the new enum value COVERAGE_CREATED to the query request parameter event_types

    • info

      added the new enum value COVERAGE_UPDATED to the query request parameter event_types

    • info

      added the new enum value ELIG_CHECK_COMPLETED to the query request parameter event_types

    • info

      added the new enum value PATIENT_TAGS_UPDATED to the query request parameter event_types

    • info

      for the path request parameter id, the type was generalized from no type to string

    • info

      for the query request parameter appointment_id, the type was generalized from no type to string

    • info

      for the query request parameter coverage_id, the type was generalized from no type to string, and format from no format to uuid

    • info

      for the query request parameter event_types, the type was generalized from no type to string

    • info

      for the query request parameter page_token, the type was generalized from no type to string

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status