HL7® FHIR® Te Aho o Te Kahu, Cancer Control Agency Implementation Guide
0.1.0 - CI Build

HL7® FHIR® Te Aho o Te Kahu, Cancer Control Agency Implementation Guide, published by David Hay. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/HL7NZ/cca/ and changes regularly. See the Directory of published versions

Notes

Plan status

The status of the overall plan is exposed in the PlanDefinition.status element, supported by an extension. The statuses that are used are:

Business statusMeaningPlanDefinition.statusExtension
PublishedThe regimen is available for useactive
Provisionally published The regimen is available for use, but is still undergoing a review so may change activeregimen-under-review
DiscontinuedThe regimen is no longer in useretired
SuperceededThe regimen is no longer in use, but has been superceeded by anotherretired replaced-by

Cycle repeats

As noted in the background, the top most action element (attached to the resource root) represents a cycle of medication adminstration with the details of the cycles (ie the medications) present as child action elements, with a reference to the ActivityDefinition. The cycles are intended to be extecuted in series - completing one cycle (and its repeats) before moving on to the next one.

As well as having any number of defined cycles in the [plan, an individual cycle can also repeat any number of times, which is indicated in the action.timingTiming element. The element (which is a Timing datatype) has the following child elements.

  • .repeat.count - the number of times this cycle should repeat. If this element is absent, then the cycle can repeat any number of times, as dictated by the physician in charge. Otherwise, the value is the number of times that this cycle should be repeated before moving on to the next one.
  • .repeat.duration / repeat.durationUnit - the length of a single cycle. This will always be present.

It is common to have regimens with multiple cycles where all cycles except for the last one have a specific count value, and the last cycle has no count, meaning that the last cycle can be repeated any number of times, but the repeats for the others are defined.

Examples

A cycle of 14 days which is only executed once

"timingTiming": {
    "repeat": {
      "count": 1,
      "duration": 14,
      "durationUnit": "d"
    }
  }

A cycle of 28 days repeated twice

"timingTiming": {
    "repeat": {
      "count": 2,
      "duration": 14,
      "durationUnit": "d"
    }
  }

A cycle of 20 days which can be executed any number of times

"timingTiming": {
    "repeat": {
      "duration": 20,
      "durationUnit": "d"
    }
  }

UseContext

The PlanDefinition.useContext element is used for 2 main items.

The cancers for which the regimen is intended to treat. There can be up to 3 of these, representing the cancer type, sub-type and sub-sub-type. The ‘code’ value for these is ‘focus’ - indicating that these are the focus of the regimen.

Infusion rate

For an infusable medication, the datatype used to indicate the infusion rate (Part of the dosage) is a Range. The range has 2 values - low and high. The high value will always be present and represents the ‘usual’ rate of administration. If the low value is present, then that represents the minimum period over which the infusion should be made.