{
"description": "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.",
"_filename": "StructureDefinition-AidboxSubscriptionTopic.json",
"package_name": "io.health-samurai.core.r4",
"date": null,
"derivation": "specialization",
"publisher": null,
"fhirVersion": "4.0.1",
"name": "AidboxSubscriptionTopic",
"abstract": false,
"type": "AidboxSubscriptionTopic",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "0.2601.0",
"status": "active",
"id": "542d566d-7788-431e-9e9e-2e383851c248",
"kind": "resource",
"url": "http://health-samurai.io/fhir/core/StructureDefinition/AidboxSubscriptionTopic",
"version": "0.2601.0",
"differential": {
"element": [ {
"id": "AidboxSubscriptionTopic",
"max": "*",
"min": 0,
"path": "AidboxSubscriptionTopic"
}, {
"id": "AidboxSubscriptionTopic.url",
"max": "1",
"min": 1,
"path": "AidboxSubscriptionTopic.url",
"type": [ {
"code": "uri"
} ],
"short": "Canonical identifier for this subscription topic, represented as an absolute URI (globally unique).",
"isSummary": true
}, {
"constraint": [ {
"key": "enum-1667",
"human": "status shall be one of: draft, active, retired, unknown",
"severity": "error",
"expression": "%context.subsetOf('draft' | 'active' | 'retired' | 'unknown')"
} ],
"path": "AidboxSubscriptionTopic.status",
"min": 1,
"isModifier": true,
"short": "draft | active | retired | unknown.",
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "AidboxSubscriptionTopic.status",
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not use a retired SubscriptionTopic without due consideration",
"isSummary": true
}, {
"id": "AidboxSubscriptionTopic.identifier",
"max": "*",
"min": 0,
"path": "AidboxSubscriptionTopic.identifier",
"type": [ {
"code": "Identifier"
} ],
"short": "Business identifier for subscription topic.",
"isSummary": true
}, {
"id": "AidboxSubscriptionTopic.version",
"max": "1",
"min": 0,
"path": "AidboxSubscriptionTopic.version",
"type": [ {
"code": "string"
} ],
"short": "Business version of the subscription topic.",
"isSummary": true
}, {
"id": "AidboxSubscriptionTopic.versionAlgorithm[x]",
"max": "1",
"min": 0,
"path": "AidboxSubscriptionTopic.versionAlgorithm[x]",
"type": [ {
"code": "string"
}, {
"code": "Coding"
} ],
"short": "How to compare versions.",
"isSummary": true
}, {
"id": "AidboxSubscriptionTopic.name",
"max": "1",
"min": 0,
"path": "AidboxSubscriptionTopic.name",
"type": [ {
"code": "string"
} ],
"short": "Name for this subscription topic (computer friendly).",
"isSummary": true
}, {
"id": "AidboxSubscriptionTopic.title",
"max": "1",
"min": 0,
"path": "AidboxSubscriptionTopic.title",
"type": [ {
"code": "string"
} ],
"short": "Name for this subscription topic (human friendly).",
"isSummary": true
}, {
"id": "AidboxSubscriptionTopic.derivedFrom",
"max": "*",
"min": 0,
"path": "AidboxSubscriptionTopic.derivedFrom",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/SubscriptionTopic" ]
} ],
"short": "Based on FHIR protocol or definition.",
"isSummary": true
}, {
"id": "AidboxSubscriptionTopic.experimental",
"max": "1",
"min": 0,
"path": "AidboxSubscriptionTopic.experimental",
"type": [ {
"code": "boolean"
} ],
"short": "If for testing purposes, not real usage.",
"isSummary": true
}, {
"id": "AidboxSubscriptionTopic.date",
"max": "1",
"min": 0,
"path": "AidboxSubscriptionTopic.date",
"type": [ {
"code": "dateTime"
} ],
"short": "Date status first applied.",
"isSummary": true
}, {
"id": "AidboxSubscriptionTopic.publisher",
"max": "1",
"min": 0,
"path": "AidboxSubscriptionTopic.publisher",
"type": [ {
"code": "string"
} ],
"short": "The name of the individual or organization that published the AidboxSubscriptionTopic.",
"isSummary": true
}, {
"id": "AidboxSubscriptionTopic.contact",
"max": "*",
"min": 0,
"path": "AidboxSubscriptionTopic.contact",
"type": [ {
"code": "ContactDetail"
} ],
"short": "Contact details for the publisher.",
"isSummary": true
}, {
"id": "AidboxSubscriptionTopic.description",
"max": "1",
"min": 0,
"path": "AidboxSubscriptionTopic.description",
"type": [ {
"code": "markdown"
} ],
"short": "Natural language description of the AidboxSubscriptionTopic."
}, {
"id": "AidboxSubscriptionTopic.useContext",
"max": "*",
"min": 0,
"path": "AidboxSubscriptionTopic.useContext",
"type": [ {
"code": "UsageContext"
} ],
"short": "Content intends to support these contexts.",
"isSummary": true
}, {
"id": "AidboxSubscriptionTopic.jurisdiction",
"max": "*",
"min": 0,
"path": "AidboxSubscriptionTopic.jurisdiction",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "Intended jurisdiction of the AidboxSubscriptionTopic (if applicable).",
"isSummary": true
}, {
"id": "AidboxSubscriptionTopic.purpose",
"max": "1",
"min": 0,
"path": "AidboxSubscriptionTopic.purpose",
"type": [ {
"code": "markdown"
} ],
"short": "Why this AidboxSubscriptionTopic is defined."
}, {
"id": "AidboxSubscriptionTopic.copyright",
"max": "1",
"min": 0,
"path": "AidboxSubscriptionTopic.copyright",
"type": [ {
"code": "markdown"
} ],
"short": "Use and/or publishing restrictions."
}, {
"id": "AidboxSubscriptionTopic.copyrightLabel",
"max": "1",
"min": 0,
"path": "AidboxSubscriptionTopic.copyrightLabel",
"type": [ {
"code": "string"
} ],
"short": "Copyright holder and year(s)."
}, {
"id": "AidboxSubscriptionTopic.approvalDate",
"max": "1",
"min": 0,
"path": "AidboxSubscriptionTopic.approvalDate",
"type": [ {
"code": "date"
} ],
"short": "When AidboxSubscriptionTopic is/was approved by publisher."
}, {
"id": "AidboxSubscriptionTopic.lastReviewDate",
"max": "1",
"min": 0,
"path": "AidboxSubscriptionTopic.lastReviewDate",
"type": [ {
"code": "date"
} ],
"short": "Date the AidboxSubscriptionTopic was last reviewed by the publisher."
}, {
"id": "AidboxSubscriptionTopic.effectivePeriod",
"max": "1",
"min": 0,
"path": "AidboxSubscriptionTopic.effectivePeriod",
"type": [ {
"code": "Period"
} ],
"short": "The effective date range for the AidboxSubscriptionTopic.",
"isSummary": true
}, {
"id": "AidboxSubscriptionTopic.trigger",
"max": "*",
"min": 0,
"path": "AidboxSubscriptionTopic.trigger",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Definition of a resource-based trigger for the subscription topic.",
"isSummary": true
}, {
"id": "AidboxSubscriptionTopic.trigger.resource",
"max": "1",
"min": 1,
"path": "AidboxSubscriptionTopic.trigger.resource",
"type": [ {
"code": "uri"
} ],
"short": "Data Type or Resource (reference to definition) for this trigger definition.",
"isSummary": true
}, {
"id": "AidboxSubscriptionTopic.trigger.description",
"max": "1",
"min": 0,
"path": "AidboxSubscriptionTopic.trigger.description",
"type": [ {
"code": "markdown"
} ],
"short": "Text representation of the resource trigger.",
"isSummary": true
}, {
"id": "AidboxSubscriptionTopic.trigger.supportedInteraction",
"max": "*",
"min": 0,
"path": "AidboxSubscriptionTopic.trigger.supportedInteraction",
"type": [ {
"code": "code"
} ],
"short": "create | update | delete.",
"isSummary": true,
"constraint": [ {
"key": "enum-1668",
"human": "supportedInteraction shall be one of: create, update, delete",
"severity": "error",
"expression": "%context.subsetOf('create' | 'update' | 'delete')"
} ]
}, {
"id": "AidboxSubscriptionTopic.trigger.fhirPathCriteria",
"max": "1",
"min": 0,
"path": "AidboxSubscriptionTopic.trigger.fhirPathCriteria",
"type": [ {
"code": "string"
} ],
"short": "FHIRPath based trigger rule.",
"isSummary": true
}, {
"id": "AidboxSubscriptionTopic.trigger.canFilterBy",
"max": "*",
"min": 0,
"path": "AidboxSubscriptionTopic.trigger.canFilterBy",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Properties by which a AidboxTopicDestination can filter notifications from the AidboxSubscriptionTopic.",
"isSummary": true
}, {
"id": "AidboxSubscriptionTopic.trigger.canFilterBy.filterParameter",
"max": "1",
"min": 1,
"path": "AidboxSubscriptionTopic.trigger.canFilterBy.filterParameter",
"type": [ {
"code": "string"
} ],
"short": "Human-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic.",
"isSummary": true
}, {
"id": "AidboxSubscriptionTopic.trigger.canFilterBy.comparator",
"max": "*",
"min": 1,
"path": "AidboxSubscriptionTopic.trigger.canFilterBy.comparator",
"type": [ {
"code": "code"
} ],
"short": "eq | ne | gt | lt | ge | le | sa | eb | ap."
}, {
"id": "AidboxSubscriptionTopic.trigger.canFilterBy.filterDefinitionFhirPathExpression",
"max": "1",
"min": 1,
"path": "AidboxSubscriptionTopic.trigger.canFilterBy.filterDefinitionFhirPathExpression",
"type": [ {
"code": "string"
} ],
"isSummary": true
}, {
"id": "AidboxSubscriptionTopic.trigger.canFilterBy.description",
"max": "1",
"min": 0,
"path": "AidboxSubscriptionTopic.trigger.canFilterBy.description",
"type": [ {
"code": "markdown"
} ],
"short": "Description of this filter parameter.",
"isSummary": true
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}