Versions Compared

Old Version 14

changes.mady.by.user Jan Hofmann

Saved on

compared with

New Version 15

changes.mady.by.user Jan Hofmann

Saved on

Key

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

...

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

EMDIS Semantic:

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

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 address INST_SMP_SENT must not be a P.O. box, since couriers often need a signature upon delivery.

The SMP_REQ is the only request message where the result also comes from the transplant centre.

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.

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

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

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

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

SendRetrieve
SampleResponseRequest (comments reffer to changes to the current API definition)SampleRequestRetrieve
  • 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

Needed

https://apispecs.wmda.info/?urls.primaryName=Connect%20API#/Message/post_api_v1_SampleInfoRequest

5.5 - Sample Arrival

Needed

https://apispecs.wmda.info/?urls.primaryName=Connect%20API#/Message/post_api_v1_SampleArrivalRequest

5.6 - Sample Results

Needed

...

5.7 - Infectious Disease Marker Request

...