Versions Compared

Old Version 129

changes.mady.by.user Matt Prestegaard

Saved on

compared with

New Version 130

changes.mady.by.user Matt Prestegaard

Saved on

Key

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

...

SendRetrieve
TypingRequestRequestTypingRequestRetrieve
  • 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)
Expand
titleRequest...
FieldDetails
request
Expand
title...
FieldDetails
requestDate*string($date-time)

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

resolutionRequired*string
maxLength: 11
minLength: 11
example: HHHHMMM-H-H

Character string with fixed length in which each position represents a HLA locus. The coding of the resolution required for every position is: S = serological L = DNA low resolution M = DNA medium resolution H = DNA high resolution - (hyphen) = not requested The character string is interpreted from left to right, with position 1 as the leftmost position. The positions for the HLA loci are defined as: Position 1: HLA-A Position 2: HLA-B Position 3: HLA-C Position 4: HLA-DRB1 Position 5: HLA-DRB3 Position 6: HLA-DRB4 Position 7: HLA-DRB5 Position 8: HLA-DQA1 Position 9: HLA-DQB1 Position 10: HLA-DPA1 Position 11: HLA-DPB1

urgent*boolean

Urgent request URGENT Opt 1

remarkstring
maxLength: 120
nullable: true
example: patient case is very urgent

Remark REMARK Opt 120

addressEmbedded Address Block
recipientinteger
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4 digit ION of recipient

patientEmbedded Patient Block
donorEmbedded Donor Block
Expand
titleResponse...
FieldDetails
wmdaResponse{...}
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
FieldDetails
originalMessage{...}
metaInformationEmbedded Meta Block
  • Meta Block (6.1.1)
    • Payload TypingRequest

    Rules

    Examples for field resolutionRequired:

    ...

    After the TypingResults (TYP_RES) 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.  More information on how to do so may be found here.

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

    ...

    SendRetrieve
    SampleRequestRequest (comments refer to changes to the current API definition)SampleRequestRetrieve
    Expand
    titleRequest
    FieldDetails
    request
    Expand
    title...
    requestDatestring($date-time)

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

    prod1{...}
    prod2{...}
    prod3{...}
    prod4{...}
    earliestDateCanReceivestring($date-time)

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

    latestDateCanReceivestring($date-time)
    nullable: true

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

    acceptableReceptionDaysOfWeekinteger
    nullable: true
    minLength: 7
    maxLength: 7
    example: 1111100

    Weekdays acceptable for reception. Binary fixed length string for the 7 days in the week. 1110000 means acceptable days for reception are Monday, Tuesday and Wednesday, not acceptable days are Thursday, Friday, Saturday or Sunday.

    institutionToSendSampleToEmbedded Address Block
    institutionPayingEmbedded Address Block
    urgentboolean

    Urgent request URGENT Opt 1

    acknowledgementIdstring
    maxLength: 17
    nullable: true
    example: 1234567890abcdefg

    Acknowledgement ID ACK_ID Opt 17

    remarkstring
    maxLength: 120
    nullable: true
    example: patient case is very urgent

    Remark REMARK Opt 120

    recipientinteger
    maximum: 9999
    minimum: 0
    maxLength: 4
    minLength: 4
    example: 1234

    4 digit ION of recipient

    patient*Embedded Patient Block
    donorEmbedded Donor Block
    Expand
    titleResponse
    deliveredAtUtcstring($date-time)

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

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

    No parameters specified

    Expand
    titleResponse...
    FieldDetails
    originalMessage{...}
    metaInformationEmbedded Meta Block

    5.4 - Sample Information

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

    ...