You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 106 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

IdentifierDescription
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
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

The UpdatePatientStatusRequest is used to update a patient's search status with the Search & Match Service.  Allowable statuses 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.

This endpoint does not affect the patient status at the donor registry or cord blood bank. For that please use endpoint UpdateRegisteredPatientStatus

Send
UpdatePatientStatus
  • wmdaId
  • newStatus
  • changeReason

3.5 - Retrieve Patient

The retrievePatientRequest is used to retrieve an individual patient's information from the Search & Match Service.

Send
RetrievePatient
  • wmdaId

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
  • limit
  • offset
  • status
  • onlyMyPatients

3.7 - Assign User To Patient

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

Send
AssignUserToPatient
  • wmdaId
  • userName

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 - see the section on Requests. 

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

3.9 - Update Registered Patient    

The updateRegisteredPatientRequest is used to update a registered patient with a partner registry.  The central hub will review the contents and update any values that are already stored in the Search & Match system.


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 - Message Flows





  • No labels