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

Draft as of 2024-03-04

Definitions for the Tumour-cs logical model.

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

0. Tumour-cs
Definition

An abnormal change and/or damage in a body structure or tissue.

ShortTumour
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Tumour-cs.TumourId
Definition

The number or identifier used to reference the given lesion/tumour.

ShortThe number or identifier used to reference the given lesion/tumour.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. Tumour-cs.TumourSite
Definition

The body location of the lesion/tumour.

ShortThe body location of the lesion/tumour.
Control0..*
TypeBackboneElement
6. Tumour-cs.TumourSite.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
8. Tumour-cs.TumourSite.BodyStructurePart
Definition

The anatomical part of the body structure being described.

ShortThe anatomical part of the body structure being described.
Control0..*
TypeCodeableConcept
10. Tumour-cs.TumourSite.Clockface
Definition

The clockface orientation from the landmark.

ShortThe clockface orientation from the landmark.
Control0..1
TypeCodeableConcept
12. Tumour-cs.TumourSite.DistanceFromLandmark
Definition

The distance from the given landmark.

ShortThe distance from the given landmark.
Control0..1
TypeQuantity
14. Tumour-cs.TumourSite.Comments
Definition

Free text comments describing the body site.

ShortFree text comments describing the body site.
Control0..1
TypeCodeableConcept
16. Tumour-cs.Comments
Definition

Free text comments about the lesion/tumour.

ShortFree text comments about the lesion/tumour.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

0. Tumour-cs
Definition

An abnormal change and/or damage in a body structure or tissue.

ShortTumour
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Tumour-cs.TumourId
Definition

The number or identifier used to reference the given lesion/tumour.

ShortThe number or identifier used to reference the given lesion/tumour.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. Tumour-cs.TumourSite
Definition

The body location of the lesion/tumour.

ShortThe body location of the lesion/tumour.
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Tumour-cs.TumourSite.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())
8. Tumour-cs.TumourSite.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
10. Tumour-cs.TumourSite.BodyStructurePart
Definition

The anatomical part of the body structure being described.

ShortThe anatomical part of the body structure being described.
Control0..*
TypeCodeableConcept
12. Tumour-cs.TumourSite.Clockface
Definition

The clockface orientation from the landmark.

ShortThe clockface orientation from the landmark.
Control0..1
TypeCodeableConcept
14. Tumour-cs.TumourSite.DistanceFromLandmark
Definition

The distance from the given landmark.

ShortThe distance from the given landmark.
Control0..1
TypeQuantity
16. Tumour-cs.TumourSite.Comments
Definition

Free text comments describing the body site.

ShortFree text comments describing the body site.
Control0..1
TypeCodeableConcept
18. Tumour-cs.Comments
Definition

Free text comments about the lesion/tumour.

ShortFree text comments about the lesion/tumour.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

0. Tumour-cs
Definition

An abnormal change and/or damage in a body structure or tissue.

ShortTumour
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Tumour-cs.TumourId
Definition

The number or identifier used to reference the given lesion/tumour.

ShortThe number or identifier used to reference the given lesion/tumour.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. Tumour-cs.TumourSite
Definition

The body location of the lesion/tumour.

ShortThe body location of the lesion/tumour.
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Tumour-cs.TumourSite.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
8. Tumour-cs.TumourSite.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 Tumour-cs.TumourSite.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
10. Tumour-cs.TumourSite.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())
12. Tumour-cs.TumourSite.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
14. Tumour-cs.TumourSite.BodyStructurePart
Definition

The anatomical part of the body structure being described.

ShortThe anatomical part of the body structure being described.
Control0..*
TypeCodeableConcept
16. Tumour-cs.TumourSite.Clockface
Definition

The clockface orientation from the landmark.

ShortThe clockface orientation from the landmark.
Control0..1
TypeCodeableConcept
18. Tumour-cs.TumourSite.DistanceFromLandmark
Definition

The distance from the given landmark.

ShortThe distance from the given landmark.
Control0..1
TypeQuantity
20. Tumour-cs.TumourSite.Comments
Definition

Free text comments describing the body site.

ShortFree text comments describing the body site.
Control0..1
TypeCodeableConcept
22. Tumour-cs.Comments
Definition

Free text comments about the lesion/tumour.

ShortFree text comments about the lesion/tumour.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension