Core Module Resources
Core system resources.
AccessPolicy
| Name | Card. | Type | Description |
|---|---|---|---|
AccessPolicy | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
and | 0..* | Object | A list of conditions that must all be satisfied for the policy to grant access. |
clj | 0..1 | string | Clojure code that defines access policy rules. DEPRECATED. DO NOT USE IT. |
description | 0..1 | string | A textual description of the access policy. |
engine | 0..1 | string | Specifies the evaluation engine used for the policy.
Allowed values: json-schema | allow | sql | complex | matcho | clj | matcho-rpc | allow-rpc | signed-rpc | smart-on-fhir |
link | 0..* | Reference | References to resources associated with this policy.
Allowed references: Client, User, Operation |
matcho | 0..1 | Object | Defines rules using the Matcho pattern-matching syntax. |
module | 0..1 | string | Module that this policy belongs to. |
or | 0..* | Object | A list of conditions where at least one must be satisfied for the policy to grant access. |
roleName | 0..1 | string | Symbolic link to Role by name. |
rpc | 0..1 | Object | Defines rules for Remote Procedure Calls (RPCs). |
schema | 0..1 | Object | JSON Schema used to validate requests against the policy. |
sql | 0..1 | BackboneElement | SQL-based policy definition. |
query | 0..1 | string | SQL query used to evaluate access conditions. |
type | 0..1 | string | The type or category of the access policy.
Allowed values: scope | rest | rpc |
AidboxArchive
Archive configuration resource for Aidbox data archival.
| Name | Card. | Type | Description |
|---|---|---|---|
AidboxArchive | |||
archiveFile | 0..1 | string | Name of the archive file. |
archivedResourcesCount | 0..1 | number | Count of resources that have been archived. |
bucket | 1..1 | string | Storage bucket where archives are stored. |
criteriaPaths | 1..* | string | Paths to use for filtering resources to archive. |
history | 0..1 | boolean | Whether to include resource history in the archive. |
period | 1..1 | BackboneElement | Time period for the resources to archive. |
start | 0..1 | dateTime | Start date/time for the archive period. |
end | 0..1 | dateTime | End date/time for the archive period. |
serviceAccount | 0..1 | BackboneElement | Service account credentials for accessing storage. |
id | 0..1 | string | Identifier for the service account. |
resourceType | 0..1 | string | Type of resource that contains service account credentials. |
display | 0..1 | string | Human-readable name for the service account. |
secret-key | 0..1 | string | Secret key for service account authentication. |
storageBackend | 1..1 | string | Type of storage backend to use.
Allowed values: gcp | aws | local |
targetResourceType | 1..1 | string | Resource type to be archived. |
AidboxConfig
Configuration resource for Aidbox settings.
| Name | Card. | Type | Description |
|---|---|---|---|
AidboxConfig | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
auth | 0..1 | BackboneElement | Authentication configuration settings. |
keys | 0..1 | BackboneElement | Cryptographic keys for authentication. |
secret | 0..1 | string | Secret key used for signing. |
public | 0..1 | string | Public key used for verification. |
box | 0..1 | Box configuration parameters. |
AidboxInitialExportStatus
Status of the initial data export for a topic destination. Possible values: pending, in-progress, completed, failed.
| Name | Card. | Type | Description |
|---|---|---|---|
AidboxInitialExportStatus | |||
extension | 0..1 | ||
url | 0..1 | ||
value[x] | 1..1 | string |
AidboxJob
Aidbox Job resource for scheduling and executing periodic tasks.
| Name | Card. | Type | Description |
|---|---|---|---|
AidboxJob | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
action | 0..1 | Object | Action to be performed when the job runs. |
at | 0..1 | string | Time of day when the job should run (for each-day type). |
every | 0..1 | integer | Frequency in seconds at which the job should run. |
module | 0..1 | string | Module that this job belongs to. |
status | 0..1 | Object | Current status information for the job. |
text | 0..1 | string | Human-readable description of the job. |
type | 0..1 | string | Type of job scheduling pattern.
Allowed values: periodic | each-day |
AidboxJobStatus
Status tracking for Aidbox job executions.
| Name | Card. | Type | Description |
|---|---|---|---|
AidboxJobStatus | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
error | 0..1 | Object | Error information if the job failed. |
job | 0..1 | Reference | Reference to the job definition. |
locked | 0..1 | boolean | Indicates whether the job is currently locked to prevent concurrent execution. |
module | 0..1 | string | Module that this job status belongs to. |
nextStart | 0..1 | dateTime | Scheduled time for the next execution of the job. |
result | 0..1 | Object | Result data from the job execution. |
start | 0..1 | dateTime | Time when the job execution started. |
status | 0..1 | string | Current status of the job execution. |
stop | 0..1 | dateTime | Time when the job execution stopped. |
text | 0..1 | string | Human-readable status information. |
Search Parameters
| SearchParameter | Type | Expression | Description |
|---|---|---|---|
| job | reference | job | Search AidboxJobStatus by job reference |
AidboxMigration
Database migration tracking resource for Aidbox.
| Name | Card. | Type | Description |
|---|---|---|---|
AidboxMigration | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
action | 0..1 | string | Action to be performed for the migration.
Allowed values: far-migration-fhir-package-install | far-migration-fhir-package-uninstall | aidbox-migration-run-sql |
dateTime | 0..1 | dateTime | Time when the migration was created or executed. |
module | 0..1 | string | Module that this migration belongs to. |
params | 0..1 | Object | Parameters for the migration. |
result | 0..1 | Object | Result data from the migration execution. |
status | 0..1 | string | Current status of the migration.
Allowed values: pending | done | error | to-run |
text | 0..1 | string | Human-readable description of the migration. |
AidboxProfile
Profile resource for Aidbox schema validation. Deprecated after 2507 LTS.
| Name | Card. | Type | Description |
|---|---|---|---|
AidboxProfile | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
bind | 1..1 | Reference | Reference to the resource to which this profile is bound. |
schema | 1..1 | Object | Schema definition for the profile. |
AidboxQuery
Custom SQL query resource for Aidbox.
| Name | Card. | Type | Description |
|---|---|---|---|
AidboxQuery | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
count-query | 0..1 | string | SQL query to count total results. |
enable-links | 0..1 | boolean | Whether to generate FHIR links for pagination. |
omit-sql | 0..1 | boolean | Whether to omit SQL in response metadata. |
params | 0..1 | Object | Parameters for the query. |
query | 1..1 | string | SQL query string. |
type | 0..1 | string | Type of query operation.
Allowed values: query | execute |
AidboxSubscription
Aidbox subscription resource for event-driven workflows.
| Name | Card. | Type | Description |
|---|---|---|---|
AidboxSubscription | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
action | 0..1 | Object | Action to be performed when the subscription is triggered. |
module | 0..1 | string | Module that this subscription belongs to. |
resources | 0..* | string | List of resource types this subscription applies to. |
type | 0..1 | string | Type of subscription execution model.
Allowed values: sync | async |
AidboxSubscriptionStatus
The status of an AidboxTopicDestination during notifications.
| Name | Card. | Type | Description |
|---|---|---|---|
AidboxSubscriptionStatus | |||
error | 0..* | CodeableConcept | List of errors on the subscription. |
eventsSinceSubscriptionStart | 0..1 | decimal | Events since the AidboxTopicDestination was created. |
notificationEvent | 0..* | BackboneElement | Detailed information about any events relevant to this notification. |
eventNumber | 1..1 | decimal | Sequencing index of this event. |
timestamp | 0..1 | instant | The instant this event occurred. |
focus | 0..1 | Reference | Reference to the primary resource or information of this event.
Allowed references: Resource |
additionalContext | 0..* | Reference | References related to the focus resource and/or context of this event.
Allowed references: Resource |
status | 0..1 | code | requested | active | error | off | entered-in-error.
Allowed values: requested | active | error | off | entered-in-error |
topic | 0..1 | canonical | Reference to the AidboxSubscriptionTopic this notification relates to. |
topic-destination | 1..1 | Reference | Reference to the AidboxTopicDestination responsible for this notification.
Allowed references: AidboxTopicDestination |
type | 1..1 | string | handshake | heartbeat | event-notification | query-status | query-event.
Allowed values: handshake | heartbeat | event-notification | query-status | query-event |
AidboxSubscriptionTopic
Defines the data sources and events that clients can subscribe to. Acts as a configuration that establishes what events matter by specifying which resources and conditions warrant notifications.
| Name | Card. | Type | Description |
|---|---|---|---|
AidboxSubscriptionTopic | |||
approvalDate | 0..1 | date | When AidboxSubscriptionTopic is/was approved by publisher. |
contact | 0..* | ContactDetail | Contact details for the publisher. |
copyright | 0..1 | markdown | Use and/or publishing restrictions. |
copyrightLabel | 0..1 | string | Copyright holder and year(s). |
date | 0..1 | dateTime | Date status first applied. |
derivedFrom | 0..* | canonical | Based on FHIR protocol or definition. |
description | 0..1 | markdown | Natural language description of the AidboxSubscriptionTopic. |
effectivePeriod | 0..1 | Period | The effective date range for the AidboxSubscriptionTopic. |
experimental | 0..1 | boolean | If for testing purposes, not real usage. |
identifier | 0..* | Identifier | Business identifier for subscription topic. |
jurisdiction | 0..* | CodeableConcept | Intended jurisdiction of the AidboxSubscriptionTopic (if applicable). |
lastReviewDate | 0..1 | date | Date the AidboxSubscriptionTopic was last reviewed by the publisher. |
name | 0..1 | string | Name for this subscription topic (computer friendly). |
publisher | 0..1 | string | The name of the individual or organization that published the AidboxSubscriptionTopic. |
purpose | 0..1 | markdown | Why this AidboxSubscriptionTopic is defined. |
status | 1..1 | code | draft | active | retired | unknown.
Allowed values: draft | active | retired | unknown |
title | 0..1 | string | Name for this subscription topic (human friendly). |
trigger | 0..* | BackboneElement | Definition of a resource-based trigger for the subscription topic. |
resource | 1..1 | uri | Data Type or Resource (reference to definition) for this trigger definition. |
description | 0..1 | markdown | Text representation of the resource trigger. |
supportedInteraction | 0..* | code | create | update | delete.
Allowed values: create | update | delete |
fhirPathCriteria | 0..1 | string | FHIRPath based trigger rule. |
canFilterBy | 0..* | BackboneElement | Properties by which a AidboxTopicDestination can filter notifications from the AidboxSubscriptionTopic. |
filterParameter | 1..1 | string | Human-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic. |
comparator | 1..* | code | eq | ne | gt | lt | ge | le | sa | eb | ap. |
filterDefinitionFhirPathExpression | 1..1 | string | |
description | 0..1 | markdown | Description of this filter parameter. |
url | 1..1 | uri | Canonical identifier for this subscription topic, represented as an absolute URI (globally unique). |
useContext | 0..* | UsageContext | Content intends to support these contexts. |
version | 0..1 | string | Business version of the subscription topic. |
versionAlgorithm[x] | 0..1 | string | How to compare versions. |
Search Parameters
| SearchParameter | Type | Expression | Description |
|---|---|---|---|
| url | uri | url | Search AidboxSubscriptionTopic by url |
AidboxTask
| Name | Card. | Type | Description |
|---|---|---|---|
AidboxTask | |||
allowedRetryCount | 0..1 | integer | Maximum number of retries allowed for this task. |
concurrencyLimit | 0..1 | decimal | Maximum number of concurrent tasks allowed. |
concurrencyPath | 0..* | ||
definition | 1..1 | string | Identifier for the task definition. |
error | 0..1 | Error details if task failed. | |
execId | 0..1 | string | Unique execution identifier. |
executeAt | 0..1 | dateTime | Scheduled time for task execution. |
inProgressTimeout | 0..1 | decimal | Maximum duration in seconds that a task can remain in in-progress status before timing out. |
label | 0..1 | string | Label for the task. |
outcome | 0..1 | string | Final outcome of the task execution.
Allowed values: succeeded | failed | canceled |
outcomeReason | 0..1 | BackboneElement | Detailed reason for the task outcome. |
type | 1..1 | string | Type of outcome reason.
Allowed values: awf.task/failed-due-to-in-progress-timeout | awf.task/failed-by-executor | awf.executor/unknown-error |
message | 1..1 | string | Human-readable explanation of the outcome. |
data | 0..1 | Additional data related to the outcome. | |
params | 1..1 | Parameters required for task execution. | |
requestedToStartTimeout | 0..1 | decimal | Maximum duration in seconds that a task can remain in requested status before timing out. |
requester | 0..1 | BackboneElement | Entity that requested the task. |
id | 0..1 | string | Identifier of the requester. |
resourceType | 0..1 | string | Type of resource that made the request. |
display | 0..1 | string | Human-readable display name of the requester. |
service | 0..1 | string | Service that initiated the request. |
rule | 0..1 | string | Rule that authorized the request. |
result | 0..1 | Result data produced by successful task execution. | |
retryCount | 0..1 | decimal | Number of times the task has been retried. |
retryDelay | 0..1 | decimal | Delay in seconds before retrying a failed task. |
status | 1..1 | string | Current status of the task.
Allowed values: created | ready | requested | in-progress | done | waiting |
workflow-definition | 0..1 | string | Reference to the workflow definition for this task. |
AidboxTaskLog
| Name | Card. | Type | Description |
|---|---|---|---|
AidboxTaskLog | |||
action | 0..1 | string | Name of the performed action. |
action-params | 0..1 | Object | Parameters provided with the action. |
re-scheduled | 0..1 | BackboneElement | Definition of a rescheduled action. |
action | 1..1 | string | Name of the rescheduled action. |
id | 1..1 | string | Unique identifier for the rescheduled action. |
delay | 0..1 | decimal | New delay in seconds before executing the action. |
at | 0..1 | dateTime | New specific time when the action should be executed. |
action-params | 0..1 | Object | Parameters for the rescheduled action. |
scheduled | 0..1 | BackboneElement | Definition of a scheduled action. |
action | 1..1 | string | Name of the scheduled action. |
id | 1..1 | string | Unique identifier for the scheduled action. |
delay | 0..1 | decimal | Delay in seconds before executing the action. |
at | 0..1 | dateTime | Specific time when the action should be executed. |
action-params | 0..1 | Object | Parameters for the scheduled action. |
status-after | 0..1 | string | Task status after the action was performed. |
status-before | 0..1 | string | Task status before the action was performed. |
subject | 0..1 | BackboneElement | Resource that is the subject of the action. |
id | 0..1 | string | Identifier of the subject. |
resourceType | 0..1 | string | Type of resource that is the subject. |
display | 0..1 | string | Human-readable display name of the subject. |
AidboxTopicDestination
Configures where and how notifications triggered by a subscription topic should be routed. Connects topics to external systems like Kafka, RabbitMQ, Webhook and others.
| Name | Card. | Type | Description |
|---|---|---|---|
AidboxTopicDestination | |||
content | 0..1 | string | empty | id-only | full-resource.
Allowed values: empty | id-only | full-resource |
includeEntryAction | 0..1 | boolean | Include entry action code in notification bundle entries. |
includeVersionId | 0..1 | boolean | Include resource versionId in notification bundle entries. |
kind | 0..1 | string | Channel type for notifications. |
status | 0..1 | string | requested | active | error | off | entered-in-error. |
topic | 0..1 | url | Reference to the AidboxSubscriptionTopic being subscribed to. |
AidboxTrigger
Aidbox trigger resource for executing SQL on resource create, update, or delete events.
| Name | Card. | Type | Description |
|---|---|---|---|
AidboxTrigger | |||
action | 1..* | code | |
resource | 1..1 | string | |
sql | 1..1 | string |
AidboxWorkflow
| Name | Card. | Type | Description |
|---|---|---|---|
AidboxWorkflow | |||
definition | 1..1 | string | Workflow definition identifier. |
error | 0..1 | Error details if workflow failed. | |
execId | 0..1 | string | Unique execution identifier. |
executeAt | 0..1 | string | Scheduled time for workflow execution. |
label | 0..1 | string | Human-readable label for the workflow. |
outcome | 0..1 | string | Final outcome of the workflow execution.
Allowed values: succeeded | failed | canceled |
outcomeReason | 0..1 | BackboneElement | Detailed reason for the workflow outcome. |
type | 1..1 | string | Type of outcome reason.
Allowed values: awf.workflow/failed-by-executor | awf.executor/unknown-error |
message | 1..1 | string | Human-readable explanation of the outcome. |
data | 0..1 | Additional data related to the outcome. | |
params | 0..1 | Parameters required for workflow execution. | |
requester | 0..1 | BackboneElement | Entity that requested the workflow. |
id | 0..1 | string | Identifier of the requester. |
resourceType | 0..1 | string | Type of resource that made the request. |
display | 0..1 | string | Human-readable display name of the requester. |
service | 0..1 | string | Service that initiated the request. |
rule | 0..1 | string | Rule that authorized the request. |
result | 0..1 | Result data produced by successful workflow execution. | |
retryCount | 0..1 | decimal | Number of times the workflow has been retried. |
status | 1..1 | string | Current status of the workflow.
Allowed values: created | in-progress | done |
App
Application definition resource for Aidbox.
| Name | Card. | Type | Description |
|---|---|---|---|
App | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
apiVersion | 1..1 | integer | Version of the API this app uses. |
endpoint | 0..1 | BackboneElement | Endpoint configuration for the app. |
url | 0..1 | string | URL of the endpoint. |
secret | 0..1 | string | Secret key for endpoint authentication. |
type | 0..1 | code | Type of endpoint protocol.
Allowed values: http-rpc | ws-rpc | native |
entities | 0..1 | Object | Entities defined by the app. |
hooks | 0..1 | Object | Hooks configuration for the app. |
migrations | 0..* | BackboneElement | List of migrations for this app. |
id | 1..1 | string | Unique identifier for the migration. |
dateTime | 1..1 | string | Timestamp for the migration. |
action | 1..1 | string | Action to be performed for the migration. |
operations | 0..1 | Object | Operations defined by the app. |
subscriptions | 0..1 | Object | Subscriptions configuration for the app. |
type | 1..1 | code | Type of application.
Allowed values: app | addon |
Attribute
Attribute definition resource for Aidbox entities.
| Name | Card. | Type | Description |
|---|---|---|---|
Attribute | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
description | 0..1 | string | Human-readable description of the attribute. |
enum | 0..* | string | Enumeration of allowed values for this attribute. |
extensionUrl | 0..1 | string | URL for the extension this attribute represents. |
isCollection | 0..1 | boolean | Whether this attribute is a collection. |
isModifier | 0..1 | boolean | Whether this attribute changes the meaning of the resource. |
isOpen | 0..1 | boolean | Whether this attribute allows additional properties. |
isRequired | 0..1 | boolean | Whether this attribute is required. |
isSummary | 0..1 | boolean | Whether this attribute is included in summary views. |
isUnique | 0..1 | boolean | Whether this attribute has unique values. |
module | 0..1 | string | Module that this attribute belongs to. |
order | 0..1 | integer | Order for display or processing. |
path | 1..* | string | Path to the attribute within the resource. |
refers | 0..* | string | Resource types this attribute can reference. |
resource | 1..1 | Reference | Reference to the resource type this attribute belongs to. |
schema | 0..1 | Object | Schema for the attribute. |
text | 0..1 | string | Human-readable text about the attribute. |
type | 0..1 | Reference | Reference to the attribute's data type. |
union | 0..* | Reference | References to other attributes in a union type. |
valueSet | 0..1 | BackboneElement | Value set constraint for this attribute. |
resourceType | 0..1 | string | Type of the value set resource. |
id | 0..1 | string | Identifier of the value set. |
uri | 0..1 | string | URI of the value set. |
AuthConfig
| Name | Card. | Type | Description |
|---|---|---|---|
AuthConfig | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
asidCookieMaxAge | 0..1 | integer | Maximum age of the ASID cookie in seconds. Default is 432000 (5 days). |
theme | 0..1 | BackboneElement | Theme configuration for auth page. |
brand | 0..1 | string | Brand for auth page |
title | 0..1 | string | Title for auth page |
styleUrl | 0..1 | uri | URL to external stylesheet |
forgotPasswordUrl | 0..1 | uri | URL to forgot password page |
twoFactor | 0..1 | BackboneElement | Two-factor authentication configuration. |
webhook | 0..1 | BackboneElement | Webhook configuration for 2FA. |
headers | 0..1 | Object | Map of HTTP header key-value pairs. |
timeout | 0..1 | integer | Timeout in milliseconds. |
endpoint | 1..1 | string | URL to webhook that supports POST method |
issuerName | 0..1 | string | Issuer name for OTP authenticator app. |
validPastTokensCount | 0..1 | integer | Number of past tokens considered valid (useful with webhook since OTP lives ~30s) |
AwsAccount
| Name | Card. | Type | Description |
|---|---|---|---|
AwsAccount | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
access-key-id | 0..1 | string | AWS access key identifier for authentication. |
host | 0..1 | string | AWS host endpoint for the service. |
path-style | 0..1 | boolean | Whether to use path-style addressing for S3 requests. |
region | 0..1 | string | AWS region where the resources are located. |
secret-access-key | 0..1 | string | AWS secret access key for authentication. |
use-ssl | 0..1 | boolean | Whether to use SSL for secure connections. |
AzureAccount
| Name | Card. | Type | Description |
|---|---|---|---|
AzureAccount | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
clientId | 0..1 | string | Azure AD application/client ID (required for User Delegation SAS). Available since 2508. |
clientSecret | 0..1 | string | Azure AD client secret (required for User Delegation SAS). Available since 2508. |
key | 0..1 | string | Azure storage account key for authentication (required for Account SAS). |
sasType | 0..1 | string | SAS type: 'account' (default) or 'userDelegation'. Available since 2508. |
tenantId | 0..1 | string | Azure AD tenant ID (required for User Delegation SAS). |
AzureContainer
| Name | Card. | Type | Description |
|---|---|---|---|
AzureContainer | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
account | 0..1 | Reference | Reference to the Azure account credentials.
Allowed references: AzureAccount |
container | 0..1 | string | Name of the Azure storage container. |
extension | 0..1 | string | File extension for content stored in the container. |
storage | 0..1 | string | Azure storage account name. |
BatchValidationError
Validation error resource for batch validation runs.
| Name | Card. | Type | Description |
|---|---|---|---|
BatchValidationError | |||
errors | 0..* | Object | List of validation errors found. |
profiles | 0..* | string | Profiles against which the resource was validated. |
resource | 1..1 | BackboneElement | Reference to the resource that failed validation. |
id | 0..1 | string | Resource identifier. |
resourceType | 0..1 | string | Type of resource. |
display | 0..1 | string | Human-readable display name for the resource. |
run | 0..1 | BackboneElement | Reference to the validation run that produced this error. |
id | 0..1 | string | Validation run identifier. |
resourceType | 0..1 | string | Type of the validation run resource. |
display | 0..1 | string | Human-readable display name for the validation run. |
BatchValidationRun
Batch validation run resource for tracking validation processes.
| Name | Card. | Type | Description |
|---|---|---|---|
BatchValidationRun | |||
async | 0..1 | boolean | Whether validation is performed asynchronously. |
duration | 0..1 | integer | Duration of the validation run in milliseconds. |
errorsThreshold | 0..1 | integer | Maximum number of errors before stopping validation. |
filter | 0..1 | string | Expression to filter resources for validation. |
invalid | 0..1 | integer | Count of invalid resources found. |
limit | 0..1 | integer | Maximum number of resources to validate. |
profiles | 0..* | string | FHIR profiles to validate against. |
resource | 1..1 | string | Resource type to validate. |
schemas | 0..* | string | List of schemas to validate against. |
status | 0..1 | string | Current status of the validation run.
Allowed values: in-progress | complete |
valid | 0..1 | integer | Count of valid resources found. |
BulkExportStatus
| Name | Card. | Type | Description |
|---|---|---|---|
BulkExportStatus | |||
error | 0..* | BackboneElement | Information about errors that occurred during export. |
type | 0..1 | string | Type of the resource that caused the error. |
url | 0..1 | string | URL with detailed error information. |
count | 0..1 | integer | Number of resources that encountered errors. |
extension | 0..1 | Additional information about the export. | |
output | 0..* | BackboneElement | Information about the exported data files. |
type | 0..1 | string | FHIR resource type for this output file. |
url | 0..1 | string | URL where the client can download this output file. |
count | 0..1 | integer | Number of resources in this output file. |
params | 0..1 | BackboneElement | Parameters specified for the bulk export request. |
since | 0..1 | dateTime | Export only resources modified after this date. |
until | 0..1 | dateTime | Export only resources modified before this date. |
requester | 0..1 | Reference | Reference to the user or client that requested the export. |
output-format | 1..1 | string | Format of the exported data files.
Allowed values: application/fhir+ndjson | application/ndjson+fhir | application/ndjson | ndjson | application/fhir+ndjson+gzip | application/fhir+gzip+ndjson | application/ndjson+fhir+gzip | application/ndjson+gzip+fhir | application/gzip+fhir+ndjson | application/gzip+ndjson+fhir |
output-file-ext | 1..1 | string | File extension for the exported files.
Allowed values: .ndjson | .ndjson.gz |
export-level | 1..1 | string | Level at which to perform the export (patient, group, or system).
Allowed values: patient | group | system |
gzip? | 1..1 | boolean | Whether to compress the exported files using gzip. |
fhir? | 0..1 | boolean | Whether to export in FHIR format. |
types | 0..* | string | List of resource types to include in the export. |
tenant | 0..1 | string | Tenant identifier for multi-tenant environments. |
patient-ids | 0..* | string | List of patient IDs to export data for. |
group-id | 0..1 | string | ID of the group to export data for, when export-level is 'group'. |
type-filters | 0..* | string | FHIR search query strings for filtering exported resources in ResourceType?params format. |
storage | 1..1 | BackboneElement | Storage configuration for exported files. |
type | 0..1 | string | Type of storage backend to use.
Allowed values: test-delay | test-cloud | aidbox | gcp | aws | azure |
bucket | 0..1 | string | Name of the storage bucket to use. |
account | 0..1 | Reference | Reference to account with credentials for accessing the storage. |
request | 0..1 | string | Original request that initiated this export. |
requester | 0..1 | Reference | Reference to the user or client that requested the export. |
requiresAccessToken | 0..1 | boolean | Whether an access token is required to download the exported files. |
status | 1..1 | string | Current status of the bulk export operation.
Allowed values: accepted | in-progress | completed | error | cancelled |
transactionTime | 0..1 | dateTime | Time when the bulk export was initiated. |
url | 0..1 | string | URL where the client can check the export status. |
BulkImportStatus
| Name | Card. | Type | Description |
|---|---|---|---|
BulkImportStatus | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
contentEncoding | 0..1 | string | Encoding of the imported content (gzip or plain).
Allowed values: gzip | plain |
inputFormat | 0..1 | string | Format of the input data files.
Allowed values: application/fhir+ndjson |
inputs | 0..* | BackboneElement | Information about input files processed during import. |
resourceType | 1..1 | string | Type of resources contained in this input file. |
url | 0..1 | string | URL of the imported file. |
time | 0..1 | integer | Time taken to process this input file in milliseconds. |
ts | 0..1 | dateTime | Time when the import operation completed. |
total | 0..1 | integer | Total number of imported resources. |
status | 0..1 | string | Import progress status. |
duration | 0..1 | integer | Import duration time. |
mode | 0..1 | string | Mode of import operation (bulk or transaction).
Allowed values: bulk | transaction |
source | 0..1 | string | Source location of the imported data. |
status | 0..1 | string | Current status of the import operation.
Allowed values: active | failed | cancelled | finished |
storageDetail | 0..1 | BackboneElement | Details about the storage used for the import. |
type | 0..1 | string |
Allowed values: file | https |
time | 0..1 | BackboneElement | Timing information for the import operation. |
start | 0..1 | dateTime | Time when the import operation started. |
end | 0..1 | dateTime | Time when the import operation completed. |
type | 0..1 | string | Type of data being imported (aidbox or fhir).
Allowed values: aidbox | fhir |
update | 0..1 | boolean | Whether to update existing resources during import. |
Client
| Name | Card. | Type | Description |
|---|---|---|---|
Client | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
active | 0..1 | boolean | Indicates whether this client is active and can be used for authentication. |
allowed-scopes | 0..* | Reference | References to specific Scope resources this client is allowed to request.
Allowed references: Scope |
allowedIssuers | 0..* | string | List of authorized token issuers for this client. |
allowed_origins | 0..* | uri | Allowed Origins are URLs that will be allowed to make requests. |
auth | 0..1 | BackboneElement | Authentication configuration for different OAuth flows. |
client_credentials | 0..1 | BackboneElement | Configuration for the client credentials grant type. |
token_format | 0..1 | string | Format of the access token.
Allowed values: jwt |
access_token_expiration | 0..1 | integer | Expiration time for access tokens in seconds. |
refresh_token_expiration | 0..1 | integer | Expiration time for refresh tokens in seconds. |
audience | 0..* | string | Intended audience for issued tokens. |
refresh_token | 0..1 | boolean | Whether to issue refresh tokens with this grant type. |
client_assertion_types | 0..* | string | Supported client assertion types.
Allowed values: urn:ietf:params:oauth:client-assertion-type:jwt-bearer |
authorization_code | 0..1 | BackboneElement | Configuration for the authorization code grant type. |
token_format | 0..1 | string | Format of the access token.
Allowed values: jwt |
audience | 0..* | string | Intended audience for issued tokens. |
secret_required | 0..1 | boolean | Whether client secret is required for token exchange. |
pkce | 0..1 | boolean | Whether PKCE (Proof Key for Code Exchange) is required. |
redirect_uri | 0..1 | url | Redirect URI for the authorization code flow. |
access_token_expiration | 0..1 | integer | Expiration time for access tokens in seconds. |
refresh_token_expiration | 0..1 | integer | Expiration time for refresh tokens in seconds. |
refresh_token | 0..1 | boolean | Whether to issue refresh tokens with this grant type. |
client_assertion_types | 0..* | string | Supported client assertion types.
Allowed values: urn:ietf:params:oauth:client-assertion-type:jwt-bearer |
default_identity_provider | 0..1 | Reference | Default IdentityProvider that will be used instead of Aidbox login.
Allowed references: IdentityProvider |
password | 0..1 | BackboneElement | Configuration for the password grant type. |
secret_required | 0..1 | boolean | Whether client secret is required for password grant. |
audience | 0..* | string | Intended audience for issued tokens. |
refresh_token | 0..1 | boolean | Whether to issue refresh tokens with this grant type. |
redirect_uri | 0..1 | url | If present, turn on redirect protection |
token_format | 0..1 | string | Format of the access token.
Allowed values: jwt |
access_token_expiration | 0..1 | integer | Expiration time for access tokens in seconds. |
refresh_token_expiration | 0..1 | integer | Expiration time for refresh tokens in seconds. |
implicit | 0..1 | BackboneElement | Configuration for the implicit grant type. |
redirect_uri | 0..1 | url | Redirect URI for the implicit flow. |
token_format | 0..1 | string | Format of the access token.
Allowed values: jwt |
audience | 0..* | string | Intended audience for issued tokens. |
access_token_expiration | 0..1 | integer | Expiration time for access tokens in seconds. |
token_exchange | 0..1 | BackboneElement | Configuration for the token exchange grant type. |
token_format | 0..1 | string | Format of the access token.
Allowed values: jwt |
access_token_expiration | 0..1 | integer | Expiration time for access tokens in seconds. |
refresh_token_expiration | 0..1 | integer | Expiration time for refresh tokens in seconds. |
audience | 0..* | string | Intended audience for issued tokens. |
refresh_token | 0..1 | boolean | Whether to issue refresh tokens with this grant type. |
description | 0..1 | string | A description of the client application for administrative purposes. |
details | 0..1 | Object | Additional client details or configuration options. |
fhir-base-url | 0..1 | string | Base URL of the FHIR server this client interacts with. |
first_party | 0..1 | boolean | Indicates whether this is a first-party client. |
grant_types | 0..* | string | OAuth 2.0 grant types this client is authorized to use.
Allowed values: basic | authorization_code | code | password | client_credentials | implicit | refresh_token | urn:ietf:params:oauth:grant-type:token-exchange |
jwks | 0..* | BackboneElement | JSON Web Key Set for client authentication and/or verification. |
kid | 0..1 | string | Key ID that identifies this key. |
kty | 0..1 | string | Key type.
Allowed values: RSA |
alg | 0..1 | string | Algorithm used with this key.
Allowed values: RS384 |
e | 0..1 | string | Exponent value for RSA key. |
n | 0..1 | string | Modulus value for RSA key. |
use | 0..1 | string | Key usage.
Allowed values: sig |
jwks_uri | 0..1 | url | URI where the client's JSON Web Key Set can be retrieved. |
name | 0..1 | string | Human-readable name of the client application. |
scope | 0..* | string | List of scopes this client is authorized to request. |
scopes | 0..* | BackboneElement | Detailed scope configurations with associated policies. |
policy | 0..1 | Reference | Reference to an AccessPolicy resource for this scope.
Allowed references: AccessPolicy |
parameters | 0..1 | Object | Parameters to be applied with the scope's policy. |
secret | 0..1 | Hashed client secret for authentication. | |
smart | 0..1 | BackboneElement | SMART on FHIR configuration for this client. |
launch_uri | 0..1 | string | URI to launch the SMART app. |
name | 0..1 | string | Name of the SMART app. |
description | 0..1 | string | Description of the SMART app. |
trusted | 0..1 | boolean | Indicates whether this client is trusted and given special privileges. |
type | 0..1 | string | The type of client application. |
Concept
Terminology concept resource for Aidbox.
| Name | Card. | Type | Description |
|---|---|---|---|
Concept | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
ancestors | 0..1 | Object | List of ancestor concepts in the hierarchy. |
code | 1..1 | string | Symbol or identifier for the concept within the system. |
definition | 0..1 | string | Formal definition of the concept. |
deprecated | 0..1 | boolean | Indicates whether the concept is deprecated. |
designation | 0..1 | Object | Additional representations for the concept. |
definition | 0..1 | Object | Additional definitions for the concept. |
display | 0..1 | Object | Display names in different languages or contexts. |
display | 0..1 | string | Human-readable representation of the concept. |
hierarchy | 0..* | string | Hierarchies this concept belongs to. |
property | 0..1 | Object | Additional properties associated with the concept. |
system | 1..1 | string | Code system that defines the concept. |
valueset | 0..* | string | Value sets that include this concept. |
Search Parameters
| SearchParameter | Type | Expression | Description |
|---|---|---|---|
| code | string | code | Search Concept by code |
| codetext | string | code | Search Concept by code as text |
| deprecated | token | deprecated | Search Concept by deprecated status |
| display | string | display | Search Concept by display |
| hierarchy | string | hierarchy | Search Concept by hierarchy |
| system | string | system | Search Concept by system |
| valueset | string | valueset | Search Concept by valueset |
ConceptMapRule
Concept mapping rule resource for terminology translations.
| Name | Card. | Type | Description |
|---|---|---|---|
ConceptMapRule | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
conceptmapId | 0..1 | string | ID of the parent concept map. |
conceptmapUrl | 0..1 | string | URL of the parent concept map. |
element | 0..1 | BackboneElement | Element mapping definition. |
target | 0..1 | BackboneElement | Target mapping information. |
comment | 0..1 | string | Comment about the mapping. |
equivalence | 0..1 | string | Equivalence relationship between source and target. |
source | 0..1 | string | Source system for the mapping. |
sourceValueSet | 0..1 | string | Source value set for the mapping. |
target | 0..1 | string | Target system for the mapping. |
targetValueSet | 0..1 | string | Target value set for the mapping. |
unmapped | 0..1 | BackboneElement | Rules for handling unmapped concepts. |
url | 0..1 | string | URL for unmapped value set. |
mode | 0..1 | string | Mode for handling unmapped concepts. |
CustomType
A modifier extension for ElementDefinition that indicates the element uses a custom non-FHIR type. When value is 'any', compiles to {any: true} schema without additionalProperties wrapper.
| Name | Card. | Type | Description |
|---|---|---|---|
CustomType | |||
extension | 0..1 | ||
url | 0..1 | ||
value[x] | 1..1 | code | Custom type code |
DisabledIndex
| Name | Card. | Type | Description |
|---|---|---|---|
DisabledIndex | |||
indexdef | 0..1 | string | SQL definition of the index. |
indexname | 0..1 | string | Name of the database index that has been disabled. |
restore | 0..1 | BackboneElement | Information about the index restoration process. |
start | 0..1 | dateTime | Time when the index restoration started. |
end | 0..1 | dateTime | Time when the index restoration completed. |
duration | 0..1 | integer | Duration of the index restoration in milliseconds. |
schemaname | 0..1 | string | Name of the database schema containing the index. |
status | 0..1 | string | Current status of the index (restored or disabled).
Allowed values: restored | disabled |
tablename | 0..1 | string | Name of the table associated with this index. |
tablespace | 0..1 | string | Tablespace where the index is stored. |
Entity
Entity definition resource for custom Aidbox resource types.
| Name | Card. | Type | Description |
|---|---|---|---|
Entity | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
description | 0..1 | string | Human-readable description of the entity. |
history | 0..1 | string | History tracking mode for this entity.
Allowed values: none | diff |
idGeneration | 0..1 | string | Strategy for generating IDs for this entity.
Allowed values: sequence | uuid |
isMeta | 0..1 | boolean | Whether this entity is a metadata entity. |
isOpen | 0..1 | boolean | Whether this entity allows additional properties. |
module | 0..1 | string | Module that this entity belongs to. |
nonPersistable | 0..1 | boolean | Whether this entity should not be persisted. |
schema | 0..1 | Object | Schema definition for the entity. |
sequencePrefix | 0..1 | string | Prefix for sequence-generated IDs. |
text | 0..1 | string | Human-readable text about the entity. |
type | 1..1 | string | Type of entity definition.
Allowed values: abstract | resource | type | primitive |
FlatImportStatus
Status tracking resource for flat file imports.
| Name | Card. | Type | Description |
|---|---|---|---|
FlatImportStatus | |||
error | 0..1 | BackboneElement | Error information when import fails. |
code | 0..1 | string | Error code. |
message | 0..1 | string | Error message description. |
params | 0..1 | Object | Parameters used for the import. |
result | 0..1 | BackboneElement | Result information for successful import. |
count | 0..1 | integer | Count of successfully imported resources. |
status | 0..1 | string | Current status of the import process.
Allowed values: in-progress | done | fail |
FtrConfig
FHIR Terminology Repository configuration resource.
| Name | Card. | Type | Description |
|---|---|---|---|
FtrConfig | |||
module | 0..1 | string | Module that this configuration belongs to. |
package-name | 0..1 | string | Name of the FHIR terminology package. |
tag | 0..1 | string | Tag for terminology resources. |
tag-index | 0..1 | Index of tags and their associations. |
GcpServiceAccount
| Name | Card. | Type | Description |
|---|---|---|---|
GcpServiceAccount | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
private-key | 0..1 | string | Private key for GCP service account authentication. |
service-account-email | 0..1 | string | Email address of the GCP service account. |
Grant
| Name | Card. | Type | Description |
|---|---|---|---|
Grant | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
client | 0..1 | Reference | Reference to the client application being granted access.
Allowed references: Client |
patient | 0..1 | Reference | Reference to the patient this grant is for (in SMART on FHIR scenarios).
Allowed references: Patient |
provided-scope | 0..* | string | List of scopes that were actually granted by the user. |
requested-scope | 0..* | string | List of scopes that were requested by the client. |
scope | 0..1 | string | Space-separated list of granted scopes. |
start | 0..1 | dateTime | Time when this grant was created. |
user | 0..1 | Reference | Reference to the user who granted the access.
Allowed references: User |
Hl7v2Config
| Name | Card. | Type | Description |
|---|---|---|---|
Hl7v2Config | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
extensions | 0..* | BackboneElement | Extensions for the HL7v2 message processing configuration. |
segment | 0..1 | string | HL7v2 segment identifier. |
msh | 0..1 | string | Message header information. |
after | 0..1 | string | After segment placement. |
quantifier | 0..1 | string | Occurrence quantifier.
Allowed values: * | ? | + |
fields | 0..* | BackboneElement | Fields within the segment. |
key | 0..1 | string | Field key. |
name | 0..1 | string | Field name. |
type | 0..1 | string | Field type. |
isStrict | 0..1 | boolean | Whether strict validation should be applied. |
mapping | 0..1 | Reference | Reference to a mapping resource for message transformation.
Allowed references: Mapping |
sortTopLevelExtensions | 0..1 | boolean | Whether to sort top-level extensions during processing. |
text | 0..1 | BackboneElement | Narrative text representation. |
div | 0..1 | string | HTML content of the narrative. |
status | 0..1 | string | Status of the narrative text. |
Hl7v2Message
| Name | Card. | Type | Description |
|---|---|---|---|
Hl7v2Message | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
apiOperation | 0..1 | string | API operation to be performed with this message. |
config | 0..1 | Reference | Reference to the configuration for processing this message.
Allowed references: Hl7v2Config |
event | 0..1 | code | Event type code from the HL7v2 message. |
outcome | 0..1 | Object | Outcome of message processing. |
parsed | 0..1 | Object | Parsed content of the HL7v2 message. |
src | 1..1 | string | Original source text of the HL7v2 message. |
status | 1..1 | string | Processing status of the message (received, processed, or error).
Allowed values: received | processed | error |
type | 0..1 | code | Message type code from the HL7v2 message. |
Search Parameters
| SearchParameter | Type | Expression | Description |
|---|---|---|---|
| config | reference | config | Search Hl7v2Message by config |
| event | token | event | Search Hl7v2Message by event |
| type | token | type | Search Hl7v2Message by type |
IdentityProvider
| Name | Card. | Type | Description |
|---|---|---|---|
IdentityProvider | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
active | 0..1 | boolean | Indicates whether this identity provider is active and can be used for authentication. |
authorize_endpoint | 0..1 | string | The URL of the authorization endpoint. |
base_url | 0..1 | uri | Base URL for the identity provider. |
client | 0..1 | BackboneElement | Client configuration for this identity provider. |
id | 0..1 | string | Client identifier used for authentication with the identity provider. |
redirect_uri | 0..1 | uri | URI where the provider will redirect after authentication. |
auth-method | 0..1 | string | Client authentication method.
Allowed values: symmetric | asymmetric |
secret | 0..1 | string | Client secret for symmetric authentication. |
private-key | 0..1 | string | Private key for asymmetric authentication. |
certificate | 0..1 | string | Client certificate for authentication. |
certificate-thumbprint | 0..1 | string | Certificate thumbprint. |
creds-ts | 0..1 | string | Credentials timestamp. |
introspection_endpoint | 0..1 | string | The URL of the token introspection endpoint. |
isEmailUniqueness | 0..1 | boolean | Indicates whether email uniqueness should be enforced for this provider. |
isScim | 0..1 | boolean | Indicates whether this provider supports SCIM protocol. |
jwks_uri | 0..1 | string | URI where the provider's JSON Web Key Set can be retrieved. |
kid | 0..1 | string | Key identifier used for token verification. |
organizations | 0..* | string | Organizations associated with this identity provider. |
registration_endpoint | 0..1 | string | The URL of the registration endpoint. |
revocation_endpoint | 0..1 | string | The URL of the token revocation endpoint. |
scopes | 0..* | string | OAuth scopes that should be requested during authentication. |
system | 0..1 | string | System identifier for the identity provider. |
team_id | 0..1 | string | Team ID (for Apple). |
title | 0..1 | string | A human-readable name for the identity provider. |
toScim | 0..1 | Object | Mapping rules for transforming identity provider data. |
token_endpoint | 0..1 | string | The URL of the token endpoint. |
type | 0..1 | string | The type of identity provider.
Allowed values: aidbox | github | google | OIDC | OAuth | az-dev | yandex | okta | apple |
userinfo-source | 0..1 | string | Source of userinfo details.
Allowed values: id-token | userinfo-endpoint |
userinfo_endpoint | 0..1 | string | The URL of the userinfo endpoint. |
userinfo_header | 0..1 | string | Header to be used when calling the userinfo endpoint. |
IndexCreationJob
Database index creation job tracking resource.
| Name | Card. | Type | Description |
|---|---|---|---|
IndexCreationJob | |||
end | 0..1 | dateTime | Time when the index creation finished. |
index | 0..1 | string | Name of the database index being created. |
message | 0..1 | string | Status or error message. |
params | 1..* | string | Parameters for the index creation. |
procstatus | 0..1 | string | Current status of the index creation process.
Allowed values: pending | in-progress | done | error |
resource | 0..1 | string | Resource type for which the index is being created. |
start | 0..1 | dateTime | Time when the index creation started. |
Lambda
Lambda function resource for hook-based code execution.
| Name | Card. | Type | Description |
|---|---|---|---|
Lambda | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
code | 1..1 | string | Code to be executed by the lambda. |
hook | 1..1 | code | Type of hook this lambda responds to.
Allowed values: audit |
LoaderFile
| Name | Card. | Type | Description |
|---|---|---|---|
LoaderFile | |||
bucket | 0..1 | string | Storage bucket where the file is located. |
end | 0..1 | dateTime | Time when the file loading process completed. |
error | 0..1 | BackboneElement | Information about errors encountered during file loading. |
source | 0..1 | string | Source of the error.
Allowed values: postgres | aws | aidbox |
code | 0..1 | string | Error code or identifier. |
file | 0..1 | string | Path or name of the file being loaded. |
last-modified | 0..1 | string | Last modification timestamp of the file. |
loaded | 0..1 | integer | Number of resources successfully loaded from this file. |
message | 0..1 | string | Status or error message related to the file loading process. |
size | 0..1 | decimal | Size of the file in bytes. |
start | 0..1 | dateTime | Time when the file loading process started. |
status | 0..1 | string | Current status of the file loading process.
Allowed values: pending | in-progress | done | error | skiped |
type | 0..1 | string | Type of the file or contained resources. |
Mapping
Data transformation mapping resource for Aidbox.
| Name | Card. | Type | Description |
|---|---|---|---|
Mapping | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
body | 1..1 | Object | Mapping transformation definition. |
params | 0..1 | BackboneElement | Parameters for the mapping execution. |
omit-drop-blanks | 0..1 | boolean | Whether to omit blank values from the result. |
returns | 0..1 | code | Type of result returned by the mapping.
Allowed values: transaction | resource |
scopeSchema | 0..1 | Object | Schema defining the scope for mapping. |
text | 0..1 | BackboneElement | Human-readable text about the mapping. |
status | 0..1 | string | Status of the text. |
div | 0..1 | string | HTML representation of the text. |
type | 0..1 | string | Type of the mapping. |
Module
Module definition resource for Aidbox.
| Name | Card. | Type | Description |
|---|---|---|---|
Module | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
meta | 0..1 | Meta | Metadata for the module. |
pre-sql | 0..1 | string | SQL to execute before module installation. |
post-sql | 0..1 | string | SQL to execute after module installation. |
module | 0..1 | string | Identifier for the module. |
version | 0..1 | integer | Version number of the module. |
Notebook
Notebook resource for interactive documentation and code execution.
| Name | Card. | Type | Description |
|---|---|---|---|
Notebook | |||
cells | 0..* | BackboneElement | Cells contained in the notebook. |
id | 1..1 | Unique identifier for the cell. | |
type | 1..1 | string | Type of cell content.
Allowed values: rpc | rest | empty | markdown | sql |
nb-title | 0..1 | string | Title for the cell. |
evaluating? | 0..1 | boolean | Whether the cell is currently being evaluated. |
value | 0..1 | Content value of the cell. | |
result | 0..1 | Result of cell evaluation. | |
error | 0..1 | Error information if evaluation failed. | |
folded | 0..1 | BackboneElement | Folding state of the cell. |
code | 0..1 | boolean | Whether the code section is folded. |
result | 0..1 | boolean | Whether the result section is folded. |
description | 0..1 | string | Description of the notebook. |
edit-secret | 0..1 | string | Secret for edit access to the notebook. |
name | 0..1 | string | Name of the notebook. |
notebook-superuser-secret | 0..1 | string | Secret for superuser access to the notebook. |
origin | 0..1 | string | Origin information for the notebook. |
publication-id | 0..1 | string | Identifier for the published version of the notebook. |
source | 0..1 | Source content for the notebook. | |
tags | 0..* | string | Tags associated with the notebook. |
Notification
| Name | Card. | Type | Description |
|---|---|---|---|
Notification | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
provider | 0..1 | string | Notification provider. |
providerData | 0..1 | Object | Provider-specific data. |
status | 0..1 | string | Status of the notification delivery (delivered or error).
Allowed values: delivered | error |
NotificationTemplate
| Name | Card. | Type | Description |
|---|---|---|---|
NotificationTemplate | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
subject | 0..1 | string | Subject line for the notification template. |
template | 0..1 | string | Template content used to generate the notification message. |
Operation
Custom operation definition resource for Aidbox.
| Name | Card. | Type | Description |
|---|---|---|---|
Operation | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
action | 0..1 | Object | Action to be performed by the operation. |
app | 0..1 | Reference | Reference to associated App.
Allowed references: App |
data | 0..1 | Object | Additional operation data. |
description | 0..1 | string | Human-readable description of the operation. |
fhirCode | 0..1 | string | FHIR operation code. |
fhirResource | 0..* | string | FHIR resources this operation applies to. |
fhirUrl | 0..1 | string | FHIR URL pattern for the operation. |
implicit-params | 0..1 | BackboneElement | Parameters that are implicitly included in the operation. |
path | 0..1 | Object | Path parameters. |
query | 0..1 | Object | Query parameters. |
module | 0..1 | string | Module that this operation belongs to. |
no-op-logs | 0..1 | boolean | Whether to disable operation logging. |
public | 0..1 | boolean | Whether the operation is publicly accessible. |
request | 0..* | Object | Request configurations. |
route-params | 0..1 | Object | Parameters for route matching. |
transform | 0..1 | BackboneElement | Transformation configuration for the operation. |
request | 0..1 | BackboneElement | Request transformation settings. |
engine | 1..1 | code | Transformation engine to use. |
template | 0..1 | Reference | Reference to a template for transformation. |
part | 1..1 | string | Part of the request to transform.
Allowed values: body |
PGSequence
PostgreSQL sequence definition resource for Aidbox.
| Name | Card. | Type | Description |
|---|---|---|---|
PGSequence | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
cycle | 0..1 | boolean | Whether the sequence should cycle when reaching max/min value. |
data_type | 0..1 | string | PostgreSQL data type for the sequence.
Allowed values: smallint | integer | bigint |
increment | 0..1 | integer | Value to increment by for each sequence call. |
maxvalue | 0..1 | integer | Maximum value for the sequence. |
minvalue | 0..1 | integer | Minimum value for the sequence. |
start | 0..1 | integer | Starting value for the sequence. |
Registration
| Name | Card. | Type | Description |
|---|---|---|---|
Registration | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
params | 0..1 | Object | |
resource | 0..1 | Object | Registration form data. |
status | 0..1 | string | Status of the registration process.
Allowed values: activated | active |
Role
Role resource for assigning access roles to users.
| Name | Card. | Type | Description |
|---|---|---|---|
Role | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
context | 0..1 | Object | Additional context data. |
description | 0..1 | string | Text description of the role. |
links | 0..1 | BackboneElement | You may list resources here, which can later be granted access for the user with this role via an AccessPolicy resource. |
patient | 0..1 | Reference | Reference to Patient resource
Allowed references: Patient |
practitionerRole | 0..1 | Reference | Reference to PractitionerRole resource.
Allowed references: PractitionerRole |
practitioner | 0..1 | Reference | Reference to Practitioner resource.
Allowed references: Practitioner |
organization | 0..1 | Reference | Reference to Organization resource.
Allowed references: Organization |
person | 0..1 | Reference | Reference to Person resource.
Allowed references: Person |
relatedPerson | 0..1 | Reference | Reference to RelatedPerson resource.
Allowed references: RelatedPerson |
name | 1..1 | string | Role name is a string that defines role. To assign the same role to multiple users, create multiple Role resources with the same "name". [Search param: name => type string] |
user | 1..1 | Reference | Reference to a User resource for which the role will be applied. [Search param: user => type reference]
Allowed references: User |
SchedulerRuleStatus
| Name | Card. | Type | Description |
|---|---|---|---|
SchedulerRuleStatus | |||
allowedRetryCount | 0..1 | integer | Maximum number of retries allowed for this rule. |
concurrencyLimit | 0..1 | decimal | Maximum number of concurrent executions allowed for this rule. |
concurrencyPath | 0..* | string | Path to the field used for concurrency control. |
definition | 1..1 | string | Identifier for the scheduler rule definition. |
executeAt | 0..1 | dateTime | Next scheduled execution time for this rule. |
inProgressTimeout | 0..1 | decimal | Maximum duration in seconds that a task can remain in in-progress status before timing out. |
label | 0..1 | string | Human-readable label for the scheduler rule. |
lastSchedule | 0..1 | dateTime | Timestamp of the last schedule attempt. |
lastScheduleReference | 0..1 | BackboneElement | Reference to the last scheduled task for this rule. |
id | 0..1 | string | Identifier of the last scheduled task. |
resourceType | 0..1 | string | Type of resource that was last scheduled. |
display | 0..1 | string | Human-readable display name of the last scheduled task. |
lastScheduleStatus | 0..1 | string | Status of the last schedule attempt.
Allowed values: started | skipped |
params | 1..1 | Parameters required for rule execution. | |
requestedToStartTimeout | 0..1 | decimal | Maximum duration in seconds that a task can remain in requested status before timing out. |
retryDelay | 0..1 | decimal | Delay in seconds before retrying a failed rule execution. |
Scope
| Name | Card. | Type | Description |
|---|---|---|---|
Scope | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
description | 0..1 | string | Scope definition additionally displayed on the consent screen. |
scope | 1..1 | string | The value of the scope. |
title | 1..1 | string | A user-friendly name for the scope that appears on the consent screen. |
Search
Custom search parameter definition resource for Aidbox.
| Name | Card. | Type | Description |
|---|---|---|---|
Search | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
format | 0..1 | string | Replaces ? with the actual value provided in the search query. Useful to use in ILIKE SQL expression. |
module | 0..1 | string | Module that this search belongs to. |
multi | 0..1 | string | If you set multi = 'array', parameters will be coerced as PostgreSQL array.
Allowed values: array |
name | 0..1 | string | Name of the search parameter. |
order-by | 0..1 | string | SQL to use in the ORDER BY expression. Supports {{table}} and {{param}}. Note that it is used only when _sort=<name> present in the query. |
param-parser | 0..1 | string | Parse value as string, identifier, or reference.
Allowed values: token | reference |
resource | 0..1 | Reference | Reference to the resource type this search applies to. ResourceType is always Entity |
token-sql | 0..1 | BackboneElement | SQL templates for token parameter handling. |
text | 0..1 | string | SQL template for text search. |
both | 0..1 | string | SQL template when both system and code are provided. |
only-system | 0..1 | string | SQL template when only system is provided. |
only-code | 0..1 | string | SQL template when only code is provided. |
text-format | 0..1 | string | Format for text search. |
no-system | 0..1 | string | SQL template when no system is provided. |
where | 0..1 | string | SQL to use in the WHERE expression. Supports {{table}} and {{param}}. |
SearchQuery
Custom search query resource for Aidbox.
| Name | Card. | Type | Description |
|---|---|---|---|
SearchQuery | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
as | 0..1 | string | Alias for the resource in the query. |
includes | 0..1 | Object | Resources to include with the results. |
limit | 0..1 | integer | Maximum number of results to return. |
params | 0..1 | Object | Search parameters for the query. |
query | 0..1 | BackboneElement | Detailed query configuration. |
order-by | 0..1 | string | Column or expression to order results by. |
join | 0..1 | Object | Join conditions for the query. |
where | 0..1 | string | Where clause for the query. |
resource | 1..1 | Reference | Reference to the resource type to search. |
total | 0..1 | boolean | Whether to include total count in results. |
SecretReference
Contains the name of a secret defined in the vault config file. Used together with data-absent-reason=masked to indicate that the field value is resolved at runtime from a mounted secret file.
| Name | Card. | Type | Description |
|---|---|---|---|
SecretReference | |||
extension | 0..1 | ||
url | 0..1 | ||
value[x] | 1..1 | string |
SeedImport
Seed data import resource for initial data loading.
| Name | Card. | Type | Description |
|---|---|---|---|
SeedImport | |||
filename | 0..1 | string | Name of the seed import file. |
md5-hash | 0..1 | string | MD5 hash of the import file for integrity verification. |
resources | 0..* | BackboneElement | Resources to be imported. |
resourceType | 1..1 | string | Type of resource. |
id | 1..1 | string | Identifier for the resource. |
meta | 0..1 | Object | Metadata for the resource. |
version | 0..1 | string | Version of the seed import format.
Allowed values: v2 |
Session
| Name | Card. | Type | Description |
|---|---|---|---|
Session | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
access_token | 0..1 | Access token hash associated with this session. | |
active | 0..1 | boolean | Indicates whether this session is currently active. |
audience | 0..1 | string | Intended audience for tokens issued in this session. |
authorization_code | 0..1 | Authorization code used to obtain this session. | |
client | 0..1 | Reference | Reference to the client application associated with this session.
Allowed references: Client |
ctx | 0..1 | Object | Session context data. |
end | 0..1 | dateTime | Time when the session ended or will end. |
exp | 0..1 | integer | Expiration time for the access token (in seconds since epoch). |
iss | 0..1 | string | Issuer of token for the current session. |
jti | 0..1 | string | JWT ID. |
on-behalf | 0..1 | Reference | Reference to a user on whose behalf this session is operating.
Allowed references: User |
parent | 0..1 | Reference | Reference to a parent session if this is a child session.
Allowed references: Session |
patient | 0..1 | Reference | Reference to the patient associated with this session.
Allowed references: Patient |
refresh_token | 0..1 | Refresh token hash associated with this session. | |
refresh_token_exp | 0..1 | integer | Expiration time for the refresh token (in seconds since epoch). |
scope | 0..* | string | List of OAuth scopes authorized for this session. |
start | 0..1 | dateTime | Time when the session started. |
type | 0..1 | string | Type of session (e.g., authorization_code, password, client_credentials). |
user | 0..1 | Reference | Reference to the user associated with this session.
Allowed references: User |
SubsNotification
Subscription notification tracking resource.
| Name | Card. | Type | Description |
|---|---|---|---|
SubsNotification | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
duration | 0..1 | integer | Duration of the notification processing in milliseconds. |
notification | 0..1 | Object | Content of the notification that was sent. |
response | 0..1 | Object | Response received from the notification endpoint. |
retried | 0..1 | boolean | Whether this notification is a retry. |
retries | 0..* | Reference | References to retry notifications.
Allowed references: SubsSubscription |
retryOf | 0..1 | Reference | Reference to the original notification this is retrying.
Allowed references: SubsSubscription |
status | 0..1 | code | Status of the notification delivery.
Allowed values: success | failed |
subscription | 0..1 | Reference | Reference to the subscription that generated this notification.
Allowed references: SubsSubscription |
SubsSubscription
Topic-based subscription resource for event notifications.
| Name | Card. | Type | Description |
|---|---|---|---|
SubsSubscription | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
channel | 1..1 | BackboneElement | Channel configuration for delivering notifications. |
type | 1..1 | code | Type of channel for notifications.
Allowed values: rest-hook |
endpoint | 1..1 | url | URL endpoint where notifications are sent. |
timeout | 0..1 | integer | Timeout in milliseconds for notification delivery. |
heartbeatPeriod | 0..1 | integer | Period in milliseconds for sending heartbeat notifications. |
headers | 0..1 | Object | HTTP headers to include with notifications. |
payload | 0..1 | BackboneElement | Content to be sent in the notification. |
content | 0..1 | code | Content type for payload.
Allowed values: id-only | full-resource |
contentType | 0..1 | code | MIME type of the payload.
Allowed values: json | fhir+json |
context | 0..1 | Additional context for the payload. | |
identifier | 0..* | Identifier | Business identifiers for the subscription. |
status | 0..1 | code | Current status of the subscription.
Allowed values: active | off |
trigger | 0..1 | Object | Events that trigger this subscription. |
TerminologyBundleFile
Terminology bundle file tracking resource.
| Name | Card. | Type | Description |
|---|---|---|---|
TerminologyBundleFile | |||
filename | 0..1 | string | Name of the terminology bundle file. |
status | 0..1 | string | Current status of the bundle file processing.
Allowed values: pending | in-progress | fail | success |
TokenIntrospector
| Name | Card. | Type | Description |
|---|---|---|---|
TokenIntrospector | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
cache_ttl | 0..1 | integer | Cache TTL for token introspection results in seconds. |
identity_provider | 0..1 | Reference | Link to Identity provider associated with the token introspector.
Allowed references: IdentityProvider |
introspection_endpoint | 0..1 | BackboneElement | Remote introspection endpoint configuration. |
url | 0..1 | string | The fully qualified URL of the remote introspection endpoint. |
authorization | 0..1 | string | The authorization header value. |
jwks_uri | 0..1 | string | A URL pointing to a JSON Web Key Set (JWKS). When type is jwt the introspector retrieves public keys from this URI to validate token signatures. |
jwt | 0..1 | BackboneElement | Configuration for local JWT validation used when type is jwt. |
iss | 0..1 | string | The expected issuer (iss) claim value for JWTs. The TokenIntrospector ensures that tokens it validates come from this issuer. |
secret | 0..1 | string | A shared secret key or other signing key material used to verify the JWT's signature. |
keys | 0..* | BackboneElement | The set of keys to use for validation. |
k | 0..1 | string | The symmetric key to use for validation. |
pub | 0..1 | string | The asymmetric key to use for validation. |
kty | 1..1 | string | The key type to use for validation.
Allowed values: RSA | EC | OCT |
alg | 1..1 | string | The algorithm to use for validation.
Allowed values: RS256 | RS384 | ES256 | HS256 |
format | 1..1 | string | The format of the key to use for validation. 'plain' for symmetric algs (HS256) and 'PEM' for all asymmetric algs
Allowed values: PEM | plain |
type | 1..1 | string | Specifies the type of token to introspect.
Allowed values: opaque | jwt | aspxauth |
User
| Name | Card. | Type | Description |
|---|---|---|---|
User | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
active | 0..1 | boolean | Deprecated. Use 'inactive' instead. Indicates the User's administrative status. |
addresses | 0..* | BackboneElement | A physical mailing address for this User. |
formatted | 0..1 | string | Full address, formatted for display or mailing label. |
streetAddress | 0..1 | string | Street address component (may contain newlines). |
locality | 0..1 | string | City or locality component. |
region | 0..1 | string | State or region component. |
postalCode | 0..1 | string | Zip code or postal code. |
country | 0..1 | string | Country name component. |
type | 0..1 | string | A label indicating the address type. |
costCenter | 0..1 | string | Identifies the name of a cost center. |
data | 0..1 | Object | Arbitrary user-related data. |
department | 0..1 | string | Identifies the name of a department. |
displayName | 0..1 | string | The name of the User, suitable for display to end-users. |
division | 0..1 | string | Identifies the name of a division. |
email | 0..1 | string | Primary email for the user. |
emails | 0..* | BackboneElement | Email addresses for the user. |
value | 0..1 | string | An individual email address (canonicalized). |
display | 0..1 | string | A human-readable name for display purposes (READ-ONLY). |
type | 0..1 | string | A label indicating the attribute's function, e.g. 'work', 'home'. |
primary | 0..1 | boolean | Indicates if this is the primary email. |
employeeNumber | 0..1 | string | Numeric or alphanumeric identifier assigned to a person. |
entitlements | 0..* | BackboneElement | A list of entitlements for the User that represent a thing the User has. |
value | 0..1 | string | The value of an entitlement. |
display | 0..1 | string | A human-readable name, primarily used for display purposes (READ-ONLY). |
type | 0..1 | string | A label indicating the attribute's function. |
primary | 0..1 | boolean | Indicates if this is the primary entitlement. Only one may be 'true'. |
fhirUser | 0..1 | Reference | A reference to a related FHIR resource.
Allowed references: Patient, Practitioner, PractitionerRole, Person, RelatedPerson |
gender | 0..1 | string | The user's gender. |
identifier | 0..* | Identifier | A list of identifiers for the user. |
ims | 0..* | BackboneElement | Instant messaging addresses for the User. |
value | 0..1 | string | Instant messaging address. |
display | 0..1 | string | A human-readable name, primarily for display (READ-ONLY). |
type | 0..1 | string | A label indicating the IM type, e.g. 'aim', 'gtalk'. |
primary | 0..1 | boolean | Indicates if this is the primary IM. Only one may be 'true'. |
inactive | 0..1 | boolean | A Boolean value indicating the User's administrative status. |
link | 0..* | BackboneElement | A collection of references or links associated with the user. |
link | 0..1 | Reference | A referenced resource link. |
type | 0..1 | string | A label indicating the link's function. |
locale | 0..1 | string | Indicates the User's default location for localization. |
manager | 0..1 | Reference | Another User resource who is this User's manager.
Allowed references: User |
name | 0..1 | BackboneElement | The components of the user's real name. |
formatted | 0..1 | string | Full name, including titles and suffixes, formatted for display. |
familyName | 0..1 | string | Family name (last name in Western languages). |
givenName | 0..1 | string | Given name (first name in Western languages). |
middleName | 0..1 | string | The middle name(s) of the User. |
honorificPrefix | 0..1 | string | Honorific prefix (title), e.g. 'Ms.'. |
honorificSuffix | 0..1 | string | Honorific suffix, e.g. 'III'. |
organization | 0..1 | Reference | Identifies the name of an organization.
Allowed references: Organization |
password | 0..1 | The User's cleartext password, used for initial or reset scenarios. | |
phoneNumber | 0..1 | string | Primary phone number. |
phoneNumbers | 0..* | BackboneElement | Phone numbers for the User. |
value | 0..1 | string | The user's phone number. |
display | 0..1 | string | A human-readable name for display purposes (READ-ONLY). |
type | 0..1 | string | A label for the phone number's function. |
primary | 0..1 | boolean | Indicates if this is the primary phone number. |
photo | 0..1 | uri | Primary photo for the user. |
photos | 0..* | BackboneElement | URLs of photos of the user. |
value | 0..1 | uri | URL of a photo of the User. |
display | 0..1 | string | A human-readable name, primarily used for display purposes (READ-ONLY). |
type | 0..1 | string | A label indicating 'photo' or 'thumbnail'. |
primary | 0..1 | boolean | Indicates if this is the primary photo. Only one may be 'true'. |
preferredLanguage | 0..1 | string | The User's preferred written or spoken language. |
profileUrl | 0..1 | uri | A fully qualified URL pointing to a page representing the User's online profile. |
roles | 0..* | BackboneElement | A list of roles for the User that collectively represent who the User is (e.g. 'Student', 'Faculty'). |
value | 0..1 | string | The value of a role. |
display | 0..1 | string | A human-readable name, primarily used for display purposes (READ-ONLY). |
type | 0..1 | string | A label indicating the attribute's function. |
primary | 0..1 | boolean | Indicates if this is the primary role. Only one may be 'true'. |
securityLabel | 0..* | BackboneElement | List of security labels associated to the user. |
system | 0..1 | string | Code system. |
code | 0..1 | string | Code value. |
timezone | 0..1 | string | The User's time zone in the 'Olson' format. |
title | 0..1 | string | The user's title, e.g. 'Vice President'. |
twoFactor | 0..1 | BackboneElement | Two factor settings for user. |
enabled | 1..1 | boolean | Defines whether two-factor auth is currently enabled. |
transport | 0..1 | string | Transport of 2FA confirmation code (if used). |
secretKey | 1..1 | string | TOTP Secret key. |
userName | 0..1 | string | Unique identifier for the User, typically used to directly authenticate. |
userType | 0..1 | string | Identifies the relationship between the organization and the user. |
x509Certificates | 0..* | BackboneElement | A list of certificates issued to the User. |
value | 0..1 | base64Binary | The value of an X.509 certificate (base64). |
display | 0..1 | string | A human-readable name, primarily used for display purposes (READ-ONLY). |
type | 0..1 | string | A label indicating the certificate's function. |
primary | 0..1 | boolean | Indicates if this is the primary certificate. Only one may be 'true'. |
Search Parameters
| SearchParameter | Type | Expression | Description |
|---|---|---|---|
| active | token | active | Search User by active status |
| string | email | Search User by email | |
| gender | string | gender | Search User by gender |
| identifier | token | identifier | Search User by identifier |
| inactive | token | inactive | Search User by inactive status |
| name | string | name.formatted | name.givenName | name.familyName | Search User by name |
| organization | reference | organization | Search User by organization |
| phoneNumber | string | phoneNumber | Search User by phone number |
| title | string | title | Search User by title |
| userName | string | userName | Search User by userName |
ViewDefinition
| Name | Card. | Type | Description |
|---|---|---|---|
ViewDefinition | |||
constant | 0..* | BackboneElement | Constant that can be used in FHIRPath expressions |
name | 1..1 | string | Name of constant (referred to in FHIRPath as %[name]) |
value[x] | 1..1 | base64Binary | Value of constant |
contact | 0..* | ContactDetail | Contact details for the publisher |
copyright | 0..1 | markdown | Use and/or publishing restrictions |
description | 0..1 | markdown | Natural language description of the view definition |
experimental | 0..1 | boolean | For testing purposes, not real usage |
fhirVersion | 0..* | code | FHIR version(s) of the resource for the ViewDefinition |
identifier | 0..1 | Identifier | Additional identifier for the view definition |
meta | 0..1 | Meta | Metadata about the view definition |
name | 0..1 | string | Name of view definition (computer and database friendly) |
publisher | 0..1 | string | Name of the publisher/steward (organization or individual) |
resource | 1..1 | code | FHIR resource for the ViewDefinition |
select | 1..* | BackboneElement | A collection of columns and nested selects to include in the view. |
column | 0..* | BackboneElement | A column to be produced in the resulting table. |
extension | 0..* | Extension | |
path | 1..1 | string | FHIRPath expression that creates a column and defines its content |
name | 1..1 | string | Column name produced in the output |
type | 0..1 | uri | A FHIR StructureDefinition URI for the column's type. |
collection | 0..1 | boolean | Indicates whether the column may have multiple values. |
description | 0..1 | markdown | Description of the column |
tag | 0..* | BackboneElement | Additional metadata describing the column |
name | 1..1 | string | Name of tag |
value | 1..1 | string | Value of tag |
select | 0..* | Nested select relative to a parent expression. | |
forEach | 0..1 | string | A FHIRPath expression to retrieve the parent element(s) used in the containing select. The default is effectively $this. |
forEachOrNull | 0..1 | string | Same as forEach, but will produce a row with null values if the collection is empty. |
unionAll | 0..* | Creates a union of all rows in the given selection structures. | |
repeat | 0..* | string | |
status | 1..1 | code | draft | active | retired | unknown |
title | 0..1 | string | Name for this view definition (human friendly) |
url | 0..1 | uri | Canonical identifier for this view definition, represented as a URI (globally unique) |
useContext | 0..* | UsageContext | The context that the content is intended to support |
where | 0..* | BackboneElement | A series of zero or more FHIRPath constraints to filter resources for the view. |
path | 1..1 | string | A FHIRPath expression defining a filter condition |
description | 0..1 | string | A human-readable description of the above where constraint. |
WebPushSubscription
| Name | Card. | Type | Description |
|---|---|---|---|
WebPushSubscription | |||
app | 0..1 | string | Application identifier for the subscription. |
subscription | 0..1 | BackboneElement | Web Push API subscription details. |
endpoint | 0..1 | string | URL to which the push notification service should send notifications. |
expirationTime | 0..1 | decimal | Time in seconds when the subscription will expire. |
keys | 0..1 | BackboneElement | Cryptographic keys needed for the push subscription. |
auth | 0..1 | string | Authentication key for the subscription. |
p256dh | 0..1 | string | Public key for the subscription (P-256 Diffie-Hellman). |
user | 0..1 | BackboneElement | Reference to the user who owns this subscription. |
id | 0..1 | string | User identifier. |
resourceType | 0..1 | string | Fixed value indicating this is a reference to a User resource. |
aidboxtopicdestination-amqp-1-0-at-least-once
AMQP 1.0 at-least-once delivery profile for AidboxTopicDestination.
| Name | Card. | Type | Description |
|---|---|---|---|
aidboxtopicdestination-amqp-1-0-at-least-once | |||
kind | 0..1 | ||
parameter | 0..1 | ||
parameter:address | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:containerName | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:host | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:idleTimeout | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | integer | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:password | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:port | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | integer | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:ssl | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | boolean | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:username | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 |
aidboxtopicdestination-amqp-rabbitmq-0-9-1
RabbitMQ AMQP 0-9-1 best-effort delivery profile for AidboxTopicDestination.
| Name | Card. | Type | Description |
|---|---|---|---|
aidboxtopicdestination-amqp-rabbitmq-0-9-1 | |||
kind | 0..1 | ||
parameter | 0..1 | ||
parameter:automaticallyRecover | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | boolean | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:connectionName | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:exchange | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:host | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:password | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:port | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | integer | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:routingKey | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:ssl | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | boolean | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:username | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:vhost | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 |
aidboxtopicdestination-amqp-rabbitmq-0-9-1-at-least-once
RabbitMQ AMQP 0-9-1 at-least-once delivery profile for AidboxTopicDestination.
| Name | Card. | Type | Description |
|---|---|---|---|
aidboxtopicdestination-amqp-rabbitmq-0-9-1-at-least-once | |||
kind | 0..1 | ||
parameter | 0..1 | ||
parameter:connectionTimeout | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | integer | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:exchange | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:exchangeType | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:host | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:password | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:port | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | integer | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:routingKey | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:ssl | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | boolean | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:username | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:vhost | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 |
aidboxtopicdestination-aws-eventbridge-at-least-once
AWS EventBridge at-least-once delivery profile for AidboxTopicDestination.
| Name | Card. | Type | Description |
|---|---|---|---|
aidboxtopicdestination-aws-eventbridge-at-least-once | |||
kind | 0..1 | ||
parameter | 0..1 | ||
parameter:accessKeyId | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:batchSize | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | integer | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:detailType | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:endpointOverride | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:eventBusName | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:region | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:secretAccessKey | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:source | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 |
aidboxtopicdestination-aws-eventbridge-best-effort
AWS EventBridge best-effort delivery profile for AidboxTopicDestination.
| Name | Card. | Type | Description |
|---|---|---|---|
aidboxtopicdestination-aws-eventbridge-best-effort | |||
kind | 0..1 | ||
parameter | 0..1 | ||
parameter:accessKeyId | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:detailType | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:endpointOverride | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:eventBusName | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:region | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:secretAccessKey | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:source | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 |
aidboxtopicdestination-aws-sns-at-least-once
AWS SNS at-least-once delivery profile for AidboxTopicDestination.
| Name | Card. | Type | Description |
|---|---|---|---|
aidboxtopicdestination-aws-sns-at-least-once | |||
kind | 0..1 | ||
parameter | 0..1 | ||
parameter:accessKeyId | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:batchSize | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | integer | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:endpointOverride | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:messageGroupId | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:region | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:secretAccessKey | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:topicArn | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 |
aidboxtopicdestination-aws-sns-best-effort
AWS SNS best-effort delivery profile for AidboxTopicDestination.
| Name | Card. | Type | Description |
|---|---|---|---|
aidboxtopicdestination-aws-sns-best-effort | |||
kind | 0..1 | ||
parameter | 0..1 | ||
parameter:accessKeyId | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:endpointOverride | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:messageGroupId | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:region | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:secretAccessKey | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:topicArn | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 |
aidboxtopicdestination-bigquery-at-least-once
BigQuery at-least-once delivery profile for AidboxTopicDestination.
| Name | Card. | Type | Description |
|---|---|---|---|
aidboxtopicdestination-bigquery-at-least-once | |||
kind | 0..1 | ||
parameter | 0..1 | ||
parameter:batchSize | 1..1 | Number of messages per batch | |
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:dataset | 1..1 | BigQuery dataset name | |
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:destinationTable | 1..1 | Target table name in BigQuery | |
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:emulatorGrpcHost | 0..1 | BigQuery emulator gRPC host:port (e.g. bigquery:9060). Uses plaintext gRPC. | |
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:emulatorUrl | 0..1 | BigQuery emulator REST URL (e.g. http://bigquery:9050). Skips authentication. | |
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:projectId | 1..1 | Google Cloud project ID | |
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:sendIntervalMs | 1..1 | Maximum time between sends in milliseconds | |
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:serviceAccountKey | 0..1 | Google Service Account JSON key (optional, omit for ADC/Workload Identity) | |
name | 0..1 | ||
value[x] | 0..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:skipInitialExport | 0..1 | Skip initial export of existing data (default: false) | |
name | 0..1 | ||
value[x] | 1..1 | boolean | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:viewDefinition | 1..1 | Name of the ViewDefinition resource for data transformation | |
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 |
aidboxtopicdestination-clickhouse
ClickHouse best-effort delivery profile for AidboxTopicDestination.
| Name | Card. | Type | Description |
|---|---|---|---|
aidboxtopicdestination-clickhouse | |||
kind | 0..1 | ||
parameter | 0..1 | ||
parameter:database | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:destinationTable | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:password | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:url | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:user | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:viewDefinition | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 |
aidboxtopicdestination-clickhouse-at-least-once
ClickHouse at-least-once delivery profile for AidboxTopicDestination.
| Name | Card. | Type | Description |
|---|---|---|---|
aidboxtopicdestination-clickhouse-at-least-once | |||
kind | 0..1 | ||
parameter | 0..1 | ||
parameter:batchSize | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:database | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:destinationTable | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:password | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:sendIntervalMs | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:url | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:user | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:viewDefinition | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 |
aidboxtopicdestination-fhir-native-topic-based-subscription
FHIR native topic-based subscription profile for AidboxTopicDestination.
| Name | Card. | Type | Description |
|---|---|---|---|
aidboxtopicdestination-fhir-native-topic-based-subscription | |||
kind | 0..1 | ||
parameter | 1..1 | ||
parameter:fhir-topic | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | canonical | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:keep-events-for-period | 0..1 | Time in seconds for which to store events. During this period, events will be available with the $events operation. If not specified, events will be stored indefinitely. | |
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:number-of-deliverer | 0..1 | Number of parallel senders which will handle subscriptions for the topic. Default is 4. | |
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:subscription-specification-version | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string |
Allowed values: R4-backported | R5 | R4B-backported |
resource | 0..1 | ||
part | 0..1 |
aidboxtopicdestination-gcp-pubsub-at-least-once
GCP Pub/Sub at-least-once delivery profile for AidboxTopicDestination.
| Name | Card. | Type | Description |
|---|---|---|---|
aidboxtopicdestination-gcp-pubsub-at-least-once | |||
kind | 0..1 | ||
parameter | 0..1 | ||
parameter:bytesThreshold | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:maxCount | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:projectId | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:timeout | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:topicId | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 |
aidboxtopicdestination-kafka-at-least-once
Kafka at-least-once delivery profile for AidboxTopicDestination.
| Name | Card. | Type | Description |
|---|---|---|---|
aidboxtopicdestination-kafka-at-least-once | |||
kind | 0..1 | ||
parameter | 0..1 | ||
parameter:batchSize | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:bootstrapServers | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:compressionType | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:deliveryTimeoutMs | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:kafkaTopic | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:maxBlockMs | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:maxRequestSize | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:requestTimeoutMs | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:saslClientCallbackHandlerClass | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:saslJaasConfig | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:saslMechanism | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:securityProtocol | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:sslKeystoreKey | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 |
aidboxtopicdestination-kafka-at-least-once-mock
Kafka at-least-once mock delivery profile for AidboxTopicDestination.
| Name | Card. | Type | Description |
|---|---|---|---|
aidboxtopicdestination-kafka-at-least-once-mock | |||
kind | 0..1 | ||
parameter | 0..1 | ||
parameter:autocomplete | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | boolean | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:batchSize | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:bootstrapServers | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:compressionType | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:deliveryTimeoutMs | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:fail-on-creation-of-producer | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | boolean | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:kafkaTopic | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:maxBlockMs | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:maxRequestSize | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:requestTimeoutMs | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:saslClientCallbackHandlerClass | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:saslJaasConfig | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:saslMechanism | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:securityProtocol | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:sslKeystoreKey | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 |
aidboxtopicdestination-kafka-best-effort
Kafka best-effort delivery profile for AidboxTopicDestination.
| Name | Card. | Type | Description |
|---|---|---|---|
aidboxtopicdestination-kafka-best-effort | |||
kind | 0..1 | ||
parameter | 0..1 | ||
parameter:batchSize | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:bootstrapServers | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:compressionType | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:deliveryTimeoutMs | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:kafkaTopic | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:maxBlockMs | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:maxRequestSize | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:requestTimeoutMs | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:saslClientCallbackHandlerClass | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:saslJaasConfig | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:saslMechanism | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:securityProtocol | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:sslKeystoreKey | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 |
aidboxtopicdestination-kafka-best-effort-mock
Kafka best-effort mock delivery profile for AidboxTopicDestination.
| Name | Card. | Type | Description |
|---|---|---|---|
aidboxtopicdestination-kafka-best-effort-mock | |||
kind | 0..1 | ||
parameter | 0..1 | ||
parameter:autocomplete | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | boolean | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:batchSize | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:bootstrapServers | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:compressionType | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:deliveryTimeoutMs | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:fail-on-creation-of-producer | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | boolean | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:kafkaTopic | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:maxBlockMs | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:maxRequestSize | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:requestTimeoutMs | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:saslClientCallbackHandlerClass | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:saslJaasConfig | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:saslMechanism | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:securityProtocol | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:sslKeystoreKey | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 |
aidboxtopicdestination-nats-core-best-effort
NATS Core best-effort delivery profile for AidboxTopicDestination.
| Name | Card. | Type | Description |
|---|---|---|---|
aidboxtopicdestination-nats-core-best-effort | |||
kind | 0..1 | ||
parameter | 0..1 | ||
parameter:connectionName | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:credentialsFilePath | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:password | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:sslContext | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:subject | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:url | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:username | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 |
aidboxtopicdestination-nats-jetstream-at-least-once
NATS JetStream at-least-once delivery profile for AidboxTopicDestination.
| Name | Card. | Type | Description |
|---|---|---|---|
aidboxtopicdestination-nats-jetstream-at-least-once | |||
kind | 0..1 | ||
parameter | 0..1 | ||
parameter:connectionName | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:credentialsFilePath | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:password | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:sslContext | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:subject | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:url | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:username | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 |
aidboxtopicdestination-webhook-at-least-once
Webhook at-least-once delivery profile for AidboxTopicDestination.
| Name | Card. | Type | Description |
|---|---|---|---|
aidboxtopicdestination-webhook-at-least-once | |||
kind | 0..1 | ||
parameter | 0..1 | ||
parameter:endpoint | 1..1 | ||
name | 0..1 | ||
value[x] | 1..1 | url | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:header | 0..* | ||
name | 0..1 | ||
value[x] | 1..1 | string | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:keepAlive | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | integer | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:maxMessagesInBatch | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 | ||
parameter:timeout | 0..1 | ||
name | 0..1 | ||
value[x] | 1..1 | unsignedInt | |
resource | 0..1 | ||
part | 0..1 |
deIdentification
Extension for ViewDefinition columns that specifies a de-identification method and its parameters. Applied during SQL generation to wrap column expressions with the corresponding aidbox_deident_* PostgreSQL function.
| Name | Card. | Type | Description |
|---|---|---|---|
deIdentification | |||
extension | 1..1 | ||
extension:cryptoHashKey | 0..1 | HMAC-SHA256 key for cryptoHash method. | |
url | 0..1 | ||
value[x] | 1..1 | string | |
extension:custom_arg | 0..1 | Optional second argument passed to the custom function. | |
url | 0..1 | ||
value[x] | 1..1 | string | |
extension:custom_function | 0..1 | Name of a custom PostgreSQL function to apply. First argument is the column value (text), optional second argument via custom_arg. | |
url | 0..1 | ||
value[x] | 1..1 | string | |
extension:dateShiftKey | 0..1 | HMAC key for deterministic date shifting. Offset is derived from HMAC(key, resource.id). | |
url | 0..1 | ||
value[x] | 1..1 | string | |
extension:encryptKey | 0..1 | AES-128-CBC encryption key as hex string (32 hex chars = 16 bytes). | |
url | 0..1 | ||
value[x] | 1..1 | string | |
extension:method | 0..1 | De-identification method to apply. Required unless custom_function is used. | |
url | 0..1 | ||
value[x] | 1..1 | code | |
extension:rangeType | 0..1 | Noise range type for perturb: fixed (absolute) or proportional (relative to value). | |
url | 0..1 | ||
value[x] | 1..1 | code | |
extension:replaceWith | 0..1 | Fixed replacement value for substitute method. | |
url | 0..1 | ||
value[x] | 1..1 | string | |
extension:roundTo | 0..1 | Decimal places to round to after perturbation. 0 means round to integer. | |
url | 0..1 | ||
value[x] | 1..1 | integer | |
extension:span | 0..1 | Noise magnitude for perturb method. | |
url | 0..1 | ||
value[x] | 1..1 | decimal | |
url | 0..1 | ||
value[x] | 0..1 |
entryActionCode
Describes the action to perform for a Bundle entry.
| Name | Card. | Type | Description |
|---|---|---|---|
entryActionCode | |||
url | 0..1 | ||
value[x] | 1..1 | code | create | update | delete |
entryVersionId
The versionId of the resource at the time the notification was triggered.
| Name | Card. | Type | Description |
|---|---|---|---|
entryVersionId | |||
url | 0..1 | ||
value[x] | 1..1 | id | Resource versionId |
fhir-package-install-parameters
Profile for FHIR package installation parameters.
| Name | Card. | Type | Description |
|---|---|---|---|
fhir-package-install-parameters | |||
parameter | 1..1 | ||
parameter:override | 0..* | ||
name | 0..1 | ||
part | 2..1 | ||
part:from | 1..1 | ||
name | 0..1 | ||
part:to | 1..1 | ||
name | 0..1 | ||
value[x] | 0..1 | string | |
parameter:package | 1..* | ||
name | 0..1 | ||
parameter:registry | 0..1 | ||
name | 0..1 |
fhir-package-uninstall-parameters
Profile for FHIR package uninstallation parameters.
| Name | Card. | Type | Description |
|---|---|---|---|
fhir-package-uninstall-parameters | |||
parameter | 1..1 | ||
parameter:package | 1..* | ||
name | 0..1 |
internalError
| Name | Card. | Type | Description |
|---|---|---|---|
internalError | |||
url | 0..1 | ||
value[x] | 0..1 | string |
legacy-fce-extension
| Name | Card. | Type | Description |
|---|---|---|---|
legacy-fce-extension | |||
url | 0..1 | ||
value[x] | 0..1 | string |
orgbac-mode
| Name | Card. | Type | Description |
|---|---|---|---|
orgbac-mode | |||
url | 0..1 | ||
value[x] | 0..1 | string |
orgbac-organization-reference
| Name | Card. | Type | Description |
|---|---|---|---|
orgbac-organization-reference | |||
url | 0..1 | ||
value[x] | 0..1 | Reference |
Allowed references: Organization |
password
| Name | Card. | Type | Description |
|---|---|---|---|
password | |||
value | 0..1 | http://hl7.org/fhirpath/System.String | Primitive value for password |
search-parameter-code-extension
| Name | Card. | Type | Description |
|---|---|---|---|
search-parameter-code-extension | |||
url | 0..1 | ||
value[x] | 0..1 | code |
secret
| Name | Card. | Type | Description |
|---|---|---|---|
secret | |||
value | 0..1 | http://hl7.org/fhirpath/System.String | Primitive value for secret |
sha256Hash
| Name | Card. | Type | Description |
|---|---|---|---|
sha256Hash | |||
value | 0..1 | http://hl7.org/fhirpath/System.String | Primitive value for sha256Hash |
ui_history
UI history tracking resource for Aidbox console.
| Name | Card. | Type | Description |
|---|---|---|---|
ui_history | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
command | 0..1 | string | Command that was executed. |
type | 0..1 | string | Type of history entry.
Allowed values: http | sql |
user | 0..1 | Reference | Reference to the user who performed the action.
Allowed references: User |
ui_snippet
UI snippet resource for saved queries and commands in Aidbox console.
| Name | Card. | Type | Description |
|---|---|---|---|
ui_snippet | |||
_source | 0..1 | string | System Property. DO NOT USE IT. |
collection | 0..1 | string | Collection the snippet belongs to. |
command | 0..1 | string | Command or query content. |
title | 0..1 | string | Title of the snippet. |
type | 0..1 | string | Type of snippet.
Allowed values: http | sql |
user | 0..1 | Reference | Reference to the user who created the snippet.
Allowed references: User |