Generated Narrative: StructureDefinition ext-R3-Subscription.channel Name Flags Card. Type Description & Constraints Extension 1..1 Extension(5.0.0) STU3: The channel on which to report matches to the criteria (new) #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:type 1..1 Extension STU3: rest-hook | websocket | email | sms | message (new) #xD; url 1..1 uri "type" #xD; value[x] 1..1 code rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. #xD; extension:endpoint 0..1 Extension STU3: Where the channel points to (new) #xD; url 1..1 uri "endpoint" #xD; value[x] 0..1 uri Where the channel points to #xD; extension:payload 0..1 Extension STU3: Mimetype to send, or omit for no payload (new) #xD; url 1..1 uri "payload" #xD; value[x] 0..1 string Mimetype to send, or omit for no payload #xD; extension:header 0..* Extension STU3: Usage depends on the channel type (new) #xD; url 1..1 uri "header" #xD; value[x] 0..1 string Usage depends on the channel type #xD; url 1..1 uri "http://hl7.org/fhir/3.0/StructureDefinition/extension-Subscription.channel" #xD; value[x] 0..0 Value of extension #xD; Documentation for this format
STU3: The channel on which to report matches to the criteria (new)
STU3: `Subscription.channel` (new:BackboneElement)
This extension is part of the cross-version definitions generated to enable use of the element `Subscription.channel` as defined in FHIR STU3 in FHIR R5. The source element is defined as: `Subscription.channel` 1..1 `BackboneElement` Across FHIR versions, the element set has been mapped as: * STU3: `Subscription.channel` 1..1 `BackboneElement` * R4: `Subscription.channel` 1..1 `BackboneElement` * R4B: `Subscription.channel` 1..1 `BackboneElement` Following are the generation technical 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).
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).
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Must have either extensions or value[x], not both
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
STU3: rest-hook | websocket | email | sms | message (new)
STU3: `Subscription.channel.type` (new:code)
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).
Additional content defined by implementations
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.
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.
Source of the definition for the extension code - a logical name or a URL.
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.
rest-hook | websocket | email | sms | message
The type of channel to send notifications on.
The type of method used to execute a subscription.
STU3: `Subscription.channel.endpoint` (new:uri)
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).
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).
The uri that describes the actual end-point to send messages to.
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).
STU3: Mimetype to send, or omit for no payload (new)
STU3: `Subscription.channel.payload` (new:string)
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.
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).
Mimetype to send, or omit for no payload
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.
Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.
STU3: Usage depends on the channel type (new)
STU3: `Subscription.channel.header` (new:string)
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.
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).
Additional headers / information to send as part of the notification.
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.
Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).