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: PrimaryCancerDiagnosis_cs - Detailed Descriptions

Draft as of 2024-03-04

Definitions for the PrimaryCancerDiagnosis-cs logical model.

Guidance on how to interpret the contents of this table can be found here

0. PrimaryCancerDiagnosis-cs
Definition

A primary cancer condition that is diagnosed in the patient (either clinically or pathologically). For solid cancers, this is the original or first neoplasm in the body. For haematologic cancers, this is the original cancer type in the body. This also includes cancers of uncertain origin or behaviour.

ShortPrimary cancer diagnosis
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. PrimaryCancerDiagnosis-cs.ClinicalStatus
Definition

The status of the condition, in terms of its clinical progression, i.e. active, recurrence, relapse, inactive, remission, resolved, unknown.

ShortThe status of the condition, in terms of its clinical progression, i.e. active, recurrence, relapse, inactive, remission, resolved, unknown.
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. PrimaryCancerDiagnosis-cs.VerificationStatus
Definition

The status of the condition from a certainty perspective, i.e. unconfirmed, provisional, differential, confirmed, refuted, entered-in-error.

ShortThe status of the condition from a certainty perspective, i.e. unconfirmed, provisional, differential, confirmed, refuted, entered-in-error.
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. PrimaryCancerDiagnosis-cs.Comments
Definition

Free text comments about the medical condition.

ShortFree text comments about the medical condition.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. PrimaryCancerDiagnosis-cs.DiagnosisDate
Definition

The date (and optionally time) on which the medical conditions was first diagnosed.

ShortThe date (and optionally time) on which the medical conditions was first diagnosed.
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. PrimaryCancerDiagnosis-cs.BasisOfDiagnosis
Definition

The evidence on which the condition was diagnosed.

ShortThe evidence on which the condition was diagnosed.
Control0..1
TypeCodeableConcept
12. PrimaryCancerDiagnosis-cs.Code
Definition

The type of medical condition.

ShortThe type of medical condition.
Control1..1
TypeCodeableConcept
14. PrimaryCancerDiagnosis-cs.BodySite
Definition

The location in the body where the condition is found.

ShortThe location in the body where the condition is found.
Control0..1
TypeBackboneElement
16. PrimaryCancerDiagnosis-cs.BodySite.BodyStructure
Definition

The anatomical structure being described

ShortThe anatomical structure being described
Control1..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
TypeCodeableConcept
18. PrimaryCancerDiagnosis-cs.BodySite.BodyStructurePart
Definition

The anatomical part of the body structure being described.

ShortThe anatomical part of the body structure being described.
Control0..*
TypeCodeableConcept
20. PrimaryCancerDiagnosis-cs.BodySite.Clockface
Definition

The clockface orientation from the landmark.

ShortThe clockface orientation from the landmark.
Control0..1
TypeCodeableConcept
22. PrimaryCancerDiagnosis-cs.BodySite.DistanceFromLandmark
Definition

The distance from the given landmark.

ShortThe distance from the given landmark.
Control0..1
TypeQuantity
24. PrimaryCancerDiagnosis-cs.BodySite.Comments
Definition

Free text comments describing the body site.

ShortFree text comments describing the body site.
Control0..1
TypeCodeableConcept
26. PrimaryCancerDiagnosis-cs.Morphology
Definition

The form and structure of the cancer, as observed by a pathologist (e.g. histologic type, cytologic type)

ShortThe form and structure of the cancer, as observed by a pathologist (e.g. histologic type, cytologic type)
Control0..1
TypeCodeableConcept

Guidance on how to interpret the contents of this table can be found here

0. PrimaryCancerDiagnosis-cs
Definition

A primary cancer condition that is diagnosed in the patient (either clinically or pathologically). For solid cancers, this is the original or first neoplasm in the body. For haematologic cancers, this is the original cancer type in the body. This also includes cancers of uncertain origin or behaviour.

ShortPrimary cancer diagnosis
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. PrimaryCancerDiagnosis-cs.ClinicalStatus
Definition

The status of the condition, in terms of its clinical progression, i.e. active, recurrence, relapse, inactive, remission, resolved, unknown.

ShortThe status of the condition, in terms of its clinical progression, i.e. active, recurrence, relapse, inactive, remission, resolved, unknown.
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. PrimaryCancerDiagnosis-cs.VerificationStatus
Definition

The status of the condition from a certainty perspective, i.e. unconfirmed, provisional, differential, confirmed, refuted, entered-in-error.

ShortThe status of the condition from a certainty perspective, i.e. unconfirmed, provisional, differential, confirmed, refuted, entered-in-error.
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. PrimaryCancerDiagnosis-cs.Comments
Definition

Free text comments about the medical condition.

ShortFree text comments about the medical condition.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. PrimaryCancerDiagnosis-cs.DiagnosisDate
Definition

The date (and optionally time) on which the medical conditions was first diagnosed.

ShortThe date (and optionally time) on which the medical conditions was first diagnosed.
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. PrimaryCancerDiagnosis-cs.BasisOfDiagnosis
Definition

The evidence on which the condition was diagnosed.

ShortThe evidence on which the condition was diagnosed.
Control0..1
TypeCodeableConcept
12. PrimaryCancerDiagnosis-cs.Code
Definition

