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: SpecimenLymphNode_cs - Detailed Descriptions

Draft as of 2024-03-04

Definitions for the SpecimenLymphNode-cs logical model.

Guidance on how to interpret the contents of this table can be found here

0. SpecimenLymphNode-cs
Definition

A lymph node sample to be used for analysis.

ShortLymph node specimen
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. SpecimenLymphNode-cs.Id
Definition

An identifier for the specimen, e.g. a barcode.

ShortAn identifier for the specimen, e.g. a barcode.
Control0..*
TypeIdentifier
4. SpecimenLymphNode-cs.Category
Definition

The category of specimen, i.e. lymph node specimen

ShortThe category of specimen, i.e. lymph node specimen
Control0..1
TypeCodeableConcept
6. SpecimenLymphNode-cs.Type
Definition

The type of specimen, e.g. lymph node biopsy specimen, lymph node excision specimen.

ShortThe type of specimen, e.g. lymph node biopsy specimen, lymph node excision specimen.
Control0..1
TypeCodeableConcept
8. SpecimenLymphNode-cs.Qualifier
Definition

A qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified.

ShortA qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified.
Control0..1
TypeCodeableConcept
10. SpecimenLymphNode-cs.Collection
Definition

Details about the collection of the specimen.

ShortDetails about the collection of the specimen.
Control0..1
TypeBackboneElement
12. SpecimenLymphNode-cs.Collection.Procedure
Definition

The procedure used to collect the specimen, e.g. Partial mastectomy, Wide local excision, Lumpectomy, Hookwire excision

ShortThe procedure used to collect the specimen, e.g. Partial mastectomy, Wide local excision, Lumpectomy, Hookwire excision
Control0..*
TypeCodeableConcept
14. SpecimenLymphNode-cs.Collection.CollectionDate
Definition

The date and/or time that the sample/specimen was collected.

ShortThe date and/or time that the sample/specimen was collected.
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. SpecimenLymphNode-cs.Collection.BodySite
Definition

The site from which the sample/specimen was collected.

ShortThe site from which the sample/specimen was collected.
Control0..1
TypeBackboneElement
18. SpecimenLymphNode-cs.Collection.BodySite.BodyStructure
Definition

The anatomical structure being described

ShortThe anatomical structure being described
Control1..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
TypeCodeableConcept
20. SpecimenLymphNode-cs.Collection.BodySite.Comments
Definition

Free text comments describing the body site.

ShortFree text comments describing the body site.
Control0..1
TypeCodeableConcept
22. SpecimenLymphNode-cs.Collection.Technique
Definition

The technique used to collect the specimen, e.g. Random specimen collection.

ShortThe technique used to collect the specimen, e.g. Random specimen collection.
Control0..*
TypeCodeableConcept
24. SpecimenLymphNode-cs.ContainerQuantity
Definition

A count of the number of containers (e.g. 3 tubes, 4 slides, 1 bottle) in which the specimen is placed after collection.

ShortA count of the number of containers (e.g. 3 tubes, 4 slides, 1 bottle) in which the specimen is placed after collection.
Control0..1
TypeQuantity
26. SpecimenLymphNode-cs.Comments
Definition

Free text comments about the specimen.

ShortFree text comments about the specimen.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. SpecimenLymphNode-cs.LymphNodeQuantity
Definition

The number of lymph nodes of this type.

ShortThe number of lymph nodes of this type.
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. SpecimenLymphNode-cs.LymphNodeAbnormalQuantity
Definition

The number of lymph nodes that are macroscopically assessed as abnormal.

ShortThe number of lymph nodes that are macroscopically assessed as abnormal.
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. SpecimenLymphNode-cs
Definition

A lymph node sample to be used for analysis.

ShortLymph node specimen
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. SpecimenLymphNode-cs.Id
Definition

An identifier for the specimen, e.g. a barcode.

ShortAn identifier for the specimen, e.g. a barcode.
Control0..*
TypeIdentifier
4. SpecimenLymphNode-cs.Category
Definition

The category of specimen, i.e. lymph node specimen

ShortThe category of specimen, i.e. lymph node specimen
Control0..1
TypeCodeableConcept
6. SpecimenLymphNode-cs.Type
Definition

The type of specimen, e.g. lymph node biopsy specimen, lymph node excision specimen.

ShortThe type of specimen, e.g. lymph node biopsy specimen, lymph node excision specimen.
Control0..1
TypeCodeableConcept
8. SpecimenLymphNode-cs.Qualifier
Definition

A qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified.

ShortA qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified.
Control0..1
TypeCodeableConcept
10. SpecimenLymphNode-cs.Collection
Definition

Details about the collection of the specimen.

ShortDetails about the collection of the specimen.
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. SpecimenLymphNode-cs.Collection.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. SpecimenLymphNode-cs.Collection.Procedure
Definition

The procedure used to collect the specimen, e.g. Partial mastectomy, Wide local excision, Lumpectomy, Hookwire excision

ShortThe procedure used to collect the specimen, e.g. Partial mastectomy, Wide local excision, Lumpectomy, Hookwire excision
Control0..*
TypeCodeableConcept
16. SpecimenLymphNode-cs.Collection.CollectionDate
Definition

The date and/or time that the sample/specimen was collected.

ShortThe date and/or time that the sample/specimen was collected.
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. SpecimenLymphNode-cs.Collection.BodySite
Definition

The site from which the sample/specimen was collected.

