Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: version 1.0.1

...

Send (Post)
Retrieve (Post)
extendedTypingRequestRequestextendedTypingRequestRetrieve
Expand
titleRequest...
FieldDetails
request*
Expand
title...
FieldDetails
requestId

string
maxLength: 15
example:XX12345

resolutionRequired*string
example: "a": high

Replacement of the single string based resolutionRequired.

address*Embedded 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*Embedded Donor Block (donor in request)
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
e
xamplet: 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

...

PlantUML Render Macro
formatPNG
alignleft
titleGeneric Request

@startuml

participant "Patient Registry" as PR

control "Match-Connect" as MC

control "Search & Match Service" as SM

participant "Donor Registry" as DR

skinparam SequenceMessageAlign center

skinparam dpi 92

== Register Patient ==

PR -> SM : Create Patient

activate SM #FFBBBB

SM -> PR : Return wmdaId

deactivate SM

== Start Search ==


PR -> SM : Start Search

activate SM #FFBBBB

SM -> PR : Return searchId

deactivate SM

PR -> SM : Check search status

activate SM #FFBBBB

SM -> PR : Return search status (Completed, Running, Errored)

deactivate SM


PR -> SM : Retrieve search results

activate SM #FFBBBB

SM -> PR : Return search results

deactivate SM


== Making Request ==

PR -[#dodgerblue]> DR : Generic Request (incl. Embedded Patient Block)

DR -[#dodgerblue]> PR : Reservation Response 

PR -[#dodgerblue]> DR : Request Cancellation


== Getting Response ==

DR -[#dodgerblue]> PR : Request Rejection

@enduml

v1.0.1