Versions Compared

Old Version 105

changes.mady.by.user Matt Prestegaard

Saved on

compared with

New Version 106

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
All requestsAll request retrievals
  • Request

  • 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

...

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 -

...

3.11 - Request More Patient Info Image Removed

Allows a donor registry to request more details about a patient from the patient registry, e.g. if that extra information is needed in a VT or later maybe a WU request.  Locally developed and managed national rules should indicate which PII is required at which stage of the process.

If a request is received where patient information is expected, but missing: Acknowledge received message and respond with warning that search is on hold until missing info is received, perhaps with reference to national rules.

TODO:  Design message flow & elaborate semantic detail.

...

Message Flows