Versions Compared

Old Version 24

changes.mady.by.user Deepa Mallapareddy

Saved on

compared with

New Version Current

changes.mady.by.user Alicia Venter

Saved on

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: 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 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: 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 -

...

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.

Requeststring
true
default: standardEnumsearchId 2 ]nullable
minimum: 1falseintegertrue
default: standardEnum:
Array [ 2 ]

Response

minimum1limit*default
Get
searches/patientSearches/{wmdaId}
Send
retrieveSearchResultsDonors
Expand
titleRequest
pagination{...}
FieldDetails
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
titleResponse
FieldDetails
searchId*integer
nullable: false
minimum: 1
filters{...}
sortBy
matchEngine*integer
nullable: 
pagination{...}
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
filters{...}
sortBy
default: 
0Enum:
Array [ 8 ]
status*
Expand
titleResponse
searchId
string
nullable: 
falseEnum:
Array [ 3 ]
summary*{...}
lociToBeConsidered*[...]
lastUpdated*string($date-time)

nullable: false
maxLength: 
paging*
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

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.

[
minItems: 0

integer
Post
searches/searchResults/donors
100
minimum: 0
offset*integer
default: 0
minimum: 0
example: 0
totalCount*integer
minimum: 0
example: 2
searchResults*
id*integer
nullable: false
example: 5176
donorRegistryIon*integer
nullable: false
minimum: 1000
maximum: 9999
example: 1234
abbreviation*string
example: NL-WMDA
maxLength: 24
haplotypeFrequencySetId*
Expand
titleRequest
FieldDetails
pagination{...}
searchId*integer
nullable: false
minimum: 1
filters{...}
sortBy

string


nullable: true

minimum

default: 

0

standard

example

Enum:

 15status*string
nullable: falseEnum:
[ AV, TU, RS ]sex*string
nullable: trueEnum:
[ 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)


Array [ 2 ]

Expand
titleResponse
FieldDetails
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.

maxLengthstring
nullable: trueEnum:10

date of CMV NAT test

cmvNatDate($date)maxLength10

date of CMV NAT test

string
nullable: true[ A, B, O, AB ]rhesus* P, N registryAccreditationStatus*
Post
searches/searchResults/cbus
Expand
titleRequest
FieldDetails
pagination{...}
searchId*integer
nullable: false
minimum: 1
filters{...}
sortBystring
nullable: true
cmvNatStatus
default: 
standardEnum:

Array [ 2 ]
threeFourMismatchSortBystring

nullable: true
default: 
abo*
resolutionScoreEnum:
Array [ 3 ]
secondarySortBy
string
nullable: true
default: tncCountEnum:
Array [
 2 ]
Expand
titleResponse
FieldDetails
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
titleRequest
FieldDetails
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.

gridstring
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

Expand
titleResponse
N/A

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
titleRequest
FieldDetails
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.

donorRegistryIoninteger
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

Expand
titleResponse
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.

Get
searches/{searchId}/searchResults/registries
Expand
titleRequest
FieldDetails
searchId*

integer

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

Expand
titleResponse
FieldDetails
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
titleRequest
FieldDetails
searchId*

integer

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

Expand
titleResponse
FieldDetails
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. 

number
minimum: 0
maximum: 100
Get
searches/donors/{searchResultsId}
Expand
titleRequest
FieldDetails
searchResultsId*

integer

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

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*
dpb1MatchGrade*string
nullable: trueEnum:
[ P, A, G, H, X ]
tceDigest*
permissiveProbability*integer
nullable: true
minimum: 0
maximum: 100

Probability of permissive MM. Probabilities calculated with allele frequencies for DPB1, no linkage disequilibrium taken into account

nonPermissiveHostVsGraftProbability*integer
nullable: true
minimum: 0
maximum: 100

Probability for non-permissive MM in HvG direction. Probabilities calculated with allele frequencies for DPB1, no linkage disequilibrium taken into account

nonPermissiveGraftVsHostProbability*integer
nullable: true
minimum: 0
maximum: 100

Probability for Nnon-permissive MM in GvH direction. Probabilities calculated with allele frequencies for DPB1, no linkage disequilibrium taken into account

notDeterminedProbability*integer
nullable: true
minimum: 0
maximum: 100

Probability for Not Determinable permissiveness. Probabilities calculated with allele frequencies for DPB1, no linkage disequilibrium taken into account

mismatches*
locus*string
nullable: true

locus where the mismatch is

Enum:
[ A, B, C, DRB1, DQB1, DPB1, DPA1, DQA1, DRB2, DRB3, DRB4, DRB5 ]
position*integer
nullable: true

position of the mismatch (chromosome 1 or 2)

Enum:
[ 1, 2 ]
type*string
nullable: true

type of mismatch

Enum:
[ ANTIGEN, ALLELE ]
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
titleResponse
FieldDetails
searchIdinteger
nullable: false
minimum: 1
searchTypestring
Enum:
Array [ 1 ]
matchDurationinteger
minimum: 0

nullable: true
example: 
54resolutionString*string
minLength: 5
maxLength: 5
example: AP-A-
nullable: true

A - high-res P - low or intermediate, - no typing

grid*string
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: 10
30

time 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. 

integer
Get
searches/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
marrowDonationsCount*
nullable: true
example: 
0pbscDonationsCount*integer
nullable: true
example: 1dateOfBirth*string($date)
nullable: true
maxLength: 10
example: 1961-05-27hla*
a*
field1*string
maxLength: 20
example: 01:01
field2*string
nullable: true
maxLength: 20
example: 02:01
b*
field1*string
maxLength: 20
example: 01:01
field2*string
nullable: true
maxLength: 20
example: 02:01
c*
field1*string
maxLength: 20
example: 01:01
field2*string
nullable: true
maxLength: 20
example: 02:01
dpa1*
field1*string
maxLength: 20
example: 01:01
field2*string
nullable: true
maxLength: 20
example: 02:01
dpb1*
field1*string
maxLength: 20
example: 01:01
field2*string
nullable: true
maxLength: 20
example: 02:01
dqa1*
field1*string
maxLength: 20
example: 01:01
field2*string
nullable: true
maxLength: 20
example: 02:01
dqb1*
field1*string
maxLength: 20
example: 01:01
field2*string
nullable: true
maxLength: 20
example: 02:01
drb1*
field1*string
maxLength: 20
example: 01:01
field2*string
nullable: true
maxLength: 20
example: 02:01
drb3*
field1*string
maxLength: 20
example: 01:01
field2*string
nullable: true
maxLength: 20
example: 02:01
drb4*
field1*string
maxLength: 20
example: 01:01
field2*string
nullable: true
maxLength: 20
example: 02:01
drb5*
field1*string
maxLength: 20
example: 01:01
field2*string
nullable: true
maxLength: 20
example: 02:01

}]