...

The retrievePatientRequest is used to retrieve an individual patient's information from the Search & Match Service.

3.6 - Retrieve Patient List

The listPatientsRequest is used to retrieve multiple patient's information from the Search & Match Service.  You may define a page size, a specific page number, a series of allowable statuses and may limit to only patients assigned to you.

3.7 - Assign User To Patient

The AssignUserToPatient is used to assign a particular user name to a patient within the Search & Match Service.

3.8 - Register Patient   

...

3.10 - Update Registered Patient Status    

...

The updatePatientStatusRequest is used to communicate changes in patient status.

...

All hubs are strongly encouraged to monitor their international searches closely and stop or suspend them if not longer needed. The searched hub is allowed to send reminder faxes with patients without activities to the patient’s hub.

Fields for consideration:

Send	Receive
UpdateRegisteredPatientStatus	UpdateRegisteredPatientStatusDequeue
wmdaId newStatus changeReason	MetaInformation wmdaId newStatus changeReason

Additional fields to be considered (checked items have been added to Swagger):

Description	Name	Type	Comment
Sending Registry	regSend	string nullable: false	Retrieve message only
Receiving Registry	regReceive	string nullable: false	Should be on the 'Send' request
WMDA Patient Identifier	wmdaId	integer nullable: false
Old Patient State	priorStat	string nullable: true	This was discussed - do we need it?
New Patient State	newStat	string nullable: false
Reason For Change	reason	string nullable: true

...

TODO:  Design message flow & elaborate semantic detail.

3.12 - Message Flows

Image Added