Bot | Medplum

On this page

Bot account for automated actions.

Schema

Elements

Name	Required	Type	Description
identifier		Identifier[]	An identifier for this bot Details An identifier for this bot.
name		string	Details A name associated with the Bot.
description		string	Details A summary, characterization or explanation of the Bot.
runtimeVersion		code	Details The identifier of the bot runtime environment (i.e., vmcontext, awslambda, etc).
timeout		integer	Details The maximum allowed execution time of the bot in seconds.
photo		Attachment	Details Image of the bot.
cron[x]		Timing, string	Details A schedule for the bot to be executed.
category		CodeableConcept[]	Classification of service Details A 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	Details Optional flag to indicate that the bot is a system bot and therefore has access to system secrets.
runAsUser		boolean	Details Optional flag to indicate that the bot should be run as the user.
publicWebhook		boolean	Details Optional flag to indicate that the bot can be used as an unauthenticated public webhook. Note that this is a security risk and should only be used for public bots that do not require authentication.
streamingEnabled		boolean	Details Optional flag to indicate that the bot should be deployed in a streaming-enabled context, allowing it to execute with streaming responses.
auditEventTrigger		code	Details Criteria 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[]	Details The destination system in which the AuditEvent is to be sent. Possible values are 'log' or 'resource'. Default value is 'resource'.
sourceCode		Attachment	Details Bot logic in original source code form written by developers.
executableCode		Attachment	Details Bot logic in executable form as a result of compiling and bundling source code.
cdsService		BotCdsService	Details CDS service definition if the bot is used as a CDS Hooks service. See https://cds-hooks.hl7.org/ for more details.
hook	✓	code	Details The hook this service should be invoked on. See https://cds-hooks.hl7.org/#hooks for possible values.
title	✓	string	Details The human-friendly name of this CDS service.
description	✓	string	Details The description of this CDS service.
usageRequirements		string	Details Optional human-friendly description of any preconditions for the use of this CDS Service.
prefetch		BotCdsServicePrefetch[]	Details An object containing key/value pairs of FHIR queries that this service is requesting the CDS Client to perform and provide on each service call.
key	✓	code	Details The type of data being requested. See https://cds-hooks.hl7.org/#prefetch-template
query	✓	string	Details The FHIR query used to retrieve the requested data. See https://cds-hooks.hl7.org/#prefetch-template
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
cds-hook	token	The CDS hook this Bot should be invoked on.	Bot.cdsService.hook

Inherited Elements

Name	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.