{
  "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"
      }, {
        "title": "Actors",
        "nameUrl": "actors.html",
        "generation": "markdown"
      }, {
        "title": "Actors and Operations",
        "nameUrl": "actors_and_operations.html",
        "generation": "markdown"
      }, {
        "title": "Background",
        "nameUrl": "background.html",
        "generation": "markdown"
      }, {
        "title": "Channels",
        "nameUrl": "channels.html",
        "generation": "markdown"
      }, {
        "title": "Components",
        "nameUrl": "components.html",
        "generation": "markdown"
      }, {
        "title": "Conformance",
        "nameUrl": "conformance.html",
        "generation": "markdown"
      }, {
        "title": "Downloads",
        "nameUrl": "downloads.html",
        "generation": "markdown"
      }, {
        "title": "Errors",
        "nameUrl": "errors.html",
        "generation": "markdown"
      }, {
        "title": "Payloads",
        "nameUrl": "payloads.html",
        "generation": "markdown"
      }, {
        "title": "Safety Security",
        "nameUrl": "safety_security.html",
        "generation": "markdown"
      }, {
        "title": "Workflow",
        "nameUrl": "workflow.html",
        "generation": "markdown"
      }, {
        "title": "Workflow Diagrams",
        "nameUrl": "workflow-diagrams.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 Subscription Notification Status",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/backport-subscriptionstatus"
      },
      "description": "Profile on the Parameters resource to enable R5-style topic-based subscription notifications in FHIR R4.",
      "exampleBoolean": false
    }, {
      "name": "Backported R5 SubscriptionTopic Canonical URL Parameters",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/backport-subscription-topic-canonical-urls"
      },
      "description": "Profile on the R4 Parameters resource to enable R5-style topic-based subscriptions in FHIR R4.",
      "exampleBoolean": false
    }, {
      "name": "Backported R5 Additional Criteria",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:extension"
      } ],
      "reference": {
        "reference": "StructureDefinition/backport-additional-criteria"
      },
      "description": "Criteria for additional resource types.",
      "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 Notification URL Location",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:extension"
      } ],
      "reference": {
        "reference": "StructureDefinition/backport-notification-url-location"
      },
      "description": "If present, where to place URLs of resources in notifications.",
      "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": "Backport R5 Subscription Topic Canonical",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:extension"
      } ],
      "reference": {
        "reference": "StructureDefinition/backport-topic-canonical"
      },
      "description": "Canonical reference to the subscription topic being subscribed to.",
      "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": "R5 Subscription Error Codes Value Set",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "ValueSet"
      } ],
      "reference": {
        "reference": "ValueSet/backport-notification-error-value-set"
      },
      "description": "Codes to represent error states on subscriptions.",
      "exampleBoolean": false
    }, {
      "name": "R5 Subscription Notification Type Value Set",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "ValueSet"
      } ],
      "reference": {
        "reference": "ValueSet/backport-notification-type-value-set"
      },
      "description": "Codes to represent types of notification bundles.",
      "exampleBoolean": false
    }, {
      "name": "Backported R5 Subscription Notification URL Location Value Set",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "ValueSet"
      } ],
      "reference": {
        "reference": "ValueSet/backport-notification-url-location-value-set"
      },
      "description": "Codes to represent the location in Bundle.entry where URLs for resources should be located.",
      "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": "R5 Subscription Error Code System",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "CodeSystem"
      } ],
      "reference": {
        "reference": "CodeSystem/backport-notification-error-code-system"
      },
      "description": "Codes to represent error states on subscriptions.",
      "exampleBoolean": false
    }, {
      "name": "R5 Subscription Notification Type Code System",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "CodeSystem"
      } ],
      "reference": {
        "reference": "CodeSystem/backport-notification-type-code-system"
      },
      "description": "Codes to represent types of notification bundles.",
      "exampleBoolean": false
    }, {
      "name": "Backported R5 Subscription Notification URL Location Code System",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "CodeSystem"
      } ],
      "reference": {
        "reference": "CodeSystem/backport-notification-url-location-code-system"
      },
      "description": "Codes to represent the location in Bundle.entry where URLs for resources should be located.",
      "exampleBoolean": false
    }, {
      "name": "Backport 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": "Backport Subscription Topic List Operation",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "OperationDefinition"
      } ],
      "reference": {
        "reference": "OperationDefinition/Backport-subscriptiontopic-list"
      },
      "description": "This operation is used to return the current list of R5 SubscriptionTopics in a Backported-R4 environment.",
      "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": "Example CapabilityStatement describing the expected capabilities of a FHIR Server supporting backported R5 Subscriptions.",
      "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: 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": "Parameters"
      } ],
      "reference": {
        "reference": "Parameters/notification-status"
      },
      "description": "Example of a backported notification with status content.",
      "exampleCanonical": "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscriptionstatus"
    }, {
      "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 Topic List",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "Parameters"
      } ],
      "reference": {
        "reference": "Parameters/topic-list-single"
      },
      "description": "Example of a backported subscription topic list with a single entry.",
      "exampleCanonical": "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-topic-canonical-urls"
    } ],
    "extension": [ {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "copyrightyear"
      }, {
        "url": "value",
        "valueString": "2020+"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "releaselabel"
      }, {
        "url": "value",
        "valueString": "ballot"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "show-inherited-invariants"
      }, {
        "url": "value",
        "valueString": "false"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "usage-stats-opt-out"
      }, {
        "url": "value",
        "valueString": "true"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "path-history"
      }, {
        "url": "value",
        "valueString": "http://hl7.org/fhir/uv/subscriptions-backport/history.html"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "autoload-resources"
      }, {
        "url": "value",
        "valueString": "true"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "path-liquid"
      }, {
        "url": "value",
        "valueString": "template/liquid"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "path-liquid"
      }, {
        "url": "value",
        "valueString": "input/liquid"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "path-qa"
      }, {
        "url": "value",
        "valueString": "temp/qa"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "path-temp"
      }, {
        "url": "value",
        "valueString": "temp/pages"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "path-output"
      }, {
        "url": "value",
        "valueString": "output"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "path-suppressed-warnings"
      }, {
        "url": "value",
        "valueString": "input/ignoreWarnings.txt"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "template-html"
      }, {
        "url": "value",
        "valueString": "template-page.html"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "template-md"
      }, {
        "url": "value",
        "valueString": "template-page-md.html"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "apply-contact"
      }, {
        "url": "value",
        "valueString": "true"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "apply-context"
      }, {
        "url": "value",
        "valueString": "true"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "apply-copyright"
      }, {
        "url": "value",
        "valueString": "true"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "apply-jurisdiction"
      }, {
        "url": "value",
        "valueString": "true"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "apply-license"
      }, {
        "url": "value",
        "valueString": "true"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "apply-publisher"
      }, {
        "url": "value",
        "valueString": "true"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "apply-version"
      }, {
        "url": "value",
        "valueString": "true"
      } ]
    }, {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter",
      "extension": [ {
        "url": "code",
        "valueString": "active-tables"
      }, {
        "url": "value",
        "valueString": "true"
      } ]
    } ],
    "parameter": [ {
      "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-tx-cache",
      "value": "input-cache/txcache"
    } ]
  },
  "date": "2020-12-16T17:37:01+00:00",
  "publisher": "HL7 FHIR Infrastructure WG",
  "fhirVersion": [ "4.0.1" ],
  "license": "CC0-1.0",
  "jurisdiction": [ {
    "coding": [ {
      "code": "001",
      "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "display": "World"
    } ]
  } ],
  "name": "SubscriptionsR5Backport",
  "type": null,
  "experimental": null,
  "resourceType": "ImplementationGuide",
  "title": "Subscriptions R5 Backport",
  "package_version": "0.1.0",
  "status": "draft",
  "id": "07dc35e8-b5e9-4fc7-a03d-9a172badeb35",
  "kind": null,
  "url": "http://hl7.org/fhir/uv/subscriptions-backport/ImplementationGuide/hl7.fhir.uv.subscriptions-backport",
  "version": "0.1.0",
  "packageId": "hl7.fhir.uv.subscriptions-backport",
  "contact": [ {
    "name": "HL7 FHIR Infrastructure WG",
    "telecom": [ {
      "value": "https://hl7.org/Special/committees/fiwg/index.cfm",
      "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"
    } ]
  } ]
}