FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: OperationDefinition/backport-subscription-events

Packagehl7.fhir.uv.subscriptions-backport
TypeOperationDefinition
Idbackport-subscription-events
FHIR VersionR4B
Sourcehttp://hl7.org/fhir/uv/subscriptions-backport/https://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/OperationDefinition-backport-subscription-events.html
URLhttp://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-events
Version1.2.0-ballot
Statusactive
Date2020-11-30
NameR5SubscriptionEvents
TitleSubscription Events Operation
Realmuv
Authorityhl7
DescriptionThis operation is used to search for and return notifications that have been previously triggered by a topic-based Subscription in R4.
Typefalse
Kindoperation

Resources that use this resource

CapabilityStatement
backport-subscription-server-r4R4 Topic-Based Subscription Server Capability Statement
backport-subscription-serverR4B Topic-Based Subscription Server Capability Statement
IHE.DSUBm.ResourceNotificationBroker.DocRef.FullEventsIHE DSUBm ResourceNotificationBroker DocRef FullEvents
IHE.DSUBm.ResourceNotificationBroker.DocRef.MinUpdIHE DSUBm ResourceNotificationBroker DocRef MinUpd
IHE.DSUBm.ResourceNotificationBroker.Folder.BasicIHE DSUBm ResourceNotificationBroker Folder Basic
IHE.DSUBm.ResourceNotificationBroker.Folder.FullEventsIHE DSUBm ResourceNotificationBroker Folder FullEvents
IHE.DSUBm.ResourceNotificationBroker.Folder.MinUpdIHE DSUBm ResourceNotificationBroker Folder MinUpd
IHE.DSUBm.ResourceNotificationBroker.Folder.UpdIHE DSUBm ResourceNotificationBroker Folder Upd
IHE.DSUBm.ResourceNotificationBrokerIHE DSUBm ResourceNotificationBroker
IHE.DSUBm.ResourceNotificationSubscriber.DocRef.FullEventsIHE DSUBm ResourceNotificationSubscriber DocRef FullEvents
IHE.DSUBm.ResourceNotificationSubscriber.DocRef.MinUpdIHE DSUBm ResourceNotificationSubscriber DocRef MinUpd
IHE.DSUBm.ResourceNotificationSubscriber.Folder.BasicIHE DSUBm ResourceNotificationSubscriber Folder Basic
IHE.DSUBm.ResourceNotificationSubscriber.Folder.FullEventsIHE DSUBm ResourceNotificationSubscriber Folder FullEvents
IHE.DSUBm.ResourceNotificationSubscriber.Folder.MinUpdIHE DSUBm ResourceNotificationSubscriber Folder MinUpd
IHE.DSUBm.ResourceNotificationSubscriber.Folder.UpdIHE DSUBm ResourceNotificationSubscriber Folder Upd
IHE.DSUBm.ResourceNotificationSubscriberIHE DSUBm ResourceNotificationSubscriber
ISiKCapabilityStatementSubscriptionRolleCapabilityStatement für Rolle "Subscription"
backport-subscription-server-r4BackportSubscriptionCapabilityStatementR4
backport-subscription-serverBackportSubscriptionCapabilityStatement
r4-capabilitystatement-example-server

Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

URL: [base]/Subscription/[id]/$events

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INeventsSinceNumber0..1string

The starting event number, inclusive of this event (lower bound).

INeventsUntilNumber0..1string

The ending event number, inclusive of this event (upper bound).

INcontent0..1code

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.

OUTreturn1..1Bundle

The operation returns a valid notification bundle, with the first entry being the subscription status information resource. The bundle type is "history".


Source

{
  "resourceType": "OperationDefinition",
  "id": "backport-subscription-events",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "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/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    }
  ],
  "url": "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-events",
  "version": "1.2.0-ballot",
  "name": "R5SubscriptionEvents",
  "title": "Subscription Events Operation",
  "status": "active",
  "kind": "operation",
  "date": "2020-11-30",
  "publisher": "HL7 International / FHIR Infrastructure",
  "contact": [
    {
      "name": "HL7 International / FHIR Infrastructure",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fiwg"
        }
      ]
    },
    {
      "name": "Gino Canessa",
      "telecom": [
        {
          "system": "email",
          "value": "mailto:gino.canessa@microsoft.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 the subscription status information resource. The bundle type is \"history\".",
      "type": "Bundle"
    }
  ]
}