Interface SearchApiGetSearchMasterrecordsRequest

Request parameters for getSearchMasterrecords operation in SearchApi.

Export

SearchApiGetSearchMasterrecordsRequest

interface SearchApiGetSearchMasterrecordsRequest {
    dob?: string[];
    facility?: string[];
    fullName?: string[];
    mrnNumber?: string[];
    numberType?: string[];
    page?: number;
    pid?: string[];
    search?: string[];
    size?: number;
    ukrdcNumber?: string[];
}

Index

Properties

dob? facility? fullName? mrnNumber? numberType? page? pid? search? size? ukrdcNumber?

Properties

`Optional` `Readonly`dob

dob?: string[]

Patient date of birth

Memberof

SearchApiGetSearchMasterrecords

`Optional` `Readonly`facility

facility?: string[]

Facility code

Memberof

SearchApiGetSearchMasterrecords

`Optional` `Readonly`fullName

fullName?: string[]

Patient full name

Memberof

SearchApiGetSearchMasterrecords

`Optional` `Readonly`mrnNumber

mrnNumber?: string[]

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

Memberof

SearchApiGetSearchMasterrecords

`Optional` `Readonly`numberType

numberType?: string[]

Number types to return, e.g. UKRDC, NHS, CHI, HSC

Memberof

SearchApiGetSearchMasterrecords

`Optional` `Readonly`page

page?: number

Memberof

SearchApiGetSearchMasterrecords

`Optional` `Readonly`pid

pid?: string[]

Patient PID

Memberof

SearchApiGetSearchMasterrecords

`Optional` `Readonly`search

search?: string[]

Free-text search query

Memberof

SearchApiGetSearchMasterrecords

`Optional` `Readonly`size

size?: number

Memberof

SearchApiGetSearchMasterrecords

`Optional` `Readonly`ukrdcNumber

ukrdcNumber?: string[]

UKRDC record number

Memberof

SearchApiGetSearchMasterrecords