FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.4.11  |  FHIR Version n/a  User: [n/a]

Resource OperationDefinition/FHIR Server from package hl7.fhir.uv.subscriptions-backport#current (31 ms)

Package hl7.fhir.uv.subscriptions-backport
Type OperationDefinition
Id Id
FHIR Version R4B
Source http://hl7.org/fhir/uv/subscriptions-backport/https://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/OperationDefinition-backport-subscription-status.html
Url http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-status
Version 1.2.0-ballot
Status active
Date 2020-11-30
Name R5SubscriptionStatus
Title Subscription Status Operation
Experimental False
Realm uv
Authority hl7
Description This operation is used to return the current status information about one or more topic-based Subscriptions in R4.
Type true
Kind operation

Resources that use this resource

CapabilityStatement
backport-subscription-server-r4 R4 Topic-Based Subscription Server Capability Statement
backport-subscription-server R4B Topic-Based Subscription Server Capability Statement
http://hl7.org/fhir/us/sdoh-clinicalcare/CapabilityStatement/SDOHCC-CoordinationPlatform SDOHCC Coordination Platform
http://hl7.org/fhir/us/sdoh-clinicalcare/CapabilityStatement/SDOHCC-ReferralRecipient SDOHCC Referral Recipient
http://hl7.org/fhir/us/sdoh-clinicalcare/CapabilityStatement/SDOHCC-ReferralRecipientLight SDOHCC Referral Recipient - Light
http://hl7.org/fhir/us/sdoh-clinicalcare/CapabilityStatement/SDOHCC-ReferralSource SDOHCC Referral Source
https://profiles.ihe.net/ITI/DSUBm/CapabilityStatement/IHE.DSUBm.ResourceNotificationBroker.DocRef.FullEvents IHE DSUBm ResourceNotificationBroker DocRef FullEvents
https://profiles.ihe.net/ITI/DSUBm/CapabilityStatement/IHE.DSUBm.ResourceNotificationBroker.DocRef.MinUpd IHE DSUBm ResourceNotificationBroker DocRef MinUpd
https://profiles.ihe.net/ITI/DSUBm/CapabilityStatement/IHE.DSUBm.ResourceNotificationBroker.Folder.Basic IHE DSUBm ResourceNotificationBroker Folder Basic
https://profiles.ihe.net/ITI/DSUBm/CapabilityStatement/IHE.DSUBm.ResourceNotificationBroker.Folder.FullEvents IHE DSUBm ResourceNotificationBroker Folder FullEvents
https://profiles.ihe.net/ITI/DSUBm/CapabilityStatement/IHE.DSUBm.ResourceNotificationBroker.Folder.MinUpd IHE DSUBm ResourceNotificationBroker Folder MinUpd
https://profiles.ihe.net/ITI/DSUBm/CapabilityStatement/IHE.DSUBm.ResourceNotificationBroker.Folder.Upd IHE DSUBm ResourceNotificationBroker Folder Upd
https://profiles.ihe.net/ITI/DSUBm/CapabilityStatement/IHE.DSUBm.ResourceNotificationBroker IHE DSUBm ResourceNotificationBroker
https://profiles.ihe.net/ITI/DSUBm/CapabilityStatement/IHE.DSUBm.ResourceNotificationSubscriber.DocRef.FullEvents IHE DSUBm ResourceNotificationSubscriber DocRef FullEvents
https://profiles.ihe.net/ITI/DSUBm/CapabilityStatement/IHE.DSUBm.ResourceNotificationSubscriber.DocRef.MinUpd IHE DSUBm ResourceNotificationSubscriber DocRef MinUpd
https://profiles.ihe.net/ITI/DSUBm/CapabilityStatement/IHE.DSUBm.ResourceNotificationSubscriber.Folder.Basic IHE DSUBm ResourceNotificationSubscriber Folder Basic
https://profiles.ihe.net/ITI/DSUBm/CapabilityStatement/IHE.DSUBm.ResourceNotificationSubscriber.Folder.FullEvents IHE DSUBm ResourceNotificationSubscriber Folder FullEvents
https://profiles.ihe.net/ITI/DSUBm/CapabilityStatement/IHE.DSUBm.ResourceNotificationSubscriber.Folder.MinUpd IHE DSUBm ResourceNotificationSubscriber Folder MinUpd
https://profiles.ihe.net/ITI/DSUBm/CapabilityStatement/IHE.DSUBm.ResourceNotificationSubscriber.Folder.Upd IHE DSUBm ResourceNotificationSubscriber Folder Upd
https://profiles.ihe.net/ITI/DSUBm/CapabilityStatement/IHE.DSUBm.ResourceNotificationSubscriber IHE DSUBm ResourceNotificationSubscriber
http://hl7.org/fhir/us/ndh/CapabilityStatement/national-directory-api-base-expanded-server National Directory API Base Expanded Server Capability Statement
http://hl7.org/fhir/us/ndh/CapabilityStatement/national-directory-api-base-server National Directory API Base Server Capability Statement
http://hl7.org/fhir/us/ndh/CapabilityStatement/national-directory-api-server National Directory API Capability Statement
http://santeonnl.github.io/shared-care-planning/CapabilityStatement/CarePlanService-server CarePlan Service Capability Statement
backport-subscription-server-r4 BackportSubscriptionCapabilityStatementR4
backport-subscription-server BackportSubscriptionCapabilityStatement

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

UseNameScopeCardinalityTypeBindingDocumentation
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" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>URL: [base]/Subscription/$status</p><p>URL: [base]/Subscription/[id]/$status</p><p>Parameters</p><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</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>id</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4B/datatypes.html#id\">id</a></td><td/><td><div><p>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., &quot;id1&quot; OR &quot;id2&quot;).</p>\n</div></td></tr><tr><td>IN</td><td>status</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4B/datatypes.html#code\">code</a></td><td/><td><div><p>At the Instance level, this parameter is ignored. At the Resource level, a Subscription status to filter by (e.g., &quot;active&quot;). 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., &quot;error&quot; OR &quot;off&quot;).</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4B/bundle.html\">Bundle</a></td><td/><td><div><p>The operation returns a bundle containing one or more subscription status resources, one per Subscription being queried. The Bundle type is &quot;searchset&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/StructureDefinition/structuredefinition-wg",
      "valueCode" : "fhir"
    }
  ],
  "url" : "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-status",
  "version" : "1.2.0-ballot",
  "name" : "R5SubscriptionStatus",
  "title" : "Subscription Status 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 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"
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.