Versions Compared

Old Version 153

changes.mady.by.user Mark Melchers

Saved on

compared with

New Version 154

changes.mady.by.user Rimke Postel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

e

Table of Contents
maxLevel1

...

The createPatient endpoint is used to submit a patient to the Search & Match Service. This call returns a wmdaId for the patient.

SendPost
createPatient
Expand
titleRequest...
FieldDetails
patientIdstring
maxLength: 17
nullable: true
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-27
diagnosis{...}
diseasePhase

string
nullable: true

Enum:
Array [ 48 ]

ethnicity

string
nullable: true

Enum:
Array [ 21 ]

poolCountryCodestring
maxLength: 2
pattern: ^[A-Z]{2}
nullable: true
example: NL

ISO 3166-1 alpha-2 Country Code (capitalized)

transplantCentreIdstring
maxLength: 10
nullable: true
example: TC X
abo

string
nullable: true

Enum:
Array [ 4 ]

rhesus

string
nullable: true

Enum:
Array [ 2 ]

weightinteger
nullable: true
minimum: 1
maximum: 999
example: 76
sex

string
nullable: true

Enum:
Array [ 2 ]

legalTermsboolean
nullable: true
default: false
example: true

If not set to true, then patientId will not be stored.

Expand
titleResponse...
FieldDetails
wmdaIdinteger
example: 123456
nullable: false

...

The updatePatient endpoint is used to update a patient with the Search & Match Service.

SendPut
updatePatient
Expand
titleRequest...
FieldDetails
patientIdstring
maxLength: 17
nullable: true
example: XY1234P

Organisation unique identifier for patient. Cannot be set unless "legalTerms" is set to "true". Do not use real names here.

A patient ID can only be updated when it was not set before. 

hla*{...}
idm{...}
dateOfBirthstring($date)
nullable: true
maxLength: 10
example: 1961-05-27
diagnosis{...}
diseasePhase

string
nullable: true

Enum:
Array [ 48 ]

ethnicity

string
nullable: true

Enum:
Array [ 21 ]

poolCountryCodestring
maxLength: 2
pattern: ^[A-Z]{2}
nullable: true
example: NL

ISO 3166-1 alpha-2 Country Code (capitalized)

transplantCentreIdstring
maxLength: 10
nullable: true
example: TC X
abo

string
nullable: true

Enum:
Array [ 4 ]

rhesus

string
nullable: true

Enum:
Array [ 2 ]

weightinteger
nullable: true
minimum: 1
maximum: 999
example: 76
sex

string
nullable: true

Enum:
Array [ 2 ]

legalTermsboolean
nullable: true
default: false
example: true

If not set to true, then patientId will not be stored.

wmdaId*integer
example: 123456
nullable: false
Expand
titleResponse...
None specified

...

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.


SendPut
updatePatientStatus
Expand
titleRequest...
FieldDetails
wmdaId*integer
example: 123456
nullable: false
newStatus*

string
nullable: false

Enum:
Array [ 4 ]

changeReasonstring
nullable: true

Reason why the change was made. Mandatory when changing to "STP"

Enum:
Array [ 21 ]
Expand
titleResponse...
FieldDetails
wmdaId*integer
example: 123456
nullable: false
newStatusstatus*

string
maxLength: 3
nullable: false

Enum:
Array [ 4 ]

changeReasonstring
maxLength: 3
nullable: true

Reason why the change was made. Mandatory when changing to "STP"

Enum:
Array [ 21 ]

...

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)

GetSend
retrievePatient 
Expand
titleRequest...
FieldDetails
wmdaId*integer
example: 123456
nullable: false
Expand
titleResponse...
FieldDetails
patientId*string
maxLength: 17
nullable: true
example: XY1234P

Organisation unique identifier for patient. Cannot be set unless "legalTerms" is set to "true". Do not use real names here.

status*

string
nullable: false

Enum:
Array [ 5 ]

hla*{...}
idm*{...}
dateOfBirth*string($date)
nullable: true
maxLength: 10
example: 1961-05-27
diagnosis*{...}
diseasePhase*

string
nullable: true

