This page is part of the Subscriptions R5 Backport (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

• Narrative Content
• XML
• JSON
• TTL

: Backport Subscription Status Operation - JSON Representation

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "Backport-subscription-status",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2>R5SubscriptionStatus</h2><p>OPERATION: R5SubscriptionStatus</p><p>The official URL for this operation definition is: </p><pre>http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/Backport-subscription-status</pre><div><p>This operation is used to return the current status information about one or more backported R5-Style Subscriptions in R4.</p>\n</div><p>URL: [base]/Subscription/$status</p><p>Parameters</p><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</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>ids</td><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#id\">id</a></td><td/><td><div><p>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.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>The bundle type is &quot;searchset&quot;. The operation returns a bundle containing one or more Parameters resources, compliant with &quot;backport-subscriptionstatus&quot;, one per Subscription being queried.</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/uv/subscriptions-backport/OperationDefinition/Backport-subscription-status",
  "version" : "0.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/index.cfm"
        }
      ]
    },
    {
      "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 backported R5-Style Subscriptions in R4.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "code" : "status",
  "resource" : [
    "Subscription"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "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\". The operation returns a bundle containing one or more Parameters resources, compliant with \"backport-subscriptionstatus\", one per Subscription being queried.",
      "type" : "Bundle"
    }
  ]
}