Versions Compared

Old Version 103

changes.mady.by.user Matt Prestegaard

Saved on

compared with

New Version 104

changes.mady.by.user Matt Prestegaard

Saved on

Key

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

...

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

Send
CreatePatient

  • Patient

    patientIdstring
    maxLength: 17
    nullable: true
    example: P1234XX

    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{...}
    diseasePhasestring
    nullable: true    Enum:
    Array [ 48 ]
    ethnicitystring
    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
    abostring
    nullable: true    Enum:
    Array [ 4 ]
    rhesusstring
    nullable: true    Enum:
    Array [ 2 ]
    weightinteger
    nullable: true
    minimum: 1
    maximum: 999
    example: 76
    sexstring
    nullable: true    Enum:
    Array [ 2 ]
    legalTermsboolean
    nullable: true
    default: false
    example: true

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

3.3 - Update Patient

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

Send
UpdatePatient

  • Patient

    patientIdstring
    maxLength: 17
    nullable: true
    example: P1234XX

    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{...}
    diseasePhasestring
    nullable: true    Enum:
    Array [ 48 ]
    ethnicitystring
    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
    abostring
    nullable: true    Enum:
    Array [ 4 ]
    rhesusstring
    nullable: true    Enum:
    Array [ 2 ]
    weightinteger
    nullable: true
    minimum: 1
    maximum: 999
    example: 76
    sexstring
    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

3.4 - Update Patient Status

...

SendRetrieve
UpdateRegisteredPatientUpdateRegisteredPatientRetrieve

  • Patient

    wmdaId*integer
    nullable: false
    example: 1234

    ID provided by the WMDA

    patientId*string
    maxLength: 17
    nullable: false
    example: P1234XX

    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{...}
    diseasePhasestring
    nullable: true    Enum:
    Array [ 48 ]
    ethnicitystring
    nullable: true    Enum:
    Array [ 20 ]
    poolCountryCodestring
    maxLength: 2
    pattern: ^[A-Z]{2}
    nullable: true
    example: NL

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

    abostring
    nullable: true    Enum:
    Array [ 4 ]
    rhesusstring
    nullable: true    Enum:
    Array [ 2 ]
    weightinteger
    nullable: true
    minimum: 1
    maximum: 999
    example: 76
    sexstring
    nullable: true    Enum:
    Array [ 2 ]
    firstNamestring
    maxLength: 30
    nullable: true
    example: John

    First (given name) of the patient

    lastNamestring
    maxLength: 30
    nullable: true
    example: Doe

    Last (family name) of the patient


  • MetaInformation
  • Sent payload

3.10 - Update Registered Patient

...

The updatePatientStatusRequest is used to communicate changes in patient status.

(This is separate from the Search & Match updatePatientStatusRequest.  The payload is similar though the status variables may have a different name.  This is intended to be forwarded to the donor registry, not for consumption by Search & Match.  The patient registry is responsible to STP the search w/ Search & Match Service).

Statuses permitted are ACT, STP.

After the status has been set to stopped (STP), all pending requests but WOR_REQ are cancelled automatically at the remote hub. In this case, no REQ_CAN messages have to be sent by the transplant centre. The only way to reactivate the patient is to send a request (generic or other). The request is necessary since it cannot be guaranteed that the patient information is still up-to-data or stored at all at the remote hub. General data retention policies determine, how long patient information is retained after the search was stopped. 

However, it makes no sense to delete a patient who is in workup. Patient searches are sometimes not stopped at remote hubs although the search is not really active any more. This wastes time for matching and gives bad statistics about search length and search counts.

...

Status - /* REMOVE */

SendReceive
UpdateRegisteredPatientStatusUpdateRegisteredPatientStatusRetrieve
  • wmdaId
  • newStatus
  • changeReason
 - /* Remove */UpdateRegisteredPatientStatusRetrieve /* Remove */
  • MetaInformation
    • Sent payload

    3.11 - Request More Patient Info 

    ...