Versions Compared

Key

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

...

SendRetrieve
sampleResponseRequest (comments refer to changes to the current API definition)sampleResponseRetrieve
Expand
titleRequest...
FieldDetails
response*
Expand
title...
FieldDetails
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

Expand
titleResponse...
originalMessage*{...}
metaInformation*Embedded Meta Block

...

This message is used to request infectious disease marker test results of the selected donor.

SendRetrieve
infectiousDiseaseMarkerRequestinfectiousDiseaseMarkerRequestRetrieve
Expand
titleRequest...
FieldDetails
response*
Expand
title...
FieldDetails
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
acknowledgementIdstring
maxLength: 17

nullable: true

example: 1234567890abcdefg

Acknowledgement ID ACK_ID Opt 17

remarkstring
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 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

No parameters specified

Expand
titleResponse...
FieldDetails
originalMessage*{...}
metaInformation*Embedded Meta Block

Rules:

...