{
  "description": "The Subscription R5 Backport Implementation Guide enables servers running verions of FHIR earlier than R5 to implement a subset of R5 Subscriptions in a standardized way.",
  "_filename": "ImplementationGuide-hl7.fhir.uv.subscriptions-backport.json",
  "package_name": "hl7.fhir.uv.subscriptions-backport",
  "definition": {
    "page": {
      "page": [ {
        "title": "Home",
        "nameUrl": "index.html",
        "generation": "markdown"
      }, {
        "page": [ {
          "title": "Actors",
          "nameUrl": "actors.html",
          "generation": "markdown"
        }, {
          "title": "Topic-Based Subscription Components",
          "nameUrl": "components.html",
          "generation": "markdown"
        }, {
          "title": "Workflow",
          "nameUrl": "workflow.html",
          "generation": "markdown"
        }, {
          "title": "Channels",
          "nameUrl": "channels.html",
          "generation": "markdown"
        }, {
          "title": "Notifications",
          "nameUrl": "notifications.html",
          "generation": "markdown"
        }, {
          "title": "Payload Types",
          "nameUrl": "payloads.html",
          "generation": "markdown"
        }, {
          "title": "Conformance",
          "nameUrl": "conformance.html",
          "generation": "markdown"
        }, {
          "title": "Handling Errors",
          "nameUrl": "errors.html",
          "generation": "markdown"
        } ],
        "title": "Specification",
        "nameUrl": "specification.html",
        "generation": "markdown"
      }, {
        "title": "Safety and Security",
        "nameUrl": "safety_security.html",
        "generation": "markdown"
      }, {
        "title": "Downloads",
        "nameUrl": "downloads.html",
        "generation": "markdown"
      } ],
      "title": "Table of Contents",
      "nameUrl": "toc.html",
      "generation": "html"
    },
    "resource": [ {
      "name": "Backported R5 Subscription",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/backport-subscription"
      },
      "description": "Profile on the R4 Subscription resource to enable R5-style topic-based subscriptions in FHIR R4.",
      "exampleBoolean": false
    }, {
      "name": "Backported R5 Subscription Notification Bundle",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/backport-subscription-notification"
      },
      "description": "Profile on the R4 Bundle resource to enable R5-style topic-based subscription notifications in FHIR R4.",
      "exampleBoolean": false
    }, {
      "name": "Backported R5 Additional Channel Types",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:extension"
      } ],
      "reference": {
        "reference": "StructureDefinition/backport-channel-type"
      },
      "description": "Additional channel types not defined in FHIR R4.",
      "exampleBoolean": false
    }, {
      "name": "Backported R5 FilterBy Criteria",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:extension"
      } ],
      "reference": {
        "reference": "StructureDefinition/backport-filter-criteria"
      },
      "description": "Criteria for topic-based filtering (filter-by).",
      "exampleBoolean": false
    }, {
      "name": "Backport R5 Subscription Heartbeat Period",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:extension"
      } ],
      "reference": {
        "reference": "StructureDefinition/backport-heartbeat-period"
      },
      "description": "Interval in seconds to send 'heartbeat' notifications.",
      "exampleBoolean": false
    }, {
      "name": "Backported R5 Subscription MaxCount",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:extension"
      } ],
      "reference": {
        "reference": "StructureDefinition/backport-max-count"
      },
      "description": "Maximum number of triggering resources included in notification bundles.",
      "exampleBoolean": false
    }, {
      "name": "Backport R5 Subscription Payload Content Information",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:extension"
      } ],
      "reference": {
        "reference": "StructureDefinition/backport-payload-content"
      },
      "description": "How much of the resource content to deliver in the notification payload. The choices are an empty payload, only the resource id, or the full resource content.",
      "exampleBoolean": false
    }, {
      "name": "Backport R5 Subscription Timeout",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:extension"
      } ],
      "reference": {
        "reference": "StructureDefinition/backport-timeout"
      },
      "description": "Timeout in seconds to attempt notification delivery.",
      "exampleBoolean": false
    }, {
      "name": "Backported R5 Subscription Content Value Set",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "ValueSet"
      } ],
      "reference": {
        "reference": "ValueSet/backport-content-value-set"
      },
      "description": "Codes to represent how much resource content to send in the notification payload.",
      "exampleBoolean": false
    }, {
      "name": "Backported R5 Subscription Content Code System",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "CodeSystem"
      } ],
      "reference": {
        "reference": "CodeSystem/backport-content-code-system"
      },
      "description": "Codes to represent how much resource content to send in the notification payload.",
      "exampleBoolean": false
    }, {
      "name": "Search by custom channel types used for notifications",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "SearchParameter"
      } ],
      "reference": {
        "reference": "SearchParameter/Subscription-custom-channel"
      },
      "description": "This SearchParameter enables query of subscriptions by additional channel type.",
      "exampleBoolean": false
    }, {
      "name": "Search by the filtering criteria used to narrow a topic-based subscription topic",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "SearchParameter"
      } ],
      "reference": {
        "reference": "SearchParameter/Subscription-filter-criteria"
      },
      "description": "This SearchParameter enables query of subscriptions by filter criteria.",
      "exampleBoolean": false
    }, {
      "name": "Search by payload types used for notifications",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "SearchParameter"
      } ],
      "reference": {
        "reference": "SearchParameter/Subscription-payload-type"
      },
      "description": "This SearchParameter enables query of subscriptions by payload type.",
      "exampleBoolean": false
    }, {
      "name": "Search by Canonical URL used in a topic-based subscription",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "SearchParameter"
      } ],
      "reference": {
        "reference": "SearchParameter/Subscription-topic"
      },
      "description": "This SearchParameter enables query of subscriptions by canonical topic-url.",
      "exampleBoolean": false
    }, {
      "name": "Subscription Events Operation",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "OperationDefinition"
      } ],
      "reference": {
        "reference": "OperationDefinition/backport-subscription-events"
      },
      "description": "This operation is used to return historical events in the backported R5-Style Subscriptions.",
      "exampleBoolean": false
    }, {
      "name": "Get WS Binding Token for Subscription Operation",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "OperationDefinition"
      } ],
      "reference": {
        "reference": "OperationDefinition/backport-subscription-get-ws-binding-token"
      },
      "description": "This operation is used to get a token for a websocket client to use in order to bind to one or more subscriptions.",
      "exampleBoolean": false
    }, {
      "name": "Backport Subscription Server Capability Statement",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "CapabilityStatement"
      } ],
      "reference": {
        "reference": "CapabilityStatement/backport-subscription-server"
      },
      "description": "CapabilityStatement describing the minimal required capabilities of a FHIR Server supporting backported R5 Subscriptions.",
      "exampleBoolean": false
    }, {
      "name": "Subscription Status Operation",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "OperationDefinition"
      } ],
      "reference": {
        "reference": "OperationDefinition/backport-subscription-status"
      },
      "description": "This operation is used to return the current status information about one or more backported R5-Style Subscriptions in R4.",
      "exampleBoolean": false
    }, {
      "name": "Backported Notification: Empty",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "Bundle"
      } ],
      "reference": {
        "reference": "Bundle/notification-empty"
      },
      "description": "Example of a backported notification with 'empty' content.",
      "exampleCanonical": "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-notification"
    }, {
      "name": "Backported Notification: Error",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "Bundle"
      } ],
      "reference": {
        "reference": "Bundle/notification-error"
      },
      "description": "Example of a backported notification with an error state.",
      "exampleCanonical": "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-notification"
    }, {
      "name": "Backported Notification: Full Resource",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "Bundle"
      } ],
      "reference": {
        "reference": "Bundle/notification-full-resource"
      },
      "description": "Example of a backported notification with 'full-resource' content.",
      "exampleCanonical": "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-notification"
    }, {
      "name": "Backported Notification: Handshake",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "Bundle"
      } ],
      "reference": {
        "reference": "Bundle/notification-handshake"
      },
      "description": "Example of a backported notification of type: 'handshake'.",
      "exampleCanonical": "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-notification"
    }, {
      "name": "Backported Notification: Heartbeat",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "Bundle"
      } ],
      "reference": {
        "reference": "Bundle/notification-heartbeat"
      },
      "description": "Example of a backported notification of type: 'heartbeat'.",
      "exampleCanonical": "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-notification"
    }, {
      "name": "Backported Notification: Id Only",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "Bundle"
      } ],
      "reference": {
        "reference": "Bundle/notification-id-only"
      },
      "description": "Example of a backported notification with 'id-only' content.",
      "exampleCanonical": "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-notification"
    }, {
      "name": "Backported Notification: Multiple Resources",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "Bundle"
      } ],
      "reference": {
        "reference": "Bundle/notification-multi-resource"
      },
      "description": "Example of a backported notification with 'full-resource' content and a related resource.",
      "exampleCanonical": "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-notification"
    }, {
      "name": "Backported Notification: Status",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "SubscriptionStatus"
      } ],
      "reference": {
        "reference": "SubscriptionStatus/notification-status"
      },
      "description": "Example of a backported notification with status content.",
      "exampleBoolean": true
    }, {
      "name": "Backported Subscription: Admission",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "Subscription"
      } ],
      "reference": {
        "reference": "Subscription/subscription-admission"
      },
      "description": "Example of a backported R5 admissions subscription in R4.",
      "exampleCanonical": "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription"
    }, {
      "name": "Backported Subscription: Multi-Resource",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "Subscription"
      } ],
      "reference": {
        "reference": "Subscription/subscription-multi-resource"
      },
      "description": "Example of a backported R5 subscription in R4 with multiple resources.",
      "exampleCanonical": "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription"
    }, {
      "name": "Backported Subscription: Custom Channel",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "Subscription"
      } ],
      "reference": {
        "reference": "Subscription/subscription-zulip"
      },
      "description": "Example of a backported R5 subscription in R4 with a custom channel.",
      "exampleCanonical": "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription"
    } ],
    "parameter": [ {
      "code": "copyrightyear",
      "value": "2020+"
    }, {
      "code": "releaselabel",
      "value": "Standard for Trial Use"
    }, {
      "code": "show-inherited-invariants",
      "value": "false"
    }, {
      "code": "usage-stats-opt-out",
      "value": "true"
    }, {
      "code": "shownav",
      "value": "true"
    }, {
      "code": "path-history",
      "value": "http://hl7.org/fhir/uv/subscriptions-backport/history.html"
    }, {
      "code": "autoload-resources",
      "value": "true"
    }, {
      "code": "path-resource",
      "value": "input/capabilities"
    }, {
      "code": "path-resource",
      "value": "input/examples"
    }, {
      "code": "path-resource",
      "value": "input/extensions"
    }, {
      "code": "path-resource",
      "value": "input/models"
    }, {
      "code": "path-resource",
      "value": "input/operations"
    }, {
      "code": "path-resource",
      "value": "input/profiles"
    }, {
      "code": "path-resource",
      "value": "input/resources"
    }, {
      "code": "path-resource",
      "value": "input/vocabulary"
    }, {
      "code": "path-resource",
      "value": "input/maps"
    }, {
      "code": "path-resource",
      "value": "input/testing"
    }, {
      "code": "path-resource",
      "value": "input/history"
    }, {
      "code": "path-resource",
      "value": "fsh-generated/resources"
    }, {
      "code": "path-pages",
      "value": "template/config"
    }, {
      "code": "path-pages",
      "value": "input/images"
    }, {
      "code": "path-liquid",
      "value": "template/liquid"
    }, {
      "code": "path-liquid",
      "value": "input/liquid"
    }, {
      "code": "path-qa",
      "value": "temp/qa"
    }, {
      "code": "path-temp",
      "value": "temp/pages"
    }, {
      "code": "path-output",
      "value": "output"
    }, {
      "code": "path-tx-cache",
      "value": "input-cache/txcache"
    }, {
      "code": "path-suppressed-warnings",
      "value": "input/ignoreWarnings.txt"
    }, {
      "code": "template-html",
      "value": "template-page.html"
    }, {
      "code": "template-md",
      "value": "template-page-md.html"
    }, {
      "code": "apply-contact",
      "value": "true"
    }, {
      "code": "apply-context",
      "value": "true"
    }, {
      "code": "apply-copyright",
      "value": "true"
    }, {
      "code": "apply-jurisdiction",
      "value": "true"
    }, {
      "code": "apply-license",
      "value": "true"
    }, {
      "code": "apply-publisher",
      "value": "true"
    }, {
      "code": "apply-version",
      "value": "true"
    }, {
      "code": "active-tables",
      "value": "true"
    }, {
      "code": "fmm-definition",
      "value": "http://hl7.org/fhir/versions.html#maturity"
    }, {
      "code": "propagate-status",
      "value": "true"
    }, {
      "code": "excludelogbinaryformat",
      "value": "true"
    } ]
  },
  "date": "2022-07-18T19:59:57+00:00",
  "publisher": "HL7 FHIR Infrastructure WG",
  "fhirVersion": [ "4.3.0" ],
  "license": "CC0-1.0",
  "jurisdiction": [ {
    "coding": [ {
      "code": "001",
      "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "display": "World"
    } ]
  } ],
  "dependsOn": [ {
    "id": "hl7tx",
    "uri": "http://terminology.hl7.org/ImplementationGuide/hl7.terminology",
    "version": "3.1.0",
    "packageId": "hl7.terminology.r4"
  } ],
  "name": "SubscriptionsR5Backport",
  "type": null,
  "experimental": null,
  "resourceType": "ImplementationGuide",
  "title": "Subscriptions R5 Backport",
  "package_version": "1.0.0",
  "status": "draft",
  "id": "cfaffad4-327c-4c39-b861-7d54297576e4",
  "kind": null,
  "url": "http://hl7.org/fhir/uv/subscriptions-backport/ImplementationGuide/hl7.fhir.uv.subscriptions-backport",
  "version": "1.0.0",
  "packageId": "hl7.fhir.uv.subscriptions-backport",
  "contact": [ {
    "name": "HL7 FHIR Infrastructure WG",
    "telecom": [ {
      "value": "https://hl7.org/Special/committees/fiwg",
      "system": "url"
    } ]
  }, {
    "name": "HL7 FHIR Infrastructure WG",
    "telecom": [ {
      "value": "https://hl7.org/Special/committees/fiwg",
      "system": "url"
    } ]
  }, {
    "name": "Gino Canessa",
    "telecom": [ {
      "value": "mailto:gino.canessa@microsoft.com",
      "system": "email"
    } ]
  }, {
    "name": "Eric Haas",
    "telecom": [ {
      "value": "mailto:ehaas@healthedatainc.com",
      "system": "email"
    } ]
  } ]
}