Page History

...

Send (Post)

Retrieve (Post)

extendedTypingRequestRequest

extendedTypingRequestRetrieve

Expand

title	Request...

Field

Details

request*

Expand

title	...

Field	Details
requestId	string maxLength: 15 example:XX12345
resolutionRequired*	string example: "a": high Replacement of the single string based resolutionRequired.
address	Embedded Address Block
isUrgent*	boolean Urgent request URGENT Opt 1
remark	string maxLength: 120 nullable: true example: the patient case is very urgent Remark REMARK Opt 120

receivingRegistry*

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

4 digit ION of the receiving registry

patient*

Embedded Patient Block

donor*

Donor IDEmbedded Donor Block (donor in request)

Expand

title	Response...

Field	Details
wmdaResponse*	Embedded WMDA Response Block

Expand

title	Request...

limit

integer
default: 100

shouldPeek

boolean
default: false

Set to true if you want messages to remain available after retrieval

messageSequenceNumber

integer
examplet: 12345

Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned.

Expand

title	Response...

Field	Details
generalInformation*	Embedded General Information Block
originalMessage*	{...}
metaInformation*	Embedded Meta Block

...

Send (Post)

Retrieve (Post)

extendedTypingResponseRequest

extendedTypingResponseRetrieve

Expand

title	Request...

Field

Details

response*

Expand

title	...

Field	Details
requestId	string maxLength: 15 example:XX12345
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

receivingRegistry*

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

4-digit ION of the receiving registry

donor*

Embedded Donor Block (donor in response)

patient*

Patient ID

Expand

title	Response...

Field	Details
wmdaResponse*	Embedded WMDA Response Block

Expand

title	Request...

limit

integer
default: 100

shouldPeek

boolean
default: false

Set to true if you want messages to remain available after retrieval

messageSequenceNumber

integer
examplet: 12345

Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned.

Expand

title	Response...

generalInformation*	Embedded General Information Block
originalMessage*	{...}
metaInformation*	Embedded Meta Block

...

Send (Post)

Retrieve (Post)

sampleRequestRequest

sampleRequestRetrieve

Expand

title	Request

Field

Details

request*

Expand

title	...

requestId	string maxLength: 15 example:XX12345
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
isUrgent	boolean Urgent request URGENT Opt 1
remark	string maxLength: 120 nullable: true example: the patient case is very urgent Remark REMARK Opt 120

receivingRegistry*

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

4-digit ION of the receiving registry

patient*

Embedded Patient Block

donor*

Donor IDEmbedded Donor Block (donor in request)

Expand

title	Response

Field	Details
wmdaResponse*	Embedded WMDA Response Block

Expand

title	Request...

limit

integer
default: 100

shouldPeek

boolean
default: false

Set to true if you want messages to remain available after retrieval

messageSequenceNumber

integer
examplet: 12345

Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned.

Expand

title	Response...

Field	Details
generalInformation*	Embedded General Information Block
originalMessage*	{...}
metaInformation*	Embedded Meta Block

...

Send (Post)

Retrieve (Post)

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

sampleInfoRetrieve

Expand

title	Request...

message*

Expand

title	...

requestId	string maxLength: 15 example:XX12345
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

receivingRegistry*

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

4-digit ION of the receiving registry

patient*

Patient ID

donor*

Donor IDEmbedded Donor Block (donor in request)

Expand

title	Response...

Field	Details
wmdaResponse*	Embedded WMDA Response Block

Expand

title	Request...

limit

integer
default: 100

shouldPeek

boolean
default: false

Set to true if you want messages to remain available after retrieval

messageSequenceNumber

integer
examplet: 12345

Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned.

Expand

title	Response...

generalInformation*	Embedded General Information Block
originalMessage*	{...}
metaInformation*	Embedded Meta Block

...

Send (Post)

Retrieve (Post)

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

sampleArrivalRetrieve

Expand

title	Request...

Field

Details

message*

Expand

title	...

Field	Details
requestId	string maxLength: 15 example:XX12345
referenceCode*	string($uuid)
arrivalDate*	string($date-time) Proposed date of sample arrival ARRV_DATE Req 8
collectionDate*	string($date-time) nullable: true Donor blood collection date COLL_DATE Opt 8
labelId*	string maxLength: 19 Verbatim verification typing (VT) sample label ID D_LABEL_ID Req 19
ctSampleType*	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

receivingRegistry*

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

4 digit ION of the receiving registry

patient*

Patient ID

donor*

Donor IDEmbedded Donor Block (donor in request)

Expand

title	Response...

Field	Details
wmdaResponse*	Embedded WMDA Response Block

Expand

title	Request...

limit

integer
default: 100

shouldPeek

boolean
default: false

Set to true if you want messages to remain available after retrieval

messageSequenceNumber

integer
examplet: 12345

Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned.

Expand

title	Response...

