Bot
Bot account for automated actions.
- Schema
Elements
Name | Required | Type | Description |
---|---|---|---|
identifier | Identifier[] | An identifier for this bot DetailsAn identifier for this bot. | |
name | string | DetailsA name associated with the Bot. | |
description | string | DetailsA summary, characterization or explanation of the Bot. | |
runtimeVersion | code | DetailsThe identifier of the bot runtime environment (i.e., vmcontext, awslambda, etc). | |
timeout | integer | DetailsThe maximum allowed execution time of the bot in seconds. | |
photo | Attachment | DetailsImage of the bot. | |
cron[x] | Timing, string | DetailsA schedule for the bot to be executed. | |
category | CodeableConcept[] | Classification of service DetailsA code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure"). There may be multiple axis of categorization depending on the context or use case for retrieving or displaying the resource. The level of granularity is defined by the category concepts in the value set. | |
system | boolean | DetailsOptional flag to indicate that the bot is a system bot and therefore has access to system secrets. | |
runAsUser | boolean | DetailsOptional flag to indicate that the bot should be run as the user. | |
auditEventTrigger | code | DetailsCriteria for creating an AuditEvent as a result of the bot invocation. Possible values are 'always', 'never', 'on-error', or 'on-output'. Default value is 'always'. | |
auditEventDestination | code[] | DetailsThe destination system in which the AuditEvent is to be sent. Possible values are 'log' or 'resource'. Default value is 'resource'. | |
sourceCode | Attachment | DetailsBot logic in original source code form written by developers. | |
executableCode | Attachment | DetailsBot logic in executable form as a result of compiling and bundling source code. | |
code | string | Details@deprecated Bot logic script. Use Bot.sourceCode or Bot.executableCode instead. |
Search Parameters
Name | Type | Description | Expression |
---|---|---|---|
identifier | token | The identifier of the bot | Bot.identifier |
name | string | The name of the bot | Bot.name |
category | token | The category of the bot for the classification for service | Bot.category |
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. | |
text | Narrative | Text summary of the resource, for human interpretation DetailsA 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 DetailsThese 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 DetailsMay 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 DetailsMay 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). |