⚠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.
Post | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
patients | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Send | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
CreatePatient
|
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.
Put | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
patients | |||||||||||||||||||||||||||||||||||||||||||
Send | |||||||||||||||||||||||||||||||||||||||||||
UpdatePatient | |||||||||||||||||||||||||||||||||||||||||||
Request
|
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 | ||||||||||||||||||||||||||||
Request
maxLength: 3
|
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.
Response
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 |
onlyMyPatients (query) | Only return patients assigned to current user. Based on username property in JWT token. Does not work with machine credentials (direct API connection without WMDA frontend). Default value : false |
Expand | ||
---|---|---|
| ||
limit*
| integer default: 100 | |
offset* | integer default: 0 | |
totalCount* | integer minimum: 0 | |
Expand | ||
| ||
| ||
wmdaId* | integer example: 123456 nullable: false |
string |
NL12345P Organisation unique identifier for patient. Cannot be set unless "legalTerms" is set to "true". Do not use real names here. |
limit |
integer |
: |
Array [ 5 ]dateOfBirth*string($date)
nullable:
true |
default: |
100 |
250 | |
offset | integer |
nullable: |
true |
default: 0 |
nullable: false
maxLength: 255
needed to help determine when patient can be automatically moved to STP state
lastViewed*string($date-time)nullable: false
maxLength: 255
needed for sorting patients in the patient list
assignedUserName*stringminLength: 4
maxLength: 100
nullable: true
example: janethesearchcoordinator@lunarregistry.com
typically the e-mail address of the user
requests*[...]
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||
|