Versions Compared

Old Version 18

changes.mady.by.user Jan Hofmann

Saved on

compared with

New Version 19

changes.mady.by.user Bertjan Nijhuis

Saved on

Key

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

...

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 (6.1) containing up-to-date contact-information about the needed institution(s).

/post_api_v1_TypingRequestRequest

SendRetrieve
TypingRequestTypingRequestRetrieve
  • Donor 
  • Typing info
  • Patient Block
  • Address Block
  • Meta Block (ref?)
  • Payload
    • Donor
      • type (adult, adcu, cbu)
      • id (grid, id)
    • Typing info
      • requestDate
      • resolutionRequired
      • urgent
      • remark
    • Patient Block (ref?)
    • Address Blcok Block (6.1)

Rules

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.

?Only one SMP_REQ can be open for a patient / donor pair (please see also the General section about duplicate requests).

Several distinct requests for the same patient / donor pair at a time are possible, for example, a DRB1 high and a class I DNA, but each request has to be answered by a TYP_RES message. It is not allowed to ”concatenate” / ”summarize” results in a single result message. Multiple typing requests for the same patient / donor pair have to be disjoint (i.e. may not contain the same locus or allele). The occurrence of multiple requests should be an exception. Usually, all loci or alleles required should be requested within one message. 

The appropriate action if the TYP_REQ.RESOLUT cannot be accepted or has to be changed by the recipient, e.g. due to national rules, is to inform the requesting side what was done. If only the resolution was changed (the sender will receive something different than ordered - either more or less) or only a part of the requested loci were accepted (the sender will only receive parts of what was ordered): send WARNING or TXT_MSG. For the complete discussion please see TC Minutes MP2007/12.

5.2 - Typing Results

Needed

...

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

...

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

...

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

...

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

...

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

...

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

...


The SampleResponseRequest SampleRequestRequest (and SampleResponseRetrieveSampleRequestRetrieve) is used to transmit the results of the sample requestrequest 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).

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.

Payload
SendRetrieve
SampleResponseRequest (comments reffer to changes to the current API definition)SampleResponseRetrieveSampleRequestRetrieve
  • patient (just the wmdaIDin 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
  • 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 (just the wmdaIDin form of an embedded register_patient block)
    • donor (format change see above)
    • referenceCode (not needed anymore see text above)
    • 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
    • requestDate
    • prod1
    • prod2
    • prod3
    • prod4
    • receptionDate1
    • receptionDate2
    • acceptableReceptionDaysOfWeek
    • institutionToSendSampleTo (as embedded addressBlock)
    • institutionPaying (as embedded addressBlock)
    • urgent
    • acknowledgementId (not needed anymore → MSG_RSP)
    • remarkremark (missing: was this field dropped by purpose?)

5.7 - Infectious Disease Marker Request

...