Class UKRDCRecordGroupApi

UKRDCRecordGroupApi - object-oriented interface

Hierarchy

BaseAPI
- UKRDCRecordGroupApi

Index

Constructors

Properties

axios basePath configuration

Methods

getUkrdcidRecords postUkrdcidMembershipsCreateMrc postUkrdcidMembershipsCreatePkb

Constructors

constructor

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

getUkrdcidRecords

getUkrdcidRecords(
requestParameters: UKRDCRecordGroupApiGetUkrdcidRecordsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PatientRecordSummarySchema[], any, {}>>
Retreive patient records related to a specific patient record
Parameters
- requestParameters: UKRDCRecordGroupApiGetUkrdcidRecordsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PatientRecordSummarySchema[], any, {}>>
Throws
- Defined in api.ts:13142

postUkrdcidMembershipsCreateMrc

postUkrdcidMembershipsCreateMrc(
requestParameters: UKRDCRecordGroupApiPostUkrdcidMembershipsCreateMrcRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<MirthMessageResponseSchema, any, {}>>
Parameters
- requestParameters: UKRDCRecordGroupApiPostUkrdcidMembershipsCreateMrcRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<MirthMessageResponseSchema, any, {}>>
Throws
- Defined in api.ts:13153

postUkrdcidMembershipsCreatePkb

postUkrdcidMembershipsCreatePkb(
requestParameters: UKRDCRecordGroupApiPostUkrdcidMembershipsCreatePkbRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<MirthMessageResponseSchema, any, {}>>
Create a new membership for a master record.
Parameters
- requestParameters: UKRDCRecordGroupApiPostUkrdcidMembershipsCreatePkbRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<MirthMessageResponseSchema, any, {}>>
Throws
- Defined in api.ts:13164