FHIR Extensions Pack
5.2.0-ballot - 5.2.0 Ballot - September 2024) International flag

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.2.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-extensions/ and changes regularly. See the Directory of published versions

Extension: Subscription Best Effort (Experimental)

Official URL: http://hl7.org/fhir/StructureDefinition/subscription-best-effort Version: 5.2.0-ballot
Standards status: Draft Maturity Level: 1 Computable Name: SubscriptionBestEffort
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1497

If true, indicates the channel should be treated as though it is using a non-guaranteed delivery mechanism, effectively labeling the subscription as ‘best effort’.

This is an experimental extension definition; the committee is seeking implementation feedback, and the definition or contents of the extension may change in future versions.

Context of Use

This extension may be used on the following element(s):

  • Element ID Subscription

Usage info

Usage:

  • This Extension is not used by any profiles in this Implementation Guide

Changes since version 1.0.0:

  • No changes

    • Formal Views of Extension Content

    Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

    This structure is derived from Extension

    Summary

    Simple Extension of type boolean: If true, indicates the channel should be treated as though it is using a non-guaranteed delivery mechanism, effectively labeling the subscription as 'best effort'.

    Maturity: 1

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Treat channel as non-guaranteed
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/subscription-best-effort"
    ... value[x] 1..1 boolean Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Treat channel as non-guaranteed
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/subscription-best-effort"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension of type boolean: If true, indicates the channel should be treated as though it is using a non-guaranteed delivery mechanism, effectively labeling the subscription as 'best effort'.

    Maturity: 1

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Treat channel as non-guaranteed
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/subscription-best-effort"
    ... value[x] 1..1 boolean Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Treat channel as non-guaranteed
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/subscription-best-effort"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    Search Parameters for this Extension

    (none found)