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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

OHH Capability Statement

Capability Statement describing the supported transactions and resource of the OHH FHIR platform

Structures: Abstract Profiles

These are profiles on resources or data types that describe patterns used by other profiles, but cannot be instantiated directly. I.e. instances can conform to profiles based on these abstract profiles, but do not declare conformance to the abstract profiles themselves.

OHH Base CarePlan

Base CarePlan Profile used by both Create and Retrieve CarePlan profiles

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

OHH CarePlan Task

Task describing OHH specific actions for CarePlans

OHH CareTeam

Either a collection of careproviders or caregivers that are part of the workflow

OHH Create CarePlan

CarePlan Profile used when creating new CarePlans

OHH Encrypted QuestionnaireResponse

A QuestionnaireResponse where the answers are encrypted

OHH Patient

Patient that is the subject of the CarePlan

OHH PlanDefinition

PlanDefinition used to describe workflow around Questionnaires

OHH Practitioner

Practitioner that represents a caregiver and/or careprovider in the OHH Questionnaire workflow

OHH Public Key Binary

Binary used to upload the public key used to encrypt QuestionnaireResponses

OHH Questionnaire

Questionnaire describing the OHH Questionnaires as designed in the Form Designer

OHH Retrieve CarePlan

CarePlan Profile used when retrieving CarePlans

OHH Subscription

Subscription used to subscribe to OHH resources

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

Caregiver Signature

Signature of the user uuid used to construct the form filler url

Custom Invite Image

Custom image to be displayed with the invitation

Custom Invite Text

Custom text to be displayed with the invitation

Encrypted Answers

All answers encrypted in a single array

Encrypted Attachment Extension

Extension containing encrypted attachment value

Encrypted Boolean Extension

Extension containing encrypted boolean value

Encrypted Coding Extension

Extension containing encrypted coding value

Encrypted Date Extension

Extension containing encrypted date value

Encrypted Date Time Extension

Extension containing encrypted dateTime value

Encrypted Decimal Extension

Extension containing encrypted decimal value

Encrypted Integer Extension

Extension containing encrypted integer value

Encrypted Open Choice Extension

Extension containing encrypted open choice value

Encrypted String Extension

Extension containing encrypted string value

Encrypted Time Extension

Extension containing encrypted time value

Form Filler Program Task URL

URL for accessing a specific task in the form filler application

Form Filler Program Timeline

URL for accessing the program timeline in the form filler application

ISO-8601 Duration Extension

Extension representing the duration in the ISO-8601 format

Participant Program Public Key

Public key for the participant to access the program

Patient Signature Extension

Extension for patient signature

Program Link

URL for patient to access the program via the invitation system

Program PIN

PIN code for the patient to access the program

Related Questionnaire

Reference to a related questionnaire

Task UUID

The UUID of the program task this activity represents

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

OHH CareTeam Category

Describes the role of the CareTeam in the workflow

OHH Patient Identifier Type

Extended identifier type for the OHH Patient

OHH PlanDefinition Action Type

Actions related to PlanDefinitions

OHH Questionnaire Item Control

Extended item control with OHH specific controls

OHH Questionnaire Type

Types of questionnaires as used in Retrieve CarePlan

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

OHH Action Type

Actions related to PlanDefinitions

OHH CarePlan Task

Actions that need to be performed on CarePlan creation

OHH CareTeam Category

Describes the role of the CareTeam in the workflow

OHH Program Use Context

Values describing how a PlanDefinition can be used in the OHH ecosystem

OHH Questionnaire Item Control

Additional item control codes beyond the standard FHIR questionnaire-item-control codes

OHH Questionnaire Type

Types of questionnaires offered by the OHH ecosystem

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

OHH CareTeam with care providers

Example of an OHH CareTeam containing care providers

OHH CareTeam with caregivers

Example of an OHH CareTeam containing caregivers

OHH Create CarePlan

Example of an OHH Create CarePlan

OHH Encrypted Questionnaire Response

Example of an OHH Encrypted QuestionnaireResponse with contained patient

OHH Patient

Example of an OHH Patient

OHH PlanDefinition

Example of an OHH PlanDefinition with Patient and Practitioner tasks

OHH Practitioner with public key

Example of an OHH Practitioner with public key (care provider)

OHH Practitioner with signature

Example of an OHH Practitioner with signature (caregiver)

OHH Questionnaire

Example of an OHH Questionnaire

OHH Questionnaire for Caregiver

Example of an OHH Questionnaire for a caregiver

OHH Retrieve CarePlan

Example of an OHH Retrieve CarePlan

OHH Subscription no payload

Example of an OHH Subscription on CarePlans without payload

OHH Subscription with payload

Example of an OHH Subscription on QuestionnaireResponse with payload

Oncologist Practitioner

Example of an Oncologist Practitioner used when creating a CarePlan with caregivers

Psychologist Practitioner

Example of a Psychologist Practitioner used when creating a CarePlan with caregivers