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

Compare with Current View Page History

« Previous Version 26 Next »

3.1 - Patient Identification

A patientId may be provided when registering a new patient.  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.

TODO:  Discuss whether patientId should be made required within createPatientRequest and updatePatientRequest

Risk of nullable is that duplicate patients may be created.  Some transplant centers or patient registries may have concerns with sharing a patientId before the point of donor request.  If we make patientId required then we should also consider enforcing uniqueness.  Decision on nullability deferred to the business requirements group.

wmdaId
  • Generated by the central (SMC) system.
  • Must be 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.


CreatePatientRequest (/api/v2/patients)

Changes to be considered:

Patient IdentificationpatientIdstring
nullable: true → change to false

3.3 - Update Patient

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

UpdatePatientRequest (/api/v2/patients)

No changes expected.

3.4 - Register Patient   

The registerPatientRequest is used to register a patient with a partner registry.  This message accompanies all requests.

RegisterPatientRequest

Same payload as UpdatePatientRequest (/api/v2/patients).  Additional fields to be considered:

Sending RegistryregSendstring
Receiving RegistryregReceivestring

3.5 - Update Registered Patient    

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

TODODiscuss whether we need this message.  Does the requesting registry take responsibility for sending updates to the partners it wants OR does SMC take responsibility for updating patients with all registries with which the patient has been shared?

UpdateRegisteredPatientRequest

Same payload as RegisterPatientRequest.

  • No labels