You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

4.1 - Start search

The startSearch endpoint is used to submit a search request to the Search & Match Service.  This call returns a searchId for the search. 

Send
startSearch

Request

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

Response

searchIdinteger
nullable: false
minimum: 1

4.2 - Search summary

The retrieveSearchResultssummary endpoint is used to request a search summary for a search. It also contains the status of a search and can therefore be used to check whether a search is done. 

Send
retrieveSearchResultssummary

Request:

searchId *  integer


Response: 

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 which phenotype cannot be explained by known haplotype

statistics*{...}
error*{...}
nullable: true
lociToBeConsidered[...]
lastUpdatedstring($date-time)
nullable: false
maxLength: 255

needed to help determine when patient can be automatically moved to STP state






4.3 - Search results - Donors

The retrieveSearchResultsDonors endpoint is used to retrieve search results for donors. Pagination is possible and optional filters can be provided. 

Send
retrieveSearchResultsDonors
  • searchId

Request: 


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


Response:


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

[
minItems: 0

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*
antiCmvStatusstring
nullable: trueEnum:
Array [ 7 ]
antiCmvDatestring($date)
nullable: true
maxLength: 10

date of CMV NAT test

cmvNatStatusstring
nullable: trueEnum:
Array [ 2 ]
cmvNatDatestring($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

The retrieveFullReportDonors endpoint is used to retrieve all available information for a specific donor in a search result. 

Send
retrieveSearchResultsDonors

Request:

  • searchResultsId 

Response:



searchIdinteger
nullable: false
minimum: 1
searchTypestringEnum:
[ DR ]
matchDurationinteger
minimum: 0
nullable: true
example: 30

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

patient
patientId*string
maxLength: 17
nullable: true
example: P1234XX

Organisation unique identifier for patient. Cannot be set unless "legalTerms" is set to "true". Do not use real names here.

status*string
nullable: falseEnum:
Array [ 5 ]
hla*{...}
idm*{...}
dateOfBirth*string($date)
nullable: true
maxLength: 10
example: 1961-05-27
diagnosis*{...}
diseasePhase*string
nullable: trueEnum:
Array [ 48 ]
ethnicity*string
nullable: trueEnum:
Array [ 21 ]
poolCountryCode*string
maxLength: 2
pattern: ^[A-Z]{2}
nullable: true
example: NL

ISO 3166-1 alpha-2 Country Code (capitalized)

transplantCentreId*string
maxLength: 10
nullable: true
example: TC X
abo*string
nullable: trueEnum:
Array [ 4 ]
rhesus*string
nullable: trueEnum:
Array [ 2 ]
weight*integer
nullable: true
minimum: 1
maximum: 999
example: 76
sex*string
nullable: trueEnum:
Array [ 2 ]
legalTerms*boolean
nullable: true
default: false
example: true

If not set to true, then patientId will not be stored.

wmdaId*integer
example: 123456
nullable: false
lastUpdated*string($date-time)
nullable: false
maxLength: 255

needed to help determine when patient can be automatically moved to STP state

lastViewed*string($date-time)
nullable: false
maxLength: 255

needed for sorting patients in the patient list

assignedUserName*string
minLength: 4
maxLength: 100
nullable: true
example: janethesearchcoordinator@lunarregistry.com

typically the e-mail address of the user

registry{...}
donor
id*integer
nullable: false
example: 5176
donorRegistryIon*integer
nullable: false
minimum: 1000
maximum: 9999
example: 1234
abbreviationstring
example: NL-WMDA
maxLength: 24
haplotypeFrequencySetId*integer
nullable: true
minimum: 0
example: 15
status*string
nullable: falseEnum:
Array [ 3 ]
sex*string
nullable: trueEnum:
Array [ 2 ]
ethnicity*string
nullable: trueEnum:
Array [ 21 ]
idm*{...}
abo*string
nullable: trueEnum:
Array [ 4 ]
rhesus*string
nullable: trueEnum:
Array [ 2 ]
registryAccreditationStatus*string
nullable: trueEnum:
Array [ 2 ]
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*{...}
mismatches*[...]
searchResultRecordState*string
nullable: false
default: ExistingEnum:
Array [ 4 ]
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:
Array [ 2 ]
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
donorAttributestring
maxLength: 3
nullable: true
kir{...}
weightinteger
nullable: true
minimum: 1
maximum: 999
example: 76
heightinteger
nullable: true
minimum: 1
maximum: 999
example: 161
collectionTypestring
nullable: true

Collection type, i.e. the willingness of the donor to donate in a specific manner. M = Marrow P = PBSC B = Both PBSC & Marrow

Enum:
Array [ 3 ]
transfusionsCountinteger
nullable: true
example: 1
pregnanciesCountinteger
nullable: true
example: 2
reservedPatientIdstring
nullable: true
example: 1234222ss
statusEndDatestring($date)
maxLength: 10
nullable: true
statusReasonstring
nullable: true

DO = Donor is too old, DD = Donor died, MR = Medical reasons, PR = Personal reasons, TX = After transplantation, MO = Donor has moved, UC = Unable to contact donor, OT = Other reasons, TQ = Typing questionable, UK = Unknown

Enum:
Array [ 10 ]
hla*{...}
mic*{...}
ccr5*string
nullable: trueEnum:
Array [ 3 ]
lastMedicalCheckupDatestring($date)
nullable: true
minLength: 10
maxLength: 10
registry*{...}

4.5 - Search results - CBUs

The retrieveSearchResultsDonors endpoint is used to retrieve search results for cord blood units. Pagination is possible and optional filters can be provided. 

Send
retrieveSearchResultsCBUs
  • searchId

4.6 - Full report - CBUs

The retrieveFullReportCBUs endpoint is used to retrieve all available information for a specific CBU in a search result. 

Send
retrieveFullReportCBUs
  • searchResultsId


4.7 - Suggested use of API endpoints

Below is a diagram indicated 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. 



  • No labels