Extensions for Using Data Elements from FHIR R4 in FHIR STU3
0.1.0 - STU International flag

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

Extension: ExtensionSubscription_Channel_Payload - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the ext-R4-Subscription.cha.payload extension.

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

0. Extension
Definition

R4: Subscription.channel.payload


Optional Extension Element - found in all resources.

ShortR4: MIME type to send, or omit for no payloadOptional Extensions Element
Comments

Element Subscription.channel.payload is mapped to FHIR STU3 element Subscription.channel.payload as Equivalent. Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.

Control0..1*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (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() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

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

Control1..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed Valuehttp://hl7.org/fhir/4.0/StructureDefinition/extension-Subscription.channel.payload
4. Extension.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. The mime type "text/plain" may also be used for Email and SMS subscriptions.


Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

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

Control0..1
Typecode, date, dateTime, Meta, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

0. Extension
Definition

R4: Subscription.channel.payload

ShortR4: MIME type to send, or omit for no payload
Comments

Element Subscription.channel.payload is mapped to FHIR STU3 element Subscription.channel.payload as Equivalent. Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.

Control0..1
Is Modifierfalse
2. Extension.url
Control1..1
Fixed Valuehttp://hl7.org/fhir/4.0/StructureDefinition/extension-Subscription.channel.payload
4. Extension.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. The mime type "text/plain" may also be used for Email and SMS subscriptions.

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

Control0..1
Typecode, date, dateTime, Meta, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

0. Extension
Definition

R4: Subscription.channel.payload

ShortR4: MIME type to send, or omit for no payload
Comments

Element Subscription.channel.payload is mapped to FHIR STU3 element Subscription.channel.payload as Equivalent. Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.

Control0..1
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (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.

Shortxml:id (or equivalent in JSON)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
4. Extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
SlicingThis 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.url
    Definition

    Source of the definition for the extension code - a logical name or a URL.

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

    Control1..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Valuehttp://hl7.org/fhir/4.0/StructureDefinition/extension-Subscription.channel.payload
    8. Extension.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. The mime type "text/plain" may also be used for Email and SMS subscriptions.

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

    Control0..1
    Typecode
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension