# OHH Capability Statement - Open Health Hub FHIR Implementation Guide v0.1.0

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **OHH Capability Statement**

## CapabilityStatement: OHH Capability Statement 

| | |
| :--- | :--- |
| *Official URL*:https://api.openhealthhub.com/OpenHealthhub/fhir/4/CapabilityStatement/ohh-capability-statement | *Version*:0.1.0 |
| Active as of 2025-10-13 | *Computable Name*:OHH_FHIR_API |

 
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. 

 [Raw OpenAPI-Swagger Definition file](ohh-capability-statement.openapi.json) | [Download](ohh-capability-statement.openapi.json) 

## OHH FHIR API

* Implementation Guide Version: 0.1.0 
* FHIR Version: 4.0.1 
* Supported Formats: `application/fhir+xml`, `xml`, `application/fhir+json`, `json`
* Published on: 2025-10-13 
* Published by: Open Health Hub 

> **Note to Implementers: FHIR Capabilities**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.

## FHIR RESTful Capabilities

### Mode: server

#### Handling versioned resources

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`.

**Summary of System-wide Interactions**

* Supports the `transaction`interaction described as follows:

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.

For `transaction` requests we currently only support posting a set of QuestionnaireResponses.


### Capabilities by Resource/Profile

#### Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

* The relevant profiles (if any)
* The interactions supported by each resource (**R**ead, **S**earch, **U**pdate, and **C**reate, are always shown, while **VR**ead, **P**atch, **D**elete, **H**istory on **I**nstance, or **H**istory on **T**ype are only present if at least one of the resources has support for them.
* The required, recommended, and some optional search parameters (if any).
* The linked resources enabled for `_include`
* The other resources enabled for `_revinclude`
* The operations on the resource (if any)

| | | | | | | | | | | |
| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- |
| [Binary](#Binary1-1) | [https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-public-key-binary](StructureDefinition-ohh-public-key-binary.md) |  |  |  | y |  |  |  |  |  |
| [CarePlan](#CarePlan1-2) | Supported Profiles  [OHH Create Care Plan Profile](StructureDefinition-ohh-create-care-plan.md)  [OHH Retrieve Care Plan Profile](StructureDefinition-ohh-retrieve-care-plan.md) | y | y | y | y | y | _id, _since, instantiates-canonical, patient.email, patient.identifier, status | `CarePlan:care-team`,`CareTeam:participant` |  |  |
| [CareTeam](#CareTeam1-3) | [https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-care-team](StructureDefinition-ohh-care-team.md) | y | y |  |  |  | _id | `CareTeam:participant` |  |  |
| [OperationDefinition](#OperationDefinition1-4) | [http://hl7.org/fhir/StructureDefinition/OperationDefinition](http://hl7.org/fhir/R4/operationdefinition.html) | y |  |  |  |  |  |  |  |  |
| [PlanDefinition](#PlanDefinition1-5) | [https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-plan-definition](StructureDefinition-ohh-plan-definition.md) | y | y |  |  |  | _since, context, definition, publisher |  |  |  |
| [Practitioner](#Practitioner1-6) | [https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/practitioner-with-key](StructureDefinition-practitioner-with-key.md) | y | y |  |  |  |  |  |  |  |
| [Questionnaire](#Questionnaire1-7) | [https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-questionnaire](StructureDefinition-ohh-questionnaire.md) | y | y |  |  |  |  |  |  |  |
| [QuestionnaireResponse](#QuestionnaireResponse1-8) | [https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/EncryptedQuestionnaireResponse](StructureDefinition-encrypted-questionnaire-response.md) | y | y |  | y |  | _since, based-on.instantiates-canonical, patient.identifier, questionnaire, status | `*`,`QuestionnaireResponse:based-on.instantiates-canonical`,`QuestionnaireResponse:questionnaire` |  |  |
| [Subscription](#Subscription1-9) | [https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-subscription](StructureDefinition-ohh-subscription.md) | y | y |  | y | y | criteria |  |  |  |

-------

#### Resource Conformance: supported Binary

Base System Profile

[OHH Public Key Binary Profile](StructureDefinition-ohh-public-key-binary.md)

Profile Conformance

**SHALL**

Reference Policy

Interaction summary

* Supports `create`.

#### Resource Conformance: supported CarePlan

Core FHIR Resource

[CarePlan](http://hl7.org/fhir/R4/careplan.html)

Reference Policy

Interaction summary

* Supports `update`, `search-type`, `read`, `delete`, `create`.

Supported Profiles
[OHH Create Care Plan Profile](StructureDefinition-ohh-create-care-plan.md)
[OHH Retrieve Care Plan Profile](StructureDefinition-ohh-retrieve-care-plan.md)

Search Parameters


 

#### Resource Conformance: supported CareTeam

Base System Profile

[Ohh Care Team Profile](StructureDefinition-ohh-care-team.md)

Profile Conformance

**SHALL**

Reference Policy

Interaction summary

* Supports `search-type`, `read`.

Search Parameters


 

#### Resource Conformance: supported OperationDefinition

Base System Profile

[OperationDefinition](http://hl7.org/fhir/R4/operationdefinition.html)

Profile Conformance

**SHALL**

Reference Policy

Interaction summary

* Supports `read`.

#### Resource Conformance: supported PlanDefinition

Base System Profile

[OHH Plan Definition Profile](StructureDefinition-ohh-plan-definition.md)

Profile Conformance

**SHALL**

Reference Policy

Interaction summary

* Supports `search-type`, `read`.

Search Parameters


 

#### Resource Conformance: supported Practitioner

Base System Profile

[Practitioner With Key Profile](StructureDefinition-practitioner-with-key.md)

Profile Conformance

**SHALL**

Reference Policy

Interaction summary

* Supports `search-type`, `read`.

#### Resource Conformance: supported Questionnaire

Base System Profile

[Ohh Questionnaire Profile](StructureDefinition-ohh-questionnaire.md)

Profile Conformance

**SHALL**

Reference Policy

Interaction summary

* Supports `search-type`, `read`.

#### Resource Conformance: supported QuestionnaireResponse

Base System Profile

[Encrypted Questionnaire Response Profile](StructureDefinition-encrypted-questionnaire-response.md)

Profile Conformance

**SHALL**

Reference Policy

Interaction summary

* Supports `search-type`, `read`, `create`.

Search Parameters


 

#### Resource Conformance: supported Subscription

Base System Profile

[OHH Subscription Profile](StructureDefinition-ohh-subscription.md)

Profile Conformance

**SHALL**

Reference Policy

Interaction summary

* Supports `search-type`, `read`, `delete`, `create`.

Search Parameters


 



## Resource Content

```json
{
  "resourceType" : "CapabilityStatement",
  "id" : "ohh-capability-statement",
  "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."
        }
      ]
    }
  ]
}

```
