⚠Due to planned maintenance you will experience short (<30 min) downtime between 08:00 - 08:30 CET.
3.1 - Patient Identification
A patientId may be provided when registering a new patient in WMDA Search & Match. Upon registration, a wmdaId will be assigned and returned. The wmdaId itself is guaranteed to be globally unique, though it cannot guarantee that the patient is not identified with another wmdaId. The wmdaId must be used to identify the patient in all calls to the Search, Match & Connect (SMC) service after the initial patient registration.
Patient Identifiers
Identifier | Description |
---|---|
patientId |
|
wmdaId |
|
3.2 - Create Patient (Send Patient)
The CreatePatientRequest is used to submit a patient to the Search & Match Service. This call returns a wmdaId for the patient.
Send | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CreatePatient | ||||||||||||||||||||||||||||
|
3.3 - Update Patient
The UpdatePatientRequest is used to update a patient with the Search & Match Service.
Send | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
UpdatePatient | ||||||||||||||||||||||||||||||
|
3.4 - Update Patient Status
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 new (NEW) state. Under the NEW state, searches must be requested explicitly. When doing so, the patient is moved to the PRE state. Under the ACT state, searches will be kept up to date automatically. SUS will stop automatic updates to searches but results will remain for 42 days. STP will terminate the search and delete all search results.
This endpoint does not affect the patient status at the donor registry or cord blood bank. For that please use endpoint UpdateRegisteredPatientStatus
Send |
---|
UpdatePatientStatus |
|
3.5 - Retrieve Patient
The retrievePatientRequest is used to retrieve an individual patient's information from the Search & Match Service.
Send |
---|
RetrievePatient |
|
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 |
---|
ListPatients |
|
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 in the form of an embedded Patient block - see the section on Requests.
Send | Retrieve | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
All requests | All request retrievals | ||||||||||||||||||||||||||||||
|
|
3.9 - Update Registered Patient
The updateRegisteredPatientRequest is used to update a registered patient with a partner registry. The central hub will review the contents and update any values that are already stored in the Search & Match system.
Send | Retrieve | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
UpdateRegisteredPatient | UpdateRegisteredPatientRetrieve | ||||||||||||||||||||||||||||||
|
|
3.10 - Update Registered Patient Status - /* REMOVE */
Send | Receive |
---|---|
UpdateRegisteredPatientStatus - /* Remove */ | UpdateRegisteredPatientStatusRetrieve /* Remove */ |
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.
If a request is received where patient information is expected, but missing: Acknowledge received message and respond with warning that search is on hold until missing info is received, perhaps with reference to national rules.
TODO: Design message flow & elaborate semantic detail.