Agent

Configuration details for an instance of the Medplum agent application.

Schema

Elements

Name	Required	Type	Description
identifier		Identifier[]	An identifier for this agent Details An identifier for this agent.
name	✓	string	The human readable friendly name of the agent. Details The human readable friendly name of the agent.
status	✓	code	active | off | error Details The status of the agent.
device		Reference<Device>	Details Optional device resource representing the device running the agent.
setting		AgentSetting[]	Details The settings for the agent.
name	✓	string	Details The setting name.
value[x]	✓	string, boolean, decimal, integer	Details The setting value.
channel		AgentChannel[]	The channel on which to report matches to the criteria Details Details where to send notifications when resources are received that meet the criteria.
name	✓	string	Details The channel name.
endpoint	✓	Reference<Endpoint>	Details The channel endpoint definition including protocol and network binding details.
target[x]	✓	Reference<Bot>, url	Details The target resource where channel messages will be delivered.

Search Parameters

Name	Type	Description	Expression
identifier	token	The identifier of the agent	Agent.identifier
name	string	Search for Agent by name	Agent.name
status	token	Search for Agent by status	Agent.status

Inherited Elements

Name	Required	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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).