Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Changed requestingRegistryReferenceCode into requestId (V1.01)

...

  • A patient registration Embedded Patient Block is sent together with each request. This block contains both the wmdaId and the patientId of the patient.

  • Next to the actual request information, whenever institutions are needed, they are sent explicitly as an Embedded Address Block.
  • (warning) The requested donor has to be reserved at the remote hub and reported back to the requesting registry by a Embedded Donor Block within a Reservation Response reflecting the changed donor status (c.f. DONOR_CB with D_STATUS = ”RS”).

  • All changes in the donors (change of status, updated typing, or IDMs) resulting from the requests are reported back in an Embedded Donor Block within the respective message, e.g. updated HLA information resulting from a Extended Typing Request in a Extended Typing Result. A separate update must be made to the Search & Match system with the updated donor data to ensure up-to-date master data. More information on how to do so may be found here.
  • ReferenceCode: In order to couple messages to the same request, e.g. Sample Request and its results, all the request-related messages responding to the original request must have a referenceMessageId as part of the message.
    • The message ID (referenceMessageId) of the request message is used as a reference code for the rest of the request-related message flow.

    • Next to the technical referenceMessageId requests, a human-readable reference code (requestingRegistryReferenceCoderequestId) is used for end-user recognition (communication outside the automated system)
      • The requestingRegistryReferenceCode requestId is optional
      • The requestingRegistryReferenceCode requestId is part of the original message block
      • The requestingRegistryReferenceCode requestId will be generated by the sending registry
      • The requestingRegistryReferenceCode requestId will only be used for human-to-human communication (e.g. could be used on printed invoices)
      • Once requestingRegistryReferenceCode requestId is sent, it must be used in all subsequent request message exchanges
  • Each field inherited from EMDIS Semantics contains a comment describing its purpose in EMDIS and its original name to assist in the transition from EMDIS to Match-Connect.
  • Paragraph Request + Response Flows depicts the new message flows.

...

Send (Post)
Retrieve (Post)
extendedTypingRequestRequestextendedTypingRequestRetrieve
Expand
titleRequest...
FieldDetails
request*
Expand
title...
FieldDetails
requestingRegistryReferenceCoderequestId

string
maxLength: 15
example:XX12345

resolutionRequired*string
example: "a": high

Replacement of the single string based resolutionRequired.

addressEmbedded Address Block
isUrgent*boolean

Urgent request URGENT Opt 1

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*Embedded Patient Block
donor*Donor 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...
FieldDetails
generalInformation*Embedded General Information Block
originalMessage*{...}
metaInformation*Embedded Meta Block

...

Send (Post)
Retrieve (Post)
extendedTypingResponseRequestextendedTypingResponseRetrieve
Expand
titleRequest...
Field

Details

response*
Expand
title...
FieldDetails
requestingRegistryReferenceCoderequestIdstring
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

...

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

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

latestDateCanReceive*string($date-time)
nullable: true

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

acceptableReceptionDaysOfWeek*integer
nullable: true

minLength: 7

maxLength: 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: 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*Embedded Patient Block
donor*Donor 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...
FieldDetails
generalInformation*Embedded General Information Block
originalMessage*{...}
metaInformation*Embedded Meta Block

...

Send (Post)
Retrieve (Post)
sampleInfoRequest (comments refer to changes to the current API definition)sampleInfoRetrieve
Expand
titleRequest...
message*
Expand
title...
requestingRegistryReferenceCoderequestIdstring
maxLength: 15
example:XX12345
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 wmdaId

ID provided by the WMDA

donor*Donor 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

...

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

ctSampleType*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*Donor 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...
FieldDetails
generalInformation*Embedded General Information Block
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
requestingRegistryReferenceCoderequestIdstring
maxLength: 15
example:XX12345
referenceCode*string($uuid)
hlaNomenclatureVersion*string
default: 3

Major version of HLA Nomenclature HLA_NOM_VER Req 7

hla{...}
idm{...}
abostring
nullable: true
Enum:
Array [ 4 ]
rhesusstring
nullable: true
Enum:
Array [ 2 ]
donorStillOfIntereststring
maxLength: 1

Donor still of interest DON_ACCPT Req 1

Enum:
Array [ 2 ]
receivingRegistry*integer
maximum: 9999

minimum: 0

maxLength: 4

minLength: 4

example: 1234

4 digit ION of the receiving registry

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

...

Send (Post)
Retrieve (Post)
infectiousDiseaseMarkerRequestinfectiousDiseaseMarkerRequestRetrieve
Expand
titleRequest...
FieldDetails
response*
Expand
title...
FieldDetails
requestingRegistryReferenceCoderequestIdstring
maxLength: 15
example:XX12345
markerAsArray[...]
marker*integer
maxLength: 19

minLength: 19

example: 111110000111

Binary fixed length string in which each position represents a test to be requested: details in Data Dictionary

institutionPaying*Embedded Address Block
remarkstring
maxLength: 120

nullable: true

example: Please also test for SARS-CoV-2

Remark REMARK Opt 120

receivingRegistry*integer
maximum: 9999

minimum: 0

maxLength: 4

minLength: 4

example: 1234

4-digit ION of the receiving registry

patient*Embedded Patient Block
donor*Donor 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...
FieldDetails
generalInformation*Embedded General Information Block
originalMessage*{...}
metaInformation*Embedded Meta Block

...

Send (Post)
Retrieve (Post)
infectiousDiseaseMarkerResultRequestinfectiousDiseaseMarkerResultRetrieve
Expand
titleRequest...
FieldDetails
response*
Expand
title...
FieldDetails
requestingRegistryReferenceCoderequestIdstring
maxLength: 15
example:XX12345
referenceCode*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: true

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

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

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...
FieldDetails
generalInformation*Embedded General Information Block
originalMessage*{...}
metaInformation*Embedded Meta Block

...

Send (Post)
Retrieve (Post)
reservationRequestRequestreservationRequestRetrieve
Expand
titleRequest...
FieldDetails
request*
Expand
title...
FieldDetails
requestingRegistryReferenceCoderequestId

string

maxLength: 15

expirationDatestring($date-time)
nullable: true

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

remarkstring
maxLength: 120

nullable: true

Remark REMARK Opt 120

receivingRegistry*string
maximum: 9999

minimum: 0

maxLength: 4

minLength: 4

example: 1234

4-digit ION of the receiving registry

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

...

Send (Post)
Retrieve (Post)
reservationResponseRequestreservationResponseRetrieve
Expand
titleRequest...
FieldDetails
response*
Expand
title...
FieldDetails
requestingRegistryReferenceCoderequestId

string

maxLength: 15

referenceCode*string($uuid)
expirationDatestring($date-time)
nullable: true

Date expiration of reservation EXPI_DATE Opt 8 yyyy-MM-dd [or yyyyMMdd]

confirmed*boolean

Confirmation of reservation CONFIRM Req 1

remarkstring
maxLength: 120

nullable: true

Remark REMARK Opt 120

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

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...
FieldDetails
generalInformation*Embedded General Information Block
originalMessage*{...}
metaInformation*Embedded Meta Block

...

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

string

maxLength: 15

referenceCode*string($uuid)
reason*string
maxLength: 3

minLength: 3

nullable: true

Reason of request cancellation REASON_CNCL Opt 3

remarkstring
maxLength: 120

nullable: true

Remark REMARK Opt 120

receivingRegistry*string
maximum: 9999

minimum: 0

maxLength: 4

minLength: 4

example: 1234

4-digit ION of the receiving registry

patient*Patient ID
donor*Donor 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...
FieldDetails
generalInformation*Embedded General Information Block
originalMessage*{...}
metaInformation*Embedded Meta Block

...

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

string

maxLength: 15

referenceCode*string($uuid)
requestType*string
maxLength: 3

Type of request REQ_TYPE Req 3

reasonstring
maxLength: 3

minLength: 3

nullable: true

Reason of request cancellation REASON_CNCL Opt 3

remarkstring
maxLength: 120

nullable: true

Remark REMARK Opt 120

receivingRegistry*string
maximum: 9999

minimum: 0

maxLength: 4

minLength: 4

example: 1234

4-digit ION of the receiving registry

patient*Patient ID
donor*Donor 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...
FieldDetails
generalInformation*Embedded General Information Block
originalMessage*{...}
metaInformation*Embedded Meta Block

...

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

string

maxLength: 15

referenceCode*string($uuid)
requestType*string
maxLength: 3

Type of request REQ_TYPE Req 3

reason*string
maxLength: 3

minLength: 2

Reason REASON Req 3

remarkstring
maxLength: 120

nullable: true

Remark REMARK Opt 120

receivingRegistry*string
maximum: 9999

minimum: 0

maxLength: 4

minLength: 4

example: 1234

4-digit ION of the receiving registry

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

...

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

string

maxLength: 15

referenceCode*string($uuid)
resultType*string
maxLength: 9

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

nullable: true

Remark REMARK Opt 120

receivingRegistry*string
maximum: 9999

minimum: 0

maxLength: 4

minLength: 4

example: 1234

4-digit ION of the receiving registry

patient*Patient ID
donor*Donor 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...
FieldDetails
generalInformation*Embedded General Information Block
originalMessage*{...}
metaInformation*Embedded Meta Block

...

Send (Post)
Retrieve (Post)
genericRequestRequestgenericRequestRetrieve
Expand
titleRequest...
FieldDetails
request*
Expand
title...
FieldDetails
requestingRegistryReferenceCoderequestId

string

maxLength: 15

reason

string

reason for the generic request

receivingRegistry*string
maximum: 9999

minimum: 0

maxLength: 4

minLength: 4

example: 1234

4-digit ION of the receiving registry

patient*Embedded Patient Block
donor*Donor 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...
FieldDetails
generalInformation*Embedded General Information Block
originalMessage*{...}
metaInformation*Embedded Meta Block

...