Page History

...

Send (Post)

Retrieve (Post)

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

sampleInfoRetrieve

Expand

title	Request...

message*

Expand

title	...

requestId	string maxLength: 19 example:XX12345
referenceMessageId*	string($uuid)
informationType*	string maxLength: 3 minLength: 3 Information Type INFO_TYPE Req 3 Enum: Array [ BMP, BMM, SCP, SCM, ABS, MUL, UBC, RPE, CMV, ROI, MED, OTH ]
remark	string maxLength: 1000 nullable: true example: the patient case is very urgent Remark REMARK Opt 120

receivingRegistry*

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

4-digit ION of the receiving registry

patient*

Expand

title	...

Field

Details

wmdaId*

integer
nullable: false
example: 1234

ID provided by the WMDA

donor*

Embedded Donor Block (donor in request)

Expand

title	Response...

Field	Details
metaInformation*https://share.wmda.info/x/4ABtGQ#id-6Administration-6.1.1EmbeddedMetablock	Embedded Meta 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

messages*

Expand

title	...

Field	Details
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: 19 example:XX12345
referenceMessageId*	string($uuid)
hlaNomenclatureVersion*	string default: 3 Major version of HLA Nomenclature HLA_NOM_VER Req 7
hla	{...}
idm	{...}
abo	string nullable: true Enum: Array [ A, B, O, AB ]
rhesus	string nullable: true Enum: Array [ P, N ]
donorStillOfInterest	string maxLength: 1boolean Donor still of interest DON_ACCPT Req 1 Enum: Array [ Y, N ]

receivingRegistry*

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

4 digit ION of the receiving registry

patient*

Expand

title	...

Field

Details

wmdaId*

integer
nullable: false
example: 1234

ID provided by the WMDA

donor*

Embedded Donor Block (donor in request)

Expand

title	Response...

Field	Details
metaInformation*	Embedded Meta 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

messages*

Expand

title	...

Field	Details
originalMessage*	...
metaInformation*	Embedded Meta Block

...

Send (Post)

Retrieve (Post)

infectiousDiseaseMarkerRequest

infectiousDiseaseMarkerRequestRetrieve

Expand

title	Request...

Field

Details

request*

Expand

title	...

Field	Details
requestId	string maxLength: 19 example:XX12345
markerAsArraymarker*	[{...]	marker*	integer maxLength: 19 minLength: 19 example: 111110000111Binary fixed length string in which each position represents a test to be requested: details in Data Dictionary}
institutionPaying*	Embedded Address Block
remark	string maxLength: 1000 nullable: true example: the patient case is very urgent Remark REMARK Opt 120

receivingRegistry*

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

4-digit ION of the receiving registry

patient*

Embedded Patient Block

donor*

Embedded Donor Block (donor in request)

Expand

title	Response...

Field	Details
metaInformation*	Embedded Meta 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

messages*

Expand

title	...

Field	Details
originalMessage*	...
metaInformation*	Embedded Meta Block

...

Send (Post)

Retrieve (Post)

infectiousDiseaseMarkerResultRequest

infectiousDiseaseMarkerResultRetrieve

Expand

title	Request...

Field

Details

response*

Expand

title	...

