Versions Compared

Old Version 152

changes.mady.by.user Matt Prestegaard

Saved on

compared with

New Version 153

changes.mady.by.user Matt Prestegaard

Saved on

Key

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

...

SendRetrieve
extendedTypingRequestRequestextendedTypingRequestRetrieve
Expand
titleRequest...
FieldDetails
request
Expand
title...
FieldDetails
resolutionRequired*string
maxLength: 11
minLength: 11
example: HHHHMMM-H-H

A character string with a fixed length in which each position represents an 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: the patient case is very urgent

Remark REMARK Opt 120

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

4 digit ION of the recipientreceiving registry

patientEmbedded Patient Block
donorDonor ID
Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
FieldDetails
originalMessage{...}
metaInformationEmbedded Meta Block

...

  • Intermediate resolution (M) translates to non-high resolution.
  • The coding schema theoretically allows more combinations than the previous bitstring (e.g. non-high DRB1 typing). The actually valid combinations have to be published in the national rules of each registry. The local user interfaces will have to take care that no invalid or previously undefined requests are issued.
  • Combinations are possible, i.e. several loci may be requested in one message.
  • The appropriate action if the typing request cannot be accepted or has to be changed by the recipientreceiving registry, e.g. due to national rules, is to inform the requesting side what was done. If only the resolution was changed (the sender sending registry will receive something different than ordered - either more or less) or only a part of the requested loci were accepted (the sender sending registry will only receive parts of what was ordered): send an MSG_RSP containing the warning.

...

SendRetrieve
extendedTypingResponseRequestextendedTypingResponseRetrieve
Expand
titleRequest...
Field

Details

response
Expand
title...
FieldDetails
referenceCodestring($uuid)
hlaNomenclatureVersionstring
default: 3

Major version of HLA Nomenclature HLA_NOM_VER Req 7

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: the patient case is very urgent

Remark REMARK Opt 120

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

4-digit ION of the recipientreceiving registry

donorEmbedded Donor Block
patientPatient ID
Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
originalMessage{...}
metaInformationEmbedded Meta Block

...

SendRetrieve
sampleRequestRequest (comments refer to changes to the current API definition)sampleRequestRetrieve
Expand
titleRequest
FieldDetails
request
Expand
title...
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. E.g., 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: the patient case is very urgent

Remark REMARK Opt 120

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

4-digit ION of the recipientreceiving registry

patient*Embedded Patient Block
donor*Donor ID
Expand
titleResponse
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...

No parameters specified

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

...

SendRetrieve
sampleInfoRequest (comments refer to changes to the current API definition)sampleInfoRetrieve
Expand
titleRequest...
referenceCode*string($uuid)
informationType*string
maxLength: 3
minLength: 3

Information Type INFO_TYPE Req 3

Enum:
Array [ 12 ]
remarkstring
nullable: true

Remark REMARK Opt 120

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

4-digit ION of the recipientreceiving registry

patient*Patient ID
donor*Embedded Donor Block
Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
originalMessage{...}
metaInformationEmbedded Meta Block

...

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: the patient case is very urgent

Remark REMARK Opt 120

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

4 digit ION of the recipientreceiving registry

patient*Patient ID
donor*Embedded Donor Block
Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
FieldDetails
originalMessage{...}
metaInformationEmbedded Meta Block

...

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: trueEnum:
Array [ 4 ]
rhesusstring
nullable: trueEnum:
Array [ 2 ]
donorStillOfIntereststring
maxLength: 1

Donor still of interest DON_ACCPT Req 1

Enum:
Array [ 2 ]
recipientreceivingRegistryinteger
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4 digit ION of the recipientreceiving registry

patient*Patient ID
donor*Donor ID
Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
originalMessage{...}
metaInformationEmbedded Meta Block

...

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: details in Data Dictionary

institutionPaying*Embedded Address Block
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

recipientreceivingRegistry*integer
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4-digit ION of the recipientreceiving registry

patient*Embedded Patient Block
donor*Donor ID
Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
FieldDetails
originalMessage{...}
metaInformationEmbedded Meta Block

...

SendRetrieve
infectiousDiseaseMarkerResultRequestinfectiousDiseaseMarkerResultRetrieve
Expand
titleRequest...
FieldDetails
referenceCode*string($uuid)
markerAsArray[...]
markerinteger
maxLength: 19
minLength: 19
example: 111110000111

Binary fixed length string in which each position represents a test to be requested: details are in Data Dictionary

sampleExtractionDatestring($date-time)
nullable: true

Date of sample extraction D_EXTR_DATE Opt 8

donorCcr5Statusstring
maxLength: 2
nullable: true

Donor CCR5 status D_CCR5 Opt 2

donorWeightKginteger($int32)
maximum: 999
minimum: 0
nullable: true

Donor weight in kilograms D_WEIGHT Opt 3

donorHeightCminteger($int32)
maximum: 999
minimum: 0
nullable: true
example: 175

Donor height in centimetres D_HEIGHT Opt 3

numberOfTransfusionsinteger($int32)
maximum: 9
minimum: 0
nullable: true

Number of transfusions D_NMBR_TRANS Opt 1

