Function FacilitiesApiFp

Returns {
    getFacility(
        code: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<FacilityDetailsSchema>,
    >;
    getFacilityErrrorsHistory(
        code: string,
        since?: string | null,
        until?: string | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<HistoryPoint[]>,
    >;
    getFacilityExtracts(
        code: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<FacilityExtractsSchema>,
    >;
    getFacilityFeedshare(
        code: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<{ [key: string]: string[] }>,
    >;
    getFacilityList(
        includeInactive?: boolean,
        includeEmpty?: boolean,
        sortBy?: FacilitySorterEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<FacilityDetailsSchema[]>,
    >;
    getFacilityPatientsLatestErrors(
        code: string,
        channel?: string[] | null,
        page?: number,
        size?: number,
        sortBy?: MessageEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageMessageSchema>,
    >;
    getFacilityRadarMissing(
        code: string,
        page?: number,
        size?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<RadarMissingPagePatientRecordSummarySchema>,
    >;
    getFacilityReportsCc001(
        code: string,
        page?: number,
        size?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PagePatientRecordSummarySchema>,
    >;
    getFacilityReportsPm001(
        code: string,
        page?: number,
        size?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PagePatientRecordSummarySchema>,
    >;
    getFacilityStatsDemographics(
        code: string,
        since?: string | null,
        until?: string | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<DemographicsStats>,
    >;
    getFacilityStatsKrt(
        code: string,
        since?: string | null,
        until?: string | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UnitLevelKRTStats>,
    >;
}

• getFacility: function

  • getFacility(
        code: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<FacilityDetailsSchema>,
    >

    Retreive information and current status of a particular facility

    Parameters

    • code: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<FacilityDetailsSchema>,
    >

    Throws

• getFacilityErrrorsHistory: function

  • getFacilityErrrorsHistory(
        code: string,
        since?: string | null,
        until?: string | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<HistoryPoint[]>,
    >

    Retreive time-series new error counts for the last year for a particular facility

    Parameters

    • code: string
    • Optionalsince: string | null
    • Optionaluntil: string | null
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<HistoryPoint[]>,
    >

    Throws

• getFacilityExtracts: function

  • getFacilityExtracts(
        code: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<FacilityExtractsSchema>,
    >

    Retreive extract counts for a particular facility

    Parameters

    • code: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<FacilityExtractsSchema>,
    >

    Throws

• getFacilityFeedshare: function

  • getFacilityFeedshare(
        code: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<{ [key: string]: string[] }>,
    >

    Retreive all feedshare facility groupings, keyed by parent facility code. Feedshare relationships change very rarely, so this is cached for 1 hour rather than recomputed on every request.

    Parameters

    • code: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<{ [key: string]: string[] }>,
    >

    Throws

• getFacilityList: function

  • getFacilityList(
        includeInactive?: boolean,
        includeEmpty?: boolean,
        sortBy?: FacilitySorterEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<FacilityDetailsSchema[]>,
    >

    Retreive a list of on-record facilities

    Parameters

    • OptionalincludeInactive: boolean
    • OptionalincludeEmpty: boolean
    • OptionalsortBy: FacilitySorterEnum | null
    • OptionalorderBy: OrderBy | null
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<FacilityDetailsSchema[]>,
    >

    Throws

• getFacilityPatientsLatestErrors: function

  • getFacilityPatientsLatestErrors(
        code: string,
        channel?: string[] | null,
        page?: number,
        size?: number,
        sortBy?: MessageEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageMessageSchema>,
    >

    Retreive time-series new error counts for the last year for a particular facility

    Parameters

    • code: string
    • Optionalchannel: string[] | null
    • Optionalpage: number

      Page number

    • Optionalsize: number

      Page size

    • OptionalsortBy: MessageEnum | null
    • OptionalorderBy: OrderBy | null
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageMessageSchema>,
    >

    Throws

• getFacilityRadarMissing: function

  • getFacilityRadarMissing(
        code: string,
        page?: number,
        size?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<RadarMissingPagePatientRecordSummarySchema>,
    >

    Radar missing: returns the membership records of patients known to radar but not the ukrdc

    Parameters

    • code: string
    • Optionalpage: number

      Page number

    • Optionalsize: number

      Page size

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<RadarMissingPagePatientRecordSummarySchema>,
    >

    Throws

• getFacilityReportsCc001: function

  • getFacilityReportsCc001(
        code: string,
        page?: number,
        size?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PagePatientRecordSummarySchema>,
    >

    Custom Cohort Report 001: No treatment or programme membership to explain presence of record in the UKRDC. Excludes patients with a known date of death prior to 5 years ago from the time of query.

    Parameters

    • code: string
    • Optionalpage: number

      Page number

    • Optionalsize: number

      Page size

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PagePatientRecordSummarySchema>,
    >

    Throws

• getFacilityReportsPm001: function

  • getFacilityReportsPm001(
        code: string,
        page?: number,
        size?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PagePatientRecordSummarySchema>,
    >

    Program Membership Report 001: Patients with no active PKB membership record

    Parameters

    • code: string
    • Optionalpage: number

      Page number

    • Optionalsize: number

      Page size

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PagePatientRecordSummarySchema>,
    >

    Throws

• getFacilityStatsDemographics: function

  • getFacilityStatsDemographics(
        code: string,
        since?: string | null,
        until?: string | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<DemographicsStats>,
    >

    Retreive demographic statistics for a given facility

    Parameters

    • code: string
    • Optionalsince: string | null
    • Optionaluntil: string | null
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<DemographicsStats>,
    >

    Throws

• getFacilityStatsKrt: function

  • getFacilityStatsKrt(
        code: string,
        since?: string | null,
        until?: string | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UnitLevelKRTStats>,
    >

    Retreive KRT statistics for a given facility

    Parameters

    • code: string
    • Optionalsince: string | null
    • Optionaluntil: string | null
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UnitLevelKRTStats>,
    >

    Throws