...
The UpdatePatientStatusRequest is used to update a patient's search status with the Search & Match Service. Allowable statuses are SUS, PRE, ACT and STP. A new patient is defaulted to the preliminary (PRE) state. Under the PRE state, searches must be requested explicitly. Under the ACT state, searches will be kept up to date automatically. SUS will stop automatic updates to searches but results will remain for 45 days. STP will terminate the search.
| Send |
|---|
| UpdatePatientStatusRequest |
|
3.5 - Retrieve Patient
The retrievePatientRequest is used to retrieve an individual patient's information from the Search & Match Service.
| Send |
|---|
| RetrievePatientRequest |
|
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.
| Send |
|---|
| ListPatientsRequest |
|
3.7 - Assign User To Patient
The AssignUserToPatient is used to assign a particular user name to a patient within the Search & Match Service.
| Send |
|---|
| AssignUserToPatient |
|
3.8 - Register Patient
There is no registerPatientRequest endpoint. A patient is registered with a partner registry at the time of request - see the section on Requests.
3.
...
9 - Update Registered Patient 
The updateRegisteredPatientRequest is used to update a registered patient with a partner registry. Empty / blank fields in the payload will mean deletion. Missing fields will have no effect. The central hub can review the contents and update any relevant values that are (already) stored in the Search & Match system. ??The response of the api will provide results (fields / values) of the updates made.??
...
| Description | Name | Type | Comment |
|---|---|---|---|
| patientId | string nullable: false | |
| regSend | string nullable: false | Retrieve message only |
| regReceive | string nullable: false | |
| firstName | string nullable: true | |
| lastName | string nullable: true |
3.
...
10 - Update Registered Patient Status
...
| Sending Registry | regSend | string nullable: false |
| Receiving Registry | regReceive | string nullable: false |
| WMDA Patient Identifier | wmdaId | integer nullable: false |
| Old Patient State | priorStat | string nullable: true |
| New Patient State | newStat | string nullable: false |
| Reason For Change | reason | string nullable: true |
3.
...
11 - Request More Patient Info
Allows a donor registry to request more details about a patient from the patient registry, e.g. if that extra information is needed in a VT or later maybe a WU request. Locally developed and managed national rules should indicate which PII is required at which stage of the process.
...
TODO: Design message flow & elaborate semantic detail.
3.
...