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

## 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 | Download

## 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 (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type 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)

Resource Type | Profile | R | S | U | C | D | Searches | `_include` | `_revinclude` | Operations
--- | --- | --- | --- | --- | --- | --- | --- | --- | --- | ---
Binary | https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-public-key-binary |  |  |  | y |  |  |  |  |
CarePlan | Supported Profiles OHH Create Care Plan Profile OHH Retrieve Care Plan Profile | y | y | y | y | y | _id, _since, instantiates-canonical, patient.email, patient.identifier, status | `CarePlan:care-team`, `CareTeam:participant` |  |
CareTeam | https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-care-team | y | y |  |  |  | _id | `CareTeam:participant` |  |
OperationDefinition | http://hl7.org/fhir/StructureDefinition/OperationDefinition | y |  |  |  |  |  |  |  |
PlanDefinition | https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-plan-definition | y | y |  |  |  | _since, context, definition, publisher |  |  |
Practitioner | https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/practitioner-with-key | y | y |  |  |  |  |  |  |
Questionnaire | https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-questionnaire | y | y |  |  |  |  |  |  |
QuestionnaireResponse | https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/EncryptedQuestionnaireResponse | y | y |  | y |  | _since, based-on.instantiates-canonical, patient.identifier, questionnaire, status | `*`, `QuestionnaireResponse:based-on.instantiates-canonical`, `QuestionnaireResponse:questionnaire` |  |
Subscription | https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-subscription | y | y |  | y | y | criteria |  |  |

#### Resource Conformance: supported Binary

Base System Profile
OHH Public Key Binary Profile
Profile Conformance
SHALL
Reference Policy

Interaction summary

- Supports `create`.

#### Resource Conformance: supported CarePlan

Core FHIR Resource
CarePlan
Reference Policy
Interaction summary

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

Supported Profiles

OHH Create Care Plan Profile
OHH Retrieve Care Plan Profile

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `string` | The ID of the resource
SHALL | _since | `date` | CarePlan has been updated after this date/time
SHALL | instantiates-canonical | `reference` | Instantiates FHIR PlanDefinition
SHALL | patient.email | `token` | Email of patient subject who the CarePlan is for
SHALL | patient.identifier | `token` | Identifier of patient subject who the CarePlan is for
SHALL | status | `token` | The status of the CarePlan

#### Resource Conformance: supported CareTeam

Base System Profile
Ohh Care Team Profile
Profile Conformance
SHALL
Reference Policy

Interaction summary

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

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `string` | The ID of the resource

#### Resource Conformance: supported OperationDefinition

Base System Profile
OperationDefinition
Profile Conformance
SHALL
Reference Policy

Interaction summary

- Supports `read`.

#### Resource Conformance: supported PlanDefinition

Base System Profile
OHH Plan Definition Profile
Profile Conformance
SHALL
Reference Policy

Interaction summary

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

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _since | `date` |
SHALL | context | `token` | The OHH FHIR Viewer context
SHALL | definition | `reference` | Activity or plan definitions used by plan definition
SHALL | publisher | `string` | Name of the publisher of the plan definition

#### Resource Conformance: supported Practitioner

Base System Profile
Practitioner With Key Profile
Profile Conformance
SHALL
Reference Policy

Interaction summary

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

#### Resource Conformance: supported Questionnaire

Base System Profile
Ohh Questionnaire Profile
Profile Conformance
SHALL
Reference Policy

Interaction summary

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

#### Resource Conformance: supported QuestionnaireResponse

Base System Profile
Encrypted Questionnaire Response Profile
Profile Conformance
SHALL
Reference Policy

Interaction summary

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

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _since | `date` |
SHALL | based-on.instantiates-canonical | `reference` | PlanDefinition fulfilled by this questionnaire response
SHALL | patient.identifier | `token` | The patient that is the subject of the questionnaire response
SHALL | questionnaire | `reference` | The questionnaire the answers are provided for
SHALL | status | `token` | The status of the questionnaire response

#### Resource Conformance: supported Subscription

Base System Profile
OHH Subscription Profile
Profile Conformance
SHALL
Reference Policy

Interaction summary

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

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | criteria | `string` | The search rules used to determine when to send a notification