Project
Encapsulation of resources for a specific project or organization.
- Schema
Elements
Name | Required | Type | Description |
---|---|---|---|
identifier | Identifier[] | An identifier for this project An identifier for this project. | |
name | string | A name associated with the Project. | |
description | string | A summary, characterization or explanation of the Project. | |
superAdmin | boolean | Whether this project is the super administrator project. Whether this project is the super administrator project. A super administrator is a user who has complete access to all resources in all projects. | |
strictMode | boolean | Whether this project uses strict FHIR validation. Whether this project uses strict FHIR validation. This setting has been deprecated, and can only be set by a super admin. | |
checkReferencesOnWrite | boolean | Whether this project uses referential integrity on write operations such as 'create' and 'update'. Whether this project uses referential integrity on write operations such as 'create' and 'update'. | |
owner | Reference<User> | The user who owns the project. | |
features | code[] | A list of optional features that are enabled for the project. | |
defaultPatientAccessPolicy | Reference<AccessPolicy> | The default access policy for patients using open registration. | |
setting | ProjectSetting[] | Option or parameter that can be adjusted within the Medplum Project to customize its behavior. | |
name | ✓ | string | The secret name. |
value[x] | ✓ | string, boolean, decimal, integer | The secret value. |
secret | [] | Option or parameter that can be adjusted within the Medplum Project to customize its behavior, only visible to project administrators. | |
systemSetting | [] | Option or parameter that can be adjusted within the Medplum Project to customize its behavior, only modifiable by system administrators. | |
systemSecret | [] | Option or parameter that can be adjusted within the Medplum Project to customize its behavior, only visible to system administrators. | |
site | ProjectSite[] | Web application or web site that is associated with the project. | |
name | ✓ | string | Friendly name that will make it easy for you to identify the site in the future. |
domain | ✓ | string[] | The list of domain names associated with the site. User authentication will be restricted to the domains you enter here, plus any subdomains. In other words, a registration for example.com also registers subdomain.example.com. A valid domain requires a host and must not include any path, port, query or fragment. |
googleClientId | string | The publicly visible Google Client ID for the site. This is used to authenticate users with Google. This value is available in the Google Developer Console. | |
googleClientSecret | string | The private Google Client Secret for the site. This value is available in the Google Developer Console. | |
recaptchaSiteKey | string | The publicly visible reCAPTCHA site key. This value is generated when you create a new reCAPTCHA site in the reCAPTCHA admin console. Use this site key in the HTML code your site serves to users. | |
recaptchaSecretKey | string | The private reCAPTCHA secret key. This value is generated when you create a new reCAPTCHA site in the reCAPTCHA admin console. Use this secret key for communication between your site and reCAPTCHA. | |
link | ProjectLink[] | Linked Projects whose contents are made available to this one | |
project | ✓ | Reference<> | A reference to the Project to be linked into this one |
defaultProfile | ProjectDefaultProfile[] | Default profiles to apply to resources in this project that do not individually specify profiles | |
resourceType | ✓ | code | The resource type onto which to apply the default profiles |
profile | ✓ | canonical[] | The profiles to add by default |
exportedResourceType | code[] | The resource types exported by the project when linked |
Search Parameters
Name | Type | Description | Expression |
---|---|---|---|
identifier | token | The identifier of the project | Project.identifier |
name | string | The name of the project | Project.name |
owner | reference | The user who owns the project | Project.owner |
google-client-id | token | The Google Client ID of the project | Project.site.googleClientId |
recaptcha-site-key | token | The reCAPTCHA site key of the project | Project.site.recaptchaSiteKey |
Inherited Elements
Name | Required | Type | Description |
---|---|---|---|
id | string | Logical id of this artifact The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | 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 | 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 | The base language in which the resource is written. | |
text | Narrative | Text summary of the resource, for human interpretation 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 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 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 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). |