Subscription
Subscription
draftResource39 elementsv5.0.0
The subscription resource describes a particular client's request to be notified about a SubscriptionTopic.
Metadata
hl7.org/fhir- Canonical URL
- http://hl7.org/fhir/StructureDefinition/Subscription
- ID
- Subscription
- Type
- Base Definition
- Derivation
- specialization
- Publisher
- Health Level Seven International (FHIR Infrastructure)
- Version
- 5.0.0
| Path | Card. | Type | Description |
|---|---|---|---|
Subscription | 0..* | Notification about a SubscriptionTopic | |
id | 0..1 | string | Logical id of this artifact |
meta | 0..1 | Metadata about the resource | |
implicitRules | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource contentrequired: all-languages |
text | 0..1 | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources |
extension | 0..* | Additional content defined by implementations | |
modifierExtension | 0..* | Extensions that cannot be ignored | |
identifier | 0..* | Additional identifiers (business identifier) | |
name | 0..1 | string | Human readable name for this subscription |
status | 1..1 | code | requested | active | error | off | entered-in-errorrequired: subscription-status |
topic | 1..1 | canonical | Reference to the subscription topic being subscribed to |
contact | 0..* | Contact details for source (e.g. troubleshooting) | |
end | 0..1 | instant | When to automatically delete the subscription |
managingEntity | 0..1 | Entity responsible for Subscription changes | |
reason | 0..1 | string | Description of why this subscription was created |
filterBy | 0..* | BackboneElement | Criteria for narrowing the subscription topic stream |
channelType | 1..1 | Channel type for notificationsextensible: subscription-channel-type | |
endpoint | 0..1 | url | Where the channel points to |
parameter | 0..* | BackboneElement | Channel type |
heartbeatPeriod | 0..1 | unsignedInt | Interval in seconds to send 'heartbeat' notification |
timeout | 0..1 | unsignedInt | Timeout in seconds to attempt notification delivery |
contentType | 0..1 | code | MIME type to send, or omit for no payloadrequired: mimetypes |
content | 0..1 | code | empty | id-only | full-resourcerequired: subscription-payload-content |
maxCount | 0..1 | positiveInt | Maximum number of events that can be combined in a single notification |