⚠Due to planned maintenance you will experience short (<30 min) downtime between 08:00 - 08:30 CET.
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 | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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.
retrieveSearchResultssummaryResponse which
Get | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
searches/{searchId} | |||||||||||||||||||||||||
Send | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
| |||||||||||||||||||||||||
|
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.
RequestResponsesearchId{...}string
true
default: standard
paging*
example
true
default: standard
[
minItems: 0
Response
Get | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
searches/patientSearches/{wmdaId} | |||||||||||
Send | |||||||||||
retrieveSearchResultsDonors | |||||||||||
| |||||||||||
| |||||||||||
| |||||||||||
integer nullable: false minimum: 1 | pagination | ||||||||||
| |||||||||||
| |||||||||||
filters | {...} | ||||||||||
sortBy | |||||||||||
| |||||||||||
| |||||||||||
searchResults* | id* | ||||||||||
|
Expand | ||
---|---|---|
| ||
|
limit* | integer default: 100 minimum: 0 |
offset* | integer default: 0 minimum: 0 example: 0 |
totalCount* | integer minimum: 0 example: 2 |
|
|
|
4.4 - Search results - Donors
A POST to the searches/searchResults/donors endpoint is used to retrieve 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.
sex*
M, F
ethnicity*
string
nullable: trueEnum:
[ UK, AF, AS, CA, HI, AFNA, AFSS, ASSW, ASSO, ASCE, ASSE, ASNE, ASOC, CAEU, CAER, CANA, CAAU, HICA, HISA, MX, OT ]idm*antiCmvStatusstring
nullable: trueEnum:
Array [ 7 ]antiCmvDatestring($date)
nullable: true
maxLength: 10
Post | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
searches/searchResults/donors | ||||||||||||||
| ||||||||||||||
donorRegistryIon* | integer nullable: false minimum: 1000 maximum: 9999 example: 1234 | |||||||||||||
abbreviation* | string example: NL-WMDA maxLength: 24 | |||||||||||||
haplotypeFrequencySetId* | integer nullable: true minimum: 0 example: 15 | |||||||||||||
status* | string nullable: falseEnum: [ AV, TU, RS ] |
|
|
Expand |
---|
|
nullable: trueEnum:
[ UK, AF, AS, CA, HI, AFNA, AFSS, ASSW, ASSO, ASCE, ASSE, ASNE, ASOC, CAEU, CAER, CANA, CAAU, HICA, HISA, MX, OT ]idm*antiCmvStatusstring
nullable: trueEnum:
Array [ 7 ]antiCmvDatestring($date)
nullable: true
maxLength: 10
date of CMV NAT test
cmvNatStatus
| ||||||
|
4.5 - Search results - CBUs
A POST to the searches/searchResults/cbus retrieveSearchResultsDonors endpoint is used to retrieve search results with cord blood units. 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.
cmvNatDate($date)maxLength10
date of CMV NAT test
abo*Post | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
searches/searchResults/cbus | |||||||||||||||
| |||||||||||||||
| |||||||||||||||
| |||||||||||||||
| |||||||||||||||
|
4.6 - Mark selected donor
A POST to the searches/selected/donors endpoint is used to select a donor. This endpoint can be used to highlight a donor of interest.
Post | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
searches/selected/donors | ||||||||||||||||||
|
4.7 - Mark selected CBU
A POST to the searches/selected/cbus endpoint is used to select a donor. This endpoint can be used to highlight a CBU of interest.
Post | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
searches/selected/cbus | ||||||||||||||||||||
|
4.8 - Get list of registries that appear in search results
A GET to the searches/{searchId}/searchResults/registries endpoint is used to retrieve an overview off all the registries that appear in the search results of a specific donor search.
Get | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
searches/{searchId}/searchResults/registries | ||||||||||||||||||
|
4.9 - Get list of cord blood banks that appear in search results
A GET to the searches/{searchId}/searchResults/cbbs endpoint is used to retrieve an overview off all the registries that appear in the search results of a specific donor search.
Get | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
searches/{searchId}/searchResults/cbbs | ||||||||||||||||||
|
4.10 - Full report - Donors
A GET to the searches/donors/{searchResultsId} endpoint retrieves all available information of a specific donor in a search result.
number
minimum: 0
maximum: 100
54resolutionString*string
minLength: 5
maxLength: 5
example: AP-A-
nullable: true
nullable: true
maxLength: 19
minLength: 19
example: 9991012070433202000donorId*string
nullable: true
example: ABC1234
maxLength: 25donorType*string
nullable: falseEnum:
[ D, B ]lastContactDate*string($date)
nullable: true
minLength: 10
maxLength: 10marrowDonationsCount*integer
nullable: true
example: 0
minimum: 0
maximum: 100
Get | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
searches/donors/{searchResultsId} | |||||||||||||
| |||||||||||||
rhesus* | string nullable: trueEnum: [ P, N ] | ||||||||||||
registryAccreditationStatus* | string nullable: trueEnum: [ accredited, qualified ] | ||||||||||||
firstAccreditationYear* | number minimum: 1990 maximum: 2100 nullable: true example: 2019 | ||||||||||||
matchClass* | string example: 9/10 nullable: false | ||||||||||||
nmdpGrade* | string maxLength: 5 example: MPPMP nullable: true A - high-res match on ARD, P - probable match, M - sure Mismatch | ||||||||||||
zeroMismatchProbability* | integer minimum: 0 maximum: 100 nullable: true | ||||||||||||
oneMismatchProbability* | integer nullable: true minimum: 0 maximum: 100 | ||||||||||||
twoMismatchProbability* | integer nullable: true minimum: 0 maximum: 100 | ||||||||||||
aLocusMatchProbability* | integer nullable: true minimum: 0 maximum: 100 | ||||||||||||
bLocusMatchProbability* | integer nullable: true minimum: 0 maximum: 100 | ||||||||||||
cLocusMatchProbability* | integer nullable: true minimum: 0 maximum: 100 | ||||||||||||
drLocusMatchProbability* | integer nullable: true minimum: 0 maximum: 100 | ||||||||||||
dqLocusMatchProbability* | integer nullable: true minimum: 0 maximum: 100 | ||||||||||||
inexplicable* | boolean | ||||||||||||
matchingInformationDpb1* |
| ||||||||||||
mismatches* |
| ||||||||||||
searchResultRecordState* | string nullable: false default: ExistingEnum: [ Existing, New, Updated, Deleted ] | ||||||||||||
searchResultRecordStateUpdatedAt* | string($date-time) nullable: true maxLength: 255 date and time when the last change was registered in the system | ||||||||||||
isSelected* | boolean nullable: true true when this record has been marked as a selected | ||||||||||||
resolutionScore* |
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
|
|
minLength: 5
maxLength: 5
example: AP-A-
nullable: true
A - high-res P - low or intermediate, - no typing
grid*stringnullable: true
maxLength: 19
minLength: 19
example: 9991012070433202000donorId*string
nullable: true
example: ABC1234
maxLength: 25donorType*string
nullable: falseEnum:
[ D, B ]lastContactDate*string($date)
nullable: true
minLength: 10
maxLength: 10marrowDonationsCount*integer
nullable: true
example: 0
|