Function SearchApiFp

Returns {
    getSearchMasterrecords(
        pid?: string[],
        mrnNumber?: string[],
        ukrdcNumber?: string[],
        fullName?: string[],
        dob?: string[],
        facility?: string[],
        search?: string[],
        numberType?: string[],
        page?: number,
        size?: number,
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageMasterRecordSchema>,
    >;
    getSearchRecords(
        pid?: string[],
        mrnNumber?: string[],
        ukrdcNumber?: string[],
        fullName?: string[],
        dob?: string[],
        facility?: string[],
        extract?: string[],
        search?: string[],
        includeMigrated?: boolean,
        includeMemberships?: boolean,
        includeInformational?: boolean,
        includeSurvey?: boolean,
        page?: number,
        size?: number,
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PagePatientRecordSummarySchema>,
    >;
}

• getSearchMasterrecords: function

  • getSearchMasterrecords(
        pid?: string[],
        mrnNumber?: string[],
        ukrdcNumber?: string[],
        fullName?: string[],
        dob?: string[],
        facility?: string[],
        search?: string[],
        numberType?: string[],
        page?: number,
        size?: number,
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageMasterRecordSchema>,
    >

    Search the EMPI for a particular master record

    Parameters

    • Optionalpid: string[]

      Patient PID
    • OptionalmrnNumber: string[]

      Patient MRN number, e.g. NHS, CHI or HSC number
    • OptionalukrdcNumber: string[]

      UKRDC record number
    • OptionalfullName: string[]

      Patient full name
    • Optionaldob: string[]

      Patient date of birth
    • Optionalfacility: string[]

      Facility code
    • Optionalsearch: string[]

      Free-text search query
    • OptionalnumberType: string[]

      Number types to return, e.g. UKRDC, NHS, CHI, HSC
    • Optionalpage: number
    • Optionalsize: number
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

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

    Deprecated

    Throws

• getSearchRecords: function

  • getSearchRecords(
        pid?: string[],
        mrnNumber?: string[],
        ukrdcNumber?: string[],
        fullName?: string[],
        dob?: string[],
        facility?: string[],
        extract?: string[],
        search?: string[],
        includeMigrated?: boolean,
        includeMemberships?: boolean,
        includeInformational?: boolean,
        includeSurvey?: boolean,
        page?: number,
        size?: number,
        options?: AxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PagePatientRecordSummarySchema>,
    >

    Search the UKRDC for a particular patient record

    Parameters

    • Optionalpid: string[]

      Patient PID
    • OptionalmrnNumber: string[]

      Patient MRN number, e.g. NHS, CHI or HSC number
    • OptionalukrdcNumber: string[]

      UKRDC record number
    • OptionalfullName: string[]

      Patient full name
    • Optionaldob: string[]

      Patient date of birth
    • Optionalfacility: string[]

      Facility code
    • Optionalextract: string[]

      Extract code
    • Optionalsearch: string[]

      Free-text search query
    • OptionalincludeMigrated: boolean

      Include migrated records in search results
    • OptionalincludeMemberships: boolean

      Include membership-only records in search results
    • OptionalincludeInformational: boolean

      Include informational-only records in search results
    • OptionalincludeSurvey: boolean

      Include survey-only records in search results
    • Optionalpage: number
    • Optionalsize: number
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

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

    Throws