Versions Compared

Key

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

...

Send (Post)
Retrieve (Post)
/api/v2/extendedTypingResponseRequest/api/v2/extendedTypingResponseRetrieve
Expand
titleRequest...
Field

Details

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

etSampleTypestring
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 ]
remarkstring
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
patient*Patient 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

...