Circle V2 API Docs
    Preparing search index...

    Type Alias ListPatientsInOrganizationParams

    type ListPatientsInOrganizationParams = {
        admissionStatus?: AdmissionStatusFilter;
        createdByUserIds?: UserId[];
        entityId: EntityId;
        facilityId?: FacilityId | FacilityId[];
        facilityIdsForLoc?: FacilityId[];
        facilityIdsForProgram?: FacilityId[];
        levelOfCareIds?: FacilityLevelOfCareId[];
        limit?: number;
        offset?: number;
        patientIds?: PatientId | PatientId[];
        patientSearch?: string;
        primaryProviderId?: ProfileId | ProfileId[];
        programIds?: FacilityProgramId[];
        sortBy?: "name" | "created_at" | "admitted_at" | "discharged_at";
        sortOrder?: "asc" | "desc";
        status?: number | number[];
    }
    Index

    Properties

    admissionStatus?: AdmissionStatusFilter
    createdByUserIds?: UserId[]
    entityId: EntityId
    facilityId?: FacilityId | FacilityId[]
    facilityIdsForLoc?: FacilityId[]
    facilityIdsForProgram?: FacilityId[]
    levelOfCareIds?: FacilityLevelOfCareId[]

    Match the current stay's value; the facilityIdsFor* pairs match a whole facility instead.

    limit?: number
    offset?: number
    patientIds?: PatientId | PatientId[]
    patientSearch?: string
    primaryProviderId?: ProfileId | ProfileId[]
    programIds?: FacilityProgramId[]
    sortBy?: "name" | "created_at" | "admitted_at" | "discharged_at"
    sortOrder?: "asc" | "desc"
    status?: number | number[]