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

Draft as of 2024-03-04

Definitions for the ColorectalDiagnosticHistoReportMacro-cs logical model.

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

0. ColorectalDiagnosticHistoReportMacro-cs
Definition

Observations on a specimen that are visible to the naked eye, as documented on a colorectal diagnostic histopathology report.

ShortMacroscopic findings (colorectal diagnostic histopathology report)
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions
Definition

The size of the specimen measured macroscopically in one or more dimensions.

ShortThe size of the specimen measured macroscopically in one or more dimensions.
Control0..1
TypeBackboneElement
4. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.Status
Definition

The status of the observation

ShortThe status of the observation
Control1..1
TypeCodeableConcept
6. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.Code
Definition

The type of observation made.

ShortThe type of observation made.
Control1..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
TypeCodeableConcept
8. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.SpecimenId
Definition

An identifier of the specimen being observed.

ShortAn identifier of the specimen being observed.
Control0..1
TypeIdentifier
10. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.SpecimenDimensionsStatus
Definition

Whether or not the specimen dimensions have been measured.

ShortWhether or not the specimen dimensions have been measured.
Control1..1
TypeCodeableConcept
12. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.MaximumSpecimenDimension
Definition

A measurement of the largest dimension of the specimen.

ShortA measurement of the largest dimension of the specimen.
Control0..1
TypeQuantity
14. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.Dimension
Definition

A measurement of one of the dimensions of the tumour.

ShortA measurement of one of the dimensions of the tumour.
Control0..*
TypeBackboneElement
16. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.Dimension.Type
Definition

The type of dimension in which this measurement was taken, e.g. length, width, depth.

ShortThe type of dimension in which this measurement was taken, e.g. length, width, depth.
Control1..1
TypeCodeableConcept
18. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.Dimension.Size
Definition

The size of the lesion in the given dimension.

ShortThe size of the lesion in the given dimension.
Control1..1
TypeQuantity

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

0. ColorectalDiagnosticHistoReportMacro-cs
Definition

Observations on a specimen that are visible to the naked eye, as documented on a colorectal diagnostic histopathology report.

ShortMacroscopic findings (colorectal diagnostic histopathology report)
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions
Definition

The size of the specimen measured macroscopically in one or more dimensions.

ShortThe size of the specimen measured macroscopically in one or more dimensions.
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.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())
6. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.Status
Definition

The status of the observation

ShortThe status of the observation
Control1..1
TypeCodeableConcept
8. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.Code
Definition

The type of observation made.

ShortThe type of observation made.
Control1..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
TypeCodeableConcept
10. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.SpecimenId
Definition

An identifier of the specimen being observed.

ShortAn identifier of the specimen being observed.
Control0..1
TypeIdentifier
12. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.SpecimenDimensionsStatus
Definition

Whether or not the specimen dimensions have been measured.

ShortWhether or not the specimen dimensions have been measured.
Control1..1
TypeCodeableConcept
14. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.MaximumSpecimenDimension
Definition

A measurement of the largest dimension of the specimen.

ShortA measurement of the largest dimension of the specimen.
Control0..1
TypeQuantity
16. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.Dimension
Definition

A measurement of one of the dimensions of the tumour.

ShortA measurement of one of the dimensions of the tumour.
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.Dimension.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())
20. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.Dimension.Type
Definition

The type of dimension in which this measurement was taken, e.g. length, width, depth.

ShortThe type of dimension in which this measurement was taken, e.g. length, width, depth.
Control1..1
TypeCodeableConcept
22. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.Dimension.Size
Definition

The size of the lesion in the given dimension.

ShortThe size of the lesion in the given dimension.
Control1..1
TypeQuantity

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

0. ColorectalDiagnosticHistoReportMacro-cs
Definition

Observations on a specimen that are visible to the naked eye, as documented on a colorectal diagnostic histopathology report.

ShortMacroscopic findings (colorectal diagnostic histopathology report)
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions
Definition

The size of the specimen measured macroscopically in one or more dimensions.

ShortThe size of the specimen measured macroscopically in one or more dimensions.
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.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
6. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.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 ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
8. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.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())
10. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.Status
Definition

The status of the observation

ShortThe status of the observation
Control1..1
TypeCodeableConcept
12. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.Code
Definition

The type of observation made.

ShortThe type of observation made.
Control1..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
TypeCodeableConcept
14. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.SpecimenId
Definition

An identifier of the specimen being observed.

ShortAn identifier of the specimen being observed.
Control0..1
TypeIdentifier
16. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.SpecimenDimensionsStatus
Definition

Whether or not the specimen dimensions have been measured.

ShortWhether or not the specimen dimensions have been measured.
Control1..1
TypeCodeableConcept
18. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.MaximumSpecimenDimension
Definition

A measurement of the largest dimension of the specimen.

ShortA measurement of the largest dimension of the specimen.
Control0..1
TypeQuantity
20. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.Dimension
Definition

A measurement of one of the dimensions of the tumour.

ShortA measurement of one of the dimensions of the tumour.
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.Dimension.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
24. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.Dimension.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 ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.Dimension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
26. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.Dimension.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())
28. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.Dimension.Type
Definition

The type of dimension in which this measurement was taken, e.g. length, width, depth.

ShortThe type of dimension in which this measurement was taken, e.g. length, width, depth.
Control1..1
TypeCodeableConcept
30. ColorectalDiagnosticHistoReportMacro-cs.SpecimenDimensions.Dimension.Size
Definition

The size of the lesion in the given dimension.

ShortThe size of the lesion in the given dimension.
Control1..1
TypeQuantity