Unique identifier of match engine used in the search. Allowed: 2 (HAP-E), 3 (ATLAS).
Enum: Array [ 2 ]
searchType*
string example:DREnum: Array [ 2 ]
overallMismatches
integer default:0Enum: Array [ 8 ]
lociToBeConsidered
[...]
isCbuAbLowDrb1HighResolution
boolean default:false nullable:true
Field
Details
searchId
integer nullable:false minimum:1
4.2 - Search summary
The retrieveSearchResultsSummary endpoint is used to request a search summary of a search. It also contains the status of the search and can therefore be used to check whether the search is done.
Unique identifier of the search. Can be determined by retrieving the patient search summary
Field
Details
patient
{...}
searchId*
integer nullable:false minimum:1
searchType*
stringEnum: Array [ 1 ]
matchEngine*
integer nullable:false
Unique identifier of match engine used in the search. Allowed: 2 (HAP-E), 3 (ATLAS).
Enum: Array [ 2 ]
overallMismatches*
integer default:0Enum: Array [ 8 ]
status*
string nullable:falseEnum: Array [ 3 ]
summary*
{...}
inexplicable*
integer nullable:true
Total number of donors whose phenotype cannot be explained by known haplotype
statistics*
{...}
error*
{...} nullable:true
lociToBeConsidered
[...]
lastUpdated
string($date-time) nullable:false maxLength:255
needed to help determine when the patient can be automatically moved to STP state
4.3 - Search results - Donors
The retrieveSearchResultsDonors endpoint is used to retrieve search results with adult donors. Pagination is possible and optional filters can be provided.
Unique identifier of the donor within a search result. This is the "id" field within searchResult
Field
Details
searchId
integer nullable:false minimum:1
searchType
string Enum: Array [ 1 ]
matchDuration
integer minimum:0 nullable:true example:30
time in seconds that the search took to run on the matching engine
patient
{...}
search
{...}
donor
{...}
4.5 - Search results - CBUs
The retrieveSearchResultsDonors endpoint is used to retrieve search results with cord blood units. Pagination is possible and optional filters can be provided.
Unique identifier of the search. Can be determined by retrieving the patient search summary
Field
Details
searchId
integer nullable:false minimum:1
searchType
stringEnum: Array [ 1 ]
matchDuration
integer minimum:0 nullable:true example:30
time in seconds that the search took to run on the matching engine
search
{...}
patient
{...}
cbu
{...}
4.7 - Suggested use of API endpoints
Below is a diagram indicating the suggested use of some of the API endpoints. More API endpoints are available and the API implementer may choose to implement the endpoints in another order.
