Resources for configuration and management of Aidbox topic-based subscriptions.

AidboxSubscriptionStatus

The status of an AidboxTopicDestination during notifications.

NameCard.TypeDescription
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.

focus
0..1
Reference

Reference to the primary resource or information of this event.

Allowed references: Resource

timestamp
0..1
instant

The instant this event occurred.

eventNumber
1..1
decimal

Sequencing index of this event.

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.

NameCard.TypeDescription
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.

event
0..1
CodeableConcept

Event which can trigger a notification from the AidboxSubscriptionTopic.

resource
1..1
uri

Data Type or Resource (reference to definition) for this trigger definition.

canFilterBy
0..*
BackboneElement

Properties by which a AidboxTopicDestination can filter notifications from the AidboxSubscriptionTopic.

modifier
0..*
code

missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate.

resource
0..1
uri

URL of the triggering Resource that this filter applies to.

comparator
0..*
code

eq | ne | gt | lt | ge | le | sa | eb | ap.

description
0..1
markdown

Description of this filter parameter.

filterParameter
1..1
string

Human-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic.

filterDefinitionFhirPathExpression
1..1
string
filterDefinition
0..1
uri

Canonical URL for a filterParameter definition.

description
0..1
markdown

Text representation of the resource trigger.

queryCriteria
0..1
BackboneElement

Query based trigger rule.

current
0..1
string

Rule applied to current resource state.

previous
0..1
string

Rule applied to previous resource state.

requireBoth
0..1
boolean

Both must be true flag.

resultForCreate
0..1
code

test-passes | test-fails.

resultForDelete
0..1
code

test-passes | test-fails.

fhirPathCriteria
0..1
string

FHIRPath based trigger rule.

notificationShape
0..*
BackboneElement

Properties for describing the shape of notifications generated by this topic.

include
0..*
string

Include directives, rooted in the resource for this shape.

resource
1..1
uri

URL of the Resource that is the focus (main) resource in a notification shape.

revInclude
0..*
string

Reverse include directives, rooted in the resource for this shape.

relatedQuery
0..*
BackboneElement

Related queries for notification shaping.

query
1..1
string

Query string to execute.

queryType
0..1
Coding

Type of query language.

supportedInteraction
0..*
code

create | update | delete.

Allowed values: create | update | delete

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
0..1

How to compare versions.

versionAlgorithmCoding
0..1
Coding

How to compare versions.

versionAlgorithmString
0..1
string

How to compare versions.

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.

NameCard.TypeDescription
AidboxTopicDestination
content
0..1
string

empty | id-only | full-resource.

Allowed values: empty | id-only | full-resource

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.

Last updated: