Versions Compared

Key

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

...

SendRetrieve
extendedTypingRequestRequestextendedTypingRequestRetrieve
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

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
recipientinteger
maximum: 9999

minimum: 0

maxLength: 4

minLength: 4

example: 1234

4 digit ION of the recipient

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

...

SendRetrieve
sampleRequestRequest (comments refer to changes to the current API definition)sampleRequestRetrieve
Expand
titleRequest
FieldDetails
request
string($date-time)Request date REQ_DATE Req 8 yyyy-MM-dd [or yyyyMMdd]
Expand
title...
requestDate
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

recipientinteger
maximum: 9999

minimum: 0

maxLength: 4

minLength: 4

example: 1234

4-digit ION of the recipient

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

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

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

recipient*string
maximum: 9999

minimum: 0

maxLength: 4

minLength: 4

example: 1234

4-digit ION of the recipient

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
resultReminderRequestresultReminderRetrieve
Expand
titleRequest...
FieldDetails
message*
Expand
title...
string($date-time)
nullable: true
Request date REQ_DATE Opt 8 yyyy-MM-dd [or yyyyMMdd]
FieldDetails
requestDate
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

recipient*string
maximum: 9999

minimum: 0

maxLength: 4

minLength: 4

example: 1234

4-digit ION of the recipient

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

...