Subscriptions R5 Backport
0.1.0 - ballot
Subscriptions R5 Backport
0.1.0 - ballot
This page is part of the Subscriptions R5 Backport (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions 
| Defining URL: | http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscriptionstatus |
| Version: | 0.1.0 |
| Name: | BackportSubscriptionStatus |
| Title: | Backported R5 Subscription Notification Status |
| Status: | Active as of 2020-12-16T17:37:01+00:00 |
| Definition: | Profile on the Parameters resource to enable R5-style topic-based subscription notifications in FHIR R4. |
| Publisher: | HL7 FHIR Infrastructure WG |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscriptionstatus
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Parameters
Summary
Mandatory: 5 elements (3 nested mandatory elements)
Must-Support: 14 elements
Fixed Value: 7 elements
Slices
This structure defines the following Slices:
This structure is derived from Parameters
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Parameters | 0..* | Parameters | Operation Request or Response | |
  parameter | 3..* | (Slice Definition) | Operation Parameter Slice: Unordered, Open by value:name | |
   parameter:subscription | S | 1..1 | BackboneElement | Operation Parameter |
   name | 1..1 | string | Name from the definition Fixed Value: subscription | |
  value[x] | S | 1..1 | Reference(Subscription) | If parameter is a data type |
| parameter:topic | S | 1..1 | BackboneElement | Operation Parameter |
| name | 1..1 | string | Name from the definition Fixed Value: topic | |
 value[x] | S | 0..1 | canonical() | If parameter is a data type |
| parameter:status | S | 0..1 | BackboneElement | Operation Parameter |
| name | 1..1 | string | Name from the definition Fixed Value: status | |
| value[x] | S | 1..1 | code | If parameter is a data type Binding: SubscriptionStatus (required) |
| parameter:type | S | 1..1 | BackboneElement | Operation Parameter |
| name | 1..1 | string | Name from the definition Fixed Value: type | |
| value[x] | S | 1..1 | code | If parameter is a data type Binding: R5 Subscription Notification Type Value Set (required) |
| parameter:eventsSinceSubscriptionStart | S | 0..1 | BackboneElement | Operation Parameter |
| name | 1..1 | string | Name from the definition Fixed Value: events-since-subscription-start | |
| value[x] | S | 1..1 | unsignedInt | If parameter is a data type |
| parameter:eventsInNotification | S | 0..1 | BackboneElement | Operation Parameter |
| name | 1..1 | string | Name from the definition Fixed Value: events-in-notification | |
| value[x] | S | 0..1 | unsignedInt | If parameter is a data type |
 parameter:error | S | 0..1 | BackboneElement | Operation Parameter |
| name | 1..1 | string | Name from the definition Fixed Value: error | |
 value[x] | S | 1..1 | CodeableConcept | If parameter is a data type |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Parameters | 0..* | Parameters | Operation Request or Response | |
 id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
| parameter | ΣI | 3..* | (Slice Definition) | Operation Parameter Slice: Unordered, Open by value:name |
| 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] | ΣI | 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 | ΣI | 0..1 | Resource | If parameter is a whole resource |
 part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
| parameter:subscription | SΣI | 1..1 | BackboneElement | Operation Parameter |
| 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 Fixed Value: subscription |
| value[x] | SΣI | 1..1 | Reference(Subscription) | If parameter is a data type |
| resource | ΣI | 0..1 | Resource | If parameter is a whole resource |
| part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
| parameter:topic | SΣI | 1..1 | BackboneElement | Operation Parameter |
| 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 Fixed Value: topic |
| value[x] | SΣI | 0..1 | canonical() | If parameter is a data type |
| resource | ΣI | 0..1 | Resource | If parameter is a whole resource |
| part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
| parameter:status | SΣI | 0..1 | BackboneElement | Operation Parameter |
| 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 Fixed Value: status |
| value[x] | SΣI | 1..1 | code | If parameter is a data type Binding: SubscriptionStatus (required) |
| resource | ΣI | 0..1 | Resource | If parameter is a whole resource |
| part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
| parameter:type | SΣI | 1..1 | BackboneElement | Operation Parameter |
| 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 Fixed Value: type |
| value[x] | SΣI | 1..1 | code | If parameter is a data type Binding: R5 Subscription Notification Type Value Set (required) |
| resource | ΣI | 0..1 | Resource | If parameter is a whole resource |
| part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
| parameter:eventsSinceSubscriptionStart | SΣI | 0..1 | BackboneElement | Operation Parameter |
| 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 Fixed Value: events-since-subscription-start |
| value[x] | SΣI | 1..1 | unsignedInt | If parameter is a data type |
| resource | ΣI | 0..1 | Resource | If parameter is a whole resource |
| part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
| parameter:eventsInNotification | SΣI | 0..1 | BackboneElement | Operation Parameter |
| 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 Fixed Value: events-in-notification |
| value[x] | SΣI | 0..1 | unsignedInt | If parameter is a data type |
| resource | ΣI | 0..1 | Resource | If parameter is a whole resource |
| part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
| parameter:error | SΣI | 0..1 | BackboneElement | Operation Parameter |
| 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 Fixed Value: error |
| value[x] | SΣI | 1..1 | CodeableConcept | If parameter is a data type |
| resource | ΣI | 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 | ||||
This structure is derived from Parameters
Summary
Mandatory: 5 elements (3 nested mandatory elements)
Must-Support: 14 elements
Fixed Value: 7 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Parameters
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Parameters | 0..* | Parameters | Operation Request or Response | |
| parameter | 3..* | (Slice Definition) | Operation Parameter Slice: Unordered, Open by value:name | |
| parameter:subscription | S | 1..1 | BackboneElement | Operation Parameter |
| name | 1..1 | string | Name from the definition Fixed Value: subscription | |
| value[x] | S | 1..1 | Reference(Subscription) | If parameter is a data type |
| parameter:topic | S | 1..1 | BackboneElement | Operation Parameter |
| name | 1..1 | string | Name from the definition Fixed Value: topic | |
| value[x] | S | 0..1 | canonical() | If parameter is a data type |
| parameter:status | S | 0..1 | BackboneElement | Operation Parameter |
| name | 1..1 | string | Name from the definition Fixed Value: status | |
| value[x] | S | 1..1 | code | If parameter is a data type Binding: SubscriptionStatus (required) |
| parameter:type | S | 1..1 | BackboneElement | Operation Parameter |
| name | 1..1 | string | Name from the definition Fixed Value: type | |
| value[x] | S | 1..1 | code | If parameter is a data type Binding: R5 Subscription Notification Type Value Set (required) |
| parameter:eventsSinceSubscriptionStart | S | 0..1 | BackboneElement | Operation Parameter |
| name | 1..1 | string | Name from the definition Fixed Value: events-since-subscription-start | |
| value[x] | S | 1..1 | unsignedInt | If parameter is a data type |
| parameter:eventsInNotification | S | 0..1 | BackboneElement | Operation Parameter |
| name | 1..1 | string | Name from the definition Fixed Value: events-in-notification | |
| value[x] | S | 0..1 | unsignedInt | If parameter is a data type |
| parameter:error | S | 0..1 | BackboneElement | Operation Parameter |
| name | 1..1 | string | Name from the definition Fixed Value: error | |
| value[x] | S | 1..1 | CodeableConcept | If parameter is a data type |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Parameters | 0..* | Parameters | Operation Request or Response | |
| id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
| parameter | ΣI | 3..* | (Slice Definition) | Operation Parameter Slice: Unordered, Open by value:name |
| 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] | ΣI | 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 | ΣI | 0..1 | Resource | If parameter is a whole resource |
| part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
| parameter:subscription | SΣI | 1..1 | BackboneElement | Operation Parameter |
| 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 Fixed Value: subscription |
| value[x] | SΣI | 1..1 | Reference(Subscription) | If parameter is a data type |
| resource | ΣI | 0..1 | Resource | If parameter is a whole resource |
| part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
| parameter:topic | SΣI | 1..1 | BackboneElement | Operation Parameter |
| 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 Fixed Value: topic |
| value[x] | SΣI | 0..1 | canonical() | If parameter is a data type |
| resource | ΣI | 0..1 | Resource | If parameter is a whole resource |
| part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
| parameter:status | SΣI | 0..1 | BackboneElement | Operation Parameter |
| 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 Fixed Value: status |
| value[x] | SΣI | 1..1 | code | If parameter is a data type Binding: SubscriptionStatus (required) |
| resource | ΣI | 0..1 | Resource | If parameter is a whole resource |
| part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
| parameter:type | SΣI | 1..1 | BackboneElement | Operation Parameter |
| 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 Fixed Value: type |
| value[x] | SΣI | 1..1 | code | If parameter is a data type Binding: R5 Subscription Notification Type Value Set (required) |
| resource | ΣI | 0..1 | Resource | If parameter is a whole resource |
| part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
| parameter:eventsSinceSubscriptionStart | SΣI | 0..1 | BackboneElement | Operation Parameter |
| 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 Fixed Value: events-since-subscription-start |
| value[x] | SΣI | 1..1 | unsignedInt | If parameter is a data type |
| resource | ΣI | 0..1 | Resource | If parameter is a whole resource |
| part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
| parameter:eventsInNotification | SΣI | 0..1 | BackboneElement | Operation Parameter |
| 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 Fixed Value: events-in-notification |
| value[x] | SΣI | 0..1 | unsignedInt | If parameter is a data type |
| resource | ΣI | 0..1 | Resource | If parameter is a whole resource |
| part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
| parameter:error | SΣI | 0..1 | BackboneElement | Operation Parameter |
| 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 Fixed Value: error |
| value[x] | SΣI | 1..1 | CodeableConcept | If parameter is a data type |
| resource | ΣI | 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 | ||||
Other representations of profile: Schematron
| Path | Conformance | ValueSet |
| Parameters.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Parameters.parameter:status.value[x] | required | SubscriptionStatus |
| Parameters.parameter:type.value[x] | required | BackportNotificationTypeValueSet |
IG © 2020+ HL7 FHIR Infrastructure WG. Package hl7.fhir.uv.subscriptions-backport#0.1.0 based on FHIR 4.0.1. Generated 2020-12-16
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change
