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: Additional specimen (colorectal histopathology metastectomy request)

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

Additional specimens provided on a colorectal metastectomy histopthology request, e.g. lymph nodes

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
.. ColorectalHistoRequestMetastectomyAdditionalSpecimen-cs 0..*BaseAdditional specimen (colorectal histopathology metastectomy request)
Instances of this logical model are not marked to be the target of a Reference
... SpecimenLymphNode 0..*BackboneElementA lymph node specimen provided on a colorectal hisopathology request.
.... Id 0..*IdentifierAn identifier for the specimen, e.g. a barcode.
.... TumourIdentifier 0..*stringThe number or identifier used to reference the given lesion/tumour.
.... Type 0..1CodeableConceptThe type of specimen, e.g. core biopsy specimen, lymph node excision specimen.
.... Collection 0..1BackboneElementDetails about the collection of the specimen.
..... BodySite 0..1BackboneElementThe site from which the sample/specimen was collected.
...... BodyStructure 1..1CodeableConceptThe anatomical structure being described
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred)
.... Comments 0..1stringFree text comments about the specimen.
... SpecimenOther 0..*BackboneElementAn other type of specimen reported on a colorectal hisopathology request.
.... Id 0..*IdentifierAn identifier for the specimen, e.g. a barcode.
.... TumourIdentifier 0..*stringThe number or identifier used to reference the given lesion/tumour.
.... Type 0..1CodeableConceptThe type of specimen, e.g. core biopsy specimen, lymph node excision specimen.
.... Collection 0..1BackboneElementDetails about the collection of the specimen.
..... BodySite 0..1BackboneElementThe site from which the sample/specimen was collected.
...... BodyStructure 1..1CodeableConceptThe anatomical structure being described
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred)
.... Comments 0..1stringFree text comments about the specimen.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ColorectalHistoRequestMetastectomyAdditionalSpecimen-cs.SpecimenLymphNode.Collection.BodySite.BodyStructurepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
ColorectalHistoRequestMetastectomyAdditionalSpecimen-cs.SpecimenOther.Collection.BodySite.BodyStructurepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
NameFlagsCard.TypeDescription & Constraintsdoco
.. ColorectalHistoRequestMetastectomyAdditionalSpecimen-cs 0..*BaseAdditional specimen (colorectal histopathology metastectomy request)
Instances of this logical model are not marked to be the target of a Reference
... SpecimenLymphNode 0..*BackboneElementA lymph node specimen provided on a colorectal hisopathology request.
.... 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.
.... 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
..... BodySite 0..1BackboneElementThe site from which the sample/specimen was collected.
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... BodyStructure 1..1CodeableConceptThe anatomical structure being described
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred)
.... Comments 0..1stringFree text comments about the specimen.
... SpecimenOther 0..*BackboneElementAn other type of specimen reported on a colorectal hisopathology request.
.... 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.
.... 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
..... BodySite 0..1BackboneElementThe site from which the sample/specimen was collected.
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... BodyStructure 1..1CodeableConceptThe anatomical structure being described
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred)
.... Comments 0..1stringFree text comments about the specimen.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ColorectalHistoRequestMetastectomyAdditionalSpecimen-cs.SpecimenLymphNode.Collection.BodySite.BodyStructurepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
ColorectalHistoRequestMetastectomyAdditionalSpecimen-cs.SpecimenOther.Collection.BodySite.BodyStructurepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography

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
.. ColorectalHistoRequestMetastectomyAdditionalSpecimen-cs 0..*BaseAdditional specimen (colorectal histopathology metastectomy request)
Instances of this logical model are not marked to be the target of a Reference
... SpecimenLymphNode 0..*BackboneElementA lymph node specimen provided on a colorectal hisopathology request.
.... @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.
.... 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
..... BodySite 0..1BackboneElementThe site from which the sample/specimen was collected.
...... @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
...... BodyStructure 1..1CodeableConceptThe anatomical structure being described
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred)
.... Comments 0..1stringFree text comments about the specimen.
... SpecimenOther 0..*BackboneElementAn other type of specimen reported on a colorectal hisopathology request.
.... @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.
.... 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
..... BodySite 0..1BackboneElementThe site from which the sample/specimen was collected.
...... @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
...... BodyStructure 1..1CodeableConceptThe anatomical structure being described
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred)
.... Comments 0..1stringFree text comments about the specimen.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ColorectalHistoRequestMetastectomyAdditionalSpecimen-cs.SpecimenLymphNode.Collection.BodySite.BodyStructurepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
ColorectalHistoRequestMetastectomyAdditionalSpecimen-cs.SpecimenOther.Collection.BodySite.BodyStructurepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography

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

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. ColorectalHistoRequestMetastectomyAdditionalSpecimen-cs 0..*BaseAdditional specimen (colorectal histopathology metastectomy request)
Instances of this logical model are not marked to be the target of a Reference
... SpecimenLymphNode 0..*BackboneElementA lymph node specimen provided on a colorectal hisopathology request.
.... Id 0..*IdentifierAn identifier for the specimen, e.g. a barcode.
.... TumourIdentifier 0..*stringThe number or identifier used to reference the given lesion/tumour.
.... Type 0..1CodeableConceptThe type of specimen, e.g. core biopsy specimen, lymph node excision specimen.
.... Collection 0..1BackboneElementDetails about the collection of the specimen.
..... BodySite 0..1BackboneElementThe site from which the sample/specimen was collected.
...... BodyStructure 1..1CodeableConceptThe anatomical structure being described
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred)
.... Comments 0..1stringFree text comments about the specimen.
... SpecimenOther 0..*BackboneElementAn other type of specimen reported on a colorectal hisopathology request.
.... Id 0..*IdentifierAn identifier for the specimen, e.g. a barcode.
.... TumourIdentifier 0..*stringThe number or identifier used to reference the given lesion/tumour.
.... Type 0..1CodeableConceptThe type of specimen, e.g. core biopsy specimen, lymph node excision specimen.
.... Collection 0..1BackboneElementDetails about the collection of the specimen.
..... BodySite 0..1BackboneElementThe site from which the sample/specimen was collected.
...... BodyStructure 1..1CodeableConceptThe anatomical structure being described
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred)
.... Comments 0..1stringFree text comments about the specimen.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ColorectalHistoRequestMetastectomyAdditionalSpecimen-cs.SpecimenLymphNode.Collection.BodySite.BodyStructurepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
ColorectalHistoRequestMetastectomyAdditionalSpecimen-cs.SpecimenOther.Collection.BodySite.BodyStructurepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ColorectalHistoRequestMetastectomyAdditionalSpecimen-cs 0..*BaseAdditional specimen (colorectal histopathology metastectomy request)
Instances of this logical model are not marked to be the target of a Reference
... SpecimenLymphNode 0..*BackboneElementA lymph node specimen provided on a colorectal hisopathology request.
.... 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.
.... 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
..... BodySite 0..1BackboneElementThe site from which the sample/specimen was collected.
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... BodyStructure 1..1CodeableConceptThe anatomical structure being described
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred)
.... Comments 0..1stringFree text comments about the specimen.
... SpecimenOther 0..*BackboneElementAn other type of specimen reported on a colorectal hisopathology request.
.... 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.
.... 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
..... BodySite 0..1BackboneElementThe site from which the sample/specimen was collected.
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... BodyStructure 1..1CodeableConceptThe anatomical structure being described
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred)
.... Comments 0..1stringFree text comments about the specimen.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ColorectalHistoRequestMetastectomyAdditionalSpecimen-cs.SpecimenLymphNode.Collection.BodySite.BodyStructurepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
ColorectalHistoRequestMetastectomyAdditionalSpecimen-cs.SpecimenOther.Collection.BodySite.BodyStructurepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography

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
.. ColorectalHistoRequestMetastectomyAdditionalSpecimen-cs 0..*BaseAdditional specimen (colorectal histopathology metastectomy request)
Instances of this logical model are not marked to be the target of a Reference
... SpecimenLymphNode 0..*BackboneElementA lymph node specimen provided on a colorectal hisopathology request.
.... @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.
.... 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
..... BodySite 0..1BackboneElementThe site from which the sample/specimen was collected.
...... @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
...... BodyStructure 1..1CodeableConceptThe anatomical structure being described
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred)
.... Comments 0..1stringFree text comments about the specimen.
... SpecimenOther 0..*BackboneElementAn other type of specimen reported on a colorectal hisopathology request.
.... @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.
.... 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
..... BodySite 0..1BackboneElementThe site from which the sample/specimen was collected.
...... @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
...... BodyStructure 1..1CodeableConceptThe anatomical structure being described
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred)
.... Comments 0..1stringFree text comments about the specimen.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ColorectalHistoRequestMetastectomyAdditionalSpecimen-cs.SpecimenLymphNode.Collection.BodySite.BodyStructurepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
ColorectalHistoRequestMetastectomyAdditionalSpecimen-cs.SpecimenOther.Collection.BodySite.BodyStructurepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography

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

 

Other representations of profile: CSV, Excel