Versions Compared

Key

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

Table of Contents
maxLevel1

General considerations: 

  • ReferenceCode: In order to couple messages to the same request, e.g. VT request (SMP_REQ) and its results (SMP_ARR, SMP_RES) all messages following the request must have a referenceCode as part of the message.

    • The message ID (correlationGUID) of the request message (TYP_REQ, IDM_REQ, SMP_REQ, RSV_REQ, etc...) will be used as the 'referenceCode' for the rest of the request related message flow.

5.1 - Extended Typing Request

This message is used to request an extended typing of a donor (adult, adcu, cbu?). It will primarily contain information about what to type and for which donor.
Added to that a patient block (ref?) containing up-to-date information about the patient, and an address block (ref?) containing up-to-date contact-information about the needed institution(s). 
Expected return message is 'typing result' (5.2) or 'request rejected' (5.14).
Check paragraph '5.18 Extended Typing' for the related message flow.

  • All changes in the donors (change of status, updated typing, or IDMs) resulting from the requests are reported back in an Embedded Donor Block (donor in response) within the respective message, e.g. updated HLA information resulting from an Extended Typing Request in an 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.
  • requestId: 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 (requestId) is used for end-user recognition (communication outside the automated system)
      • The requestId is optional
      • The requestId is part of the original message block
      • The requestId will be generated by the sending registry
      • The requestId will only be used for human-to-human communication (e.g. could be used on printed invoices)
      • Once 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.

5.1 - Extended Typing Request (TYP_REQ)

This message is used to request an extended typing of a donor (adult, ADCU, CBU). It primarily contains information about what to type and for which donor. 
The expected return messages are Reservation ResponseExtended Typing Result and/or Request Rejected.

SendRetrieveTypingRequestRequestTypingRequestRetrieve
Expand
titleRequest...
FieldDetails
request
Expand
title...
FieldDetails
requestDate*string($date-time)

Request date REQ_DATE Req 8 yyyy-MM-dd [or yyyyMMdd]

resolutionRequired*string
maxLength: 11

minLength: 11

example: HHHHMMM-H-H

Character string with fixed length in which each position represents a HLA locus. The coding of the resolution required for every position is: S = serological L = DNA low resolution M = DNA medium resolution H = DNA high resolution - (hyphen) = not requested The character string is interpreted from left to right, with position 1 as the leftmost position. The positions for the HLA loci are defined as: Position 1: HLA-A Position 2: HLA-B Position 3: HLA-C Position 4: HLA-DRB1 Position 5: HLA-DRB3 Position 6: HLA-DRB4 Position 7: HLA-DRB5 Position 8: HLA-DQA1 Position 9: HLA-DQB1 Position 10: HLA-DPA1 Position 11: HLA-DPB1

urgent*boolean

Urgent request URGENT Opt 1

remarkstring
maxLength: 120

nullable: true

example: patient case is very urgent

Remark REMARK Opt 120

addressEmbedded Address Block
recipientinteger
maximum: 9999

minimum: 0

maxLength: 4

minLength: 4

example: 1234

4 digit ION of recipient

patientEmbedded Patient Block
donorEmbedded Donor Block
Send (Post)
Retrieve (Post)
extendedTypingRequestRequestextendedTypingRequestRetrieve
Expand
titleRequest...
FieldDetails
request*
Expand
title...
FieldDetails
requestId

string
maxLength: 19
example:XX12345

resolutionRequired*string
example: "a": high

Replacement of the single string based resolutionRequired.

address*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
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
wmdaResponse{...} Expand
titleRequest...
No parameters specified
generalInformation*Embedded General Information Block
messages*
Expand
title
Response
...
FieldDetails
originalMessage*
{
}


metaInformation*Embedded Meta Block

Rules

Examples for field resolutionRequired:

...

string-enum with the following options

  • low = DNA low resolution

...

  • medium = DNA medium (intermediate) resolution
  • high = DNA high resolution

  • Intermediate resolution (medium) translates to non-high resolution.
  • Combinations are possible, i.e. several loci may be requested in one message.

The address block must provide the necessary details for the donor registry to send an invoice for the service. In EMDIS, this used to be the address of the financial institution

Intermediate resolution (M) translates to the non-high resolution.

The coding schema theoretically allows more combinations than the previous bitstring (e.g. non-high DRB1 typing). The actually valid combinations have to be published in the national rules of each registry. The local user interfaces will have to take care that no invalid or previously undefined requests are issued.

Combinations are possible, i.e. several loci may be requested in one message.

The appropriate action if the typing request cannot be accepted or has to be changed by the recipientby the receiving registry, e.g. due to national rules, is to inform the requesting side what was done. If only the only the resolution was changed (the sender sending registry will receive something different than ordered - either more either more or less) or only a part of the requested loci were accepted (the sender sending registry will only receive parts receive parts of what was ordered): send MSG_RSP containing a message response (see 6 - Administration v1.0)  containing the warning.

5.2 - Extended Typing Results (TYP_RES)

This message is used to send the results of the initial ET request Extended Typing Request back to the requesting registry. 
Check paragraph '5.18 Extended Typing' for the related message flows.

Send (Post)
Retrieve
TypingResponseTypingResponseRetrieveExtended Typing Resultpatient (wmdaId
(Post)
referenceCode 
extendedTypingResponseRequest
hlaNomenclatureVersion
extendedTypingResponseRetrieve
etSampleType
Expand
  • remark
  • Donor Block (6.1.4)
    • Meta Block (6.1.1)
    • Payload TypingResponse

    Rules

    After the TypingResults (TYP_RES) message which includes an embedded donor (DONOR_CB) block, 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.

    5.3 - Sample Request

    The SampleRequestRequest (and SampleRequestRetrieve) is used to request a VT for a specific donor/product for a patient. The message, as all requests, has an embedded 'register_patient' part. Next to the actual request information the institutions needed are sent explicitly as an embedded 'addressBlock' (6.1).

    The messageId of this message will be used as 'referenceCode' for the rest of the request related message flow.

    EMDIS Semantic:

    The fields ”earliest and latest date of sample reception” represent the lower and upper limit of a period of time in which the blood sample has to be received. If the second date is missing the sample may be received any time after the first date.

    The field ACC_DAYS is a binary field with position 1 corresponding to Monday and position 7 corresponding to Sunday. A set bit means acceptable day, an unset bit means not acceptable day. For example, 1110000 means acceptable days for reception are Monday, Tuesday and Wednesday, not acceptable days are Thursday, Friday, Saturday and Sunday. The default value is 1111100 (accept all working days).

    The quantity for the first product is optional when requesting DNA from a cord blood unit. In all other requests, the quantity fields for any of the corresponding product fields are required if a product is requested.

    Number of tubes requested in a sample request or marrow request:

    The maximum amount of material, requested in one sample request or pre-collection sample request, is 100 ml, if not stated otherwise in the national rules. If the number of tubes is unassigned, not given in the request, the default value number of tubes is one.

    ...

    Expand
    titleRequest
    FieldDetails
    request
    Expand
    title...
    requestDatestring($date-time)

    Request date REQ_DATE Req 8 yyyy-MM-dd [or yyyyMMdd]

    prod1{...}
    prod2{...}
    prod3{...}
    prod4{...}
    earliestDateCanReceivestring($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]

    acceptableReceptionDaysOfWeekinteger
    nullable: true

    minLength: 7

    maxLength: 7

    example: 1111100

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

    institutionToSendSampleToEmbedded Address Block
    institutionPayingEmbedded Address Block
    urgentboolean

    Urgent request URGENT Opt 1

    acknowledgementIdstring
    maxLength: 17

    nullable: true

    example: 1234567890abcdefg

    Acknowledgement ID ACK_ID Opt 17

    remarkstring
    maxLength: 120

    nullable: true

    example: patient case is very urgent

    Remark REMARK Opt 120

    recipientinteger
    maximum: 9999

    minimum: 0

    maxLength: 4

    minLength: 4

    example: 1234

    4 digit ION of recipient

    patient*Embedded Patient Block
    donorEmbedded Donor Block
    Expand
    titleResponse
    deliveredAtUtcstring($date-time)

    Server-supplied timestamp showing time of Message delivery to recipient's inbox queue

    referenceMessageIdstring($uuid)
    responseTypestringEnum:
    Array [ 3 ]
    remark[...]

    ...

    Expand
    titleRequest...

    No parameters specified

    Expand
    titleResponse...
    FieldDetails
    originalMessage{...}
    metaInformationEmbedded Meta Block
    titleRequest...
    Field

    Details

    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

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

    5.3 - Sample Request (SMP_REQ)

    This message is used to request a sample to be used for verification typing in the lab of the sending registry. 

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

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

    Rules:

    • The fields ”earliest and latest date of sample reception” represent the lower and upper limit of the period of time in which the blood sample has to be received. If the second date is missing, the sample may be received any time after the first date.
    • The quantity for the first product is optional when requesting DNA from a cord blood unit. In all other requests, the quantity fields for any of the corresponding product fields are required if a product is requested.
    • A number of tubes requested in a sample request or marrow request:
      • The maximum amount of material, requested in one sample request or pre-collection sample request is 100 ml, if not stated otherwise in the national rules of the donor registry.
      • If the number of tubes is unassigned, and not given in the request, the default value number of tubes is one.
    • A typical response to the Sample Request message is the Sample Arrival Date message. In addition to that, it is mandatory (by the accreditation standards) that the donor registry also sends an IDM Result message to inform the patient registry of the known diseases of the donor.

    5.4 - Sample Information (SMP_INFO)

    This message is used to send relevant secondary information that may arise in the context of the sample request.

    Send (Post)
    Retrieve (Post)
    sampleInfoRequest (comments refer to changes to the current API definition)sampleInfoRetrieve
    Expand
    titleRequest...
    message*
    Expand
    title...
    requestIdstring
    maxLength: 19
    example:XX12345
    referenceMessageId*string($uuid)
    informationType*string
    maxLength: 3

    minLength: 3

    Information Type INFO_TYPE Req 3

    Enum:

    Array [ BMP, BMM, SCP, SCM, ABS, MUL, UBC, RPE, CMV, ROI, MED, OTH ]

    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

    Rules:

    • The message can only be exchanged in one direction: from the donor side to the patient side.
    • Sample information is always referencing a sample request.
    • Sample information is only valid as long as the referenced sample request is considered ”open” and the donor is reserved for this patient after the sample request.
    • A request is considered ”open” as long as the patient registry has neither reported the sample results nor a Request Rejected message nor a request cancellation.
    • There might be several sample information messages within the context of one sample request. Subsequent sample information is regarded as new or additional information and not as updates.

    5.5 - Sample Arrival (SMP_ARR)

    This message is used to transmit the proposed date of the sample arrival.

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

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

    5.6 - Sample Response (SMP_RES)

    This message is used to transmit the results of the sample testing.

    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 ]

    donorStillOfInterestboolean

    Donor still of interest DON_ACCPT Req 1

    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

    Rules:

    • donorStillOfInterest = ”N” means: the donor can be released immediately.
    • donorStillOfInterest = ”Y” means: please prolong donor reservation according to your national rules.
    • The fields for the infectious disease markers are included in this message in order to give the transplant centers the possibility to report the results of IDMs they might have tested.
    • If Sample Results cannot be sent then a Request Rejected message should be sent with the reason field populated to explain why.

    5.7 - Infectious Disease Marker Request (IDM_REQ)

    This message is used to request infectious disease marker test results of the selected donor.

    Send (Post)
    Retrieve (Post)
    infectiousDiseaseMarkerRequestinfectiousDiseaseMarkerRequestRetrieve
    Expand
    titleRequest...
    FieldDetails
    request*
    Expand
    title...
    FieldDetails
    requestIdstring
    maxLength: 19
    example:XX12345
    marker*{...}
    institutionPaying*Embedded Address Block
    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
    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

    Rules:

    • Several distinct requests for the same patient/donor pair at a time are possible, for example, a verification typing and a CMV status, but each request has to be answered by an individual IDM Results, i.e. results must not be ”concatenated” to a single result message. Multiple IDM
      requests for the same patient/donor pair have to be disjoint (i.e. may not contain identical markers). The occurrence of multiple requests should be an exception. Normally, all markers required should be requested within one message.

    5.8 - Infectious Disease Marker Results (IDM_RES)

    This message is used to send the results of the IDM request back to the requesting registry. 

    Send (Post)
    Retrieve (Post)
    infectiousDiseaseMarkerResultRequestinfectiousDiseaseMarkerResultRetrieve
    Expand
    titleRequest...
    FieldDetails
    response*
    Expand
    title...
    FieldDetails
    requestIdstring
    maxLength: 19
    example:XX12345
    referenceMessageId*string($uuid)
    marker*[...]
    sampleExtractionDate*string($date-time)
    nullable:false

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

    Rules

    • The common use of the IDM Results message is in response to the Sample Request message, in addition to the shipment of the donor blood sample. Please note there may be a charge involved with this service. If a fee is charged, it may come as a separate item or might be included in the price of the sample shipment. Such IDM Results messages can be sent via a regular EMDIS message - the remote hub must be able to handle it appropriately. The IDM Results must have the same requestId as the Sample Request message.
    • IDM Results message can be generated in response to two different message requests:
      • Sample Request does not specify what set of infectious disease markers to be tested
      • IDM Request does specify what set of infectious disease markers to be tested
    • The field marker is a required field.
    • For those hubs reporting infectious disease markers during verification typing, the marker field should contain the IDMs actually tested. There is a fixed-length binary field for the IDM Results message. The blood group may also be reported.
    • IDM results can also be reported as a part of the Sample Results message by the hub (transplant center) that requested the blood sample. This is to give the transplant centers the possibility to report the results of IDMs they might have tested.

    5.9 - Reservation Request (RSV_REQ)

    This message is used to request the reservation of a donor for a specific patient for a upcoming transplantation at the receiving registry. The patient registry can ask for a specific reservation period by making use of the optional field expirationDate. 

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

    string

    maxLength: 19

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

    5.4 - Sample Information

    The SampleInfoRequest (and SampleInfoRetrieve) is used to sent relevant secondary information which may arise in the context of sample request.

    The referenceCode is the 'messageId' from the request message.

    EMDIS Semantic:

    The SMP_INFO message can only be exchanged in one direction: from donor side to patient side.

    Sample information is always referencing a sample request.

    Sample information is only valid as long as the referenced sample request is considered as ”open” or the donor is reserved for this patient after the sample request.

    A request is considered as ”open” as long as the patient registry has neither reported the sample result nor a ”service cannot be performed (NO_RES)” information nor a request cancellation.

    There might be several sample information messages within the context of one sample request. Subsequent sample information is regarded as new or additional information and not as updates.

    SendRetrieveSampleInfoRequest (comments refer to changes to the current API definition)SampleInfoRetrieve Expand
    titleRequest...
    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

    recipientinteger
    maximum: 9999

    minimum: 
    0
    maxLength: 4

    minLength: 4

    example: 1234

    4-digit ION of

    recipientpatient*Embedded Patient Block
    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.

    donor*Embedded Donor Block


    Expand
    titleResponse...
    FieldDetailswmdaResponse
    generalInformation*Embedded General Information Block
    messages*
    {...}
    Expand
    title
    Request
    ...
    No parameters specified
    Field
    Expand
    titleResponse...
    originalMessage{
    Details
    originalMessage*
    }


    metaInformation*Embedded Meta Block

    5.

    ...

    10 - Reservation Response (RSV_RES)

    This message is used to notify the requesting patient registry if the Reservation Request has been confirmed by the donor registry OR if the donor reservation was performed after another request. The donor registry reports back the expirationDate. This might differ from the expirationDate of the Reservation Request message due to local rules or regulations at the donor registry side. The expirationDate in the Reservation Response reflects the "true" reservation period.

    The SampleArrivalRequest (and SampleArrivalRetrieve) is used to transmit proposed date of sample arrival.

    The messageId of this message will be used as 'referenceCode' for the rest of the request related message flow.

    EMDIS Semantic:

    This message is sent in response to a SMP_REQ and indicates the arrival date of the sample.

    SendRetrieveSampleArrivalRequest (comments refer to changes to the current API definition)SampleArrivalRetrieve
    Expand
    titleRequest...
    FieldDetails
    message Expand
    title...
    FieldDetailsreferenceCode*string($uuid)arrivalDate*string($date-time)

    Proposed date of sample arrival ARRV_DATE Req 8

    collectionDatestring($date-time)
    nullable: true

    Donor blood collection date COLL_DATE Opt 8

    response*
    Expand
    title...
    FieldDetails
    requestId
    labelId*

    string

    maxLength: 19

    Verbatim verification typing (VT) sample label ID D_LABEL_ID Req 19etSampleTypestring
    nullable: true
    referenceMessageId*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

    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
    1000
    nullable: true

    example:
     
    the patient case is very urgent

    Remark REMARK Opt 120

    recipient
    receivingRegistry*
    integer
    string
    maximum: 9999
    minimum:
     
    1000
    maxLength: 4

    minLength: 4

    example: 1234

    4-digit ION of

    recipientpatientEmbedded Patient Block

    the receiving registry

    patient*
    Expand
    title...
    FieldDetails
    wmdaId*

    integer
    nullable: false

    example: 1234

    ID provided by the WMDA

     

    donor*
    donor
    Expand
    titleResponse...
    Field
    DetailswmdaResponse
    Details
    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
    title
    Request
    Response...
    No parameters specified
    generalInformation*Embedded General Information Block
    messages*
    Expand
    title
    Response
    ...
    FieldDetails
    originalMessage
    {...}metaInformationEmbedded Meta Block

    5.6 - Sample Results

    The SampleResponseRequest (and SampleResponseRetrieve) is used to transmit the results of the sample request.

    The messageId of this message will be used as 'referenceCode' for the rest of the request related message flow.

    DON_ACCPT = ”N” means: donor can be released immediately.

    DON_ACCPT = ”Y” means: please reserve the donor according to your national rules. If possible, the donor should be reserved at the remote hub and reported back to the requesting hub by adding a DONOR_DIFF block to the message STATUS = ”RS”.  For all the other patients the donor should be updated by sending a DIFF update to S&M. A delta search will then update the search results for those patients.

    Suggested text: "Y" means: please prolong donor reservation according to your national rules.

    EMDIS Semantic:

    The fields for the infectious disease markers are included in this message in order to give the transplant centres the possibility to report the results of IDMs they might have tested.

    If no SMP_RES can be sent then a NO_RES should be sent with the reason field populated to explain why.

    *

    ...

    metaInformation*Embedded Meta Block

    5.11 - Reservation Release Request (new message)

    The patient registry sends this message to inform the donor registry that a donor can be released from the reservation when it is no longer needed (e.g. patient is deceased or was transplanted with another donor). This should be used if the donor reservation was confirmed in response to some request. If the reservation has not been confirmed then a Request Cancellation message should be used.

    This is a change request with respect to the current procedure and should be handled as such as it has implications on local systems.

    There is no response to this message except for the automated acknowledgment.

    Send (Post)
    Retrieve (Post)
    reservationReleaseRequestreservationReleaseRetrieve
    SendRetrieveSampleResponseRequest (comments refer to changes to the current API definition)SampleResponseRetrieve
    Expand
    titleRequest...
    FieldDetails
    responseabo
    request*
    Expand
    title...
    FieldDetails
    referenceCode*string($uuid)hlaNomenclatureVersion*string
    default: 3

    Major version of HLA Nomenclature HLA_NOM_VER Req 7

    hla{...}idm{...}
    requestId

    string

    nullable

    maxLength: 

    trueEnum:
    Array [ 4 ]
    rhesusstring
    nullable: true
    Enum:
    Array [ 2 ]

    19

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

    minLength: 3
    nullable: false

    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

    remark
    donorStillOfInterestrecipientinteger
    string
    maxLength: 
    1

    Donor still of interest DON_ACCPT Req 1

    Enum:
    Array [ 2 ]
    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

    recipientpatientEmbedded Patient BlockdonorEmbedded Donor Block
    Expand
    titleResponse...
    FieldDetails
    wmdaResponse{...}
    Expand
    titleRequest...
    No parameters specified

    the receiving registry

    patient*
    Expand
    title
    Response
    ...
    originalMessage{...}
    metaInformationEmbedded Meta Block

    5.7 - Infectious Disease Marker Request

    This message is used to request infectious disease marker test results of the selected donor. Expected return message is 'idm result' (5.8) or 'request rejected' (5.15).

    FieldDetails
    wmdaId*

    integer
    nullable: false

    example: 1234

    ID provided by the WMDA

     

    donor*Embedded Donor Block (donor in request)
    Expand
    titleResponse
    SendRetrieveInfectiousDiseaseMarkerRequestInfectiousDiseaseMarkerRequestRetrieve ExpandtitleRequest
    ...
    FieldDetails
    referenceCode
    metaInformation*
    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: Position 1: Blood group and rhesus Position 2: CMV status Position 3: Toxoplasmosis Position 4: EBV Position 5: HIV status Position 6: HIV P24 Position 7: Hepatitis B surface antigen Position 8: Antibody to Hepatitis B surface antigen Position 9: Antibody to Hepatitis B core antigen Position 10: Antibody to Hepatitis C virus Position 11: Lues status (Treponema pallidum) Position 12: ALT status Position 13: Antibody to HTLV1.V2

    institutionPaying*{...}acknowledgementIdstring
    maxLength: 17

    nullable: true

    example: 1234567890abcdefg

    Acknowledgement ID ACK_ID Opt 17

    remarkstring
    maxLength: 120

    nullable: true

    example: Please also test for SARS-CoV-2

    Remark REMARK Opt 120

    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

    5.12 - Workup Request

    Future Phase

    5.13 - Workup Status

    Future Phase

    5.14 - Request Cancellation (REQ_CAN)

    This message is used to cancel a previous request that has been sent to the donor registry. The Request must have a preceding request that is being canceled.

    Send (Post)
    Retrieve (Post)
    requestCancellationRequestrequestCancellationRetrieve
    Expand
    titleRequest
    recipientinteger
    maximum: 9999

    minimum: 0

    maxLength: 4

    minLength: 4

    example: 1234

    4 digit ION of recipient

    patientEmbedded Patient BlockdonorEmbedded Donor Block ExpandtitleResponse{...}
    ...
    FieldDetails
    wmdaResponse
    message*
    Expand
    title
    Request
    ...
    No parameters specified
    Expand
    titleResponse...
    FieldDetails
    originalMessage{...}
    metaInformationEmbedded Meta Block

    5.8 - Infectious Disease Marker Results

    This message is used to send the results of the IDM request back to the requesting registry. 
    Check paragraph '5.18 Infectious Disease Marker' for the related message flow.

    ...

    Expand
    titleRequest...
    FieldDetails
    referenceCode*string($uuid)
    markerAsArray[...]
    markerinteger
    maxLength: 19

    minLength: 19

    example: 111110000111

    Binary fixed length string in which each position represents a test to be requested: Position 1: Blood group and rhesus Position 2: CMV status Position 3: Toxoplasmosis Position 4: EBV Position 5: HIV status Position 6: HIV P24 Position 7: Hepatitis B surface antigen Position 8: Antibody to Hepatitis B surface antigen Position 9: Antibody to Hepatitis B core antigen Position 10: Antibody to Hepatitis C virus Position 11: Lues status (Treponema pallidum) Position 12: ALT status Position 13: Antibody to HTLV1.V2

    sampleExtractionDatestring($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

    recipientinteger
    maximum: 9999

    minimum: 0

    maxLength: 4

    minLength: 4

    example: 1234

    4 digit ION of recipient

    donor*Embedded Donor Block
    patient*Embedded Patient Block
    Expand
    titleResponse...
    FieldDetails
    wmdaResponse{...}

    ...

    Expand
    titleRequest...
    No parameters specified
    Expand
    titleResponse...
    FieldDetails
    originalMessage{...}
    metaInformationEmbedded Meta Block

    Rules

    After the IDM_RES message which includes an embedded donor (DONOR_CB) block, a separate update must be made to the Search & Match system with the updated donor data to ensure up-to-date master data.

    5.9 - Reservation Request

    This message is used to request the reservation of a donor for transplant at the receiving registry.

    ...

    Expand
    titleRequest...
    FieldDetails
    payload*
    Expand
    title...
    FieldDetails
    patient*Embedded Patient Block
    donorEmbedded Donor Block
    requestDate*string($date-time)

    Request date REQ_DATE Req 8 yyyy-MM-dd [or yyyyMMdd]

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

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

    acknowledgementIdstring
    maxLength: 17

    nullable: true

    example: 1234567890abcdefg

    Acknowledgement ID ACK_ID Opt 17

    remarkstring
    maxLength: 120

    nullable: true

    Remark REMARK Opt 120

    recipient*string
    maximum: 9999

    minimum: 0

    maxLength: 4

    minLength: 4

    example: 1234

    4 digit ION of recipient

    correlationGuid*string($uuid)

    Sender generated GUID used to correlate response acknowledgement

    Expand
    titleResponse...
    FieldDetails
    wmdaResponse{...}

    ...

    Expand
    titleRequest...
    No parameters specified
    Expand
    titleResponse...
    originalMessage{...}
    metaInformationEmbedded Meta Block
    FieldDetails
    requestId

    string

    maxLength: 19

    referenceMessageId*string($uuid)
    requestType*

    string
    maxLength: 3
    nullable: false

    Enum: [ genericRequest, extendedTypingRequest, 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
    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

    5.15 - Request Rejection (NO_RES)

    This message is used to notify the requesting registry when a request cannot be fulfilled (service cannot be provided).


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

    string

    maxLength: 19

    referenceMessageId*string($uuid)
    requestType*

    string
    maxLength: 3

    Enum: [ genericRequest, extendedTypingRequest, 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
    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

    5.16 - Result Reminder (RES_REM)

    This message is sent by the requesting registry to the receiving registry to remind the receiving registry of an outstanding result from a previous request.

    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: [ extendedTypingResponse, sampleArrival, sampleResponse, 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

    5.10 - Reservation Result

    This message is used to notify the requesting patient registry if the Reservation Request has been confirmed by the donor registry.

    SendRetrieveReservationResultRequestReservationResultRetrieve Expand
    titleRequest...
    FieldDetailssender*string
    maxLength: 4
    minLength: 4

    example: 
    5678
    1234

    4-digit ION of

    sender

    the receiving registry

    sentAtUtc
    patient*
    string($date-time)

    Server-supplied timestamp showing UTC time sender posted (i.e. sent) MessageRequest.

    deliveredAtUtc*string($date-time)

    Server-supplied timestamp showing UTC time of Message delivery to recipient's inbox queue.

    payload*
    Expand
    title...
    FieldDetails
    wmdaId*

    integer
    nullable: false

    example: 1234

    ID provided by the WMDA

     

    donor*Embedded Donor Block (donor in request)
    Expand
    titleResponse
    Expandtitle
    ...
    FieldDetails
    patient
    metaInformation*
    {...}donor*{
    Expand
    titleRequest...
    }
    limit
    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

    integer
    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

    5.17 - Generic Request (new message)

    This message is used for registering a patient (by the embedded patient block).

    This may be required for example for direct WU requests until 5.11 is available or to reactivate a closed patient case on the receiving registry side.

    Send (Post)
    Retrieve (Post)
    genericRequestRequestgenericRequestRetrieve
    Expand
    titleRequest
    recipient*string
    maximum: 9999

    minimum: 0

    maxLength: 4

    minLength: 4

    example: 1234

    4 digit ION of recipient

    correlationGuid*string($uuid)

    Sender generated GUID used to correlate response acknowledgement

    messageTypestring

    Message types supported by WmdaConnect

    Enum:
    Array [ 21 ]
    ExpandtitleResponse{...}
    ...
    FieldDetails
    wmdaResponse
    request*
    Expand
    title
    Request
    ...
    No parameters specified
    Field
    expand
    Details
    titleResponse...
    FieldDetails
    originalMessage{...}
    metaInformationEmbedded Meta Block

    Rules

    After the ReservationResult (RSV_RES) message which includes an embedded donor (DONOR_CB) block, a separate update must be made to the Search & Match system with the updated donor data to ensure up-to-date master data.

    5.11 - Donor Release Request (Reservation Release)

    This message is used so the patient registry can notify the donor registry to release a donor reservation when it is no longer needed (e.g. patient deceased or was transplanted with another donor). This should be used if the Reservation Request has been fulfilled, if the Reservation Request has not been fulfilled then a Request Cancellation message should be used.

    This is a change request with respect to the current procedure and should be handled as such as it has implications on local systems.

    ...

    • Reservation Release
      • patient (wmdaId)
      • referenceCode 
      • requestDate
      • reason
      • remark
    • Donor Block (6.1.4)

    ...

    • Meta Block (6.1.1)
    • Payload Reservation Release

    Rules

    After the Reservation Release message which includes an embedded donor (DONOR_CB) block, a separate update must be made to the Search & Match system with the updated donor data to ensure up-to-date master data. 

    5.12 - Workup Request

    Future Phase

    5.13 - Workup Status

    Future Phase

    5.14 - Request Cancellation

    This message is used to cancel a previous request that has been sent to the donor registry. The Request  It must have a preceding request that is being cancelled.

    ...

    Expand
    titleRequest...
    FieldDetails
    sender*string
    maxLength: 4

    minLength: 4

    example: 5678

    4 digit ION of sender

    sentAtUtc*string($date-time)

    Server-supplied timestamp showing UTC time sender posted (i.e. sent) MessageRequest.

    deliveredAtUtc*string($date-time)

    Server-supplied timestamp showing UTC time of Message delivery to recipient's inbox queue.

    payload*{...}
    recipient*string
    maximum: 9999

    minimum: 0

    maxLength: 4

    minLength: 4

    example: 1234

    4 digit ION of recipient

    correlationGuid*string($uuid)

    Sender generated GUID used to correlate response acknowledgement

    messageTypestring

    Message types supported by WmdaConnect

    Enum:
    Array [ 21 ]
    Expand
    titleResponse...
    FieldDetails
    wmdaResponse{...}

    ...

    Expand
    titleRequest...
    No parameters specified
    Expand
    titleResponse...
    FieldDetails
    originalMessage{...}
    metaInformationEmbedded Meta Block

    5.15 - Request Rejected 

    This message is used to notify the requesting registry when a request cannot be fulfilled.

    ...

    Expand
    titleRequest...
    FieldDetails
    payload*
    Expand
    title...
    FieldDetails
    patient*Embedded Patient Block
    donor*Embedded Donor Block
    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

    recipient*string
    maximum: 9999

    minimum: 0

    maxLength: 4

    minLength: 4

    example: 1234

    4 digit ION of recipient

    correlationGuid*string($uuid)

    Sender generated GUID used to correlate response acknowledgement

    Expand
    titleResponse...
    FieldDetails
    wmdaResponse{...}

    ...

    Expand
    titleRequest...
    No parameters specified
    Expand
    titleResponse...
    originalMessage{...}
    metaInformationEmbedded Meta Block

    Rules

    After the Request Rejected message which includes an embedded donor (DONOR_CB) block, a separate update must be made to the Search & Match system with the updated donor data to ensure up-to-date master data

    5.16 - Result Reminder

    This message is sent by the requesting registry to the receiving registry to remind the receiving registry of an outstanding results from a previous request.

    requestId

    string

    maxLength: 19

    reason

    string

    reason for the generic request. Free text.

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


    5.18 Request + Response Flows


    PlantUML Render Macro
    formatPNG
    alignleft
    titleExtended Typing

    participant "Patient Registry" as PR

    control "Match-Connect" as MC

    control "Search & Match Service" as SM

    participant "Donor Registry" as DR

    skinparam SequenceMessageAlign center

    skinparam dpi 92

    == Register Patient ==

    PR -> SM : Create Patient

    activate SM #FFBBBB

    SM -> PR : Return wmdaId

    deactivate SM

    == Start Search ==

    PR -> SM : Start Search

    activate SM #FFBBBB

    SM -> PR : Return searchId

    deactivate SM


    PR -> SM : Check search status

    activate SM #FFBBBB

    SM -> PR : Return search status (Completed, Running, Errored)

    deactivate SM


    PR -> SM : Retrieve search results

    activate SM #FFBBBB

    SM -> PR : Return search results

    deactivate SM


    == Making Request ==

    PR -[#dodgerblue]> DR : Extended Typing Request (incl. Embedded Patient Block)

    DR -[#dodgerblue]> PR : Reservation Response 

    PR -[#dodgerblue]> DR : Request Cancellation


    == Getting Response ==

    DR -[#dodgerblue]> PR : Request Rejection

    DR -[#dodgerblue]> PR : Extended Typing Result (incl. Embedded Donor Block)

     


    PlantUML Render Macro
    formatPNG
    alignleft
    titleSample Request

    participant "Patient Registry" as PR

    control "Match-Connect" as MC

    control "Search & Match Service" as SM

    participant "Donor Registry" as DR

    skinparam SequenceMessageAlign center

    skinparam dpi 92

    == Register Patient ==

    PR -> SM : Create Patient

    activate SM #FFBBBB

    SM -> PR : Return wmdaId

    deactivate SM

    == Start Search ==

    PR -> SM : Start Search

    activate SM #FFBBBB

    SM -> PR : Return searchId

    deactivate SM


    PR -> SM : Check search status

    activate SM #FFBBBB

    SM -> PR : Return search status (Completed, Running, Errored)

    deactivate SM


    PR -> SM : Retrieve search results

    activate SM #FFBBBB

    SM -> PR : Return search results

    deactivate SM


    == Making Request ==

    PR -[#dodgerblue]> DR : Sample Request (incl. Embedded Patient Block)

    DR -[#dodgerblue]> PR : Reservation Response

    PR -[#dodgerblue]> DR : Request Cancellation

    DR -[#dodgerblue]> PR : Request Rejection

    DR -[#dodgerblue]> PR : Sample Arrival

    DR -[#dodgerblue]> PR : IDM result (incl. Embedded Donor Block)

    DR -[#dodgerblue]> PR : Sample Information


    == Getting Response ==

    PR -[#dodgerblue]> DR : Request Rejection

    PR -[#dodgerblue]> DR : Sample Result



    PlantUML Render Macro
    formatPNG
    alignleft
    titleInfectious Disease Marker Request

    participant "Patient Registry" as PR

    control "Match-Connect" as MC

    control "Search & Match Service" as SM

    participant "Donor Registry" as DR

    skinparam SequenceMessageAlign center

    skinparam dpi 92

    == Register Patient ==

    PR -> SM : Create Patient

    activate SM #FFBBBB

    SM -> PR : Return wmdaId

    deactivate SM

    == Start Search ==

    PR -> SM : Start Search

    activate SM #FFBBBB

    SM -> PR : Return searchId

    deactivate SM



    PR -> SM : Check search status

    activate SM #FFBBBB

    SM -> PR : Return search status (Completed, Running, Errored)

    deactivate SM



    PR -> SM : Retrieve search results

    activate SM #FFBBBB

    SM -> PR : Return search results

    deactivate SM


    == Making Request ==

    PR -[#dodgerblue]> DR : IDM Request (incl. Embedded Patient Block)

    DR -[#dodgerblue]> PR : Reservation Response

    PR -[#dodgerblue]> DR : Request Cancellation

    == Getting Response ==

    DR -[#dodgerblue]> PR : Request Rejection

    DR -[#dodgerblue]> PR : IDM Result (incl. Embedded Donor Block)



    PlantUML Render Macro
    formatPNG
    alignleft
    titleReservation Request

    participant "Patient Registry" as PR

    control "Match-Connect" as MC

    control "Search & Match Service" as SM

    participant "Donor Registry" as DR

    skinparam SequenceMessageAlign center


    skinparam dpi 92

    == Register Patient ==

    PR -> SM : Create Patient

    activate SM #FFBBBB

    SM -> PR : Return wmdaId

    deactivate SM

    == Start Search ==

    PR -> SM : Start Search

    activate SM #FFBBBB

    SM -> PR : Return searchId

    deactivate SM


    PR -> SM : Check search status

    activate SM #FFBBBB

    SM -> PR : Return search status (Completed, Running, Errored)

    deactivate SM


    PR -> SM : Retrieve search results

    activate SM #FFBBBB

    SM -> PR : Return search results

    deactivate SM


    == Making Request ==

    PR -[#dodgerblue]> DR : Reservation Request (incl. Embedded Patient Block)

    PR -[#dodgerblue]> DR : Request Cancellation


    == Getting Response ==

    DR -[#dodgerblue]> PR : Reservation Response (incl. Embedded Donor Block)

    PR -[#dodgerblue]> DR : Reservation Release Request



    PlantUML Render Macro
    formatPNG
    alignleft
    titleGeneric Request

    @startuml

    participant "Patient Registry" as PR

    control "Match-Connect" as MC

    control "Search & Match Service" as SM

    participant "Donor Registry" as DR

    skinparam SequenceMessageAlign center

    skinparam dpi 92

    == Register Patient ==

    PR -> SM : Create Patient

    activate SM #FFBBBB

    SM -> PR : Return wmdaId

    deactivate SM

    == Start Search ==


    PR -> SM : Start Search

    activate SM #FFBBBB

    SM -> PR : Return searchId

    deactivate SM

    PR -> SM : Check search status

    activate SM #FFBBBB

    SM -> PR : Return search status (Completed, Running, Errored)

    deactivate SM


    PR -> SM : Retrieve search results

    activate SM #FFBBBB

    SM -> PR : Return search results

    deactivate SM


    == Making Request ==

    PR -[#dodgerblue]> DR : Generic Request (incl. Embedded Patient Block)

    DR -[#dodgerblue]> PR : Reservation Response 

    PR -[#dodgerblue]> DR : Request Cancellation


    == Getting Response ==

    DR -[#dodgerblue]> PR : Request Rejection

    @enduml

    v1.0.1

    ...

    Expand
    titleRequest...
    FieldDetails
    sender*string
    maxLength: 4

    minLength: 4

    example: 5678

    4 digit ION of sender

    sentAtUtc*string($date-time)

    Server-supplied timestamp showing UTC time sender posted (i.e. sent) MessageRequest.

    deliveredAtUtc*string($date-time)

    Server-supplied timestamp showing UTC time of Message delivery to recipient's inbox queue.

    payload*{...}
    recipient*string
    maximum: 9999

    minimum: 0

    maxLength: 4

    minLength: 4

    example: 1234

    4 digit ION of recipient

    correlationGuid*string($uuid)

    Sender generated GUID used to correlate response acknowledgement

    messageTypestring

    Message types supported by WmdaConnect

    Enum:
    Array [ 21 ]
    Expand
    titleResponse...
    FieldDetails
    wmdaResponse{...}

    ...

    Expand
    titleRequest...
    No parameters specified
    Expand
    titleResponse...
    FieldDetails
    originalMessage{...}
    metaInformationEmbedded Meta Block

    5.17 - Generic Request

    Used for registering a patient (by the embedded patientBlock).

    Is used for example for direct WU requests until 5.11 is available or to reactivate a closed patient case on receiving registry side.

    5.18 Request + Response Flows

    Generic 

    Image Removed

    Extended Typing 

    Image Removed

    Infectious Disease Marker

    Image Removed

    Sample Request

    Image Removed