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

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

## Resource Profile: OHH Practitioner 

| | |
| :--- | :--- |
| *Official URL*:https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/practitioner-with-key | *Version*:0.1.0 |
| Active as of 2025-12-03 | *Computable Name*:PractitionerWithKey |

 
Practitioner representation used by the Open Health Hub Platform for both care providers (with public key) and caregivers (with signature). 

## Scope and Usage 

The Practitioner resembles a user in the Open Health Hub Platform. There are two types of users:

* A program care provider participant (see below), this is a participant that can view the responses of the questionnaires. The Practitioner resource for this type of participant can be used to retrieve a public key used for encrypting a [QuestionnaireResponse](StructureDefinition-encrypted-questionnaire-response.md).
* A program caregiver participant. This is a participant that is supposed to fill out questionnaires about the patient as part of the program. This participant has a specific role in the program and has a name and email address. The caregiver participant will also have an extension with url `https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/caregiver-signature` which contains the signature of the user uuid. This can be used to construct the form filler url.

**Usages:**

* Examples for this Profile: [Practitioner/0c41aec8-286c-4a7d-8714-8137a199f46e](Practitioner-0c41aec8-286c-4a7d-8714-8137a199f46e.md) and [Practitioner/2d61c3c5-c0ce-4cee-ad0a-9e83289a5b61](Practitioner-2d61c3c5-c0ce-4cee-ad0a-9e83289a5b61.md)
* CapabilityStatements using this Profile: [OHH FHIR API](CapabilityStatement-ohh-capability-statement.md)

You can also check for [usages in the FHIR IG Statistics](https://packages2.fhir.org/xig/ohh-fhir|current/StructureDefinition/practitioner-with-key)

### Formal Views of Profile Content

 [Description of Profiles, Differentials, Snapshots and how the different presentations work](http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#structure-definitions). 

 

Other representations of profile: [CSV](StructureDefinition-practitioner-with-key.csv), [Excel](StructureDefinition-practitioner-with-key.xlsx), [Schematron](StructureDefinition-practitioner-with-key.sch) 

### Notes:

### Retrieving Practitioners

Retrieving a Practitioner by ID is currently only possible for the client itself. To search for other Practitioners, you’ll need to [search](http://hl7.org/fhir/R4/search.html) them by CareTeam id.



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "practitioner-with-key",
  "url" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/practitioner-with-key",
  "version" : "0.1.0",
  "name" : "PractitionerWithKey",
  "title" : "Practitioner With Key Profile",
  "status" : "active",
  "date" : "2025-12-03T12:00:57+00:00",
  "publisher" : "Open Health Hub",
  "contact" : [
    {
      "name" : "Open Health Hub",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.openhealthhub.com"
        },
        {
          "system" : "email",
          "value" : "support@openhealthhub.com"
        }
      ]
    }
  ],
  "description" : "Practitioner representation used by the Open Health Hub Platform for both care providers (with public key) and caregivers (with signature).",
  "fhirVersion" : "4.0.1",
  "mapping" : [
    {
      "identity" : "v2",
      "uri" : "http://hl7.org/v2",
      "name" : "HL7 v2 Mapping"
    },
    {
      "identity" : "rim",
      "uri" : "http://hl7.org/v3",
      "name" : "RIM Mapping"
    },
    {
      "identity" : "servd",
      "uri" : "http://www.omg.org/spec/ServD/1.0/",
      "name" : "ServD"
    },
    {
      "identity" : "w5",
      "uri" : "http://hl7.org/fhir/fivews",
      "name" : "FiveWs Pattern Mapping"
    }
  ],
  "kind" : "resource",
  "abstract" : false,
  "type" : "Practitioner",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Practitioner",
  "derivation" : "constraint",
  "differential" : {
    "element" : [
      {
        "id" : "Practitioner",
        "path" : "Practitioner",
        "constraint" : [
          {
            "key" : "practitioner-extension-rule",
            "severity" : "warning",
            "human" : "A Practitioner must have a public key extension (for care providers) or a signature extension (for caregivers)",
            "expression" : "extension.where(url = 'https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/participant-program-public-key').exists() or extension.where(url = 'https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/caregiver-signature').exists()",
            "source" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/practitioner-with-key"
          }
        ]
      },
      {
        "id" : "Practitioner.id",
        "path" : "Practitioner.id",
        "min" : 1,
        "mustSupport" : true
      },
      {
        "id" : "Practitioner.extension",
        "path" : "Practitioner.extension",
        "slicing" : {
          "discriminator" : [
            {
              "type" : "value",
              "path" : "url"
            }
          ],
          "ordered" : false,
          "rules" : "open"
        }
      },
      {
        "id" : "Practitioner.extension:participantProgramPublicKey",
        "path" : "Practitioner.extension",
        "sliceName" : "participantProgramPublicKey",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Extension",
            "profile" : [
              "https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/participant-program-public-key"
            ]
          }
        ]
      },
      {
        "id" : "Practitioner.extension:caregiverSignature",
        "path" : "Practitioner.extension",
        "sliceName" : "caregiverSignature",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Extension",
            "profile" : [
              "https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/caregiver-signature"
            ]
          }
        ]
      },
      {
        "id" : "Practitioner.identifier",
        "path" : "Practitioner.identifier",
        "max" : "1",
        "mustSupport" : true
      },
      {
        "id" : "Practitioner.identifier.system",
        "path" : "Practitioner.identifier.system",
        "patternUri" : "urn:ietf:rfc:3986"
      },
      {
        "id" : "Practitioner.identifier.value",
        "path" : "Practitioner.identifier.value",
        "mustSupport" : true
      },
      {
        "id" : "Practitioner.name",
        "path" : "Practitioner.name",
        "max" : "1",
        "mustSupport" : true
      },
      {
        "id" : "Practitioner.name.text",
        "path" : "Practitioner.name.text",
        "mustSupport" : true
      },
      {
        "id" : "Practitioner.telecom",
        "path" : "Practitioner.telecom",
        "slicing" : {
          "discriminator" : [
            {
              "type" : "value",
              "path" : "system"
            }
          ],
          "rules" : "open"
        },
        "max" : "1",
        "mustSupport" : true
      },
      {
        "id" : "Practitioner.telecom:email",
        "path" : "Practitioner.telecom",
        "sliceName" : "email",
        "min" : 0,
        "max" : "1",
        "mustSupport" : true
      },
      {
        "id" : "Practitioner.telecom:email.system",
        "path" : "Practitioner.telecom.system",
        "min" : 1,
        "patternCode" : "email"
      },
      {
        "id" : "Practitioner.telecom:email.value",
        "path" : "Practitioner.telecom.value",
        "mustSupport" : true
      }
    ]
  }
}

```
