Versions Compared

Old Version 25

changes.mady.by.user Deepa Mallapareddy

Saved on

compared with

New Version 26

changes.mady.by.user Deepa Mallapareddy

Saved on

Key

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

...

Send
retrieveSearchResultsDonors
Expand
titleRequest
pagination{...}
searchId*integer
nullable: false
minimum: 1
filters{...}
sortBystring
nullable: true
default: standardEnum:
Array [ 2 ]
Expand
titleResponse
paging*{...}
searchResults*[...]

4.4 - Full report - Donors

...

string
maxLength: 17
Send
retrieveSearchResultsDonors

Request

integer
nullable: false
minimum: 1
Expand
titleResponse
searchId
Request
searchResultsIdinteger

Response

Expand
titleResponse
searchIdinteger
nullable: false
minimum: 1

{

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

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

patient
patientId*
{...}
donor{...}

}

integer

nullable: 
true
false
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-27diagnosis*{...}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 Xabo*string
nullable: trueEnum:
Array [ 4 ]rhesus*string
nullable: trueEnum:
Array [ 2 ]weight*integer
nullable: true
minimum: 1
maximum: 999
example: 76sex*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: falselastUpdated*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{...}donorid*integer
nullable: false
example: 5176donorRegistryIon*integer
nullable: false
minimum: 1000
maximum: 9999
example: 1234abbreviationstring
example: NL-WMDA
maxLength: 24haplotypeFrequencySetId*integer
nullable: true
minimum: 0
example: 15status*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: 2019matchClass*string
example: 9/10
nullable: falsenmdpGrade*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: trueoneMismatchProbability*integer
nullable: true
minimum: 0
maximum: 100twoMismatchProbability*integer
nullable: true
minimum: 0
maximum: 100aLocusMatchProbability*integer
nullable: true
minimum: 0
maximum: 100bLocusMatchProbability*integer
nullable: true
minimum: 0
maximum: 100cLocusMatchProbability*integer
nullable: true
minimum: 0
maximum: 100drLocusMatchProbability*integer
nullable: true
minimum: 0
maximum: 100dqLocusMatchProbability*integer
nullable: true
minimum: 0
maximum: 100inexplicable*booleanmatchingInformationDpb1*{...}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: 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:
Array [ 2 ]lastContactDate*string($date)
nullable: true
minLength: 10
maxLength: 10marrowDonationsCount*integer
nullable: true
example: 0pbscDonationsCount*integer
nullable: true
example: 1dateOfBirth*string($date)
nullable: true
maxLength: 10
example: 1961-05-27donorAttributestring
maxLength: 3
nullable: truekir{...}weightinteger
nullable: true
minimum: 1
maximum: 999
example: 76heightinteger
nullable: true
minimum: 1
maximum: 999
example: 161collectionTypestring
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: 1pregnanciesCountinteger
nullable: true
example: 2reservedPatientIdstring
nullable: true
example: 1234222ssstatusEndDatestring($date)
maxLength: 10
nullable: truestatusReasonstring
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: 10registry*{...}
minimum: 1

4.5 - Search results - CBUs

...