Versions Compared

Old Version 126

changes.mady.by.user Matt Prestegaard

Saved on

compared with

New Version 127

changes.mady.by.user Matt Prestegaard

Saved on

Key

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

...

SendRetrieve
SampleInfoRequest (comments reffer refer to changes to the current API definition)SampleInfoRetrieve
Expand
titleRequest...
referenceCode*string($uuid
Payload
  • patient (just the wmdaID)
  • donor (format change see above)
    • referenceCode (see text above
    )
    informationType
  • remark
    • Response
      • deliveredAtUtc
      • messageId
      • responseType
      • remark
    *string
    maxLength: 3
    minLength: 3

    Information Type INFO_TYPE Req 3

    Enum:
    Array [ 12 ]
    remarkstring
    nullable: true

    Remark REMARK Opt 120

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

    4 digit ION of recipient

    patient*Embedded Patient Block
    donor*Embedded Donor Block
    Expand
    titleResponse...
    FieldDetails
    wmdaResponse{...}
    Expand
    titleRequest...
    No parameters specified
    Expand
    titleResponse...
    originalMessage{...}
    metaInformationEmbedded Meta Block
    • Payload
      • n/a
     Response
  • MetaInformation
    • Send payload

    5.5 - 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
    Expand
    titleRequest...
    FieldDetails
    message
    Expand
    title...
    FieldDetails
    referenceCode*string($uuid)
    arrivalDate*string($date-time)

    Proposed date of sample arrival ARRV_DATE Req 8

    collectionDatestring($date-time)
    nullable: true

    Donor blood collection date COLL_DATE Opt 8

    labelId*string
    maxLength: 19

    Verbatim verification typing (VT) sample label ID D_LABEL_ID Req 19

    etSampleTypestring
    nullable: true

    Type of sample. AS = CBU Contiguous Attached Segment WB = Whole Blood Sample RC = Red Cell Fraction (pellet) FP = Blood Spotted Filter Paper ED = Extracted DNA

    Enum:
    Array [ 5 ]
    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

    patientEmbedded Patient Block
    donorEmbedded Donor Block
    Expand
    titleResponse...
    FieldDetails
    wmdaResponse{...}
    Expand
    titleRequest...
    No parameters specified
    Expand
    titleResponse...
    FieldDetails
    originalMessage{...}
    metaInformationEmbedded Meta Block

    5.6 - Sample Results

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

    ...