Field	Details
requestId	string maxLength: 19 example:XX12345
referenceMessageId*	string($uuid)
markerAsArraymarker*	[...]
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(	sampleExtractionDate*	string($date-time) nullable:false 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: 1000 nullable: true example: the patient case is very urgent Remark REMARK Opt 120

receivingRegistry*

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

4-digit ION of the receiving registry

donor*

Embedded Donor Block (donor in response)

patient*

Expand

title	...

Field

Details

wmdaId*

integer
nullable: false
example: 1234

ID provided by the WMDA

Expand

title	Response...

Field	Details
metaInformation*	Embedded Meta 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

messages*

Expand

title	...

Field	Details
originalMessage*	...
metaInformation*	Embedded Meta Block

...

Send (Post)

Retrieve (Post)

reservationReleaseRequest

reservationReleaseRetrieve

Expand

title	Request...

Field

Details

request*

Expand

title	...

Field	Details
requestId	string maxLength: 19
referenceMessageId*	string($uuid)
reason*	string maxLength: 3 minLength: 3 nullable: false Enum: [ ATX, RMT, UMT, RCT, UCT, RPT, UPT, GCC, BCC, PDC, PAT, PPR, ICH, FND, NDF, COR, HMM, DRR, OTH, UNK ] Reason of request cancellation REASON_CNCL Opt 3
remark	string maxLength: 1000 nullable: true example: the patient case is very urgent Remark REMARK Opt 120

receivingRegistry*

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

4-digit ION of the receiving registry

patient*

Expand

title	...

Field

Details

wmdaId*

integer
nullable: false
example: 1234

ID provided by the WMDA

donor*

Embedded Donor Block (donor in request)

Expand

title	Response...

Field	Details
metaInformation*	Embedded Meta 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

messages*

Expand

title	...

Field	Details
originalMessage*	...
metaInformation*	Embedded Meta Block

...

Send (Post)

Retrieve (Post)

requestCancellationRequest

requestCancellationRetrieve

Expand

title	Request...

Field

Details

message*

Expand

title	...

Field	Details
requestId	string maxLength: 19
referenceMessageId*	string($uuid)
requestType*	string maxLength: 3 nullable: false Enum: [ ALM, BLS, CBR, IDM, RSV, TYP, WOR ] Type of request REQ_Type of request REQ_TYPE Req 3
reason	string maxLength: 3 minLength: 3 nullable: true Enum: [ ATX, RMT, UMT, RCT, UCT, RPT, UPT, GCC, BCC, PDC, PAT, PPR, ICH, FND, NDF, COR, HMM, DRR, OTH, UNK ] Reason of request cancellation REASON_CNCL Opt 3
remark	string maxLength: 1000 nullable: true example: the patient case is very urgent Remark REMARK Opt 120

receivingRegistry*

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

4-digit ION of the receiving registry

patient*

Expand

title	...

Field

Details

wmdaId*

integer
nullable: false
example: 1234

ID provided by the WMDA

donor*

Embedded Donor Block (donor in request)

Expand

title	Response...

Field	Details
metaInformation*	Embedded Meta 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

messages*

Expand

title	...

Field	Details
originalMessage*	...
metaInformation*	Embedded Meta Block

...

Send (Post)

Retrieve (Post)

requestRejectedRequest

requestRejectedRetrieve

Expand

title	Request...

Field

Details

message*

Expand

title	...

Field	Details
requestId	string maxLength: 19
referenceMessageId*	string($uuid)
requestType*	string maxLength: 3 Enum: [ ALM, BLS, CBR, IDM, RSV, TYP, WOR ] Type of request REQ_TYPE Req 3
reason*	string maxLength: 3 minLength: 2 Enum: [ BCC, FND, LAB, NSP, OLD, PDC, STP, TRX, OTH, DO, DD, MR, PR, TX, MO, UC, NS, OT, UK, EX, MM ] Reason REASON Req 3
remark	string maxLength: 1000 nullable: true example: the patient case is very urgent Remark REMARK Opt 120

receivingRegistry*

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

4-digit ION of the receiving registry

patient*

Expand

title	...

Field

Details

wmdaId*

integer
nullable: false
example: 1234

ID provided by the WMDA

donor*

Embedded Donor Block (donor in request)

Expand

title	Response...

Field	Details
metaInformation*	Embedded Meta 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

messages*

Expand

title	...

Field	Details
originalMessage*	...
metaInformation*	Embedded Meta Block

...

Send (Post)

Retrieve (Post)

resultReminderRequest

resultReminderRetrieve

Expand

title	Request...

Field

Details

message*

Expand

title	...

Field	Details
requestId	string maxLength: 19
referenceMessageId*	string($uuid)
resultType*	string maxLength: 9 nullable: false Enum: [ cordBloodUnitReportResponse, infectiousDiseaseMarkerResult, workupRequestResult, reservationRequestResult, sampleArrival, sampleResponse, extendedTypingRequest ] 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: 1000 nullable: true example: the patient case is very urgent Remark REMARK Opt 120

receivingRegistry*

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

4-digit ION of the receiving registry

patient*

Expand

title	...

Field

Details

wmdaId*

integer
nullable: false
example: 1234

ID provided by the WMDA

donor*

Embedded Donor Block (donor in request)

Expand

title	Response...

Field	Details
metaInformation*	Embedded Meta 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

messages*

Expand

title	...

Field	Details
originalMessage*	...
metaInformation*	Embedded Meta Block

...

Send (Post)

Retrieve (Post)

genericRequestRequest

genericRequestRetrieve

Expand

title	Request...

Field

Details

request*

Expand

title	...

Field

Details

requestId

string

maxLength: 19

reason

string

reason for the generic request. Free text.

receivingRegistry*

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

4-digit ION of the receiving registry

patient*

Embedded Patient Block

donor*

Embedded Donor Block (donor in request)

Expand

title	Response...

Field	Details
metaInformation*	Embedded Meta 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

messages*

Expand

title	...

Field	Details
originalMessage*	...
metaInformation*	Embedded Meta Block

...

Page tree

Versions Compared

Old Version 256

New Version 257

Key