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 (colorectal histopathology request)

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

Relevant details about the specimen in a colorectal histopathology request.

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
.. ColorectalHistoRequestSpecimen-cs 0..*BaseSpecimen (colorectal histopathology request)
Instances of this logical model are not marked to be the target of a Reference
... Specimen 1..1BackboneElementRelevant details about the specimen itself.
.... Id 0..*IdentifierAn identifier for the specimen in a given pot, e.g. a barcode.
.... Type 0..1CodeableConceptThe type of specimen, e.g. core biopsy specimen, lymph node excision specimen.
.... Qualifier 0..1CodeableConceptA qualifying characteristic of the specimen, e.g. sessile, pedunculated,
.... 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)
...... DistanceFromLandmark 0..1QuantityThe distance from the given landmark.
...... Comments 0..1CodeableConceptFree text comments describing the body site.
..... Technique 0..1CodeableConceptThe technique used to collect the specimen, e.g. Random specimen collection.
.... 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.
... SpecimenDimensions 0..1BackboneElementMaximal dimension of specimen collected.
.... SpecimenId 1..1IdentifierAn identifier of the specimen being observed.
.... MaximumSpecimenDimension 0..1QuantityA measurement of the largest dimension of the polyp

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ColorectalHistoRequestSpecimen-cs.Specimen.Collection.BodySite.BodyStructurepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
NameFlagsCard.TypeDescription & Constraintsdoco
.. ColorectalHistoRequestSpecimen-cs 0..*BaseSpecimen (colorectal histopathology request)
Instances of this logical model are not marked to be the target of a Reference
... Specimen 1..1BackboneElementRelevant details about the specimen itself.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Id 0..*IdentifierAn identifier for the specimen in a given pot, e.g. a barcode.
.... Type 0..1CodeableConceptThe type of specimen, e.g. core biopsy specimen, lymph node excision specimen.
.... Qualifier 0..1CodeableConceptA qualifying characteristic of the specimen, e.g. sessile, pedunculated,
.... 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)
...... DistanceFromLandmark 0..1QuantityThe distance from the given landmark.
...... Comments 0..1CodeableConceptFree text comments describing the body site.
..... Technique 0..1CodeableConceptThe technique used to collect the specimen, e.g. Random specimen collection.
.... 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.
... SpecimenDimensions 0..1BackboneElementMaximal dimension of specimen collected.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... SpecimenId 1..1IdentifierAn identifier of the specimen being observed.
.... MaximumSpecimenDimension 0..1QuantityA measurement of the largest dimension of the polyp

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ColorectalHistoRequestSpecimen-cs.Specimen.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
.. ColorectalHistoRequestSpecimen-cs 0..*BaseSpecimen (colorectal histopathology request)
Instances of this logical model are not marked to be the target of a Reference
... Specimen 1..1BackboneElementRelevant details about the specimen itself.
.... @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 in a given pot, e.g. a barcode.
.... Type 0..1CodeableConceptThe type of specimen, e.g. core biopsy specimen, lymph node excision specimen.
.... Qualifier 0..1CodeableConceptA qualifying characteristic of the specimen, e.g. sessile, pedunculated,
.... 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)
...... DistanceFromLandmark 0..1QuantityThe distance from the given landmark.
...... Comments 0..1CodeableConceptFree text comments describing the body site.
..... Technique 0..1CodeableConceptThe technique used to collect the specimen, e.g. Random specimen collection.
.... 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.
... SpecimenDimensions 0..1BackboneElementMaximal dimension of specimen 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
.... SpecimenId 1..1IdentifierAn identifier of the specimen being observed.
.... MaximumSpecimenDimension 0..1QuantityA measurement of the largest dimension of the polyp

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ColorectalHistoRequestSpecimen-cs.Specimen.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 (3 nested mandatory elements)

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. ColorectalHistoRequestSpecimen-cs 0..*BaseSpecimen (colorectal histopathology request)
Instances of this logical model are not marked to be the target of a Reference
... Specimen 1..1BackboneElementRelevant details about the specimen itself.
.... Id 0..*IdentifierAn identifier for the specimen in a given pot, e.g. a barcode.
.... Type 0..1CodeableConceptThe type of specimen, e.g. core biopsy specimen, lymph node excision specimen.
.... Qualifier 0..1CodeableConceptA qualifying characteristic of the specimen, e.g. sessile, pedunculated,
.... 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)
...... DistanceFromLandmark 0..1QuantityThe distance from the given landmark.
...... Comments 0..1CodeableConceptFree text comments describing the body site.
..... Technique 0..1CodeableConceptThe technique used to collect the specimen, e.g. Random specimen collection.
.... 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.
... SpecimenDimensions 0..1BackboneElementMaximal dimension of specimen collected.
.... SpecimenId 1..1IdentifierAn identifier of the specimen being observed.
.... MaximumSpecimenDimension 0..1QuantityA measurement of the largest dimension of the polyp

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ColorectalHistoRequestSpecimen-cs.Specimen.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
.. ColorectalHistoRequestSpecimen-cs 0..*BaseSpecimen (colorectal histopathology request)
Instances of this logical model are not marked to be the target of a Reference
... Specimen 1..1BackboneElementRelevant details about the specimen itself.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Id 0..*IdentifierAn identifier for the specimen in a given pot, e.g. a barcode.
.... Type 0..1CodeableConceptThe type of specimen, e.g. core biopsy specimen, lymph node excision specimen.
.... Qualifier 0..1CodeableConceptA qualifying characteristic of the specimen, e.g. sessile, pedunculated,
.... 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)
...... DistanceFromLandmark 0..1QuantityThe distance from the given landmark.
...... Comments 0..1CodeableConceptFree text comments describing the body site.
..... Technique 0..1CodeableConceptThe technique used to collect the specimen, e.g. Random specimen collection.
.... 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.
... SpecimenDimensions 0..1BackboneElementMaximal dimension of specimen collected.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... SpecimenId 1..1IdentifierAn identifier of the specimen being observed.
.... MaximumSpecimenDimension 0..1QuantityA measurement of the largest dimension of the polyp

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ColorectalHistoRequestSpecimen-cs.Specimen.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
.. ColorectalHistoRequestSpecimen-cs 0..*BaseSpecimen (colorectal histopathology request)
Instances of this logical model are not marked to be the target of a Reference
... Specimen 1..1BackboneElementRelevant details about the specimen itself.
.... @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 in a given pot, e.g. a barcode.
.... Type 0..1CodeableConceptThe type of specimen, e.g. core biopsy specimen, lymph node excision specimen.
.... Qualifier 0..1CodeableConceptA qualifying characteristic of the specimen, e.g. sessile, pedunculated,
.... 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)
...... DistanceFromLandmark 0..1QuantityThe distance from the given landmark.
...... Comments 0..1CodeableConceptFree text comments describing the body site.
..... Technique 0..1CodeableConceptThe technique used to collect the specimen, e.g. Random specimen collection.
.... 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.
... SpecimenDimensions 0..1BackboneElementMaximal dimension of specimen 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
.... SpecimenId 1..1IdentifierAn identifier of the specimen being observed.
.... MaximumSpecimenDimension 0..1QuantityA measurement of the largest dimension of the polyp

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ColorectalHistoRequestSpecimen-cs.Specimen.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 (3 nested mandatory elements)

 

Other representations of profile: CSV, Excel