Class SearchApi

SearchApi - object-oriented interface

Hierarchy

BaseAPI
- SearchApi

Index

Constructors

Properties

axios basePath configuration

Methods

getSearchMasterrecords getSearchRecords

Constructors

constructor

new SearchApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): SearchApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns SearchApi
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

Methods

getSearchMasterrecords

getSearchMasterrecords(
requestParameters?: SearchApiGetSearchMasterrecordsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PageMasterRecordSchema, any, {}>>
Search the EMPI for a particular master record
Parameters
- requestParameters: SearchApiGetSearchMasterrecordsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PageMasterRecordSchema, any, {}>>
Deprecated
Throws
- Defined in api.ts:12574

getSearchRecords

getSearchRecords(
requestParameters?: SearchApiGetSearchRecordsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PagePatientRecordSummarySchema, any, {}>>
Search the UKRDC for a particular patient record
Parameters
- requestParameters: SearchApiGetSearchRecordsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PagePatientRecordSummarySchema, any, {}>>
Throws
- Defined in api.ts:12585