ProjectMembership
Medplum project membership. A project membership grants a user access to a project.
- Schema
Elements
Name | Required | Type | Description |
---|---|---|---|
project | ✓ | Reference<Project> | DetailsProject where the memberships are available. |
invitedBy | Reference<User> | DetailsThe project administrator who invited the user to the project. | |
user | ✓ | Reference< Bot | ClientApplication | User > | DetailsUser that is granted access to the project. |
profile | ✓ | Reference< Bot | ClientApplication | Patient | Practitioner | RelatedPerson > | DetailsReference to the resource that represents the user profile within the project. |
externalId | string | DetailsA 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> | DetailsThe access policy for the user within the project memebership. | |
access | ProjectMembershipAccess[] | DetailsExtended access configuration using parameterized access policies. | |
policy | ✓ | Reference<AccessPolicy> | DetailsThe base access policy used as a template. Variables in the template access policy are replaced by the values in the parameter. |
parameter | ProjectMembershipAccessParameter[] | DetailsUser options that control the display of the application. | |
name | ✓ | code | DetailsThe unique name of the parameter. |
value[x] | ✓ | string, Reference<> | Value of the parameter. DetailsValue of the parameter - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
userConfiguration | Reference<UserConfiguration> | DetailsThe 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. DetailsWhether 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 |
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 DetailsThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | DetailsThe 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 | DetailsA 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 | DetailsThe base language in which the resource is written. |