Function MasterRecordsApiFp

Returns {
    getMasterRecord(
        recordId: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MasterRecordSchema>,
    >;
    getMasterRecordLatestMessage(
        recordId: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MinimalMessageSchema>,
    >;
    getMasterRecordLinkrecords(
        recordId: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<LinkRecordSchema[]>,
    >;
    getMasterRecordMessages(
        recordId: number,
        facility?: string | null,
        since?: string | null,
        until?: string | null,
        status?: string[] | null,
        channel?: string[] | null,
        page?: number,
        size?: number,
        sortBy?: MessageEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageMessageSchema>,
    >;
    getMasterRecordPatientrecords(
        recordId: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PatientRecordSummarySchema[]>,
    >;
    getMasterRecordPersons(
        recordId: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PersonSchema[]>,
    >;
    getMasterRecordRelated(
        recordId: number,
        excludeSelf?: boolean,
        nationalidType?: string | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MasterRecordSchema[]>,
    >;
    getMasterRecordStatistics(
        recordId: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MasterRecordStatisticsSchema>,
    >;
    getMasterRecordWorkitems(
        recordId: number,
        status?: number[] | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<WorkItemSchema[]>,
    >;
}

• getMasterRecord: function

  • getMasterRecord(
        recordId: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MasterRecordSchema>,
    >

    Retreive a particular master record from the EMPI

    Parameters

    • recordId: number
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MasterRecordSchema>,
    >

    Throws

• getMasterRecordLatestMessage: function

  • getMasterRecordLatestMessage(
        recordId: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MinimalMessageSchema>,
    >

    Retreive a minimal representation of the latest file received for the patient, if received within the last year.

    Parameters

    • recordId: number
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MinimalMessageSchema>,
    >

    Throws

• getMasterRecordLinkrecords: function

  • getMasterRecordLinkrecords(
        recordId: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<LinkRecordSchema[]>,
    >

    Retreive a list of link records related to a particular master record

    Parameters

    • recordId: number
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<LinkRecordSchema[]>,
    >

    Throws

• getMasterRecordMessages: function

  • getMasterRecordMessages(
        recordId: number,
        facility?: string | null,
        since?: string | null,
        until?: string | null,
        status?: string[] | null,
        channel?: string[] | null,
        page?: number,
        size?: number,
        sortBy?: MessageEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageMessageSchema>,
    >

    Retreive a list of errors related to a particular master record. By default returns message created within the last 365 days.

    Parameters

    • recordId: number
    • Optionalfacility: string | null
    • Optionalsince: string | null
    • Optionaluntil: string | null
    • Optionalstatus: string[] | null
    • Optionalchannel: string[] | null
    • Optionalpage: number

      Page number

    • Optionalsize: number

      Page size

    • OptionalsortBy: MessageEnum | null
    • OptionalorderBy: OrderBy | null
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageMessageSchema>,
    >

    Throws

• getMasterRecordPatientrecords: function

  • getMasterRecordPatientrecords(
        recordId: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PatientRecordSummarySchema[]>,
    >

    Retreive a list of patient records related to a particular master record.

    Parameters

    • recordId: number
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PatientRecordSummarySchema[]>,
    >

    Throws

• getMasterRecordPersons: function

  • getMasterRecordPersons(
        recordId: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PersonSchema[]>,
    >

    Retreive a list of person records related to a particular master record.

    Parameters

    • recordId: number
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PersonSchema[]>,
    >

    Throws

• getMasterRecordRelated: function

  • getMasterRecordRelated(
        recordId: number,
        excludeSelf?: boolean,
        nationalidType?: string | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MasterRecordSchema[]>,
    >

    Retreive a list of other master records related to a particular master record

    Parameters

    • recordId: number
    • OptionalexcludeSelf: boolean
    • OptionalnationalidType: string | null
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MasterRecordSchema[]>,
    >

    Throws

• getMasterRecordStatistics: function

  • getMasterRecordStatistics(
        recordId: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MasterRecordStatisticsSchema>,
    >

    Retreive a particular master record from the EMPI

    Parameters

    • recordId: number
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MasterRecordStatisticsSchema>,
    >

    Throws

• getMasterRecordWorkitems: function

  • getMasterRecordWorkitems(
        recordId: number,
        status?: number[] | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<WorkItemSchema[]>,
    >

    Retreive a list of work items related to a particular master record.

    Parameters

    • recordId: number
    • Optionalstatus: number[] | null
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<WorkItemSchema[]>,
    >

    Throws