Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Example OperationDefinition/Subscription-events (JSON)

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: Informative

Raw JSON (canonical form + also see JSON Format Specification)

Operation Definition

{
  "resourceType" : "OperationDefinition",
  "id" : "Subscription-events",
  "text" : {
    "status" : "extensions",
    "div" : "<div>!-- Snipped for Brevity --></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/OperationDefinition/Subscription-events",
  "version" : "5.0.0-ballot",
  "name" : "Events",
  "title" : "Search and retrieve prior events for a Subscription",
  "status" : "draft",
  "kind" : "operation",
  "experimental" : false,
  "date" : "2022-09-07T10:58:29+10:00",
  "publisher" : "HL7 (FHIR Project)",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    },
    {
      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  }],
  "description" : "This operation is used to search for and return notifications that have been previously triggered by a topic-based Subscription.",
  "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" : "integer64"
  },
  {
    "name" : "eventsUntilNumber",
    "use" : "in",
    "min" : 0,
    "max" : "1",
    "documentation" : "The ending event number, inclusive of this event (upper bound).",
    "type" : "integer64"
  },
  {
    "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 \"subscription-notification\".",
    "type" : "Bundle"
  }]
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.