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 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
Draft as of 2020-10-27 |
Definitions for the CancerRegimensLM logical model.
Guidance on how to interpret the contents of this table can be found here
0. CancerRegimens | |
Definition | No description |
Control | 1..1 |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. 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. |
Short | status |
Control | 0..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Label | status |
4. CancerRegimens.version | |
Definition | The version of the regimen |
Short | version |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | version |
6. CancerRegimens.title | |
Definition | A short title that describes the regimen, suitable for a display |
Short | title |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Label | title |
8. CancerRegimens.description | |
Definition | A more detailed description |
Short | description |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Label | description |
10. CancerRegimens.instructions | |
Definition | Overall instructions for use. Distinct from the description of the regimen |
Short | instructions |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | instructions |
12. CancerRegimens.publisher | |
Definition | The organisation responsible for publishing the regimen |
Short | publisher |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | publisher |
14. CancerRegimens.date | |
Definition | When the regimen was first made available for use |
Short | date |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | date |
16. CancerRegimens.type | |
Definition | The type od regimen - eg FOLFOX |
Short | type |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | type |
18. CancerRegimens.intent | |
Definition | The intent of the regimen - eg curative or palliative |
Short | intent |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | intent |
20. 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. |
Short | replacedBy |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Label | replacedBy |
22. CancerRegimens.cancerTypes | |
Definition | The types of cancer that this regimen is intended to treat. There can be up to 3 - type, subType, subSubType. |
Short | CancerTypes |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Label | cancerTypes |
24. 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. |
Short | primaryType |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | primaryType |
26. CancerRegimens.cancerTypes.subType | |
Definition | The cancer sub-type. Will be second in the list, if present. |
Short | subType |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | subType |
28. CancerRegimens.cancerTypes.subSubType | |
Definition | The cancer sub-sub-type. Will be third in the list, if present. |
Short | subSubType |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | subSubType |
30. 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. |
Short | supportFactor |
Control | 0..* |
Type | BackboneElement |
Must Support | false |
Label | supportFactor |
32. CancerRegimens.supportFactor.type | |
Definition | The type of sub-factor - eg anti-emetic |
Short | type |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | type |
34. CancerRegimens.supportFactor.value | |
Definition | The actual factor - eg a specific anti-emetic |
Short | value |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | value |
36. CancerRegimens.disclaimer | |
Definition | Important notes about the regimen to a potential user |
Short | disclaimer |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | disclaimer |
38. CancerRegimens.references | |
Definition | Related artifacts such as additional documentation, justification, or bibliographic references. |
Short | relatedArtifact |
Control | 0..* |
Type | BackboneElement |
Must Support | false |
Label | references |
40. CancerRegimens.references.type | |
Definition | The type of related artifact |
Short | type |
Control | 0..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | type |
42. CancerRegimens.references.display | |
Definition | A string suitable for display |
Short | display |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | display |
44. CancerRegimens.references.url | |
Definition | The location where the artefact can be retrieved from |
Short | url |
Control | 0..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | url |
46. CancerRegimens.cycle | |
Definition | Represents a single cycle of treatment. Note that in the FHIR resource, the cycle is nested... |
Short | cycle |
Control | 1..* |
Type | BackboneElement |
Must Support | false |
Label | cycle |
48. 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 |
Short | description |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | description |
50. CancerRegimens.cycle.instructions | |
Definition | Specific instructions for use during this cycle (as opposed to a description OF the cycle) |
Short | instructions |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | instructions |
52. CancerRegimens.cycle.duration | |
Definition | The length of the cycle in days |
Short | duration |
Control | 0..1 |
Type | Identifier |
Must Support | false |
Label | duration |
54. CancerRegimens.cycle.medicationAdministration | |
Definition | The details of medication administration within this cycle. Details of the administration are in the medication element. |
Short | medication |
Control | 1..* |
Type | BackboneElement |
Must Support | false |
Label | medicationAdministration |
56. CancerRegimens.cycle.medicationAdministration.description | |
Definition | Human description of the medication |
Short | description |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | description |
58. CancerRegimens.cycle.medicationAdministration.dailyAdmin | |
Definition | Describes the days within the cycle that the medication is given. |
Short | dailyAdmin |
Control | 0..* |
Type | BackboneElement |
Must Support | false |
Label | dailyAdmin |
60. CancerRegimens.cycle.medicationAdministration.dailyAdmin.dayNumber | |
Definition | The day number for the administration from the start of the cycle |
Short | dayNumber |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | dayNumber |
62. CancerRegimens.cycle.medicationAdministration.dailyAdmin.instructions | |
Definition | Specific instructions that apply to this administration on this day. eg for day 1 watch for anaphylaxis |
Short | instructions |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | instructions |
64. CancerRegimens.cycle.medicationAdministration.medication | |
Definition | Details of the medication - including dosage and other details |
Short | medication |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Label | medication |
66. CancerRegimens.cycle.medicationAdministration.medication.offLabel | |
Definition | Indicates that this usage of the medication is not one for which it has been specifically approved |
Short | offLabel |
Control | 0..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | offLabel |
68. 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) |
Short | collection |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | collection |
70. CancerRegimens.cycle.medicationAdministration.medication.location | |
Definition | The physical location where the medication is to be administered - eg home, clinic |
Short | location |
Control | 0..1 |
Type | CodeableConcept |
Must Support | true |
Label | location |
72. CancerRegimens.cycle.medicationAdministration.medication.code | |
Definition | The code for the drug |
Short | code |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | code |
74. CancerRegimens.cycle.medicationAdministration.medication.dose | |
Definition | Dosage details for a single administration of the medication |
Short | dose |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Label | dose |
76. CancerRegimens.cycle.medicationAdministration.medication.dose.quantity | |
Definition | Amount of medication to be administered at a time |
Short | quantity |
Control | 0..1 |
Type | Quantity |
Must Support | false |
Label | quantity |
78. 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. |
Short | administratrionPeriod |
Control | 0..1 |
Type | Range |
Must Support | false |
Label | administrationRate |
80. CancerRegimens.cycle.medicationAdministration.medication.dose.route | |
Definition | Route of administration |
Short | route |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | route |
82. CancerRegimens.cycle.medicationAdministration.medication.dose.timesPerDay | |
Definition | How many times per day that the medication should be administered if more than one |
Short | timesPerDay |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Label | timesPerDay |
Guidance on how to interpret the contents of this table can be found here
0. CancerRegimens | |
Definition | No description Base definition for all elements in a resource. |
Short | Base for all elements |
Control | 10..1* This element is affected by the following invariants: ele-1 |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
2. 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. |
Short | status |
Control | 0..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Label | status |
4. CancerRegimens.version | |
Definition | The version of the regimen |
Short | version |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | version |
6. CancerRegimens.title | |
Definition | A short title that describes the regimen, suitable for a display |
Short | title |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Label | title |
8. CancerRegimens.description | |
Definition | A more detailed description |
Short | description |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Label | description |
10. CancerRegimens.instructions | |
Definition | Overall instructions for use. Distinct from the description of the regimen |
Short | instructions |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | instructions |
12. CancerRegimens.publisher | |
Definition | The organisation responsible for publishing the regimen |
Short | publisher |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | publisher |
14. CancerRegimens.date | |
Definition | When the regimen was first made available for use |
Short | date |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | date |
16. CancerRegimens.type | |
Definition | The type od regimen - eg FOLFOX |
Short | type |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | type |
18. CancerRegimens.intent | |
Definition | The intent of the regimen - eg curative or palliative |
Short | intent |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | intent |
20. 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. |
Short | replacedBy |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Label | replacedBy |
22. CancerRegimens.cancerTypes | |
Definition | The types of cancer that this regimen is intended to treat. There can be up to 3 - type, subType, subSubType. |
Short | CancerTypes |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Label | cancerTypes |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
24. CancerRegimens.cancerTypes.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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()) |
26. 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. |
Short | primaryType |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | primaryType |
28. CancerRegimens.cancerTypes.subType | |
Definition | The cancer sub-type. Will be second in the list, if present. |
Short | subType |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | subType |
30. CancerRegimens.cancerTypes.subSubType | |
Definition | The cancer sub-sub-type. Will be third in the list, if present. |
Short | subSubType |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | subSubType |
32. 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. |
Short | supportFactor |
Control | 0..* |
Type | BackboneElement |
Must Support | false |
Label | supportFactor |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
34. CancerRegimens.supportFactor.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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()) |
36. CancerRegimens.supportFactor.type | |
Definition | The type of sub-factor - eg anti-emetic |
Short | type |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | type |
38. CancerRegimens.supportFactor.value | |
Definition | The actual factor - eg a specific anti-emetic |
Short | value |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | value |
40. CancerRegimens.disclaimer | |
Definition | Important notes about the regimen to a potential user |
Short | disclaimer |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | disclaimer |
42. CancerRegimens.references | |
Definition | Related artifacts such as additional documentation, justification, or bibliographic references. |
Short | relatedArtifact |
Control | 0..* |
Type | BackboneElement |
Must Support | false |
Label | references |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
44. CancerRegimens.references.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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()) |
46. CancerRegimens.references.type | |
Definition | The type of related artifact |
Short | type |
Control | 0..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | type |
48. CancerRegimens.references.display | |
Definition | A string suitable for display |
Short | display |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | display |
50. CancerRegimens.references.url | |
Definition | The location where the artefact can be retrieved from |
Short | url |
Control | 0..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | url |
52. CancerRegimens.cycle | |
Definition | Represents a single cycle of treatment. Note that in the FHIR resource, the cycle is nested... |
Short | cycle |
Control | 1..* |
Type | BackboneElement |
Must Support | false |
Label | cycle |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
54. CancerRegimens.cycle.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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()) |
56. 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 |
Short | description |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | description |
58. CancerRegimens.cycle.instructions | |
Definition | Specific instructions for use during this cycle (as opposed to a description OF the cycle) |
Short | instructions |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | instructions |
60. CancerRegimens.cycle.duration | |
Definition | The length of the cycle in days |
Short | duration |
Control | 0..1 |
Type | Identifier |
Must Support | false |
Label | duration |
62. CancerRegimens.cycle.medicationAdministration | |
Definition | The details of medication administration within this cycle. Details of the administration are in the medication element. |
Short | medication |
Control | 1..* |
Type | BackboneElement |
Must Support | false |
Label | medicationAdministration |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
64. CancerRegimens.cycle.medicationAdministration.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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()) |
66. CancerRegimens.cycle.medicationAdministration.description | |
Definition | Human description of the medication |
Short | description |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | description |
68. CancerRegimens.cycle.medicationAdministration.dailyAdmin | |
Definition | Describes the days within the cycle that the medication is given. |
Short | dailyAdmin |
Control | 0..* |
Type | BackboneElement |
Must Support | false |
Label | dailyAdmin |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
70. CancerRegimens.cycle.medicationAdministration.dailyAdmin.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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()) |
72. CancerRegimens.cycle.medicationAdministration.dailyAdmin.dayNumber | |
Definition | The day number for the administration from the start of the cycle |
Short | dayNumber |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | dayNumber |
74. CancerRegimens.cycle.medicationAdministration.dailyAdmin.instructions | |
Definition | Specific instructions that apply to this administration on this day. eg for day 1 watch for anaphylaxis |
Short | instructions |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | instructions |
76. CancerRegimens.cycle.medicationAdministration.medication | |
Definition | Details of the medication - including dosage and other details |
Short | medication |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Label | medication |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
78. CancerRegimens.cycle.medicationAdministration.medication.offLabel | |
Definition | Indicates that this usage of the medication is not one for which it has been specifically approved |
Short | offLabel |
Control | 0..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | offLabel |
80. 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) |
Short | collection |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | collection |
82. CancerRegimens.cycle.medicationAdministration.medication.location | |
Definition | The physical location where the medication is to be administered - eg home, clinic |
Short | location |
Control | 0..1 |
Type | CodeableConcept |
Must Support | true |
Label | location |
84. CancerRegimens.cycle.medicationAdministration.medication.code | |
Definition | The code for the drug |
Short | code |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | code |
86. CancerRegimens.cycle.medicationAdministration.medication.dose | |
Definition | Dosage details for a single administration of the medication |
Short | dose |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Label | dose |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
88. CancerRegimens.cycle.medicationAdministration.medication.dose.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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()) |
90. CancerRegimens.cycle.medicationAdministration.medication.dose.quantity | |
Definition | Amount of medication to be administered at a time |
Short | quantity |
Control | 0..1 |
Type | Quantity |
Must Support | false |
Label | quantity |
92. 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. |
Short | administratrionPeriod |
Control | 0..1 |
Type | Range |
Must Support | false |
Label | administrationRate |
94. CancerRegimens.cycle.medicationAdministration.medication.dose.route | |
Definition | Route of administration |
Short | route |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | route |
96. CancerRegimens.cycle.medicationAdministration.medication.dose.timesPerDay | |
Definition | How many times per day that the medication should be administered if more than one |
Short | timesPerDay |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Label | timesPerDay |
Guidance on how to interpret the contents of this table can be found here
0. CancerRegimens | |
Definition | No description |
Short | Base for all elements |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
Invariants | 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. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
4. 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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on CancerRegimens.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
6. 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. |
Short | status |
Control | 0..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Label | status |
8. CancerRegimens.version | |
Definition | The version of the regimen |
Short | version |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | version |
10. CancerRegimens.title | |
Definition | A short title that describes the regimen, suitable for a display |
Short | title |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Label | title |
12. CancerRegimens.description | |
Definition | A more detailed description |
Short | description |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Label | description |
14. CancerRegimens.instructions | |
Definition | Overall instructions for use. Distinct from the description of the regimen |
Short | instructions |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | instructions |
16. CancerRegimens.publisher | |
Definition | The organisation responsible for publishing the regimen |
Short | publisher |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | publisher |
18. CancerRegimens.date | |
Definition | When the regimen was first made available for use |
Short | date |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | date |
20. CancerRegimens.type | |
Definition | The type od regimen - eg FOLFOX |
Short | type |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | type |
22. CancerRegimens.intent | |
Definition | The intent of the regimen - eg curative or palliative |
Short | intent |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | intent |
24. 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. |
Short | replacedBy |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Label | replacedBy |
26. CancerRegimens.cancerTypes | |
Definition | The types of cancer that this regimen is intended to treat. There can be up to 3 - type, subType, subSubType. |
Short | CancerTypes |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Label | cancerTypes |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
28. CancerRegimens.cancerTypes.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
30. CancerRegimens.cancerTypes.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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on CancerRegimens.cancerTypes.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
32. CancerRegimens.cancerTypes.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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() ) |
34. 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. |
Short | primaryType |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | primaryType |
36. CancerRegimens.cancerTypes.subType | |
Definition | The cancer sub-type. Will be second in the list, if present. |
Short | subType |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | subType |
38. CancerRegimens.cancerTypes.subSubType | |
Definition | The cancer sub-sub-type. Will be third in the list, if present. |
Short | subSubType |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | subSubType |
40. 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. |
Short | supportFactor |
Control | 0..* |
Type | BackboneElement |
Must Support | false |
Label | supportFactor |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
42. CancerRegimens.supportFactor.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
44. CancerRegimens.supportFactor.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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on CancerRegimens.supportFactor.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
46. CancerRegimens.supportFactor.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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() ) |
48. CancerRegimens.supportFactor.type | |
Definition | The type of sub-factor - eg anti-emetic |
Short | type |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | type |
50. CancerRegimens.supportFactor.value | |
Definition | The actual factor - eg a specific anti-emetic |
Short | value |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | value |
52. CancerRegimens.disclaimer | |
Definition | Important notes about the regimen to a potential user |
Short | disclaimer |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | disclaimer |
54. CancerRegimens.references | |
Definition | Related artifacts such as additional documentation, justification, or bibliographic references. |
Short | relatedArtifact |
Control | 0..* |
Type | BackboneElement |
Must Support | false |
Label | references |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
56. CancerRegimens.references.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
58. CancerRegimens.references.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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on CancerRegimens.references.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
60. CancerRegimens.references.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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() ) |
62. CancerRegimens.references.type | |
Definition | The type of related artifact |
Short | type |
Control | 0..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | type |
64. CancerRegimens.references.display | |
Definition | A string suitable for display |
Short | display |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | display |
66. CancerRegimens.references.url | |
Definition | The location where the artefact can be retrieved from |
Short | url |
Control | 0..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | url |
68. CancerRegimens.cycle | |
Definition | Represents a single cycle of treatment. Note that in the FHIR resource, the cycle is nested... |
Short | cycle |
Control | 1..* |
Type | BackboneElement |
Must Support | false |
Label | cycle |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
70. CancerRegimens.cycle.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
72. CancerRegimens.cycle.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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on CancerRegimens.cycle.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
74. CancerRegimens.cycle.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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() ) |
76. 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 |
Short | description |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | description |
78. CancerRegimens.cycle.instructions | |
Definition | Specific instructions for use during this cycle (as opposed to a description OF the cycle) |
Short | instructions |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | instructions |
80. CancerRegimens.cycle.duration | |
Definition | The length of the cycle in days |
Short | duration |
Control | 0..1 |
Type | Identifier |
Must Support | false |
Label | duration |
82. CancerRegimens.cycle.medicationAdministration | |
Definition | The details of medication administration within this cycle. Details of the administration are in the medication element. |
Short | medication |
Control | 1..* |
Type | BackboneElement |
Must Support | false |
Label | medicationAdministration |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
84. CancerRegimens.cycle.medicationAdministration.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
86. CancerRegimens.cycle.medicationAdministration.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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on CancerRegimens.cycle.medicationAdministration.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
88. CancerRegimens.cycle.medicationAdministration.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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() ) |
90. CancerRegimens.cycle.medicationAdministration.description | |
Definition | Human description of the medication |
Short | description |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | description |
92. CancerRegimens.cycle.medicationAdministration.dailyAdmin | |
Definition | Describes the days within the cycle that the medication is given. |
Short | dailyAdmin |
Control | 0..* |
Type | BackboneElement |
Must Support | false |
Label | dailyAdmin |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
94. CancerRegimens.cycle.medicationAdministration.dailyAdmin.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
96. CancerRegimens.cycle.medicationAdministration.dailyAdmin.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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on CancerRegimens.cycle.medicationAdministration.dailyAdmin.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
98. CancerRegimens.cycle.medicationAdministration.dailyAdmin.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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() ) |
100. CancerRegimens.cycle.medicationAdministration.dailyAdmin.dayNumber | |
Definition | The day number for the administration from the start of the cycle |
Short | dayNumber |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | dayNumber |
102. CancerRegimens.cycle.medicationAdministration.dailyAdmin.instructions | |
Definition | Specific instructions that apply to this administration on this day. eg for day 1 watch for anaphylaxis |
Short | instructions |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | instructions |
104. CancerRegimens.cycle.medicationAdministration.medication | |
Definition | Details of the medication - including dosage and other details |
Short | medication |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Label | medication |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
106. CancerRegimens.cycle.medicationAdministration.medication.id | |
Definition | unique id for the element within a resource (for internal references) |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
108. CancerRegimens.cycle.medicationAdministration.medication.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
110. CancerRegimens.cycle.medicationAdministration.medication.value | |
Definition | The actual value |
Short | Primitive value for string |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Max Length | 1048576 |
112. CancerRegimens.cycle.medicationAdministration.medication.offLabel | |
Definition | Indicates that this usage of the medication is not one for which it has been specifically approved |
Short | offLabel |
Control | 0..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Label | offLabel |
114. 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) |
Short | collection |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | collection |
116. CancerRegimens.cycle.medicationAdministration.medication.location | |
Definition | The physical location where the medication is to be administered - eg home, clinic |
Short | location |
Control | 0..1 |
Type | CodeableConcept |
Must Support | true |
Label | location |
118. CancerRegimens.cycle.medicationAdministration.medication.code | |
Definition | The code for the drug |
Short | code |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | code |
120. CancerRegimens.cycle.medicationAdministration.medication.dose | |
Definition | Dosage details for a single administration of the medication |
Short | dose |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Label | dose |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
122. CancerRegimens.cycle.medicationAdministration.medication.dose.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
124. CancerRegimens.cycle.medicationAdministration.medication.dose.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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on CancerRegimens.cycle.medicationAdministration.medication.dose.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
126. CancerRegimens.cycle.medicationAdministration.medication.dose.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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() ) |
128. CancerRegimens.cycle.medicationAdministration.medication.dose.quantity | |
Definition | Amount of medication to be administered at a time |
Short | quantity |
Control | 0..1 |
Type | Quantity |
Must Support | false |
Label | quantity |
130. 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. |
Short | administratrionPeriod |
Control | 0..1 |
Type | Range |
Must Support | false |
Label | administrationRate |
132. CancerRegimens.cycle.medicationAdministration.medication.dose.route | |
Definition | Route of administration |
Short | route |
Control | 0..1 |
Type | CodeableConcept |
Must Support | false |
Label | route |
134. CancerRegimens.cycle.medicationAdministration.medication.dose.timesPerDay | |
Definition | How many times per day that the medication should be administered if more than one |
Short | timesPerDay |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Label | timesPerDay |