SubscriptionChannel constructor

const SubscriptionChannel({ @JsonKey(name: 'id') FhirId? fhirId, @JsonKey(name: 'extension') List<FhirExtension>? extension_, List<FhirExtension>? modifierExtension, FhirCode? type, @JsonKey(name: '_type') Element? typeElement, FhirUrl? endpoint, @JsonKey(name: '_endpoint') Element? endpointElement, FhirCode? payload, @JsonKey(name: '_payload') Element? payloadElement, List<String>? header, @JsonKey(name: '_header') List<Element?>? headerElement, })

SubscriptionChannel The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system can take an appropriate action.

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

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 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.

modifierExtension 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).

type The type of channel to send notifications on.

typeElement Extensions for type

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

endpointElement Extensions for endpoint

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. The mime type "text/plain" may also be used for Email and SMS subscriptions.

payloadElement Extensions for payload

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

headerElement Extensions for header

Implementation

const factory SubscriptionChannel({
  /// [id] Unique id for the element within a resource (for internal
  ///  references). This may be any string value that does not contain spaces.
  @JsonKey(name: 'id') FhirId? fhirId,

  /// [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 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.
  @JsonKey(name: 'extension') List<FhirExtension>? extension_,

  /// [modifierExtension] 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).
  List<FhirExtension>? modifierExtension,

  /// [type] The type of channel to send notifications on.
  FhirCode? type,

  /// [typeElement] Extensions for type
  @JsonKey(name: '_type') Element? typeElement,

  /// [endpoint] The url that describes the actual end-point to send messages
  ///  to.
  FhirUrl? endpoint,

  /// [endpointElement] Extensions for endpoint
  @JsonKey(name: '_endpoint') Element? endpointElement,

  /// [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. The mime type "text/plain" may also be used for Email and
  ///  SMS subscriptions.
  FhirCode? payload,

  /// [payloadElement] Extensions for payload
  @JsonKey(name: '_payload') Element? payloadElement,

  /// [header] Additional headers / information to send as part of the
  ///  notification.
  List<String>? header,

  /// [headerElement] Extensions for header
  @JsonKey(name: '_header') List<Element?>? headerElement,
}) = _SubscriptionChannel;