Field	Details
generalInformation*	Embedded General Information Block
originalMessage*	{...}
metaInformation*	Embedded Meta Block

...

Send (Post)

Retrieve (Post)

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

sampleResponseRetrieve

Expand

title	Request...

Field

Details

response*

Expand

title	...

Field	Details
requestId	string maxLength: 15 example:XX12345
referenceCode*	string($uuid)
hlaNomenclatureVersion*	string default: 3 Major version of HLA Nomenclature HLA_NOM_VER Req 7
hla	{...}
idm	{...}
abo	string nullable: trueEnum: Array [ 4 ]
rhesus	string nullable: trueEnum: Array [ 2 ]
donorStillOfInterest	string maxLength: 1 Donor still of interest DON_ACCPT Req 1 Enum: Array [ 2 ]

receivingRegistry*

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

4 digit ION of the receiving registry

patient*

Patient ID

donor*

Donor IDEmbedded Donor Block (donor in request)

Expand

title	Response...

Field	Details
wmdaResponse*	Embedded WMDA Response Block

Expand

title	Request...

limit

integer
default: 100

shouldPeek

boolean
default: false

Set to true if you want messages to remain available after retrieval

messageSequenceNumber

integer
examplet: 12345

Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned.

Expand

title	Response...

generalInformation*	Embedded General Information Block
originalMessage*	{...}
metaInformation*	Embedded Meta Block

...

Send (Post)

Retrieve (Post)

infectiousDiseaseMarkerRequest

infectiousDiseaseMarkerRequestRetrieve

Expand

title	Request...

Field

Details

response*

Expand

title	...

Field	Details
requestId	string maxLength: 15 example:XX12345
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
remark	string maxLength: 120 nullable: true example: Please also test for SARS-CoV-2 Remark REMARK Opt 120

receivingRegistry*

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

4-digit ION of the receiving registry

patient*

Embedded Patient Block

donor*

Donor IDEmbedded Donor Block (donor in request)

Expand

title	Response...

Field	Details
wmdaResponse*	Embedded WMDA Response Block

Expand

title	Request...

limit

integer
default: 100

shouldPeek

boolean
default: false

Set to true if you want messages to remain available after retrieval

messageSequenceNumber

integer
examplet: 12345

Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned.

Expand

title	Response...

Field	Details
generalInformation*	Embedded General Information Block
originalMessage*	{...}
metaInformation*	Embedded Meta Block

...

Send (Post)

Retrieve (Post)

infectiousDiseaseMarkerResultRequest

infectiousDiseaseMarkerResultRetrieve

Expand

title	Request...

Field

Details

response*

Expand

title	...

Field	Details
requestId	string maxLength: 15 example:XX12345
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

receivingRegistry*

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

4-digit ION of the receiving registry

donor*

Embedded Donor Block (donor in response)

patient*

Patient ID

Expand

title	Response...

Field	Details
wmdaResponse*	Embedded WMDA Response Block

Expand

title	Request...

limit

integer
default: 100

shouldPeek

boolean
default: false

Set to true if you want messages to remain available after retrieval

messageSequenceNumber

integer
examplet: 12345

Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned.

Expand

title	Response...

Field	Details
generalInformation*	Embedded General Information Block
originalMessage*	{...}
metaInformation*	Embedded Meta Block

...

Send (Post)

Retrieve (Post)

reservationRequestRequest

reservationRequestRetrieve

Expand

title	Request...

Field

Details

request*

Expand

title	...

Field

Details

requestId

string

maxLength: 15

expirationDate

string($date-time)
nullable: true

Request date EXPI_DATE Opt 8 yyyy-MM-dd [or yyyyMMdd]

remark

string
maxLength: 120
nullable: true

Remark REMARK Opt 120

receivingRegistry*

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

4-digit ION of the receiving registry

patient*

Embedded Patient Block

donor*

Donor IDEmbedded Donor Block (donor in request)

Expand

title	Response...

Field	Details
wmdaResponse*	Embedded WMDA Response Block

Expand

title	Request...

limit

integer
default: 100

shouldPeek

boolean
default: false

Set to true if you want messages to remain available after retrieval

messageSequenceNumber

integer
examplet: 12345

Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned.

Expand

title	Response...

generalInformation*	Embedded General Information Block
originalMessage*	{...}
metaInformation*	Embedded Meta Bloc k

...

Send (Post)

Retrieve (Post)

reservationResponseRequest

reservationResponseRetrieve

Expand

title	Request...

Field

Details

response*

Expand

title	...

Field	Details
requestId	string maxLength: 15
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

receivingRegistry*

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

4-digit ION of the receiving registry

patient*

Patient ID

donor*

Embedded Donor Block (donor in response)

Expand

title	Response...

Field	Details
wmdaResponse*	Embedded WMDA Response Block

Expand

title	Request...

limit

integer
default: 100

shouldPeek

boolean
default: false

