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

FHIR IG Statistics: OperationDefinition/backport-subscription-status

Packagehl7.fhir.uv.subscriptions-backport.r4
TypeOperationDefinition
Idbackport-subscription-status
FHIR VersionR4
Sourcehttp://hl7.org/fhir/uv/subscriptions-backport/http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/OperationDefinition-backport-subscription-status.html
URLhttp://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-status
Version1.1.0
Statusactive
Date2020-11-30
NameR5SubscriptionStatus
Realmuv
Authorityhl7
DescriptionThis operation is used to return the current status information about one or more topic-based Subscriptions in R4.
Typetrue
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
SDOHCC-CoordinationPlatformSDOHCC Coordination Platform
SDOHCC-ReferralRecipientSDOHCC Referral Recipient
SDOHCC-ReferralRecipientLightSDOHCC Referral Recipient - Light
SDOHCC-ReferralSourceSDOHCC Referral Source
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/$status

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

Parameters

UseNameCardinalityTypeBindingDocumentation
INid0..*id

At the Instance level, this parameter is ignored. At the Resource level, one or more parameters containing a FHIR id for a Subscription to get status information for. In the absence of any specified ids, the server returns the status for all Subscriptions available to the caller. Multiple values are joined via OR (e.g., "id1" OR "id2").

INstatus0..*code

At the Instance level, this parameter is ignored. At the Resource level, a Subscription status to filter by (e.g., "active"). In the absence of any specified status values, the server does not filter contents based on the status. Multiple values are joined via OR (e.g., "error" OR "off").

OUTreturn1..1Bundle

The operation returns a bundle containing one or more subscription status resources, one per Subscription being queried. The Bundle type is "searchset".


Source

{
  "resourceType": "OperationDefinition",
  "id": "backport-subscription-status",
  "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/uv/subscriptions-backport/OperationDefinition/backport-subscription-status",
  "version": "1.1.0",
  "name": "R5SubscriptionStatus",
  "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"
        }
      ]
    },
    {
      "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 return the current status information about one or more topic-based Subscriptions in R4.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "affectsState": false,
  "code": "status",
  "resource": [
    "Subscription"
  ],
  "system": false,
  "type": true,
  "instance": true,
  "parameter": [
    {
      "name": "id",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "At the Instance level, this parameter is ignored.  At the Resource level, one or more parameters containing a FHIR id for a Subscription to get status information for. In the absence of any specified ids, the server returns the status for all Subscriptions available to the caller. Multiple values are joined via OR (e.g., \"id1\" OR \"id2\").",
      "type": "id"
    },
    {
      "name": "status",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "At the Instance level, this parameter is ignored. At the Resource level, a Subscription status to filter by (e.g., \"active\"). In the absence of any specified status values, the server does not filter contents based on the status. Multiple values are joined via OR (e.g., \"error\" OR \"off\").",
      "type": "code"
    },
    {
      "name": "return",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "The operation returns a bundle containing one or more subscription status resources, one per Subscription being queried. The Bundle type is \"searchset\".",
      "type": "Bundle"
    }
  ]
}