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: Treatment course (radiation oncology)

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

Details about the treatment course(s) relevant to a radiation oncology treatment summary form.

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
.. SectionROCTreatmentCourse-cs 0..*BaseTreatment course (radiation oncology)
Instances of this logical model are not marked to be the target of a Reference
... ECOGStatus 0..1BackboneElementThe performance status of a patient as defined by the Eastern Cooperative Oncology Group (ECOG).
.... Status 1..1CodeableConceptThe status of the observation
.... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
.... Method 0..1CodeableConceptThe technique, procedure, or system used to perform the observation.
.... Date 0..1dateTimeThe date and/or time that the observation was performed.
.... PerformedBy 0..*BackboneElementA person responsible for performing the observation.
..... Id 0..1IdentifierHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
..... PersonName 0..1BackboneElementPerson name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.
...... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
...... GivenName 0..1stringThe person’s forename or given name at birth
...... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
...... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
...... age 0..1stringSectionROCTreatmentCourse.ECOGStatus.PerformedBy.PersonName.age
..... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
...... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
..... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
...... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
...... RoleCode 1..1CodeableConceptThe designated the role of a health worker
...... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
...... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.
.... Comments 0..1stringPlain text comments about the observation.
.... ValueCodeable 0..1CodeableConceptThe result of the observation represented using a coded value.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ecog-status (preferred)
... ROCTherapy 0..1BackboneElementA single course of radiation therapy.
.... 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.
.... TherapyDateRange 0..1PeriodThe date of first and last dose delivered for the therapy.
.... 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..1stringSectionROCTreatmentCourse.ROCTherapy.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
SectionROCTreatmentCourse-cs.ECOGStatus.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
SectionROCTreatmentCourse-cs.ECOGStatus.ValueCodeablepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-ecog-status
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ecog-status
SectionROCTreatmentCourse-cs.ROCTherapy.Prescription.SiteOfTreatment.BodyStructurepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
NameFlagsCard.TypeDescription & Constraintsdoco
.. SectionROCTreatmentCourse-cs 0..*BaseTreatment course (radiation oncology)
Instances of this logical model are not marked to be the target of a Reference
... ECOGStatus 0..1BackboneElementThe performance status of a patient as defined by the Eastern Cooperative Oncology Group (ECOG).
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Status 1..1CodeableConceptThe status of the observation
.... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
.... Method 0..1CodeableConceptThe technique, procedure, or system used to perform the observation.
.... Date 0..1dateTimeThe date and/or time that the observation was performed.
.... PerformedBy 0..*BackboneElementA person responsible for performing the observation.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Id 0..1IdentifierHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
..... PersonName 0..1BackboneElementPerson name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
...... GivenName 0..1stringThe person’s forename or given name at birth
...... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
...... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
...... age 0..1stringSectionROCTreatmentCourse.ECOGStatus.PerformedBy.PersonName.age
..... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
..... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
...... RoleCode 1..1CodeableConceptThe designated the role of a health worker
...... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
...... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.
.... Comments 0..1stringPlain text comments about the observation.
.... ValueCodeable 0..1CodeableConceptThe result of the observation represented using a coded value.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ecog-status (preferred)
... ROCTherapy 0..1BackboneElementA single course of radiation therapy.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... 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.
.... TherapyDateRange 0..1PeriodThe date of first and last dose delivered for the therapy.
.... 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..1stringSectionROCTreatmentCourse.ROCTherapy.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
SectionROCTreatmentCourse-cs.ECOGStatus.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
SectionROCTreatmentCourse-cs.ECOGStatus.ValueCodeablepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-ecog-status
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ecog-status
SectionROCTreatmentCourse-cs.ROCTherapy.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
.. SectionROCTreatmentCourse-cs 0..*BaseTreatment course (radiation oncology)
Instances of this logical model are not marked to be the target of a Reference
... ECOGStatus 0..1BackboneElementThe performance status of a patient as defined by the Eastern Cooperative Oncology Group (ECOG).
.... @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
.... Status 1..1CodeableConceptThe status of the observation
.... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
.... Method 0..1CodeableConceptThe technique, procedure, or system used to perform the observation.
.... Date 0..1dateTimeThe date and/or time that the observation was performed.
.... PerformedBy 0..*BackboneElementA person responsible for performing the observation.
..... @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
..... Id 0..1IdentifierHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
..... PersonName 0..1BackboneElementPerson name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.
...... @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
...... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
...... GivenName 0..1stringThe person’s forename or given name at birth
...... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
...... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
...... age 0..1stringSectionROCTreatmentCourse.ECOGStatus.PerformedBy.PersonName.age
..... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
...... @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
...... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
..... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
...... @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
...... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
...... RoleCode 1..1CodeableConceptThe designated the role of a health worker
...... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
...... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.
.... Comments 0..1stringPlain text comments about the observation.
.... ValueCodeable 0..1CodeableConceptThe result of the observation represented using a coded value.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ecog-status (preferred)
... ROCTherapy 0..1BackboneElementA single course of radiation therapy.
.... @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
.... 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.
.... TherapyDateRange 0..1PeriodThe date of first and last dose delivered for the therapy.
.... 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..1stringSectionROCTreatmentCourse.ROCTherapy.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
SectionROCTreatmentCourse-cs.ECOGStatus.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
SectionROCTreatmentCourse-cs.ECOGStatus.ValueCodeablepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-ecog-status
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ecog-status
SectionROCTreatmentCourse-cs.ROCTherapy.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 (12 nested mandatory elements)

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. SectionROCTreatmentCourse-cs 0..*BaseTreatment course (radiation oncology)
Instances of this logical model are not marked to be the target of a Reference
... ECOGStatus 0..1BackboneElementThe performance status of a patient as defined by the Eastern Cooperative Oncology Group (ECOG).
.... Status 1..1CodeableConceptThe status of the observation
.... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
.... Method 0..1CodeableConceptThe technique, procedure, or system used to perform the observation.
.... Date 0..1dateTimeThe date and/or time that the observation was performed.
.... PerformedBy 0..*BackboneElementA person responsible for performing the observation.
..... Id 0..1IdentifierHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
..... PersonName 0..1BackboneElementPerson name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.
...... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
...... GivenName 0..1stringThe person’s forename or given name at birth
...... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
...... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
...... age 0..1stringSectionROCTreatmentCourse.ECOGStatus.PerformedBy.PersonName.age
..... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
...... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
..... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
...... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
...... RoleCode 1..1CodeableConceptThe designated the role of a health worker
...... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
...... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.
.... Comments 0..1stringPlain text comments about the observation.
.... ValueCodeable 0..1CodeableConceptThe result of the observation represented using a coded value.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ecog-status (preferred)
... ROCTherapy 0..1BackboneElementA single course of radiation therapy.
.... 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.
.... TherapyDateRange 0..1PeriodThe date of first and last dose delivered for the therapy.
.... 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..1stringSectionROCTreatmentCourse.ROCTherapy.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
SectionROCTreatmentCourse-cs.ECOGStatus.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
SectionROCTreatmentCourse-cs.ECOGStatus.ValueCodeablepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-ecog-status
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ecog-status
SectionROCTreatmentCourse-cs.ROCTherapy.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
.. SectionROCTreatmentCourse-cs 0..*BaseTreatment course (radiation oncology)
Instances of this logical model are not marked to be the target of a Reference
... ECOGStatus 0..1BackboneElementThe performance status of a patient as defined by the Eastern Cooperative Oncology Group (ECOG).
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Status 1..1CodeableConceptThe status of the observation
.... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
.... Method 0..1CodeableConceptThe technique, procedure, or system used to perform the observation.
.... Date 0..1dateTimeThe date and/or time that the observation was performed.
.... PerformedBy 0..*BackboneElementA person responsible for performing the observation.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Id 0..1IdentifierHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
..... PersonName 0..1BackboneElementPerson name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
...... GivenName 0..1stringThe person’s forename or given name at birth
...... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
...... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
...... age 0..1stringSectionROCTreatmentCourse.ECOGStatus.PerformedBy.PersonName.age
..... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
..... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
...... RoleCode 1..1CodeableConceptThe designated the role of a health worker
...... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
...... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.
.... Comments 0..1stringPlain text comments about the observation.
.... ValueCodeable 0..1CodeableConceptThe result of the observation represented using a coded value.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ecog-status (preferred)
... ROCTherapy 0..1BackboneElementA single course of radiation therapy.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... 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.
.... TherapyDateRange 0..1PeriodThe date of first and last dose delivered for the therapy.
.... 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..1stringSectionROCTreatmentCourse.ROCTherapy.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
SectionROCTreatmentCourse-cs.ECOGStatus.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
SectionROCTreatmentCourse-cs.ECOGStatus.ValueCodeablepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-ecog-status
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ecog-status
SectionROCTreatmentCourse-cs.ROCTherapy.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
.. SectionROCTreatmentCourse-cs 0..*BaseTreatment course (radiation oncology)
Instances of this logical model are not marked to be the target of a Reference
... ECOGStatus 0..1BackboneElementThe performance status of a patient as defined by the Eastern Cooperative Oncology Group (ECOG).
.... @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
.... Status 1..1CodeableConceptThe status of the observation
.... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
.... Method 0..1CodeableConceptThe technique, procedure, or system used to perform the observation.
.... Date 0..1dateTimeThe date and/or time that the observation was performed.
.... PerformedBy 0..*BackboneElementA person responsible for performing the observation.
..... @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
..... Id 0..1IdentifierHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
..... PersonName 0..1BackboneElementPerson name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.
...... @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
...... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
...... GivenName 0..1stringThe person’s forename or given name at birth
...... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
...... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
...... age 0..1stringSectionROCTreatmentCourse.ECOGStatus.PerformedBy.PersonName.age
..... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
...... @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
...... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
..... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
...... @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
...... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
...... RoleCode 1..1CodeableConceptThe designated the role of a health worker
...... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
...... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.
.... Comments 0..1stringPlain text comments about the observation.
.... ValueCodeable 0..1CodeableConceptThe result of the observation represented using a coded value.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ecog-status (preferred)
... ROCTherapy 0..1BackboneElementA single course of radiation therapy.
.... @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
.... 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.
.... TherapyDateRange 0..1PeriodThe date of first and last dose delivered for the therapy.
.... 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..1stringSectionROCTreatmentCourse.ROCTherapy.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
SectionROCTreatmentCourse-cs.ECOGStatus.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
SectionROCTreatmentCourse-cs.ECOGStatus.ValueCodeablepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-ecog-status
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ecog-status
SectionROCTreatmentCourse-cs.ROCTherapy.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 (12 nested mandatory elements)

 

Other representations of profile: CSV, Excel