Versions Compared

Old Version 109

changes.mady.by.user Albert Mustafin

Saved on

compared with

New Version 110

changes.mady.by.user Albert Mustafin

Saved on

Key

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

Table of Contents
maxLevel1


General considerations:

  • A patient registration embedded block will be sent together with each request. This block contains both wmdaId and patientId of the patient.

  • The donor requested has to be reserved at the remote hub and reported back to the requesting hub / donor patient registry by a an embedded donor block with the donor status reflecting the change (DONOR_CB with D_STATUS = ”RS”.

3 - Patient Administration#3PatientAdministration-3.8-RegisterPatient

ADCU and CBU have similar structure, but adult donor has the ID (GRID) right away.

Suggested structure for the adult donors:

...

{

grid*string
nullable: true
maxLength: 19
minLength: 19
example: 9991012070433202000

}

  • ReferenceCode:

...

  • ).

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

...

  • Typing request info
    • donor
      • type (adult, adcu, cbu)
      • id (grid, id)
    • requestDate
    • resolutionRequired
    • urgent
    • remark
  • Patient Block (6.1.3)
  • Address Block (6.1.2)

...

  • Meta Block (6.1.1)
  • Payload TypingRequest

flow.

SendRetrieve
TypingRequestTypingRequestRetrieve
  • Typing request info
    • donor
      • type (adult, adcu, cbu)
      • id (grid, id)
    • requestDate
    • resolutionRequired
    • urgent
    • remark
  • Patient Block (6.1.3)
  • Address Block (6.1.2)
  • Meta Block (6.1.1)
  • Payload TypingRequest

Rules

Examples for field resolutionRequired:

HLA-DRB1 low resolution:
---L-------
HLA-DRB1 serological:
---S-------
HLA-DRB1 high resolution:
---H-------
HLA-DRB1 and HLA-DQB1 high resolution:
---H----H--

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

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 previously undefined requests are issued.

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

...

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


SendRetrieve
SampleRequestRequest (comments reffer to changes to the current API definition)SampleRequestRetrieve
Expand
titleRequest
recipientinteger
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

Payload
patient block*{patient block}
donor*
description:

Supply one node from the following

adult{...}
adcu{...}
cbu{...}
referenceCode*string($uuid)
requestDate*string($date-time)

Request date REQ_DATE Req 8

prod1*{...}
prod2{...}
prod3{...}
prod4{...}
receptionDate1*string($date-time)

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

receptionDate2string($date-time)
nullable: true

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

acceptableReceptionDaysOfWeekstring
nullable: true

Weekdays acceptable for reception ACC_DAYS Opt 7

institutionToSendSampleTo*

address block

Address of the institution the sample must be sent to

institutionPaying*

address block

Details of the institution that must pay for the service

urgentboolean

Urgent request URGENT Opt 1

acknowledgementIdstring
maxLength: 17
nullable: true
example: 1234567890abcdefg

Acknowledgement ID ACK_ID Opt 17

remarkstring
nullable: true

Remark REMARK Opt 120



Expand
titleResponse
deliveredAtUtcstring($date-time)

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

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

Request

No parameters specified


Expand
titleResponse
recipientinteger
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

Payload
patient*{patient block}
donor*{...}
referenceCode*string($uuid)
requestDate*string($date-time)

Request date REQ_DATE Req 8

requestDateEmdisstring
nullable: true
readOnly: true

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

prod1*{...}
prod2{...}
prod3{...}
prod4{...}
receptionDate1*string($date-time)

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

receptionDate1Emdisstring
nullable: true
readOnly: true

EMDIS format of Earliest date of sample reception REC_DATE1 Req 8

receptionDate2string($date-time)
nullable: true

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

receptionDate2Emdisstring
nullable: true
readOnly: true

EMDIS format of Latest date of sample reception REC_DATE2 Opt 8

acceptableReceptionDaysOfWeekstring
nullable: true

Weekdays acceptable for reception ACC_DAYS Opt 7

institutionToSendSampleTo*

address block

Address of the institution the sample must be sent to

institutionPaying*

address block

Details of the institution that must pay for the service

urgentboolean

Urgent request URGENT Opt 1

acknowledgementIdstring
maxLength: 17
nullable: true
example: 1234567890abcdefg

Acknowledgement ID ACK_ID Opt 17

remarkstring
nullable: true

Remark REMARK Opt 120

...

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

...