Versions Compared

Old Version 96

changes.mady.by.user Bertjan Nijhuis

Saved on

compared with

New Version 97

changes.mady.by.user Jan Hofmann

Saved on

Key

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

...

SendRetrieve
SampleRequestRequest (comments reffer to changes to the current API definition)SampleRequestRetrieve

Request

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*{...}
donor*{...}
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*string
maxLength: 14

Institution the sample has to be sent to INST_SMP_SENT Req 10

institutionPaying*string
maxLength: 10

Institution paying INST_PAY Req 10

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


Response

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

Response

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*{...}
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*string
maxLength: 14

Institution the sample has to be sent to INST_SMP_SENT Req 10

institutionPaying*string
maxLength: 10

Institution paying INST_PAY Req 10

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

old:

...

  • 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
  • Response
    • deliveredAtUtc
    • messageId
    • responseType
    • remark
  • Payload
    • n/a
  •  Response
    • MetaInformation
    • Send payload

...

5.3.2 - 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
  • Response
    • deliveredAtUtc
    • messageId
    • responseType
    • remark
  • Payload
    • n/a




  •  Response
    • MetaInformation
    • Send payload

5.3.

...

3 -

...

Sample Arrival

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

...

SendRetrieve
SampleArrivalRequest (comments refer 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
  • Response
    • deliveredAtUtc
    • messageId
    • responseType
    • remark
  • Payload
    • n/a






  •  Response
    • MetaInformation
    • Send payload

5.

...

3.4 -

...

Sample Results

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

...

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

Consulation Consultation items from the TWG - Stopping a Search

...