ExtensionSubscription_Channel - Definitions - Extensions for Using Data Elements from FHIR STU3 in FHIR R5 v0.1.0

Extensions for Using Data Elements from FHIR STU3 in FHIR R5 - Downloaded Version null See the Directory of published versions

Extension: ExtensionSubscription_Channel - Detailed Descriptions

Page standards status: Trial-use

Maturity Level: 0

Definitions for the ext-R3-Subscription.channel extension.

Key Elements Table
Differential Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. Extension
Definition	STU3: `Subscription.channel` (new:BackboneElement) Optional Extension Element - found in all resources.
Short	STU3: The channel on which to report matches to the criteria (new)Optional Extensions Element
Comments	Element `Subscription.channel` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).
Control	10..1*
Is Modifier	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()`) 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())
2. Extension.extension
Definition	An Extension 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 managable, 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	ExtensionAdditional content defined by implementations
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	10..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
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()`) 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 `Extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
4. Extension.extension:type
Slice Name	type
Definition	STU3: `Subscription.channel.type` (new:code)
Short	STU3: rest-hook \| websocket \| email \| sms \| message (new)Additional content defined by implementations
Comments	Element `Subscription.channel.type` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.type` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.type` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).
Control	10..1*
Type	Extension
Is Modifier	false
Summary	false
Requirements	Element `Subscription.channel.type` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.type` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.type` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).
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()`) 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())
6. Extension.extension:type.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`type`
8. Extension.extension:type.value[x]
Definition	The type of channel to send notifications on. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	rest-hook \| websocket \| email \| sms \| messageValue of extension
Control	10..1 This element is affected by the following invariants: ext-1
Binding	The codes SHALL be taken from For codes, see SubscriptionChannelType (required to `http://hl7.org/fhir/ValueSet/subscription-channel-type\|5.0.0`) The type of method used to execute a subscription.
Type	code, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
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())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Extension.extension:endpoint
Slice Name	endpoint
Definition	STU3: `Subscription.channel.endpoint` (new:uri)
Short	STU3: Where the channel points to (new)Additional content defined by implementations
Comments	Element `Subscription.channel.endpoint` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.endpoint` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.endpoint` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). 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 their may be more than one, clients should avoid using relative URIs).
Control	0..1*
Type	Extension
Is Modifier	false
Summary	false
Requirements	Element `Subscription.channel.endpoint` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.endpoint` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.endpoint` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).
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()`) 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())
12. Extension.extension:endpoint.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`endpoint`
14. Extension.extension:endpoint.value[x]
Definition	The uri that describes the actual end-point to send messages to. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Where the channel points toValue of extension
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 their may be more than one, clients should avoid using relative URIs).
Control	0..1 This element is affected by the following invariants: ext-1
Type	uri, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
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())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Extension.extension:payload
Slice Name	payload
Definition	STU3: `Subscription.channel.payload` (new:string)
Short	STU3: Mimetype to send, or omit for no payload (new)Additional content defined by implementations
Comments	Element `Subscription.channel.payload` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.payload` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.payload` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.
Control	0..1*
Type	Extension
Is Modifier	false
Summary	false
Requirements	Element `Subscription.channel.payload` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.payload` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.payload` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).
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()`) 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())
18. Extension.extension:payload.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`payload`
20. Extension.extension:payload.value[x]
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. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Mimetype to send, or omit for no payloadValue of extension
Comments	Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.
Control	0..1 This element is affected by the following invariants: ext-1
Type	string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
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())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Extension.extension:header
Slice Name	header
Definition	STU3: `Subscription.channel.header` (new:string)
Short	STU3: Usage depends on the channel type (new)Additional content defined by implementations
Comments	Element `Subscription.channel.header` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.header` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.header` has no mapping targets in FHIR R5. 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 recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions.
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Requirements	Element `Subscription.channel.header` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.header` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.header` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).
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()`) 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())
24. Extension.extension:header.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`header`
26. Extension.extension:header.value[x]
Definition	Additional headers / information to send as part of the notification. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Usage depends on the channel typeValue of extension
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..1 This element is affected by the following invariants: ext-1
Type	string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
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())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`http://hl7.org/fhir/3.0/StructureDefinition/extension-Subscription.channel`
30. Extension.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	0..01 This element is affected by the following invariants: ext-1
Type	Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta
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())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. Extension
Definition	STU3: `Subscription.channel` (new:BackboneElement)
Short	STU3: The channel on which to report matches to the criteria (new)
Comments	Element `Subscription.channel` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).
Control	1..1
Is Modifier	false
2. Extension.extension
Control	1..*
Slicing	This element introduces a set of slices on `Extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
4. Extension.extension:type
Slice Name	type
Definition	STU3: `Subscription.channel.type` (new:code)
Short	STU3: rest-hook \| websocket \| email \| sms \| message (new)
Comments	Element `Subscription.channel.type` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.type` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.type` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).
Control	1..1
Requirements	Element `Subscription.channel.type` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.type` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.type` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).
6. Extension.extension:type.url
Control	1..1
Fixed Value	`type`
8. Extension.extension:type.value[x]
Definition	The type of channel to send notifications on.
Short	rest-hook \| websocket \| email \| sms \| message
Control	1..1
Binding	The codes SHALL be taken from SubscriptionChannelType (required to `http://hl7.org/fhir/ValueSet/subscription-channel-type\|5.0.0`) The type of method used to execute a subscription.
Type	code
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
10. Extension.extension:endpoint
Slice Name	endpoint
Definition	STU3: `Subscription.channel.endpoint` (new:uri)
Short	STU3: Where the channel points to (new)
Comments	Element `Subscription.channel.endpoint` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.endpoint` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.endpoint` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). 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 their may be more than one, clients should avoid using relative URIs).
Control	0..1
Requirements	Element `Subscription.channel.endpoint` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.endpoint` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.endpoint` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).
12. Extension.extension:endpoint.url
Control	1..1
Fixed Value	`endpoint`
14. Extension.extension:endpoint.value[x]
Definition	The uri 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 their may be more than one, clients should avoid using relative URIs).
Control	0..1
Type	uri
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
16. Extension.extension:payload
Slice Name	payload
Definition	STU3: `Subscription.channel.payload` (new:string)
Short	STU3: Mimetype to send, or omit for no payload (new)
Comments	Element `Subscription.channel.payload` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.payload` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.payload` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.
Control	0..1
Requirements	Element `Subscription.channel.payload` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.payload` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.payload` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).
18. Extension.extension:payload.url
Control	1..1
Fixed Value	`payload`
20. Extension.extension:payload.value[x]
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.
Short	Mimetype 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
Type	string
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
22. Extension.extension:header
Slice Name	header
Definition	STU3: `Subscription.channel.header` (new:string)
Short	STU3: Usage depends on the channel type (new)
Comments	Element `Subscription.channel.header` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.header` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.header` has no mapping targets in FHIR R5. 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 recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions.
Control	0..*
Requirements	Element `Subscription.channel.header` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.header` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.header` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).
24. Extension.extension:header.url
Control	1..1
Fixed Value	`header`
26. Extension.extension:header.value[x]
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..1
Type	string
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
28. Extension.url
Control	1..1
Fixed Value	`http://hl7.org/fhir/3.0/StructureDefinition/extension-Subscription.channel`
30. Extension.value[x]
Control	0..0