The type of medical condition.

ShortThe type of medical condition.
Control1..1
TypeCodeableConcept
14. PrimaryCancerDiagnosis-cs.BodySite
Definition

The location in the body where the condition is found.

ShortThe location in the body where the condition is found.
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. PrimaryCancerDiagnosis-cs.BodySite.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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
18. PrimaryCancerDiagnosis-cs.BodySite.BodyStructure
Definition

The anatomical structure being described

ShortThe anatomical structure being described
Control1..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
TypeCodeableConcept
20. PrimaryCancerDiagnosis-cs.BodySite.BodyStructurePart
Definition

The anatomical part of the body structure being described.

ShortThe anatomical part of the body structure being described.
Control0..*
TypeCodeableConcept
22. PrimaryCancerDiagnosis-cs.BodySite.Clockface
Definition

The clockface orientation from the landmark.

ShortThe clockface orientation from the landmark.
Control0..1
TypeCodeableConcept
24. PrimaryCancerDiagnosis-cs.BodySite.DistanceFromLandmark
Definition

The distance from the given landmark.

ShortThe distance from the given landmark.
Control0..1
TypeQuantity
26. PrimaryCancerDiagnosis-cs.BodySite.Comments
Definition

Free text comments describing the body site.

ShortFree text comments describing the body site.
Control0..1
TypeCodeableConcept
28. PrimaryCancerDiagnosis-cs.Morphology
Definition

The form and structure of the cancer, as observed by a pathologist (e.g. histologic type, cytologic type)

ShortThe form and structure of the cancer, as observed by a pathologist (e.g. histologic type, cytologic type)
Control0..1
TypeCodeableConcept

Guidance on how to interpret the contents of this table can be found here

0. PrimaryCancerDiagnosis-cs
Definition

A primary cancer condition that is diagnosed in the patient (either clinically or pathologically). For solid cancers, this is the original or first neoplasm in the body. For haematologic cancers, this is the original cancer type in the body. This also includes cancers of uncertain origin or behaviour.

ShortPrimary cancer diagnosis
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. PrimaryCancerDiagnosis-cs.ClinicalStatus
Definition

The status of the condition, in terms of its clinical progression, i.e. active, recurrence, relapse, inactive, remission, resolved, unknown.

ShortThe status of the condition, in terms of its clinical progression, i.e. active, recurrence, relapse, inactive, remission, resolved, unknown.
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. PrimaryCancerDiagnosis-cs.VerificationStatus
Definition

The status of the condition from a certainty perspective, i.e. unconfirmed, provisional, differential, confirmed, refuted, entered-in-error.

ShortThe status of the condition from a certainty perspective, i.e. unconfirmed, provisional, differential, confirmed, refuted, entered-in-error.
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. PrimaryCancerDiagnosis-cs.Comments
Definition

Free text comments about the medical condition.

ShortFree text comments about the medical condition.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. PrimaryCancerDiagnosis-cs.DiagnosisDate
Definition

The date (and optionally time) on which the medical conditions was first diagnosed.

ShortThe date (and optionally time) on which the medical conditions was first diagnosed.
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. PrimaryCancerDiagnosis-cs.BasisOfDiagnosis
Definition

The evidence on which the condition was diagnosed.

ShortThe evidence on which the condition was diagnosed.
Control0..1
TypeCodeableConcept
12. PrimaryCancerDiagnosis-cs.Code
Definition

The type of medical condition.

ShortThe type of medical condition.
Control1..1
TypeCodeableConcept
14. PrimaryCancerDiagnosis-cs.BodySite
Definition

The location in the body where the condition is found.

ShortThe location in the body where the condition is found.
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. PrimaryCancerDiagnosis-cs.BodySite.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
18. PrimaryCancerDiagnosis-cs.BodySite.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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PrimaryCancerDiagnosis-cs.BodySite.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
20. PrimaryCancerDiagnosis-cs.BodySite.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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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())
22. PrimaryCancerDiagnosis-cs.BodySite.BodyStructure
Definition

The anatomical structure being described

ShortThe anatomical structure being described
Control1..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
TypeCodeableConcept
24. PrimaryCancerDiagnosis-cs.BodySite.BodyStructurePart
Definition

The anatomical part of the body structure being described.

ShortThe anatomical part of the body structure being described.
Control0..*
TypeCodeableConcept
26. PrimaryCancerDiagnosis-cs.BodySite.Clockface
Definition

The clockface orientation from the landmark.

ShortThe clockface orientation from the landmark.
Control0..1
TypeCodeableConcept
28. PrimaryCancerDiagnosis-cs.BodySite.DistanceFromLandmark
Definition

The distance from the given landmark.

ShortThe distance from the given landmark.
Control0..1
TypeQuantity
30. PrimaryCancerDiagnosis-cs.BodySite.Comments
Definition

Free text comments describing the body site.

ShortFree text comments describing the body site.
Control0..1
TypeCodeableConcept
32. PrimaryCancerDiagnosis-cs.Morphology
Definition

The form and structure of the cancer, as observed by a pathologist (e.g. histologic type, cytologic type)

ShortThe form and structure of the cancer, as observed by a pathologist (e.g. histologic type, cytologic type)
Control0..1
TypeCodeableConcept