Page History

...

Send

Retrieve

extendedTypingRequestRequest

extendedTypingRequestRetrieve

Expand

title	Request...

Field

Details

request

Expand

title	...

Field	Details
requestDate*	string($date-time) Request date REQ_DATE Req 8 yyyy-MM-dd [or yyyyMMdd]
resolutionRequired*	string maxLength: 11 minLength: 11 example: HHHHMMM-H-H A character string with a fixed length in which each position represents an HLA locus. The coding of the resolution required for every position is: S = serological L = DNA low resolution M = DNA medium resolution H = DNA high resolution - (hyphen) = not requested. The character string is interpreted from left to right, with position 1 as the leftmost position. The positions for the HLA loci are defined as Position 1: HLA-A Position 2: HLA-B Position 3: HLA-C Position 4: HLA-DRB1 Position 5: HLA-DRB3 Position 6: HLA-DRB4 Position 7: HLA-DRB5 Position 8: HLA-DQA1 Position 9: HLA-DQB1 Position 10: HLA-DPA1 Position 11: HLA-DPB1
urgent*	boolean Urgent request URGENT Opt 1
remark	string maxLength: 120 nullable: true example: the patient case is very urgent Remark REMARK Opt 120

address

Embedded Address Block

recipient

integer
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4 digit ION of the recipient

patient

Embedded Patient Block

donor

Donor ID

Expand

title	Response...

Field	Details
wmdaResponse	Embedded WMDA Response Block

Expand

title	Request...

No parameters specified

Expand

title	Response...

Field	Details
originalMessage	{...}
metaInformation	Embedded Meta Block

...

Send

Retrieve

extendedTypingResponseRequest

extendedTypingResponseRetrieve

Expand

title	Request...

Field

Details

response

Expand

title	...

Field	Details
referenceCode	string($uuid)
hlaNomenclatureVersion	string default: 3 Major version of HLA Nomenclature HLA_NOM_VER Req 7
etSampleType	string nullable: true Type of sample. 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 ]
remark	string maxLength: 120 nullable: true example: the patient case is very urgent Remark REMARK Opt 120

recipient

integer
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4-digit ION of the recipient

donor

Embedded Donor Block

patient

Patient ID

Expand

title	Response...

Field	Details
wmdaResponse	Embedded WMDA Response Block

Expand

title	Request...

No parameters specified

Expand

title	Response...

originalMessage	{...}
metaInformation	Embedded Meta Block

...

Send

Retrieve

sampleRequestRequest (comments refer to changes to the current API definition)

sampleRequestRetrieve

Expand

title	Request

Field

Details

request

Expand

title	...

requestDate	string($date-time) Request date REQ_DATE Req 8 yyyy-MM-dd [or yyyyMMdd]
prod1	{...}
prod2	{...}
prod3	{...}
prod4	{...}
earliestDateCanReceive	string($date-time) Earliest date of sample reception REC_DATE1 Req 8 yyyy-MM-dd [or yyyyMMdd]
latestDateCanReceive	string($date-time) nullable: true Latest date of sample reception REC_DATE2 Opt 8 yyyy-MM-dd [or yyyyMMdd]
acceptableReceptionDaysOfWeek	integer nullable: true minLength: 7 maxLength: 7 example: 1111100 Weekdays acceptable for reception. Binary fixed length string for the 7 days in the week. E.g., 1110000 means acceptable days for reception are Monday, Tuesday and Wednesday, not acceptable days are Thursday, Friday, Saturday or Sunday.
institutionToSendSampleTo	Embedded Address Block
institutionPaying	Embedded Address Block
urgent	boolean Urgent request URGENT Opt 1
acknowledgementId	string maxLength: 17 nullable: true example: 1234567890abcdefg Acknowledgement ID ACK_ID Opt 17
remark	string maxLength: 120 nullable: true example: the patient case is very urgent Remark REMARK Opt 120

recipient

integer
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4-digit ION of the recipient

patient*

Embedded Patient Block

donor*

Donor ID

Expand

title	Response

Field	Details
wmdaResponse	Embedded WMDA Response Block

Expand

title	Request...

No parameters specified

Expand

title	Response...

Field	Details
originalMessage	{...}
metaInformation	Embedded Meta Block

...

Send

Retrieve

sampleInfoRequest (comments refer to changes to the current API definition)

sampleInfoRetrieve

Expand

title	Request...

referenceCode*	string($uuid)
informationType*	string maxLength: 3 minLength: 3 Information Type INFO_TYPE Req 3 Enum: Array [ 12 ]
remark	string nullable: true Remark REMARK Opt 120
recipient	integer maximum: 9999 minimum: 0 maxLength: 4 minLength: 4 example: 1234 4-digit ION of the recipient
patient*	Patient ID
donor*	Embedded Donor Block

Expand

title	Response...

Field	Details
wmdaResponse	Embedded WMDA Response Block

Expand

title	Request...

No parameters specified

Expand

title	Response...

originalMessage	{...}
metaInformation	Embedded Meta Block

...

Send

Retrieve

infectiousDiseaseMarkerRequest

infectiousDiseaseMarkerRequestRetrieve

Expand

title	Request...

Field	Details
referenceCode*	string($uuid)
markerAsArray	[...]
marker*	integer maxLength: 19 minLength: 19 example: 111110000111 Binary fixed length string in which each position represents a test to be requested: details in Data Dictionary
institutionPaying*	Embedded Address Block
acknowledgementId	string maxLength: 17 nullable: true example: 1234567890abcdefg Acknowledgement ID ACK_ID Opt 17
remark	string maxLength: 120 nullable: true example: Please also test for SARS-CoV-2 Remark REMARK Opt 120
recipient*	integer maximum: 9999 minimum: 0 maxLength: 4 minLength: 4 example: 1234 4-digit ION of the recipient
patient*	Embedded Patient Block
donor*	Donor ID

Expand

title	Response...

Field	Details
wmdaResponse	Embedded WMDA Response Block

Expand

title	Request...

No parameters specified

Expand

title	Response...

Field	Details
originalMessage	{...}
metaInformation	Embedded Meta Block

...

Send

Retrieve

infectiousDiseaseMarkerResultRequest

infectiousDiseaseMarkerResultRetrieve

Expand

title	Request...

Field	Details
referenceCode*	string($uuid)
markerAsArray	[...]
marker	integer maxLength: 19 minLength: 19 example: 111110000111 Binary fixed length string in which each position represents a test to be requested: details are in Data Dictionary
sampleExtractionDate	string($date-time) nullable: true Date of sample extraction D_EXTR_DATE Opt 8
donorCcr5Status	string maxLength: 2 nullable: true Donor CCR5 status D_CCR5 Opt 2
donorWeightKg	integer($int32) maximum: 999 minimum: 0 nullable: true Donor weight in kilograms D_WEIGHT Opt 3
donorHeightCm	integer($int32) maximum: 999 minimum: 0 nullable: true example: 175 Donor height in centimetres D_HEIGHT Opt 3
numberOfTransfusions	integer($int32) maximum: 9 minimum: 0 nullable: true Number of transfusions D_NMBR_TRANS Opt 1
numberOfPregnancies	integer($int32) maximum: 9 minimum: 0 nullable: true Number of pregnancies D_NMBR_PREG Opt 1
idm	{...}
remark	string maxLength: 120 nullable: true Remark REMARK Opt 120
recipient	integer maximum: 9999 minimum: 0 maxLength: 4 minLength: 4 example: 1234 4-digit ION of the recipient
donor*	Embedded Donor Block
patient*	Patient ID

Expand

title	Response...

Field	Details
wmdaResponse	Embedded WMDA Response Block

Expand

title	Request...

No parameters specified

Expand

title	Response...

Field	Details
originalMessage	{...}
metaInformation	Embedded Meta Block

...

Send

Retrieve

reservationRequestRequest

reservationRequestRetrieve

Expand

title	Request...

Field

Details

payload*

Expand

title	...

Field	Details
patient*	Embedded Patient Block
donor	Donor ID
requestDate*	string($date-time) Request date REQ_DATE Req 8 yyyy-MM-dd [or yyyyMMdd]
referenceCode*	string($uuid)
expirationDate	string($date-time) nullable: true Request date EXPI_DATE Opt 8 yyyy-MM-dd [or yyyyMMdd]
acknowledgementId	string maxLength: 17 nullable: true example: 1234567890abcdefg Acknowledgement ID ACK_ID Opt 17
remark	string maxLength: 120 nullable: true Remark REMARK Opt 120

recipient*

string
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4-digit ION of the recipient

correlationGuid*

string($uuid)

The sender generated GUID used to correlate response acknowledgement

Expand

title	Response...

Field	Details
wmdaResponse	Embedded WMDA Response Block

Expand

title	Request...

No parameters specified

Expand

title	Response...

originalMessage	{...}
metaInformation	Embedded Meta Bloc k

...

Send

Retrieve

reservationResponseRequest

reservationResponseRetrieve

Expand

title	Request...

Field

Details

sender*

string
maxLength: 4
minLength: 4
example: 5678

4 digit ION of the sender

sentAtUtc*

string($date-time)

Server-supplied timestamp showing UTC time sender posted (i.e. sent) MessageRequest.

deliveredAtUtc*

