HL7® FHIR® Te Aho o Te Kahu, Cancer Control Agency Implementation Guide, published by Te Aho o Te Kahu, Cancer Control Agency. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/cca/ and changes regularly. See the Directory of published versions
Extension: Regimen under review
| Official URL: http://hl7.org.nz/fhir/StructureDefinition/sact-additional-plan-status | Version: 0.1.0 | |||
| Active as of 2026-05-21 | Computable Name: AdditionalPlanStatus | |||
Additional status values for PlanDefinition. Currently only a single value - review - indicating that a regimen is published and available to be used, but there is still a review being performed, so could change. In most situations the value of the status element itself will be 'active'
Context of Use
-
Element ID:
PlanDefinition.status
This extension may be used on the following element(s)
Usage info
Usages:
- Use this Extension: PlanDefinition
- Examples for this Extension: PlanDefinition/ColoRectal
You can also check for usages in the FHIR IG Statistics
Formal Views of Extension Content
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Extension |
0..* | Extension | Regimen under review | |
  extension |
0..0 | Extension | ||
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/sact-additional-plan-status" | |
  value[x] |
0..1 | code | Value of extension Binding: PlanDefinition additional status (required) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Regimen under review | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/sact-additional-plan-status" | |
| value[x] |
0..1 | code | Value of extension Binding: PlanDefinition additional status (required) | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Simple Extension with the type code: Additional status values for PlanDefinition. Currently only a single value - review - indicating that a regimen is published and available to be used, but there is still a review being performed, so could change. In most situations the value of the status element itself will be 'active'
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Regimen under review | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/sact-additional-plan-status" | |
| value[x] |
0..1 | code | Value of extension Binding: PlanDefinition additional status (required) | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Regimen under review | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/sact-additional-plan-status" | |
| value[x] |
0..1 | code | Value of extension Binding: PlanDefinition additional status (required) | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Simple Extension with the type code: Additional status values for PlanDefinition. Currently only a single value - review - indicating that a regimen is published and available to be used, but there is still a review being performed, so could change. In most situations the value of the status element itself will be 'active'
Other representations of profile: CSV, Excel, Schematron
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.value[x] | Base | required | PlanDefinition additional status | 📦0.1.0 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|