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 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.
Patient Identifiers
Identifier | Description |
---|---|
patientId |
|
wmdaId |
|
The createPatient endpoint is used to submit a patient to the Search & Match Service. This call returns a wmdaId for the patient.
Post | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
createPatient | ||||||||||||||||||||||||||||||||||||
|
The updatePatient endpoint is used to update a patient with the Search & Match Service.
Put | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
updatePatient | ||||||||||||||||||||||||||||||||||
|
The updatePatientStatus endpoint is used to update a patient's search status with the Search & Match Service. Allowable 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.
Put | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
updatePatientStatus | ||||||||||||||||||
|
The retrievePatient is used to retrieve an individual patient's information from the Search & Match Service.
(DO NOT USE, TO BE DEPRECATED in V3. Use patients/list endpoint instead)
Get | ||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
retrievePatient | ||||||||||||||||||||||||||||||||||||||||||||||
|
The retrievePatientList endpoint 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.
Post | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
retrievePatientList | ||||||||||||||||||||||||||||||||||||||||||||||||
|
The assignUserToPatient endpoint is used to assign a particular user name to a patient within the Search & Match Service.
Put | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
assignUserToPatient | ||||||||||||||
|
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.
The updateRegisteredPatient endpoint is used to update a registered patient with a partner registry.
Send (Post) | Retrieve (Post) | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
updateRegisteredPatient | updateRegisteredPatientRetrieve | ||||||||||||||||||||||||||||
|
|
participant "Patient Registry" as PR control "Match-Connect" as MC control "Search & Match\nService" as SM participant "Donor Registry" as DR skinparam SequenceMessageAlign center == Register Patient == PR -> SM : Send Patient SM -> PR : Return WMDA PID == Modify Patient == PR --> SM : Update Patient PR --> SM : Assign User To Patient == Retrieve Patient(s) == PR -> SM : Retrieve Patients SM -> PR : Return One or More Patients == Making Requests == PR -> SM : Update Patient Status (ACT) PR -[#blue]> DR : Request a Donor (patient embedded) PR -[#blue]> DR : Update Registered Patient |