numberOfPregnanciesinteger($int32)
maximum: 9
minimum: 0
nullable: true

Number of pregnancies D_NMBR_PREG Opt 1

idm{...}
remarkstring
maxLength: 120
nullable: true

Remark REMARK Opt 120

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

4-digit ION of the recipientreceiving registry

donor*Embedded Donor Block
patient*Patient ID
Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
FieldDetails
originalMessage{...}
metaInformationEmbedded Meta Block

...

SendRetrieve
reservationRequestRequestreservationRequestRetrieve
Expand
titleRequest...
FieldDetails
request*
Expand
title...
FieldDetails
referenceCode*string($uuid)
expirationDatestring($date-time)
nullable: true

Request date EXPI_DATE Opt 8 yyyy-MM-dd [or yyyyMMdd]

acknowledgementIdstring
maxLength: 17
nullable: true
example: 1234567890abcdefg

Acknowledgement ID ACK_ID Opt 17

remarkstring
maxLength: 120
nullable: true

Remark REMARK Opt 120

recipientreceivingRegistry*string
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4-digit ION of the recipientreceiving registry

patient*Embedded Patient Block
donor*Donor ID
Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
originalMessage{...}
metaInformationEmbedded Meta Block

...

SendRetrieve
reservationResponseRequestreservationResponseRetrieve
Expand
titleRequest...
FieldDetails
response*
Expand
title...
FieldDetails
referenceCode*string($uuid)
expirationDatestring($date-time)
nullable: true

Date expiration of reservation EXPI_DATE Opt 8 yyyy-MM-dd [or yyyyMMdd]

confirmed*boolean

Confirmation of reservation CONFIRM Req 1

remarkstring
maxLength: 120
nullable: true

Remark REMARK Opt 120

recipientreceivingRegistry*string
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4-digit ION of the recipientreceiving registry

patient*Patient ID
donor*Embedded Donor Block
Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
FieldDetails
originalMessage{...}
metaInformationEmbedded Meta Block

...

SendRetrieve
reservationReleaseRequestreservationReleaseRetrieve
Expand
titleRequest...
FieldDetails
request*
Expand
title...
FieldDetails
referenceCode*string($uuid)
requestType*string
maxLength: 3

Type of request REQ_TYPE Req 3

reasonstring
maxLength: 3
minLength: 3
nullable: true

Reason of request cancellation REASON_CNCL Opt 3

remarkstring
maxLength: 120
nullable: true

Remark REMARK Opt 120

recipientreceivingRegistry*string
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4-digit ION of the recipientreceiving registry

patient*Patient ID
donor*Donor ID
Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
FieldDetails
originalMessage{...}
metaInformationEmbedded Meta Block

...

SendRetrieve
requestCancellationRequestrequestCancellationRetrieve
Expand
titleRequest...
FieldDetails
message*
Expand
title...
FieldDetails
referenceCode*string($uuid)
requestType*string
maxLength: 3

Type of request REQ_TYPE Req 3

reasonstring
maxLength: 3
minLength: 3
nullable: true

Reason of request cancellation REASON_CNCL Opt 3

remarkstring
maxLength: 120
nullable: true

Remark REMARK Opt 120

recipientreceivingRegistry*string
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4-digit ION of the recipientreceiving registry

patient*Patient ID
donor*Donor ID
Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
FieldDetails
originalMessage{...}
metaInformationEmbedded Meta Block

...

SendRetrieve
requestRejectedRequestrequestRejectedRetrieve
Expand
titleRequest...
FieldDetails
message*
Expand
title...
FieldDetails
referenceCode*string($uuid)
requestType*string
maxLength: 3

Type of request REQ_TYPE Req 3

reason*string
maxLength: 3
minLength: 2

Reason REASON Req 3

remarkstring
maxLength: 120
nullable: true

Remark REMARK Opt 120

recipientreceivingRegistry*string
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4-digit ION of the recipientreceiving registry

patient*Patient ID
donor*Donor ID
Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
originalMessage{...}
metaInformationEmbedded Meta Block

...

SendRetrieve
resultReminderRequestresultReminderRetrieve
Expand
titleRequest...
FieldDetails
message*
Expand
title...
FieldDetails
referenceCode*string($uuid)
resultType*string
maxLength: 9

Type of result reminded RES_TYPE Req 9

expirationDatestring($date-time)
nullable: true

Request date EXPI_DATE Opt 8 yyyy-MM-dd [or yyyyMMdd]

remarkstring
maxLength: 120
nullable: true

Remark REMARK Opt 120

recipientreceivingRegistry*string
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4-digit ION of the recipientreceiving registry

patient*Patient ID
donor*Donor ID
Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
FieldDetails
originalMessage{...}
metaInformationEmbedded Meta Block

...

SendRetrieve
genericRequestRequestgenericRequestRetrieve
Expand
titleRequest...
FieldDetails
request*
Expand
title...
FieldDetails
reason

string

reason for the generic request

recipientreceivingRegistry*string
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4-digit ION of the recipientreceiving registry

patientEmbedded Patient Block
donorDonor ID
Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
FieldDetails
originalMessage{...}
metaInformationEmbedded Meta Block

...