Enum:
Array [ 48 ]

ethnicity*

string
nullable: true

Enum:
Array [ 21 ]

poolCountryCode*string
maxLength: 2
pattern: ^[A-Z]{2}
nullable: true
example: NL

ISO 3166-1 alpha-2 Country Code (capitalized)

transplantCentreId*string
maxLength: 10
nullable: true
example: TC X
abo*

string
nullable: true

Enum:
Array [ 4 ]

rhesus*

string
nullable: true

Enum:
Array [ 2 ]

weight*integer
nullable: true
minimum: 1
maximum: 999
example: 76
sex*

string
nullable: true

Enum:
Array [ 2 ]

legalTerms*boolean
nullable: true
default: false
example: true

If not set to true, then patientId will not be stored.

wmdaId*integer
example: 123456
nullable: false
lastUpdated*string($date-time)
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*string
minLength: 4
maxLength: 100
nullable: true
example: janethesearchcoordinator@lunarregistry.com

typically the e-mail address of the user

...

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.

SendPost
retrievePatientList
Expand
titleRequest...

Field

Details

patientId

string
maxLength: 17
nullable: true
example: NL12345P

Organisation unique identifier for patient. Cannot be set unless "legalTerms" is set to "true". Do not use real names here.

limit

integer

Maximum number of patients per page.

nullable: true
default: 100
Default value : 100example:250

offset

integer

Starting position of the requested page.

Default value nullable: true
default: 0

status

array[string]

the statuses that the patients are allowed to have

Available values : NEW, PRE, ACT, SUS, STP

Default value : null

Example : ACT|NEW

onlyMyPatients

onlyMyPatients

booleanboolean
default: 0
nullable: true
example: true

Only return patients assigned to current user. Based on username property in JSON Web Token (JWT). Does not work with machine credentials (direct API connection without WMDA frontend).Default value : false
Expand
titleResponse...
Field

Details

paging
Expand
title...
FieldDetails
limit*integer
default: 100
offset*integer
default: 0
totalCount*integer
minimum: 0
patients
Expand
title...
FieldDetails
wmdaId*integer
example: 123456
nullable: false
patientId*string
maxLength: 17
nullable: true
example: XY1234P

Organisation unique identifier for patient. Cannot be set unless "legalTerms" is set to "true". Do not use real names here.

status*

string
nullable: false

Enum:
Array [ 5 ]

dateOfBirth*string($date)
nullable: true
maxLength: 10
example: 1961-05-27
ethnicity*

string
nullable: true

Enum:
Array [ 21 ]

lastUpdated*string($date-time)
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*string
minLength: 4
maxLength: 100
nullable: true
example: janethesearchcoordinator@lunarregistry.com

typically the e-mail address of the user

requests*[...]

...

The assignUserToPatient endpoint is used to assign a particular user name to a patient within the Search & Match Service.

SendPut
assignUserToPatient
Expand
titleRequest...
FieldDetails
wmdaId*integer
example: 123456
nullable: false
userName*string
minLength: 4
maxLength: 100
nullable: true
example: janethesearchcoordinator@lunarregistry.com

typically the e-mail address of the user

Expand
titleResponse...
FieldDetails
succeededboolean
default: true
messagestring
example: Successfully assigned janethesearchcoordinator@lunarregistry.com

...

The updateRegisteredPatient endpoint is used to update a registered patient with a partner registry.


Send (Post)Retrieve (Post)
updateRegisteredPatientupdateRegisteredPatientRetrieve
Expand
titleRequest...
FieldDetails
receivingRegistry*integer
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4 digit ION of receiving registry

patient*Embedded Patient Block
Expand
titleResponse...
FieldDetails
wmdaResponse*Embedded WMDA Response Block
Expand
titleRequest...
limitinteger
default: 100
shouldPeekboolean
default: false

Set to true if you want messages to remain available after retrieval

messageSequenceNumber

integer
example: 12345

Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned.

Expand
titleResponse...
FieldDetails
generalInformationEmbedded General Information Block
originalMessagepatient*Embedded Patient Block
metaInformation*Embedded Meta Block

...