ProjectMembership

Medplum project membership. A project membership grants a user access to a project.

Schema

Elements

Name	Required	Type	Description
project	✓	Reference<Project>	Details Project where the memberships are available.
invitedBy		Reference<User>	Details The project administrator who invited the user to the project.
user	✓	Reference< Bot | ClientApplication | User >	Details User that is granted access to the project.
profile	✓	Reference< Bot | ClientApplication | Patient | Practitioner | RelatedPerson >	Details Reference to the resource that represents the user profile within the project.
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. Often displayed to the user as their unique identifier within the system (as opposed to "id" or "externalId", which are generally opaque and not user-friendly identifiers). Each User MUST include a non-empty userName value. This identifier MUST be unique across the service provider's entire set of Users. This attribute is REQUIRED and is case insensitive.
externalId		string	Details SCIM externalId. A String that is an identifier for the resource as defined by the provisioning client. The "externalId" may simplify identification of a resource between the provisioning client and the service provider by allowing the client to use a filter to locate the resource with an identifier from the provisioning domain, obviating the need to store a local mapping between the provisioning domain's identifier of the resource and the identifier used by the service provider. Each resource MAY include a non-empty "externalId" value. The value of the "externalId" attribute is always issued by the provisioning client and MUST NOT be specified by the service provider. The service provider MUST always interpret the externalId as scoped to the provisioning domain.
accessPolicy		Reference<AccessPolicy>	Details The access policy for the user within the project memebership.
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](extensibility.html) for a list).
userConfiguration		Reference<UserConfiguration>	Details The user configuration for the user within the project memebership 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 | ProjectMembership.access.policy

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[]	Contained, inline Resources 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).