Class FacilitiesApi

FacilitiesApi - object-oriented interface

Export

FacilitiesApi

Hierarchy

BaseAPI
- FacilitiesApi

Index

Constructors

constructor

new FacilitiesApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): FacilitiesApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns FacilitiesApi
Inherited from BaseAPI.constructor
- Defined in base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration

Methods

getFacility

getFacility(
requestParameters: FacilitiesApiGetFacilityRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<FacilityDetailsSchema, any>>
Retreive information and current status of a particular facility
Parameters
- requestParameters: FacilitiesApiGetFacilityRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<FacilityDetailsSchema, any>>
Throws
Memberof
FacilitiesApi
- Defined in api.ts:9433

getFacilityErrrorsHistory

getFacilityErrrorsHistory(
requestParameters: FacilitiesApiGetFacilityErrrorsHistoryRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<HistoryPoint[], any>>
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 Promise<AxiosResponse<HistoryPoint[], any>>
Throws
Memberof
FacilitiesApi
- Defined in api.ts:9445

getFacilityExtracts

getFacilityExtracts(
requestParameters: FacilitiesApiGetFacilityExtractsRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<FacilityExtractsSchema, any>>
Retreive extract counts for a particular facility
Parameters
- requestParameters: FacilitiesApiGetFacilityExtractsRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<FacilityExtractsSchema, any>>
Throws
Memberof
FacilitiesApi
- Defined in api.ts:9457

getFacilityList

getFacilityList(
requestParameters?: FacilitiesApiGetFacilityListRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<FacilityDetailsSchema[], any>>
Retreive a list of on-record facilities
Parameters
- requestParameters: FacilitiesApiGetFacilityListRequest = {}
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<FacilityDetailsSchema[], any>>
Throws
Memberof
FacilitiesApi
- Defined in api.ts:9469

getFacilityPatientsLatestErrors

getFacilityPatientsLatestErrors(
requestParameters: FacilitiesApiGetFacilityPatientsLatestErrorsRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<PageMessageSchema, any>>
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 Promise<AxiosResponse<PageMessageSchema, any>>
Throws
Memberof
FacilitiesApi
- Defined in api.ts:9481

getFacilityReportsCc001

getFacilityReportsCc001(
requestParameters: FacilitiesApiGetFacilityReportsCc001Request,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<PagePatientRecordSummarySchema, any>>
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 Promise<AxiosResponse<PagePatientRecordSummarySchema, any>>
Throws
Memberof
FacilitiesApi
- Defined in api.ts:9493

getFacilityReportsPm001

getFacilityReportsPm001(
requestParameters: FacilitiesApiGetFacilityReportsPm001Request,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<PagePatientRecordSummarySchema, any>>
Program Membership Report 001: Patients with no active PKB membership record
Parameters
- requestParameters: FacilitiesApiGetFacilityReportsPm001Request
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PagePatientRecordSummarySchema, any>>
Throws
Memberof
FacilitiesApi
- Defined in api.ts:9505

getFacilityStatsDemographics

getFacilityStatsDemographics(
requestParameters: FacilitiesApiGetFacilityStatsDemographicsRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<DemographicsStats, any>>
Retreive demographic statistics for a given facility
Parameters
- requestParameters: FacilitiesApiGetFacilityStatsDemographicsRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<DemographicsStats, any>>
Throws
Memberof
FacilitiesApi
- Defined in api.ts:9517

getFacilityStatsKrt

getFacilityStatsKrt(
requestParameters: FacilitiesApiGetFacilityStatsKrtRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<UnitLevelDialysisStats, any>>
Retreive KRT statistics for a given facility
Parameters
- requestParameters: FacilitiesApiGetFacilityStatsKrtRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UnitLevelDialysisStats, any>>
Throws
Memberof
FacilitiesApi
- Defined in api.ts:9529

Class FacilitiesApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FacilitiesApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

getFacility

Parameters

Returns Promise<AxiosResponse<FacilityDetailsSchema, any>>

Throws

Memberof

getFacilityErrrorsHistory

Parameters

Returns Promise<AxiosResponse<HistoryPoint[], any>>

Throws

Memberof

getFacilityExtracts

Parameters

Returns Promise<AxiosResponse<FacilityExtractsSchema, any>>

Throws

Memberof

getFacilityList

Parameters

Returns Promise<AxiosResponse<FacilityDetailsSchema[], any>>

Throws

Memberof

getFacilityPatientsLatestErrors

Parameters

Returns Promise<AxiosResponse<PageMessageSchema, any>>

Throws

Memberof

getFacilityReportsCc001

Parameters

Returns Promise<AxiosResponse<PagePatientRecordSummarySchema, any>>

Throws

Memberof

getFacilityReportsPm001

Parameters

Returns Promise<AxiosResponse<PagePatientRecordSummarySchema, any>>

Throws

Memberof

getFacilityStatsDemographics

Parameters

Returns Promise<AxiosResponse<DemographicsStats, any>>

Throws

Memberof

getFacilityStatsKrt

Parameters

Returns Promise<AxiosResponse<UnitLevelDialysisStats, any>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration