Operation Definition

{
  "resourceType" : "OperationDefinition",
  "id" : "Subscription-status",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition Subscription-status</b></p><a name=\"Subscription-status\"> </a><a name=\"hcSubscription-status\"> </a><a name=\"Subscription-status-en-US\"> </a><p>URL: [base]/Subscription/$status</p><p>URL: [base]/Subscription/[id]/$status</p><h3>Parameters</h3><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>type</td><td>0..*</td><td><a href=\"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 FHIR ids to Subscription resources 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>type</td><td>0..*</td><td><a href=\"datatypes.html#code\">code</a></td><td><a href=\"valueset-subscription-status.html\">Subscription Status</a> (Required)</td><td><div><p>At the Instance level, this parameter is ignored. At the Resource level, a Subscription status code 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=\"bundle.html\">Bundle</a></td><td/><td><div><p>The operation returns a bundle containing zero or more SubscriptionStatus resources, one per Subscription in the request that was found. The Bundle type is &quot;searchset&quot;.</p>\n</div></td></tr></table></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 2
  },
  {
    "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/OperationDefinition/Subscription-status",
  "version" : "6.0.0-ballot2",
  "name" : "Status",
  "title" : "Get Current Subscription Status for One or More Subscriptions",
  "status" : "draft",
  "kind" : "operation",
  "experimental" : false,
  "date" : "2024-11-22T14:16:48+00:00",
  "publisher" : "HL7 International / FHIR Infrastructure",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    },
    {
      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  },
  {
    "telecom" : [{
      "system" : "url",
      "value" : "http://www.hl7.org/Special/committees/fiwg"
    }]
  }],
  "description" : "This operation is used to return the current status information about one or more topic-based Subscriptions.",
  "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",
    "scope" : ["type"],
    "min" : 0,
    "max" : "*",
    "documentation" : "At the Instance level, this parameter is ignored. At the Resource level, one or more FHIR ids to Subscription resources 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",
    "scope" : ["type"],
    "min" : 0,
    "max" : "*",
    "documentation" : "At the Instance level, this parameter is ignored. At the Resource level, a Subscription status code 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",
    "binding" : {
      "strength" : "required",
      "valueSet" : "http://hl7.org/fhir/ValueSet/subscription-status|6.0.0-ballot2"
    }
  },
  {
    "name" : "return",
    "use" : "out",
    "min" : 1,
    "max" : "1",
    "documentation" : "The operation returns a bundle containing zero or more SubscriptionStatus resources, one per Subscription in the request that was found. The Bundle type is \"searchset\".",
    "type" : "Bundle"
  }]
}