Subscriptions R5 Backport
1.2.0-ballot - ballot

Subscriptions R5 Backport, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-subscription-backport-ig/ and changes regularly. See the Directory of published versions

## Resource Profile: R4 Backported R5 SubscriptionStatus

Official URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-status-r4 | Version: 1.2.0-ballot
Standards status: Trial-use | Computable Name: BackportSubscriptionStatusR4

Profile on Parameters for topic-based subscription notifications in R4.

Usage:

- Use this Resource Profile: R4 Topic-Based Subscription Notification Bundle
- Examples for this Resource Profile: Parameters/r4-notification-status

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from Parameters

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Parameters |  | 0..* | Parameters | Parameter containing subscription status information
Slices for parameter |  | 3..* | BackboneElement | Slices containing subscription status information Slice: Unordered, Open by value:name
parameter:subscription | S | 1..1 | BackboneElement | Parameter containing the reference to a subscription
name |  | 1..1 | string | Slice discriminator: the reference to a subscription Fixed Value: subscription
value[x] | S | 1..1 | Reference(Subscription) | Reference to the Subscription responsible for this notification
parameter:topic | S | 0..1 | BackboneElement | Parameter containing the canonical reference to a subscription topic
name |  | 1..1 | string | Slice discriminator: the canonical reference to a subscription topic Fixed Value: topic
value[x] | S | 0..1 | canonical() | Canonical reference to the SubscriptionTopic this notification relates to
parameter:status | S | 1..1 | BackboneElement | Parameter containing the subscription status
name |  | 1..1 | string | Slice discriminator: the subscription status Fixed Value: status
value[x] | S | 1..1 | code | Status of the subscription when this notification was generated Binding: SubscriptionStatusCodes (required)
parameter:type | S | 1..1 | BackboneElement | Parameter containing the type of event for this notification
name |  | 1..1 | string | Slice discriminator: the type of event for this notification Fixed Value: type
value[x] | S | 1..1 | code | The type of event being conveyed with this notificaiton. Binding: SubscriptionNotificationType (required)
parameter:eventsSinceSubscriptionStart | S | 0..1 | BackboneElement | Parameter containing the number of events since this subscription started
name |  | 1..1 | string | Slice discriminator: the number of events since this subscription started Fixed Value: events-since-subscription-start
value[x] | S | 0..1 | string | Events since the Subscription was created
parameter:notificationEvent | S | 0..* | BackboneElement | Parameter containing the event notification details
name |  | 1..1 | string | Parameter containing notification event details Fixed Value: notification-event
Slices for part | S | 1..* |  | Named part of a multi-part parameter Slice: Unordered, Open by value:name
part:eventNumber | S | 1..1 | BackboneElement | Parameter containing the event number
name |  | 1..1 | string | Slice discriminator: the event number Fixed Value: event-number
value[x] | S | 1..1 | string | Event number
part:eventTimestamp | S | 0..1 | BackboneElement | Parameter containing the event timestamp
name |  | 1..1 | string | Slice discriminator: the event timestamp Fixed Value: timestamp
value[x] | S | 0..1 | instant | The instant this event occurred
part:eventFocus | S | 0..1 | BackboneElement | Parameter containing the event focus
name |  | 1..1 | string | Slice discriminator: the event focus Fixed Value: focus
value[x] | S | 0..1 | Reference() | The focus of this event
part:eventAdditionalContext | S | 0..* | BackboneElement | Parameter containing additional context for this event
name |  | 1..1 | string | Slice discriminator: additional context for this event Fixed Value: additional-context
value[x] | S | 0..1 | Reference() | Additional context for this event
part:eventRelatedQuery | S | 0..* | BackboneElement | Parameter containing related query information for this event
name |  | 1..1 | string | Slice discriminator: related query information for this event Fixed Value: related-query
Slices for part |  | 1..* |  | Named part of a multi-part parameter Slice: Unordered, Open by value:name
part:queryType | S | 0..1 | BackboneElement | Parameter containing the query type
name |  | 1..1 | string | Slice discriminator: the query type Fixed Value: query-type
value[x] | S | 0..1 | Coding | Query Type
part:query | S | 1..1 | BackboneElement | Parameter containing the query
name |  | 1..1 | string | Slice discriminator: the query Fixed Value: query
value[x] | S | 1..1 | string | If parameter is a data type
part:authType | S | 0..1 | BackboneElement | Parameter containing the authorization hint type.
name |  | 1..1 | string | Slice discriminator: the authorization hint type Fixed Value: authorization-type
value[x] | S | 0..1 | Coding | Authorization Hint Type
part:authValue | S | 0..1 | BackboneElement | Parameter containing the authorization hint value.
name |  | 1..1 | string | Slice discriminator: the authorization hint value Fixed Value: authorization-value
value[x] | S | 0..1 | string | Authorization Hint Value
parameter:error | S | 0..* | BackboneElement | Parameter containing errors on the subscription
name |  | 1..1 | string | Slice discriminator: errors on the subscription Fixed Value: error
value[x] | S | 0..1 | CodeableConcept | An error on the subscription
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Parameters.parameter:status.value[x] | required | SubscriptionStatusCodes `http://hl7.org/fhir/ValueSet/subscription-status` from the FHIR Standard
Parameters.parameter:type.value[x] | required | SubscriptionNotificationType `http://hl7.org/fhir/ValueSet/subscription-notification-type` from the FHIR Standard

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Parameters |  | 0..* | Parameters | Parameter containing subscription status information
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for parameter | Σ C | 3..* | BackboneElement | Slices containing subscription status information Slice: Unordered, Open by value:name inv-1: A parameter must have one and only one of (value, resource, part)
parameter:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Name from the definition
parameter:subscription | S Σ C | 1..1 | BackboneElement | Parameter containing the reference to a subscription inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the reference to a subscription Fixed Value: subscription
value[x] | S Σ C | 1..1 | Reference(Subscription) | Reference to the Subscription responsible for this notification
parameter:topic | S Σ C | 0..1 | BackboneElement | Parameter containing the canonical reference to a subscription topic inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the canonical reference to a subscription topic Fixed Value: topic
value[x] | S Σ C | 0..1 | canonical() | Canonical reference to the SubscriptionTopic this notification relates to
parameter:status | S Σ C | 1..1 | BackboneElement | Parameter containing the subscription status inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the subscription status Fixed Value: status
value[x] | S Σ C | 1..1 | code | Status of the subscription when this notification was generated Binding: SubscriptionStatusCodes (required)
parameter:type | S Σ C | 1..1 | BackboneElement | Parameter containing the type of event for this notification inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the type of event for this notification Fixed Value: type
value[x] | S Σ C | 1..1 | code | The type of event being conveyed with this notificaiton. Binding: SubscriptionNotificationType (required)
parameter:eventsSinceSubscriptionStart | S Σ C | 0..1 | BackboneElement | Parameter containing the number of events since this subscription started inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the number of events since this subscription started Fixed Value: events-since-subscription-start
value[x] | S Σ C | 0..1 | string | Events since the Subscription was created
parameter:notificationEvent | S Σ C | 0..* | BackboneElement | Parameter containing the event notification details inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Parameter containing notification event details Fixed Value: notification-event
Slices for part | S Σ | 1..* | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name
part:eventNumber | S Σ | 1..1 | BackboneElement | Parameter containing the event number
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the event number Fixed Value: event-number
value[x] | S Σ C | 1..1 | string | Event number
part:eventTimestamp | S Σ | 0..1 | BackboneElement | Parameter containing the event timestamp
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the event timestamp Fixed Value: timestamp
value[x] | S Σ C | 0..1 | instant | The instant this event occurred
part:eventFocus | S Σ | 0..1 | BackboneElement | Parameter containing the event focus
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the event focus Fixed Value: focus
value[x] | S Σ C | 0..1 | Reference() | The focus of this event
part:eventAdditionalContext | S Σ | 0..* | BackboneElement | Parameter containing additional context for this event
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: additional context for this event Fixed Value: additional-context
value[x] | S Σ C | 0..1 | Reference() | Additional context for this event
part:eventRelatedQuery | S Σ | 0..* | BackboneElement | Parameter containing related query information for this event
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: related query information for this event Fixed Value: related-query
Slices for part | Σ | 1..* | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name
part:queryType | S Σ | 0..1 | BackboneElement | Parameter containing the query type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the query type Fixed Value: query-type
value[x] | S Σ C | 0..1 | Coding | Query Type
part:query | S Σ | 1..1 | BackboneElement | Parameter containing the query
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the query Fixed Value: query
value[x] | S Σ C | 1..1 | string | If parameter is a data type
part:authType | S Σ | 0..1 | BackboneElement | Parameter containing the authorization hint type.
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the authorization hint type Fixed Value: authorization-type
value[x] | S Σ C | 0..1 | Coding | Authorization Hint Type
part:authValue | S Σ | 0..1 | BackboneElement | Parameter containing the authorization hint value.
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the authorization hint value Fixed Value: authorization-value
value[x] | S Σ C | 0..1 | string | Authorization Hint Value
parameter:error | S Σ C | 0..* | BackboneElement | Parameter containing errors on the subscription inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: errors on the subscription Fixed Value: error
value[x] | S Σ C | 0..1 | CodeableConcept | An error on the subscription
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Parameters.parameter:status.value[x] | required | SubscriptionStatusCodes `http://hl7.org/fhir/ValueSet/subscription-status` from the FHIR Standard
Parameters.parameter:type.value[x] | required | SubscriptionNotificationType `http://hl7.org/fhir/ValueSet/subscription-notification-type` from the FHIR Standard

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Parameters |  | 0..* | Parameters | Parameter containing subscription status information
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | 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 content Binding: CommonLanguages (preferred): IETF language tag
Additional Bindings | Purpose
AllLanguages | Max Binding
Slices for parameter | Σ C | 3..* | BackboneElement | Slices containing subscription status information Slice: Unordered, Open by value:name inv-1: A parameter must have one and only one of (value, resource, part)
parameter:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Name from the definition
value[x] | Σ C | 0..1 |  | If parameter is a data type
valueBase64Binary |  |  | base64Binary |
valueBoolean |  |  | boolean |
valueCanonical |  |  | canonical(Any) |
valueCode |  |  | code |
valueDate |  |  | date |
valueDateTime |  |  | dateTime |
valueDecimal |  |  | decimal |
valueId |  |  | id |
valueInstant |  |  | instant |
valueInteger |  |  | integer |
valueMarkdown |  |  | markdown |
valueOid |  |  | oid |
valuePositiveInt |  |  | positiveInt |
valueString |  |  | string |
valueTime |  |  | time |
valueUnsignedInt |  |  | unsignedInt |
valueUri |  |  | uri |
valueUrl |  |  | url |
valueUuid |  |  | uuid |
valueAddress |  |  | Address |
valueAge |  |  | Age |
valueAnnotation |  |  | Annotation |
valueAttachment |  |  | Attachment |
valueCodeableConcept |  |  | CodeableConcept |
valueCoding |  |  | Coding |
valueContactPoint |  |  | ContactPoint |
valueCount |  |  | Count |
valueDistance |  |  | Distance |
valueDuration |  |  | Duration |
valueHumanName |  |  | HumanName |
valueIdentifier |  |  | Identifier |
valueMoney |  |  | Money |
valuePeriod |  |  | Period |
valueQuantity |  |  | Quantity |
valueRange |  |  | Range |
valueRatio |  |  | Ratio |
valueReference |  |  | Reference(Any) |
valueSampledData |  |  | SampledData |
valueSignature |  |  | Signature |
valueTiming |  |  | Timing |
valueContactDetail |  |  | ContactDetail |
valueContributor |  |  | Contributor |
valueDataRequirement |  |  | DataRequirement |
valueExpression |  |  | Expression |
valueParameterDefinition |  |  | ParameterDefinition |
valueRelatedArtifact |  |  | RelatedArtifact |
valueTriggerDefinition |  |  | TriggerDefinition |
valueUsageContext |  |  | UsageContext |
valueDosage |  |  | Dosage |
valueMeta |  |  | Meta |
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:subscription | S Σ C | 1..1 | BackboneElement | Parameter containing the reference to a subscription inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the reference to a subscription Fixed Value: subscription
value[x] | S Σ C | 1..1 | Reference(Subscription) | Reference to the Subscription responsible for this notification
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:topic | S Σ C | 0..1 | BackboneElement | Parameter containing the canonical reference to a subscription topic inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the canonical reference to a subscription topic Fixed Value: topic
value[x] | S Σ C | 0..1 | canonical() | Canonical reference to the SubscriptionTopic this notification relates to
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:status | S Σ C | 1..1 | BackboneElement | Parameter containing the subscription status inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the subscription status Fixed Value: status
value[x] | S Σ C | 1..1 | code | Status of the subscription when this notification was generated Binding: SubscriptionStatusCodes (required)
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:type | S Σ C | 1..1 | BackboneElement | Parameter containing the type of event for this notification inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the type of event for this notification Fixed Value: type
value[x] | S Σ C | 1..1 | code | The type of event being conveyed with this notificaiton. Binding: SubscriptionNotificationType (required)
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:eventsSinceSubscriptionStart | S Σ C | 0..1 | BackboneElement | Parameter containing the number of events since this subscription started inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the number of events since this subscription started Fixed Value: events-since-subscription-start
value[x] | S Σ C | 0..1 | string | Events since the Subscription was created
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:notificationEvent | S Σ C | 0..* | BackboneElement | Parameter containing the event notification details inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Parameter containing notification event details Fixed Value: notification-event
value[x] | Σ C | 0..1 |  | If parameter is a data type
valueBase64Binary |  |  | base64Binary |
valueBoolean |  |  | boolean |
valueCanonical |  |  | canonical(Any) |
valueCode |  |  | code |
valueDate |  |  | date |
valueDateTime |  |  | dateTime |
valueDecimal |  |  | decimal |
valueId |  |  | id |
valueInstant |  |  | instant |
valueInteger |  |  | integer |
valueMarkdown |  |  | markdown |
valueOid |  |  | oid |
valuePositiveInt |  |  | positiveInt |
valueString |  |  | string |
valueTime |  |  | time |
valueUnsignedInt |  |  | unsignedInt |
valueUri |  |  | uri |
valueUrl |  |  | url |
valueUuid |  |  | uuid |
valueAddress |  |  | Address |
valueAge |  |  | Age |
valueAnnotation |  |  | Annotation |
valueAttachment |  |  | Attachment |
valueCodeableConcept |  |  | CodeableConcept |
valueCoding |  |  | Coding |
valueContactPoint |  |  | ContactPoint |
valueCount |  |  | Count |
valueDistance |  |  | Distance |
valueDuration |  |  | Duration |
valueHumanName |  |  | HumanName |
valueIdentifier |  |  | Identifier |
valueMoney |  |  | Money |
valuePeriod |  |  | Period |
valueQuantity |  |  | Quantity |
valueRange |  |  | Range |
valueRatio |  |  | Ratio |
valueReference |  |  | Reference(Any) |
valueSampledData |  |  | SampledData |
valueSignature |  |  | Signature |
valueTiming |  |  | Timing |
valueContactDetail |  |  | ContactDetail |
valueContributor |  |  | Contributor |
valueDataRequirement |  |  | DataRequirement |
valueExpression |  |  | Expression |
valueParameterDefinition |  |  | ParameterDefinition |
valueRelatedArtifact |  |  | RelatedArtifact |
valueTriggerDefinition |  |  | TriggerDefinition |
valueUsageContext |  |  | UsageContext |
valueDosage |  |  | Dosage |
valueMeta |  |  | Meta |
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
Slices for part | S Σ | 1..* | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name
part:eventNumber | S Σ | 1..1 | BackboneElement | Parameter containing the event number
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the event number Fixed Value: event-number
value[x] | S Σ C | 1..1 | string | Event number
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:eventTimestamp | S Σ | 0..1 | BackboneElement | Parameter containing the event timestamp
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the event timestamp Fixed Value: timestamp
value[x] | S Σ C | 0..1 | instant | The instant this event occurred
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:eventFocus | S Σ | 0..1 | BackboneElement | Parameter containing the event focus
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the event focus Fixed Value: focus
value[x] | S Σ C | 0..1 | Reference() | The focus of this event
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:eventAdditionalContext | S Σ | 0..* | BackboneElement | Parameter containing additional context for this event
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: additional context for this event Fixed Value: additional-context
value[x] | S Σ C | 0..1 | Reference() | Additional context for this event
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:eventRelatedQuery | S Σ | 0..* | BackboneElement | Parameter containing related query information for this event
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: related query information for this event Fixed Value: related-query
value[x] | Σ C | 0..1 |  | If parameter is a data type
valueBase64Binary |  |  | base64Binary |
valueBoolean |  |  | boolean |
valueCanonical |  |  | canonical(Any) |
valueCode |  |  | code |
valueDate |  |  | date |
valueDateTime |  |  | dateTime |
valueDecimal |  |  | decimal |
valueId |  |  | id |
valueInstant |  |  | instant |
valueInteger |  |  | integer |
valueMarkdown |  |  | markdown |
valueOid |  |  | oid |
valuePositiveInt |  |  | positiveInt |
valueString |  |  | string |
valueTime |  |  | time |
valueUnsignedInt |  |  | unsignedInt |
valueUri |  |  | uri |
valueUrl |  |  | url |
valueUuid |  |  | uuid |
valueAddress |  |  | Address |
valueAge |  |  | Age |
valueAnnotation |  |  | Annotation |
valueAttachment |  |  | Attachment |
valueCodeableConcept |  |  | CodeableConcept |
valueCoding |  |  | Coding |
valueContactPoint |  |  | ContactPoint |
valueCount |  |  | Count |
valueDistance |  |  | Distance |
valueDuration |  |  | Duration |
valueHumanName |  |  | HumanName |
valueIdentifier |  |  | Identifier |
valueMoney |  |  | Money |
valuePeriod |  |  | Period |
valueQuantity |  |  | Quantity |
valueRange |  |  | Range |
valueRatio |  |  | Ratio |
valueReference |  |  | Reference(Any) |
valueSampledData |  |  | SampledData |
valueSignature |  |  | Signature |
valueTiming |  |  | Timing |
valueContactDetail |  |  | ContactDetail |
valueContributor |  |  | Contributor |
valueDataRequirement |  |  | DataRequirement |
valueExpression |  |  | Expression |
valueParameterDefinition |  |  | ParameterDefinition |
valueRelatedArtifact |  |  | RelatedArtifact |
valueTriggerDefinition |  |  | TriggerDefinition |
valueUsageContext |  |  | UsageContext |
valueDosage |  |  | Dosage |
valueMeta |  |  | Meta |
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
Slices for part | Σ | 1..* | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name
part:queryType | S Σ | 0..1 | BackboneElement | Parameter containing the query type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the query type Fixed Value: query-type
value[x] | S Σ C | 0..1 | Coding | Query Type
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:query | S Σ | 1..1 | BackboneElement | Parameter containing the query
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the query Fixed Value: query
value[x] | S Σ C | 1..1 | string | If parameter is a data type
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:authType | S Σ | 0..1 | BackboneElement | Parameter containing the authorization hint type.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the authorization hint type Fixed Value: authorization-type
value[x] | S Σ C | 0..1 | Coding | Authorization Hint Type
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:authValue | S Σ | 0..1 | BackboneElement | Parameter containing the authorization hint value.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the authorization hint value Fixed Value: authorization-value
value[x] | S Σ C | 0..1 | string | Authorization Hint Value
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:error | S Σ C | 0..* | BackboneElement | Parameter containing errors on the subscription inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: errors on the subscription Fixed Value: error
value[x] | S Σ C | 0..1 | CodeableConcept | An error on the subscription
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Parameters.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Parameters.parameter:status.value[x] | required | SubscriptionStatusCodes `http://hl7.org/fhir/ValueSet/subscription-status` from the FHIR Standard
Parameters.parameter:type.value[x] | required | SubscriptionNotificationType `http://hl7.org/fhir/ValueSet/subscription-notification-type` from the FHIR Standard

