@ukkidney/ukrdc-axios-ts
    Preparing search index...

    Interface SearchApiGetSearchRecordsRequest

    Request parameters for getSearchRecords operation in SearchApi.

    SearchApiGetSearchRecordsRequest

    interface SearchApiGetSearchRecordsRequest {
        dob?: string[];
        extract?: string[];
        facility?: string[];
        fullName?: string[];
        includeInformational?: boolean;
        includeMemberships?: boolean;
        includeMigrated?: boolean;
        includeSurvey?: boolean;
        mrnNumber?: string[];
        page?: number;
        pid?: string[];
        search?: string[];
        size?: number;
        ukrdcNumber?: string[];
    }
    Index

    Properties

    dob? extract? facility? fullName? includeInformational? includeMemberships? includeMigrated? includeSurvey? mrnNumber? page? pid? search? size? ukrdcNumber?

    Properties

    dob?: string[]

    Patient date of birth

    SearchApiGetSearchRecords

    extract?: string[]

    Extract code

    SearchApiGetSearchRecords

    facility?: string[]

    Facility code

    SearchApiGetSearchRecords

    fullName?: string[]

    Patient full name

    SearchApiGetSearchRecords

    includeInformational?: boolean

    Include informational-only records in search results

    SearchApiGetSearchRecords

    includeMemberships?: boolean

    Include membership-only records in search results

    SearchApiGetSearchRecords

    includeMigrated?: boolean

    Include migrated records in search results

    SearchApiGetSearchRecords

    includeSurvey?: boolean

    Include survey-only records in search results

    SearchApiGetSearchRecords

    mrnNumber?: string[]

    Patient MRN number, e.g. NHS, CHI or HSC number

    SearchApiGetSearchRecords

    Optional Readonlypage

    page?: number

    SearchApiGetSearchRecords

    pid?: string[]

    Patient PID

    SearchApiGetSearchRecords

    search?: string[]

    Free-text search query

    SearchApiGetSearchRecords

    size?: number

    SearchApiGetSearchRecords

    ukrdcNumber?: string[]

    UKRDC record number

    SearchApiGetSearchRecords

    Settings

    Member Visibility

    On This Page

    Properties