4.1 - Start
...
search
A POST to the searches endpoint is used to submit a search request to the Search & Match Service. This call returns a searchId of the search.
| Post |
|---|
searches |
| Expand |
|---|
| | Field | Details |
|---|
| wmdaId* | integer
example: 123456
nullable: false | | matchEngine* | integer
nullable: falseUnique 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 |
|
| Expand |
|---|
| | 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.
| Get |
|---|
| searches/{searchId} |
| Expand |
|---|
| | Field | Details |
|---|
| searchId* | integer Unique identifier of the search. Can be determined by retrieving the patient search summary |
|
| Expand |
|---|
| | Field | Details |
|---|
| patient | {...} | | searchId* | integer
nullable: false
minimum: 1 | | searchType* | stringEnum:
Array [ 1 ] | | matchEngine* | integer
nullable: falseUnique 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: trueTotal number of donors whose phenotype cannot be explained by known haplotype | | statistics* | {...} | | error* | {...}
nullable: true | | lociToBeConsidered | [...] | | lastUpdated | string($date-time)
nullable: false
maxLength: 255needed 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.
| Get |
|---|
| searches/patientSearches/{wmdaId} |
| Expand |
|---|
| | Field | Details |
|---|
| wmdaId* | 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 |
|---|
| | Field | Details |
|---|
| searchId* | integer
nullable: false
minimum: 1 | | matchEngine* | integer
nullable: falseUnique 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: 255needed to help determine when the patient can be automatically moved to STP state | | inexplicable | integer
nullable: trueTotal 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.
| Post |
|---|
| searches/searchResults/donors |
| Expand |
|---|
| | Field | Details |
|---|
| pagination | {...} | | searchId* | integer
nullable: false
minimum: 1 | | filters | {...} | | sortBy | string
nullable: true
default: standard
Enum:
Array [ 2 ] |
|
| Expand |
|---|
| | Field | Details |
|---|
| paging* | {...} | | searchResults* | [...] |
|
|
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.
| Post |
|---|
| searches/searchResults/cbus |
| Expand |
|---|
| | Field | Details |
|---|
| pagination | {...} | | searchId* | integer
nullable: false
minimum: 1 | | filters | {...} | | sortBy | string
nullable: true
default: standardEnum:
Array [ 2 ] | | threeFourMismatchSortBy | string
nullable: true
default: resolutionScoreEnum:
Array [ 3 ] | | secondarySortBy | string
nullable: true
default: tncCountEnum:
Array [ 2 ] |
|
| Expand |
|---|
| | Field | Details |
|---|
| paging* | {...} | | searchResults* | [...] |
|
|
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 |
| Expand |
|---|
| | Field | Details |
|---|
| wmdaId | 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. | | grid | string
nullable: true
maxLength: 19
minLength: 19
example: 9991012070433202000 | | setAsSelected | boolean
nullable: false
set (true) or unset (false) the indicated grid or cordId as a selected stem cell source for this patient |
|
|
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 |
| Expand |
|---|
| | Field | Details |
|---|
| wmdaId | 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. | | cordId | string
nullable: true
maxLength: 25
example: 9991012070433202000 cordId of the CBU. | | donorRegistryIon | integer
nullable: false
minimum: 1000
maximum: 9999
example: 1234 | | setAsSelected | boolean
nullable: false
set (true) or unset (false) the indicated grid or cordId as a selected stem cell source for this patient |
|
|
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 |
| Expand |
|---|
| | Field | Details |
|---|
| searchId* | integer Unique identifier of the search. Can be determined by retrieving the patient search summary |
|
| Expand |
|---|
| | 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.
| Get |
|---|
| searches/{searchId}/searchResults/cbbs |
| Expand |
|---|
| | Field | Details |
|---|
| searchId* | integer Unique identifier of the search. Can be determined by retrieving the patient search summary |
|
| Expand |
|---|
| | Field | Details |
|---|
| cbbs* | {...} Array of unique cbbs bank manufacterer IDs with their abbreviation and name |
|
|
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.
| Get |
|---|
| searches/donors/{searchResultsId} |
| Expand |
|---|
| | Field | Details |
|---|
| searchResultsId* | integer Unique identifier of the donor within a search result. This is the "id" field within searchResult |
|
| Expand |
|---|
| | Field | Details |
|---|
| searchId | integer
nullable: false
minimum: 1 | | searchType | string
Enum:
Array [ 1 ] | | matchDuration | integer
minimum: 0
nullable: true
example: 30time in seconds that the search took to run on the matching engine | | patient | {...} | | search | {...} | | donor | {...} |
|
|
4.11 - Full report - CBUs
A GET to the searches/cbus/{searchResultsId} endpoint retrieves all available information of a specific CBU in a search result.
| Get |
|---|
| searches/cbus/{searchResultsId} |
| Expand |
|---|
| | Field | Details |
|---|
| searchResultsId* | integer Unique identifier of the search. Can be determined by retrieving the patient search summary |
|
| Expand |
|---|
| | Field | Details |
|---|
| searchId | integer
nullable: false
minimum: 1 | | searchType | stringEnum:
Array [ 1 ] | | matchDuration | integer
minimum: 0
nullable: true
example: 30time in seconds that the search took to run on the matching engine | | search | {...} | | patient | {...} | | cbu | {...} |
|
|
4.12 - Refresh all searches for a patient
A POST to the searches/refreshAllPatientSearches endpoint is used to restart all searches for this patient and retrieve the new results.
4.13 - Restart a single search
A POST to the searches/searchResultsRefresh endpoint is used to restart all searches for this patient and retrieve the new results.
| Post |
|---|
searches/searchResultsRefresh |
| Expand |
|---|
| | Field | Details |
|---|
| searchId* | integer
example: 123456
nullable: false |
|
| Expand |
|---|
| | Field | Details |
|---|
| newSearchId | integer
example: 123457
nullable: false |
|
|
4.14 - 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.
...