Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

4.1 - Start

...

search 

A POST to the searches The startSearch endpoint is used to submit a search request to the Search & Match Service.  This call returns a searchId for of the search. 

SendPost

startSearchsearches

Expand
titleRequest...
FieldDetails
wmdaId*integer
example: 123456

nullable: false
matchEngine*integer
nullable: false

Unique identifier of match engine used in the search. Allowed: 2 (HAP-E), 3 (ATLAS).

Enum:
Array [ 2 ]
searchType*string
example: DR
Enum:
Array [ 2 ]
overallMismatchesinteger
default: 0
Enum:
Array [ 8 ]
lociToBeConsidered[...]
isCbuAbLowDrb1HighResolutionboolean
default: false

nullable: true
Expand
titleResponse
FieldDetails
searchIdinteger
nullable: false

minimum: 1

4.2 - Search summary

The retrieveSearchResultssummary A GET to the searches/{searchId} endpoint is used to request a search summary for of a search. It also contains the status of a the search and can therefore be used to check whether a the search is done. 

retrieveSearchResultssummary which
Get
searches/{searchId}
Send
Expand
titleRequest
FieldDetails
searchId*

integer

Unique identifier of the search. Can be determined by retrieving the patient search summary

Expand
titleResponse
FieldDetails
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: 0
Enum:
Array [ 8 ]
status*string
nullable: false
Enum:
Array [ 3 ]
summary*{...}
inexplicable*integer
nullable: true

Total number of donors

whose phenotype cannot be explained by known haplotype

statistics*{...}
error*{...}
nullable: true
lociToBeConsidered[...]
lastUpdatedstring($date-time)
nullable: false

maxLength: 255

needed to help determine when the patient can be automatically moved to STP state

4.3 -

...

Retrieve all searches for a patient

A GET to the searches/patientSearches/{wmdaId} The retrieveSearchResultsDonors endpoint is used to retrieve search results for donors. Pagination is possible and optional filters can be provided. an overview off all searches that have been performed for a specific patient.

retrieveSearchResultsDonors{...}string
nullable: true
standard 2 expandpagingsearchResults
Get
searches/patientSearches/{wmdaId}
Send
Expand
titleRequest
FieldDetails
wmdaId*
pagination

integer

wmdaId of patient you want to find search information for. This is NOT the patientId, but the wmdaId you received in the response body after creating your patient.

Expand
titleResponse
FieldDetails
searchId*integer
nullable: false

minimum: 1
filters{...}
sortBy
matchEngine*integer
nullable: false

Unique identifier of match engine used in the search. Allowed: 2 (HAP-E), 3 (ATLAS).

Enum:
Array [ 2 ]
searchType*stringEnum:
Array [ 1 ]
overallMismatches*integer

default: 
0Enum:
Array [
 8 ]
status*
titleResponse
FieldDetails
string
nullable: false
Enum:
Array [ 3 ]
summary*{...}
lociToBeConsidered*[...]
lastUpdated*string($date-time)
nullable: false

maxLength: 255

needed to help determine when the patient can be automatically moved to STP state

inexplicableinteger
nullable: true

Total number of donors whose phenotype cannot be explained by known haplotype

statistics{...}
error{...}
nullable: true

4.4 -

...

Search results - Donors

The retrieveFullReportDonors A POST to the searches/searchResults/donors endpoint is used to retrieve all available information for a specific donor in a search result. search results with adult donors. Pagination is possible and optional filters can be provided. If only interested in recent changes to the search results, this can be achieved using a filter on "recordLastUpdatedFrom" field.

string
Post
searches/searchResults/donors
Send
retrieveSearchResultsDonors
searchId
Expand
titleRequest
FieldDetails
searchResultsIdinteger
Expand
titleResponse
pagination{...}
searchId*
FieldDetails
integer
nullable: false

minimum: 1
searchType
filters{...}
sortBy

string
nullable: true

default: standard

Enum:
Array [

 1 

 2 ]

matchDuration
patient
Expand
titleResponse
FieldDetails
paging*
integer
minimum: 0

nullable: true

example: 30

time in seconds that the search took to run on the matching engine

{...}
donor
searchResults*
{
[...
}
]