Circle V2 API Docs
    Preparing search index...

    Type Alias ListPatientChartsForPatientParams

    type ListPatientChartsForPatientParams = {
        dateFrom?: string;
        dateTo?: string;
        externalDocumentType?: ExternalDocumentType | ExternalDocumentType[];
        fileType?: FormType | FormType[];
        limit?: number;
        offset?: number;
        patientId: PatientId;
        pieces?: "exclude" | "include";
        search?: string;
        sortOrder?: "asc" | "desc";
        treatmentEpisodeId?: TreatmentEpisodeId;
    }
    Index

    Properties

    dateFrom? dateTo? externalDocumentType? fileType? limit? offset? patientId pieces? search? sortOrder? treatmentEpisodeId?

    Properties

    dateFrom?: string
    dateTo?: string
    externalDocumentType?: ExternalDocumentType | ExternalDocumentType[]
    fileType?: FormType | FormType[]
    limit?: number
    offset?: number
    patientId: PatientId
    pieces?: "exclude" | "include"

    Packet pieces are hidden in the grouped view (the default) and listed flat on "include".

    search?: string
    sortOrder?: "asc" | "desc"
    treatmentEpisodeId?: TreatmentEpisodeId

    When set, scope the listing to this treatment episode: charts stamped with the episode OR dated within its admission/discharge window (see episodeScopePredicate). Omit to list across all of the patient's episodes.

    Settings

    Member Visibility

    On This Page

    Properties