Versions Compared

Key

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

...

SendRetrieve
sampleInfoRequest (comments refer to changes to the current API definition)sampleInfoRetrieve
Expand
titleRequest...
message*
Expand
title...
referenceCode*string($uuid)
informationType*string
maxLength: 3

minLength: 3

Information Type INFO_TYPE Req 3

Enum:
Array [ 12 ]
remarkstring
nullable: true

Remark REMARK Opt 120

receivingRegistry*integer
maximum: 9999

minimum: 0

maxLength: 4

minLength: 4

example: 1234

4-digit ION of the receiving registry

patient*Patient ID
donor*Embedded Donor Block
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 transmit the proposed date of the sample arrival.

SendRetrieve
sampleArrivalRequest (comments refer to changes to the current API definition)sampleArrivalRetrieve
Expand
titleRequest...
FieldDetails
message*
Expand
title...
FieldDetails
referenceCode*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

etSampleTypectSampleType*string
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

patient*Patient ID
donor*Embedded Donor Block
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

5.6 - Sample Response (SMP_RES)

...