Subscriptions R5 Backport
0.1.0 - ballot

Subscriptions R5 Backport - Local Development build (v0.1.0). See the Directory of published versions

: Subscription Events Operation - JSON Representation

Raw json | Download

​
{
  "resourceType" : "OperationDefinition",
  "id" : "backport-subscription-events",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2>R5SubscriptionEvents</h2><p>OPERATION: R5SubscriptionEvents</p><p>The official URL for this operation definition is: </p><pre>http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-events</pre><div><p>This operation is used to search for and return notifications that have been previously triggered by a topic-based Subscription in R4.</p>\n</div><p>URL: [base]/Subscription/[id]/$events</p><p>Parameters</p><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>eventsSinceNumber</td><td>0..1</td><td><a href=\"http://build.fhir.org/branches/R4B//datatypes.html#string\">string</a></td><td/><td><div><p>The starting event number, inclusive of this event (lower bound).</p>\n</div></td></tr><tr><td>IN</td><td>eventsUntilNumber</td><td>0..1</td><td><a href=\"http://build.fhir.org/branches/R4B//datatypes.html#string\">string</a></td><td/><td><div><p>The ending event number, inclusive of this event (upper bound).</p>\n</div></td></tr><tr><td>IN</td><td>content</td><td>0..1</td><td><a href=\"http://build.fhir.org/branches/R4B//datatypes.html#code\">code</a></td><td/><td><div><p>Requested content style of returned data. Codes from backport-content-value-set (e.g., empty, id-only, full-resource). This is a hint to the server what a client would prefer, and MAY be ignored.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td>1..1</td><td><a href=\"http://build.fhir.org/branches/R4B//bundle.html\">Bundle</a></td><td/><td><div><p>The operation returns a valid notification bundle, with the first entry being a SubscriptionStatus resource. The bundle type is &quot;history&quot;.</p>\n</div></td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 0
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use"
    }
  ],
  "url" : "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-events",
  "version" : "0.1.0",
  "name" : "R5SubscriptionEvents",
  "status" : "active",
  "kind" : "operation",
  "date" : "2020-11-30",
  "publisher" : "HL7 FHIR Infrastructure WG",
  "contact" : [
    {
      "name" : "HL7 FHIR Infrastructure WG",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://hl7.org/Special/committees/fiwg/index.cfm"
        }
      ]
    },
    {
      "name" : "Gino Canessa",
      "telecom" : [
        {
          "system" : "email",
          "value" : "mailto:gino.canessa@microsoft.com"
        }
      ]
    },
    {
      "name" : "Eric Haas",
      "telecom" : [
        {
          "system" : "email",
          "value" : "mailto:ehaas@healthedatainc.com"
        }
      ]
    }
  ],
  "description" : "This operation is used to search for and return notifications that have been previously triggered by a topic-based Subscription in R4.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "affectsState" : false,
  "code" : "events",
  "resource" : [
    "Subscription"
  ],
  "system" : false,
  "type" : false,
  "instance" : true,
  "parameter" : [
    {
      "name" : "eventsSinceNumber",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The starting event number, inclusive of this event (lower bound).",
      "type" : "string"
    },
    {
      "name" : "eventsUntilNumber",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The ending event number, inclusive of this event (upper bound).",
      "type" : "string"
    },
    {
      "name" : "content",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Requested content style of returned data. Codes from backport-content-value-set (e.g., empty, id-only, full-resource). This is a hint to the server what a client would prefer, and MAY be ignored.",
      "type" : "code"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The operation returns a valid notification bundle, with the first entry being a SubscriptionStatus resource. The bundle type is \"history\".",
      "type" : "Bundle"
    }
  ]
}