string($date-time)

Server-supplied timestamp showing UTC time of Message delivery to recipient's inbox queue.

payload*

Expand

title	...

Field	Details
patient*	Patient ID
donor*	Embedded Donor Block
referenceCode*	string($uuid)
expirationDate	string($date-time) nullable: true Date expiration of reservation EXPI_DATE Opt 8 yyyy-MM-dd [or yyyyMMdd]
confirmed*	boolean Confirmation of reservation CONFIRM Req 1
remark	string maxLength: 120 nullable: true Remark REMARK Opt 120

recipient*

string
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4-digit ION of the recipient

correlationGuid*

string($uuid)

The sender generated GUID used to correlate response acknowledgement

messageType

string

Message types supported by WmdaConnect

Enum:
Array [ 21 ]

Expand

title	Response...

Field	Details
wmdaResponse	Embedded WMDA Response Block

Expand

title	Request...

No parameters specified

Expand

title	Response...

Field	Details
originalMessage	{...}
metaInformation	Embedded Meta Block

...

Send

Retrieve

reservationReleaseRequest

reservationReleaseRetrieve

Expand

title	Request...

Field

Details

sender*

string
maxLength: 4
minLength: 4
example: 5678

4-digit ION of the sender

sentAtUtc*

string($date-time)

Server-supplied timestamp showing UTC time sender posted (i.e. sent) MessageRequest.

deliveredAtUtc*

string($date-time)

Server-supplied timestamp showing UTC time of Message delivery to recipient's inbox queue.

payload*

Expand

title	...

Field	Details
patient*	Patient ID
donor*	Donor ID
referenceCode*	string($uuid)
requestType*	string maxLength: 3 Type of request REQ_TYPE Req 3
reason	string maxLength: 3 minLength: 3 nullable: true Reason of request cancellation REASON_CNCL Opt 3
remark	string maxLength: 120 nullable: true Remark REMARK Opt 120

recipient*

string
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4-digit ION of the recipient

correlationGuid*

string($uuid)

Sender generated GUID used to correlate response acknowledgment

messageType

string

Message types supported by WmdaConnect

Enum:
Array [ 21 ]

Expand

title	Response...

Field	Details
wmdaResponse	Embedded WMDA Response Block

Expand

title	Request...

No parameters specified

Expand

title	Response...

Field	Details
originalMessage	{...}
metaInformation	Embedded Meta Block

...

Send

Retrieve

requestCancellationRequest

requestCancellationRetrieve

Expand

title	Request...

Field

Details

sender*

string
maxLength: 4
minLength: 4
example: 5678

4-digit ION of the sender

sentAtUtc*

string($date-time)

Server-supplied timestamp showing UTC time sender posted (i.e. sent) MessageRequest.

deliveredAtUtc*

string($date-time)

Server-supplied timestamp showing UTC time of Message delivery to recipient's inbox queue.

payload*

Expand

title	...

Field	Details
patient*	Patient ID
donor*	Donor ID
referenceCode*	string($uuid)
requestType*	string maxLength: 3 Type of request REQ_TYPE Req 3
reason	string maxLength: 3 minLength: 3 nullable: true Reason of request cancellation REASON_CNCL Opt 3
remark	string maxLength: 120 nullable: true Remark REMARK Opt 120

recipient*

string
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4-digit ION of the recipient

correlationGuid*

string($uuid)

Sender generated GUID used to correlate response acknowledgment

messageType

string

Message types supported by WmdaConnect

Enum:
Array [ 21 ]

Expand

title	Response...

Field	Details
wmdaResponse	Embedded WMDA Response Block

Expand

title	Request...

No parameters specified

Expand

title	Response...

Field	Details
originalMessage	{...}
metaInformation	Embedded Meta Block

...

Send

Retrieve

requestRejectedRequest

requestRejectedRetrieve

Expand

title	Request...

Field

Details

payload*

Expand

title	...

Field	Details
patient*	Patient ID
donor*	Embedded Donor Block
referenceCode*	string($uuid)
requestType*	string maxLength: 3 Type of request REQ_TYPE Req 3
reason*	string maxLength: 3 minLength: 2 Reason REASON Req 3
remark	string maxLength: 120 nullable: true Remark REMARK Opt 120

recipient*

string
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4-digit ION of the recipient

correlationGuid*

string($uuid)

Sender generated GUID used to correlate response acknowledgment

Expand

title	Response...

Field	Details
wmdaResponse	Embedded WMDA Response Block

Expand

title	Request...

No parameters specified

Expand

title	Response...

originalMessage	{...}
metaInformation	Embedded Meta Block

...

Page tree

Versions Compared

Old Version 142

New Version 143

Key