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

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

Extension: ExtensionSubscriptionStatus_NotificationEvent - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the ext-R5-SubscriptionStatus.notificationEvent extension.

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

0. Extension
Definition

R5: SubscriptionStatus.notificationEvent (new:BackboneElement)


Optional Extension Element - found in all resources.

ShortR5: Detailed information about any events relevant to this notification (new)Optional Extensions Element
Comments

Element SubscriptionStatus.notificationEvent is not mapped to FHIR R4, since FHIR R5 SubscriptionStatus is not mapped. Element SubscriptionStatus.notificationEvent has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
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())
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.

Control10..*
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:eventNumber
    Slice NameeventNumber
    Definition

    R5: SubscriptionStatus.notificationEvent.eventNumber (new:integer64)

    ShortR5: Sequencing index of this event (new)Additional content defined by implementations
    Comments

    Element SubscriptionStatus.notificationEvent.eventNumber is part of an existing definition because parent element SubscriptionStatus.notificationEvent requires a cross-version extension. Element SubscriptionStatus.notificationEvent.eventNumber is not mapped to FHIR R4, since FHIR R5 SubscriptionStatus is not mapped. Element SubscriptionStatus.notificationEvent.eventNumber has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). In subscriptions where delivery of notifications IS NOT guaranteed (e.g., REST-Hook), this number is a unique and monotonically-increasing event number for a subscription. In channels where delivery of notifications IS guaranteed, this number is a relative index for the events present in the notification (e.g., 1, 2, etc.).

    Control10..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element SubscriptionStatus.notificationEvent.eventNumber is part of an existing definition because parent element SubscriptionStatus.notificationEvent requires a cross-version extension. Element SubscriptionStatus.notificationEvent.eventNumber is not mapped to FHIR R4, since FHIR R5 SubscriptionStatus is not mapped. Element SubscriptionStatus.notificationEvent.eventNumber has no mapping targets in FHIR R4. 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:eventNumber.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 ValueeventNumber
    8. Extension.extension:eventNumber.value[x]
    Definition

    Either the sequential number of this event in this subscription context or a relative event number for this notification.


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

    ShortSequencing index of this eventValue of extension
    Comments

    In subscriptions where delivery of notifications IS NOT guaranteed (e.g., REST-Hook), this number is a unique and monotonically-increasing event number for a subscription. In channels where delivery of notifications IS guaranteed, this number is a relative index for the events present in the notification (e.g., 1, 2, etc.).

    Control10..1
    Typestring, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, 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, 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()))
    10. Extension.extension:timestamp
    Slice Nametimestamp
    Definition

    R5: SubscriptionStatus.notificationEvent.timestamp (new:instant)

    ShortR5: The instant this event occurred (new)Additional content defined by implementations
    Comments

    Element SubscriptionStatus.notificationEvent.timestamp is part of an existing definition because parent element SubscriptionStatus.notificationEvent requires a cross-version extension. Element SubscriptionStatus.notificationEvent.timestamp is not mapped to FHIR R4, since FHIR R5 SubscriptionStatus is not mapped. Element SubscriptionStatus.notificationEvent.timestamp has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Control0..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element SubscriptionStatus.notificationEvent.timestamp is part of an existing definition because parent element SubscriptionStatus.notificationEvent requires a cross-version extension. Element SubscriptionStatus.notificationEvent.timestamp is not mapped to FHIR R4, since FHIR R5 SubscriptionStatus is not mapped. Element SubscriptionStatus.notificationEvent.timestamp has no mapping targets in FHIR R4. 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:timestamp.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 Valuetimestamp
    14. Extension.extension:timestamp.value[x]
    Definition

    The actual time this event occurred on the server.


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

    ShortThe instant this event occurredValue of extension
    Control0..1
    Typeinstant, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, 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:focus
    Slice Namefocus
    Definition

    R5: SubscriptionStatus.notificationEvent.focus (new:Reference(Resource))

    ShortR5: Reference to the primary resource or information of this event (new)Additional content defined by implementations
    Comments

    Element SubscriptionStatus.notificationEvent.focus is part of an existing definition because parent element SubscriptionStatus.notificationEvent requires a cross-version extension. Element SubscriptionStatus.notificationEvent.focus is not mapped to FHIR R4, since FHIR R5 SubscriptionStatus is not mapped. Element SubscriptionStatus.notificationEvent.focus has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Control0..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element SubscriptionStatus.notificationEvent.focus is part of an existing definition because parent element SubscriptionStatus.notificationEvent requires a cross-version extension. Element SubscriptionStatus.notificationEvent.focus is not mapped to FHIR R4, since FHIR R5 SubscriptionStatus is not mapped. Element SubscriptionStatus.notificationEvent.focus has no mapping targets in FHIR R4. 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: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
    20. Extension.extension:focus.value[x]
    Definition

    The focus of this event. While this will usually be a reference to the focus resource of the event, it MAY contain a reference to a non-FHIR object.


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

    ShortReference to the primary resource or information of this eventValue of extension
    Control0..1
    TypeReference(Cross-version Profile for R5.Resource for use in FHIR R4, Resource), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, 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, 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()))
    22. Extension.extension:additionalContext
    Slice NameadditionalContext
    Definition

    R5: SubscriptionStatus.notificationEvent.additionalContext (new:Reference(Resource))

    ShortR5: References related to the focus resource and/or context of this event (new)Additional content defined by implementations
    Comments

    Element SubscriptionStatus.notificationEvent.additionalContext is part of an existing definition because parent element SubscriptionStatus.notificationEvent requires a cross-version extension. Element SubscriptionStatus.notificationEvent.additionalContext is not mapped to FHIR R4, since FHIR R5 SubscriptionStatus is not mapped. Element SubscriptionStatus.notificationEvent.additionalContext has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element SubscriptionStatus.notificationEvent.additionalContext is part of an existing definition because parent element SubscriptionStatus.notificationEvent requires a cross-version extension. Element SubscriptionStatus.notificationEvent.additionalContext is not mapped to FHIR R4, since FHIR R5 SubscriptionStatus is not mapped. Element SubscriptionStatus.notificationEvent.additionalContext has no mapping targets in FHIR R4. 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:additionalContext.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 ValueadditionalContext
    26. Extension.extension:additionalContext.value[x]
    Definition

    Additional context information for this event. Generally, this will contain references to additional resources included with the event (e.g., the Patient relevant to an Encounter), however it MAY refer to non-FHIR objects.


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

    ShortReferences related to the focus resource and/or context of this eventValue of extension
    Control0..1
    TypeReference(Cross-version Profile for R5.Resource for use in FHIR R4, Resource), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, 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, 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()))
    28. 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/5.0/StructureDefinition/extension-SubscriptionStatus.notificationEvent
    30. 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, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
    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

    R5: SubscriptionStatus.notificationEvent (new:BackboneElement)

    ShortR5: Detailed information about any events relevant to this notification (new)
    Comments

    Element SubscriptionStatus.notificationEvent is not mapped to FHIR R4, since FHIR R5 SubscriptionStatus is not mapped. Element SubscriptionStatus.notificationEvent has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Control0..*
    Is Modifierfalse
    2. Extension.extension
    Control1..*
    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:eventNumber
      Slice NameeventNumber
      Definition

      R5: SubscriptionStatus.notificationEvent.eventNumber (new:integer64)

      ShortR5: Sequencing index of this event (new)
      Comments

      Element SubscriptionStatus.notificationEvent.eventNumber is part of an existing definition because parent element SubscriptionStatus.notificationEvent requires a cross-version extension. Element SubscriptionStatus.notificationEvent.eventNumber is not mapped to FHIR R4, since FHIR R5 SubscriptionStatus is not mapped. Element SubscriptionStatus.notificationEvent.eventNumber has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). In subscriptions where delivery of notifications IS NOT guaranteed (e.g., REST-Hook), this number is a unique and monotonically-increasing event number for a subscription. In channels where delivery of notifications IS guaranteed, this number is a relative index for the events present in the notification (e.g., 1, 2, etc.).

      Control1..1
      Requirements

      Element SubscriptionStatus.notificationEvent.eventNumber is part of an existing definition because parent element SubscriptionStatus.notificationEvent requires a cross-version extension. Element SubscriptionStatus.notificationEvent.eventNumber is not mapped to FHIR R4, since FHIR R5 SubscriptionStatus is not mapped. Element SubscriptionStatus.notificationEvent.eventNumber has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      6. Extension.extension:eventNumber.url
      Control1..1
      Fixed ValueeventNumber
      8. Extension.extension:eventNumber.value[x]
      Definition

      Either the sequential number of this event in this subscription context or a relative event number for this notification.

      ShortSequencing index of this event
      Comments

      In subscriptions where delivery of notifications IS NOT guaranteed (e.g., REST-Hook), this number is a unique and monotonically-increasing event number for a subscription. In channels where delivery of notifications IS guaranteed, this number is a relative index for the events present in the notification (e.g., 1, 2, etc.).

      Control1..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
      10. Extension.extension:timestamp
      Slice Nametimestamp
      Definition

      R5: SubscriptionStatus.notificationEvent.timestamp (new:instant)

      ShortR5: The instant this event occurred (new)
      Comments

      Element SubscriptionStatus.notificationEvent.timestamp is part of an existing definition because parent element SubscriptionStatus.notificationEvent requires a cross-version extension. Element SubscriptionStatus.notificationEvent.timestamp is not mapped to FHIR R4, since FHIR R5 SubscriptionStatus is not mapped. Element SubscriptionStatus.notificationEvent.timestamp has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      Control0..1
      Requirements

      Element SubscriptionStatus.notificationEvent.timestamp is part of an existing definition because parent element SubscriptionStatus.notificationEvent requires a cross-version extension. Element SubscriptionStatus.notificationEvent.timestamp is not mapped to FHIR R4, since FHIR R5 SubscriptionStatus is not mapped. Element SubscriptionStatus.notificationEvent.timestamp has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      12. Extension.extension:timestamp.url
      Control1..1
      Fixed Valuetimestamp
      14. Extension.extension:timestamp.value[x]
      Definition

      The actual time this event occurred on the server.

      ShortThe instant this event occurred
      Control0..1
      Typeinstant
      [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:focus
      Slice Namefocus
      Definition

      R5: SubscriptionStatus.notificationEvent.focus (new:Reference(Resource))

      ShortR5: Reference to the primary resource or information of this event (new)
      Comments

      Element SubscriptionStatus.notificationEvent.focus is part of an existing definition because parent element SubscriptionStatus.notificationEvent requires a cross-version extension. Element SubscriptionStatus.notificationEvent.focus is not mapped to FHIR R4, since FHIR R5 SubscriptionStatus is not mapped. Element SubscriptionStatus.notificationEvent.focus has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      Control0..1
      Requirements

      Element SubscriptionStatus.notificationEvent.focus is part of an existing definition because parent element SubscriptionStatus.notificationEvent requires a cross-version extension. Element SubscriptionStatus.notificationEvent.focus is not mapped to FHIR R4, since FHIR R5 SubscriptionStatus is not mapped. Element SubscriptionStatus.notificationEvent.focus has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      18. Extension.extension:focus.url
      Control1..1
      Fixed Valuefocus
      20. Extension.extension:focus.value[x]
      Definition

      The focus of this event. While this will usually be a reference to the focus resource of the event, it MAY contain a reference to a non-FHIR object.

      ShortReference to the primary resource or information of this event
      Control0..1
      TypeReference(Cross-version Profile for R5.Resource for use in FHIR R4, Resource)
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      22. Extension.extension:additionalContext
      Slice NameadditionalContext
      Definition

      R5: SubscriptionStatus.notificationEvent.additionalContext (new:Reference(Resource))

      ShortR5: References related to the focus resource and/or context of this event (new)
      Comments

      Element SubscriptionStatus.notificationEvent.additionalContext is part of an existing definition because parent element SubscriptionStatus.notificationEvent requires a cross-version extension. Element SubscriptionStatus.notificationEvent.additionalContext is not mapped to FHIR R4, since FHIR R5 SubscriptionStatus is not mapped. Element SubscriptionStatus.notificationEvent.additionalContext has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      Control0..*
      Requirements

      Element SubscriptionStatus.notificationEvent.additionalContext is part of an existing definition because parent element SubscriptionStatus.notificationEvent requires a cross-version extension. Element SubscriptionStatus.notificationEvent.additionalContext is not mapped to FHIR R4, since FHIR R5 SubscriptionStatus is not mapped. Element SubscriptionStatus.notificationEvent.additionalContext has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      24. Extension.extension:additionalContext.url
      Control1..1
      Fixed ValueadditionalContext
      26. Extension.extension:additionalContext.value[x]
      Definition

      Additional context information for this event. Generally, this will contain references to additional resources included with the event (e.g., the Patient relevant to an Encounter), however it MAY refer to non-FHIR objects.

      ShortReferences related to the focus resource and/or context of this event
      Control0..1
      TypeReference(Cross-version Profile for R5.Resource for use in FHIR R4, Resource)
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      28. Extension.url
      Control1..1
      Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-SubscriptionStatus.notificationEvent
      30. Extension.value[x]
      Control0..0

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

      0. Extension
      Definition

      R5: SubscriptionStatus.notificationEvent (new:BackboneElement)

      ShortR5: Detailed information about any events relevant to this notification (new)
      Comments

      Element SubscriptionStatus.notificationEvent is not mapped to FHIR R4, since FHIR R5 SubscriptionStatus is not mapped. Element SubscriptionStatus.notificationEvent has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      Control0..*
      This element is affected by the following invariants: ele-1
      Is Modifierfalse
      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())
      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
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      4. Extension.extension
      Definition

      An Extension

      ShortExtension
      Control1..*
      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:eventNumber
        Slice NameeventNumber
        Definition

        R5: SubscriptionStatus.notificationEvent.eventNumber (new:integer64)

        ShortR5: Sequencing index of this event (new)
        Comments

        Element SubscriptionStatus.notificationEvent.eventNumber is part of an existing definition because parent element SubscriptionStatus.notificationEvent requires a cross-version extension. Element SubscriptionStatus.notificationEvent.eventNumber is not mapped to FHIR R4, since FHIR R5 SubscriptionStatus is not mapped. Element SubscriptionStatus.notificationEvent.eventNumber has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). In subscriptions where delivery of notifications IS NOT guaranteed (e.g., REST-Hook), this number is a unique and monotonically-increasing event number for a subscription. In channels where delivery of notifications IS guaranteed, this number is a relative index for the events present in the notification (e.g., 1, 2, etc.).

        Control1..1
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Requirements

        Element SubscriptionStatus.notificationEvent.eventNumber is part of an existing definition because parent element SubscriptionStatus.notificationEvent requires a cross-version extension. Element SubscriptionStatus.notificationEvent.eventNumber is not mapped to FHIR R4, since FHIR R5 SubscriptionStatus is not mapped. Element SubscriptionStatus.notificationEvent.eventNumber has no mapping targets in FHIR R4. 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:eventNumber.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
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        10. Extension.extension:eventNumber.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:eventNumber.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 ValueeventNumber
          14. Extension.extension:eventNumber.value[x]
          Definition

          Either the sequential number of this event in this subscription context or a relative event number for this notification.

          ShortSequencing index of this event
          Comments

          In subscriptions where delivery of notifications IS NOT guaranteed (e.g., REST-Hook), this number is a unique and monotonically-increasing event number for a subscription. In channels where delivery of notifications IS guaranteed, this number is a relative index for the events present in the notification (e.g., 1, 2, etc.).

          Control1..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()))
          16. Extension.extension:timestamp
          Slice Nametimestamp
          Definition

          R5: SubscriptionStatus.notificationEvent.timestamp (new:instant)

          ShortR5: The instant this event occurred (new)
          Comments

          Element SubscriptionStatus.notificationEvent.timestamp is part of an existing definition because parent element SubscriptionStatus.notificationEvent requires a cross-version extension. Element SubscriptionStatus.notificationEvent.timestamp is not mapped to FHIR R4, since FHIR R5 SubscriptionStatus is not mapped. Element SubscriptionStatus.notificationEvent.timestamp has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

          Control0..1
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Requirements

          Element SubscriptionStatus.notificationEvent.timestamp is part of an existing definition because parent element SubscriptionStatus.notificationEvent requires a cross-version extension. Element SubscriptionStatus.notificationEvent.timestamp is not mapped to FHIR R4, since FHIR R5 SubscriptionStatus is not mapped. Element SubscriptionStatus.notificationEvent.timestamp has no mapping targets in FHIR R4. 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:timestamp.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
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          20. Extension.extension:timestamp.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:timestamp.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 Valuetimestamp
            24. Extension.extension:timestamp.value[x]
            Definition

            The actual time this event occurred on the server.

            ShortThe instant this event occurred
            Control0..1
            Typeinstant
            [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:focus
            Slice Namefocus
            Definition

            R5: SubscriptionStatus.notificationEvent.focus (new:Reference(Resource))

            ShortR5: Reference to the primary resource or information of this event (new)
            Comments

            Element SubscriptionStatus.notificationEvent.focus is part of an existing definition because parent element SubscriptionStatus.notificationEvent requires a cross-version extension. Element SubscriptionStatus.notificationEvent.focus is not mapped to FHIR R4, since FHIR R5 SubscriptionStatus is not mapped. Element SubscriptionStatus.notificationEvent.focus has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

            Control0..1
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Requirements

            Element SubscriptionStatus.notificationEvent.focus is part of an existing definition because parent element SubscriptionStatus.notificationEvent requires a cross-version extension. Element SubscriptionStatus.notificationEvent.focus is not mapped to FHIR R4, since FHIR R5 SubscriptionStatus is not mapped. Element SubscriptionStatus.notificationEvent.focus has no mapping targets in FHIR R4. 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: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
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            30. 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
            • 32. 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
              34. Extension.extension:focus.value[x]
              Definition

              The focus of this event. While this will usually be a reference to the focus resource of the event, it MAY contain a reference to a non-FHIR object.

              ShortReference to the primary resource or information of this event
              Control0..1
              TypeReference(Cross-version Profile for R5.Resource for use in FHIR R4, Resource)
              [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()))
              36. Extension.extension:additionalContext
              Slice NameadditionalContext
              Definition

              R5: SubscriptionStatus.notificationEvent.additionalContext (new:Reference(Resource))

              ShortR5: References related to the focus resource and/or context of this event (new)
              Comments

              Element SubscriptionStatus.notificationEvent.additionalContext is part of an existing definition because parent element SubscriptionStatus.notificationEvent requires a cross-version extension. Element SubscriptionStatus.notificationEvent.additionalContext is not mapped to FHIR R4, since FHIR R5 SubscriptionStatus is not mapped. Element SubscriptionStatus.notificationEvent.additionalContext has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Requirements

              Element SubscriptionStatus.notificationEvent.additionalContext is part of an existing definition because parent element SubscriptionStatus.notificationEvent requires a cross-version extension. Element SubscriptionStatus.notificationEvent.additionalContext is not mapped to FHIR R4, since FHIR R5 SubscriptionStatus is not mapped. Element SubscriptionStatus.notificationEvent.additionalContext has no mapping targets in FHIR R4. 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:additionalContext.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
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              40. Extension.extension:additionalContext.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:additionalContext.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 ValueadditionalContext
                44. Extension.extension:additionalContext.value[x]
                Definition

                Additional context information for this event. Generally, this will contain references to additional resources included with the event (e.g., the Patient relevant to an Encounter), however it MAY refer to non-FHIR objects.

                ShortReferences related to the focus resource and/or context of this event
                Control0..1
                TypeReference(Cross-version Profile for R5.Resource for use in FHIR R4, Resource)
                [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()))
                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/5.0/StructureDefinition/extension-SubscriptionStatus.notificationEvent
                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..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, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
                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()))