Versions Compared

Old Version 229

changes.mady.by.user Jan Hofmann

Saved on

compared with

New Version 230

changes.mady.by.user Matt Prestegaard

Saved on

Key

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

...

Send (Post)
Retrieve (Post)
/api/v2/extendedTypingRequestRequest/api/v2/extendedTypingRequestRetrieve
Expand
titleRequest...
FieldDetails
request*
Expand
title...
FieldDetails
requestingRegistryReferenceCode

string
maxLength: 15
example:XX12345

resolutionRequired*string
example: "a": high

Replacement of the single string based resolutionRequired.

addressEmbedded Address Block
isUrgent*boolean

Urgent request URGENT Opt 1

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

Remark REMARK Opt 120

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

4 digit ION of the receiving registry

patient*Embedded Patient Block
donor*Donor ID
Expand
titleResponse...
FieldDetails
wmdaResponse*Embedded WMDA Response Block
Expand
titleRequest...
limitinteger
default: 100
shouldPeekboolean
default: false

Set to true if you want messages to remain available after retrieval

messageSequenceNumber

integer
examplet: 12345

Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned.

Expand
titleResponse...
FieldDetails
generalInformation*Embedded General Information Block
originalMessage*{...}
metaInformation*Embedded Meta Block

...

Send (Post)
Retrieve (Post)
/api/v2/extendedTypingResponseRequest/api/v2/extendedTypingResponseRetrieve
Expand
titleRequest...
Field

Details

response*
Expand
title...
FieldDetails
requestingRegistryReferenceCodestring
maxLength: 15
example:XX12345
referenceCode*string($uuid)
hlaNomenclatureVersion*string
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

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

4-digit ION of the receiving registry

donor*Embedded Donor Block
patient*Patient ID
Expand
titleResponse...
FieldDetails
wmdaResponse*Embedded WMDA Response Block
Expand
titleRequest...
limitinteger
default: 100
shouldPeekboolean
default: false

Set to true if you want messages to remain available after retrieval

messageSequenceNumber

integer
examplet: 12345

Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned.

Expand
titleResponse...
generalInformation*Embedded General Information Block
originalMessage*{...}
metaInformation*Embedded Meta Block

...

Send (Post)
Retrieve (Post)
/api/v2/reservationRequestRequest/api/v2/reservationRequestRetrieve
Expand
titleRequest...
FieldDetails
request*
Expand
title...
FieldDetails
requestingRegistryReferenceCode

string

maxLength: 15

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

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

4-digit ION of the receiving registry

patient*Embedded Patient Block
donor*Donor ID
Expand
titleResponse...
FieldDetails
wmdaResponse*Embedded WMDA Response Block
Expand
titleRequest...
limitinteger
default: 100
shouldPeekboolean
default: false

Set to true if you want messages to remain available after retrieval

messageSequenceNumber

integer
examplet: 12345

Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned.

Expand
titleResponse...
generalInformation*Embedded General Information Block
originalMessage*{...}
metaInformation*Embedded Meta Block

...

Send (Post)
Retrieve (Post)
/api/v2/reservationResponseRequest/api/v2/reservationResponseRetrieve
Expand
titleRequest...
FieldDetails
response*
Expand
title...
FieldDetails
requestingRegistryReferenceCode

string

maxLength: 15

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

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

4-digit ION of the receiving registry

patient*Patient ID
donor*Embedded Donor Block
Expand
titleResponse...
FieldDetails
wmdaResponse*Embedded WMDA Response Block
Expand
titleRequest...
limitinteger
default: 100
shouldPeekboolean
default: false

Set to true if you want messages to remain available after retrieval

messageSequenceNumber

integer
examplet: 12345

Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned.

Expand
titleResponse...
FieldDetails
generalInformation*Embedded General Information Block
originalMessage*{...}
metaInformation*Embedded Meta Block

...

Send (Post)
Retrieve (Post)
/api/v2/reservationReleaseRequest ​/api​/v2​/reservationReleaseRetrieve
Expand
titleRequest...
FieldDetails
request*
Expand
title...
FieldDetails
requestingRegistryReferenceCode

string

maxLength: 15

referenceCode*string($uuid)
reason*string
maxLength: 3
minLength: 3
nullable: true

Reason of request cancellation REASON_CNCL Opt 3

remarkstring
maxLength: 120
nullable: true

Remark REMARK Opt 120

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

4-digit ION of the receiving registry

patient*Patient ID
donor*Donor ID
Expand
titleResponse...
FieldDetails
wmdaResponse*Embedded WMDA Response Block
Expand
titleRequest...
limitinteger
default: 100
shouldPeekboolean
default: false

Set to true if you want messages to remain available after retrieval

messageSequenceNumber

integer
examplet: 12345

Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned.

Expand
titleResponse...
FieldDetails
generalInformation*Embedded General Information Block
originalMessage*{...}
metaInformation*Embedded Meta Block

...