@ukkidney/ukrdc-axios-ts
    Preparing search index...

    Function FacilitiesApiAxiosParamCreator

    • FacilitiesApi - axios parameter creator

      Parameters

      Returns {
          getFacility: (
              code: string,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getFacilityErrrorsHistory: (
              code: string,
              since?: string,
              until?: string,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getFacilityExtracts: (
              code: string,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getFacilityList: (
              includeInactive?: boolean,
              includeEmpty?: boolean,
              sortBy?: FacilitySorterEnum,
              orderBy?: OrderBy,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getFacilityPatientsLatestErrors: (
              code: string,
              channel?: string[],
              sortBy?: MessageEnum,
              orderBy?: OrderBy,
              page?: number,
              size?: number,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getFacilityReportsCc001: (
              code: string,
              page?: number,
              size?: number,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getFacilityReportsPm001: (
              code: string,
              page?: number,
              size?: number,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getFacilityStatsDemographics: (
              code: string,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getFacilityStatsKrt: (
              code: string,
              options?: AxiosRequestConfig,
          ) => Promise<RequestArgs>;
      }

      • getFacility: (code: string, options?: AxiosRequestConfig) => Promise<RequestArgs>

        Retreive information and current status of a particular facility

      • getFacilityErrrorsHistory: (
            code: string,
            since?: string,
            until?: string,
            options?: AxiosRequestConfig,
        ) => Promise<RequestArgs>

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

      • getFacilityExtracts: (code: string, options?: AxiosRequestConfig) => Promise<RequestArgs>

        Retreive extract counts for a particular facility

      • getFacilityList: (
            includeInactive?: boolean,
            includeEmpty?: boolean,
            sortBy?: FacilitySorterEnum,
            orderBy?: OrderBy,
            options?: AxiosRequestConfig,
        ) => Promise<RequestArgs>

        Retreive a list of on-record facilities

      • getFacilityPatientsLatestErrors: (
            code: string,
            channel?: string[],
            sortBy?: MessageEnum,
            orderBy?: OrderBy,
            page?: number,
            size?: number,
            options?: AxiosRequestConfig,
        ) => Promise<RequestArgs>

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

      • getFacilityReportsCc001: (
            code: string,
            page?: number,
            size?: number,
            options?: AxiosRequestConfig,
        ) => Promise<RequestArgs>

        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.

      • getFacilityReportsPm001: (
            code: string,
            page?: number,
            size?: number,
            options?: AxiosRequestConfig,
        ) => Promise<RequestArgs>

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

      • getFacilityStatsDemographics: (code: string, options?: AxiosRequestConfig) => Promise<RequestArgs>

        Retreive demographic statistics for a given facility

      • getFacilityStatsKrt: (code: string, options?: AxiosRequestConfig) => Promise<RequestArgs>

        Retreive KRT statistics for a given facility