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

Draft as of 2024-03-04

Definitions for the BreastHistoSpecimen-cs logical model.

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

0. BreastHistoSpecimen-cs
Definition

Relevant details about the specimen in a breast histopathology composition.

ShortSpecimen (breast histopathology)
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. BreastHistoSpecimen-cs.Specimen
Definition

A sample to be used for analysis.

ShortA sample to be used for analysis.
Control1..1
TypeBackboneElement
4. BreastHistoSpecimen-cs.Specimen.Id
Definition

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

ShortAn identifier for the specimen, e.g. a barcode.
Control0..*
TypeIdentifier
6. BreastHistoSpecimen-cs.Specimen.TumourIdentifier
Definition

The number or identifier used to reference the given lesion/tumour.

ShortThe number or identifier used to reference the given lesion/tumour.
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. BreastHistoSpecimen-cs.Specimen.Category
Definition

The category of specimen, e.g. biopsy specimen

ShortThe category of specimen, e.g. biopsy specimen
Control0..1
TypeCodeableConcept
10. BreastHistoSpecimen-cs.Specimen.Type
Definition

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

ShortThe type of specimen, e.g. core biopsy specimen, lymph node excision specimen.
Control0..1
TypeCodeableConcept
12. BreastHistoSpecimen-cs.Specimen.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
14. BreastHistoSpecimen-cs.Specimen.Collection
Definition

Details about the collection of the specimen.

ShortDetails about the collection of the specimen.
Control0..1
TypeBackboneElement
16. BreastHistoSpecimen-cs.Specimen.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
18. BreastHistoSpecimen-cs.Specimen.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
20. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy
Definition

The healthcare practitioner who collected the specimen.

ShortThe healthcare practitioner who collected the specimen.
Control0..1
TypeBackboneElement
22. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.PersonName
Definition

Person name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.

ShortPerson name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.
Control0..1
TypeBackboneElement
24. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.PersonName.Title
Definition

The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person

ShortThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
Control0..1
TypeCodeableConcept
26. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.PersonName.GivenName
Definition

The person’s forename or given name at birth

ShortThe person’s forename or given name at birth
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.PersonName.FamilyName
Definition

The family name (surname) of a person as distinct from their given, second and subsequent name(s)

ShortThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.PersonName.NameProtectionFlag
Definition

This indicator denotes that the person’s name information is to be held ‘in confidence’

ShortThis indicator denotes that the person’s name information is to be held ‘in confidence’
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.PersonName.age
Definition

BreastHistoSpecimen.Specimen.Collection.collectedBy.PersonName.age

ShortBreastHistoSpecimen.Specimen.Collection.collectedBy.PersonName.age
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.ProfessionalRegistration
Definition

the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced

Shortthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
Control0..*
TypeBackboneElement
36. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.ProfessionalRegistration.AssigningOrganisationIdentifier
Definition

The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number

ShortThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
Control0..1
TypeCodeableConcept
38. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.HealthWorkerRole
Definition

The employment of a health worker in a specific role

ShortThe employment of a health worker in a specific role
Control0..1
TypeBackboneElement
40. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.HealthWorkerRole.PRI
Definition

A unique ten-character identifier assigned by the HPI system to an individual role

ShortA unique ten-character identifier assigned by the HPI system to an individual role
Control1..1
TypeIdentifier
42. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.HealthWorkerRole.RoleCode
Definition

The designated the role of a health worker

ShortThe designated the role of a health worker
Control1..1
TypeCodeableConcept
44. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.HealthWorkerRole.RoleConfidential
Definition

Whether or not the role of health care practitioner is confidential

ShortWhether or not the role of health care practitioner is confidential
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
46. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.HealthWorkerRole.FacilityId
Definition

The identifier of the healthcare facility at which the practitioner works in this role.

ShortThe identifier of the healthcare facility at which the practitioner works in this role.
Control0..1
TypeIdentifier
48. BreastHistoSpecimen-cs.Specimen.Collection.BodySite
Definition

The site from which the sample/specimen was collected.

ShortThe site from which the sample/specimen was collected.
Control0..1
TypeBackboneElement
50. BreastHistoSpecimen-cs.Specimen.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
52. BreastHistoSpecimen-cs.Specimen.Collection.BodySite.BodyStructurePart
Definition

The anatomical part of the body structure being described.

ShortThe anatomical part of the body structure being described.
Control0..*
TypeCodeableConcept
54. BreastHistoSpecimen-cs.Specimen.Collection.BodySite.Clockface
Definition

The clockface orientation from the landmark.

ShortThe clockface orientation from the landmark.
Control0..1
TypeCodeableConcept
56. BreastHistoSpecimen-cs.Specimen.Collection.BodySite.DistanceFromLandmark
Definition

The distance from the given landmark.

ShortThe distance from the given landmark.
Control0..1
TypeQuantity
58. BreastHistoSpecimen-cs.Specimen.Collection.BodySite.Comments
Definition

Free text comments describing the body site.

ShortFree text comments describing the body site.
Control0..1
TypeCodeableConcept
60. BreastHistoSpecimen-cs.Specimen.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
62. BreastHistoSpecimen-cs.Specimen.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
64. BreastHistoSpecimen-cs.Specimen.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
66. BreastHistoSpecimen-cs.SpecimenContainer
Definition

An individual container (e.g. a specific tube) in which the specimen is placed.

ShortAn individual container (e.g. a specific tube) in which the specimen is placed.
Control0..*
TypeBackboneElement
68. BreastHistoSpecimen-cs.SpecimenContainer.ContainerId
Definition

An identifier for the individual specimen container.

ShortAn identifier for the individual specimen container.
Control0..1
TypeIdentifier
70. BreastHistoSpecimen-cs.SpecimenContainer.SpecimenId
Definition

An identifier for the specimen in the container.

ShortAn identifier for the specimen in the container.
Control0..1
TypeIdentifier
72. BreastHistoSpecimen-cs.SpecimenContainer.Type
Definition

The type of container used (e.g. slide, tube, bottle).

ShortThe type of container used (e.g. slide, tube, bottle).
Control0..1
TypeCodeableConcept
74. BreastHistoSpecimen-cs.SpecimenContainer.SpecimenQualifier
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
76. BreastHistoSpecimen-cs.SpecimenContainer.PreparationTechnique
Definition

BreastHistoSpecimen.SpecimenContainer.PreparationTechnique

ShortBreastHistoSpecimen.SpecimenContainer.PreparationTechnique
Control0..*
TypeCodeableConcept
78. BreastHistoSpecimen-cs.SpecimenContainer.MediumStatus
Definition

Whether or not the specimen is fresh or in a medium.

ShortWhether or not the specimen is fresh or in a medium.
Control0..1
TypeCodeableConcept
80. BreastHistoSpecimen-cs.SpecimenContainer.MediumType
Definition

The type of medium used for the specimen in the container.

ShortThe type of medium used for the specimen in the container.
Control0..1
TypeCodeableConcept
82. BreastHistoSpecimen-cs.SpecimenContainer.Quantity
Definition

The quantity of specimen (volume, weight or count of pieces/fragments) placed in this individual container.

ShortThe quantity of specimen (volume, weight or count of pieces/fragments) placed in this individual container.
Control0..1
TypeQuantity
84. BreastHistoSpecimen-cs.SpecimenOrientationMarkers
Definition

Orientation markers of a tissue sample (used for excision/resection specimens).

ShortOrientation markers of a tissue sample (used for excision/resection specimens).
Control0..1
TypeBackboneElement
86. BreastHistoSpecimen-cs.SpecimenOrientationMarkers.SpecimenId
Definition

The identifier of the specimen.

ShortThe identifier of the specimen.
Control1..1
TypeIdentifier
88. BreastHistoSpecimen-cs.SpecimenOrientationMarkers.Technique
Definition

The orientation marker technique used (e.g. surgical, radiological).

ShortThe orientation marker technique used (e.g. surgical, radiological).
Control0..1
TypeCodeableConcept
90. BreastHistoSpecimen-cs.SpecimenOrientationMarkers.Type
Definition

The type of orientation marker used (e.g. suture, clip).

ShortThe type of orientation marker used (e.g. suture, clip).
Control0..1
TypeCodeableConcept
92. BreastHistoSpecimen-cs.SpecimenOrientationMarkers.OrientationMarker
Definition

Details about an individual specimen orientation marker.

ShortDetails about an individual specimen orientation marker.
Control0..*
TypeBackboneElement
94. BreastHistoSpecimen-cs.SpecimenOrientationMarkers.OrientationMarker.Position
Definition

The position of the orientation marker (e.g. superior, inferior)

ShortThe position of the orientation marker (e.g. superior, inferior)
Control1..1
TypeCodeableConcept
96. BreastHistoSpecimen-cs.SpecimenOrientationMarkers.OrientationMarker.Description
Definition

A description of the marker at the given position.

ShortA description of the marker at the given position.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
98. BreastHistoSpecimen-cs.ClinicalMarginStatus
Definition

The status of the tissue on the margin of a resected specimen as specified by the clinician (eg surgeon).

ShortThe status of the tissue on the margin of a resected specimen as specified by the clinician (eg surgeon).
Control0..1
TypeBackboneElement
100. BreastHistoSpecimen-cs.ClinicalMarginStatus.Status
Definition

The status of the observation

ShortThe status of the observation
Control1..1
TypeCodeableConcept
102. BreastHistoSpecimen-cs.ClinicalMarginStatus.Code
Definition

The type of observation made.

ShortThe type of observation made.
Control1..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
TypeCodeableConcept
104. BreastHistoSpecimen-cs.ClinicalMarginStatus.TumourIdentifier
Definition

An identifier for the tumour about which the observation is made.

ShortAn identifier for the tumour about which the observation is made.
Control0..1
TypeIdentifier
106. BreastHistoSpecimen-cs.ClinicalMarginStatus.ResidualCancerStatus
Definition

Whether or not the margin of a resected specimen is involved in the tumour.

ShortWhether or not the margin of a resected specimen is involved in the tumour.
Control0..1
TypeCodeableConcept
108. BreastHistoSpecimen-cs.ClinicalMarginStatus.InvolvedMargins
Definition

A free text description of the margins involved with respect to the tumour.

ShortA free text description of the margins involved with respect to the tumour.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
110. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail
Definition

Any relevant details about margins on a resected specimen.

ShortAny relevant details about margins on a resected specimen.
Control0..*
TypeBackboneElement
112. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.Status
Definition

The status of the observation

