Open Health Hub FHIR Implementation Guide
0.1.0 - v0.1.0
Open Health Hub FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Active as of 2025-10-13 |
{
"resourceType" : "CapabilityStatement",
"id" : "ohh-capability-statement",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement ohh-capability-statement</b></p><a name=\"ohh-capability-statement\"> </a><a name=\"hcohh-capability-statement\"> </a><h2 id=\"title\">OHH FHIR API</h2><ul><li>Implementation Guide Version: 0.1.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+xml</code>, <code>xml</code>, <code>application/fhir+json</code>, <code>json</code></li><li>Published on: 2025-10-13 </li><li>Published by: Open Health Hub </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><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><h4>Handling versioned resources</h4>\n<p>Some of our resources (e.g., Questionnaire and PlanDefinition) are versioned. When you retrieve a versioned resource by id, you'll always get the latest version. If you want to get a specific version, you can append the id with a <code>|</code> and the version you want to retrieve. Make sure you URL-encode the <code>|</code> using <code>%7C</code>.</p>\n</div><div class=\"lead\"><em>Summary of System-wide Interactions</em></div><ul><li>Supports the <code>transaction</code>interaction described as follows:<div><p>We currently support <code>batch</code> requests for all our supported resources. Please note that for batch requests there should not be any dependencies between actions in the request. Every action will be handled as a single standalone action.</p>\n<p>For <code>transaction</code> requests we currently only support posting a set of QuestionnaireResponses.</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=\"#Binary1-1\">Binary</a></td><td><a href=\"StructureDefinition-ohh-public-key-binary.html\">https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-public-key-binary</a></td><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\">y</td><td class=\"text-center\"/><td/><td/><td/><td/></tr><tr><td><a href=\"#CarePlan1-2\">CarePlan</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-ohh-create-care-plan.html\">OHH Create Care Plan Profile</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-ohh-retrieve-care-plan.html\">OHH Retrieve Care Plan Profile</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td>_id, _since, instantiates-canonical, patient.email, patient.identifier, status</td><td><code>CarePlan:care-team</code>, <code>CareTeam:participant</code></td><td/><td/></tr><tr><td><a href=\"#CareTeam1-3\">CareTeam</a></td><td><a href=\"StructureDefinition-ohh-care-team.html\">https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-care-team</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\"/><td>_id</td><td><code>CareTeam:participant</code></td><td/><td/></tr><tr><td><a href=\"#OperationDefinition1-4\">OperationDefinition</a></td><td><a href=\"http://hl7.org/fhir/R4/operationdefinition.html\">http://hl7.org/fhir/StructureDefinition/OperationDefinition</a></td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\"/><td/><td/><td/><td/></tr><tr><td><a href=\"#PlanDefinition1-5\">PlanDefinition</a></td><td><a href=\"StructureDefinition-ohh-plan-definition.html\">https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-plan-definition</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\"/><td>_since, context, definition, publisher</td><td/><td/><td/></tr><tr><td><a href=\"#Practitioner1-6\">Practitioner</a></td><td><a href=\"StructureDefinition-practitioner-with-key.html\">https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/practitioner-with-key</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\"/><td/><td/><td/><td/></tr><tr><td><a href=\"#Questionnaire1-7\">Questionnaire</a></td><td><a href=\"StructureDefinition-ohh-questionnaire.html\">https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-questionnaire</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\"/><td/><td/><td/><td/></tr><tr><td><a href=\"#QuestionnaireResponse1-8\">QuestionnaireResponse</a></td><td><a href=\"StructureDefinition-encrypted-questionnaire-response.html\">https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/EncryptedQuestionnaireResponse</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\">y</td><td class=\"text-center\"/><td>_since, based-on.instantiates-canonical, patient.identifier, questionnaire, status</td><td><code>*</code>, <code>QuestionnaireResponse:based-on.instantiates-canonical</code>, <code>QuestionnaireResponse:questionnaire</code></td><td/><td/></tr><tr><td><a href=\"#Subscription1-9\">Subscription</a></td><td><a href=\"StructureDefinition-ohh-subscription.html\">https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-subscription</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td>criteria</td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Binary1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Binary</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-ohh-public-key-binary.html\">OHH Public Key Binary Profile</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 <code>create</code>.</li></ul></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"CarePlan1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>CarePlan</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/careplan.html\">CarePlan</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>update</code>, <code>search-type</code>, <code>read</code>, <code>delete</code>, <code>create</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-ohh-create-care-plan.html\">OHH Create Care Plan Profile</a><br/><a href=\"StructureDefinition-ohh-retrieve-care-plan.html\">OHH Retrieve Care Plan Profile</a></p></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>string</code></td><td><div><p>The ID of the resource</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>_since</td><td><code>date</code></td><td><div><p>CarePlan has been updated after this date/time</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>instantiates-canonical</td><td><code>reference</code></td><td><div><p>Instantiates FHIR PlanDefinition</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>patient.email</td><td><code>token</code></td><td><div><p>Email of patient subject who the CarePlan is for</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>patient.identifier</td><td><code>token</code></td><td><div><p>Identifier of patient subject who the CarePlan is for</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>status</td><td><code>token</code></td><td><div><p>The status of the CarePlan</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"CareTeam1-3\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>CareTeam</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-ohh-care-team.html\">Ohh Care Team Profile</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 <code>search-type</code>, <code>read</code>.</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>string</code></td><td><div><p>The ID of the resource</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"OperationDefinition1-4\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>OperationDefinition</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=\"http://hl7.org/fhir/R4/operationdefinition.html\">OperationDefinition</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 <code>read</code>.</li></ul></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"PlanDefinition1-5\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>PlanDefinition</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-ohh-plan-definition.html\">OHH Plan Definition Profile</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 <code>search-type</code>, <code>read</code>.</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>_since</td><td><code>date</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>context</td><td><code>token</code></td><td><div><p>The OHH FHIR Viewer context</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>definition</td><td><code>reference</code></td><td><div><p>Activity or plan definitions used by plan definition</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>publisher</td><td><code>string</code></td><td><div><p>Name of the publisher of the plan definition</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Practitioner1-6\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Practitioner</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-practitioner-with-key.html\">Practitioner With Key Profile</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 <code>search-type</code>, <code>read</code>.</li></ul></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Questionnaire1-7\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Questionnaire</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-ohh-questionnaire.html\">Ohh Questionnaire Profile</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 <code>search-type</code>, <code>read</code>.</li></ul></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"QuestionnaireResponse1-8\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>QuestionnaireResponse</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-encrypted-questionnaire-response.html\">Encrypted Questionnaire Response Profile</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 <code>search-type</code>, <code>read</code>, <code>create</code>.</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>_since</td><td><code>date</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>based-on.instantiates-canonical</td><td><code>reference</code></td><td><div><p>PlanDefinition fulfilled by this questionnaire response</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>patient.identifier</td><td><code>token</code></td><td><div><p>The patient that is the subject of the questionnaire response</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>questionnaire</td><td><code>reference</code></td><td><div><p>The questionnaire the answers are provided for</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>status</td><td><code>token</code></td><td><div><p>The status of the questionnaire response</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Subscription1-9\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Subscription</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-ohh-subscription.html\">OHH Subscription Profile</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 <code>search-type</code>, <code>read</code>, <code>delete</code>, <code>create</code>.</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>criteria</td><td><code>string</code></td><td><div><p>The search rules used to determine when to send a notification</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div></div>"
},
"url" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/CapabilityStatement/ohh-capability-statement",
"version" : "0.1.0",
"name" : "OHH_FHIR_API",
"title" : "OHH FHIR API",
"status" : "active",
"date" : "2025-10-13",
"publisher" : "Open Health Hub",
"contact" : [
{
"name" : "Open Health Hub",
"telecom" : [
{
"system" : "url",
"value" : "https://www.openhealthhub.com"
},
{
"system" : "email",
"value" : "support@openhealthhub.com"
}
]
}
],
"description" : "Since we're not a full-fledged FHIR Resource Server, our supported FHIR interactions and search capabilities are focused on the the workflow around FHIR Questionnaires.",
"kind" : "instance",
"software" : {
"name" : "ohh-fhir",
"version" : "1.0.0"
},
"implementation" : {
"description" : "Open Health Hub FHIR gateway"
},
"fhirVersion" : "4.0.1",
"format" : [
"application/fhir+xml",
"xml",
"application/fhir+json",
"json"
],
"rest" : [
{
"mode" : "server",
"documentation" : "#### Handling versioned resources \n\n Some of our resources (e.g., Questionnaire and PlanDefinition) are versioned. When you retrieve a versioned resource by id, you'll always get the latest version. If you want to get a specific version, you can append the id with a `|` and the version you want to retrieve. Make sure you URL-encode the `|` using `%7C`.",
"resource" : [
{
"type" : "Binary",
"profile" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-public-key-binary",
"interaction" : [
{
"code" : "create"
}
]
},
{
"type" : "CarePlan",
"supportedProfile" : [
🔗 "https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-create-care-plan"🔗 ,
"https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-retrieve-care-plan"
],
"interaction" : [
{
"code" : "update"
},
{
"code" : "search-type"
},
{
"code" : "read"
},
{
"code" : "delete"
},
{
"code" : "create"
}
],
"conditionalUpdate" : false,
"conditionalDelete" : "single",
"searchInclude" : [
"CarePlan:care-team",
"CareTeam:participant"
],
"searchParam" : [
{
"name" : "_id",
"type" : "string",
"documentation" : "The ID of the resource"
},
{
"name" : "_since",
"type" : "date",
"documentation" : "CarePlan has been updated after this date/time"
},
{
"name" : "instantiates-canonical",
"type" : "reference",
"documentation" : "Instantiates FHIR PlanDefinition"
},
{
"name" : "patient.email",
"type" : "token",
"documentation" : "Email of patient subject who the CarePlan is for"
},
{
"name" : "patient.identifier",
"type" : "token",
"documentation" : "Identifier of patient subject who the CarePlan is for"
},
{
"name" : "status",
"type" : "token",
"documentation" : "The status of the CarePlan"
}
]
},
{
"type" : "CareTeam",
"profile" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-care-team",
"interaction" : [
{
"code" : "search-type"
},
{
"code" : "read"
}
],
"searchInclude" : [
"CareTeam:participant"
],
"searchParam" : [
{
"name" : "_id",
"type" : "string",
"documentation" : "The ID of the resource"
}
]
},
{
"type" : "OperationDefinition",
"profile" : "http://hl7.org/fhir/StructureDefinition/OperationDefinition",
"interaction" : [
{
"code" : "read"
}
]
},
{
"type" : "PlanDefinition",
"profile" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-plan-definition",
"interaction" : [
{
"code" : "search-type"
},
{
"code" : "read"
}
],
"searchParam" : [
{
"name" : "_since",
"type" : "date"
},
{
"name" : "context",
"type" : "token",
"documentation" : "The OHH FHIR Viewer context"
},
{
"name" : "definition",
"type" : "reference",
"documentation" : "Activity or plan definitions used by plan definition"
},
{
"name" : "publisher",
"type" : "string",
"documentation" : "Name of the publisher of the plan definition"
}
]
},
{
"type" : "Practitioner",
"profile" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/practitioner-with-key",
"interaction" : [
{
"code" : "search-type"
},
{
"code" : "read"
}
]
},
{
"type" : "Questionnaire",
"profile" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-questionnaire",
"interaction" : [
{
"code" : "search-type"
},
{
"code" : "read"
}
]
},
{
"type" : "QuestionnaireResponse",
"profile" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/EncryptedQuestionnaireResponse",
"interaction" : [
{
"code" : "search-type"
},
{
"code" : "read"
},
{
"code" : "create"
}
],
"searchInclude" : [
"*",
"QuestionnaireResponse:based-on.instantiates-canonical",
"QuestionnaireResponse:questionnaire"
],
"searchParam" : [
{
"name" : "_since",
"type" : "date"
},
{
"name" : "based-on.instantiates-canonical",
"type" : "reference",
"documentation" : "PlanDefinition fulfilled by this questionnaire response"
},
{
"name" : "patient.identifier",
"type" : "token",
"documentation" : "The patient that is the subject of the questionnaire response"
},
{
"name" : "questionnaire",
"type" : "reference",
"documentation" : "The questionnaire the answers are provided for"
},
{
"name" : "status",
"type" : "token",
"documentation" : "The status of the questionnaire response"
}
]
},
{
"type" : "Subscription",
"profile" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-subscription",
"interaction" : [
{
"code" : "search-type"
},
{
"code" : "read"
},
{
"code" : "delete"
},
{
"code" : "create"
}
],
"searchParam" : [
{
"name" : "criteria",
"type" : "string",
"documentation" : "The search rules used to determine when to send a notification"
}
]
}
],
"interaction" : [
{
"code" : "transaction",
"documentation" : "We currently support `batch` requests for all our supported resources. Please note that for batch requests there should not be any dependencies between actions in the request. Every action will be handled as a single standalone action. \n\n For `transaction` requests we currently only support posting a set of QuestionnaireResponses."
}
]
}
]
}