Versions Compared

Old Version 255

changes.mady.by.user Rimke Postel

Saved on

compared with

New Version 256

changes.mady.by.user Rimke Postel

Saved on

Key

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

...

Send (Post)Retrieve (Post)
sampleRequestRequest sampleRequestRetrieve
Expand
titleRequest
FieldDetails
request*
Expand
title...
requestIdstring
maxLength: 19
example:XX12345
prod1*{...}
prod2{...}
prod3{...}
prod4{...}
earliestDateCanReceive*string($date-time)

Earliest date of sample reception REC_DATE1 Req 8 yyyy-MM-dd [or yyyyMMdd]

latestDateCanReceivestring($date-time)
nullable: true

Latest date of sample reception REC_DATE2 Opt 8 yyyy-MM-dd [or yyyyMMdd]

acceptableReceptionDaysOfWeek*

integer
nullable: truefalse
minLength: 7
maxLength: 7
pattern: ^[01]{7}$
example: 1111100

Weekdays acceptable for reception. Binary fixed length string for the 7 days in the week. E.g., 1110000 means acceptable days for reception are Monday, Tuesday and Wednesday, not acceptable days are Thursday, Friday, Saturday or Sunday.

institutionToSendSampleTo*Embedded Address Block
institutionPaying*Embedded Address Block
isUrgentboolean

Urgent request URGENT Opt 1

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*Embedded Patient Block
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
examplet: 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

...

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: truefalse

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:false

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
examplet: 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

...

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

Major version of HLA Nomenclature HLA_NOM_VER Req 7

hla{...}
idm{...}
abo

string
nullable: true

Enum:
Array [ A, B, O, AB ]

rhesus

string
nullable: true

Enum:
Array [ P, N ]

donorStillOfIntereststring
maxLength: 1

Donor still of interest DON_ACCPT Req 1

Enum:
Array [ Y, N ]
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
examplet: 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

...

Send (Post)
Retrieve (Post)
infectiousDiseaseMarkerResultRequestinfectiousDiseaseMarkerResultRetrieve
Expand
titleRequest...
FieldDetails
response*
Expand
title...
FieldDetails
requestIdstring
maxLength: 19
example:XX12345
referenceMessageId*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 are in Data Dictionary

sampleExtractionDate*string($date-time)
nullable: truefalse

Date of sample extraction D_EXTR_DATE Opt 8

donorCcr5Statusstring
maxLength: 2
nullable: true

Donor CCR5 status D_CCR5 Opt 2

donorWeightKginteger($int32)
maximum: 999
minimum: 0
nullable: true

Donor weight in kilograms D_WEIGHT Opt 3

donorHeightCminteger($int32)
maximum: 999
minimum: 0
nullable: true
example: 175

Donor height in centimetres D_HEIGHT Opt 3

numberOfTransfusionsinteger($int32)
maximum: 9
minimum: 0
nullable: true

Number of transfusions D_NMBR_TRANS Opt 1

numberOfPregnanciesinteger($int32)
maximum: 9
minimum: 0
nullable: true

Number of pregnancies D_NMBR_PREG Opt 1

idm{...}
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

donor*Embedded Donor Block (donor in response)
patient*
Expand
title...
FieldDetails
wmdaId*

integer
nullable: false
example: 1234

ID provided by the WMDA

 

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
examplet: 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

...

Send (Post)
Retrieve (Post)
reservationReleaseRequestreservationReleaseRetrieve
Expand
titleRequest...
FieldDetails
request*
Expand
title...
FieldDetails
requestId

string

maxLength: 19

referenceMessageId*string($uuid)
reason*string
maxLength: 3
minLength: 3
nullable: truefalse

Reason of request cancellation REASON_CNCL Opt 3

remarkstring
maxLength: 1000
nullable: true
example: the patient case is very urgent

Remark REMARK Opt 120

receivingRegistry*string
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
examplet: 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

...