Sequoia Project Healthcare Directory Implementation Guide
1.2.0 - Release 1
Sequoia Project Healthcare Directory Implementation Guide
1.2.0 - Release 1
| Active as of 2024-12-23 |
{
"resourceType" : "CapabilityStatement",
"id" : "directory-capability-statement",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement directory-capability-statement</b></p><a name=\"directory-capability-statement\"> </a><a name=\"hcdirectory-capability-statement\"> </a><a name=\"directory-capability-statement-en-US\"> </a><h2 id=\"title\">Sequoia Project Healthcare Directory</h2><ul><li>Implementation Guide Version: 1.2.0 </li><li>FHIR Version: 4.0.0 </li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Supported Patch Formats: </li><li>Published on: 2024-12-23 </li><li>Published by: The Sequoia Project </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h3 id=\"shallIGs\">SHALL Support the Following Implementation Guides</h3><ul><li>https://sequoiaproject.org/fhir/sphd</li></ul><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div><p>Sequoia Project FHIR Provider Directory</p>\n</div><div class=\"lead\"><em>Security</em></div><div class=\"row\"><div class=\"col-lg-6\">Enable CORS: no</div><div class=\"col-lg-6\">Security services supported: <code>Basic</code></div></div><div class=\"lead\"><em>Summary of System-wide Interactions</em></div><ul><li>Supports the <code>search-system</code>interaction described as follows:<div><p>You can search organizations with several fields and also with their combination</p>\n</div></li></ul></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th class=\"text-center\"><b title=\"DELETE a resource (delete interaction)\">D</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#Organization1-1\">Organization</a></td><td><a href=\"StructureDefinition-SequoiaOrganization.html\">https://sequoiaproject.org/fhir/sphd/StructureDefinition/SequoiaOrganization</a></td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td>_id, _name, _lastUpdated, _zip, _city, _state, _radius, _active</td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Organization1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Organization</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-SequoiaOrganization.html\">Sequoia Organization</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <br/><code>read</code><div><p>Some operations require permission</p>\n</div><code>create</code><div><p>Some operations require permission</p>\n</div><code>update</code><div><p>Some operations require permission</p>\n</div><code>delete</code><div><p>Some operations require permission</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>_id</td><td><code>number</code></td><td><div><p>Search with the id of organization</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>_name</td><td><code>string</code></td><td><div><p>Search with the name of organization</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>_lastUpdated</td><td><code>date</code></td><td><div><p>Search with the lastUpdated of organization</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>_zip</td><td><code>string</code></td><td><div><p>Search with the zip of organization</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>_city</td><td><code>string</code></td><td><div><p>Search with the city of organization</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>_state</td><td><code>string</code></td><td><div><p>Search with the state of organization</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>_radius</td><td><code>string</code></td><td><div><p>Search with the radius of organization</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>_active</td><td><code>string</code></td><td><div><p>Search with the active of organization</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div></div>"
},
"url" : "https://sequoiaproject.org/fhir/sphd/CapabilityStatement/directory-capability-statement",
"version" : "1.2.0",
"name" : "SequoiaProjectHealthcareDirectory",
"title" : "Sequoia Project Healthcare Directory",
"status" : "active",
"date" : "2024-12-23",
"publisher" : "The Sequoia Project",
"contact" : [
{
"name" : "The Sequoia Project",
"telecom" : [
{
"system" : "url",
"value" : "https://sequoiaproject.org/"
}
]
}
],
"description" : "Sequoia Project FHIR Provider Directory",
"kind" : "capability",
"software" : {
"name" : "Sequoia Project FHIR Provider Directory"
},
"fhirVersion" : "4.0.0",
"format" : [
"xml",
"json"
],
"implementationGuide" : [
"https://sequoiaproject.org/fhir/sphd"
],
"rest" : [
{
"mode" : "server",
"documentation" : "Sequoia Project FHIR Provider Directory",
"security" : {
"cors" : false,
"service" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/restful-security-service",
"code" : "Basic"
}
]
}
]
},
"resource" : [
{
"type" : "Organization",
"profile" : "https://sequoiaproject.org/fhir/sphd/StructureDefinition/SequoiaOrganization",
"interaction" : [
{
"code" : "read",
"documentation" : "Some operations require permission"
},
{
"code" : "create",
"documentation" : "Some operations require permission"
},
{
"code" : "update",
"documentation" : "Some operations require permission"
},
{
"code" : "delete",
"documentation" : "Some operations require permission"
}
],
"versioning" : "no-version",
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchParam" : [
{
"name" : "_id",
"type" : "number",
"documentation" : "Search with the id of organization"
},
{
"name" : "_name",
"type" : "string",
"documentation" : "Search with the name of organization"
},
{
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "Search with the lastUpdated of organization"
},
{
"name" : "_zip",
"type" : "string",
"documentation" : "Search with the zip of organization"
},
{
"name" : "_city",
"type" : "string",
"documentation" : "Search with the city of organization"
},
{
"name" : "_state",
"type" : "string",
"documentation" : "Search with the state of organization"
},
{
"name" : "_radius",
"type" : "string",
"documentation" : "Search with the radius of organization"
},
{
"name" : "_active",
"type" : "string",
"documentation" : "Search with the active of organization"
}
]
}
],
"interaction" : [
{
"code" : "search-system",
"documentation" : "You can search organizations with several fields and also with their combination"
}
]
}
]
}