ShortThe site from which the sample/specimen was collected.
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. SpecimenLymphNode-cs.Collection.BodySite.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
22. SpecimenLymphNode-cs.Collection.BodySite.BodyStructure
Definition

The anatomical structure being described

ShortThe anatomical structure being described
Control1..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
TypeCodeableConcept
24. SpecimenLymphNode-cs.Collection.BodySite.Comments
Definition

Free text comments describing the body site.

ShortFree text comments describing the body site.
Control0..1
TypeCodeableConcept
26. SpecimenLymphNode-cs.Collection.Technique
Definition

The technique used to collect the specimen, e.g. Random specimen collection.

ShortThe technique used to collect the specimen, e.g. Random specimen collection.
Control0..*
TypeCodeableConcept
28. SpecimenLymphNode-cs.ContainerQuantity
Definition

A count of the number of containers (e.g. 3 tubes, 4 slides, 1 bottle) in which the specimen is placed after collection.

ShortA count of the number of containers (e.g. 3 tubes, 4 slides, 1 bottle) in which the specimen is placed after collection.
Control0..1
TypeQuantity
30. SpecimenLymphNode-cs.Comments
Definition

Free text comments about the specimen.

ShortFree text comments about the specimen.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. SpecimenLymphNode-cs.LymphNodeQuantity
Definition

The number of lymph nodes of this type.

ShortThe number of lymph nodes of this type.
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. SpecimenLymphNode-cs.LymphNodeAbnormalQuantity
Definition

The number of lymph nodes that are macroscopically assessed as abnormal.

ShortThe number of lymph nodes that are macroscopically assessed as abnormal.
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. SpecimenLymphNode-cs
Definition

A lymph node sample to be used for analysis.

ShortLymph node specimen
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. SpecimenLymphNode-cs.Id
Definition

An identifier for the specimen, e.g. a barcode.

ShortAn identifier for the specimen, e.g. a barcode.
Control0..*
TypeIdentifier
4. SpecimenLymphNode-cs.Category
Definition

The category of specimen, i.e. lymph node specimen

ShortThe category of specimen, i.e. lymph node specimen
Control0..1
TypeCodeableConcept
6. SpecimenLymphNode-cs.Type
Definition

The type of specimen, e.g. lymph node biopsy specimen, lymph node excision specimen.

ShortThe type of specimen, e.g. lymph node biopsy specimen, lymph node excision specimen.
Control0..1
TypeCodeableConcept
8. SpecimenLymphNode-cs.Qualifier
Definition

A qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified.

ShortA qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified.
Control0..1
TypeCodeableConcept
10. SpecimenLymphNode-cs.Collection
Definition

Details about the collection of the specimen.

ShortDetails about the collection of the specimen.
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. SpecimenLymphNode-cs.Collection.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
14. SpecimenLymphNode-cs.Collection.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on SpecimenLymphNode-cs.Collection.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
16. SpecimenLymphNode-cs.Collection.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. SpecimenLymphNode-cs.Collection.Procedure
Definition

The procedure used to collect the specimen, e.g. Partial mastectomy, Wide local excision, Lumpectomy, Hookwire excision

ShortThe procedure used to collect the specimen, e.g. Partial mastectomy, Wide local excision, Lumpectomy, Hookwire excision
Control0..*
TypeCodeableConcept
20. SpecimenLymphNode-cs.Collection.CollectionDate
Definition

The date and/or time that the sample/specimen was collected.

ShortThe date and/or time that the sample/specimen was collected.
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. SpecimenLymphNode-cs.Collection.BodySite
Definition

The site from which the sample/specimen was collected.

ShortThe site from which the sample/specimen was collected.
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. SpecimenLymphNode-cs.Collection.BodySite.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
26. SpecimenLymphNode-cs.Collection.BodySite.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on SpecimenLymphNode-cs.Collection.BodySite.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
28. SpecimenLymphNode-cs.Collection.BodySite.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
30. SpecimenLymphNode-cs.Collection.BodySite.BodyStructure
Definition

The anatomical structure being described

ShortThe anatomical structure being described
Control1..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
TypeCodeableConcept
32. SpecimenLymphNode-cs.Collection.BodySite.Comments
Definition

Free text comments describing the body site.

ShortFree text comments describing the body site.
Control0..1
TypeCodeableConcept
34. SpecimenLymphNode-cs.Collection.Technique
Definition

The technique used to collect the specimen, e.g. Random specimen collection.

ShortThe technique used to collect the specimen, e.g. Random specimen collection.
Control0..*
TypeCodeableConcept
36. SpecimenLymphNode-cs.ContainerQuantity
Definition

A count of the number of containers (e.g. 3 tubes, 4 slides, 1 bottle) in which the specimen is placed after collection.

ShortA count of the number of containers (e.g. 3 tubes, 4 slides, 1 bottle) in which the specimen is placed after collection.
Control0..1
TypeQuantity
38. SpecimenLymphNode-cs.Comments
Definition

Free text comments about the specimen.

ShortFree text comments about the specimen.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
40. SpecimenLymphNode-cs.LymphNodeQuantity
Definition

The number of lymph nodes of this type.

ShortThe number of lymph nodes of this type.
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
42. SpecimenLymphNode-cs.LymphNodeAbnormalQuantity
Definition

The number of lymph nodes that are macroscopically assessed as abnormal.

ShortThe number of lymph nodes that are macroscopically assessed as abnormal.
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension