Versions Compared

Key

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

...

SendRetrieve
SampleResponseRequest (comments refer to changes to the current API definition)SampleResponseRetrieve
Expand
titleRequest...
FieldDetails
response
Expand
title...
FieldDetails
referenceCode*string($uuid)
hlaNomenclatureVersion*string
default: 3

Major version of HLA Nomenclature HLA_NOM_VER Req 7

hla{...}
idm{...}
abostring
nullable: true
Enum:
Array [ 4 ]
rhesusstring
nullable: true
Enum:
Array [ 2 ]
donorStillOfIntereststring
maxLength: 1

Donor still of interest DON_ACCPT Req 1

Enum:
Array [ 2 ]
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...
originalMessage{...}
metaInformationEmbedded Meta Block
  • Payload
    • patient (just the wmdaID)
    • donor (format change see above)
    • referenceCode (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
    • remark (missing: was this field dropped by purpose?)
  • Response
    • deliveredAtUtc
    • messageId
    • responseType
    • remark
Payloadn/a

























  •  Response
    • MetaInformation
    • Send payload

5.7 - Infectious Disease Marker Request

...

SendRetrieve
InfectiousDiseaseMarkerRequestInfectiousDiseaseMarkerRequestRetrieve
Expand
titleRequest...
FieldDetails
referenceCode*string($uuid)
markerAsArray[...]
marker*integer
maxLength: 19

minLength: 19

example: 111110000111

Binary fixed length string in which each position represents a test to be requested: Position 1: Blood group and rhesus Position 2: CMV status Position 3: Toxoplasmosis Position 4: EBV Position 5: HIV status Position 6: HIV P24 Position 7: Hepatitis B surface antigen Position 8: Antibody to Hepatitis B surface antigen Position 9: Antibody to Hepatitis B core antigen Position 10: Antibody to Hepatitis C virus Position 11: Lues status (Treponema pallidum) Position 12: ALT status Position 13: Antibody to HTLV1.V2

institutionPaying*{...}
acknowledgementIdstring
maxLength: 17

nullable: true

example: 1234567890abcdefg

Acknowledgement ID ACK_ID Opt 17

remarkstring
maxLength: 120

nullable: true

example: Please also test for SARS-CoV-2

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.8 - Infectious Disease Marker Results

...