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

Draft as of 2024-03-04

Definitions for the MarginStatus-cs logical model.

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

0. MarginStatus-cs
Definition

The status of the tissue on the margin of a resected specimen.

ShortMargin status
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. MarginStatus-cs.Status
Definition

The status of the observation

ShortThe status of the observation
Control1..1
TypeCodeableConcept
4. MarginStatus-cs.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
6. MarginStatus-cs.SpecimenId
Definition

An identifier of the specimen being observed.

ShortAn identifier of the specimen being observed.
Control0..1
TypeIdentifier
8. MarginStatus-cs.TumourIdentifier
Definition

An identifier for the tumour about which the observation is made.

ShortAn identifier for the tumour about which the observation is made.
Control0..1
TypeIdentifier
10. MarginStatus-cs.ResidualCancerStatus
Definition

Whether or not the margin of a resected specimen is involved in the tumour.

ShortWhether or not the margin of a resected specimen is involved in the tumour.
Control0..1
TypeCodeableConcept
12. MarginStatus-cs.InvolvedMargins
Definition

A free text description of the margins involved with respect to the tumour.

ShortA free text description of the margins involved with respect to the tumour.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. MarginStatus-cs.MarginDetail
Definition

Any relevant details about margins on a resected specimen.

ShortAny relevant details about margins on a resected specimen.
Control0..*
TypeBackboneElement
16. MarginStatus-cs.MarginDetail.Status
Definition

The status of the observation

ShortThe status of the observation
Control1..1
TypeCodeableConcept
18. MarginStatus-cs.MarginDetail.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
20. MarginStatus-cs.MarginDetail.SpecimenId
Definition

An identifier of the specimen being observed.

ShortAn identifier of the specimen being observed.
Control0..1
TypeIdentifier
22. MarginStatus-cs.MarginDetail.TumourIdentifier
Definition

An identifier for the tumour about which the observation is made.

ShortAn identifier for the tumour about which the observation is made.
Control0..1
TypeIdentifier
24. MarginStatus-cs.MarginDetail.Margin
Definition

The type of margin observed.

ShortThe type of margin observed.
Control1..1
TypeCodeableConcept
26. MarginStatus-cs.MarginDetail.MarginStatus
Definition

Whether or not this margin of the resected specimen is involved in the given tumour.

ShortWhether or not this margin of the resected specimen is involved in the given tumour.
Control0..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour
TypeCodeableConcept
28. MarginStatus-cs.MarginDetail.MarginQualifier
Definition

An additional qualification of the margin description, e.g. Proximal, Distal.

ShortAn additional qualification of the margin description, e.g. Proximal, Distal.
Control0..*
TypeCodeableConcept
30. MarginStatus-cs.MarginDetail.DistanceToMarginRange
Definition

The distance range between the given margin and the tumour on the resected specimen.

ShortThe distance range between the given margin and the tumour on the resected specimen.
Control0..1
TypeCodeableConcept
32. MarginStatus-cs.MarginDetail.DistanceToMarginMeasurement
Definition

The measurement of the distance between the given margin and the tumour on the resected specimen.

ShortThe measurement of the distance between the given margin and the tumour on the resected specimen.
Control0..1
TypeQuantity
34. MarginStatus-cs.MarginDetail.NatureOfTissueBetweenTumourAndMargin
Definition

The type of tissue found between the tumour and given margin on the specimen.

ShortThe type of tissue found between the tumour and given margin on the specimen.
Control0..1
TypeCodeableConcept
36. MarginStatus-cs.MarginDetail.MarginComments
Definition

Additional free text comments about the given margin on the resected specimen.

ShortAdditional free text comments about the given margin on the resected specimen.
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. MarginStatus-cs
Definition

The status of the tissue on the margin of a resected specimen.

ShortMargin status
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. MarginStatus-cs.Status
Definition

The status of the observation

ShortThe status of the observation
Control1..1
TypeCodeableConcept
4. MarginStatus-cs.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
6. MarginStatus-cs.SpecimenId
Definition

An identifier of the specimen being observed.

ShortAn identifier of the specimen being observed.
Control0..1
TypeIdentifier
8. MarginStatus-cs.TumourIdentifier
Definition

An identifier for the tumour about which the observation is made.

ShortAn identifier for the tumour about which the observation is made.
Control0..1
TypeIdentifier
10. MarginStatus-cs.ResidualCancerStatus
Definition

Whether or not the margin of a resected specimen is involved in the tumour.

ShortWhether or not the margin of a resected specimen is involved in the tumour.
Control0..1
TypeCodeableConcept
12. MarginStatus-cs.InvolvedMargins
Definition

A free text description of the margins involved with respect to the tumour.

ShortA free text description of the margins involved with respect to the tumour.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. MarginStatus-cs.MarginDetail
Definition

Any relevant details about margins on a resected specimen.

ShortAny relevant details about margins on a resected specimen.
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. MarginStatus-cs.MarginDetail.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. MarginStatus-cs.MarginDetail.Status
Definition

The status of the observation

ShortThe status of the observation
Control1..1
TypeCodeableConcept
20. MarginStatus-cs.MarginDetail.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
22. MarginStatus-cs.MarginDetail.SpecimenId
Definition

An identifier of the specimen being observed.

ShortAn identifier of the specimen being observed.
Control0..1
TypeIdentifier
24. MarginStatus-cs.MarginDetail.TumourIdentifier
Definition

An identifier for the tumour about which the observation is made.

