Operation-subscription-status.json

Operation Definition

{
  "resourceType" : "OperationDefinition",
  "id" : "Subscription-status",
  "text" : {
    "status" : "extensions",
    "div" : "<div>!-- Snipped for Brevity --></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/OperationDefinition/Subscription-status",
  "version" : "4.6.0",
  "name" : "status",
  "title" : "Get Current Subscription Status for One or More Subscriptions",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2021-04-15T12:25:09+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 return the current SubscriptionStatus information about one or more Subscriptions.",
  "affectsState" : false,
  "code" : "status",
  "resource" : ["Subscription"],
  "system" : false,
  "type" : true,
  "instance" : true,
  "parameter" : [{
    "name" : "ids",
    "use" : "in",
    "min" : 0,
    "max" : "*",
    "documentation" : "At the Resource level, one or more parameters containing one or more comma-delimited FHIR ids of Subscriptions to get status information for.  In the absense of any specified ids, the server returns the status for all Subscriptions available to the caller.  At the Instance level, this parameter is ignored.",
    "type" : "id"
  },
  {
    "name" : "return",
    "use" : "out",
    "min" : 1,
    "max" : "1",
    "documentation" : "The bundle type is \"searchset\"",
    "type" : "Bundle"
  }]
}