Agent
Configuration details for an instance of the Medplum agent application.
- Schema
Elements
Name | Required | Type | Description |
---|---|---|---|
identifier | Identifier[] | An identifier for this agent DetailsAn identifier for this agent. | |
name | ✓ | string | The human readable friendly name of the agent. DetailsThe human readable friendly name of the agent. |
status | ✓ | code | active | off | error DetailsThe status of the agent. |
device | Reference<Device> | DetailsOptional device resource representing the device running the agent. | |
setting | AgentSetting[] | DetailsThe settings for the agent. | |
name | ✓ | string | DetailsThe setting name. |
value[x] | ✓ | string, boolean, decimal, integer | DetailsThe setting value. |
channel | AgentChannel[] | The channel on which to report matches to the criteria DetailsDetails where to send notifications when resources are received that meet the criteria. | |
name | ✓ | string | DetailsThe channel name. |
endpoint | ✓ | Reference<Endpoint> | DetailsThe channel endpoint definition including protocol and network binding details. |
target[x] | ✓ | Reference<Bot>, url | DetailsThe 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 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. |