Versions Compared

Old Version 259

changes.mady.by.user Rimke Postel

Saved on

compared with

New Version 260

changes.mady.by.user Rimke Postel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated "requestType" + "resultType" to correct ENUMs

...

Send (Post)
Retrieve (Post)
requestCancellationRequestrequestCancellationRetrieve
Expand
titleRequest...
FieldDetails
message*
Expand
title...
FieldDetails
requestId

string

maxLength: 19

referenceMessageId*string($uuid)
requestType*

string
maxLength: 3
nullable: false

Enum:   [ ALMgenericRequest, BLSextendedTypingRequest, CBR, IDM, RSV, TYP, WOR sampleRequest, infectiousDiseaseMarkerRequest ]

Type of request REQ_TYPE Req 3

reason

string
maxLength: 3
minLength: 3
nullable: true

Enum: [ ATX, RMT, UMT, RCT, UCT, RPT, UPT, GCC, BCC, PDC, PAT, PPR, ICH, FND, NDF, COR, HMM, DRR, OTH, UNK ]

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

...

Send (Post)
Retrieve (Post)
requestRejectedRequestrequestRejectedRetrieve
Expand
titleRequest...
FieldDetails
message*
Expand
title...
FieldDetails
requestId

string

maxLength: 19

referenceMessageId*string($uuid)
requestType*

string
maxLength: 3

Enum: [ ALMgenericRequest, BLSextendedTypingRequest, CBR, IDM, RSV, TYP, WOR sampleRequest, infectiousDiseaseMarkerRequest ]

Type of request REQ_TYPE Req 3

reason*

string
maxLength: 3
minLength: 2

Enum: [ BCC, FND, LAB, NSP, OLD, PDC, STP, TRX, OTH, DO, DD, MR, PR, TX, MO, UC, NS, OT, UK, EX, MM ]

Reason REASON Req 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

...

Send (Post)
Retrieve (Post)
resultReminderRequestresultReminderRetrieve
Expand
titleRequest...
FieldDetails
message*
Expand
title...
FieldDetails
requestId

string

maxLength: 19

referenceMessageId*string($uuid)
resultType*

string
maxLength: 9
nullable: false

Enum: [ cordBloodUnitReportResponse, infectiousDiseaseMarkerResult, workupRequestResult, reservationRequestResultextendedTypingResponse, sampleArrival, sampleResponse, extendedTypingRequest infectiousDiseaseMarkerResult, reservationResponse ]

Type of result reminded RES_TYPE Req 9

expirationDatestring($date-time)
nullable: true

Request date EXPI_DATE Opt 8 yyyy-MM-dd [or yyyyMMdd]

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

...