Circle V2 API Docs
    Preparing search index...

    Type Alias UpsertExternalDocumentRow

    Row shape for bulk EMR-document upserts. Mirrors the valuesToUpsert shape in storePatientDocuments (legacy package). Distinct from CreatePatientChartParams, which is for in-app file uploads.

    type UpsertExternalDocumentRow = {
        circle_metadata?: unknown | null;
        entity_id: EntityId;
        external_document_created_at?: string | null;
        external_document_id: string;
        external_document_type: ExternalDocumentType;
        external_document_updated_at?: string | null;
        file_name: string;
        file_type: "emr_document";
        file_url?: string | null;
        integration_id: IntegrationId;
        is_ready: boolean;
        patient_id: PatientId;
        raw_document: unknown;
        treatment_episode_id?: TreatmentEpisodeId | null;
    }
    Index

    Properties

    circle_metadata? entity_id external_document_created_at? external_document_id external_document_type external_document_updated_at? file_name file_type file_url? integration_id is_ready patient_id raw_document treatment_episode_id?

    Properties

    circle_metadata?: unknown | null
    entity_id: EntityId
    external_document_created_at?: string | null
    external_document_id: string
    external_document_type: ExternalDocumentType
    external_document_updated_at?: string | null
    file_name: string
    file_type: "emr_document"
    file_url?: string | null

    Optional source file (e.g. the RPA-downloaded PDF) so the detail view can render it. Null for API-only EMR docs.

    integration_id: IntegrationId
    is_ready: boolean
    patient_id: PatientId
    raw_document: unknown
    treatment_episode_id?: TreatmentEpisodeId | null

    Settings

    Member Visibility

    On This Page

    Properties