Set to true if you want messages to remain available after retrieval

messageSequenceNumber

integer
examplet: 12345

Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned.

Expand

title	Response...

Field	Details
generalInformation*	Embedded General Information Block
originalMessage*	{...}
metaInformation*	Embedded Meta Block

...

Send (Post)

Retrieve (Post)

reservationReleaseRequest

reservationReleaseRetrieve

Expand

title	Request...

Field

Details

request*

Expand

title	...

Field	Details
requestId	string maxLength: 15
referenceCode*	string($uuid)
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

receivingRegistry*

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

4-digit ION of the receiving registry

patient*

Patient ID

donor*

Donor IDEmbedded Donor Block (donor in request)

Expand

title	Response...

Field	Details
wmdaResponse*	Embedded WMDA Response Block

Expand

title	Request...

limit

integer
default: 100

shouldPeek

boolean
default: false

Set to true if you want messages to remain available after retrieval

messageSequenceNumber

integer
examplet: 12345

Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned.

Expand

title	Response...

Field	Details
generalInformation*	Embedded General Information Block
originalMessage*	{...}
metaInformation*	Embedded Meta Block

...

Send (Post)

Retrieve (Post)

requestCancellationRequest

requestCancellationRetrieve

Expand

title	Request...

Field

Details

message*

Expand

title	...

Field	Details
requestId	string maxLength: 15
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

receivingRegistry*

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

4-digit ION of the receiving registry

patient*

Patient ID

donor*

Donor IDEmbedded Donor Block (donor in request)

Expand

title	Response...

Field	Details
wmdaResponse*	Embedded WMDA Response Block

Expand

title	Request...

limit

integer
default: 100

shouldPeek

boolean
default: false

Set to true if you want messages to remain available after retrieval

messageSequenceNumber

integer
examplet: 12345

Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned.

Expand

title	Response...

Field	Details
generalInformation*	Embedded General Information Block
originalMessage*	{...}
metaInformation*	Embedded Meta Block

...

Send (Post)

Retrieve (Post)

requestRejectedRequest

requestRejectedRetrieve

Expand

title	Request...

Field

Details

message*

Expand

title	...

Field	Details
requestId	string maxLength: 15
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

receivingRegistry*

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

4-digit ION of the receiving registry

patient*

Patient ID

donor*

Donor IDEmbedded Donor Block (donor in response)

Expand

title	Response...

Field	Details
wmdaResponse*	Embedded WMDA Response Block

Expand

title	Request...

limit

integer
default: 100

shouldPeek

boolean
default: false

Set to true if you want messages to remain available after retrieval

messageSequenceNumber

integer
examplet: 12345

Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned.

Expand

title	Response...

generalInformation*	Embedded General Information Block
originalMessage*	{...}
metaInformation*	Embedded Meta Block

...

Send (Post)

Retrieve (Post)

resultReminderRequest

resultReminderRetrieve

Expand

title	Request...

Field

Details

message*

Expand

title	...

Field	Details
requestId	string maxLength: 15
referenceCode*	string($uuid)
resultType*	string maxLength: 9 Type of result reminded RES_TYPE Req 9
expirationDate	string($date-time) nullable: true Request date EXPI_DATE Opt 8 yyyy-MM-dd [or yyyyMMdd]
remark	string maxLength: 120 nullable: true Remark REMARK Opt 120

receivingRegistry*

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

4-digit ION of the receiving registry

patient*

Patient ID

donor*

Donor IDEmbedded Donor Block (donor in request)

Expand

title	Response...

Field	Details
wmdaResponse*	Embedded WMDA Response Block

Expand

title	Request...

limit

integer
default: 100

shouldPeek

boolean
default: false

Set to true if you want messages to remain available after retrieval

messageSequenceNumber

integer
examplet: 12345

Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned.

Expand

title	Response...

Field	Details
generalInformation*	Embedded General Information Block
originalMessage*	{...}
metaInformation*	Embedded Meta Block

...

Send (Post)

Retrieve (Post)

genericRequestRequest

genericRequestRetrieve

Expand

title	Request...

Field

Details

request*

Expand

title	...

Field

Details

requestId

string

maxLength: 15

reason

string

reason for the generic request

receivingRegistry*

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

4-digit ION of the receiving registry

patient*

Embedded Patient Block

donor*

Donor IDEmbedded Donor Block (donor in request)

Expand

title	Response...

Field	Details
wmdaResponse*	Embedded WMDA Response Block

Expand

title	Request...

limit

integer
default: 100

shouldPeek

boolean
default: false

Set to true if you want messages to remain available after retrieval

messageSequenceNumber

integer
examplet: 12345

Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned.

Expand

title	Response...

Field	Details
generalInformation*	Embedded General Information Block
originalMessage*	{...}
metaInformation*	Embedded Meta Block

...

Page tree

Versions Compared

Old Version 241

New Version 242

Key