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: Lymph nodes (breast histopathology)

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

Information about any lymph node specimens taken in addition to the main breast specimen.

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
.. BreastHistoLymphNodes-cs 0..*BaseLymph nodes (breast histopathology)
Instances of this logical model are not marked to be the target of a Reference
... LymphNodeStatus 1..1booleanA status indicating whether or not a lymph node specimen has been collected.
... SpecimenLymphNode 0..*BackboneElementA lymph node sample to be used for analysis.
.... Id 0..*IdentifierAn identifier for the specimen, e.g. a barcode.
.... Category 0..1CodeableConceptThe category of specimen, i.e. lymph node specimen
.... Type 0..1CodeableConceptThe type of specimen, e.g. lymph node 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
..... 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.
.... LymphNodeQuantity 0..1integerThe number of lymph nodes of this type.
.... LymphNodeAbnormalQuantity 0..1integerThe number of lymph nodes that are macroscopically assessed as abnormal.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
BreastHistoLymphNodes-cs.SpecimenLymphNode.Collection.BodySite.BodyStructurepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
NameFlagsCard.TypeDescription & Constraintsdoco
.. BreastHistoLymphNodes-cs 0..*BaseLymph nodes (breast histopathology)
Instances of this logical model are not marked to be the target of a Reference
... LymphNodeStatus 1..1booleanA status indicating whether or not a lymph node specimen has been collected.
... SpecimenLymphNode 0..*BackboneElementA lymph node 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.
.... Category 0..1CodeableConceptThe category of specimen, i.e. lymph node specimen
.... Type 0..1CodeableConceptThe type of specimen, e.g. lymph node 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
..... 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.
.... LymphNodeQuantity 0..1integerThe number of lymph nodes of this type.
.... LymphNodeAbnormalQuantity 0..1integerThe number of lymph nodes that are macroscopically assessed as abnormal.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BreastHistoLymphNodes-cs.SpecimenLymphNode.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
.. BreastHistoLymphNodes-cs 0..*BaseLymph nodes (breast histopathology)
Instances of this logical model are not marked to be the target of a Reference
... LymphNodeStatus 1..1booleanA status indicating whether or not a lymph node specimen has been collected.
... SpecimenLymphNode 0..*BackboneElementA lymph node 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.
.... Category 0..1CodeableConceptThe category of specimen, i.e. lymph node specimen
.... Type 0..1CodeableConceptThe type of specimen, e.g. lymph node 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
..... 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.
.... LymphNodeQuantity 0..1integerThe number of lymph nodes of this type.
.... LymphNodeAbnormalQuantity 0..1integerThe number of lymph nodes that are macroscopically assessed as abnormal.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BreastHistoLymphNodes-cs.SpecimenLymphNode.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
.. BreastHistoLymphNodes-cs 0..*BaseLymph nodes (breast histopathology)
Instances of this logical model are not marked to be the target of a Reference
... LymphNodeStatus 1..1booleanA status indicating whether or not a lymph node specimen has been collected.
... SpecimenLymphNode 0..*BackboneElementA lymph node sample to be used for analysis.
.... Id 0..*IdentifierAn identifier for the specimen, e.g. a barcode.
.... Category 0..1CodeableConceptThe category of specimen, i.e. lymph node specimen
.... Type 0..1CodeableConceptThe type of specimen, e.g. lymph node 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
..... 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.
.... LymphNodeQuantity 0..1integerThe number of lymph nodes of this type.
.... LymphNodeAbnormalQuantity 0..1integerThe number of lymph nodes that are macroscopically assessed as abnormal.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
BreastHistoLymphNodes-cs.SpecimenLymphNode.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
.. BreastHistoLymphNodes-cs 0..*BaseLymph nodes (breast histopathology)
Instances of this logical model are not marked to be the target of a Reference
... LymphNodeStatus 1..1booleanA status indicating whether or not a lymph node specimen has been collected.
... SpecimenLymphNode 0..*BackboneElementA lymph node 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.
.... Category 0..1CodeableConceptThe category of specimen, i.e. lymph node specimen
.... Type 0..1CodeableConceptThe type of specimen, e.g. lymph node 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
..... 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.
.... LymphNodeQuantity 0..1integerThe number of lymph nodes of this type.
.... LymphNodeAbnormalQuantity 0..1integerThe number of lymph nodes that are macroscopically assessed as abnormal.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BreastHistoLymphNodes-cs.SpecimenLymphNode.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
.. BreastHistoLymphNodes-cs 0..*BaseLymph nodes (breast histopathology)
Instances of this logical model are not marked to be the target of a Reference
... LymphNodeStatus 1..1booleanA status indicating whether or not a lymph node specimen has been collected.
... SpecimenLymphNode 0..*BackboneElementA lymph node 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.
.... Category 0..1CodeableConceptThe category of specimen, i.e. lymph node specimen
.... Type 0..1CodeableConceptThe type of specimen, e.g. lymph node 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
..... 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.
.... LymphNodeQuantity 0..1integerThe number of lymph nodes of this type.
.... LymphNodeAbnormalQuantity 0..1integerThe number of lymph nodes that are macroscopically assessed as abnormal.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BreastHistoLymphNodes-cs.SpecimenLymphNode.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