User | Medplum

On this page

Representation of a human user of the system.

Schema

Elements

Name	Required	Type	Description
identifier		Identifier[]	An identifier for this user Details An identifier for this user.
firstName	✓	string	Details The first name or given name of the user. This is the value as entered when the user is created. It is used to populate the profile resource.
lastName	✓	string	Details The last name or family name of the user. This is the value as entered when the user is created. It is used to populate the profile resource.
externalId		string	Details @deprecated Replaced by ProjectMembership.externalId.
email		string	Details The email address that uniquely identifies the user. Must be all lowercase.
emailVerified		boolean	Details Whether the system has verified that the user has access to the email address.
admin		boolean	@deprecated Details @deprecated
passwordHash		string	Details Encrypted hash of the user's password.
mfaSecret		string	Details Shared secret for MFA authenticator applications.
mfaRequired		boolean	Details Whether the user is required to complete MFA enrollment. If true, the user must complete MFA enrollment before they can log in.
mfaEnrolled		boolean	Details Whether the user has completed MFA enrollment.
mfaMethod		code[]	Details The MFA methods the user has enrolled in. 'totp' uses an authenticator application; 'email' sends a magic link to the user's email address on login.
project		Reference< Project >	Details Optional project if the user only exists for the project. This is used for the project-specific user database.

Search Parameters

Name	Type	Description	Expression
identifier	token	The identifier of the user	User.identifier
email	string	The email address of the user	User.email
external-id	string	The externalID of the user	User.externalId
project	reference	The project that contains the user	User.project

Inherited Elements

Name	Required	Type	Description
id		string	Logical id of this artifact Details The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta		Meta	Details The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules		uri	Details A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language		code	Details The base language in which the resource is written.
text		Narrative	Text summary of the resource, for human interpretation Details A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained		Resource[]	Details These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension		Extension[]	Additional content defined by implementations Details May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension		Extension[]	Extensions that cannot be ignored Details May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).