Versions Compared

Key

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

...

This message is used to transmit the results of the sample testing.

Send (Post)
Retrieve (Post)
sampleResponseRequest (comments refer to changes to the current API definition)sampleResponseRetrieve
Expand
titleRequest...
FieldDetails
response*
Expand
title...
FieldDetails
requestingRegistryReferenceCodestring
maxLength: 15
example:XX12345
referenceCode*string($uuid)
hlaNomenclatureVersion*string
default: 3

Major version of HLA Nomenclature HLA_NOM_VER Req 7

hla{...}
idm{...}
abostring
nullable: true
Enum:
Array [ 4 ]
rhesusstring
nullable: true
Enum:
Array [ 2 ]
donorStillOfIntereststring
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 ID
Expand
titleResponse...
FieldDetails
wmdaResponse*Embedded WMDA Response Block
Expand
titleRequest...
limitinteger
default: 100

shouldPeekboolean
default: false

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

messageSequenceNumber

integer
e
xamplet: 12345

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

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

...