Page History

Versions Compared

Key

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

...

Send

retrieveSearchResultsDonors

Request

Expand

title	Request

pagination	{...}
searchId*	integer nullable: false minimum: 1
filters	{...}
sortBy	string nullable: true default: standardEnum: Array [ 2 ]

Expand

pagination

{...}

searchId*

integer
nullable: false
minimum: 1

filters

title	Response

paging*

{...}

sortBystring
nullable: true
default: standardEnum:
Array [ 2 ]

Response

Expand

title	Response

searchId

integer
nullable: false
minimum: 1

paging*

limit*	integer default: 100 minimum: 0
offset*	integer default: 0 minimum: 0 example: 0
totalCount*	integer minimum: 0 example: 2

searchResults*

[
minItems: 0

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*

integer
nullable: true
minimum: 0
example: 15

status*

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*

antiCmvStatus	string nullable: trueEnum: Array [ 7 ]
antiCmvDate	string($date) nullable: true maxLength: 10 date of CMV NAT test
cmvNatStatus	string nullable: trueEnum: Array [ 2 ]
cmvNatDate	string($date) nullable: true maxLength: 10 date of CMV NAT test

abo*

string
nullable: trueEnum:
[ A, B, O, AB ]

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*

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*

number
minimum: 0
maximum: 100
nullable: true
example: 54

resolutionString*

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

donorId*

string
nullable: true
example: ABC1234
maxLength: 25

donorType*

string
nullable: falseEnum:
[ D, B ]

lastContactDate*

string($date)
nullable: true
minLength: 10
maxLength: 10

marrowDonationsCount*

integer
nullable: true
example: 0

pbscDonationsCount*

integer
nullable: true
example: 1

dateOfBirth*

string($date)
nullable: true
maxLength: 10
example: 1961-05-27

hla*

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

}

]

4.4 - Full report - Donors

...