CanShare models
0.1.0 - ci-build

CanShare models, published by David hay. 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/davidhay25/models/ and changes regularly. See the Directory of published versions

Logical Model: Radiation therapy course

Official URL: http://example.org/StructureDefinition/ROCTherapy-cs Version: 0.1.0
Draft as of 2024-03-04 Computable Name: ROCTherapy_cs

A single course of radiation therapy.

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. ROCTherapy-cs 0..*BaseRadiation therapy course
Instances of this logical model are not marked to be the target of a Reference
... LocalCourseId 0..1IdentifierAn identifier used at the local healthcare facility to identifier the course of therapy. A course of radiation therapy is a set of radiotherapy treatment(s) to a continuous or contiguous volume with a single intent from a single referral. A course can include multiple phases and multiple radiotherapy modalities
... Intent 1..1CodeableConceptThe intent of the cancer treatment, e.g. curative, palliative.
... TreatmentPriority 1..1CodeableConceptA categorisation used to prioritise the start of a treatment.
... Prescription 1..*BackboneElementA prescribed radiation therapy for a given site, technique and volume.
.... Technique 1..1CodeableConceptThe treatment technique used to deliver the radiation therapy, e.g. VMAT (Volumetric Modulated Arc Therapy)
.... PlannedFractions 1..1integerThe total number of radiotherapy treatment fractions (attendances) planned for the course of treatment.
.... PlannedTotalDose 1..1decimalPlanned radiation dose over whole course, in Gy (gray). Note that centres using centigray will need to adjust their data in the extract.
.... SiteOfTreatment 1..1BackboneElementThe anatomical site receiving the radiation therapy treatment.
..... BodyStructure 1..1CodeableConceptThe anatomical structure being described
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred)
..... Comments 0..1CodeableConceptFree text comments describing the body site.
..... newElement 0..1stringROCTherapy.Prescription.SiteOfTreatment.newElement
... CoursePeriod 0..1PeriodThe date of first and last fraction delivered for the course of treatment.
... DeliveredFractions 0..1integerThe total number of radiotherapy treatment fractions (attendances) delivered during the course of treatment.
... AverageBookedAppointmentTime 0..1decimalThe average duration of a booking slot for each fraction (appointment) in the course (in minutes).
... AverageActualAppointmentTime 0..1decimalThe average timed duration of each fraction (appointment) that has been delivered in the course (in minutes).

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ROCTherapy-cs.Prescription.SiteOfTreatment.BodyStructurepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
NameFlagsCard.TypeDescription & Constraintsdoco
.. ROCTherapy-cs 0..*BaseRadiation therapy course
Instances of this logical model are not marked to be the target of a Reference
... LocalCourseId 0..1IdentifierAn identifier used at the local healthcare facility to identifier the course of therapy. A course of radiation therapy is a set of radiotherapy treatment(s) to a continuous or contiguous volume with a single intent from a single referral. A course can include multiple phases and multiple radiotherapy modalities
... Intent 1..1CodeableConceptThe intent of the cancer treatment, e.g. curative, palliative.
... TreatmentPriority 1..1CodeableConceptA categorisation used to prioritise the start of a treatment.
... Prescription 1..*BackboneElementA prescribed radiation therapy for a given site, technique and volume.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Technique 1..1CodeableConceptThe treatment technique used to deliver the radiation therapy, e.g. VMAT (Volumetric Modulated Arc Therapy)
.... PlannedFractions 1..1integerThe total number of radiotherapy treatment fractions (attendances) planned for the course of treatment.
.... PlannedTotalDose 1..1decimalPlanned radiation dose over whole course, in Gy (gray). Note that centres using centigray will need to adjust their data in the extract.
.... SiteOfTreatment 1..1BackboneElementThe anatomical site receiving the radiation therapy treatment.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... BodyStructure 1..1CodeableConceptThe anatomical structure being described
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred)
..... Comments 0..1CodeableConceptFree text comments describing the body site.
..... newElement 0..1stringROCTherapy.Prescription.SiteOfTreatment.newElement
... CoursePeriod 0..1PeriodThe date of first and last fraction delivered for the course of treatment.
... DeliveredFractions 0..1integerThe total number of radiotherapy treatment fractions (attendances) delivered during the course of treatment.
... AverageBookedAppointmentTime 0..1decimalThe average duration of a booking slot for each fraction (appointment) in the course (in minutes).
... AverageActualAppointmentTime 0..1decimalThe average timed duration of each fraction (appointment) that has been delivered in the course (in minutes).

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ROCTherapy-cs.Prescription.SiteOfTreatment.BodyStructurepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ROCTherapy-cs 0..*BaseRadiation therapy course
Instances of this logical model are not marked to be the target of a Reference
... LocalCourseId 0..1IdentifierAn identifier used at the local healthcare facility to identifier the course of therapy. A course of radiation therapy is a set of radiotherapy treatment(s) to a continuous or contiguous volume with a single intent from a single referral. A course can include multiple phases and multiple radiotherapy modalities
... Intent 1..1CodeableConceptThe intent of the cancer treatment, e.g. curative, palliative.
... TreatmentPriority 1..1CodeableConceptA categorisation used to prioritise the start of a treatment.
... Prescription 1..*BackboneElementA prescribed radiation therapy for a given site, technique and volume.
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Technique 1..1CodeableConceptThe treatment technique used to deliver the radiation therapy, e.g. VMAT (Volumetric Modulated Arc Therapy)
.... PlannedFractions 1..1integerThe total number of radiotherapy treatment fractions (attendances) planned for the course of treatment.
.... PlannedTotalDose 1..1decimalPlanned radiation dose over whole course, in Gy (gray). Note that centres using centigray will need to adjust their data in the extract.
.... SiteOfTreatment 1..1BackboneElementThe anatomical site receiving the radiation therapy treatment.
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... BodyStructure 1..1CodeableConceptThe anatomical structure being described
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred)
..... Comments 0..1CodeableConceptFree text comments describing the body site.
..... newElement 0..1stringROCTherapy.Prescription.SiteOfTreatment.newElement
... CoursePeriod 0..1PeriodThe date of first and last fraction delivered for the course of treatment.
... DeliveredFractions 0..1integerThe total number of radiotherapy treatment fractions (attendances) delivered during the course of treatment.
... AverageBookedAppointmentTime 0..1decimalThe average duration of a booking slot for each fraction (appointment) in the course (in minutes).
... AverageActualAppointmentTime 0..1decimalThe average timed duration of each fraction (appointment) that has been delivered in the course (in minutes).

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ROCTherapy-cs.Prescription.SiteOfTreatment.BodyStructurepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element (8 nested mandatory elements)

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. ROCTherapy-cs 0..*BaseRadiation therapy course
Instances of this logical model are not marked to be the target of a Reference
... LocalCourseId 0..1IdentifierAn identifier used at the local healthcare facility to identifier the course of therapy. A course of radiation therapy is a set of radiotherapy treatment(s) to a continuous or contiguous volume with a single intent from a single referral. A course can include multiple phases and multiple radiotherapy modalities
... Intent 1..1CodeableConceptThe intent of the cancer treatment, e.g. curative, palliative.
... TreatmentPriority 1..1CodeableConceptA categorisation used to prioritise the start of a treatment.
... Prescription 1..*BackboneElementA prescribed radiation therapy for a given site, technique and volume.
.... Technique 1..1CodeableConceptThe treatment technique used to deliver the radiation therapy, e.g. VMAT (Volumetric Modulated Arc Therapy)
.... PlannedFractions 1..1integerThe total number of radiotherapy treatment fractions (attendances) planned for the course of treatment.
.... PlannedTotalDose 1..1decimalPlanned radiation dose over whole course, in Gy (gray). Note that centres using centigray will need to adjust their data in the extract.
.... SiteOfTreatment 1..1BackboneElementThe anatomical site receiving the radiation therapy treatment.
..... BodyStructure 1..1CodeableConceptThe anatomical structure being described
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred)
..... Comments 0..1CodeableConceptFree text comments describing the body site.
..... newElement 0..1stringROCTherapy.Prescription.SiteOfTreatment.newElement
... CoursePeriod 0..1PeriodThe date of first and last fraction delivered for the course of treatment.
... DeliveredFractions 0..1integerThe total number of radiotherapy treatment fractions (attendances) delivered during the course of treatment.
... AverageBookedAppointmentTime 0..1decimalThe average duration of a booking slot for each fraction (appointment) in the course (in minutes).
... AverageActualAppointmentTime 0..1decimalThe average timed duration of each fraction (appointment) that has been delivered in the course (in minutes).

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ROCTherapy-cs.Prescription.SiteOfTreatment.BodyStructurepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ROCTherapy-cs 0..*BaseRadiation therapy course
Instances of this logical model are not marked to be the target of a Reference
... LocalCourseId 0..1IdentifierAn identifier used at the local healthcare facility to identifier the course of therapy. A course of radiation therapy is a set of radiotherapy treatment(s) to a continuous or contiguous volume with a single intent from a single referral. A course can include multiple phases and multiple radiotherapy modalities
... Intent 1..1CodeableConceptThe intent of the cancer treatment, e.g. curative, palliative.
... TreatmentPriority 1..1CodeableConceptA categorisation used to prioritise the start of a treatment.
... Prescription 1..*BackboneElementA prescribed radiation therapy for a given site, technique and volume.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Technique 1..1CodeableConceptThe treatment technique used to deliver the radiation therapy, e.g. VMAT (Volumetric Modulated Arc Therapy)
.... PlannedFractions 1..1integerThe total number of radiotherapy treatment fractions (attendances) planned for the course of treatment.
.... PlannedTotalDose 1..1decimalPlanned radiation dose over whole course, in Gy (gray). Note that centres using centigray will need to adjust their data in the extract.
.... SiteOfTreatment 1..1BackboneElementThe anatomical site receiving the radiation therapy treatment.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... BodyStructure 1..1CodeableConceptThe anatomical structure being described
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred)
..... Comments 0..1CodeableConceptFree text comments describing the body site.
..... newElement 0..1stringROCTherapy.Prescription.SiteOfTreatment.newElement
... CoursePeriod 0..1PeriodThe date of first and last fraction delivered for the course of treatment.
... DeliveredFractions 0..1integerThe total number of radiotherapy treatment fractions (attendances) delivered during the course of treatment.
... AverageBookedAppointmentTime 0..1decimalThe average duration of a booking slot for each fraction (appointment) in the course (in minutes).
... AverageActualAppointmentTime 0..1decimalThe average timed duration of each fraction (appointment) that has been delivered in the course (in minutes).

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ROCTherapy-cs.Prescription.SiteOfTreatment.BodyStructurepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ROCTherapy-cs 0..*BaseRadiation therapy course
Instances of this logical model are not marked to be the target of a Reference
... LocalCourseId 0..1IdentifierAn identifier used at the local healthcare facility to identifier the course of therapy. A course of radiation therapy is a set of radiotherapy treatment(s) to a continuous or contiguous volume with a single intent from a single referral. A course can include multiple phases and multiple radiotherapy modalities
... Intent 1..1CodeableConceptThe intent of the cancer treatment, e.g. curative, palliative.
... TreatmentPriority 1..1CodeableConceptA categorisation used to prioritise the start of a treatment.
... Prescription 1..*BackboneElementA prescribed radiation therapy for a given site, technique and volume.
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Technique 1..1CodeableConceptThe treatment technique used to deliver the radiation therapy, e.g. VMAT (Volumetric Modulated Arc Therapy)
.... PlannedFractions 1..1integerThe total number of radiotherapy treatment fractions (attendances) planned for the course of treatment.
.... PlannedTotalDose 1..1decimalPlanned radiation dose over whole course, in Gy (gray). Note that centres using centigray will need to adjust their data in the extract.
.... SiteOfTreatment 1..1BackboneElementThe anatomical site receiving the radiation therapy treatment.
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... BodyStructure 1..1CodeableConceptThe anatomical structure being described
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred)
..... Comments 0..1CodeableConceptFree text comments describing the body site.
..... newElement 0..1stringROCTherapy.Prescription.SiteOfTreatment.newElement
... CoursePeriod 0..1PeriodThe date of first and last fraction delivered for the course of treatment.
... DeliveredFractions 0..1integerThe total number of radiotherapy treatment fractions (attendances) delivered during the course of treatment.
... AverageBookedAppointmentTime 0..1decimalThe average duration of a booking slot for each fraction (appointment) in the course (in minutes).
... AverageActualAppointmentTime 0..1decimalThe average timed duration of each fraction (appointment) that has been delivered in the course (in minutes).

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ROCTherapy-cs.Prescription.SiteOfTreatment.BodyStructurepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element (8 nested mandatory elements)

 

Other representations of profile: CSV, Excel