Circle V2 API Docs
    Preparing search index...
    • Parameters

      • params: {
            documentType:
                | "kipu_evaluation"
                | "kipu_consent_form"
                | "kipu_ciwa_ar"
                | "kipu_ciwa_b"
                | "kipu_group_session"
                | "lightningstep_formdata"
                | "lightningstep_txplan"
                | "kipu_vital_signs"
                | "kipu_orthostatic_vital_signs"
                | "kipu_patient_orders"
                | "kipu_glucose_logs"
                | "kipu_program_history"
                | "kipu_diagnosis_history"
                | "kipu_appointment"
                | "lightningstep_admissions"
                | "kipu_episode_outcome"
                | "sunwave_form"
                | "sunwave_diagnosis"
                | "sunwave_group_note"
                | "sunwave_program"
                | "sunwave_lab_result"
                | "sunwave_assessment"
                | "emr_insurance_information"
                | "insync_episode_summary"
                | "insync_condition"
                | "insync_vital_signs"
                | "insync_lab_result"
                | "insync_observation"
                | "insync_allergy"
                | "insync_immunization"
                | "insync_medication_request"
                | "insync_diagnostic_report"
                | "insync_procedure"
                | "insync_rpa_locadtr"
                | "insync_rpa_treatment_plan"
                | "insync_rpa_biopsychosocial"
                | "synthetic_biopsychosocial"
                | "synthetic_asam"
                | "synthetic_consent"
                | "synthetic_nursing_intake"
                | "synthetic_diagnosis"
                | "synthetic_treatment_plan"
                | "synthetic_group_note"
                | "synthetic_progress_note"
                | "synthetic_ur_review"
                | "synthetic_discharge_summary"
                | "insync_rpa_encounter_note"
                | "insync_rpa_consent_form"
                | "insync_rpa_lab_result"
                | "insync_rpa_insurance"
                | "insync_rpa_document"
                | null;
            fileName: string;
            rawDocument: unknown;
            recordedOn: Date
            | null;
            timeZone: string;
        }
        • documentType:
              | "kipu_evaluation"
              | "kipu_consent_form"
              | "kipu_ciwa_ar"
              | "kipu_ciwa_b"
              | "kipu_group_session"
              | "lightningstep_formdata"
              | "lightningstep_txplan"
              | "kipu_vital_signs"
              | "kipu_orthostatic_vital_signs"
              | "kipu_patient_orders"
              | "kipu_glucose_logs"
              | "kipu_program_history"
              | "kipu_diagnosis_history"
              | "kipu_appointment"
              | "lightningstep_admissions"
              | "kipu_episode_outcome"
              | "sunwave_form"
              | "sunwave_diagnosis"
              | "sunwave_group_note"
              | "sunwave_program"
              | "sunwave_lab_result"
              | "sunwave_assessment"
              | "emr_insurance_information"
              | "insync_episode_summary"
              | "insync_condition"
              | "insync_vital_signs"
              | "insync_lab_result"
              | "insync_observation"
              | "insync_allergy"
              | "insync_immunization"
              | "insync_medication_request"
              | "insync_diagnostic_report"
              | "insync_procedure"
              | "insync_rpa_locadtr"
              | "insync_rpa_treatment_plan"
              | "insync_rpa_biopsychosocial"
              | "synthetic_biopsychosocial"
              | "synthetic_asam"
              | "synthetic_consent"
              | "synthetic_nursing_intake"
              | "synthetic_diagnosis"
              | "synthetic_treatment_plan"
              | "synthetic_group_note"
              | "synthetic_progress_note"
              | "synthetic_ur_review"
              | "synthetic_discharge_summary"
              | "insync_rpa_encounter_note"
              | "insync_rpa_consent_form"
              | "insync_rpa_lab_result"
              | "insync_rpa_insurance"
              | "insync_rpa_document"
              | null
        • fileName: string
        • rawDocument: unknown
        • recordedOn: Date | null

          When the EMR recorded the document — the fallback when nothing states a date of its own.

        • timeZone: string

      Returns ResolvedDocumentDate