{
"description": "The status of an AidboxTopicDestination during notifications.",
"_filename": "StructureDefinition-AidboxSubscriptionStatus.json",
"package_name": "io.health-samurai.core.r4",
"date": null,
"derivation": "specialization",
"publisher": null,
"fhirVersion": "4.0.1",
"name": "AidboxSubscriptionStatus",
"abstract": false,
"type": "AidboxSubscriptionStatus",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "0.2601.0",
"status": "active",
"id": "96215f0f-d089-4825-95c0-379845cc7424",
"kind": "resource",
"url": "http://health-samurai.io/fhir/core/StructureDefinition/AidboxSubscriptionStatus",
"version": "0.2601.0",
"differential": {
"element": [ {
"id": "AidboxSubscriptionStatus",
"max": "*",
"min": 0,
"path": "AidboxSubscriptionStatus",
"constraint": [ {
"key": "sst-1",
"human": "Event notifications must contain events",
"severity": "error",
"expression": "(type = 'event-notification' or type = 'query-event') implies notificationEvent.exists()"
}, {
"key": "sst-2",
"human": "Status messages must contain status",
"severity": "error",
"expression": "type = 'query-status' implies status.exists()"
} ]
}, {
"constraint": [ {
"key": "enum-1670",
"human": "type shall be one of: handshake, heartbeat, event-notification, query-status, query-event",
"severity": "error",
"expression": "%context.subsetOf('handshake' | 'heartbeat' | 'event-notification' | 'query-status' | 'query-event')"
} ],
"path": "AidboxSubscriptionStatus.type",
"min": 1,
"isModifier": true,
"short": "handshake | heartbeat | event-notification | query-status | query-event.",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "AidboxSubscriptionStatus.type",
"isModifierReason": "Not known why this is labelled a modifier",
"isSummary": true
}, {
"id": "AidboxSubscriptionStatus.topic-destination",
"max": "1",
"min": 1,
"path": "AidboxSubscriptionStatus.topic-destination",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://health-samurai.io/fhir/core/StructureDefinition/AidboxTopicDestination" ]
} ],
"short": "Reference to the AidboxTopicDestination responsible for this notification.",
"isSummary": true
}, {
"id": "AidboxSubscriptionStatus.status",
"max": "1",
"min": 0,
"path": "AidboxSubscriptionStatus.status",
"type": [ {
"code": "code"
} ],
"short": "requested | active | error | off | entered-in-error.",
"isSummary": true,
"constraint": [ {
"key": "enum-1671",
"human": "status shall be one of: requested, active, error, off, entered-in-error",
"severity": "error",
"expression": "%context.subsetOf('requested' | 'active' | 'error' | 'off' | 'entered-in-error')"
} ]
}, {
"id": "AidboxSubscriptionStatus.topic",
"max": "1",
"min": 0,
"path": "AidboxSubscriptionStatus.topic",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/SubscriptionTopic" ]
} ],
"short": "Reference to the AidboxSubscriptionTopic this notification relates to.",
"isSummary": true
}, {
"id": "AidboxSubscriptionStatus.error",
"max": "*",
"min": 0,
"path": "AidboxSubscriptionStatus.error",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "List of errors on the subscription.",
"isSummary": true
}, {
"id": "AidboxSubscriptionStatus.eventsSinceSubscriptionStart",
"max": "1",
"min": 0,
"path": "AidboxSubscriptionStatus.eventsSinceSubscriptionStart",
"type": [ {
"code": "decimal"
} ],
"short": "Events since the AidboxTopicDestination was created.",
"isSummary": true
}, {
"id": "AidboxSubscriptionStatus.notificationEvent",
"max": "*",
"min": 0,
"path": "AidboxSubscriptionStatus.notificationEvent",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Detailed information about any events relevant to this notification."
}, {
"id": "AidboxSubscriptionStatus.notificationEvent.eventNumber",
"max": "1",
"min": 1,
"path": "AidboxSubscriptionStatus.notificationEvent.eventNumber",
"type": [ {
"code": "decimal"
} ],
"short": "Sequencing index of this event."
}, {
"id": "AidboxSubscriptionStatus.notificationEvent.timestamp",
"max": "1",
"min": 0,
"path": "AidboxSubscriptionStatus.notificationEvent.timestamp",
"type": [ {
"code": "instant"
} ],
"short": "The instant this event occurred."
}, {
"id": "AidboxSubscriptionStatus.notificationEvent.focus",
"max": "1",
"min": 0,
"path": "AidboxSubscriptionStatus.notificationEvent.focus",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"short": "Reference to the primary resource or information of this event."
}, {
"id": "AidboxSubscriptionStatus.notificationEvent.additionalContext",
"max": "*",
"min": 0,
"path": "AidboxSubscriptionStatus.notificationEvent.additionalContext",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"short": "References related to the focus resource and/or context of this event."
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}