⚠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.
Get | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
patients | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Send | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
RetrievePatient | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request
|
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 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
|
|
Expand | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
|
Default value : false
Response
Paging
|
|
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.
wmdaId
integer
nullable: false
example: 1234
maxLength: 17
nullable: false
example: XY1234P
nullable: true
maxLength: 10
example: 1961-05-27diagnosis{...}diseasePhase
maxLength: 2
pattern: ^[A-Z]{2}
nullable: true
example: NL
nullable: true
minimum: 1
maximum: 999
example: 76sex
maxLength: 30
nullable: true
example: John
maxLength: 30
nullable: true
example: Doe
Send (Post) | Retrieve | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
UpdateRegisteredPatient | UpdateRegisteredPatientRetrieve | ||||||||||
(Post) | |||||||||||
updateRegisteredPatient | updateRegisteredPatientRetrieve | ||||||||||
Request recipient
| |||||||||||
Patient |
|
|
nullable: false
example: 1234
ID provided by the WMDA
patientId*stringmaxLength: 17
nullable: false
example: XY1234P
Organisation unique identifier for patient. Cannot be set unless "legalTerms" is set to "true". Do not use real names here.
hla*{...}idm{...}dateOfBirthstring($date)nullable: true
maxLength: 10
example: 1961-05-27diagnosis{...}diseasePhase
string
nullable: true
Enum:
Array [ 48 ]
string
nullable: true
Enum:
Array [ 20 ]
maxLength: 2
pattern: ^[A-Z]{2}
nullable: true
example: NL
ISO 3166-1 alpha-2 Country Code (capitalized)
abostring
nullable: true
Enum:
Array [ 4 ]
string
nullable: true
Enum:
Array [ 2 ]
nullable: true
minimum: 1
maximum: 999
example: 76sex
string
nullable: true
Enum:
Array [ 2 ]
maxLength: 30
nullable: true
example: John
First (given name) of the patient
lastNamestringmaxLength: 30
nullable: true
example: Doe
Last (family name) of the patient
Response
deliveredAtUtc | string($date-time) Server-supplied timestamp showing time of Message delivery to recipient's inbox queue |
referenceMessageId | string($uuid) |
responseType | string Enum: |
remark | [...] |
Request
No parameters specified
Response
patient* | {...} |
metaInformation* | {...} |