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

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

Extension: ExtensionCapabilityStatement_Messaging_Event - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the ext-R3-CapabilityStatement.mes.event extension.

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

0. Extension
Definition

STU3: CapabilityStatement.messaging.event (new:BackboneElement)


Optional Extension Element - found in all resources.

ShortSTU3: Declare support for this event (new)Optional Extensions Element
Comments

Element CapabilityStatement.messaging.event has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). The same event may be listed up to two times - once as sender and once as receiver.

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
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 unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
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 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.

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

Control50..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
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
  • 4. Extension.extension:code
    Slice Namecode
    Definition

    STU3: CapabilityStatement.messaging.event.code (new:Coding)

    ShortSTU3: Event type (new)Additional content defined by implementations
    Comments

    Element CapabilityStatement.messaging.event.code is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.code has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.code has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

    Control10..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element CapabilityStatement.messaging.event.code is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.code has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.code has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

    Invariantsele-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:code.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
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuecode
    8. Extension.extension:code.value[x]
    Definition

    A coded identifier of a supported messaging event.


    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    ShortEvent typeValue of extension
    Control10..1
    BindingFor example codes, see For codes, see MessageEvent
    (example to http://hl7.org/fhir/ValueSet/message-events|4.3.0)

    One of the message events defined as part of FHIR.

    TypeCoding, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Summaryfalse
    Invariantsele-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:category
    Slice Namecategory
    Definition

    STU3: CapabilityStatement.messaging.event.category (new:code)

    ShortSTU3: Consequence | Currency | Notification (new)Additional content defined by implementations
    Comments

    Element CapabilityStatement.messaging.event.category is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.category has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.category has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

    Control0..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element CapabilityStatement.messaging.event.category is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.category has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.category has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

    Invariantsele-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:category.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
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuecategory
    14. Extension.extension:category.value[x]
    Definition

    The impact of the content of the message.


    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    ShortConsequence | Currency | NotificationValue of extension
    Control0..1
    BindingThe codes SHALL be taken from For codes, see MessageSignificanceCategory
    (required to http://hl7.org/fhir/ValueSet/message-significance-category|4.3.0)

    The impact of the content of a message.

    Typecode, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-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:mode
    Slice Namemode
    Definition

    STU3: CapabilityStatement.messaging.event.mode (new:code)

    ShortSTU3: sender | receiver (new)Additional content defined by implementations
    Comments

    Element CapabilityStatement.messaging.event.mode is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.mode has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.mode has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

    Control10..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element CapabilityStatement.messaging.event.mode is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.mode has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.mode has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

    Invariantsele-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:mode.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
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuemode
    20. Extension.extension:mode.value[x]
    Definition

    The mode of this event declaration - whether an application is a sender or receiver.


    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    Shortsender | receiverValue of extension
    Control10..1
    BindingThe codes SHALL be taken from For codes, see EventCapabilityMode
    (required to http://hl7.org/fhir/ValueSet/event-capability-mode|4.3.0)

    The mode of a message capability statement.

    Typecode, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-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:focus
    Slice Namefocus
    Definition

    STU3: CapabilityStatement.messaging.event.focus (new:code)

    ShortSTU3: Resource that's focus of message (new)Additional content defined by implementations
    Comments

    Element CapabilityStatement.messaging.event.focus is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.focus has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.focus has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). This SHALL be provided if the event type supports multiple different resource types.

    Control10..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element CapabilityStatement.messaging.event.focus is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.focus has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.focus has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

    Invariantsele-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:focus.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
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuefocus
    26. Extension.extension:focus.value[x]
    Definition

    A resource associated with the event. This is the resource that defines the event.


    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    ShortResource that's focus of messageValue of extension
    Comments

    This SHALL be provided if the event type supports multiple different resource types.

    Control10..1
    BindingThe codes SHALL be taken from For codes, see R3ResourceTypesForR4B (0.1.0)
    (required to http://hl7.org/fhir/uv/xver/ValueSet/R3-resource-types-for-R4B|0.1.0)

    One of the resource types defined as part of FHIR.

    Typecode, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-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.extension:request
    Slice Namerequest
    Definition

    STU3: CapabilityStatement.messaging.event.request (new:Reference(StructureDefinition))

    ShortSTU3: Profile that describes the request (new)Additional content defined by implementations
    Comments

    Element CapabilityStatement.messaging.event.request is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.request has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.request has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

    Control10..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element CapabilityStatement.messaging.event.request is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.request has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.request has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

    Invariantsele-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())
    30. Extension.extension:request.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
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuerequest
    32. Extension.extension:request.value[x]
    Definition

    Information about the request for this event.


    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    ShortProfile that describes the requestValue of extension
    Control10..1
    TypeReference(Cross-version Profile for STU3.StructureDefinition for use in FHIR R4B, StructureDefinition), date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Summaryfalse
    Invariantsele-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()))
    34. Extension.extension:response
    Slice Nameresponse
    Definition

    STU3: CapabilityStatement.messaging.event.response (new:Reference(StructureDefinition))

    ShortSTU3: Profile that describes the response (new)Additional content defined by implementations
    Comments

    Element CapabilityStatement.messaging.event.response is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.response has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.response has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

    Control10..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element CapabilityStatement.messaging.event.response is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.response has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.response has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

    Invariantsele-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())
    36. Extension.extension:response.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
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valueresponse
    38. Extension.extension:response.value[x]
    Definition

    Information about the response for this event.


    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    ShortProfile that describes the responseValue of extension
    Control10..1
    TypeReference(Cross-version Profile for STU3.StructureDefinition for use in FHIR R4B, StructureDefinition), date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Summaryfalse
    Invariantsele-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()))
    40. Extension.extension:documentation
    Slice Namedocumentation
    Definition

    STU3: CapabilityStatement.messaging.event.documentation (new:string)

    ShortSTU3: Endpoint-specific event documentation (new)Additional content defined by implementations
    Comments

    Element CapabilityStatement.messaging.event.documentation is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.documentation has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.documentation has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

    Control0..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element CapabilityStatement.messaging.event.documentation is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.documentation has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.documentation has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

    Invariantsele-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())
    42. Extension.extension:documentation.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
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuedocumentation
    44. Extension.extension:documentation.value[x]
    Definition

    Guidance on how this event is handled, such as internal system trigger points, business rules, etc.


    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    ShortEndpoint-specific event documentationValue of extension
    Control0..1
    Typestring, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-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()))
    46. 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
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuehttp://hl7.org/fhir/3.0/StructureDefinition/extension-CapabilityStatement.messaging.event
    48. Extension.value[x]
    Definition

    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    ShortValue of extension
    Control0..01
    TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, 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, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-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: CapabilityStatement.messaging.event (new:BackboneElement)

    ShortSTU3: Declare support for this event (new)
    Comments

    Element CapabilityStatement.messaging.event has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). The same event may be listed up to two times - once as sender and once as receiver.

    Control0..*
    Is Modifierfalse
    2. Extension.extension
    Control5..*
    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
    • 4. Extension.extension:code
      Slice Namecode
      Definition

      STU3: CapabilityStatement.messaging.event.code (new:Coding)

      ShortSTU3: Event type (new)
      Comments

      Element CapabilityStatement.messaging.event.code is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.code has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.code has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

      Control1..1
      Requirements

      Element CapabilityStatement.messaging.event.code is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.code has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.code has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

      6. Extension.extension:code.url
      Control1..1
      Fixed Valuecode
      8. Extension.extension:code.value[x]
      Definition

      A coded identifier of a supported messaging event.

      ShortEvent type
      Control1..1
      BindingFor example codes, see MessageEvent
      (example to http://hl7.org/fhir/ValueSet/message-events|4.3.0)

      One of the message events defined as part of FHIR.

      TypeCoding
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      10. Extension.extension:category
      Slice Namecategory
      Definition

      STU3: CapabilityStatement.messaging.event.category (new:code)

      ShortSTU3: Consequence | Currency | Notification (new)
      Comments

      Element CapabilityStatement.messaging.event.category is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.category has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.category has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

      Control0..1
      Requirements

      Element CapabilityStatement.messaging.event.category is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.category has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.category has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

      12. Extension.extension:category.url
      Control1..1
      Fixed Valuecategory
      14. Extension.extension:category.value[x]
      Definition

      The impact of the content of the message.

      ShortConsequence | Currency | Notification
      Control0..1
      BindingThe codes SHALL be taken from MessageSignificanceCategory
      (required to http://hl7.org/fhir/ValueSet/message-significance-category|4.3.0)

      The impact of the content of a message.

      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
      16. Extension.extension:mode
      Slice Namemode
      Definition

      STU3: CapabilityStatement.messaging.event.mode (new:code)

      ShortSTU3: sender | receiver (new)
      Comments

      Element CapabilityStatement.messaging.event.mode is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.mode has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.mode has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

      Control1..1
      Requirements

      Element CapabilityStatement.messaging.event.mode is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.mode has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.mode has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

      18. Extension.extension:mode.url
      Control1..1
      Fixed Valuemode
      20. Extension.extension:mode.value[x]
      Definition

      The mode of this event declaration - whether an application is a sender or receiver.

      Shortsender | receiver
      Control1..1
      BindingThe codes SHALL be taken from EventCapabilityMode
      (required to http://hl7.org/fhir/ValueSet/event-capability-mode|4.3.0)

      The mode of a message capability statement.

      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
      22. Extension.extension:focus
      Slice Namefocus
      Definition

      STU3: CapabilityStatement.messaging.event.focus (new:code)

      ShortSTU3: Resource that's focus of message (new)
      Comments

      Element CapabilityStatement.messaging.event.focus is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.focus has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.focus has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). This SHALL be provided if the event type supports multiple different resource types.

      Control1..1
      Requirements

      Element CapabilityStatement.messaging.event.focus is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.focus has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.focus has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

      24. Extension.extension:focus.url
      Control1..1
      Fixed Valuefocus
      26. Extension.extension:focus.value[x]
      Definition

      A resource associated with the event. This is the resource that defines the event.

      ShortResource that's focus of message
      Comments

      This SHALL be provided if the event type supports multiple different resource types.

      Control1..1
      BindingThe codes SHALL be taken from R3ResourceTypesForR4B (0.1.0)
      (required to http://hl7.org/fhir/uv/xver/ValueSet/R3-resource-types-for-R4B|0.1.0)

      One of the resource types defined as part of FHIR.

      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
      28. Extension.extension:request
      Slice Namerequest
      Definition

      STU3: CapabilityStatement.messaging.event.request (new:Reference(StructureDefinition))

      ShortSTU3: Profile that describes the request (new)
      Comments

      Element CapabilityStatement.messaging.event.request is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.request has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.request has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

      Control1..1
      Requirements

      Element CapabilityStatement.messaging.event.request is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.request has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.request has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

      30. Extension.extension:request.url
      Control1..1
      Fixed Valuerequest
      32. Extension.extension:request.value[x]
      Definition

      Information about the request for this event.

      ShortProfile that describes the request
      Control1..1
      TypeReference(Cross-version Profile for STU3.StructureDefinition for use in FHIR R4B, StructureDefinition)
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      34. Extension.extension:response
      Slice Nameresponse
      Definition

      STU3: CapabilityStatement.messaging.event.response (new:Reference(StructureDefinition))

      ShortSTU3: Profile that describes the response (new)
      Comments

      Element CapabilityStatement.messaging.event.response is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.response has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.response has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

      Control1..1
      Requirements

      Element CapabilityStatement.messaging.event.response is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.response has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.response has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

      36. Extension.extension:response.url
      Control1..1
      Fixed Valueresponse
      38. Extension.extension:response.value[x]
      Definition

      Information about the response for this event.

      ShortProfile that describes the response
      Control1..1
      TypeReference(Cross-version Profile for STU3.StructureDefinition for use in FHIR R4B, StructureDefinition)
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      40. Extension.extension:documentation
      Slice Namedocumentation
      Definition

      STU3: CapabilityStatement.messaging.event.documentation (new:string)

      ShortSTU3: Endpoint-specific event documentation (new)
      Comments

      Element CapabilityStatement.messaging.event.documentation is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.documentation has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.documentation has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

      Control0..1
      Requirements

      Element CapabilityStatement.messaging.event.documentation is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.documentation has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.documentation has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

      42. Extension.extension:documentation.url
      Control1..1
      Fixed Valuedocumentation
      44. Extension.extension:documentation.value[x]
      Definition

      Guidance on how this event is handled, such as internal system trigger points, business rules, etc.

      ShortEndpoint-specific event documentation
      Control0..1
      Typestring
      [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
      46. Extension.url
      Control1..1
      Fixed Valuehttp://hl7.org/fhir/3.0/StructureDefinition/extension-CapabilityStatement.messaging.event
      48. Extension.value[x]
      Control0..0

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

      0. Extension
      Definition

      STU3: CapabilityStatement.messaging.event (new:BackboneElement)

      ShortSTU3: Declare support for this event (new)
      Comments

      Element CapabilityStatement.messaging.event has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). The same event may be listed up to two times - once as sender and once as receiver.

      Control0..*
      This element is affected by the following invariants: ele-1
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
      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.

      ShortUnique id for inter-element referencing
      Control0..1
      Typeid
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      4. Extension.extension
      Definition

      An Extension

      ShortExtension
      Control5..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Invariantsele-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())
      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.extension:code
        Slice Namecode
        Definition

        STU3: CapabilityStatement.messaging.event.code (new:Coding)

        ShortSTU3: Event type (new)
        Comments

        Element CapabilityStatement.messaging.event.code is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.code has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.code has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

        Control1..1
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Requirements

        Element CapabilityStatement.messaging.event.code is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.code has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.code has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

        Invariantsele-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:code.id
        Definition

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

        ShortUnique id for inter-element referencing
        Control0..1
        Typeid
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        10. Extension.extension:code.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.

        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
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-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())
        SlicingThis 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:code.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
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          Fixed Valuecode
          14. Extension.extension:code.value[x]
          Definition

          A coded identifier of a supported messaging event.

          ShortEvent type
          Control1..1
          BindingFor example codes, see MessageEvent
          (example to http://hl7.org/fhir/ValueSet/message-events|4.3.0)

          One of the message events defined as part of FHIR.

          TypeCoding
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          16. Extension.extension:category
          Slice Namecategory
          Definition

          STU3: CapabilityStatement.messaging.event.category (new:code)

          ShortSTU3: Consequence | Currency | Notification (new)
          Comments

          Element CapabilityStatement.messaging.event.category is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.category has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.category has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

          Control0..1
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Requirements

          Element CapabilityStatement.messaging.event.category is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.category has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.category has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

          Invariantsele-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:category.id
          Definition

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

          ShortUnique id for inter-element referencing
          Control0..1
          Typeid
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          20. Extension.extension:category.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.

          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
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-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())
          SlicingThis 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:category.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
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            Fixed Valuecategory
            24. Extension.extension:category.value[x]
            Definition

            The impact of the content of the message.

            ShortConsequence | Currency | Notification
            Control0..1
            BindingThe codes SHALL be taken from MessageSignificanceCategory
            (required to http://hl7.org/fhir/ValueSet/message-significance-category|4.3.0)

            The impact of the content of a message.

            Typecode
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            26. Extension.extension:mode
            Slice Namemode
            Definition

            STU3: CapabilityStatement.messaging.event.mode (new:code)

            ShortSTU3: sender | receiver (new)
            Comments

            Element CapabilityStatement.messaging.event.mode is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.mode has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.mode has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

            Control1..1
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Requirements

            Element CapabilityStatement.messaging.event.mode is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.mode has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.mode has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

            Invariantsele-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:mode.id
            Definition

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

            ShortUnique id for inter-element referencing
            Control0..1
            Typeid
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            30. Extension.extension:mode.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.

            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
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-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())
            SlicingThis 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:mode.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
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              Fixed Valuemode
              34. Extension.extension:mode.value[x]
              Definition

              The mode of this event declaration - whether an application is a sender or receiver.

              Shortsender | receiver
              Control1..1
              BindingThe codes SHALL be taken from EventCapabilityMode
              (required to http://hl7.org/fhir/ValueSet/event-capability-mode|4.3.0)

              The mode of a message capability statement.

              Typecode
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              36. Extension.extension:focus
              Slice Namefocus
              Definition

              STU3: CapabilityStatement.messaging.event.focus (new:code)

              ShortSTU3: Resource that's focus of message (new)
              Comments

              Element CapabilityStatement.messaging.event.focus is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.focus has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.focus has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). This SHALL be provided if the event type supports multiple different resource types.

              Control1..1
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Requirements

              Element CapabilityStatement.messaging.event.focus is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.focus has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.focus has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

              Invariantsele-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:focus.id
              Definition

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

              ShortUnique id for inter-element referencing
              Control0..1
              Typeid
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              40. Extension.extension:focus.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.

              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
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-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())
              SlicingThis 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:focus.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
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                Fixed Valuefocus
                44. Extension.extension:focus.value[x]
                Definition

                A resource associated with the event. This is the resource that defines the event.

                ShortResource that's focus of message
                Comments

                This SHALL be provided if the event type supports multiple different resource types.

                Control1..1
                BindingThe codes SHALL be taken from R3ResourceTypesForR4B (0.1.0)
                (required to http://hl7.org/fhir/uv/xver/ValueSet/R3-resource-types-for-R4B|0.1.0)

                One of the resource types defined as part of FHIR.

                Typecode
                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                46. Extension.extension:request
                Slice Namerequest
                Definition

                STU3: CapabilityStatement.messaging.event.request (new:Reference(StructureDefinition))

                ShortSTU3: Profile that describes the request (new)
                Comments

                Element CapabilityStatement.messaging.event.request is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.request has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.request has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

                Control1..1
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Requirements

                Element CapabilityStatement.messaging.event.request is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.request has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.request has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

                Invariantsele-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())
                48. Extension.extension:request.id
                Definition

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

                ShortUnique id for inter-element referencing
                Control0..1
                Typeid
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                50. Extension.extension:request.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.

                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
                Is Modifierfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-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())
                SlicingThis 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
                • 52. Extension.extension:request.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
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  Fixed Valuerequest
                  54. Extension.extension:request.value[x]
                  Definition

                  Information about the request for this event.

                  ShortProfile that describes the request
                  Control1..1
                  TypeReference(Cross-version Profile for STU3.StructureDefinition for use in FHIR R4B, StructureDefinition)
                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                  Is Modifierfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  56. Extension.extension:response
                  Slice Nameresponse
                  Definition

                  STU3: CapabilityStatement.messaging.event.response (new:Reference(StructureDefinition))

                  ShortSTU3: Profile that describes the response (new)
                  Comments

                  Element CapabilityStatement.messaging.event.response is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.response has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.response has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

                  Control1..1
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Requirements

                  Element CapabilityStatement.messaging.event.response is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.response has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.response has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

                  Invariantsele-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())
                  58. Extension.extension:response.id
                  Definition

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

                  ShortUnique id for inter-element referencing
                  Control0..1
                  Typeid
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  60. Extension.extension:response.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.

                  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
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-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())
                  SlicingThis 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
                  • 62. Extension.extension:response.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
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    Fixed Valueresponse
                    64. Extension.extension:response.value[x]
                    Definition

                    Information about the response for this event.

                    ShortProfile that describes the response
                    Control1..1
                    TypeReference(Cross-version Profile for STU3.StructureDefinition for use in FHIR R4B, StructureDefinition)
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    66. Extension.extension:documentation
                    Slice Namedocumentation
                    Definition

                    STU3: CapabilityStatement.messaging.event.documentation (new:string)

                    ShortSTU3: Endpoint-specific event documentation (new)
                    Comments

                    Element CapabilityStatement.messaging.event.documentation is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.documentation has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.documentation has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

                    Control0..1
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

                    Element CapabilityStatement.messaging.event.documentation is part of an existing definition because parent element CapabilityStatement.messaging.event requires a cross-version extension. Element CapabilityStatement.messaging.event.documentation has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to CapabilityStatement. Element CapabilityStatement.messaging.event.documentation has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

                    Invariantsele-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())
                    68. Extension.extension:documentation.id
                    Definition

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

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typeid
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    70. Extension.extension:documentation.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.

                    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
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesextensions, user content
                    Invariantsele-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())
                    SlicingThis 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
                    • 72. Extension.extension:documentation.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
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      Fixed Valuedocumentation
                      74. Extension.extension:documentation.value[x]
                      Definition

                      Guidance on how this event is handled, such as internal system trigger points, business rules, etc.

                      ShortEndpoint-specific event documentation
                      Control0..1
                      Typestring
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      76. 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
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      Fixed Valuehttp://hl7.org/fhir/3.0/StructureDefinition/extension-CapabilityStatement.messaging.event
                      78. Extension.value[x]
                      Definition

                      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                      ShortValue of extension
                      Control0..0
                      TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, 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, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))