Skip to main content

Agent

Configuration details for an instance of the Medplum agent application.

Elements

NameRequiredTypeDescription
identifierIdentifier[]

An identifier for this agent

Details

An identifier for this agent.

namestring

The human readable friendly name of the agent.

Details

The human readable friendly name of the agent.

statuscode

active | off | error

Details

The status of the agent.

deviceReference<Device>

Details

Optional device resource representing the device running the agent.

settingAgentSetting[]

Details

The settings for the agent.

namestring

Details

The setting name.

value[x]string, boolean, decimal, integer

Details

The setting value.

channelAgentChannel[]

The channel on which to report matches to the criteria

Details

Details where to send notifications when resources are received that meet the criteria.

namestring

Details

The channel name.

endpointReference<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

NameTypeDescriptionExpression
identifiertokenThe identifier of the agentAgent.identifier
namestringSearch for Agent by nameAgent.name
statustokenSearch for Agent by statusAgent.status

Inherited Elements

NameRequiredTypeDescription
idstring

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.

metaMeta

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.

implicitRulesuri

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.

languagecode

Details

The base language in which the resource is written.