You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 112
Next »
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 | - Provided by the local registry system.
- Should be worldwide unique.
- Should follow the construct of hub code + local patient id.
- The hub code should be the two-character ISO country code of the registry (e.g. DE for Germany)
- In the case of multiple registries in one country, a replacement code will be assigned.
- Should be provided as a user-friendly (displayable) id for use on screens and on documentation.
|
wmdaId | - Generated by the central (SMC) system.
- Must be globally unique.
- Must be used for all system-to-system patient identification after the initial patient registration.
- Should be displayed on screens and on documentation.
|
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 |
---|
|
Patient |
---|
patientId | string maxLength: 17 nullable: true example: Organisation unique identifier for patient. Cannot be set unless "legalTerms" is set to "true". Do not use real names here. | hla* | {...} | idm | {...} | dateOfBirth | string($date) nullable: true maxLength: 10 example: 1961-05-27 | diagnosis | {...} | diseasePhase | string nullable: trueEnum: Array [ 48 ] | ethnicity | string nullable: trueEnum: Array [ 21 ] | poolCountryCode | string maxLength: 2 pattern: ^[A-Z]{2} nullable: true example: NLISO 3166-1 alpha-2 Country Code (capitalized) | transplantCentreId | string maxLength: 10 nullable: true example: TC X | abo | string nullable: trueEnum: Array [ 4 ] | rhesus | string nullable: trueEnum: Array [ 2 ] | weight | integer nullable: true minimum: 1 maximum: 999 example: 76 | sex | string nullable: trueEnum: Array [ 2 ] | legalTerms | boolean nullable: true default: false example: trueIf not set to true, then patientId will not be stored. |
Response wmdaId | integer example: 123456 nullable: false |
|
3.3 - Update Patient
The UpdatePatientRequest is used to update a patient with the Search & Match Service.
Send |
---|
UpdatePatient |
Patient |
---|
patientId | string maxLength: 17 nullable: true example: XY1234POrganisation unique identifier for patient. Cannot be set unless "legalTerms" is set to "true". Do not use real names here. | hla* | {...} | idm | {...} | dateOfBirth | string($date) nullable: true maxLength: 10 example: 1961-05-27 | diagnosis | {...} | diseasePhase | string nullable: trueEnum: Array [ 48 ] | ethnicity | string nullable: trueEnum: Array [ 21 ] | poolCountryCode | string maxLength: 2 pattern: ^[A-Z]{2} nullable: true example: NLISO 3166-1 alpha-2 Country Code (capitalized) | transplantCentreId | string maxLength: 10 nullable: true example: TC X | abo | string nullable: trueEnum: Array [ 4 ] | rhesus | string nullable: trueEnum: Array [ 2 ] | weight | integer nullable: true minimum: 1 maximum: 999 example: 76 | sex | string nullable: trueEnum: Array [ 2 ] | legalTerms | boolean nullable: true default: false example: trueIf not set to true, then patientId will not be stored. | wmdaId* | integer example: 123456 nullable: false |
Response None specified |
3.4 - Update Patient Status
The UpdatePatientStatusRequest is used to update a patient's search status with the Search & Match Service.

