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

Logical Model: CancerRegimensLM - Detailed Descriptions

Definitions for the CancerRegimensLM logical model.

1. CancerRegimens
Definition

No description

Control1..1 This element is affected by the following invariants: ele-1
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
2. CancerRegimens.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
3. CancerRegimens.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on CancerRegimens.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. CancerRegimens.status
Definition

The overall status for the regimen. Includes that the regimen is approved for use (status=active) but is still under review so may change.

Control0..1
Typecode
Must Supporttrue
5. CancerRegimens.version
Definition

The version of the regimen

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
6. CancerRegimens.title
Definition

A short title that describes the regimen, suitable for a display

Control0..1
Typestring
Must Supporttrue
7. CancerRegimens.description
Definition

A more detailed description

Control0..1
Typestring
Must Supporttrue
8. CancerRegimens.instructions
Definition

Overall instructions for use. Distinct from the description of the regimen

Control0..1
Typestring
9. CancerRegimens.publisher
Definition

The organisation responsible for publishing the regimen

Control0..1
Typestring
10. CancerRegimens.date
Definition

When the regimen was first made available for use

Control0..1
TypedateTime
11. CancerRegimens.type
Definition

The type od regimen - eg FOLFOX

Control0..1
TypeCodeableConcept
12. CancerRegimens.intent
Definition

The intent of the regimen - eg curative or palliative

Control0..1
TypeCodeableConcept
13. CancerRegimens.replacedBy
Definition

populated if this regimen is no longer active, but has been replaced by another. Refers directly to the replacement regimen. Note that there is not a reference from the replacement regimen back to this one.

Control0..1
Typestring
Must Supporttrue
14. CancerRegimens.cancerTypes
Definition

The types of cancer that this regimen is intended to treat. There can be up to 3 - type, subType, subSubType.

Control0..1
TypeBackboneElement
Must Supporttrue
15. CancerRegimens.cancerTypes.primaryType
Definition

The main cancer that the regimen is targeted to. This will be the first one in the list and will always be present.

Control0..1
TypeCodeableConcept
16. CancerRegimens.cancerTypes.subType
Definition

The cancer sub-type. Will be second in the list, if present.

Control0..1
TypeCodeableConcept
17. CancerRegimens.cancerTypes.subSubType
Definition

The cancer sub-sub-type. Will be third in the list, if present.

Control0..1
TypeCodeableConcept
18. CancerRegimens.supportFactor
Definition

Factors - such as medications - that may be needed by the patient during a course of treatment - often to counter side-effects of treatment.

Control0..*
TypeBackboneElement
19. CancerRegimens.supportFactor.type
Definition

The type of sub-factor - eg anti-emetic

Control0..1
TypeCodeableConcept
20. CancerRegimens.supportFactor.value
Definition

The actual factor - eg a specific anti-emetic

Control0..1
TypeCodeableConcept
21. CancerRegimens.disclaimer
Definition

Important notes about the regimen to a potential user

Control0..1
Typestring
22. CancerRegimens.references
Definition

Related artifacts such as additional documentation, justification, or bibliographic references.

Control0..*
TypeBackboneElement
23. CancerRegimens.references.type
Definition

The type of related artifact

Control0..1
Typecode
24. CancerRegimens.references.display
Definition

A string suitable for display

Control0..1
Typestring
25. CancerRegimens.references.url
Definition

The location where the artefact can be retrieved from

Control0..1
Typeuri
26. CancerRegimens.cycle
Definition

Represents a single cycle of treatment. Note that in the FHIR resource, the cycle is nested...

Control1..*
TypeBackboneElement
27. CancerRegimens.cycle.description
Definition

A human readable description of what the cycle is. eg "Cabergoline administration, 2mg over 20 minutes" repeated weekly for 4 weeks

Control0..1
Typestring
28. CancerRegimens.cycle.instructions
Definition

Specific instructions for use during this cycle (as opposed to a description OF the cycle)

Control0..1
Typestring
29. CancerRegimens.cycle.duration
Definition

The length of the cycle in days

Control0..1
TypeIdentifier
30. CancerRegimens.cycle.medicationAdministration
Definition

The details of medication administration within this cycle. Details of the administration are in the medication element.

Control1..*
TypeBackboneElement
31. CancerRegimens.cycle.medicationAdministration.description
Definition

Human description of the medication

Control0..1
Typestring
32. CancerRegimens.cycle.medicationAdministration.dailyAdmin
Definition

Describes the days within the cycle that the medication is given.

Control0..*
TypeBackboneElement
33. CancerRegimens.cycle.medicationAdministration.dailyAdmin.dayNumber
Definition

The day number for the administration from the start of the cycle

Control0..1
Typeinteger
34. CancerRegimens.cycle.medicationAdministration.dailyAdmin.instructions
Definition

Specific instructions that apply to this administration on this day. eg for day 1 watch for anaphylaxis

Control0..1
Typestring
35. CancerRegimens.cycle.medicationAdministration.medication
Definition

Details of the medication - including dosage and other details

Control1..1
Typestring
Must Supporttrue
36. CancerRegimens.cycle.medicationAdministration.medication.offLabel
Definition

Indicates that this usage of the medication is not one for which it has been specifically approved

Control0..1
Typeboolean
37. CancerRegimens.cycle.medicationAdministration.medication.collection
Definition

Where the medication is collected from prior to administration - eg a clinic or pharmacy (not a specific one - just the type of collection place)

Control0..1
TypeCodeableConcept
38. CancerRegimens.cycle.medicationAdministration.medication.location
Definition

The physical location where the medication is to be administered - eg home, clinic

Control0..1
TypeCodeableConcept
Must Supporttrue
39. CancerRegimens.cycle.medicationAdministration.medication.code
Definition

The code for the drug

Control0..1
TypeCodeableConcept
40. CancerRegimens.cycle.medicationAdministration.medication.dose
Definition

Dosage details for a single administration of the medication

Control0..1
TypeBackboneElement
Must Supporttrue
41. CancerRegimens.cycle.medicationAdministration.medication.dose.quantity
Definition

Amount of medication to be administered at a time

Control0..1
TypeQuantity
42. CancerRegimens.cycle.medicationAdministration.medication.dose.administrationRate
Definition

The time in minutes over which the medication is to be administered (if an infusion). The first number is the minimum period that the infusion should be over.

Control0..1
TypeRange
43. CancerRegimens.cycle.medicationAdministration.medication.dose.route
Definition

Route of administration

Control0..1
TypeCodeableConcept
44. CancerRegimens.cycle.medicationAdministration.medication.dose.timesPerDay
Definition

How many times per day that the medication should be administered if more than one

Control0..1
Typestring
Must Supporttrue