core.inviterequest | Medplum

InviteRequest interface

Signature:

export interface InviteRequest

Properties

Property Modifiers Type Description
access? ProjectMembershipAccess[] (Optional)
accessPolicy? Reference (Optional)
admin? boolean (Optional)
email? string (Optional)
externalId? string (Optional)
firstName string
forceNewMembership? boolean (Optional)
lastName string
membership? Partial (Optional)
mfaRequired? boolean (Optional)
password? string (Optional)
patient? Reference (Optional) The patient that a newly provisioned RelatedPerson is related to. Required when inviting a RelatedPerson without an existing membership.profile, since RelatedPerson.patient is a required FHIR field.
resourceType 'Patient' | 'Practitioner' | 'RelatedPerson'
scope? 'project' | 'server' (Optional)
sendEmail? boolean (Optional)
upsert? boolean (Optional)