Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Subscription | TU | DomainResource | Notification about a SubscriptionTopic Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |||||
identifier | Σ | 0..* | Identifier | Additional identifiers (business identifier) | ||||
name | Σ | 0..1 | string | Human readable name for this subscription | ||||
status | ?!Σ | 1..1 | code | requested | active | error | off | entered-in-error Binding: Subscription Status (Required) | ||||
topic | Σ | 1..1 | canonical(SubscriptionTopic) | Reference to the subscription topic being subscribed to | ||||
contact | Σ | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | ||||
end | Σ | 0..1 | instant | When to automatically delete the subscription | ||||
managingEntity | Σ | 0..1 | Reference(CareTeam | HealthcareService | Organization | RelatedPerson | Patient | Practitioner | PractitionerRole) | Entity responsible for Subscription changes | ||||
reason | Σ | 0..1 | string | Description of why this subscription was created | ||||
filterBy | ΣC | 0..* | BackboneElement | Criteria for narrowing the subscription topic stream + Rule: Subscription filters may only contain a modifier or a comparator | ||||
resource | Σ | 0..1 | uri | Allowed Resource (reference to definition) for this Subscription filter Binding: Types used with Subscriptions (Extensible)
| ||||
filterParameter | Σ | 1..1 | string | Filter label defined in SubscriptionTopic | ||||
comparator | C | 0..1 | code | eq | ne | gt | lt | ge | le | sa | eb | ap Binding: Search Comparator (Required) | ||||
modifier | C | 0..1 | code | missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate Binding: Search Modifier Code (Required) | ||||
value | Σ | 1..1 | string | Literal value or resource path | ||||
channelType | Σ | 1..1 | Coding | Channel type for notifications Binding: Subscription Channel Type (Extensible) | ||||
endpoint | Σ | 0..1 | url | Where the channel points to | ||||
parameter | 0..* | BackboneElement | Channel type | |||||
name | 1..1 | string | Name (key) of the parameter | |||||
value | 1..1 | string | Value of the parameter to use or pass through | |||||
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 payload Binding: Mime Types (Required) | ||||
content | Σ | 0..1 | code | empty | id-only | full-resource Binding: Subscription Payload Content (Required) | ||||
maxCount | Σ | 0..1 | positiveInt | Maximum number of events that can be combined in a single notification | ||||
Documentation for this format |