Class FacilitiesApi

FacilitiesApi - object-oriented interface

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:39

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

getFacility

getFacility(
requestParameters: FacilitiesApiGetFacilityRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<FacilityDetailsSchema, any, {}>>
Retreive information and current status of a particular facility
Parameters
- requestParameters: FacilitiesApiGetFacilityRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<FacilityDetailsSchema, any, {}>>

Throws
- Defined in api.ts:4978

getFacilityErrrorsHistory

getFacilityErrrorsHistory(
requestParameters: FacilitiesApiGetFacilityErrrorsHistoryRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<HistoryPoint[], any, {}>>
Retreive time-series new error counts for the last year for a particular facility
Parameters
- requestParameters: FacilitiesApiGetFacilityErrrorsHistoryRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<HistoryPoint[], any, {}>>

Throws
- Defined in api.ts:4989

getFacilityExtracts

getFacilityExtracts(
requestParameters: FacilitiesApiGetFacilityExtractsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<FacilityExtractsSchema, any, {}>>
Retreive extract counts for a particular facility
Parameters
- requestParameters: FacilitiesApiGetFacilityExtractsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<FacilityExtractsSchema, any, {}>>

Throws
- Defined in api.ts:5000

getFacilityFeedshare

getFacilityFeedshare(
requestParameters: FacilitiesApiGetFacilityFeedshareRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<{ [key: string]: string[] }, any, {}>>
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
- requestParameters: FacilitiesApiGetFacilityFeedshareRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<{ [key: string]: string[] }, any, {}>>

Throws
- Defined in api.ts:5011

getFacilityList

getFacilityList(
requestParameters?: FacilitiesApiGetFacilityListRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<FacilityDetailsSchema[], any, {}>>
Retreive a list of on-record facilities
Parameters
- requestParameters: FacilitiesApiGetFacilityListRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<FacilityDetailsSchema[], any, {}>>

Throws
- Defined in api.ts:5022

getFacilityPatientsLatestErrors

getFacilityPatientsLatestErrors(
requestParameters: FacilitiesApiGetFacilityPatientsLatestErrorsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PageMessageSchema, any, {}>>
Retreive time-series new error counts for the last year for a particular facility
Parameters
- requestParameters: FacilitiesApiGetFacilityPatientsLatestErrorsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PageMessageSchema, any, {}>>

Throws
- Defined in api.ts:5033

getFacilityRadarMissing

getFacilityRadarMissing(
    requestParameters: FacilitiesApiGetFacilityRadarMissingRequest,
    options?: RawAxiosRequestConfig,
): Promise<
    AxiosResponse<RadarMissingPagePatientRecordSummarySchema, any, {}>,
>
Radar missing: returns the membership records of patients known to radar but not the ukrdc
Parameters
- requestParameters: FacilitiesApiGetFacilityRadarMissingRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RadarMissingPagePatientRecordSummarySchema, any, {}>>

Throws
- Defined in api.ts:5044

getFacilityReportsCc001

getFacilityReportsCc001(
requestParameters: FacilitiesApiGetFacilityReportsCc001Request,
options?: RawAxiosRequestConfig,
): 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: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PagePatientRecordSummarySchema, any, {}>>

Throws
- Defined in api.ts:5055

getFacilityReportsPm001

getFacilityReportsPm001(
requestParameters: FacilitiesApiGetFacilityReportsPm001Request,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PagePatientRecordSummarySchema, any, {}>>
Program Membership Report 001: Patients with no active PKB membership record
Parameters
- requestParameters: FacilitiesApiGetFacilityReportsPm001Request
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PagePatientRecordSummarySchema, any, {}>>

Throws
- Defined in api.ts:5066

getFacilityStatsDemographics

getFacilityStatsDemographics(
requestParameters: FacilitiesApiGetFacilityStatsDemographicsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<DemographicsStats, any, {}>>
Retreive demographic statistics for a given facility
Parameters
- requestParameters: FacilitiesApiGetFacilityStatsDemographicsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<DemographicsStats, any, {}>>

Throws
- Defined in api.ts:5077

getFacilityStatsKrt

getFacilityStatsKrt(
requestParameters: FacilitiesApiGetFacilityStatsKrtRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<UnitLevelKRTStats, any, {}>>
Retreive KRT statistics for a given facility
Parameters
- requestParameters: FacilitiesApiGetFacilityStatsKrtRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UnitLevelKRTStats, any, {}>>

Throws
- Defined in api.ts:5088

Class FacilitiesApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FacilitiesApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

getFacility

Parameters

Returns Promise<AxiosResponse<FacilityDetailsSchema, any, {}>>

Throws

getFacilityErrrorsHistory

Parameters

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

Throws

getFacilityExtracts

Parameters

Returns Promise<AxiosResponse<FacilityExtractsSchema, any, {}>>

Throws

getFacilityFeedshare

Parameters

Returns Promise<AxiosResponse<{ [key: string]: string[] }, any, {}>>

Throws

getFacilityList

Parameters

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

Throws

getFacilityPatientsLatestErrors

Parameters

Returns Promise<AxiosResponse<PageMessageSchema, any, {}>>

Throws

getFacilityRadarMissing

Parameters

Returns Promise<AxiosResponse<RadarMissingPagePatientRecordSummarySchema, any, {}>>

Throws

getFacilityReportsCc001

Parameters

Returns Promise<AxiosResponse<PagePatientRecordSummarySchema, any, {}>>

Throws

getFacilityReportsPm001

Parameters

Returns Promise<AxiosResponse<PagePatientRecordSummarySchema, any, {}>>

Throws

getFacilityStatsDemographics

Parameters

Returns Promise<AxiosResponse<DemographicsStats, any, {}>>

Throws

getFacilityStatsKrt

Parameters

Returns Promise<AxiosResponse<UnitLevelKRTStats, any, {}>>

Throws

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration