ProjectMembership | Medplum

Medplum Project Membership

A project membership grants a user access to a project.

Schema

Elements

Name	Required	Type	Description
identifier		Identifier[]	An identifier for this ProjectMembership Details An identifier for this ProjectMembership.
active		boolean	Whether this patient's record is in active use Details Whether this project membership record is in active use.
project	✓	Reference<Project>	Details Project where the memberships are available.
invitedBy		Reference<Bot	ClientApplication
user	✓	Reference<Bot	ClientApplication
profile	✓	Reference<Bot	ClientApplication
userName		string	Details SCIM userName. A service provider's unique identifier for the user, typically used by the user to directly authenticate to the service provider.
externalId		string	Details SCIM externalId. A string that is an identifier for the resource as defined by the provisioning client.
accessPolicy		Reference<AccessPolicy>	Details The access policy for the user within the project membership.
access		ProjectMembershipAccess[]	Details Extended access configuration using parameterized access policies.
policy	✓	Reference<AccessPolicy>	Details The base access policy used as a template. Variables in the template access policy are replaced by the values in the parameter.
parameter		ProjectMembershipAccessParameter[]	Details User options that control the display of the application.
name	✓	code	Details The unique name of the parameter.
value[x]	✓	string, Reference<>	Value of the parameter. Details Value of the parameter - must be one of a constrained set of the data types (see Extensibility for a list).
userConfiguration		Reference<UserConfiguration>	Details The user configuration for the user within the project membership such as menu links, saved searches, and features.
admin		boolean	Whether this user is a project administrator. Details Whether this user is a project administrator.

Search Parameters

Name	Type	Description	Expression
project	reference	The project associated with the project membership	ProjectMembership.project
user	reference	The user associated with the project membership	ProjectMembership.user
profile	reference	The user profile associated with the project membership	ProjectMembership.profile
profile-type	token	Resource type of the user profile associated with the project membership	ProjectMembership.profile.resolve().resourceType
user-name	string	The SCIM userName of the user	ProjectMembership.userName
external-id	string	The externalID of the user	ProjectMembership.externalId
access-policy	reference	The access policy of the user	ProjectMembership.accessPolicy
identifier	token	The identifier of the project membership	ProjectMembership.identifier
admin	token	The admin status of the project membership	ProjectMembership.admin
active	token	If this ProjectMembership is active	ProjectMembership.active

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.
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.
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.
contained		Resource[]	Details These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently.
extension		Extension[]	Details May be used to represent additional information that is not part of the basic definition of the resource.
modifierExtension		Extension[]	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.