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 Te Aho o Te Kahu, Cancer Control Agency. 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
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.
CapabilityStatement |
Represents API exposed to retrieve plans |
These define data models that represent the domain covered by this implementation guide in more business-friendly terms than the underlying FHIR resources.
CancerRegimensLM |
CancerRegimens |
These define constraints on FHIR resources for systems conforming to this implementation guide.
ActivityDefinition |
CCA Regimen Activity Definition. |
PlanDefinition |
CCA Regimen Plan Definition. |
These define constraints on FHIR data types for systems conforming to this implementation guide.
Dosage |
CCA Regimen Dosage. |
These define constraints on FHIR data types for systems conforming to this implementation guide.
AdditionalDetails |
Allows additional information to be added to a regimen such as dosing modification details |
Disclaimer |
A disclaimer for use of this Plan |
Instructions for use |
Specific instructions for use of the regimen overall, or for the individual cycles |
LocationAdministration |
The physical Location where the medication administration occurs (eg home or clinic) |
LocationMedicationCollection |
The physical Location where the medication can be collection prior to collection |
Off label |
Indicates that the medication is being used for a purpose for which it has not been specifically approved |
Regimen type |
The overall type of the regimen - eg FOLFOX |
Regimen under review |
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’ |
Replaced by |
When a Plan has been deprecated (superceeded or discontinued), refers to the one that replaces it, if any |
SupportFactor |
Support factors needed during treatment |
TimingOfDays |
Allows specific days to be indicated in a component of a regimen cycle. extends the idea of UV extension: http://hl7.org/fhir/extension-timing-daysofcycle.html by adding instructions |
TreatmentSetting |
The setting of the regimen - what is its purpose |
These define sets of codes used by systems conforming to this implementation guide.
Administration location |
The physical location where the administration occurred - eg at home or in a clinic |
Cancer type |
The type of Cancer |
Medication collection location |
The physical location where the medication can be collected on prior to administration - eg a pharmacy |
Medication dose administration frequency |
The dose administration frequency |
Medication dose unit |
The dose unit |
PlanDefinition additional status |
Other codes used for the PlanDefinition status |
Possible values for Support Factors |
The set of all possible support factors values (not specific to any one factor) |
Regimen type code |
The type of regimen - eg FOLFOX |
Route |
Route |
Support Factors |
The set of possible support factors (not their values) |
Treatment setting |
The setting of the regimen - what is its purpose |
These define new code systems used by systems conforming to this implementation guide.
PlanDefinition additional status |
Other codes used for the PlanDefinition status |
Regimen type code |
Codes used for the regimen type |
Treatment setting |
The setting of the regimen - what is its purpose |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
ActCabergoline |
Cabergoline Administration |
ActTragacanth |
Tragacanth Administration |
Colorectal Adjuvant FOLFOX (a7) |
Example Plan definition for coloRectal cancer |
GU PROS Castration resistant Metastatic - abiraterone and dexamethasone |
A drug treatment regimen for Urogenital Prostate Castration resistant Metastatic - abiraterone and dexamethasone |
GYN END Adjuvant - cISplatin chemoradiation followed by cARBOplatin and PACLItaxel |
A drug treatment regimen for Gynaecological Endometrial Adjuvant - cISplatin chemoradiation followed by cARBOplatin and PACLItaxel |
LUNG NSCLC Metastatic - alectinib |
A drug treatment regimen for Respiratory Non small cell lung cancer Metastatic - alectinib |
LUNG NSCLC NON-Metastatic - alectinib |
A drug treatment regimen for Respiratory Non small cell lung cancer NON-Metastatic - alectinib |
SuperceededPlan |
A plan that has been superceeded by another |