ShortThe status of the observation
Control1..1
TypeCodeableConcept
114. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.Code
Definition

The type of observation made.

ShortThe type of observation made.
Control1..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
TypeCodeableConcept
116. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.SpecimenId
Definition

An identifier of the specimen being observed.

ShortAn identifier of the specimen being observed.
Control0..1
TypeIdentifier
118. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.TumourIdentifier
Definition

An identifier for the tumour about which the observation is made.

ShortAn identifier for the tumour about which the observation is made.
Control0..1
TypeIdentifier
120. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.Margin
Definition

The type of margin observed.

ShortThe type of margin observed.
Control1..1
TypeCodeableConcept
122. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.MarginStatus
Definition

Whether or not this margin of the resected specimen is involved in the given tumour.

ShortWhether or not this margin of the resected specimen is involved in the given tumour.
Control0..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour
TypeCodeableConcept
124. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.MarginQualifier
Definition

An additional qualification of the margin description, e.g. Proximal, Distal.

ShortAn additional qualification of the margin description, e.g. Proximal, Distal.
Control0..*
TypeCodeableConcept
126. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.DistanceToMarginRange
Definition

The distance range between the given margin and the tumour on the resected specimen.

ShortThe distance range between the given margin and the tumour on the resected specimen.
Control0..1
TypeCodeableConcept
128. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.DistanceToMarginMeasurement
Definition

The measurement of the distance between the given margin and the tumour on the resected specimen.

ShortThe measurement of the distance between the given margin and the tumour on the resected specimen.
Control0..1
TypeQuantity
130. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.NatureOfTissueBetweenTumourAndMargin
Definition

The type of tissue found between the tumour and given margin on the specimen.

ShortThe type of tissue found between the tumour and given margin on the specimen.
Control0..1
TypeCodeableConcept
132. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.MarginComments
Definition

Additional free text comments about the given margin on the resected specimen.

ShortAdditional free text comments about the given margin on the resected specimen.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
134. BreastHistoSpecimen-cs.SpecimenImageIncluded
Definition

A flag to indicate whether or not an image of the specimen is included.

ShortA flag to indicate whether or not an image of the specimen is included.
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
136. BreastHistoSpecimen-cs.Image
Definition

An image of the patient's tumour, specimen, or radiology.

ShortAn image of the patient's tumour, specimen, or radiology.
Control0..1
TypeBackboneElement
138. BreastHistoSpecimen-cs.Image.File
Definition

The file containing the image.

ShortThe file containing the image.
Control0..1
TypeAttachment
140. BreastHistoSpecimen-cs.Image.Label
Definition

A label describing the image in the file.

ShortA label describing the image in the file.
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
142. BreastHistoSpecimen-cs.Image.bool
Definition

BreastHistoSpecimen.Image.bool

ShortBreastHistoSpecimen.Image.bool
Control0..1
Typeboolean
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. BreastHistoSpecimen-cs
Definition

Relevant details about the specimen in a breast histopathology composition.

ShortSpecimen (breast histopathology)
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. BreastHistoSpecimen-cs.Specimen
Definition

A sample to be used for analysis.

ShortA sample to be used for analysis.
Control1..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. BreastHistoSpecimen-cs.Specimen.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())
6. BreastHistoSpecimen-cs.Specimen.Id
Definition

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

ShortAn identifier for the specimen, e.g. a barcode.
Control0..*
TypeIdentifier
8. BreastHistoSpecimen-cs.Specimen.TumourIdentifier
Definition

The number or identifier used to reference the given lesion/tumour.

ShortThe number or identifier used to reference the given lesion/tumour.
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. BreastHistoSpecimen-cs.Specimen.Category
Definition

The category of specimen, e.g. biopsy specimen

ShortThe category of specimen, e.g. biopsy specimen
Control0..1
TypeCodeableConcept
12. BreastHistoSpecimen-cs.Specimen.Type
Definition

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

ShortThe type of specimen, e.g. core biopsy specimen, lymph node excision specimen.
Control0..1
TypeCodeableConcept
14. BreastHistoSpecimen-cs.Specimen.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
16. BreastHistoSpecimen-cs.Specimen.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()))
18. BreastHistoSpecimen-cs.Specimen.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())
20. BreastHistoSpecimen-cs.Specimen.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
22. BreastHistoSpecimen-cs.Specimen.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
24. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy
Definition

The healthcare practitioner who collected the specimen.

ShortThe healthcare practitioner who collected the specimen.
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.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())
28. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.PersonName
Definition

Person name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.

ShortPerson name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.PersonName.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())
32. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.PersonName.Title
Definition

The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person

ShortThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
Control0..1
TypeCodeableConcept
34. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.PersonName.GivenName
Definition

The person’s forename or given name at birth

ShortThe person’s forename or given name at birth
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
36. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.PersonName.FamilyName
Definition

The family name (surname) of a person as distinct from their given, second and subsequent name(s)

ShortThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
38. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.PersonName.NameProtectionFlag
Definition

This indicator denotes that the person’s name information is to be held ‘in confidence’

ShortThis indicator denotes that the person’s name information is to be held ‘in confidence’
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
40. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.PersonName.age
Definition

BreastHistoSpecimen.Specimen.Collection.collectedBy.PersonName.age

ShortBreastHistoSpecimen.Specimen.Collection.collectedBy.PersonName.age
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
42. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.ProfessionalRegistration
Definition

the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced

Shortthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.ProfessionalRegistration.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())
46. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.ProfessionalRegistration.AssigningOrganisationIdentifier
Definition

The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number

ShortThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
Control0..1
TypeCodeableConcept
48. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.HealthWorkerRole
Definition

The employment of a health worker in a specific role

ShortThe employment of a health worker in a specific role
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.HealthWorkerRole.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())
52. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.HealthWorkerRole.PRI
Definition

A unique ten-character identifier assigned by the HPI system to an individual role

ShortA unique ten-character identifier assigned by the HPI system to an individual role
Control1..1
TypeIdentifier
54. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.HealthWorkerRole.RoleCode
Definition

The designated the role of a health worker

ShortThe designated the role of a health worker
Control1..1
TypeCodeableConcept
56. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.HealthWorkerRole.RoleConfidential
Definition

Whether or not the role of health care practitioner is confidential

ShortWhether or not the role of health care practitioner is confidential
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
58. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.HealthWorkerRole.FacilityId
Definition

The identifier of the healthcare facility at which the practitioner works in this role.

ShortThe identifier of the healthcare facility at which the practitioner works in this role.
Control0..1
TypeIdentifier
60. BreastHistoSpecimen-cs.Specimen.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()))
62. BreastHistoSpecimen-cs.Specimen.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())
64. BreastHistoSpecimen-cs.Specimen.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
66. BreastHistoSpecimen-cs.Specimen.Collection.BodySite.BodyStructurePart
Definition

The anatomical part of the body structure being described.

ShortThe anatomical part of the body structure being described.
Control0..*
TypeCodeableConcept
68. BreastHistoSpecimen-cs.Specimen.Collection.BodySite.Clockface
Definition

The clockface orientation from the landmark.

ShortThe clockface orientation from the landmark.
Control0..1
TypeCodeableConcept
70. BreastHistoSpecimen-cs.Specimen.Collection.BodySite.DistanceFromLandmark
Definition

The distance from the given landmark.

ShortThe distance from the given landmark.
Control0..1
TypeQuantity
72. BreastHistoSpecimen-cs.Specimen.Collection.BodySite.Comments
Definition

Free text comments describing the body site.

ShortFree text comments describing the body site.
Control0..1
TypeCodeableConcept
74. BreastHistoSpecimen-cs.Specimen.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
76. BreastHistoSpecimen-cs.Specimen.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
78. BreastHistoSpecimen-cs.Specimen.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
80. BreastHistoSpecimen-cs.SpecimenContainer
Definition

An individual container (e.g. a specific tube) in which the specimen is placed.

ShortAn individual container (e.g. a specific tube) in which the specimen is placed.
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. BreastHistoSpecimen-cs.SpecimenContainer.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())
84. BreastHistoSpecimen-cs.SpecimenContainer.ContainerId
Definition

An identifier for the individual specimen container.

ShortAn identifier for the individual specimen container.
Control0..1
TypeIdentifier
86. BreastHistoSpecimen-cs.SpecimenContainer.SpecimenId
Definition

An identifier for the specimen in the container.

ShortAn identifier for the specimen in the container.
Control0..1
TypeIdentifier
88. BreastHistoSpecimen-cs.SpecimenContainer.Type
Definition

The type of container used (e.g. slide, tube, bottle).

ShortThe type of container used (e.g. slide, tube, bottle).
Control0..1
TypeCodeableConcept
90. BreastHistoSpecimen-cs.SpecimenContainer.SpecimenQualifier
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
92. BreastHistoSpecimen-cs.SpecimenContainer.PreparationTechnique
Definition

BreastHistoSpecimen.SpecimenContainer.PreparationTechnique

ShortBreastHistoSpecimen.SpecimenContainer.PreparationTechnique
Control0..*
TypeCodeableConcept
94. BreastHistoSpecimen-cs.SpecimenContainer.MediumStatus
Definition

Whether or not the specimen is fresh or in a medium.

ShortWhether or not the specimen is fresh or in a medium.
Control0..1
TypeCodeableConcept
96. BreastHistoSpecimen-cs.SpecimenContainer.MediumType
Definition

The type of medium used for the specimen in the container.

ShortThe type of medium used for the specimen in the container.
Control0..1
TypeCodeableConcept
98. BreastHistoSpecimen-cs.SpecimenContainer.Quantity
Definition

The quantity of specimen (volume, weight or count of pieces/fragments) placed in this individual container.

ShortThe quantity of specimen (volume, weight or count of pieces/fragments) placed in this individual container.
Control0..1
TypeQuantity
100. BreastHistoSpecimen-cs.SpecimenOrientationMarkers
Definition

Orientation markers of a tissue sample (used for excision/resection specimens).

ShortOrientation markers of a tissue sample (used for excision/resection specimens).
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
102. BreastHistoSpecimen-cs.SpecimenOrientationMarkers.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())
104. BreastHistoSpecimen-cs.SpecimenOrientationMarkers.SpecimenId
Definition

The identifier of the specimen.

ShortThe identifier of the specimen.
Control1..1
TypeIdentifier
106. BreastHistoSpecimen-cs.SpecimenOrientationMarkers.Technique
Definition

The orientation marker technique used (e.g. surgical, radiological).

ShortThe orientation marker technique used (e.g. surgical, radiological).
Control0..1
TypeCodeableConcept
108. BreastHistoSpecimen-cs.SpecimenOrientationMarkers.Type
Definition

The type of orientation marker used (e.g. suture, clip).

ShortThe type of orientation marker used (e.g. suture, clip).
Control0..1
TypeCodeableConcept
110. BreastHistoSpecimen-cs.SpecimenOrientationMarkers.OrientationMarker
Definition

Details about an individual specimen orientation marker.

ShortDetails about an individual specimen orientation marker.
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
112. BreastHistoSpecimen-cs.SpecimenOrientationMarkers.OrientationMarker.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())
114. BreastHistoSpecimen-cs.SpecimenOrientationMarkers.OrientationMarker.Position
Definition

The position of the orientation marker (e.g. superior, inferior)

ShortThe position of the orientation marker (e.g. superior, inferior)
Control1..1
TypeCodeableConcept
116. BreastHistoSpecimen-cs.SpecimenOrientationMarkers.OrientationMarker.Description
Definition

A description of the marker at the given position.

ShortA description of the marker at the given position.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
118. BreastHistoSpecimen-cs.ClinicalMarginStatus
Definition

The status of the tissue on the margin of a resected specimen as specified by the clinician (eg surgeon).

ShortThe status of the tissue on the margin of a resected specimen as specified by the clinician (eg surgeon).
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
120. BreastHistoSpecimen-cs.ClinicalMarginStatus.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())
122. BreastHistoSpecimen-cs.ClinicalMarginStatus.Status
Definition

The status of the observation

ShortThe status of the observation
Control1..1
TypeCodeableConcept
124. BreastHistoSpecimen-cs.ClinicalMarginStatus.Code
Definition

The type of observation made.

ShortThe type of observation made.
Control1..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
TypeCodeableConcept
126. BreastHistoSpecimen-cs.ClinicalMarginStatus.TumourIdentifier
Definition

An identifier for the tumour about which the observation is made.

ShortAn identifier for the tumour about which the observation is made.
Control0..1
TypeIdentifier
128. BreastHistoSpecimen-cs.ClinicalMarginStatus.ResidualCancerStatus
Definition

Whether or not the margin of a resected specimen is involved in the tumour.

ShortWhether or not the margin of a resected specimen is involved in the tumour.
Control0..1
TypeCodeableConcept
130. BreastHistoSpecimen-cs.ClinicalMarginStatus.InvolvedMargins
Definition

A free text description of the margins involved with respect to the tumour.

ShortA free text description of the margins involved with respect to the tumour.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
132. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail
Definition

Any relevant details about margins on a resected specimen.

ShortAny relevant details about margins on a resected specimen.
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
134. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.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())
136. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.Status
Definition

The status of the observation

ShortThe status of the observation
Control1..1
TypeCodeableConcept
138. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.Code
Definition

The type of observation made.

ShortThe type of observation made.
Control1..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
TypeCodeableConcept
140. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.SpecimenId
Definition

An identifier of the specimen being observed.

ShortAn identifier of the specimen being observed.
Control0..1
TypeIdentifier
142. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.TumourIdentifier
Definition

An identifier for the tumour about which the observation is made.

ShortAn identifier for the tumour about which the observation is made.
Control0..1
TypeIdentifier
144. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.Margin
Definition

The type of margin observed.

ShortThe type of margin observed.
Control1..1
TypeCodeableConcept
146. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.MarginStatus
Definition

Whether or not this margin of the resected specimen is involved in the given tumour.

ShortWhether or not this margin of the resected specimen is involved in the given tumour.
Control0..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour
TypeCodeableConcept
148. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.MarginQualifier
Definition

An additional qualification of the margin description, e.g. Proximal, Distal.

ShortAn additional qualification of the margin description, e.g. Proximal, Distal.
Control0..*
TypeCodeableConcept
150. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.DistanceToMarginRange
Definition

The distance range between the given margin and the tumour on the resected specimen.

ShortThe distance range between the given margin and the tumour on the resected specimen.
Control0..1
TypeCodeableConcept
152. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.DistanceToMarginMeasurement
Definition

The measurement of the distance between the given margin and the tumour on the resected specimen.

ShortThe measurement of the distance between the given margin and the tumour on the resected specimen.
Control0..1
TypeQuantity
154. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.NatureOfTissueBetweenTumourAndMargin
Definition

The type of tissue found between the tumour and given margin on the specimen.

ShortThe type of tissue found between the tumour and given margin on the specimen.
Control0..1
TypeCodeableConcept
156. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.MarginComments
Definition

Additional free text comments about the given margin on the resected specimen.

ShortAdditional free text comments about the given margin on the resected specimen.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
158. BreastHistoSpecimen-cs.SpecimenImageIncluded
Definition

A flag to indicate whether or not an image of the specimen is included.

ShortA flag to indicate whether or not an image of the specimen is included.
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
160. BreastHistoSpecimen-cs.Image
Definition

An image of the patient's tumour, specimen, or radiology.

ShortAn image of the patient's tumour, specimen, or radiology.
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
162. BreastHistoSpecimen-cs.Image.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())
164. BreastHistoSpecimen-cs.Image.File
Definition

The file containing the image.

ShortThe file containing the image.
Control0..1
TypeAttachment
166. BreastHistoSpecimen-cs.Image.Label
Definition

A label describing the image in the file.

ShortA label describing the image in the file.
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
168. BreastHistoSpecimen-cs.Image.bool
Definition

BreastHistoSpecimen.Image.bool

ShortBreastHistoSpecimen.Image.bool
Control0..1
Typeboolean
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. BreastHistoSpecimen-cs
Definition

Relevant details about the specimen in a breast histopathology composition.

ShortSpecimen (breast histopathology)
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. BreastHistoSpecimen-cs.Specimen
Definition

A sample to be used for analysis.

ShortA sample to be used for analysis.
Control1..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. BreastHistoSpecimen-cs.Specimen.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
6. BreastHistoSpecimen-cs.Specimen.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 BreastHistoSpecimen-cs.Specimen.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
8. BreastHistoSpecimen-cs.Specimen.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())
10. BreastHistoSpecimen-cs.Specimen.Id
Definition

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

ShortAn identifier for the specimen, e.g. a barcode.
Control0..*
TypeIdentifier
12. BreastHistoSpecimen-cs.Specimen.TumourIdentifier
Definition

The number or identifier used to reference the given lesion/tumour.

ShortThe number or identifier used to reference the given lesion/tumour.
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. BreastHistoSpecimen-cs.Specimen.Category
Definition

The category of specimen, e.g. biopsy specimen

ShortThe category of specimen, e.g. biopsy specimen
Control0..1
TypeCodeableConcept
16. BreastHistoSpecimen-cs.Specimen.Type
Definition

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

ShortThe type of specimen, e.g. core biopsy specimen, lymph node excision specimen.
Control0..1
TypeCodeableConcept
18. BreastHistoSpecimen-cs.Specimen.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
20. BreastHistoSpecimen-cs.Specimen.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()))
22. BreastHistoSpecimen-cs.Specimen.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
24. BreastHistoSpecimen-cs.Specimen.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 BreastHistoSpecimen-cs.Specimen.Collection.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
26. BreastHistoSpecimen-cs.Specimen.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())
28. BreastHistoSpecimen-cs.Specimen.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
30. BreastHistoSpecimen-cs.Specimen.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
32. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy
Definition

The healthcare practitioner who collected the specimen.

ShortThe healthcare practitioner who collected the specimen.
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.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
36. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.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 BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
38. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.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())
40. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.PersonName
Definition

Person name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.

ShortPerson name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.PersonName.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
44. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.PersonName.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 BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.PersonName.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
46. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.PersonName.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())
48. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.PersonName.Title
Definition

The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person

ShortThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
Control0..1
TypeCodeableConcept
50. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.PersonName.GivenName
Definition

The person’s forename or given name at birth

ShortThe person’s forename or given name at birth
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
52. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.PersonName.FamilyName
Definition

The family name (surname) of a person as distinct from their given, second and subsequent name(s)

ShortThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
54. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.PersonName.NameProtectionFlag
Definition

This indicator denotes that the person’s name information is to be held ‘in confidence’

ShortThis indicator denotes that the person’s name information is to be held ‘in confidence’
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
56. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.PersonName.age
Definition

BreastHistoSpecimen.Specimen.Collection.collectedBy.PersonName.age

ShortBreastHistoSpecimen.Specimen.Collection.collectedBy.PersonName.age
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
58. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.ProfessionalRegistration
Definition

the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced

Shortthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.ProfessionalRegistration.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
62. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.ProfessionalRegistration.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 BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.ProfessionalRegistration.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
64. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.ProfessionalRegistration.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())
66. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.ProfessionalRegistration.AssigningOrganisationIdentifier
Definition

The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number

ShortThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
Control0..1
TypeCodeableConcept
68. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.HealthWorkerRole
Definition

The employment of a health worker in a specific role

ShortThe employment of a health worker in a specific role
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.HealthWorkerRole.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
72. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.HealthWorkerRole.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 BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.HealthWorkerRole.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
74. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.HealthWorkerRole.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())
76. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.HealthWorkerRole.PRI
Definition

A unique ten-character identifier assigned by the HPI system to an individual role

ShortA unique ten-character identifier assigned by the HPI system to an individual role
Control1..1
TypeIdentifier
78. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.HealthWorkerRole.RoleCode
Definition

The designated the role of a health worker

ShortThe designated the role of a health worker
Control1..1
TypeCodeableConcept
80. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.HealthWorkerRole.RoleConfidential
Definition

Whether or not the role of health care practitioner is confidential

ShortWhether or not the role of health care practitioner is confidential
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
82. BreastHistoSpecimen-cs.Specimen.Collection.collectedBy.HealthWorkerRole.FacilityId
Definition

The identifier of the healthcare facility at which the practitioner works in this role.

ShortThe identifier of the healthcare facility at which the practitioner works in this role.
Control0..1
TypeIdentifier
84. BreastHistoSpecimen-cs.Specimen.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()))
86. BreastHistoSpecimen-cs.Specimen.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
88. BreastHistoSpecimen-cs.Specimen.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 BreastHistoSpecimen-cs.Specimen.Collection.BodySite.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
90. BreastHistoSpecimen-cs.Specimen.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())
92. BreastHistoSpecimen-cs.Specimen.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
94. BreastHistoSpecimen-cs.Specimen.Collection.BodySite.BodyStructurePart
Definition

The anatomical part of the body structure being described.

ShortThe anatomical part of the body structure being described.
Control0..*
TypeCodeableConcept
96. BreastHistoSpecimen-cs.Specimen.Collection.BodySite.Clockface
Definition

The clockface orientation from the landmark.

ShortThe clockface orientation from the landmark.
Control0..1
TypeCodeableConcept
98. BreastHistoSpecimen-cs.Specimen.Collection.BodySite.DistanceFromLandmark
Definition

The distance from the given landmark.

ShortThe distance from the given landmark.
Control0..1
TypeQuantity
100. BreastHistoSpecimen-cs.Specimen.Collection.BodySite.Comments
Definition

Free text comments describing the body site.

ShortFree text comments describing the body site.
Control0..1
TypeCodeableConcept
102. BreastHistoSpecimen-cs.Specimen.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
104. BreastHistoSpecimen-cs.Specimen.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
106. BreastHistoSpecimen-cs.Specimen.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
108. BreastHistoSpecimen-cs.SpecimenContainer
Definition

An individual container (e.g. a specific tube) in which the specimen is placed.

ShortAn individual container (e.g. a specific tube) in which the specimen is placed.
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
110. BreastHistoSpecimen-cs.SpecimenContainer.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
112. BreastHistoSpecimen-cs.SpecimenContainer.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 BreastHistoSpecimen-cs.SpecimenContainer.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
114. BreastHistoSpecimen-cs.SpecimenContainer.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())
116. BreastHistoSpecimen-cs.SpecimenContainer.ContainerId
Definition

An identifier for the individual specimen container.

ShortAn identifier for the individual specimen container.
Control0..1
TypeIdentifier
118. BreastHistoSpecimen-cs.SpecimenContainer.SpecimenId
Definition

An identifier for the specimen in the container.

ShortAn identifier for the specimen in the container.
Control0..1
TypeIdentifier
120. BreastHistoSpecimen-cs.SpecimenContainer.Type
Definition

The type of container used (e.g. slide, tube, bottle).

ShortThe type of container used (e.g. slide, tube, bottle).
Control0..1
TypeCodeableConcept
122. BreastHistoSpecimen-cs.SpecimenContainer.SpecimenQualifier
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
124. BreastHistoSpecimen-cs.SpecimenContainer.PreparationTechnique
Definition

BreastHistoSpecimen.SpecimenContainer.PreparationTechnique

ShortBreastHistoSpecimen.SpecimenContainer.PreparationTechnique
Control0..*
TypeCodeableConcept
126. BreastHistoSpecimen-cs.SpecimenContainer.MediumStatus
Definition

Whether or not the specimen is fresh or in a medium.

ShortWhether or not the specimen is fresh or in a medium.
Control0..1
TypeCodeableConcept
128. BreastHistoSpecimen-cs.SpecimenContainer.MediumType
Definition

The type of medium used for the specimen in the container.

ShortThe type of medium used for the specimen in the container.
Control0..1
TypeCodeableConcept
130. BreastHistoSpecimen-cs.SpecimenContainer.Quantity
Definition

The quantity of specimen (volume, weight or count of pieces/fragments) placed in this individual container.

ShortThe quantity of specimen (volume, weight or count of pieces/fragments) placed in this individual container.
Control0..1
TypeQuantity
132. BreastHistoSpecimen-cs.SpecimenOrientationMarkers
Definition

Orientation markers of a tissue sample (used for excision/resection specimens).

ShortOrientation markers of a tissue sample (used for excision/resection specimens).
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
134. BreastHistoSpecimen-cs.SpecimenOrientationMarkers.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
136. BreastHistoSpecimen-cs.SpecimenOrientationMarkers.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 BreastHistoSpecimen-cs.SpecimenOrientationMarkers.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
138. BreastHistoSpecimen-cs.SpecimenOrientationMarkers.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())
140. BreastHistoSpecimen-cs.SpecimenOrientationMarkers.SpecimenId
Definition

The identifier of the specimen.

ShortThe identifier of the specimen.
Control1..1
TypeIdentifier
142. BreastHistoSpecimen-cs.SpecimenOrientationMarkers.Technique
Definition

The orientation marker technique used (e.g. surgical, radiological).

ShortThe orientation marker technique used (e.g. surgical, radiological).
Control0..1
TypeCodeableConcept
144. BreastHistoSpecimen-cs.SpecimenOrientationMarkers.Type
Definition

The type of orientation marker used (e.g. suture, clip).

ShortThe type of orientation marker used (e.g. suture, clip).
Control0..1
TypeCodeableConcept
146. BreastHistoSpecimen-cs.SpecimenOrientationMarkers.OrientationMarker
Definition

Details about an individual specimen orientation marker.

ShortDetails about an individual specimen orientation marker.
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
148. BreastHistoSpecimen-cs.SpecimenOrientationMarkers.OrientationMarker.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
150. BreastHistoSpecimen-cs.SpecimenOrientationMarkers.OrientationMarker.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 BreastHistoSpecimen-cs.SpecimenOrientationMarkers.OrientationMarker.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
152. BreastHistoSpecimen-cs.SpecimenOrientationMarkers.OrientationMarker.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())
154. BreastHistoSpecimen-cs.SpecimenOrientationMarkers.OrientationMarker.Position
Definition

The position of the orientation marker (e.g. superior, inferior)

ShortThe position of the orientation marker (e.g. superior, inferior)
Control1..1
TypeCodeableConcept
156. BreastHistoSpecimen-cs.SpecimenOrientationMarkers.OrientationMarker.Description
Definition

A description of the marker at the given position.

ShortA description of the marker at the given position.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
158. BreastHistoSpecimen-cs.ClinicalMarginStatus
Definition

The status of the tissue on the margin of a resected specimen as specified by the clinician (eg surgeon).

ShortThe status of the tissue on the margin of a resected specimen as specified by the clinician (eg surgeon).
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
160. BreastHistoSpecimen-cs.ClinicalMarginStatus.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
162. BreastHistoSpecimen-cs.ClinicalMarginStatus.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 BreastHistoSpecimen-cs.ClinicalMarginStatus.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
164. BreastHistoSpecimen-cs.ClinicalMarginStatus.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())
166. BreastHistoSpecimen-cs.ClinicalMarginStatus.Status
Definition

The status of the observation

ShortThe status of the observation
Control1..1
TypeCodeableConcept
168. BreastHistoSpecimen-cs.ClinicalMarginStatus.Code
Definition

The type of observation made.

ShortThe type of observation made.
Control1..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
TypeCodeableConcept
170. BreastHistoSpecimen-cs.ClinicalMarginStatus.TumourIdentifier
Definition

An identifier for the tumour about which the observation is made.

ShortAn identifier for the tumour about which the observation is made.
Control0..1
TypeIdentifier
172. BreastHistoSpecimen-cs.ClinicalMarginStatus.ResidualCancerStatus
Definition

Whether or not the margin of a resected specimen is involved in the tumour.

ShortWhether or not the margin of a resected specimen is involved in the tumour.
Control0..1
TypeCodeableConcept
174. BreastHistoSpecimen-cs.ClinicalMarginStatus.InvolvedMargins
Definition

A free text description of the margins involved with respect to the tumour.

ShortA free text description of the margins involved with respect to the tumour.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
176. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail
Definition

Any relevant details about margins on a resected specimen.

ShortAny relevant details about margins on a resected specimen.
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
178. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.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
180. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.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 BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
182. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.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())
184. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.Status
Definition

The status of the observation

ShortThe status of the observation
Control1..1
TypeCodeableConcept
186. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.Code
Definition

The type of observation made.

ShortThe type of observation made.
Control1..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
TypeCodeableConcept
188. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.SpecimenId
Definition

An identifier of the specimen being observed.

ShortAn identifier of the specimen being observed.
Control0..1
TypeIdentifier
190. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.TumourIdentifier
Definition

An identifier for the tumour about which the observation is made.

ShortAn identifier for the tumour about which the observation is made.
Control0..1
TypeIdentifier
192. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.Margin
Definition

The type of margin observed.

ShortThe type of margin observed.
Control1..1
TypeCodeableConcept
194. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.MarginStatus
Definition

Whether or not this margin of the resected specimen is involved in the given tumour.

ShortWhether or not this margin of the resected specimen is involved in the given tumour.
Control0..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour
TypeCodeableConcept
196. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.MarginQualifier
Definition

An additional qualification of the margin description, e.g. Proximal, Distal.

ShortAn additional qualification of the margin description, e.g. Proximal, Distal.
Control0..*
TypeCodeableConcept
198. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.DistanceToMarginRange
Definition

The distance range between the given margin and the tumour on the resected specimen.

ShortThe distance range between the given margin and the tumour on the resected specimen.
Control0..1
TypeCodeableConcept
200. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.DistanceToMarginMeasurement
Definition

The measurement of the distance between the given margin and the tumour on the resected specimen.

ShortThe measurement of the distance between the given margin and the tumour on the resected specimen.
Control0..1
TypeQuantity
202. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.NatureOfTissueBetweenTumourAndMargin
Definition

The type of tissue found between the tumour and given margin on the specimen.

ShortThe type of tissue found between the tumour and given margin on the specimen.
Control0..1
TypeCodeableConcept
204. BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.MarginComments
Definition

Additional free text comments about the given margin on the resected specimen.

ShortAdditional free text comments about the given margin on the resected specimen.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
206. BreastHistoSpecimen-cs.SpecimenImageIncluded
Definition

A flag to indicate whether or not an image of the specimen is included.

ShortA flag to indicate whether or not an image of the specimen is included.
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
208. BreastHistoSpecimen-cs.Image
Definition

An image of the patient's tumour, specimen, or radiology.

ShortAn image of the patient's tumour, specimen, or radiology.
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
210. BreastHistoSpecimen-cs.Image.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
212. BreastHistoSpecimen-cs.Image.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 BreastHistoSpecimen-cs.Image.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
214. BreastHistoSpecimen-cs.Image.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())
216. BreastHistoSpecimen-cs.Image.File
Definition

The file containing the image.

ShortThe file containing the image.
Control0..1
TypeAttachment
218. BreastHistoSpecimen-cs.Image.Label
Definition

A label describing the image in the file.

ShortA label describing the image in the file.
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
220. BreastHistoSpecimen-cs.Image.bool
Definition

BreastHistoSpecimen.Image.bool

ShortBreastHistoSpecimen.Image.bool
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension