Profile_R5_Subscription_R4 - Definitions - Extensions for Using Data Elements from FHIR R5 in FHIR R4 v0.1.0

Is Modifier false

Summary true

4. Subscription.meta

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Short Metadata about the resource

Control 0..1

Meta

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

6. Subscription.implicitRules

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Short A set of rules under which this content was created

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control 0..1

uri

Is Modifier true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

8. Subscription.language

Definition

The base language in which the resource is written.

Short Language of the resource content

Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control 0..1

The codes SHOULD be taken from CommonLanguages

(preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

A human language.

Additional Bindings

Purpose

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

10. Subscription.text

Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Short Text summary of the resource, for human interpretation

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control 0..1

Narrative

Is Modifier false

Summary false

Alternate Names narrative, html, xhtml, display

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

12. Subscription.contained

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Short Contained, inline Resources

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Control 0..*

Resource

Is Modifier false

Summary false

Alternate Names inline resources, anonymous resources, contained resources

14. Subscription.extension

Definition

An Extension

Short Extension

Control 1..*

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

Slicing

This element introduces a set of slices on Subscription.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

16. Subscription.extension:identifier

Slice Name identifier

Definition

R5: Subscription.identifier (new:Identifier)

Short R5: Additional identifiers (business identifier) (new)

Comments

Element Subscription.identifier has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.identifier has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Additional identifiers (business identifier) (new)) (Extension Type: Identifier)

Is Modifier false

Summary false

18. Subscription.extension:name

Slice Name name

Definition

R5: Subscription.name (new:string)

Short R5: Human readable name for this subscription (new)

Comments

Element Subscription.name has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.name has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Human readable name for this subscription (new)) (Extension Type: string)

Is Modifier false

Summary false

20. Subscription.extension:topic

Slice Name topic

Definition

R5: Subscription.topic (new:canonical(SubscriptionTopic))

Short R5: Reference to the subscription topic being subscribed to (new)

Comments

Element Subscription.topic has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.topic has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Control 1..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Reference to the subscription topic being subscribed to (new)) (Extension Type: canonical(Cross-version Profile for R5.SubscriptionTopic for use in FHIR R4, Basic))

Is Modifier false

Summary false

22. Subscription.extension:managingEntity

Slice Name managingEntity

Definition

R5: Subscription.managingEntity (new:Reference(CareTeam,HealthcareService,Organization,RelatedPerson,Patient,Practitioner,PractitionerRole))

Short R5: Entity responsible for Subscription changes (new)

Comments

Element Subscription.managingEntity has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.managingEntity has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Entity responsible for Subscription changes (new)) (Extension Type: Reference(Cross-version Profile for R5.CareTeam for use in FHIR R4, CareTeam, Cross-version Profile for R5.HealthcareService for use in FHIR R4, HealthcareService, Cross-version Profile for R5.Organization for use in FHIR R4, Organization, Cross-version Profile for R5.RelatedPerson for use in FHIR R4, RelatedPerson, Cross-version Profile for R5.Patient for use in FHIR R4, Patient, Cross-version Profile for R5.Practitioner for use in FHIR R4, Practitioner, Cross-version Profile for R5.PractitionerRole for use in FHIR R4, PractitionerRole))

Is Modifier false

Summary false

24. Subscription.extension:filterBy

Slice Name filterBy

Definition

R5: Subscription.filterBy (new:BackboneElement)

Short R5: Criteria for narrowing the subscription topic stream (new)

Comments

Element Subscription.filterBy has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Criteria for narrowing the subscription topic stream (new)) (Complex Extension)

Is Modifier false

26. Subscription.extension:parameter

Slice Name parameter

Definition

R5: Subscription.parameter (new:BackboneElement)

Short R5: Channel type (new)

Comments

Element Subscription.parameter has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.parameter has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Exactly what these mean depend on the channel type. They can convey additional information to the server or recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions. Note that names are not required to be unique, but channel definitions can impose restrictions.

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Channel type (new)) (Complex Extension)

Is Modifier false

28. Subscription.extension:heartbeatPeriod

Slice Name heartbeatPeriod

Definition

R5: Subscription.heartbeatPeriod (new:unsignedInt)

Short R5: Interval in seconds to send 'heartbeat' notification (new)

Comments

Element Subscription.heartbeatPeriod has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.heartbeatPeriod has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element Subscription.heartbeatPeriod: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period.

Control 0..1

Type Extension(http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period)

Is Modifier false

Summary false

30. Subscription.extension:timeout

Slice Name timeout

Definition

R5: Subscription.timeout (new:unsignedInt)

Short R5: Timeout in seconds to attempt notification delivery (new)

Comments

Element Subscription.timeout has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.timeout has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element Subscription.timeout: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout.

Control 0..1

Type Extension(http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout)

Is Modifier false

Summary false

32. Subscription.extension:content

Slice Name content

Definition

R5: Subscription.content (new:code)

Short R5: empty | id-only | full-resource (new)

Comments

Element Subscription.content has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.content has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element Subscription.content: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content. Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.

Control 0..1

Type Extension(http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content)

Is Modifier false

Summary false

34. Subscription.extension:maxCount

Slice Name maxCount

Definition

R5: Subscription.maxCount (new:positiveInt)

Short R5: Maximum number of events that can be combined in a single notification (new)

Comments

Element Subscription.maxCount has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.maxCount has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element Subscription.maxCount: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count.

Control 0..1

Type Extension(http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count)

Is Modifier false

Summary false

36. Subscription.modifierExtension

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them

Summary false

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, user content

38. Subscription.status

Definition

The status of the subscription, which marks the server state for managing the subscription.

Short requested | active | error | off

Comments

A client can only submit subscription resources in the requested or off state. Only the server can move a subscription from requested to active, and then to error. Either the server or the client can turn a subscription off.

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Control 1..1

The codes SHALL be taken from SubscriptionStatus

(required to http://hl7.org/fhir/ValueSet/subscription-status|4.0.1)

The status of a subscription.

code

Is Modifier true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

40. Subscription.status.id

Definition

unique id for the element within a resource (for internal references)

Short xml:id (or equivalent in JSON)

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

42. Subscription.status.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

Slicing

This element introduces a set of slices on Subscription.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

44. Subscription.status.extension:status

Slice Name status

Definition

R5: Subscription.status

Short R5: requested | active | error | off | entered-in-error

Comments

Element Subscription.status is mapped to FHIR R4 element Subscription.status as SourceIsBroaderThanTarget. The target context Subscription.status is a modifier element, so this extension does not need to be defined as a modifier. A client can only submit subscription resources in the requested or off state. Only the server can move a subscription from requested to active, and then to error. Either the server or the client can turn a subscription off.

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: requested | active | error | off | entered-in-error) (Extension Type: code)

Is Modifier false

Summary false

46. Subscription.status.value

Definition

Primitive value for code

Short Primitive value for code

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

48. Subscription.contact

Definition

Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.

Short Contact details for source (e.g. troubleshooting)

Control 0..*

ContactPoint

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

50. Subscription.end

Definition

The time for the server to turn the subscription off.

Short When to automatically delete the subscription

Comments

The server is permitted to deviate from this time but should observe it.

Control 0..1

instant

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

52. Subscription.reason

Definition

A description of why this subscription is defined.

Short Description of why this subscription was created

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

54. Subscription.criteria

Definition

The rules that the server should use to determine when to generate notifications for this subscription.

Short Rule for server push

Comments

The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading "/".

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

56. Subscription.error

Definition

A record of the last error that occurred when the server processed a notification.

Short Latest error note

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

58. Subscription.channel

Definition

Details where to send notifications when resources are received that meet the criteria.

Short The channel on which to report matches to the criteria

Control 1..1

BackboneElement

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

60. Subscription.channel.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

62. Subscription.channel.extension

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

64. Subscription.channel.modifierExtension

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

66. Subscription.channel.type

Definition

The type of channel to send notifications on.

Short rest-hook | websocket | email | sms | message

Control 1..1

The codes SHALL be taken from SubscriptionChannelType
(required to http://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.1)

The type of method used to execute a subscription.

code

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

68. Subscription.channel.type.id

Definition

unique id for the element within a resource (for internal references)

Short xml:id (or equivalent in JSON)

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

70. Subscription.channel.type.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

Slicing

This element introduces a set of slices on Subscription.channel.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

72. Subscription.channel.type.extension:channelType

Slice Name channelType

Definition

R5: Subscription.channelType additional types (Coding) additional types from child elements (userSelected)

Short R5: Channel type for notifications additional types

Comments

Element Subscription.channelType is mapped to FHIR R4 element Subscription.channel.type as RelatedTo. The mappings for Subscription.channelType do not cover the following types: Coding. The mappings for Subscription.channelType do not cover the following types based on type expansion: userSelected. An externally-defined extension that has been mapped as the representation of FHIR R5 element Subscription.channelType: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type.

Control 0..1

Type Extension(http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type)

Is Modifier false

Summary false

74. Subscription.channel.type.value

Definition

Primitive value for code

Short Primitive value for code

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

76. Subscription.channel.endpoint

Definition

The url that describes the actual end-point to send messages to.

Short Where the channel points to

Comments

For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs).

Control 0..1

url

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

78. Subscription.channel.payload

Definition

The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification. The mime type "text/plain" may also be used for Email and SMS subscriptions.

Short MIME type to send, or omit for no payload

Comments

Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.

Control 0..1

The codes SHALL be taken from Mime Types
(required to http://hl7.org/fhir/ValueSet/mimetypes|4.0.1)

The mime type of an attachment. Any valid mime type is allowed.

code

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

80. Subscription.channel.header

Definition

Additional headers / information to send as part of the notification.

Short Usage depends on the channel type

Comments

Exactly what these mean depend on the channel type. They can convey additional information to the recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions.

Control 0..*