Guidance on how to interpret the contents of this table can be foundhere

0. Extension
Definition	STU3: `Subscription.channel` (new:BackboneElement)
Short	STU3: The channel on which to report matches to the criteria (new)
Comments	Element `Subscription.channel` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).
Control	1..1
Is Modifier	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()`)
2. Extension.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 This element is affected by the following invariants: ele-1
Type	id
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
4. Extension.extension
Definition	An Extension
Short	Extension
Control	1..*
Type	Extension
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 `Extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
6. Extension.extension:type
Slice Name	type
Definition	STU3: `Subscription.channel.type` (new:code)
Short	STU3: rest-hook \| websocket \| email \| sms \| message (new)
Comments	Element `Subscription.channel.type` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.type` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.type` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).
Control	1..1
Type	Extension
Is Modifier	false
Summary	false
Requirements	Element `Subscription.channel.type` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.type` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.type` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).
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()`)
8. Extension.extension:type.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 This element is affected by the following invariants: ele-1
Type	id
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
10. Extension.extension:type.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 managable, 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	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..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
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 `Extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
12. Extension.extension:type.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`type`
14. Extension.extension:type.value[x]
Definition	The type of channel to send notifications on.
Short	rest-hook \| websocket \| email \| sms \| message
Control	1..1 This element is affected by the following invariants: ext-1
Binding	The codes SHALL be taken from SubscriptionChannelType (required to `http://hl7.org/fhir/ValueSet/subscription-channel-type\|5.0.0`) The type of method used to execute a subscription.
Type	code
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
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())`)
16. Extension.extension:endpoint
Slice Name	endpoint
Definition	STU3: `Subscription.channel.endpoint` (new:uri)
Short	STU3: Where the channel points to (new)
Comments	Element `Subscription.channel.endpoint` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.endpoint` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.endpoint` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). 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 their may be more than one, clients should avoid using relative URIs).
Control	0..1
Type	Extension
Is Modifier	false
Summary	false
Requirements	Element `Subscription.channel.endpoint` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.endpoint` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.endpoint` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).
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()`)
18. Extension.extension:endpoint.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 This element is affected by the following invariants: ele-1
Type	id
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
20. Extension.extension:endpoint.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 managable, 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	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..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
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 `Extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
22. Extension.extension:endpoint.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`endpoint`
24. Extension.extension:endpoint.value[x]
Definition	The uri 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 their may be more than one, clients should avoid using relative URIs).
Control	0..1 This element is affected by the following invariants: ext-1
Type	uri
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
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())`)
26. Extension.extension:payload
Slice Name	payload
Definition	STU3: `Subscription.channel.payload` (new:string)
Short	STU3: Mimetype to send, or omit for no payload (new)
Comments	Element `Subscription.channel.payload` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.payload` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.payload` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.
Control	0..1
Type	Extension
Is Modifier	false
Summary	false
Requirements	Element `Subscription.channel.payload` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.payload` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.payload` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).
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()`)
28. Extension.extension:payload.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 This element is affected by the following invariants: ele-1
Type	id
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
30. Extension.extension:payload.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 managable, 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	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..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
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 `Extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
32. Extension.extension:payload.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`payload`
34. Extension.extension:payload.value[x]
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.
Short	Mimetype 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 This element is affected by the following invariants: ext-1
Type	string
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
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())`)
36. Extension.extension:header
Slice Name	header
Definition	STU3: `Subscription.channel.header` (new:string)
Short	STU3: Usage depends on the channel type (new)
Comments	Element `Subscription.channel.header` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.header` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.header` has no mapping targets in FHIR R5. 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 recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions.
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Requirements	Element `Subscription.channel.header` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.header` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.header` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).
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()`)
38. Extension.extension:header.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 This element is affected by the following invariants: ele-1
Type	id
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
40. Extension.extension:header.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 managable, 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	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..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
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 `Extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
42. Extension.extension:header.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`header`
44. Extension.extension:header.value[x]
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..1 This element is affected by the following invariants: ext-1
Type	string
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
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())`)
46. Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`http://hl7.org/fhir/3.0/StructureDefinition/extension-Subscription.channel`
48. Extension.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	0..0 This element is affected by the following invariants: ext-1
Type	Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta
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())`)