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
| 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
application/fhir+xml, application/fhir+jsonNote 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.
serverSome 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.
The | version above is the business version of a resource and is unrelated to meta.versionId. Resources that support version-aware updates (Subscription) return their current meta.versionId, also as the ETag header. Send this value in an optional If-Match header (e.g. If-Match: W/"1") when updating the resource to prevent overwriting changes made in the meantime.
transactioninteraction 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.
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revincludecreate.update, search-type, read, delete, create.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | string | The ID of the resource |
| SHALL | _since | date | CarePlan has been updated after this date/time |
| SHALL | identifier | token | Identifier of the CarePlan |
| 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 |
search-type, read.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | string | The ID of the resource |
read.search-type, read.| 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 |
| SHALL | _id | token |
search-type, read.search-type, read.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | url | uri | |
| SHALL | version | number |
search-type, read, create.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _since | date | |
| SHALL | based-on | reference | CarePlan this questionnaire response is part of, e.g. CarePlan/123. Cannot be combined with based-on.instantiates-canonical |
| SHALL | based-on.instantiates-canonical | reference | PlanDefinition fulfilled by this questionnaire response. Cannot be combined with based-on |
| 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 |
search-type, read, delete, createupdateAn optional If-Match header containing the current meta.versionId of the Subscription prevents overwriting changes made in the meantime.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | criteria | string | The search rules used to determine when to send a notification |
read, search-typeupdateOnly the status of a notification task (ohh-participant-task with code PUSH_NOTIFICATION) can be updated, and a call task (code CALL_PATIENT) can be completed; all other elements are ignored. The status of a notification can no longer be changed once the patient has completed a questionnaire of the CarePlan.
The tasks of the patient and caregivers of a CarePlan and the call tasks of its care provider. A questionnaire or notification Task has the same id as the
activity.detail.idin the CarePlan. Search results are sorted newest first; use_sort=authored-onfor oldest first.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | based-on | reference | CarePlan this task is part of, e.g. CarePlan/123. Cannot be combined with based-on.instantiates-canonical |
| SHALL | based-on.instantiates-canonical | reference | PlanDefinition of the CarePlan this task is part of. Cannot be combined with based-on |
| SHALL | code | token | The kind of task: |
| SHALL | patient.identifier | token | Identifier of the patient the task is for |
| SHALL | status | token | The status of the task: requested, ready, in-progress, completed, cancelled or failed |