eHealthExchange Healthcare Directory Implementation Guide
1.8.1 - Release 1

: OrgHierarchy - JSON Representation

Active as of 2025-10-27

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "org-hierarchy",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition org-hierarchy</b></p><a name=\"org-hierarchy\"> </a><a name=\"hcorg-hierarchy\"> </a><p>URL: [base]/Organization/[id]/$org-hierarchy</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>_lastUpdated</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#instant\">instant</a></td><td/><td><div><p>Filter on Organization.meta.lastUpdated.</p>\n</div></td></tr><tr><td>IN</td><td>active</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"https://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td/><td><div><p>Filter on Organization.active.</p>\n</div></td></tr><tr><td>IN</td><td>type</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"https://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td/><td><div><p>Filter on Organization.type.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>Bundle of organizations representing the requested hierarchy.</p>\n</div></td></tr></table></div>"
  },
  "url" : "https://sequoiaproject.org/fhir/ehx/OperationDefinition/org-hierarchy",
  "version" : "1.8.1",
  "name" : "OrgHierarchy",
  "title" : "Org Hierarchy",
  "status" : "active",
  "kind" : "operation",
  "date" : "2025-10-27T13:14:09-04:00",
  "publisher" : "eHealthExchange",
  "contact" : [
    {
      "name" : "eHealthExchange",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://ehealthexchange.org/"
        }
      ]
    }
  ],
  "description" : "Retrieves all organizations below one top level organization.",
  "code" : "org-hierarchy",
  "base" : "https://sequoiaproject.org/fhir/ehx/OperationDefinition/org-hierarchy",
  "resource" : [
    "Organization"
  ],
  "system" : false,
  "type" : false,
  "instance" : true,
  "parameter" : [
    {
      "name" : "_lastUpdated",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "Filter on Organization.meta.lastUpdated.",
      "type" : "instant"
    },
    {
      "name" : "active",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "Filter on Organization.active.",
      "type" : "string",
      "searchType" : "token"
    },
    {
      "name" : "type",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "Filter on Organization.type.",
      "type" : "string",
      "searchType" : "token"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "Bundle of organizations representing the requested hierarchy.",
      "type" : "Bundle"
    }
  ]
}