Class MasterRecordsApi

MasterRecordsApi - object-oriented interface

Export

MasterRecordsApi

Hierarchy

BaseAPI
- MasterRecordsApi

Index

Constructors

constructor

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

getMasterRecord

getMasterRecord(
requestParameters: MasterRecordsApiGetMasterRecordRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<MasterRecordSchema, any>>
Retreive a particular master record from the EMPI
Parameters
- requestParameters: MasterRecordsApiGetMasterRecordRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<MasterRecordSchema, any>>
Throws
Memberof
MasterRecordsApi
- Defined in api.ts:10864

getMasterRecordLatestMessage

getMasterRecordLatestMessage(
requestParameters: MasterRecordsApiGetMasterRecordLatestMessageRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<MinimalMessageSchema, any>>
Retreive a minimal representation of the latest file received for the patient, if received within the last year.
Parameters
- requestParameters: MasterRecordsApiGetMasterRecordLatestMessageRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<MinimalMessageSchema, any>>
Throws
Memberof
MasterRecordsApi
- Defined in api.ts:10876

getMasterRecordLinkrecords

getMasterRecordLinkrecords(
requestParameters: MasterRecordsApiGetMasterRecordLinkrecordsRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<LinkRecordSchema[], any>>
Retreive a list of link records related to a particular master record
Parameters
- requestParameters: MasterRecordsApiGetMasterRecordLinkrecordsRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<LinkRecordSchema[], any>>
Throws
Memberof
MasterRecordsApi
- Defined in api.ts:10888

getMasterRecordMessages

getMasterRecordMessages(
requestParameters: MasterRecordsApiGetMasterRecordMessagesRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<PageMessageSchema, any>>
Retreive a list of errors related to a particular master record. By default returns message created within the last 365 days.
Parameters
- requestParameters: MasterRecordsApiGetMasterRecordMessagesRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PageMessageSchema, any>>
Throws
Memberof
MasterRecordsApi
- Defined in api.ts:10900

getMasterRecordPatientrecords

getMasterRecordPatientrecords(
requestParameters: MasterRecordsApiGetMasterRecordPatientrecordsRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<PatientRecordSummarySchema[], any>>
Retreive a list of patient records related to a particular master record.
Parameters
- requestParameters: MasterRecordsApiGetMasterRecordPatientrecordsRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PatientRecordSummarySchema[], any>>
Throws
Memberof
MasterRecordsApi
- Defined in api.ts:10912

getMasterRecordPersons

getMasterRecordPersons(
requestParameters: MasterRecordsApiGetMasterRecordPersonsRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<PersonSchema[], any>>
Retreive a list of person records related to a particular master record.
Parameters
- requestParameters: MasterRecordsApiGetMasterRecordPersonsRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PersonSchema[], any>>
Throws
Memberof
MasterRecordsApi
- Defined in api.ts:10924

getMasterRecordRelated

getMasterRecordRelated(
requestParameters: MasterRecordsApiGetMasterRecordRelatedRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<MasterRecordSchema[], any>>
Retreive a list of other master records related to a particular master record
Parameters
- requestParameters: MasterRecordsApiGetMasterRecordRelatedRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<MasterRecordSchema[], any>>
Throws
Memberof
MasterRecordsApi
- Defined in api.ts:10936

getMasterRecordStatistics

getMasterRecordStatistics(
requestParameters: MasterRecordsApiGetMasterRecordStatisticsRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<MasterRecordStatisticsSchema, any>>
Retreive a particular master record from the EMPI
Parameters
- requestParameters: MasterRecordsApiGetMasterRecordStatisticsRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<MasterRecordStatisticsSchema, any>>
Throws
Memberof
MasterRecordsApi
- Defined in api.ts:10948

getMasterRecordWorkitems

getMasterRecordWorkitems(
requestParameters: MasterRecordsApiGetMasterRecordWorkitemsRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<WorkItemSchema[], any>>
Retreive a list of work items related to a particular master record.
Parameters
- requestParameters: MasterRecordsApiGetMasterRecordWorkitemsRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<WorkItemSchema[], any>>
Throws
Memberof
MasterRecordsApi
- Defined in api.ts:10960

Class MasterRecordsApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MasterRecordsApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

getMasterRecord

Parameters

Returns Promise<AxiosResponse<MasterRecordSchema, any>>

Throws

Memberof

getMasterRecordLatestMessage

Parameters

Returns Promise<AxiosResponse<MinimalMessageSchema, any>>

Throws

Memberof

getMasterRecordLinkrecords

Parameters

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

Throws

Memberof

getMasterRecordMessages

Parameters

Returns Promise<AxiosResponse<PageMessageSchema, any>>

Throws

Memberof

getMasterRecordPatientrecords

Parameters

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

Throws

Memberof

getMasterRecordPersons

Parameters

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

Throws

Memberof

getMasterRecordRelated

Parameters

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

Throws

Memberof

getMasterRecordStatistics

Parameters

Returns Promise<AxiosResponse<MasterRecordStatisticsSchema, any>>

Throws

Memberof

getMasterRecordWorkitems

Parameters

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

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration