Versions Compared

Old Version 16

changes.mady.by.user Bertjan Nijhuis

Saved on

compared with

New Version 17

changes.mady.by.user Jan Hofmann

Saved on

Key

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

...

After the TYP_RES message, a DONOR_CB with the updated donor data is mandatory to ensure up-to-date master data. See 4.0 above.

5.3 - Sample Request (SMP_REQ)

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 informations the institutions needed are sent explicitly as an embedded 'addressBlock' (6.1).

...

Duplicate requests on the same day: This issue becomes particularly difficult if SMP_REQs are concerned - sometimes users want to ”correct” their previous request (i.e. forgot to request quantity and product). The correct way of doing this is to cancel the erroneous request first and send the second one later. However, this procedure might also confuse if not carried out on the same working day. In doubt a phone call helps sorting things out.


SendRetrieve
SampleRequestRequest (comments reffer to changes to the current API definition)SampleRequestRetrieve
  • Payload
    • patient (in form of an embedded register_patient block)
    • donor (format change see above)
    • referenceCode (not needed anymore see text above)
    • requestDate
    • prod1
    • prod2
    • prod3
    • prod4
    • receptionDate1
    • receptionDate2
    • acceptableReceptionDaysOfWeek
    • institutionToSendSampleTo (as embedded addressBlock)
    • institutionPaying (as embedded addressBlock)
    • urgent
    • acknowledgementId (not needed anymore → MSG_RSP)
    • remark
  • MetaInformation
  • Payload
    • patient (in form of an embedded register_patient block)
    • donor (format change see above)
    • referenceCode (not needed anymore see text above)
    • requestDate
    • prod1
    • prod2
    • prod3
    • prod4
    • receptionDate1
    • receptionDate2
    • acceptableReceptionDaysOfWeek
    • institutionToSendSampleTo (as embedded addressBlock)
    • institutionPaying (as embedded addressBlock)
    • urgent
    • acknowledgementId (not needed anymore → MSG_RSP)
    • remark

5.4 - Sample Information (SMP_INFO)

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

The referenceCode is teh 'massageId' 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 searching 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.


SendRetrieve
SampleInfoRequest (comments reffer to changes to the current API definition)SampleInfoRetrieve
  • Payload
    • patient (just the wmdaID)
    • donor (format change see above)
    • referenceCode (see text above)
    • informationType
    • remark
  • MetaInformation
  • Payload
    • patient (just the wmdaID)
    • donor (format change see above)
    • referenceCode (see text above)
    • informationType
    • remark

5.5 - Sample Arrival (SMP_ARR)

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

The message ID (correlationGUID) 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.


SendRetrieve
SampleArrivalRequest (comments reffer to changes to the current API definition)SampleArrivalRetrieve
  • Payload
    • patient (just the wmdaID)
    • donor (format change see above)
    • referenceCode (see text above)
    • arrivalDate
    • collectionDate
    • acknowledgementId (not needed anymore → MSG_RSP)
    • labelId (is there a usecase for this ID, where it is not the donor ID?)
    • aampleType (missing: was this field dropped by purpose?)
    • remark
  • MetaInformation
  • Payload
    • patient (just the wmdaID)
    • donor (format change see above)
    • referenceCode (see text above)
    • arrivalDate
    • collectionDate
    • acknowledgementId (not needed anymore → MSG_RSP)
    • labelId (is there a usecase for this ID, where it is not the donor ID?)
    • aampleType (missing: was this field dropped by purpose?)
    • remark

5.6 - Sample Results (SMP_RES)

The

...

SampleResponseRequest (and

...

SampleResponseRetrieve) is used to

...

transmit the results of the sample request.

The message ID (correlationGUID) of this message will be used as 'referenceCode' for the rest of the request related message flow.

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. 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 a DONOR_CB with D_STATUS = ”RS”. All the other patients the donor might have been reported for should receive a DONOR_CB with D_STATUS = ”OP”.

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


SendRetrieve
SampleResponseRequest (comments reffer to changes to the current API definition)SampleResponseRetrieve
SampleRequestRetrieve
  • Payload
    • patient (
in form of an embedded register_patient block
    • just the wmdaID)
    • donor (format change see above)
    • referenceCode (
not needed anymore
    • see text above
)
  • requestDate
  • prod1
  • prod2
  • prod3
  • prod4
  • receptionDate1
  • receptionDate2
  • acceptableReceptionDaysOfWeek
  • institutionToSendSampleTo (as embedded addressBlock)
  • institutionPaying (as embedded addressBlock)
  • urgent
  • acknowledgementId (not needed anymore → MSG_RSP)
    • remark
      • )
      • hlaNomenclatureVersion
      • hla (full block of all HLA typing results)
      • mlcGch
      • mlcHvg
      • gvhReactivityPercent
      • hvgReactivityPercent
      • abo
      • rh (missing)
      • ccr5 (missing)
      • cmv (→ antiCmv)
      • cmvDate (→ antiCmvDate)
      • cmvNat (missing)
      • cmvNatDate (missing)
      • hbsAg
      • antiHbc
      • antiHbs
      • hbvNat (missing)
      • antiHcv
      • hcvNat (missing)
      • antiHev (missing)
      • hiv (→ antiHiv12)
      • hiv1Nat (missing)
      • hivP24
      • antiHtlv
      • syphilis (missing)
      • antiChagas (missing)
      • chagasNat (missing) 
      • ebv
      • toxo
      • pb19Nat (missing)
      • alt
      • donAccpt
      • remark (missing: was this field dropped by purpose?)
    • MetaInformation
    • Payload
      • patient (in form of an embedded register_patient block)
      • donor (format change see above)
      • referenceCode (not needed anymore see text above)
      • requestDate
      • prod1
      • prod2
      • prod3
      • prod4
      • receptionDate1
      • receptionDate2
      • acceptableReceptionDaysOfWeek
      • institutionToSendSampleTo (as embedded addressBlock)
      • institutionPaying (as embedded addressBlock)
      • urgent
      • acknowledgementId (not needed anymore → MSG_RSP)
      • remark

    5.7 - Infectious Disease Marker Request

    ...