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: Clinical margin status

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

The status of the tissue on the margin of a resected specimen as specified by the clinician (eg surgeon).

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
.. ClinicalMarginStatus-cs 0..*BaseClinical margin status
Instances of this logical model are not marked to be the target of a Reference
... 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)
... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
... InvolvedMargins 0..1stringA free text description of the margins involved with respect to the tumour.
... MarginDetail 0..*BackboneElementAny relevant details about margins on a resected specimen.
.... 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)
.... SpecimenId 0..1IdentifierAn identifier of the specimen being observed.
.... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
.... Margin 1..1CodeableConceptThe type of margin observed.
.... MarginStatus 0..1CodeableConceptWhether or not this margin of the resected specimen is involved in the given tumour.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour (preferred)
.... MarginQualifier 0..*CodeableConceptAn additional qualification of the margin description, e.g. Proximal, Distal.
.... DistanceToMarginRange 0..1CodeableConceptThe distance range between the given margin and the tumour on the resected specimen.
.... DistanceToMarginMeasurement 0..1QuantityThe measurement of the distance between the given margin and the tumour on the resected specimen.
.... NatureOfTissueBetweenTumourAndMargin 0..1CodeableConceptThe type of tissue found between the tumour and given margin on the specimen.
.... MarginComments 0..1stringAdditional free text comments about the given margin on the resected specimen.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ClinicalMarginStatus-cs.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
ClinicalMarginStatus-cs.MarginDetail.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
ClinicalMarginStatus-cs.MarginDetail.MarginStatuspreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour
NameFlagsCard.TypeDescription & Constraintsdoco
.. ClinicalMarginStatus-cs 0..*BaseClinical margin status
Instances of this logical model are not marked to be the target of a Reference
... 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)
... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
... InvolvedMargins 0..1stringA free text description of the margins involved with respect to the tumour.
... MarginDetail 0..*BackboneElementAny relevant details about margins on a resected specimen.
.... 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)
.... SpecimenId 0..1IdentifierAn identifier of the specimen being observed.
.... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
.... Margin 1..1CodeableConceptThe type of margin observed.
.... MarginStatus 0..1CodeableConceptWhether or not this margin of the resected specimen is involved in the given tumour.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour (preferred)
.... MarginQualifier 0..*CodeableConceptAn additional qualification of the margin description, e.g. Proximal, Distal.
.... DistanceToMarginRange 0..1CodeableConceptThe distance range between the given margin and the tumour on the resected specimen.
.... DistanceToMarginMeasurement 0..1QuantityThe measurement of the distance between the given margin and the tumour on the resected specimen.
.... NatureOfTissueBetweenTumourAndMargin 0..1CodeableConceptThe type of tissue found between the tumour and given margin on the specimen.
.... MarginComments 0..1stringAdditional free text comments about the given margin on the resected specimen.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ClinicalMarginStatus-cs.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
ClinicalMarginStatus-cs.MarginDetail.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
ClinicalMarginStatus-cs.MarginDetail.MarginStatuspreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour

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
.. ClinicalMarginStatus-cs 0..*BaseClinical margin status
Instances of this logical model are not marked to be the target of a Reference
... 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)
... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
... InvolvedMargins 0..1stringA free text description of the margins involved with respect to the tumour.
... MarginDetail 0..*BackboneElementAny relevant details about margins on a resected specimen.
.... @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)
.... SpecimenId 0..1IdentifierAn identifier of the specimen being observed.
.... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
.... Margin 1..1CodeableConceptThe type of margin observed.
.... MarginStatus 0..1CodeableConceptWhether or not this margin of the resected specimen is involved in the given tumour.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour (preferred)
.... MarginQualifier 0..*CodeableConceptAn additional qualification of the margin description, e.g. Proximal, Distal.
.... DistanceToMarginRange 0..1CodeableConceptThe distance range between the given margin and the tumour on the resected specimen.
.... DistanceToMarginMeasurement 0..1QuantityThe measurement of the distance between the given margin and the tumour on the resected specimen.
.... NatureOfTissueBetweenTumourAndMargin 0..1CodeableConceptThe type of tissue found between the tumour and given margin on the specimen.
.... MarginComments 0..1stringAdditional free text comments about the given margin on the resected specimen.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ClinicalMarginStatus-cs.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
ClinicalMarginStatus-cs.MarginDetail.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
ClinicalMarginStatus-cs.MarginDetail.MarginStatuspreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour

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 (5 nested mandatory elements)

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. ClinicalMarginStatus-cs 0..*BaseClinical margin status
Instances of this logical model are not marked to be the target of a Reference
... 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)
... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
... InvolvedMargins 0..1stringA free text description of the margins involved with respect to the tumour.
... MarginDetail 0..*BackboneElementAny relevant details about margins on a resected specimen.
.... 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)
.... SpecimenId 0..1IdentifierAn identifier of the specimen being observed.
.... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
.... Margin 1..1CodeableConceptThe type of margin observed.
.... MarginStatus 0..1CodeableConceptWhether or not this margin of the resected specimen is involved in the given tumour.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour (preferred)
.... MarginQualifier 0..*CodeableConceptAn additional qualification of the margin description, e.g. Proximal, Distal.
.... DistanceToMarginRange 0..1CodeableConceptThe distance range between the given margin and the tumour on the resected specimen.
.... DistanceToMarginMeasurement 0..1QuantityThe measurement of the distance between the given margin and the tumour on the resected specimen.
.... NatureOfTissueBetweenTumourAndMargin 0..1CodeableConceptThe type of tissue found between the tumour and given margin on the specimen.
.... MarginComments 0..1stringAdditional free text comments about the given margin on the resected specimen.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ClinicalMarginStatus-cs.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
ClinicalMarginStatus-cs.MarginDetail.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
ClinicalMarginStatus-cs.MarginDetail.MarginStatuspreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ClinicalMarginStatus-cs 0..*BaseClinical margin status
Instances of this logical model are not marked to be the target of a Reference
... 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)
... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
... InvolvedMargins 0..1stringA free text description of the margins involved with respect to the tumour.
... MarginDetail 0..*BackboneElementAny relevant details about margins on a resected specimen.
.... 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)
.... SpecimenId 0..1IdentifierAn identifier of the specimen being observed.
.... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
.... Margin 1..1CodeableConceptThe type of margin observed.
.... MarginStatus 0..1CodeableConceptWhether or not this margin of the resected specimen is involved in the given tumour.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour (preferred)
.... MarginQualifier 0..*CodeableConceptAn additional qualification of the margin description, e.g. Proximal, Distal.
.... DistanceToMarginRange 0..1CodeableConceptThe distance range between the given margin and the tumour on the resected specimen.
.... DistanceToMarginMeasurement 0..1QuantityThe measurement of the distance between the given margin and the tumour on the resected specimen.
.... NatureOfTissueBetweenTumourAndMargin 0..1CodeableConceptThe type of tissue found between the tumour and given margin on the specimen.
.... MarginComments 0..1stringAdditional free text comments about the given margin on the resected specimen.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ClinicalMarginStatus-cs.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
ClinicalMarginStatus-cs.MarginDetail.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
ClinicalMarginStatus-cs.MarginDetail.MarginStatuspreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour

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
.. ClinicalMarginStatus-cs 0..*BaseClinical margin status
Instances of this logical model are not marked to be the target of a Reference
... 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)
... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
... InvolvedMargins 0..1stringA free text description of the margins involved with respect to the tumour.
... MarginDetail 0..*BackboneElementAny relevant details about margins on a resected specimen.
.... @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)
.... SpecimenId 0..1IdentifierAn identifier of the specimen being observed.
.... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
.... Margin 1..1CodeableConceptThe type of margin observed.
.... MarginStatus 0..1CodeableConceptWhether or not this margin of the resected specimen is involved in the given tumour.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour (preferred)
.... MarginQualifier 0..*CodeableConceptAn additional qualification of the margin description, e.g. Proximal, Distal.
.... DistanceToMarginRange 0..1CodeableConceptThe distance range between the given margin and the tumour on the resected specimen.
.... DistanceToMarginMeasurement 0..1QuantityThe measurement of the distance between the given margin and the tumour on the resected specimen.
.... NatureOfTissueBetweenTumourAndMargin 0..1CodeableConceptThe type of tissue found between the tumour and given margin on the specimen.
.... MarginComments 0..1stringAdditional free text comments about the given margin on the resected specimen.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ClinicalMarginStatus-cs.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
ClinicalMarginStatus-cs.MarginDetail.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
ClinicalMarginStatus-cs.MarginDetail.MarginStatuspreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour

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 (5 nested mandatory elements)

 

Other representations of profile: CSV, Excel