Page History

...

Field	Details
messageId	string($uuid)
sentAtUtc	string($date-time) Server-supplied timestamp showing UTC time of Message delivery to recipient's inbox queue.
sender	string maximum: 9999 minimum: 0 maxLength: 4 minLength: 4 example: 5678 4 digit ION of sender
messageType	string Enum: Array [ 1 ]

6.1.2 Embedded Address block

...

(NEW_ADD

...

)

With this message block, the contact information of the hub's institutions, namely Financial institutions, Transplant Centers and Laboratories are shared with the partner hubs. Thus a partner hub has all the required contact information for the Institution contained in Donor Requests.

...

Suggested format	Suggested field	Description	Mapping to NEW_ADD
StringType	city	The name of the city, town, suburb, village or other community or delivery center.	City CITY Req 40
StringType	country	Country - a nation as commonly understood or generally accepted.	Country COUNTRY Req 2
StringType	district	The name of the administrative area (county).	Address Line 2 ADDR_2 Opt 40
List <StringType><StringType>	line	This component contains the house number, apartment number, street name, street direction, P.O.	Address Line 3 ADDR_3 Opt 40
Period	period	Time period when address was/is in use.	new - Opt
StringType	postalCode	A postal code designating a region defined by the postal service.	ZIP code ZIP Req 10
StringType	state	Sub-unit of a country with limited sovereignty in a federally organized country.	new - Opt
StringType	text	Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.	Address Line 1 to Address Line 3, City, Country, Zip code - Opt
Enumeration <Address<Address.AddressType>AddressType>	type	Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses. Most addresses are both.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value.	new - Req
Enumeration <Address<Address.AddressUse>AddressUse>	use	The purpose of this address.	Institution Type INST_TYPE Req 3
StringType	contactPerson	The name of the contact person.	Contact person PERSON Opt 40
StringType	`phone`	The value is a telephone number used for voice calls.	Phone Number PHONE Req 20
StringType	`fax`	The value is a fax machine.	Fax Number FAX Opt 20
StringType	`email`	The value is an email address.	Email address EMAIL Opt 60
		Not needed anymore, as the full address will be sent embedded in every request.	INST_ID Req 10
		Obsolete. Accreditation is provided by S&M on the match list.	Accreditation Opt 5

6.1.3 Embedded Patient Block

There is no "register patient" endpoint. Instead, an embedded patient block will accompany all requests. The embedded patient block looks as follows:

...

In EMDIS, the following messages are linked to the donor updates:

InfectiousDiseaseMarkerResultRequest (IDM_RES)
TypingResponseRequest (TYP_RES)
NoResultRequest (NO_RES)
ReservationResultRequest (RSV_RES

These 4 and newly 2 more (SMP_ARR and SMP_INFO) will be replaced with the Match-Connect API endpoints that have the donor details embedded in the message. Respective endpoints of IDM_RES and TYP_RES will deliver new IDM and new typing details, and all the mentioned endpoints will also inform the patient registry of the new donor status.

These donor updates are for the receiving registry (patient registry) only and will not be updated in the central HUB. So the sending (donor) registry is responsible to send a DIFF upload to the S&M system in parallel to keep information in sync.In the future a block for ADCUs may come to play.

Donor type

Payload

Adult donor

Expand

title	Donor payload...

Field	Details
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: 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 ]
isSelected*	boolean nullable: true true when this record has been marked as 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
donorAttribute	string maxLength: 3 nullable: true
kir	{...}
weight	integer nullable: true minimum: 1 maximum: 999 example: 76
height	integer nullable: true minimum: 1 maximum: 999 example: 161
collectionType	string 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 ]
transfusionsCount	integer nullable: true example: 1
pregnanciesCount	integer nullable: true example: 2
reservedPatientId	string nullable: true example: 1234222ss
statusEndDate	string($date) maxLength: 10 nullable: true
statusReason	string 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 ]
lastMedicalCheckupDate	string($date) nullable: true minLength: 10 maxLength: 10
registry*	{...}

CBU

Expand

title	CBU payload...

Field	Details
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: 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 ]
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
cordId	string nullable: true maxLength: 25 example: 9991012070433202000
donorType*	string nullable: falseEnum: Array [ 2 ]
collectionDate	string($date) minLength: 10 maxLength: 10 nullable: true example: 2021-05-27
volume*	integer example: 25 nullable: true
tncCount*	number example: 1140000000 nullable: true
cd34Count*	number example: 3900000 nullable: true
viability*	integer minimum: 0 maximum: 100 example: 97 nullable: true
attachedSegmentsCount	integer nullable: true minimum: 0 maximum: 99 example: 2
bankManufacturerIdWmda*	integer example: 5432 nullable: true
cbbAccreditationStatus*	string nullable: trueEnum: Array [ 3 ]
localId	string example: 12345ABC nullable: true
bagId	string example: ABCDE1234 nullable: true
dateOfBirth*	string($date) nullable: true maxLength: 10 example: 1961-05-27
processingDate	string($date) nullable: true minLength: 10 maxLength: 10
processingMethod	string nullable: true HES = Hydroxy-Ethyl-Starch, DGS = Density Gradient Separation, CEN = Centrifuge, FIL = Filtration, FIC = FICOL, PER = PERCOL, OTH = Other Enum: Array [ 7 ]
processingMethodType	string nullable: trueEnum: Array [ 5 ]
freezeDate	string($date) nullable: true
freezeMethod	string nullable: trueEnum: Array [ 2 ]
reservedPatientId	string nullable: true example: 1234222ss
productModifications	string nullable: trueEnum: Array [ 7 ]
bagType	string nullable: trueEnum: Array [ 4 ]
bagsCount	integer minimum: 1 maximum: 99 example: 2 nullable: true
bankDistributionIdWmda	integer nullable: true example: 1234
bacterialCultureResults	string nullable: true P = Positive N = Negative D = Not done Enum: Array [ 3 ]
fungalCultureResults	string nullable: true P = Positive N = Negative D = Not done Enum: Array [ 3 ]
hemoglobinopathyScreeningStatus	string nullable: true DN = "Screening done, normal results" DU = "Screening done, unusual findings" NS = "No screening done" CD = "Can be done at time of release" NC = "Cannot be done" DT = "Thalassemia" DD = "Drepanocytosis" Enum: Array [ 7 ]
viabilityCellType	string nullable: true type of cell tested for viability Enum: Array [ 3 ]
viabilityMethod	string nullable: true 7A = 7AAD PI = Propidium Iodide TB = Trypan Blue OT = Other Enum: Array [ 4 ]
viabilityDate	string($date) nullable: true
volumeFrozen*	integer example: 25 nullable: true
tncFrozenCount*	number example: 1020000000 nullable: true
cd34FrozenCount*	number example: 3700000 nullable: true
cfuFrozenCount	integer nullable: true minimum: 10000 maximum: 99990000 Total count of colony forming units (post processing, prior to cryopreservation)
mncFrozenCount*	number example: 430000000 nullable: true
ccr5	string nullable: trueEnum: Array [ 3 ]
kir	{...}
plasmaAliquotsCount	integer minimum: 0 maximum: 99 nullable: true Number of plasma aliquots available
redCellAliquotsCount	integer minimum: 0 maximum: 99 nullable: true Number of red cell fraction aliquots
nucleatedRbcFrozenCount	integer minimum: 0 maximum: 9999000000 nullable: true Total number of nucleated red blood cells (post processing, prior to cryopreservation)
serumAliquotsCount	integer minimum: 0 maximum: 99 nullable: true
serumQuantity	number minimum: 0 maximum: 99.9 nullable: true
plasmaQuantity	number minimum: 0 maximum: 99.9 nullable: true
ctCompletionDate	string($date) maxLength: 10
ctSampleType	string nullable: true maxLength: 2 AS = CBU Contiguous Attached Segment, WB = Whole Blood Sample, RC = Red Cell Fraction (pellet), FP = Blood Spotted Filter Paper, ED = Extracted DNA Enum: Array [ 5 ]
dnaSamplesAvailable	boolean nullable: true
otherSamplesAvailable	boolean nullable: true
donorAttribute	string maxLength: 3 nullable: true
statusEndDate	string($date) maxLength: 10 nullable: true
statusReason	string 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	{...}
registry	{...}
cbb	{...}
maternalInfo	{...}

ADCU

In the future

Here is the comparison of the DONOR_CB and the API endpoints: EMDIS vs API.xlsx

...

The WMDA will provide a standard response to request messages sent to MatchConnectMatch-Connect. It's Its structure is as follows:

Field	Details
sender	string maximum: 9999 minimum: 0 maxLength: 4 minLength: 4 example: 5678 4 digit ION of sender
deliveredAtUtc	string($date-time) Server-supplied timestamp showing time of Message delivery to recipient's inbox queue
referenceMessageId	string($uuid)
responseType	stringEnum: Array [ 3 ]
wmdaRemark	[...]

...

Page tree

Versions Compared

Old Version 78

New Version 79

Key

6.1.2 Embedded Address block

(NEW_ADD

)

6.1.3 Embedded Patient Block