CreatePatientExternalIdentifier

Last updated: 26 Jun 2025

CreatePatientExternalIdentifier #

Creates a new external identifier for a patient.

Parameters #

Name	Type	Description
patient_id	UUID	The unique identifier of the patient.
system	String	The system for the external identifier (url).
value	String	The value of the external identifier.

Example #

from canvas_sdk.v1.effects.patient import CreatePatientExternalIdentifier

effect = CreatePatientExternalIdentifier(
    patient_id="1eed3ea2a8d546a1b681a2a45de1d790",
    system="https://www.va.gov/",
    value="VET123456"
)

This effect will create a new external identifier for the specified patient.