Function FacilitiesApiFactory

Returns {
    getFacility(
        requestParameters: FacilitiesApiGetFacilityRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<FacilityDetailsSchema>;
    getFacilityErrrorsHistory(
        requestParameters: FacilitiesApiGetFacilityErrrorsHistoryRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<HistoryPoint[]>;
    getFacilityExtracts(
        requestParameters: FacilitiesApiGetFacilityExtractsRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<FacilityExtractsSchema>;
    getFacilityList(
        requestParameters?: FacilitiesApiGetFacilityListRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<FacilityDetailsSchema[]>;
    getFacilityPatientsLatestErrors(
        requestParameters: FacilitiesApiGetFacilityPatientsLatestErrorsRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<PageMessageSchema>;
    getFacilityReportsCc001(
        requestParameters: FacilitiesApiGetFacilityReportsCc001Request,
        options?: AxiosRequestConfig,
    ): AxiosPromise<PagePatientRecordSummarySchema>;
    getFacilityReportsPm001(
        requestParameters: FacilitiesApiGetFacilityReportsPm001Request,
        options?: AxiosRequestConfig,
    ): AxiosPromise<PagePatientRecordSummarySchema>;
    getFacilityStatsDemographics(
        requestParameters: FacilitiesApiGetFacilityStatsDemographicsRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<DemographicsStats>;
    getFacilityStatsKrt(
        requestParameters: FacilitiesApiGetFacilityStatsKrtRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<UnitLevelDialysisStats>;
}

• getFacility: function

  • getFacility(
        requestParameters: FacilitiesApiGetFacilityRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<FacilityDetailsSchema>

    Retreive information and current status of a particular facility

    Parameters

    • requestParameters: FacilitiesApiGetFacilityRequest

      Request parameters.
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<FacilityDetailsSchema>

    Throws

• getFacilityErrrorsHistory: function

  • getFacilityErrrorsHistory(
        requestParameters: FacilitiesApiGetFacilityErrrorsHistoryRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<HistoryPoint[]>

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

    Parameters

    • requestParameters: FacilitiesApiGetFacilityErrrorsHistoryRequest

      Request parameters.
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<HistoryPoint[]>

    Throws

• getFacilityExtracts: function

  • getFacilityExtracts(
        requestParameters: FacilitiesApiGetFacilityExtractsRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<FacilityExtractsSchema>

    Retreive extract counts for a particular facility

    Parameters

    • requestParameters: FacilitiesApiGetFacilityExtractsRequest

      Request parameters.
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<FacilityExtractsSchema>

    Throws

• getFacilityList: function

  • getFacilityList(
        requestParameters?: FacilitiesApiGetFacilityListRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<FacilityDetailsSchema[]>

    Retreive a list of on-record facilities

    Parameters

    • requestParameters: FacilitiesApiGetFacilityListRequest = {}

      Request parameters.
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<FacilityDetailsSchema[]>

    Throws

• getFacilityPatientsLatestErrors: function

  • getFacilityPatientsLatestErrors(
        requestParameters: FacilitiesApiGetFacilityPatientsLatestErrorsRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<PageMessageSchema>

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

    Parameters

    • requestParameters: FacilitiesApiGetFacilityPatientsLatestErrorsRequest

      Request parameters.
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PageMessageSchema>

    Throws

• getFacilityReportsCc001: function

  • getFacilityReportsCc001(
        requestParameters: FacilitiesApiGetFacilityReportsCc001Request,
        options?: AxiosRequestConfig,
    ): 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

    • requestParameters: FacilitiesApiGetFacilityReportsCc001Request

      Request parameters.
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PagePatientRecordSummarySchema>

    Throws

• getFacilityReportsPm001: function

  • getFacilityReportsPm001(
        requestParameters: FacilitiesApiGetFacilityReportsPm001Request,
        options?: AxiosRequestConfig,
    ): AxiosPromise<PagePatientRecordSummarySchema>

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

    Parameters

    • requestParameters: FacilitiesApiGetFacilityReportsPm001Request

      Request parameters.
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PagePatientRecordSummarySchema>

    Throws

• getFacilityStatsDemographics: function

  • getFacilityStatsDemographics(
        requestParameters: FacilitiesApiGetFacilityStatsDemographicsRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<DemographicsStats>

    Retreive demographic statistics for a given facility

    Parameters

    • requestParameters: FacilitiesApiGetFacilityStatsDemographicsRequest

      Request parameters.
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<DemographicsStats>

    Throws

• getFacilityStatsKrt: function

  • getFacilityStatsKrt(
        requestParameters: FacilitiesApiGetFacilityStatsKrtRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<UnitLevelDialysisStats>

    Retreive KRT statistics for a given facility

    Parameters

    • requestParameters: FacilitiesApiGetFacilityStatsKrtRequest

      Request parameters.
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<UnitLevelDialysisStats>

    Throws