Circle V2 API Docs
    Preparing search index...

    Interface Notes

    Table "notes" (activity), schema v3. Rows keep their source record ids; record_id (rec prefix) resolves via records.get().

    interface Notes {
        admission_id: string | null;
        attachment_id: string | null;
        author: string | null;
        diagnosis_codes: string | null;
        encounter_id: string | null;
        episode_id: string | null;
        note_type: string | null;
        patient_id: string | null;
        patient_name: string | null;
        record_id: string | null;
        signed_at: string | null;
        status: string | null;
        summary: string | null;
        visit_at: string | null;
    }
    Index

    Properties

    admission_id attachment_id author diagnosis_codes encounter_id episode_id note_type patient_id patient_name record_id signed_at status summary visit_at

    Properties

    admission_id: string | null
    attachment_id: string | null
    author: string | null

    Name of the person who recorded or signed the entry, for sources that keep one on it

    diagnosis_codes: string | null
    encounter_id: string | null
    episode_id: string | null
    note_type: string | null
    patient_id: string | null
    patient_name: string | null
    record_id: string | null
    signed_at: string | null
    status: string | null
    summary: string | null
    visit_at: string | null

    Settings

    Member Visibility

    On This Page

    Properties