# Regimen Careplan - ACT-NOW Implementation Guide v0.5.0

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **Regimen Careplan**

## Resource Profile: Regimen Careplan 

| | |
| :--- | :--- |
| *Official URL*:http://canshare.co.nz/fhir/StructureDefinition/an-careplan-regimen | *Version*:0.5.0 |
| Draft as of 2026-06-15 | *Computable Name*:CareplanRegimen |

 
A CarePlan that represents a PlanDefinition being applied to a Patient. Referred to as a regimen. The regimen has multiple cycles also represented as CarePlans which have a 'partOf' reference back to the regimen plan. 

**Usages:**

* Refer to this Profile: [Cycle Careplan](StructureDefinition-an-careplan-cycle.md)
* Examples for this Profile: [CarePlan/careplan-regimen-1](CarePlan-careplan-regimen-1.md) and [CarePlan/careplan-regimen-2](CarePlan-careplan-regimen-2.md)
* CapabilityStatements using this Profile: [CapabilityStatement representing the server requirements for a FHIR server](CapabilityStatement-AnCapabilityStatement.md)

You can also check for [usages in the FHIR IG Statistics](https://packages2.fhir.org/xig/resource/actnow.canshare.co.nz|current/StructureDefinition/StructureDefinition-an-careplan-regimen.json)

### 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-an-careplan-regimen.csv), [Excel](StructureDefinition-an-careplan-regimen.xlsx), [Schematron](StructureDefinition-an-careplan-regimen.sch) 



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "an-careplan-regimen",
  "url" : "http://canshare.co.nz/fhir/StructureDefinition/an-careplan-regimen",
  "version" : "0.5.0",
  "name" : "CareplanRegimen",
  "title" : "Regimen Careplan",
  "status" : "draft",
  "date" : "2026-06-15T22:12:46+00:00",
  "publisher" : "Te aho o te kahu - Cancer Control Agency",
  "contact" : [{
    "name" : "Te aho o te kahu - Cancer Control Agency",
    "telecom" : [{
      "system" : "email",
      "value" : "mailto:david.hay25@gmail.com"
    }]
  }],
  "description" : "A CarePlan that represents a PlanDefinition being applied to a Patient. Referred to as a regimen. The regimen\nhas multiple cycles also represented as CarePlans which have a 'partOf' reference back to the regimen plan.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "urn:iso:std:iso:3166",
      "code" : "NZ",
      "display" : "New Zealand"
    }]
  }],
  "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" : "http://hl7.org/fhir/StructureDefinition/CarePlan",
  "derivation" : "constraint",
  "differential" : {
    "element" : [{
      "id" : "CarePlan",
      "path" : "CarePlan",
      "constraint" : [{
        "key" : "an-regimenCP-1",
        "severity" : "error",
        "human" : "If the CarePlan was cancelled, then the cancellation reason extension must be present",
        "expression" : "CarePlan.status = 'revoked' implies extension('http://canshare.co.nz/fhir/StructureDefinition/an-regimen-discontinued').exists()",
        "source" : "http://canshare.co.nz/fhir/StructureDefinition/an-careplan-regimen"
      }]
    },
    {
      "id" : "CarePlan.extension",
      "path" : "CarePlan.extension",
      "slicing" : {
        "discriminator" : [{
          "type" : "value",
          "path" : "url"
        }],
        "ordered" : false,
        "rules" : "open"
      },
      "min" : 1
    },
    {
      "id" : "CarePlan.extension:intent-of-treatment",
      "path" : "CarePlan.extension",
      "sliceName" : "intent-of-treatment",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://canshare.co.nz/fhir/StructureDefinition/an-iot"]
      }]
    },
    {
      "id" : "CarePlan.extension:clinical-trial",
      "path" : "CarePlan.extension",
      "sliceName" : "clinical-trial",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://canshare.co.nz/fhir/StructureDefinition/an-clinical-trial"]
      }],
      "mustSupport" : true
    },
    {
      "id" : "CarePlan.extension:cycle-count",
      "path" : "CarePlan.extension",
      "sliceName" : "cycle-count",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://canshare.co.nz/fhir/StructureDefinition/an-cycle-count"]
      }],
      "mustSupport" : true
    },
    {
      "id" : "CarePlan.extension:regimen-discontinued",
      "path" : "CarePlan.extension",
      "sliceName" : "regimen-discontinued",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://canshare.co.nz/fhir/StructureDefinition/an-regimen-discontinued"]
      }],
      "mustSupport" : true
    },
    {
      "id" : "CarePlan.extension:overall-treatment-utility",
      "path" : "CarePlan.extension",
      "sliceName" : "overall-treatment-utility",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://canshare.co.nz/fhir/StructureDefinition/an-regimen-otu"]
      }],
      "mustSupport" : true
    },
    {
      "id" : "CarePlan.extension:regimen-type",
      "path" : "CarePlan.extension",
      "sliceName" : "regimen-type",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org.nz/fhir/StructureDefinition/sact-regimen-type"]
      }],
      "mustSupport" : true
    },
    {
      "id" : "CarePlan.extension:course-number",
      "path" : "CarePlan.extension",
      "sliceName" : "course-number",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://canshare.co.nz/fhir/StructureDefinition/an-course-number"]
      }],
      "mustSupport" : true
    },
    {
      "id" : "CarePlan.identifier",
      "path" : "CarePlan.identifier",
      "min" : 1
    },
    {
      "id" : "CarePlan.intent",
      "path" : "CarePlan.intent",
      "patternCode" : "plan"
    },
    {
      "id" : "CarePlan.category",
      "path" : "CarePlan.category",
      "min" : 1
    },
    {
      "id" : "CarePlan.category.coding",
      "path" : "CarePlan.category.coding",
      "slicing" : {
        "discriminator" : [{
          "type" : "pattern",
          "path" : "code"
        }],
        "rules" : "open"
      },
      "min" : 1
    },
    {
      "id" : "CarePlan.category.coding:regimencode",
      "path" : "CarePlan.category.coding",
      "sliceName" : "regimencode",
      "short" : "Regimen level carePlan",
      "definition" : "Code identifying this carePlan as being at the regimen level",
      "min" : 1,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "CarePlan.category.coding:regimencode.system",
      "path" : "CarePlan.category.coding.system",
      "patternUri" : "http://snomed.info/sct/21000210109"
    },
    {
      "id" : "CarePlan.category.coding:regimencode.code",
      "path" : "CarePlan.category.coding.code",
      "min" : 1,
      "patternCode" : "261751000210101"
    },
    {
      "id" : "CarePlan.period",
      "path" : "CarePlan.period",
      "min" : 1,
      "constraint" : [{
        "key" : "an-period-1",
        "severity" : "error",
        "human" : "The end date of a period must be greater than or equal to the start date",
        "expression" : "Period.end >= Period.start",
        "source" : "http://canshare.co.nz/fhir/StructureDefinition/an-careplan-regimen"
      }]
    }]
  }
}

```
