INinteractly
Integrations Resource Records V2

List Resource Records

Changed on
get/integrations/v2/resource-records

Request

  • Base URL
    https://api-qa.interactly.ai
  • URL
    https://api-qa.interactly.ai/integrations/v2/resource-records
  • Auth
    HTTP bearer

Query parameters

integrationIdstring nullable

Reference to the associated integration

status'active' | 'inactive'

Represents whether the integration is active or inactive.

type'locations' | 'practitioners' | 'visiting_reasons' | 'patients' | 'insurance_details' | 'appointments' | 'waitlist' | 'outreach' | 'appointment_types' | 'visit_statuses' | 'insurance_payers' | 'provider_resources'

Defines the type of resource record.

patientStatus'created' | 'updated' | 'sync_created' | 'sync_failed' | 'existing_patient'

Defines appointment status options for integration

patientMrnIdstring nullable

Medical Record Number (MRN) identifier for the patient

patientPhoneNumberstring nullable

Phone number of the patient

patientEmailstring nullable

Email address of the patient

appointmentStatus'scheduled' | 'cancelled' | 'rescheduled' | 'reschedule_failed' | 'cancel_failed' | 'sync_created' | 'sync_updated' | 'sync_failed'

Defines appointment status options for integration

appointmentAtGtestring nullable

Start time of the appointment in ISO 8601 format

appointmentAtLtestring nullable

End time of the appointment in ISO 8601 format

appointmentTypestring nullable

Type of the appointment

paymentMethod'self_pay' | 'commercial_insurance' | 'medicare' | 'medicaid'
locationIdstring nullable

Identifier for the location associated with the appointment

practitionerIdstring nullable

Identifier for the practitioner associated with the appointment

patientFlowMismatchboolean nullable

Indicates if there is a patient flow mismatch for the appointment

patientCreatedSourcesIntegrationPatientCreatedSource[]

Sources of the patient creation

appointmentCreatedSourcesIntegrationAppointmentCreatedSource[]

Sources of the appointment creation

hasRemindersboolean nullable

Indicates if the appointment has reminders set up

isInsuranceCardUploaded'yes' | 'no' | 'skip' | 'not_applicable'

Defines possible answers for integration questions.

isInsuranceCardUploadedToEHR'yes' | 'no' | 'skip' | 'not_applicable'

Defines possible answers for integration questions.

isOcrExtracted'yes' | 'no' | 'skip' | 'not_applicable'

Defines possible answers for integration questions.

hasStediResponse'yes' | 'no' | 'skip' | 'not_applicable'

Defines possible answers for integration questions.

stediFinalStatus'active_insurance' | 'inactive_insurance' | 'unable_to_verify_insurance'
debugboolean nullable

If true, includes debug information in the response

{
  "integrationId": "5eb7cf5a86d9755df3a6c593"
}
sizeinteger

Number of items per page

pageinteger

Page number

searchstring nullable

Search keywords

startstring date-time nullable

Filter by start time (ISO 8601 format)

endstring date-time nullable

Filter by end time (ISO 8601 format)

Response

Successful Response

totalinteger nullable

Total number of integrations resource records available without pagination.

Example response

{
  "integration_resource_records": [
    {
      "teamId": "5eb7cf5a86d9755df3a6c593",
      "createdBy": "5eb7cf5a86d9755df3a6c593",
      "updatedBy": "5eb7cf5a86d9755df3a6c593",
      "_id": "5eb7cf5a86d9755df3a6c593",
      "integrationId": "5eb7cf5a86d9755df3a6c593",
      "config": {
        "supervisorId": "5eb7cf5a86d9755df3a6c593",
        "preferred_visiting_reasons": [
          "5eb7cf5a86d9755df3a6c593"
        ]
      }
    }
  ]
}

Changes

  • 9395eef95ea5Revision changes
    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

  • c1ddf4b5859aRevision changes
    • warning

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

    • warning

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

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status