Project
Encapsulation of resources for a specific project or organization.
- Schema
Elements
Name | Required | Type | Description |
---|---|---|---|
name | string | DetailsA name associated with the Project. | |
description | string | DetailsA summary, characterization or explanation of the Project. | |
superAdmin | boolean | Whether this project is the super administrator project. DetailsWhether 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. DetailsWhether this project uses strict FHIR validation. | |
checkReferencesOnWrite | boolean | Whether this project uses referential integrity on write operations such as 'create' and 'update'. DetailsWhether this project uses referential integrity on write operations such as 'create' and 'update'. | |
owner | Reference<User> | DetailsThe user who owns the project. | |
features | code[] | DetailsA list of optional features that are enabled for the project. | |
defaultPatientAccessPolicy | Reference<AccessPolicy> | DetailsThe default access policy for patients using open registration. | |
secret | ProjectSecret[] | DetailsSecure environment variable that can be used to store secrets for bots. | |
name | ✓ | string | DetailsThe secret name. |
value[x] | ✓ | string, boolean, decimal, integer | DetailsThe secret value. |
site | ProjectSite[] | DetailsWeb application or web site that is associated with the project. | |
name | ✓ | string | DetailsFriendly name that will make it easy for you to identify the site in the future. |
domain | ✓ | string[] | DetailsThe 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 | DetailsThe 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 | DetailsThe private Google Client Secret for the site. This value is available in the Google Developer Console. | |
recaptchaSiteKey | string | DetailsThe 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 | DetailsThe 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. |
Search Parameters
Name | Type | Description | Expression |
---|---|---|---|
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 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. |