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
A GET to the searches/{searchId} 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 - Retrieve all searches for a patient
A GET to the searches/patientSearches/{wmdaId} endpoint is used to retrieve an overview off all searches that have been performed for a specific patient.
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.
Field
Details
searchId*
integer nullable:false minimum:1
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*
string nullable:falseEnum: 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
inexplicable
integer nullable:true
Total number of donors whose phenotype cannot be explained by known haplotype
statistics
{...}
error
{...} nullable:true
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.
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.
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.
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.
set (true) or unset (false) the indicated grid or cordId as a selected stem cell source for this patient
N/A
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.
Unique identifier of the search. Can be determined by retrieving the patient search summary
Field
Details
registries*
{...}
Array of unique registry IONs with their abbreviation and name
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.
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.
1 Comment
Jan Hofmann
describe in more details how a delta search could be operated