Versions Compared

Old Version 42

changes.mady.by.user Albert Mustafin

Saved on

compared with

New Version 43

changes.mady.by.user Matt Prestegaard

Saved on

Key

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

Table of Contents

4.1 - Start search

The startSearch 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

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: DREnum:
Array [ 2 ]
overallMismatchesinteger
default: 0Enum:
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 of a search. It also contains the status of the search and can therefore be used to check whether the search is done. 

Get
retrieveSearchResultsSummarysearches/{searchId}
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: 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[...]
lastUpdatedstring($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 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. 

Post
retrieveSearchResultsDonorssearches/searchResults/donors
Expand
titleRequest
FieldDetails
pagination{...}
searchId*integer
nullable: false
minimum: 1
filters{...}
sortBy

string
nullable: true
default: standard
Enum:
Array [ 2 ]

Expand
titleResponse
FieldDetails
paging*{...}
searchResults*[...]

4.4 - Full report - Donors

The retrieveFullReportDonors A GET to the searches/donors/{searchResultsId} endpoint retrieves all available information of a specific donor in a search result. 

Get
retrieveSearchResultsDonorssearches/donors/{searchResultsId}
Expand
titleRequest
FieldDetails
searchResultsId

integer

Unique identifier of the donor within a search result. This is the "id" field within searchResult

Expand
titleResponse
FieldDetails
searchIdinteger
nullable: false
minimum: 1
searchTypestring
Enum:
Array [ 1 ]
matchDurationinteger
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 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. 

Post
retrieveSearchResultsCBUssearches/searchResults/cbus
Expand
titleRequest
FieldDetails
pagination{...}
searchId*integer
nullable: false
minimum: 1
filters{...}
sortBystring
nullable: true
default: standardEnum:
Array [ 2 ]
threeFourMismatchSortBystring
nullable: true
default: resolutionScoreEnum:
Array [ 3 ]
secondarySortBystring
nullable: true
default: tncCountEnum:
Array [ 2 ]
Expand
titleResponse
FieldDetails
paging*{...}
searchResults*[...]

4.6 - Full report - CBUs

The retrieveFullReportCBUs A GET to the searches/cbus/{searchResultsId} endpoint retrieves all available information of a specific CBU in a search result. 

Get
retrieveFullReportCBUssearches/cbus/{searchResultsId}
Expand
titleRequest
Field

Details

searchResultsId

integer

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

Expand
titleResponse
FieldDetails
searchIdinteger
nullable: false
minimum: 1
searchTypestringEnum:
Array [ 1 ]
matchDurationinteger
minimum: 0
nullable: true
example: 30

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

search{...}
patient{...}
cbu{...}

...