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: Specimen (breast resection histopathology)

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

Relevant specimen information in a breast resection histopathology composition.

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
.. BreastResectionHistoSpecimen-cs 0..*BaseSpecimen (breast resection histopathology)
Instances of this logical model are not marked to be the target of a Reference
... Specimen 1..1BackboneElementA sample to be used for analysis.
.... Id 0..*IdentifierAn identifier for the specimen, e.g. a barcode.
.... TumourIdentifier 0..*stringThe number or identifier used to reference the given lesion/tumour.
.... Category 0..1CodeableConceptThe category of specimen, e.g. biopsy specimen
.... Type 0..1CodeableConceptThe type of specimen, e.g. core biopsy specimen, lymph node excision specimen.
.... Collection 0..1BackboneElementDetails about the collection of the specimen.
..... Procedure 0..*CodeableConceptThe procedure used to collect the specimen, e.g. Partial mastectomy, Wide local excision, Lumpectomy, Hookwire excision
..... CollectionDate 0..1dateTimeThe date and/or time that the sample/specimen was collected.
..... collectedBy 0..1BackboneElementThe healthcare practitioner who collected the specimen.
...... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
....... RoleCode 1..1CodeableConceptThe designated the role of a health worker
.... ContainerQuantity 0..1QuantityA count of the number of containers (e.g. 3 tubes, 4 slides, 1 bottle) in which the specimen is placed after collection.
.... Comments 0..1stringFree text comments about the specimen.
... SpecimenContainer 0..*BackboneElementAn individual container (e.g. a specific tube) in which the specimen is placed.
.... ContainerId 0..1IdentifierAn identifier for the individual specimen container.
.... SpecimenId 0..1IdentifierAn identifier for the specimen in the container.
.... Quantity 0..1QuantityThe quantity of specimen (volume, weight or count of pieces/fragments) placed in this individual container.
... SpecimenOrientationMarkers 0..1BackboneElementOrientation markers of a tissue sample (used for excision/resection specimens).
.... SpecimenId 1..1IdentifierThe identifier of the specimen.
.... Technique 0..1CodeableConceptThe orientation marker technique used (e.g. surgical, radiological).
.... OrientationMarker 0..*BackboneElementDetails about an individual specimen orientation marker.
..... Position 1..1CodeableConceptThe position of the orientation marker (e.g. superior, inferior)
..... Description 0..1stringA description of the marker at the given position.
.... 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.
.... ResidualCancerStatus 0..1CodeableConceptWhether or not the margin of a resected specimen is involved in the tumour.
.... 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.
... SpecimenImageIncluded 0..1booleanA flag to indicate whether or not an image of the specimen is included.
... Image 0..1BackboneElementAn image of the patient's tumour, specimen, or radiology.
.... File 0..1AttachmentThe file containing the image.
.... Label 0..*stringA label describing the image in the file.
.... bool 0..1booleanBreastResectionHistoSpecimen.Image.bool

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
BreastResectionHistoSpecimen-cs.ClinicalMarginStatus.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
BreastResectionHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
BreastResectionHistoSpecimen-cs.ClinicalMarginStatus.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
.. BreastResectionHistoSpecimen-cs 0..*BaseSpecimen (breast resection histopathology)
Instances of this logical model are not marked to be the target of a Reference
... Specimen 1..1BackboneElementA sample to be used for analysis.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Id 0..*IdentifierAn identifier for the specimen, e.g. a barcode.
.... TumourIdentifier 0..*stringThe number or identifier used to reference the given lesion/tumour.
.... Category 0..1CodeableConceptThe category of specimen, e.g. biopsy specimen
.... Type 0..1CodeableConceptThe type of specimen, e.g. core biopsy specimen, lymph node excision specimen.
.... Collection 0..1BackboneElementDetails about the collection of the specimen.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Procedure 0..*CodeableConceptThe procedure used to collect the specimen, e.g. Partial mastectomy, Wide local excision, Lumpectomy, Hookwire excision
..... CollectionDate 0..1dateTimeThe date and/or time that the sample/specimen was collected.
..... collectedBy 0..1BackboneElementThe healthcare practitioner who collected the specimen.
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... RoleCode 1..1CodeableConceptThe designated the role of a health worker
.... ContainerQuantity 0..1QuantityA count of the number of containers (e.g. 3 tubes, 4 slides, 1 bottle) in which the specimen is placed after collection.
.... Comments 0..1stringFree text comments about the specimen.
... SpecimenContainer 0..*BackboneElementAn individual container (e.g. a specific tube) in which the specimen is placed.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ContainerId 0..1IdentifierAn identifier for the individual specimen container.
.... SpecimenId 0..1IdentifierAn identifier for the specimen in the container.
.... Quantity 0..1QuantityThe quantity of specimen (volume, weight or count of pieces/fragments) placed in this individual container.
... SpecimenOrientationMarkers 0..1BackboneElementOrientation markers of a tissue sample (used for excision/resection specimens).
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... SpecimenId 1..1IdentifierThe identifier of the specimen.
.... Technique 0..1CodeableConceptThe orientation marker technique used (e.g. surgical, radiological).
.... OrientationMarker 0..*BackboneElementDetails about an individual specimen orientation marker.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Position 1..1CodeableConceptThe position of the orientation marker (e.g. superior, inferior)
..... Description 0..1stringA description of the marker at the given position.
.... 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)
.... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
.... ResidualCancerStatus 0..1CodeableConceptWhether or not the margin of a resected specimen is involved in the tumour.
.... 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.
... SpecimenImageIncluded 0..1booleanA flag to indicate whether or not an image of the specimen is included.
... Image 0..1BackboneElementAn image of the patient's tumour, specimen, or radiology.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... File 0..1AttachmentThe file containing the image.
.... Label 0..*stringA label describing the image in the file.
.... bool 0..1booleanBreastResectionHistoSpecimen.Image.bool

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BreastResectionHistoSpecimen-cs.ClinicalMarginStatus.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
BreastResectionHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
BreastResectionHistoSpecimen-cs.ClinicalMarginStatus.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
.. BreastResectionHistoSpecimen-cs 0..*BaseSpecimen (breast resection histopathology)
Instances of this logical model are not marked to be the target of a Reference
... Specimen 1..1BackboneElementA sample to be used for analysis.
.... @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
.... Id 0..*IdentifierAn identifier for the specimen, e.g. a barcode.
.... TumourIdentifier 0..*stringThe number or identifier used to reference the given lesion/tumour.
.... Category 0..1CodeableConceptThe category of specimen, e.g. biopsy specimen
.... Type 0..1CodeableConceptThe type of specimen, e.g. core biopsy specimen, lymph node excision specimen.
.... Collection 0..1BackboneElementDetails about the collection of the 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
..... Procedure 0..*CodeableConceptThe procedure used to collect the specimen, e.g. Partial mastectomy, Wide local excision, Lumpectomy, Hookwire excision
..... CollectionDate 0..1dateTimeThe date and/or time that the sample/specimen was collected.
..... collectedBy 0..1BackboneElementThe healthcare practitioner who collected the 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
...... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
....... @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
....... RoleCode 1..1CodeableConceptThe designated the role of a health worker
.... ContainerQuantity 0..1QuantityA count of the number of containers (e.g. 3 tubes, 4 slides, 1 bottle) in which the specimen is placed after collection.
.... Comments 0..1stringFree text comments about the specimen.
... SpecimenContainer 0..*BackboneElementAn individual container (e.g. a specific tube) in which the specimen is placed.
.... @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
.... ContainerId 0..1IdentifierAn identifier for the individual specimen container.
.... SpecimenId 0..1IdentifierAn identifier for the specimen in the container.
.... Quantity 0..1QuantityThe quantity of specimen (volume, weight or count of pieces/fragments) placed in this individual container.
... SpecimenOrientationMarkers 0..1BackboneElementOrientation markers of a tissue sample (used for excision/resection specimens).
.... @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
.... SpecimenId 1..1IdentifierThe identifier of the specimen.
.... Technique 0..1CodeableConceptThe orientation marker technique used (e.g. surgical, radiological).
.... OrientationMarker 0..*BackboneElementDetails about an individual specimen orientation marker.
..... @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
..... Position 1..1CodeableConceptThe position of the orientation marker (e.g. superior, inferior)
..... Description 0..1stringA description of the marker at the given position.
.... @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)
.... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
.... ResidualCancerStatus 0..1CodeableConceptWhether or not the margin of a resected specimen is involved in the tumour.
.... 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.
... SpecimenImageIncluded 0..1booleanA flag to indicate whether or not an image of the specimen is included.
... Image 0..1BackboneElementAn image of the patient's tumour, specimen, or radiology.
.... @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
.... File 0..1AttachmentThe file containing the image.
.... Label 0..*stringA label describing the image in the file.
.... bool 0..1booleanBreastResectionHistoSpecimen.Image.bool

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BreastResectionHistoSpecimen-cs.ClinicalMarginStatus.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
BreastResectionHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
BreastResectionHistoSpecimen-cs.ClinicalMarginStatus.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 (9 nested mandatory elements)

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. BreastResectionHistoSpecimen-cs 0..*BaseSpecimen (breast resection histopathology)
Instances of this logical model are not marked to be the target of a Reference
... Specimen 1..1BackboneElementA sample to be used for analysis.
.... Id 0..*IdentifierAn identifier for the specimen, e.g. a barcode.
.... TumourIdentifier 0..*stringThe number or identifier used to reference the given lesion/tumour.
.... Category 0..1CodeableConceptThe category of specimen, e.g. biopsy specimen
.... Type 0..1CodeableConceptThe type of specimen, e.g. core biopsy specimen, lymph node excision specimen.
.... Collection 0..1BackboneElementDetails about the collection of the specimen.
..... Procedure 0..*CodeableConceptThe procedure used to collect the specimen, e.g. Partial mastectomy, Wide local excision, Lumpectomy, Hookwire excision
..... CollectionDate 0..1dateTimeThe date and/or time that the sample/specimen was collected.
..... collectedBy 0..1BackboneElementThe healthcare practitioner who collected the specimen.
...... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
....... RoleCode 1..1CodeableConceptThe designated the role of a health worker
.... ContainerQuantity 0..1QuantityA count of the number of containers (e.g. 3 tubes, 4 slides, 1 bottle) in which the specimen is placed after collection.
.... Comments 0..1stringFree text comments about the specimen.
... SpecimenContainer 0..*BackboneElementAn individual container (e.g. a specific tube) in which the specimen is placed.
.... ContainerId 0..1IdentifierAn identifier for the individual specimen container.
.... SpecimenId 0..1IdentifierAn identifier for the specimen in the container.
.... Quantity 0..1QuantityThe quantity of specimen (volume, weight or count of pieces/fragments) placed in this individual container.
... SpecimenOrientationMarkers 0..1BackboneElementOrientation markers of a tissue sample (used for excision/resection specimens).
.... SpecimenId 1..1IdentifierThe identifier of the specimen.
.... Technique 0..1CodeableConceptThe orientation marker technique used (e.g. surgical, radiological).
.... OrientationMarker 0..*BackboneElementDetails about an individual specimen orientation marker.
..... Position 1..1CodeableConceptThe position of the orientation marker (e.g. superior, inferior)
..... Description 0..1stringA description of the marker at the given position.
.... 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.
.... ResidualCancerStatus 0..1CodeableConceptWhether or not the margin of a resected specimen is involved in the tumour.
.... 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.
... SpecimenImageIncluded 0..1booleanA flag to indicate whether or not an image of the specimen is included.
... Image 0..1BackboneElementAn image of the patient's tumour, specimen, or radiology.
.... File 0..1AttachmentThe file containing the image.
.... Label 0..*stringA label describing the image in the file.
.... bool 0..1booleanBreastResectionHistoSpecimen.Image.bool

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
BreastResectionHistoSpecimen-cs.ClinicalMarginStatus.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
BreastResectionHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
BreastResectionHistoSpecimen-cs.ClinicalMarginStatus.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
.. BreastResectionHistoSpecimen-cs 0..*BaseSpecimen (breast resection histopathology)
Instances of this logical model are not marked to be the target of a Reference
... Specimen 1..1BackboneElementA sample to be used for analysis.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Id 0..*IdentifierAn identifier for the specimen, e.g. a barcode.
.... TumourIdentifier 0..*stringThe number or identifier used to reference the given lesion/tumour.
.... Category 0..1CodeableConceptThe category of specimen, e.g. biopsy specimen
.... Type 0..1CodeableConceptThe type of specimen, e.g. core biopsy specimen, lymph node excision specimen.
.... Collection 0..1BackboneElementDetails about the collection of the specimen.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Procedure 0..*CodeableConceptThe procedure used to collect the specimen, e.g. Partial mastectomy, Wide local excision, Lumpectomy, Hookwire excision
..... CollectionDate 0..1dateTimeThe date and/or time that the sample/specimen was collected.
..... collectedBy 0..1BackboneElementThe healthcare practitioner who collected the specimen.
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... RoleCode 1..1CodeableConceptThe designated the role of a health worker
.... ContainerQuantity 0..1QuantityA count of the number of containers (e.g. 3 tubes, 4 slides, 1 bottle) in which the specimen is placed after collection.
.... Comments 0..1stringFree text comments about the specimen.
... SpecimenContainer 0..*BackboneElementAn individual container (e.g. a specific tube) in which the specimen is placed.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ContainerId 0..1IdentifierAn identifier for the individual specimen container.
.... SpecimenId 0..1IdentifierAn identifier for the specimen in the container.
.... Quantity 0..1QuantityThe quantity of specimen (volume, weight or count of pieces/fragments) placed in this individual container.
... SpecimenOrientationMarkers 0..1BackboneElementOrientation markers of a tissue sample (used for excision/resection specimens).
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... SpecimenId 1..1IdentifierThe identifier of the specimen.
.... Technique 0..1CodeableConceptThe orientation marker technique used (e.g. surgical, radiological).
.... OrientationMarker 0..*BackboneElementDetails about an individual specimen orientation marker.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Position 1..1CodeableConceptThe position of the orientation marker (e.g. superior, inferior)
..... Description 0..1stringA description of the marker at the given position.
.... 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)
.... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
.... ResidualCancerStatus 0..1CodeableConceptWhether or not the margin of a resected specimen is involved in the tumour.
.... 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.
... SpecimenImageIncluded 0..1booleanA flag to indicate whether or not an image of the specimen is included.
... Image 0..1BackboneElementAn image of the patient's tumour, specimen, or radiology.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... File 0..1AttachmentThe file containing the image.
.... Label 0..*stringA label describing the image in the file.
.... bool 0..1booleanBreastResectionHistoSpecimen.Image.bool

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BreastResectionHistoSpecimen-cs.ClinicalMarginStatus.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
BreastResectionHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
BreastResectionHistoSpecimen-cs.ClinicalMarginStatus.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
.. BreastResectionHistoSpecimen-cs 0..*BaseSpecimen (breast resection histopathology)
Instances of this logical model are not marked to be the target of a Reference
... Specimen 1..1BackboneElementA sample to be used for analysis.
.... @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
.... Id 0..*IdentifierAn identifier for the specimen, e.g. a barcode.
.... TumourIdentifier 0..*stringThe number or identifier used to reference the given lesion/tumour.
.... Category 0..1CodeableConceptThe category of specimen, e.g. biopsy specimen
.... Type 0..1CodeableConceptThe type of specimen, e.g. core biopsy specimen, lymph node excision specimen.
.... Collection 0..1BackboneElementDetails about the collection of the 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
..... Procedure 0..*CodeableConceptThe procedure used to collect the specimen, e.g. Partial mastectomy, Wide local excision, Lumpectomy, Hookwire excision
..... CollectionDate 0..1dateTimeThe date and/or time that the sample/specimen was collected.
..... collectedBy 0..1BackboneElementThe healthcare practitioner who collected the 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
...... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
....... @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
....... RoleCode 1..1CodeableConceptThe designated the role of a health worker
.... ContainerQuantity 0..1QuantityA count of the number of containers (e.g. 3 tubes, 4 slides, 1 bottle) in which the specimen is placed after collection.
.... Comments 0..1stringFree text comments about the specimen.
... SpecimenContainer 0..*BackboneElementAn individual container (e.g. a specific tube) in which the specimen is placed.
.... @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
.... ContainerId 0..1IdentifierAn identifier for the individual specimen container.
.... SpecimenId 0..1IdentifierAn identifier for the specimen in the container.
.... Quantity 0..1QuantityThe quantity of specimen (volume, weight or count of pieces/fragments) placed in this individual container.
... SpecimenOrientationMarkers 0..1BackboneElementOrientation markers of a tissue sample (used for excision/resection specimens).
.... @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
.... SpecimenId 1..1IdentifierThe identifier of the specimen.
.... Technique 0..1CodeableConceptThe orientation marker technique used (e.g. surgical, radiological).
.... OrientationMarker 0..*BackboneElementDetails about an individual specimen orientation marker.
..... @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
..... Position 1..1CodeableConceptThe position of the orientation marker (e.g. superior, inferior)
..... Description 0..1stringA description of the marker at the given position.
.... @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)
.... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
.... ResidualCancerStatus 0..1CodeableConceptWhether or not the margin of a resected specimen is involved in the tumour.
.... 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.
... SpecimenImageIncluded 0..1booleanA flag to indicate whether or not an image of the specimen is included.
... Image 0..1BackboneElementAn image of the patient's tumour, specimen, or radiology.
.... @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
.... File 0..1AttachmentThe file containing the image.
.... Label 0..*stringA label describing the image in the file.
.... bool 0..1booleanBreastResectionHistoSpecimen.Image.bool

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BreastResectionHistoSpecimen-cs.ClinicalMarginStatus.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
BreastResectionHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
BreastResectionHistoSpecimen-cs.ClinicalMarginStatus.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 (9 nested mandatory elements)

 

Other representations of profile: CSV, Excel