{
"description": "Topic-based subscription resource for event notifications.",
"_filename": "StructureDefinition-subs-subscription.json",
"package_name": "io.health-samurai.core.r4",
"date": null,
"derivation": "specialization",
"publisher": null,
"fhirVersion": "4.0.1",
"name": "SubsSubscription",
"abstract": false,
"type": "SubsSubscription",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "0.2601.0",
"status": "active",
"id": "7fb3618a-e4ca-4d28-b0d9-81fbebc175fb",
"kind": "resource",
"url": "http://health-samurai.io/fhir/core/StructureDefinition/SubsSubscription",
"version": "0.2601.0",
"differential": {
"element": [ {
"id": "SubsSubscription",
"max": "*",
"min": 0,
"path": "SubsSubscription"
}, {
"id": "SubsSubscription._source",
"max": "1",
"min": 0,
"path": "SubsSubscription._source",
"type": [ {
"code": "string"
} ],
"short": "System Property. DO NOT USE IT."
}, {
"id": "SubsSubscription.status",
"max": "1",
"min": 0,
"path": "SubsSubscription.status",
"type": [ {
"code": "code"
} ],
"short": "Current status of the subscription.",
"constraint": [ {
"key": "enum-50",
"human": "Status must be one of: active, off",
"severity": "error",
"expression": "%context.subsetOf('active' | 'off')"
} ]
}, {
"id": "SubsSubscription.identifier",
"max": "*",
"min": 0,
"path": "SubsSubscription.identifier",
"type": [ {
"code": "Identifier"
} ],
"short": "Business identifiers for the subscription."
}, {
"id": "SubsSubscription.trigger",
"max": "1",
"min": 0,
"path": "SubsSubscription.trigger",
"short": "Events that trigger this subscription.",
"extension": [ {
"url": "http://health-samurai.io/fhir/core/StructureDefinition/additional-properties-custom-type",
"valueCode": "any"
} ]
}, {
"id": "SubsSubscription.channel",
"max": "1",
"min": 1,
"path": "SubsSubscription.channel",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Channel configuration for delivering notifications."
}, {
"id": "SubsSubscription.channel.type",
"max": "1",
"min": 1,
"path": "SubsSubscription.channel.type",
"type": [ {
"code": "code"
} ],
"short": "Type of channel for notifications.",
"constraint": [ {
"key": "enum-49",
"human": "Channel type must be: rest-hook",
"severity": "error",
"expression": "%context.subsetOf('rest-hook')"
} ]
}, {
"id": "SubsSubscription.channel.endpoint",
"max": "1",
"min": 1,
"path": "SubsSubscription.channel.endpoint",
"type": [ {
"code": "url"
} ],
"short": "URL endpoint where notifications are sent."
}, {
"id": "SubsSubscription.channel.timeout",
"max": "1",
"min": 0,
"path": "SubsSubscription.channel.timeout",
"type": [ {
"code": "integer"
} ],
"short": "Timeout in milliseconds for notification delivery."
}, {
"id": "SubsSubscription.channel.heartbeatPeriod",
"max": "1",
"min": 0,
"path": "SubsSubscription.channel.heartbeatPeriod",
"type": [ {
"code": "integer"
} ],
"short": "Period in milliseconds for sending heartbeat notifications."
}, {
"id": "SubsSubscription.channel.headers",
"max": "1",
"min": 0,
"path": "SubsSubscription.channel.headers",
"short": "HTTP headers to include with notifications.",
"extension": [ {
"url": "http://health-samurai.io/fhir/core/StructureDefinition/additional-properties-custom-type",
"valueCode": "any"
} ]
}, {
"id": "SubsSubscription.channel.payload",
"max": "1",
"min": 0,
"path": "SubsSubscription.channel.payload",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Content to be sent in the notification."
}, {
"id": "SubsSubscription.channel.payload.content",
"max": "1",
"min": 0,
"path": "SubsSubscription.channel.payload.content",
"type": [ {
"code": "code"
} ],
"short": "Content type for payload.",
"constraint": [ {
"key": "payload-content",
"human": "Payload content must be one of: id-only, full-resource",
"severity": "error",
"expression": "%context.subsetOf('id-only' | 'full-resource')"
} ]
}, {
"id": "SubsSubscription.channel.payload.contentType",
"max": "1",
"min": 0,
"path": "SubsSubscription.channel.payload.contentType",
"type": [ {
"code": "code"
} ],
"short": "MIME type of the payload.",
"constraint": [ {
"key": "payload-contenttype",
"human": "Payload content type must be one of: json, fhir+json",
"severity": "error",
"expression": "%context.subsetOf('json' | 'fhir+json')"
} ]
}, {
"id": "SubsSubscription.channel.payload.context",
"path": "SubsSubscription.channel.payload.context",
"short": "Additional context for the payload.",
"extension": [ {
"url": "http://health-samurai.io/fhir/core/StructureDefinition/custom-type",
"valueCode": "any"
} ]
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}