Document Subscription for Mobile (DSUBm)
1.0.1-current - ci-build

Document Subscription for Mobile (DSUBm), published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 1.0.1-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.DSUBm/ and changes regularly. See the Directory of published versions

## Resource Profile: SubscriptionStatus for the status operation

Official URL: https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/IHE.DSUBm.SubscriptionStatus-StatusOperation | Version: 1.0.1-current
Active as of 2025-04-28 | Computable Name: SubscriptionStatus_StatusOperation

Profile on the SubscriptionStatus resource for the $status operation

Usage:

- Use this Resource Profile: Bundle response for $status
- Examples for this Resource Profile: Parameters/ex-SubscriptionStatus-StatusOperation

### 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 BackportSubscriptionStatusR4

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Parameters |  |  | BackportSubscriptionStatusR4 |
parameter |  | 4..* | BackboneElement | Slices containing subscription status information
Slices for parameter |  |  |  | Content/Rules for all slices
parameter:status |  | 1..1 | BackboneElement | Current status of the relevant subscription
parameter:type |  | 1..1 | BackboneElement | Parameter containing the type of event for this notification
value[x] |  | 1..1 | code | The type of event being conveyed with this notificaiton. Required Pattern: query-status
parameter:eventsSinceSubscriptionStart |  | 1..1 | BackboneElement | Parameter containing the number of events since this subscription started
value[x] |  | 0..1 | string | This value is REQUIRED because clients MAY use it to know if there are missing notifications. Note: this value SHALL NOT be incremented by sending a query-status notification.
parameter:notificationEvent |  | 0..0 |  |
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Parameters |  | 0..* | BackportSubscriptionStatusR4 | Parameter containing subscription status information
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for parameter | Σ C | 4..* | BackboneElement | Slices containing subscription status information Slice: Unordered, Open by value:name ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children
parameter:subscription | S Σ C | 1..1 | BackboneElement | Parameter containing the reference to a subscription ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | Σ | 1..1 | string | Slice discriminator: the reference to a subscription ele-1: All FHIR elements must have a @value or children Fixed Value: subscription
value[x] | S Σ C | 1..1 | Reference(Subscription) | Reference to the Subscription responsible for this notification ele-1: All FHIR elements must have a @value or children
parameter:topic | S Σ C | 0..1 | BackboneElement | Parameter containing the canonical reference to a subscription topic ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | Σ | 1..1 | string | Slice discriminator: the canonical reference to a subscription topic ele-1: All FHIR elements must have a @value or children Fixed Value: topic
value[x] | S Σ C | 0..1 | canonical() | Canonical reference to the SubscriptionTopic this notification relates to ele-1: All FHIR elements must have a @value or children
parameter:status | S Σ C | 1..1 | BackboneElement | Current status of the relevant subscription ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | Σ | 1..1 | string | Slice discriminator: the subscription status ele-1: All FHIR elements must have a @value or children Fixed Value: status
value[x] | S Σ C | 1..1 | code | Status of the subscription when this notification was generated Binding: SubscriptionStatus (required) ele-1: All FHIR elements must have a @value or children
parameter:type | S Σ C | 1..1 | BackboneElement | Parameter containing the type of event for this notification ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | Σ | 1..1 | string | Slice discriminator: the type of event for this notification ele-1: All FHIR elements must have a @value or children Fixed Value: type
value[x] | S Σ C | 1..1 | code | The type of event being conveyed with this notificaiton. Binding: subscription-notification-type (??) (required) ele-1: All FHIR elements must have a @value or children Required Pattern: query-status
parameter:eventsSinceSubscriptionStart | S Σ C | 1..1 | BackboneElement | Parameter containing the number of events since this subscription started ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | Σ | 1..1 | string | Slice discriminator: the number of events since this subscription started ele-1: All FHIR elements must have a @value or children Fixed Value: events-since-subscription-start
value[x] | S Σ C | 0..1 | string | This value is REQUIRED because clients MAY use it to know if there are missing notifications. Note: this value SHALL NOT be incremented by sending a query-status notification. ele-1: All FHIR elements must have a @value or children
parameter:error | S Σ C | 0..* | BackboneElement | Parameter containing errors on the subscription ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | Σ | 1..1 | string | Slice discriminator: errors on the subscription ele-1: All FHIR elements must have a @value or children Fixed Value: error
value[x] | S Σ C | 0..1 | CodeableConcept | An error on the subscription ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

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

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Parameters |  | 0..* | BackportSubscriptionStatusR4 | 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 | 4..* | 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 | Current status of the relevant 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 subscription status Fixed Value: status
value[x] | S Σ C | 1..1 | code | Status of the subscription when this notification was generated Binding: SubscriptionStatus (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: subscription-notification-type (??) (required) Required Pattern: query-status
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 | 1..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 | This value is REQUIRED because clients MAY use it to know if there are missing notifications. Note: this value SHALL NOT be incremented by sending a query-status 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: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 / Code | URI
Parameters.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Parameters.parameter:status.value[x] | required | SubscriptionStatus `http://hl7.org/fhir/ValueSet/subscription-status` from the FHIR Standard
Parameters.parameter:type.value[x] | required | Pattern: query-status `http://hl7.org/fhir/ValueSet/subscription-notification-type`

This structure is derived from BackportSubscriptionStatusR4

Summary

Mandatory: 1 element
Prohibited: 1 element

Differential View

This structure is derived from BackportSubscriptionStatusR4

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Parameters |  |  | BackportSubscriptionStatusR4 |
parameter |  | 4..* | BackboneElement | Slices containing subscription status information
Slices for parameter |  |  |  | Content/Rules for all slices
parameter:status |  | 1..1 | BackboneElement | Current status of the relevant subscription
parameter:type |  | 1..1 | BackboneElement | Parameter containing the type of event for this notification
value[x] |  | 1..1 | code | The type of event being conveyed with this notificaiton. Required Pattern: query-status
parameter:eventsSinceSubscriptionStart |  | 1..1 | BackboneElement | Parameter containing the number of events since this subscription started
value[x] |  | 0..1 | string | This value is REQUIRED because clients MAY use it to know if there are missing notifications. Note: this value SHALL NOT be incremented by sending a query-status notification.
parameter:notificationEvent |  | 0..0 |  |
Documentation for this format

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Parameters |  | 0..* | BackportSubscriptionStatusR4 | Parameter containing subscription status information
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for parameter | Σ C | 4..* | BackboneElement | Slices containing subscription status information Slice: Unordered, Open by value:name ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children
parameter:subscription | S Σ C | 1..1 | BackboneElement | Parameter containing the reference to a subscription ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | Σ | 1..1 | string | Slice discriminator: the reference to a subscription ele-1: All FHIR elements must have a @value or children Fixed Value: subscription
value[x] | S Σ C | 1..1 | Reference(Subscription) | Reference to the Subscription responsible for this notification ele-1: All FHIR elements must have a @value or children
parameter:topic | S Σ C | 0..1 | BackboneElement | Parameter containing the canonical reference to a subscription topic ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | Σ | 1..1 | string | Slice discriminator: the canonical reference to a subscription topic ele-1: All FHIR elements must have a @value or children Fixed Value: topic
value[x] | S Σ C | 0..1 | canonical() | Canonical reference to the SubscriptionTopic this notification relates to ele-1: All FHIR elements must have a @value or children
parameter:status | S Σ C | 1..1 | BackboneElement | Current status of the relevant subscription ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | Σ | 1..1 | string | Slice discriminator: the subscription status ele-1: All FHIR elements must have a @value or children Fixed Value: status
value[x] | S Σ C | 1..1 | code | Status of the subscription when this notification was generated Binding: SubscriptionStatus (required) ele-1: All FHIR elements must have a @value or children
parameter:type | S Σ C | 1..1 | BackboneElement | Parameter containing the type of event for this notification ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | Σ | 1..1 | string | Slice discriminator: the type of event for this notification ele-1: All FHIR elements must have a @value or children Fixed Value: type
value[x] | S Σ C | 1..1 | code | The type of event being conveyed with this notificaiton. Binding: subscription-notification-type (??) (required) ele-1: All FHIR elements must have a @value or children Required Pattern: query-status
parameter:eventsSinceSubscriptionStart | S Σ C | 1..1 | BackboneElement | Parameter containing the number of events since this subscription started ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | Σ | 1..1 | string | Slice discriminator: the number of events since this subscription started ele-1: All FHIR elements must have a @value or children Fixed Value: events-since-subscription-start
value[x] | S Σ C | 0..1 | string | This value is REQUIRED because clients MAY use it to know if there are missing notifications. Note: this value SHALL NOT be incremented by sending a query-status notification. ele-1: All FHIR elements must have a @value or children
parameter:error | S Σ C | 0..* | BackboneElement | Parameter containing errors on the subscription ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | Σ | 1..1 | string | Slice discriminator: errors on the subscription ele-1: All FHIR elements must have a @value or children Fixed Value: error
value[x] | S Σ C | 0..1 | CodeableConcept | An error on the subscription ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

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

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Parameters |  | 0..* | BackportSubscriptionStatusR4 | 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 | 4..* | 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 | Current status of the relevant 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 subscription status Fixed Value: status
value[x] | S Σ C | 1..1 | code | Status of the subscription when this notification was generated Binding: SubscriptionStatus (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: subscription-notification-type (??) (required) Required Pattern: query-status
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 | 1..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 | This value is REQUIRED because clients MAY use it to know if there are missing notifications. Note: this value SHALL NOT be incremented by sending a query-status 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: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 / Code | URI
Parameters.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Parameters.parameter:status.value[x] | required | SubscriptionStatus `http://hl7.org/fhir/ValueSet/subscription-status` from the FHIR Standard
Parameters.parameter:type.value[x] | required | Pattern: query-status `http://hl7.org/fhir/ValueSet/subscription-notification-type`

This structure is derived from BackportSubscriptionStatusR4

Summary

Mandatory: 1 element
Prohibited: 1 element

Other representations of profile: CSV, Excel, Schematron