⚠Due to planned maintenance you will experience short (<30 min) downtime between 08:00 - 08:30 CET.
Table of Contents | ||
---|---|---|
|
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 same patient is not identified with another wmdaId. registered by multiple organisations using the same patientId or with different patientId's within the same organisation. The wmdaId must be used to identify the patient in all calls to the Search, Match & Connect (SMC) service after the initial patient registration.
...
Identifier | Description |
---|---|
patientId |
|
wmdaId |
|
3.2 - Create
...
Patient
...
A POST to the patients endpoint The CreatePatientRequest is used to submit a patient to the Search & Match Service. This call returns a wmdaId for the patient.
SendPost | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CreatePatientpatients | ||||||||||||||||||||||||||||||||||||||||||||
|
3.3 - Update Patient
The UpdatePatientRequest A PUT to the patients endpoint is used to update a patient with the Search & Match Service. An update to search relevant information, such as HLA, ethnicity or pool will result in a refresh of the search.
SendPut | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
UpdatePatientpatients | ||||||||||||||||||||||||||||||||||||||||||
|
3.4 - Update Patient Status
The UpdatePatientStatusRequest A PUT to the patients/status endpoint is used to update a patient's search status with the Search & Match Service. Allowable statuses status values 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.
Include Page | ||||
---|---|---|---|---|
|
Put | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
patients/status | ||||||||||||||||||||||||||||||||||||
Send | ||||||||||||||||||||||||||||||||||||
UpdatePatientStatus | ||||||||||||||||||||||||||||||||||||
|
3.5 - Retrieve Patient
The retrievePatientRequest A GET to the patients endpoint is used to retrieve an individual patient's information from the Search & Match Service.
Send
Get | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
patients | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
3.6 - Retrieve Patient
...
(s)
A GET to the patients/list endpoint 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.
onlyMyPatients
boolean
Post | |
---|---|
patients/list | |
Send | |
ListPatients | |
Request | |
limit (query) | Maximum number of patients per page. Default value : 100 |
offset (query) | Starting position of the requested page. Default value : 0 |
status (query) | the statuses that the patients are allowed to have Available values : NEW, PRE, ACT, SUS, STP Default value : null Example : ACT|NEW |
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
|
|
Default value : false
Response
pagingExpand | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
|
|
3.7 - Assign User To Patient
The AssignUserToPatient A PUT to the patients/user endpoint is used to assign a particular user name to a patient within the Search & Match Service.
Put | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
patients/user | |||||||||||||||||
| |||||||||||||||||
Send | |||||||||||||||||
AssignUserToPatient | |||||||||||||||||
Request
|
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 - described in the Admin chapter.
3.9 - Update Registered Patient (PAT_UPD)
The updateRegisteredPatientRequest updateRegisteredPatient message is used to update a registered patient with a partner registry.
Send (Post) | Retrieve | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
UpdateRegisteredPatient | UpdateRegisteredPatientRetrieve | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
(Post) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updateRegisteredPatient | updateRegisteredPatientRetrieve | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request recipient
Request No parameters specified Response patient
|
|
3.10 -
...
Patient Flows
PlantUML Render Macro | ||
---|---|---|
| ||
participant "Patient Registry" as PR control "Match-Connect" as MC control "Search & Match\nService" 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 WMDA Patient ID deactivate SM == Modify Patient == PR -> SM : Update Patient PR -> SM : Assign User To Patient == Retrieve Patient(s) == PR -> SM : Retrieve Patients activate SM #FFBBBB SM -> PR : Return One or More Patients deactivate SM == Making Requests == PR -[#dodgerblue]> DR : <color #dodgerblue> Request a Donor (patient embedded) </color> PR -[#dodgerblue]> DR : <color #dodgerblue> Update Registered Patient </color> |
3.11 - Patient Life Cycle
Include Page | ||||
---|---|---|---|---|
|