Circle V2 API Docs
    Preparing search index...

    Type Alias RawPatientDocument

    type RawPatientDocument = {
        circle_metadata?: CircleDocumentMetadata | null;
        created_at?: Date;
        file_url?: string | null;
        id: string;
        name: string;
        raw_document: unknown;
        treatment_episode_id?: TreatmentEpisodeId | null;
        type: ExternalDocumentType;
        updated_at?: Date;
    }
    Index

    Properties

    circle_metadata? created_at? file_url? id name raw_document treatment_episode_id? type updated_at?

    Properties

    circle_metadata?: CircleDocumentMetadata | null
    created_at?: Date
    file_url?: string | null

    Optional source file (e.g. RPA-downloaded PDF) for the detail viewer. Omit for API-only EMR docs.

    id: string
    name: string
    raw_document: unknown
    treatment_episode_id?: TreatmentEpisodeId | null

    Per-document episode override; wins over the batch-level treatmentEpisodeId so one batch can span multiple stays (InSync-RPA attributes each document by its date-of-service).

    type: ExternalDocumentType
    updated_at?: Date

    Settings

    Member Visibility

    On This Page

    Properties