Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: V1.02 - Aligned semantics with current API specs

...

Send (Post)
Retrieve (Post)
sampleArrivalRequest (comments refer to changes to the current API definition)sampleArrivalRetrieve
Expand
titleRequest...
FieldDetails
message*
Expand
title...
FieldDetails
requestIdstring
maxLength: 19
example:XX12345
referenceMessageId*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: truefalse

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 [ AS, WB, RC, FP, ED ]
remarkstring
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...
FieldDetails
wmdaId*

integer
nullable: false

example: 1234

ID provided by the WMDA

 

donor*Embedded Donor Block (donor in request)
Expand
titleResponse...
FieldDetails
metaInformation*Embedded Meta 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
messages*
Expand
title...
FieldDetails
originalMessage*

...

metaInformation*Embedded Meta Block

...