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

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

## Resource Profile: OHH PlanDefinition 

| | |
| :--- | :--- |
| *Official URL*:https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-plan-definition | *Version*:0.1.0 |
| Active as of 2025-12-03 | *Computable Name*:OhhPlanDefinition |

 
PlanDefinition describes the actions needed as part of a care path for a patient. 

### Scope and Usage

The PlanDefinition is the FHIR representation of the program as created in the Open Health Hub Form Designer. The PlanDefinition contains all the tasks of a program, represented by actions and goals.

**Usages:**

* Refer to this Profile: [Ohh Base Care Plan Profile](StructureDefinition-ohh-base-care-plan.md)
* Examples for this Profile: [Test_PlanDefinition](PlanDefinition-a7b4be95-7fd1-480c-9f62-0100adfde3db.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/ohh-plan-definition)

### 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-ohh-plan-definition.csv), [Excel](StructureDefinition-ohh-plan-definition.xlsx), [Schematron](StructureDefinition-ohh-plan-definition.sch) 

### Notes:

### Retrieving versioned PlanDefinitions

Programs and therefore PlanDefinitions are versioned. If you retrieve the PlanDefinition by id, you’ll get the latest version. You can also request a specific version. It is possible that some patients use an old version, where new patients are on the latest version of the PlanDefinition. When referencing the PlanDefinition in the CarePlan, we therefore reference a specific version of the PlanDefinition. See [Handling versioned resources](CapabilityStatement-ohh-capability-statement.md#handling-versioned-resources) for more info on retrieving versioned resources.



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "ohh-plan-definition",
  "url" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-plan-definition",
  "version" : "0.1.0",
  "name" : "OhhPlanDefinition",
  "title" : "OHH Plan Definition 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" : "PlanDefinition describes the actions needed as part of a care path for a patient.",
  "fhirVersion" : "4.0.1",
  "mapping" : [
    {
      "identity" : "workflow",
      "uri" : "http://hl7.org/fhir/workflow",
      "name" : "Workflow Pattern"
    },
    {
      "identity" : "w5",
      "uri" : "http://hl7.org/fhir/fivews",
      "name" : "FiveWs Pattern Mapping"
    },
    {
      "identity" : "objimpl",
      "uri" : "http://hl7.org/fhir/object-implementation",
      "name" : "Object Implementation Information"
    },
    {
      "identity" : "rim",
      "uri" : "http://hl7.org/v3",
      "name" : "RIM Mapping"
    }
  ],
  "kind" : "resource",
  "abstract" : false,
  "type" : "PlanDefinition",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/PlanDefinition",
  "derivation" : "constraint",
  "differential" : {
    "element" : [
      {
        "id" : "PlanDefinition",
        "path" : "PlanDefinition"
      },
      {
        "id" : "PlanDefinition.useContext",
        "path" : "PlanDefinition.useContext",
        "slicing" : {
          "discriminator" : [
            {
              "type" : "value",
              "path" : "code"
            }
          ],
          "description" : "Slice on useContext.code",
          "ordered" : false,
          "rules" : "open"
        }
      },
      {
        "id" : "PlanDefinition.useContext:fhirViewerInvites",
        "path" : "PlanDefinition.useContext",
        "sliceName" : "fhirViewerInvites",
        "min" : 0,
        "max" : "1"
      },
      {
        "id" : "PlanDefinition.useContext:fhirViewerInvites.code",
        "path" : "PlanDefinition.useContext.code",
        "patternCoding" : {
          "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
          "code" : "program"
        }
      },
      {
        "id" : "PlanDefinition.useContext:fhirViewerInvites.value[x]",
        "path" : "PlanDefinition.useContext.value[x]",
        "slicing" : {
          "discriminator" : [
            {
              "type" : "type",
              "path" : "$this"
            }
          ],
          "ordered" : false,
          "rules" : "open"
        }
      },
      {
        "id" : "PlanDefinition.useContext:fhirViewerInvites.value[x]:valueCodeableConcept",
        "path" : "PlanDefinition.useContext.value[x]",
        "sliceName" : "valueCodeableConcept",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "CodeableConcept"
          }
        ],
        "patternCodeableConcept" : {
          "coding" : [
            {
              "system" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/program-use-context",
              "code" : "fhir-viewer-invite"
            }
          ]
        }
      },
      {
        "id" : "PlanDefinition.goal",
        "path" : "PlanDefinition.goal",
        "min" : 1,
        "mustSupport" : true
      },
      {
        "id" : "PlanDefinition.goal.target.due.extension",
        "path" : "PlanDefinition.goal.target.due.extension",
        "slicing" : {
          "discriminator" : [
            {
              "type" : "value",
              "path" : "url"
            }
          ],
          "description" : "Extensions are always sliced by (at least) url",
          "rules" : "closed"
        },
        "min" : 1,
        "max" : "1"
      },
      {
        "id" : "PlanDefinition.goal.target.due.extension:iso-8601-duration",
        "path" : "PlanDefinition.goal.target.due.extension",
        "sliceName" : "iso-8601-duration",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "Extension",
            "profile" : [
              "https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration"
            ]
          }
        ]
      },
      {
        "id" : "PlanDefinition.action",
        "path" : "PlanDefinition.action",
        "slicing" : {
          "discriminator" : [
            {
              "type" : "value",
              "path" : "participant.type"
            }
          ],
          "rules" : "open"
        },
        "min" : 1,
        "mustSupport" : true
      },
      {
        "id" : "PlanDefinition.action.timing[x]",
        "path" : "PlanDefinition.action.timing[x]",
        "type" : [
          {
            "code" : "Duration"
          }
        ]
      },
      {
        "id" : "PlanDefinition.action.timing[x].extension",
        "path" : "PlanDefinition.action.timing[x].extension",
        "min" : 1,
        "max" : "1"
      },
      {
        "id" : "PlanDefinition.action.timing[x].extension:iso-8601-duration",
        "path" : "PlanDefinition.action.timing[x].extension",
        "sliceName" : "iso-8601-duration",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Extension",
            "profile" : [
              "https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration"
            ]
          }
        ]
      },
      {
        "id" : "PlanDefinition.action.participant.role.coding.system",
        "path" : "PlanDefinition.action.participant.role.coding.system",
        "max" : "0"
      },
      {
        "id" : "PlanDefinition.action.definition[x]",
        "path" : "PlanDefinition.action.definition[x]",
        "type" : [
          {
            "code" : "canonical",
            "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Questionnaire"]
          }
        ]
      },
      {
        "id" : "PlanDefinition.action.action",
        "path" : "PlanDefinition.action.action",
        "type" : [
          {
            "code" : "BackboneElement"
          }
        ]
      },
      {
        "id" : "PlanDefinition.action.action.code",
        "path" : "PlanDefinition.action.action.code",
        "slicing" : {
          "discriminator" : [
            {
              "type" : "value",
              "path" : "coding.system"
            }
          ],
          "rules" : "open"
        },
        "min" : 1
      },
      {
        "id" : "PlanDefinition.action.action.code:action-type",
        "path" : "PlanDefinition.action.action.code",
        "sliceName" : "action-type",
        "min" : 1,
        "max" : "1",
        "binding" : {
          "strength" : "preferred",
          "valueSet" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/ValueSet/plan-definition-action-type-value-set"
        }
      },
      {
        "id" : "PlanDefinition.action.action.code:action-type.coding.system",
        "path" : "PlanDefinition.action.action.code.coding.system",
        "min" : 1,
        "patternUri" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/action-type"
      },
      {
        "id" : "PlanDefinition.action.action.code:notification",
        "path" : "PlanDefinition.action.action.code",
        "sliceName" : "notification",
        "min" : 0,
        "max" : "1"
      },
      {
        "id" : "PlanDefinition.action.action.code:notification.coding.system",
        "path" : "PlanDefinition.action.action.code.coding.system",
        "min" : 1,
        "patternUri" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/push_notification"
      },
      {
        "id" : "PlanDefinition.action:patientAction",
        "path" : "PlanDefinition.action",
        "sliceName" : "patientAction",
        "min" : 0,
        "max" : "*",
        "mustSupport" : true
      },
      {
        "id" : "PlanDefinition.action:patientAction.timing[x].extension:iso-8601-duration",
        "path" : "PlanDefinition.action.timing[x].extension",
        "sliceName" : "iso-8601-duration",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Extension",
            "profile" : [
              "https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration"
            ]
          }
        ]
      },
      {
        "id" : "PlanDefinition.action:patientAction.participant.type",
        "path" : "PlanDefinition.action.participant.type",
        "patternCode" : "patient"
      },
      {
        "id" : "PlanDefinition.action:patientAction.participant.role",
        "path" : "PlanDefinition.action.participant.role",
        "max" : "0"
      },
      {
        "id" : "PlanDefinition.action:practitionerAction",
        "path" : "PlanDefinition.action",
        "sliceName" : "practitionerAction",
        "min" : 0,
        "max" : "*",
        "mustSupport" : true
      },
      {
        "id" : "PlanDefinition.action:practitionerAction.timing[x].extension:iso-8601-duration",
        "path" : "PlanDefinition.action.timing[x].extension",
        "sliceName" : "iso-8601-duration",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Extension",
            "profile" : [
              "https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/iso-8601-duration"
            ]
          }
        ]
      },
      {
        "id" : "PlanDefinition.action:practitionerAction.participant.type",
        "path" : "PlanDefinition.action.participant.type",
        "patternCode" : "practitioner"
      },
      {
        "id" : "PlanDefinition.action:practitionerAction.participant.role.text",
        "path" : "PlanDefinition.action.participant.role.text",
        "min" : 1
      }
    ]
  }
}

```
