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

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

## Resource Profile: OHH Create CarePlan 

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

 
A profile on the CarePlan resource for creating new care plans. 

### Scope and Usage 

A CarePlan can be created to instantiate a PlanDefinition for a specific patient. The patient and (if applicable) the caregivers referenced in the PlanDefinition will be able to fill out the Questionnaires that are part of the PlanDefinition.

**Usages:**

* Examples for this Profile: [CarePlan/ExampleCreateCarePlan](CarePlan-ExampleCreateCarePlan.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-create-care-plan)

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

### Notes:

We always remove any time portion from the period.start field. We start the program at the start of the remaining date (in UTC). When retrieving a CarePlan the start date will always be in timezone Europe/Amsterdam. So for a CarePlan with period.start set to 2022-12-02T03:00:00+05:00 the program will start at 2022-12-02T01:00:00+01:00.

#### Activities

We offer the possibility to automatically create a user for the patient (if it doesn’t exist yet), register the patient to the program and send an invitation email to the patient. To achieve this, you should add an `activity` element to the CarePlan. The activity should contain a reference to a contained `Task` resource, where the [desired actions](CodeSystem-care-plan-task.md) can be specified.

Note that you can’t use `register-patient` without also enabling `create-user`.

Please see the [create CarePlan JSON](CarePlan-ExampleCreateCarePlan.json.md) for an example what this looks like in a complete CarePlan request.

For more information about the returned CarePlan see [Retrieving a CarePlan](StructureDefinition-ohh-retrieve-care-plan.md).

#### Caregivers

When a program has questionnaires that need to be filled out by caregivers of the patient, the caregivers need to be specified when creating a CarePlan for a patient. This can be done by setting the `careTeam` field. The CareTeam reference should point to a contained CareTeam resource. This CareTeam resource should list all Practitioners for all caregiver roles used in the program. The Practitioner can be referenced as a contained resource, or by id (if known). The [create CarePlan example](CarePlan-ExampleCreateCarePlan.json.md) includes a contained CareTeam and Practitioner with the role `psychologist`, and an `oncologist` referenced by id.



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "ohh-create-care-plan",
  "url" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-create-care-plan",
  "version" : "0.1.0",
  "name" : "OhhCreateCarePlan",
  "title" : "OHH Create Care Plan 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" : "A profile on the CarePlan resource for creating new care plans.",
  "fhirVersion" : "4.0.1",
  "mapping" : [
    {
      "identity" : "workflow",
      "uri" : "http://hl7.org/fhir/workflow",
      "name" : "Workflow Pattern"
    },
    {
      "identity" : "rim",
      "uri" : "http://hl7.org/v3",
      "name" : "RIM Mapping"
    },
    {
      "identity" : "w5",
      "uri" : "http://hl7.org/fhir/fivews",
      "name" : "FiveWs Pattern Mapping"
    },
    {
      "identity" : "v2",
      "uri" : "http://hl7.org/v2",
      "name" : "HL7 v2 Mapping"
    }
  ],
  "kind" : "resource",
  "abstract" : false,
  "type" : "CarePlan",
  "baseDefinition" : "https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-base-care-plan",
  "derivation" : "constraint",
  "differential" : {
    "element" : [
      {
        "id" : "CarePlan",
        "path" : "CarePlan"
      },
      {
        "id" : "CarePlan.activity",
        "path" : "CarePlan.activity",
        "max" : "1",
        "mustSupport" : true
      },
      {
        "id" : "CarePlan.activity.reference",
        "path" : "CarePlan.activity.reference",
        "type" : [
          {
            "code" : "Reference",
            "targetProfile" : [
              "https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-care-plan-task"
            ]
          }
        ],
        "mustSupport" : true
      }
    ]
  }
}

```