Send |
---|
UpdatePatientStatus |
Request wmdaId* | integer example: 123456 nullable: false | newStatus* | string maxLength: 3 nullable: falseEnum: Array [ 4 ] | changeReason | string maxLength: 3 nullable: trueReason why the change was made. Mandatory when changing to "STP" Enum: Array [ 21 ] |
Response wmdaId* | integer example: 123456 nullable: false | newStatus* | string maxLength: 3 nullable: falseEnum: Array [ 4 ] | changeReason | string maxLength: 3 nullable: trueReason why the change was made. Mandatory when changing to "STP" Enum: Array [ 21 ] |
|
3.5 - Retrieve Patient
The retrievePatientRequest is used to retrieve an individual patient's information from the Search & Match Service.
Send |
---|
RetrievePatient |
Request wmdaId* | integer example: 123456 nullable: false |
Response patientId* | string maxLength: 17 nullable: true example: XY1234POrganisation unique identifier for patient. Cannot be set unless "legalTerms" is set to "true". Do not use real names here. | status* | string nullable: falseEnum: Array [ 5 ] | hla* | {...} | idm* | {...} | dateOfBirth* | string($date) nullable: true maxLength: 10 example: 1961-05-27 | diagnosis* | {...} | diseasePhase* | string nullable: trueEnum: Array [ 48 ] | ethnicity* | string nullable: trueEnum: Array [ 21 ] | poolCountryCode* | string maxLength: 2 pattern: ^[A-Z]{2} nullable: true example: NLISO 3166-1 alpha-2 Country Code (capitalized) | transplantCentreId* | string maxLength: 10 nullable: true example: TC X | abo* | string nullable: trueEnum: Array [ 4 ] | rhesus* | string nullable: trueEnum: Array [ 2 ] | weight* | integer nullable: true minimum: 1 maximum: 999 example: 76 | sex* | string nullable: trueEnum: Array [ 2 ] | legalTerms* | boolean nullable: true default: false example: trueIf not set to true, then patientId will not be stored. | wmdaId* | integer example: 123456 nullable: false | lastUpdated* | string($date-time) nullable: false maxLength: 255needed to help determine when patient can be automatically moved to STP state | lastViewed* | string($date-time) nullable: false maxLength: 255needed for sorting patients in the patient list | assignedUserName* | string minLength: 4 maxLength: 100 nullable: true example: janethesearchcoordinator@lunarregistry.comtypically the e-mail address of the user |
|
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 |
Request limit integer (query) | Maximum number of patients per page. Default value : 100 | offset integer (query) | Starting position of the requested page. Default value : 0 | status array[string] (query) | the statuses that the patients are allowed to have Available values : NEW, PRE, ACT, SUS, STP Default value : null Example : ACT|NEW | onlyMyPatients boolean (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 |
Response Paging |
---|
limit* | integer default: 100 | offset* | integer default: 0 | totalCount* | integer minimum: 0 | Patients |
---|
wmdaId* | integer example: 123456 nullable: false | patientId* | string maxLength: 17 nullable: true example: XY1234POrganisation unique identifier for patient. Cannot be set unless "legalTerms" is set to "true". Do not use real names here. | status* | string nullable: falseEnum: Array [ 5 ] | dateOfBirth* | string($date) nullable: true maxLength: 10 example: 1961-05-27 | ethnicity* | string nullable: trueEnum: Array [ 21 ] | lastUpdated* | string($date-time) nullable: false maxLength: 255needed to help determine when patient can be automatically moved to STP state | lastViewed* | string($date-time) nullable: false maxLength: 255needed for sorting patients in the patient list | assignedUserName* | string minLength: 4 maxLength: 100 nullable: true example: janethesearchcoordinator@lunarregistry.comtypically the e-mail address of the user | requests* | [...] |
|
3.7 - Assign User To Patient
The AssignUserToPatient is used to assign a particular user name to a patient within the Search & Match Service.
3.9 - Update Registered Patient (PAT_UPD)
The updateRegisteredPatientRequest is used to update a registered patient with a partner registry.
Send | Retrieve |
---|
UpdateRegisteredPatient | UpdateRegisteredPatientRetrieve |
Request recipient | integer maximum: 9999 minimum: 0 maxLength: 4 minLength: 4 example: 12344 digit ION of recipient | Patient |
---|
wmdaId* | integer nullable: false example: 1234ID provided by the WMDA | patientId* | string maxLength: 17 nullable: false example: XY1234POrganisation unique identifier for patient. Cannot be set unless "legalTerms" is set to "true". Do not use real names here. | hla* | {...} | idm | {...} | dateOfBirth | string($date) nullable: true maxLength: 10 example: 1961-05-27 | diagnosis | {...} | diseasePhase | string nullable: trueEnum: Array [ 48 ] | ethnicity | string nullable: trueEnum: Array [ 20 ] | poolCountryCode | string maxLength: 2 pattern: ^[A-Z]{2} nullable: true example: NLISO 3166-1 alpha-2 Country Code (capitalized) | abo | string nullable: trueEnum: Array [ 4 ] | rhesus | string nullable: trueEnum: Array [ 2 ] | weight | integer nullable: true minimum: 1 maximum: 999 example: 76 | sex | string nullable: trueEnum: Array [ 2 ] | firstName | string maxLength: 30 nullable: true example: JohnFirst (given name) of the patient | lastName | string maxLength: 30 nullable: true example: DoeLast (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 | stringEnum: Array [ 3 ] | remark | [...] |
| - MetaInformation
- Sent payload
|
3.10 - Flows