This structure is derived from Parameters

Summary

Mandatory: 6 elements(6 nested mandatory elements)
Must-Support: 31 elements
Fixed: 16 elements

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Parameters.parameter
- The element 1 is sliced based on the value of Parameters.parameter.part
- The element 1 is sliced based on the value of Parameters.parameter.part.part

Differential View

This structure is derived from Parameters

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Parameters |  | 0..* | Parameters | Parameter containing subscription status information
Slices for parameter |  | 3..* | BackboneElement | Slices containing subscription status information Slice: Unordered, Open by value:name
parameter:subscription | S | 1..1 | BackboneElement | Parameter containing the reference to a subscription
name |  | 1..1 | string | Slice discriminator: the reference to a subscription Fixed Value: subscription
value[x] | S | 1..1 | Reference(Subscription) | Reference to the Subscription responsible for this notification
parameter:topic | S | 0..1 | BackboneElement | Parameter containing the canonical reference to a subscription topic
name |  | 1..1 | string | Slice discriminator: the canonical reference to a subscription topic Fixed Value: topic
value[x] | S | 0..1 | canonical() | Canonical reference to the SubscriptionTopic this notification relates to
parameter:status | S | 1..1 | BackboneElement | Parameter containing the subscription status
name |  | 1..1 | string | Slice discriminator: the subscription status Fixed Value: status
value[x] | S | 1..1 | code | Status of the subscription when this notification was generated Binding: SubscriptionStatusCodes (required)
parameter:type | S | 1..1 | BackboneElement | Parameter containing the type of event for this notification
name |  | 1..1 | string | Slice discriminator: the type of event for this notification Fixed Value: type
value[x] | S | 1..1 | code | The type of event being conveyed with this notificaiton. Binding: SubscriptionNotificationType (required)
parameter:eventsSinceSubscriptionStart | S | 0..1 | BackboneElement | Parameter containing the number of events since this subscription started
name |  | 1..1 | string | Slice discriminator: the number of events since this subscription started Fixed Value: events-since-subscription-start
value[x] | S | 0..1 | string | Events since the Subscription was created
parameter:notificationEvent | S | 0..* | BackboneElement | Parameter containing the event notification details
name |  | 1..1 | string | Parameter containing notification event details Fixed Value: notification-event
Slices for part | S | 1..* |  | Named part of a multi-part parameter Slice: Unordered, Open by value:name
part:eventNumber | S | 1..1 | BackboneElement | Parameter containing the event number
name |  | 1..1 | string | Slice discriminator: the event number Fixed Value: event-number
value[x] | S | 1..1 | string | Event number
part:eventTimestamp | S | 0..1 | BackboneElement | Parameter containing the event timestamp
name |  | 1..1 | string | Slice discriminator: the event timestamp Fixed Value: timestamp
value[x] | S | 0..1 | instant | The instant this event occurred
part:eventFocus | S | 0..1 | BackboneElement | Parameter containing the event focus
name |  | 1..1 | string | Slice discriminator: the event focus Fixed Value: focus
value[x] | S | 0..1 | Reference() | The focus of this event
part:eventAdditionalContext | S | 0..* | BackboneElement | Parameter containing additional context for this event
name |  | 1..1 | string | Slice discriminator: additional context for this event Fixed Value: additional-context
value[x] | S | 0..1 | Reference() | Additional context for this event
part:eventRelatedQuery | S | 0..* | BackboneElement | Parameter containing related query information for this event
name |  | 1..1 | string | Slice discriminator: related query information for this event Fixed Value: related-query
Slices for part |  | 1..* |  | Named part of a multi-part parameter Slice: Unordered, Open by value:name
part:queryType | S | 0..1 | BackboneElement | Parameter containing the query type
name |  | 1..1 | string | Slice discriminator: the query type Fixed Value: query-type
value[x] | S | 0..1 | Coding | Query Type
part:query | S | 1..1 | BackboneElement | Parameter containing the query
name |  | 1..1 | string | Slice discriminator: the query Fixed Value: query
value[x] | S | 1..1 | string | If parameter is a data type
part:authType | S | 0..1 | BackboneElement | Parameter containing the authorization hint type.
name |  | 1..1 | string | Slice discriminator: the authorization hint type Fixed Value: authorization-type
value[x] | S | 0..1 | Coding | Authorization Hint Type
part:authValue | S | 0..1 | BackboneElement | Parameter containing the authorization hint value.
name |  | 1..1 | string | Slice discriminator: the authorization hint value Fixed Value: authorization-value
value[x] | S | 0..1 | string | Authorization Hint Value
parameter:error | S | 0..* | BackboneElement | Parameter containing errors on the subscription
name |  | 1..1 | string | Slice discriminator: errors on the subscription Fixed Value: error
value[x] | S | 0..1 | CodeableConcept | An error on the subscription
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Parameters.parameter:status.value[x] | required | SubscriptionStatusCodes `http://hl7.org/fhir/ValueSet/subscription-status` from the FHIR Standard
Parameters.parameter:type.value[x] | required | SubscriptionNotificationType `http://hl7.org/fhir/ValueSet/subscription-notification-type` from the FHIR Standard

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Parameters |  | 0..* | Parameters | Parameter containing subscription status information
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for parameter | Σ C | 3..* | BackboneElement | Slices containing subscription status information Slice: Unordered, Open by value:name inv-1: A parameter must have one and only one of (value, resource, part)
parameter:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Name from the definition
parameter:subscription | S Σ C | 1..1 | BackboneElement | Parameter containing the reference to a subscription inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the reference to a subscription Fixed Value: subscription
value[x] | S Σ C | 1..1 | Reference(Subscription) | Reference to the Subscription responsible for this notification
parameter:topic | S Σ C | 0..1 | BackboneElement | Parameter containing the canonical reference to a subscription topic inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the canonical reference to a subscription topic Fixed Value: topic
value[x] | S Σ C | 0..1 | canonical() | Canonical reference to the SubscriptionTopic this notification relates to
parameter:status | S Σ C | 1..1 | BackboneElement | Parameter containing the subscription status inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the subscription status Fixed Value: status
value[x] | S Σ C | 1..1 | code | Status of the subscription when this notification was generated Binding: SubscriptionStatusCodes (required)
parameter:type | S Σ C | 1..1 | BackboneElement | Parameter containing the type of event for this notification inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the type of event for this notification Fixed Value: type
value[x] | S Σ C | 1..1 | code | The type of event being conveyed with this notificaiton. Binding: SubscriptionNotificationType (required)
parameter:eventsSinceSubscriptionStart | S Σ C | 0..1 | BackboneElement | Parameter containing the number of events since this subscription started inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the number of events since this subscription started Fixed Value: events-since-subscription-start
value[x] | S Σ C | 0..1 | string | Events since the Subscription was created
parameter:notificationEvent | S Σ C | 0..* | BackboneElement | Parameter containing the event notification details inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Parameter containing notification event details Fixed Value: notification-event
Slices for part | S Σ | 1..* | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name
part:eventNumber | S Σ | 1..1 | BackboneElement | Parameter containing the event number
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the event number Fixed Value: event-number
value[x] | S Σ C | 1..1 | string | Event number
part:eventTimestamp | S Σ | 0..1 | BackboneElement | Parameter containing the event timestamp
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the event timestamp Fixed Value: timestamp
value[x] | S Σ C | 0..1 | instant | The instant this event occurred
part:eventFocus | S Σ | 0..1 | BackboneElement | Parameter containing the event focus
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the event focus Fixed Value: focus
value[x] | S Σ C | 0..1 | Reference() | The focus of this event
part:eventAdditionalContext | S Σ | 0..* | BackboneElement | Parameter containing additional context for this event
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: additional context for this event Fixed Value: additional-context
value[x] | S Σ C | 0..1 | Reference() | Additional context for this event
part:eventRelatedQuery | S Σ | 0..* | BackboneElement | Parameter containing related query information for this event
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: related query information for this event Fixed Value: related-query
Slices for part | Σ | 1..* | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name
part:queryType | S Σ | 0..1 | BackboneElement | Parameter containing the query type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the query type Fixed Value: query-type
value[x] | S Σ C | 0..1 | Coding | Query Type
part:query | S Σ | 1..1 | BackboneElement | Parameter containing the query
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the query Fixed Value: query
value[x] | S Σ C | 1..1 | string | If parameter is a data type
part:authType | S Σ | 0..1 | BackboneElement | Parameter containing the authorization hint type.
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the authorization hint type Fixed Value: authorization-type
value[x] | S Σ C | 0..1 | Coding | Authorization Hint Type
part:authValue | S Σ | 0..1 | BackboneElement | Parameter containing the authorization hint value.
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the authorization hint value Fixed Value: authorization-value
value[x] | S Σ C | 0..1 | string | Authorization Hint Value
parameter:error | S Σ C | 0..* | BackboneElement | Parameter containing errors on the subscription inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: errors on the subscription Fixed Value: error
value[x] | S Σ C | 0..1 | CodeableConcept | An error on the subscription
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Parameters.parameter:status.value[x] | required | SubscriptionStatusCodes `http://hl7.org/fhir/ValueSet/subscription-status` from the FHIR Standard
Parameters.parameter:type.value[x] | required | SubscriptionNotificationType `http://hl7.org/fhir/ValueSet/subscription-notification-type` from the FHIR Standard

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Parameters |  | 0..* | Parameters | Parameter containing subscription status information
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | 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 content Binding: CommonLanguages (preferred): IETF language tag
Additional Bindings | Purpose
AllLanguages | Max Binding
Slices for parameter | Σ C | 3..* | BackboneElement | Slices containing subscription status information Slice: Unordered, Open by value:name inv-1: A parameter must have one and only one of (value, resource, part)
parameter:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Name from the definition
value[x] | Σ C | 0..1 |  | If parameter is a data type
valueBase64Binary |  |  | base64Binary |
valueBoolean |  |  | boolean |
valueCanonical |  |  | canonical(Any) |
valueCode |  |  | code |
valueDate |  |  | date |
valueDateTime |  |  | dateTime |
valueDecimal |  |  | decimal |
valueId |  |  | id |
valueInstant |  |  | instant |
valueInteger |  |  | integer |
valueMarkdown |  |  | markdown |
valueOid |  |  | oid |
valuePositiveInt |  |  | positiveInt |
valueString |  |  | string |
valueTime |  |  | time |
valueUnsignedInt |  |  | unsignedInt |
valueUri |  |  | uri |
valueUrl |  |  | url |
valueUuid |  |  | uuid |
valueAddress |  |  | Address |
valueAge |  |  | Age |
valueAnnotation |  |  | Annotation |
valueAttachment |  |  | Attachment |
valueCodeableConcept |  |  | CodeableConcept |
valueCoding |  |  | Coding |
valueContactPoint |  |  | ContactPoint |
valueCount |  |  | Count |
valueDistance |  |  | Distance |
valueDuration |  |  | Duration |
valueHumanName |  |  | HumanName |
valueIdentifier |  |  | Identifier |
valueMoney |  |  | Money |
valuePeriod |  |  | Period |
valueQuantity |  |  | Quantity |
valueRange |  |  | Range |
valueRatio |  |  | Ratio |
valueReference |  |  | Reference(Any) |
valueSampledData |  |  | SampledData |
valueSignature |  |  | Signature |
valueTiming |  |  | Timing |
valueContactDetail |  |  | ContactDetail |
valueContributor |  |  | Contributor |
valueDataRequirement |  |  | DataRequirement |
valueExpression |  |  | Expression |
valueParameterDefinition |  |  | ParameterDefinition |
valueRelatedArtifact |  |  | RelatedArtifact |
valueTriggerDefinition |  |  | TriggerDefinition |
valueUsageContext |  |  | UsageContext |
valueDosage |  |  | Dosage |
valueMeta |  |  | Meta |
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:subscription | S Σ C | 1..1 | BackboneElement | Parameter containing the reference to a subscription inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the reference to a subscription Fixed Value: subscription
value[x] | S Σ C | 1..1 | Reference(Subscription) | Reference to the Subscription responsible for this notification
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:topic | S Σ C | 0..1 | BackboneElement | Parameter containing the canonical reference to a subscription topic inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the canonical reference to a subscription topic Fixed Value: topic
value[x] | S Σ C | 0..1 | canonical() | Canonical reference to the SubscriptionTopic this notification relates to
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:status | S Σ C | 1..1 | BackboneElement | Parameter containing the subscription status inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the subscription status Fixed Value: status
value[x] | S Σ C | 1..1 | code | Status of the subscription when this notification was generated Binding: SubscriptionStatusCodes (required)
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:type | S Σ C | 1..1 | BackboneElement | Parameter containing the type of event for this notification inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the type of event for this notification Fixed Value: type
value[x] | S Σ C | 1..1 | code | The type of event being conveyed with this notificaiton. Binding: SubscriptionNotificationType (required)
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:eventsSinceSubscriptionStart | S Σ C | 0..1 | BackboneElement | Parameter containing the number of events since this subscription started inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the number of events since this subscription started Fixed Value: events-since-subscription-start
value[x] | S Σ C | 0..1 | string | Events since the Subscription was created
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:notificationEvent | S Σ C | 0..* | BackboneElement | Parameter containing the event notification details inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Parameter containing notification event details Fixed Value: notification-event
value[x] | Σ C | 0..1 |  | If parameter is a data type
valueBase64Binary |  |  | base64Binary |
valueBoolean |  |  | boolean |
valueCanonical |  |  | canonical(Any) |
valueCode |  |  | code |
valueDate |  |  | date |
valueDateTime |  |  | dateTime |
valueDecimal |  |  | decimal |
valueId |  |  | id |
valueInstant |  |  | instant |
valueInteger |  |  | integer |
valueMarkdown |  |  | markdown |
valueOid |  |  | oid |
valuePositiveInt |  |  | positiveInt |
valueString |  |  | string |
valueTime |  |  | time |
valueUnsignedInt |  |  | unsignedInt |
valueUri |  |  | uri |
valueUrl |  |  | url |
valueUuid |  |  | uuid |
valueAddress |  |  | Address |
valueAge |  |  | Age |
valueAnnotation |  |  | Annotation |
valueAttachment |  |  | Attachment |
valueCodeableConcept |  |  | CodeableConcept |
valueCoding |  |  | Coding |
valueContactPoint |  |  | ContactPoint |
valueCount |  |  | Count |
valueDistance |  |  | Distance |
valueDuration |  |  | Duration |
valueHumanName |  |  | HumanName |
valueIdentifier |  |  | Identifier |
valueMoney |  |  | Money |
valuePeriod |  |  | Period |
valueQuantity |  |  | Quantity |
valueRange |  |  | Range |
valueRatio |  |  | Ratio |
valueReference |  |  | Reference(Any) |
valueSampledData |  |  | SampledData |
valueSignature |  |  | Signature |
valueTiming |  |  | Timing |
valueContactDetail |  |  | ContactDetail |
valueContributor |  |  | Contributor |
valueDataRequirement |  |  | DataRequirement |
valueExpression |  |  | Expression |
valueParameterDefinition |  |  | ParameterDefinition |
valueRelatedArtifact |  |  | RelatedArtifact |
valueTriggerDefinition |  |  | TriggerDefinition |
valueUsageContext |  |  | UsageContext |
valueDosage |  |  | Dosage |
valueMeta |  |  | Meta |
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
Slices for part | S Σ | 1..* | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name
part:eventNumber | S Σ | 1..1 | BackboneElement | Parameter containing the event number
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the event number Fixed Value: event-number
value[x] | S Σ C | 1..1 | string | Event number
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:eventTimestamp | S Σ | 0..1 | BackboneElement | Parameter containing the event timestamp
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the event timestamp Fixed Value: timestamp
value[x] | S Σ C | 0..1 | instant | The instant this event occurred
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:eventFocus | S Σ | 0..1 | BackboneElement | Parameter containing the event focus
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the event focus Fixed Value: focus
value[x] | S Σ C | 0..1 | Reference() | The focus of this event
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:eventAdditionalContext | S Σ | 0..* | BackboneElement | Parameter containing additional context for this event
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: additional context for this event Fixed Value: additional-context
value[x] | S Σ C | 0..1 | Reference() | Additional context for this event
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:eventRelatedQuery | S Σ | 0..* | BackboneElement | Parameter containing related query information for this event
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: related query information for this event Fixed Value: related-query
value[x] | Σ C | 0..1 |  | If parameter is a data type
valueBase64Binary |  |  | base64Binary |
valueBoolean |  |  | boolean |
valueCanonical |  |  | canonical(Any) |
valueCode |  |  | code |
valueDate |  |  | date |
valueDateTime |  |  | dateTime |
valueDecimal |  |  | decimal |
valueId |  |  | id |
valueInstant |  |  | instant |
valueInteger |  |  | integer |
valueMarkdown |  |  | markdown |
valueOid |  |  | oid |
valuePositiveInt |  |  | positiveInt |
valueString |  |  | string |
valueTime |  |  | time |
valueUnsignedInt |  |  | unsignedInt |
valueUri |  |  | uri |
valueUrl |  |  | url |
valueUuid |  |  | uuid |
valueAddress |  |  | Address |
valueAge |  |  | Age |
valueAnnotation |  |  | Annotation |
valueAttachment |  |  | Attachment |
valueCodeableConcept |  |  | CodeableConcept |
valueCoding |  |  | Coding |
valueContactPoint |  |  | ContactPoint |
valueCount |  |  | Count |
valueDistance |  |  | Distance |
valueDuration |  |  | Duration |
valueHumanName |  |  | HumanName |
valueIdentifier |  |  | Identifier |
valueMoney |  |  | Money |
valuePeriod |  |  | Period |
valueQuantity |  |  | Quantity |
valueRange |  |  | Range |
valueRatio |  |  | Ratio |
valueReference |  |  | Reference(Any) |
valueSampledData |  |  | SampledData |
valueSignature |  |  | Signature |
valueTiming |  |  | Timing |
valueContactDetail |  |  | ContactDetail |
valueContributor |  |  | Contributor |
valueDataRequirement |  |  | DataRequirement |
valueExpression |  |  | Expression |
valueParameterDefinition |  |  | ParameterDefinition |
valueRelatedArtifact |  |  | RelatedArtifact |
valueTriggerDefinition |  |  | TriggerDefinition |
valueUsageContext |  |  | UsageContext |
valueDosage |  |  | Dosage |
valueMeta |  |  | Meta |
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
Slices for part | Σ | 1..* | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name
part:queryType | S Σ | 0..1 | BackboneElement | Parameter containing the query type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the query type Fixed Value: query-type
value[x] | S Σ C | 0..1 | Coding | Query Type
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:query | S Σ | 1..1 | BackboneElement | Parameter containing the query
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the query Fixed Value: query
value[x] | S Σ C | 1..1 | string | If parameter is a data type
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:authType | S Σ | 0..1 | BackboneElement | Parameter containing the authorization hint type.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the authorization hint type Fixed Value: authorization-type
value[x] | S Σ C | 0..1 | Coding | Authorization Hint Type
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:authValue | S Σ | 0..1 | BackboneElement | Parameter containing the authorization hint value.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: the authorization hint value Fixed Value: authorization-value
value[x] | S Σ C | 0..1 | string | Authorization Hint Value
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:error | S Σ C | 0..* | BackboneElement | Parameter containing errors on the subscription inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Slice discriminator: errors on the subscription Fixed Value: error
value[x] | S Σ C | 0..1 | CodeableConcept | An error on the subscription
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Parameters.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Parameters.parameter:status.value[x] | required | SubscriptionStatusCodes `http://hl7.org/fhir/ValueSet/subscription-status` from the FHIR Standard
Parameters.parameter:type.value[x] | required | SubscriptionNotificationType `http://hl7.org/fhir/ValueSet/subscription-notification-type` from the FHIR Standard

This structure is derived from Parameters

Summary

Mandatory: 6 elements(6 nested mandatory elements)
Must-Support: 31 elements
Fixed: 16 elements

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Parameters.parameter
- The element 1 is sliced based on the value of Parameters.parameter.part
- The element 1 is sliced based on the value of Parameters.parameter.part.part

Other representations of profile: CSV, Excel, Schematron