ShortAn identifier for the tumour about which the observation is made.
Control0..1
TypeIdentifier
26. MarginStatus-cs.MarginDetail.Margin
Definition

The type of margin observed.

ShortThe type of margin observed.
Control1..1
TypeCodeableConcept
28. MarginStatus-cs.MarginDetail.MarginStatus
Definition

Whether or not this margin of the resected specimen is involved in the given tumour.

ShortWhether or not this margin of the resected specimen is involved in the given tumour.
Control0..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour
TypeCodeableConcept
30. MarginStatus-cs.MarginDetail.MarginQualifier
Definition

An additional qualification of the margin description, e.g. Proximal, Distal.

ShortAn additional qualification of the margin description, e.g. Proximal, Distal.
Control0..*
TypeCodeableConcept
32. MarginStatus-cs.MarginDetail.DistanceToMarginRange
Definition

The distance range between the given margin and the tumour on the resected specimen.

ShortThe distance range between the given margin and the tumour on the resected specimen.
Control0..1
TypeCodeableConcept
34. MarginStatus-cs.MarginDetail.DistanceToMarginMeasurement
Definition

The measurement of the distance between the given margin and the tumour on the resected specimen.

ShortThe measurement of the distance between the given margin and the tumour on the resected specimen.
Control0..1
TypeQuantity
36. MarginStatus-cs.MarginDetail.NatureOfTissueBetweenTumourAndMargin
Definition

The type of tissue found between the tumour and given margin on the specimen.

ShortThe type of tissue found between the tumour and given margin on the specimen.
Control0..1
TypeCodeableConcept
38. MarginStatus-cs.MarginDetail.MarginComments
Definition

Additional free text comments about the given margin on the resected specimen.

ShortAdditional free text comments about the given margin on the resected specimen.
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. MarginStatus-cs
Definition

The status of the tissue on the margin of a resected specimen.

ShortMargin status
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. MarginStatus-cs.Status
Definition

The status of the observation

ShortThe status of the observation
Control1..1
TypeCodeableConcept
4. MarginStatus-cs.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
6. MarginStatus-cs.SpecimenId
Definition

An identifier of the specimen being observed.

ShortAn identifier of the specimen being observed.
Control0..1
TypeIdentifier
8. MarginStatus-cs.TumourIdentifier
Definition

An identifier for the tumour about which the observation is made.

ShortAn identifier for the tumour about which the observation is made.
Control0..1
TypeIdentifier
10. MarginStatus-cs.ResidualCancerStatus
Definition

Whether or not the margin of a resected specimen is involved in the tumour.

ShortWhether or not the margin of a resected specimen is involved in the tumour.
Control0..1
TypeCodeableConcept
12. MarginStatus-cs.InvolvedMargins
Definition

A free text description of the margins involved with respect to the tumour.

ShortA free text description of the margins involved with respect to the tumour.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. MarginStatus-cs.MarginDetail
Definition

Any relevant details about margins on a resected specimen.

ShortAny relevant details about margins on a resected specimen.
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. MarginStatus-cs.MarginDetail.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. MarginStatus-cs.MarginDetail.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 MarginStatus-cs.MarginDetail.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
20. MarginStatus-cs.MarginDetail.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. MarginStatus-cs.MarginDetail.Status
Definition

The status of the observation

ShortThe status of the observation
Control1..1
TypeCodeableConcept
24. MarginStatus-cs.MarginDetail.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
26. MarginStatus-cs.MarginDetail.SpecimenId
Definition

An identifier of the specimen being observed.

ShortAn identifier of the specimen being observed.
Control0..1
TypeIdentifier
28. MarginStatus-cs.MarginDetail.TumourIdentifier
Definition

An identifier for the tumour about which the observation is made.

ShortAn identifier for the tumour about which the observation is made.
Control0..1
TypeIdentifier
30. MarginStatus-cs.MarginDetail.Margin
Definition

The type of margin observed.

ShortThe type of margin observed.
Control1..1
TypeCodeableConcept
32. MarginStatus-cs.MarginDetail.MarginStatus
Definition

Whether or not this margin of the resected specimen is involved in the given tumour.

ShortWhether or not this margin of the resected specimen is involved in the given tumour.
Control0..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour
TypeCodeableConcept
34. MarginStatus-cs.MarginDetail.MarginQualifier
Definition

An additional qualification of the margin description, e.g. Proximal, Distal.

ShortAn additional qualification of the margin description, e.g. Proximal, Distal.
Control0..*
TypeCodeableConcept
36. MarginStatus-cs.MarginDetail.DistanceToMarginRange
Definition

The distance range between the given margin and the tumour on the resected specimen.

ShortThe distance range between the given margin and the tumour on the resected specimen.
Control0..1
TypeCodeableConcept
38. MarginStatus-cs.MarginDetail.DistanceToMarginMeasurement
Definition

The measurement of the distance between the given margin and the tumour on the resected specimen.

ShortThe measurement of the distance between the given margin and the tumour on the resected specimen.
Control0..1
TypeQuantity
40. MarginStatus-cs.MarginDetail.NatureOfTissueBetweenTumourAndMargin
Definition

The type of tissue found between the tumour and given margin on the specimen.

ShortThe type of tissue found between the tumour and given margin on the specimen.
Control0..1
TypeCodeableConcept
42. MarginStatus-cs.MarginDetail.MarginComments
Definition

Additional free text comments about the given margin on the resected specimen.

ShortAdditional free text comments about the given margin on the resected specimen.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension