Subscriptions R5 Backport - Local Development build (v0.1.0). See the Directory of published versions
Defining URL: | http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-notification |
Version: | 0.1.0 |
Name: | BackportSubscriptionNotification |
Title: | Backported R5 Subscription Notification Bundle |
Status: | Active as of 2021-11-09T16:42:00-06:00 |
Definition: | Profile on the R4 Bundle 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-subscription-notification
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Bundle
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | I | 0..* | Bundle | Contains a collection of resources backport-notification-bundle-1: A notification bundle MUST have a SubscriptionStatus as the first entry |
type | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Required Pattern: history | |
Slices for entry | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource | |
entry:subscriptionStatus | S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information |
resource | S | 1..1 | SubscriptionStatus | A resource in the bundle |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | I | 0..* | Bundle | Contains a collection of resources backport-notification-bundle-1: A notification bundle MUST have a SubscriptionStatus as the first entry |
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) Max Binding: AllLanguages: IETF language tag | |
identifier | Σ | 0..1 | Identifier | Persistent identifier for the bundle |
type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: history |
timestamp | Σ | 0..1 | instant | When the bundle was assembled |
total | ΣI | 0..1 | unsignedInt | If search, the total number of matches |
link | Σ | 0..* | BackboneElement | Links related to this Bundle |
id | 0..1 | id | 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 |
relation | Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 |
url | Σ | 1..1 | uri | Reference details for the link |
Slices for entry | ΣI | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
entry:All Slices | Content/Rules for all slices | |||
id | 0..1 | id | 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 |
link | Σ | 0..* | See link (Bundle) | Links related to this entry |
fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
resource | Σ | 0..1 | Resource | A resource in the bundle |
search | ΣI | 0..1 | BackboneElement | Search related information |
id | 0..1 | id | 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 |
mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. |
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) |
request | ΣI | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
id | 0..1 | id | 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 |
method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
ifNoneMatch | Σ | 0..1 | string | For managing cache currency |
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency |
ifMatch | Σ | 0..1 | string | For managing update contention |
ifNoneExist | Σ | 0..1 | string | For conditional creates |
response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
id | 0..1 | id | 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 |
status | Σ | 1..1 | string | Status response code (text optional) |
location | Σ | 0..1 | uri | The location (if the operation returns a location) |
etag | Σ | 0..1 | string | The Etag for the resource (if relevant) |
lastModified | Σ | 0..1 | instant | Server's date time modified |
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
entry:subscriptionStatus | SΣI | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
id | 0..1 | id | 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 |
link | Σ | 0..* | See link (Bundle) | Links related to this entry |
fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
resource | SΣ | 1..1 | SubscriptionStatus | A resource in the bundle |
search | ΣI | 0..1 | BackboneElement | Search related information |
id | 0..1 | id | 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 |
mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. |
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) |
request | ΣI | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
id | 0..1 | id | 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 |
method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
ifNoneMatch | Σ | 0..1 | string | For managing cache currency |
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency |
ifMatch | Σ | 0..1 | string | For managing update contention |
ifNoneExist | Σ | 0..1 | string | For conditional creates |
response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
id | 0..1 | id | 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 |
status | Σ | 1..1 | string | Status response code (text optional) |
location | Σ | 0..1 | uri | The location (if the operation returns a location) |
etag | Σ | 0..1 | string | The Etag for the resource (if relevant) |
lastModified | Σ | 0..1 | instant | Server's date time modified |
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
signature | Σ | 0..1 | Signature | Digital Signature |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | I | 0..* | Bundle | Contains a collection of resources backport-notification-bundle-1: A notification bundle MUST have a SubscriptionStatus as the first entry |
entry:subscriptionStatus | ΣI | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
resource | Σ | 1..1 | SubscriptionStatus | A resource in the bundle |
Documentation for this format |
This structure is derived from Bundle
Summary
Mandatory: 3 elements
Must-Support: 2 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Bundle
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | I | 0..* | Bundle | Contains a collection of resources backport-notification-bundle-1: A notification bundle MUST have a SubscriptionStatus as the first entry |
type | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Required Pattern: history | |
Slices for entry | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource | |
entry:subscriptionStatus | S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information |
resource | S | 1..1 | SubscriptionStatus | A resource in the bundle |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | I | 0..* | Bundle | Contains a collection of resources backport-notification-bundle-1: A notification bundle MUST have a SubscriptionStatus as the first entry |
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) Max Binding: AllLanguages: IETF language tag | |
identifier | Σ | 0..1 | Identifier | Persistent identifier for the bundle |
type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: history |
timestamp | Σ | 0..1 | instant | When the bundle was assembled |
total | ΣI | 0..1 | unsignedInt | If search, the total number of matches |
link | Σ | 0..* | BackboneElement | Links related to this Bundle |
id | 0..1 | id | 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 |
relation | Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 |
url | Σ | 1..1 | uri | Reference details for the link |
Slices for entry | ΣI | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
entry:All Slices | Content/Rules for all slices | |||
id | 0..1 | id | 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 |
link | Σ | 0..* | See link (Bundle) | Links related to this entry |
fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
resource | Σ | 0..1 | Resource | A resource in the bundle |
search | ΣI | 0..1 | BackboneElement | Search related information |
id | 0..1 | id | 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 |
mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. |
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) |
request | ΣI | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
id | 0..1 | id | 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 |
method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
ifNoneMatch | Σ | 0..1 | string | For managing cache currency |
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency |
ifMatch | Σ | 0..1 | string | For managing update contention |
ifNoneExist | Σ | 0..1 | string | For conditional creates |
response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
id | 0..1 | id | 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 |
status | Σ | 1..1 | string | Status response code (text optional) |
location | Σ | 0..1 | uri | The location (if the operation returns a location) |
etag | Σ | 0..1 | string | The Etag for the resource (if relevant) |
lastModified | Σ | 0..1 | instant | Server's date time modified |
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
entry:subscriptionStatus | SΣI | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
id | 0..1 | id | 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 |
link | Σ | 0..* | See link (Bundle) | Links related to this entry |
fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
resource | SΣ | 1..1 | SubscriptionStatus | A resource in the bundle |
search | ΣI | 0..1 | BackboneElement | Search related information |
id | 0..1 | id | 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 |
mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. |
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) |
request | ΣI | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
id | 0..1 | id | 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 |
method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
ifNoneMatch | Σ | 0..1 | string | For managing cache currency |
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency |
ifMatch | Σ | 0..1 | string | For managing update contention |
ifNoneExist | Σ | 0..1 | string | For conditional creates |
response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
id | 0..1 | id | 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 |
status | Σ | 1..1 | string | Status response code (text optional) |
location | Σ | 0..1 | uri | The location (if the operation returns a location) |
etag | Σ | 0..1 | string | The Etag for the resource (if relevant) |
lastModified | Σ | 0..1 | instant | Server's date time modified |
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
signature | Σ | 0..1 | Signature | Digital Signature |
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet / Code |
Bundle.language | preferred | CommonLanguages Max Binding: AllLanguages |
Bundle.type | required | Pattern: history |
Bundle.entry.search.mode | required | SearchEntryMode |
Bundle.entry.request.method | required | HTTPVerb |
Bundle.entry:subscriptionStatus.search.mode | required | SearchEntryMode |
Bundle.entry:subscriptionStatus.request.method | required | HTTPVerb |
Id | Path | Details | Requirements |
backport-notification-bundle-1 | Bundle | A notification bundle MUST have a SubscriptionStatus as the first entry : entry.first().resource.is(SubscriptionStatus) |