CanShare models
0.1.0 - ci-build

CanShare models, published by David hay. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/davidhay25/models/ and changes regularly. See the Directory of published versions

Logical Model: Specimen (breast histopathology)

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

Relevant details about the specimen in a breast histopathology composition.

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. BreastHistoSpecimen-cs 0..*BaseSpecimen (breast histopathology)
Instances of this logical model are not marked to be the target of a Reference
... Specimen 1..1BackboneElementA sample to be used for analysis.
.... Id 0..*IdentifierAn identifier for the specimen, e.g. a barcode.
.... TumourIdentifier 0..*stringThe number or identifier used to reference the given lesion/tumour.
.... Category 0..1CodeableConceptThe category of specimen, e.g. biopsy specimen
.... Type 0..1CodeableConceptThe type of specimen, e.g. core biopsy specimen, lymph node excision specimen.
.... Qualifier 0..1CodeableConceptA qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified.
.... Collection 0..1BackboneElementDetails about the collection of the specimen.
..... Procedure 0..*CodeableConceptThe procedure used to collect the specimen, e.g. Partial mastectomy, Wide local excision, Lumpectomy, Hookwire excision
..... CollectionDate 0..1dateTimeThe date and/or time that the sample/specimen was collected.
..... collectedBy 0..1BackboneElementThe healthcare practitioner who collected the specimen.
...... PersonName 0..1BackboneElementPerson name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.
....... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
....... GivenName 0..1stringThe person’s forename or given name at birth
....... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
....... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
....... age 0..1stringBreastHistoSpecimen.Specimen.Collection.collectedBy.PersonName.age
...... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
....... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
...... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
....... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
....... RoleCode 1..1CodeableConceptThe designated the role of a health worker
....... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
....... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.
..... BodySite 0..1BackboneElementThe site from which the sample/specimen was collected.
...... BodyStructure 1..1CodeableConceptThe anatomical structure being described
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred)
...... BodyStructurePart 0..*CodeableConceptThe anatomical part of the body structure being described.
...... Clockface 0..1CodeableConceptThe clockface orientation from the landmark.
...... DistanceFromLandmark 0..1QuantityThe distance from the given landmark.
...... Comments 0..1CodeableConceptFree text comments describing the body site.
..... Technique 0..*CodeableConceptThe technique used to collect the specimen, e.g. Random specimen collection.
.... ContainerQuantity 0..1QuantityA count of the number of containers (e.g. 3 tubes, 4 slides, 1 bottle) in which the specimen is placed after collection.
.... Comments 0..1stringFree text comments about the specimen.
... SpecimenContainer 0..*BackboneElementAn individual container (e.g. a specific tube) in which the specimen is placed.
.... ContainerId 0..1IdentifierAn identifier for the individual specimen container.
.... SpecimenId 0..1IdentifierAn identifier for the specimen in the container.
.... Type 0..1CodeableConceptThe type of container used (e.g. slide, tube, bottle).
.... SpecimenQualifier 0..1CodeableConceptA qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified.
.... PreparationTechnique 0..*CodeableConceptBreastHistoSpecimen.SpecimenContainer.PreparationTechnique
.... MediumStatus 0..1CodeableConceptWhether or not the specimen is fresh or in a medium.
.... MediumType 0..1CodeableConceptThe type of medium used for the specimen in the container.
.... Quantity 0..1QuantityThe quantity of specimen (volume, weight or count of pieces/fragments) placed in this individual container.
... SpecimenOrientationMarkers 0..1BackboneElementOrientation markers of a tissue sample (used for excision/resection specimens).
.... SpecimenId 1..1IdentifierThe identifier of the specimen.
.... Technique 0..1CodeableConceptThe orientation marker technique used (e.g. surgical, radiological).
.... Type 0..1CodeableConceptThe type of orientation marker used (e.g. suture, clip).
.... OrientationMarker 0..*BackboneElementDetails about an individual specimen orientation marker.
..... Position 1..1CodeableConceptThe position of the orientation marker (e.g. superior, inferior)
..... Description 0..1stringA description of the marker at the given position.
.... Status 1..1CodeableConceptThe status of the observation
.... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
.... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
.... ResidualCancerStatus 0..1CodeableConceptWhether or not the margin of a resected specimen is involved in the tumour.
.... InvolvedMargins 0..1stringA free text description of the margins involved with respect to the tumour.
.... MarginDetail 0..*BackboneElementAny relevant details about margins on a resected specimen.
..... Status 1..1CodeableConceptThe status of the observation
..... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
..... SpecimenId 0..1IdentifierAn identifier of the specimen being observed.
..... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
..... Margin 1..1CodeableConceptThe type of margin observed.
..... MarginStatus 0..1CodeableConceptWhether or not this margin of the resected specimen is involved in the given tumour.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour (preferred)
..... MarginQualifier 0..*CodeableConceptAn additional qualification of the margin description, e.g. Proximal, Distal.
..... DistanceToMarginRange 0..1CodeableConceptThe distance range between the given margin and the tumour on the resected specimen.
..... DistanceToMarginMeasurement 0..1QuantityThe measurement of the distance between the given margin and the tumour on the resected specimen.
..... NatureOfTissueBetweenTumourAndMargin 0..1CodeableConceptThe type of tissue found between the tumour and given margin on the specimen.
..... MarginComments 0..1stringAdditional free text comments about the given margin on the resected specimen.
... SpecimenImageIncluded 0..1booleanA flag to indicate whether or not an image of the specimen is included.
... Image 0..1BackboneElementAn image of the patient's tumour, specimen, or radiology.
.... File 0..1AttachmentThe file containing the image.
.... Label 0..*stringA label describing the image in the file.
.... bool 0..1booleanBreastHistoSpecimen.Image.bool

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
BreastHistoSpecimen-cs.Specimen.Collection.BodySite.BodyStructurepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
BreastHistoSpecimen-cs.ClinicalMarginStatus.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.MarginStatuspreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour
NameFlagsCard.TypeDescription & Constraintsdoco
.. BreastHistoSpecimen-cs 0..*BaseSpecimen (breast histopathology)
Instances of this logical model are not marked to be the target of a Reference
... Specimen 1..1BackboneElementA sample to be used for analysis.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Id 0..*IdentifierAn identifier for the specimen, e.g. a barcode.
.... TumourIdentifier 0..*stringThe number or identifier used to reference the given lesion/tumour.
.... Category 0..1CodeableConceptThe category of specimen, e.g. biopsy specimen
.... Type 0..1CodeableConceptThe type of specimen, e.g. core biopsy specimen, lymph node excision specimen.
.... Qualifier 0..1CodeableConceptA qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified.
.... Collection 0..1BackboneElementDetails about the collection of the specimen.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Procedure 0..*CodeableConceptThe procedure used to collect the specimen, e.g. Partial mastectomy, Wide local excision, Lumpectomy, Hookwire excision
..... CollectionDate 0..1dateTimeThe date and/or time that the sample/specimen was collected.
..... collectedBy 0..1BackboneElementThe healthcare practitioner who collected the specimen.
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... PersonName 0..1BackboneElementPerson name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
....... GivenName 0..1stringThe person’s forename or given name at birth
....... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
....... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
....... age 0..1stringBreastHistoSpecimen.Specimen.Collection.collectedBy.PersonName.age
...... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
...... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
....... RoleCode 1..1CodeableConceptThe designated the role of a health worker
....... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
....... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.
..... BodySite 0..1BackboneElementThe site from which the sample/specimen was collected.
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... BodyStructure 1..1CodeableConceptThe anatomical structure being described
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred)
...... BodyStructurePart 0..*CodeableConceptThe anatomical part of the body structure being described.
...... Clockface 0..1CodeableConceptThe clockface orientation from the landmark.
...... DistanceFromLandmark 0..1QuantityThe distance from the given landmark.
...... Comments 0..1CodeableConceptFree text comments describing the body site.
..... Technique 0..*CodeableConceptThe technique used to collect the specimen, e.g. Random specimen collection.
.... ContainerQuantity 0..1QuantityA count of the number of containers (e.g. 3 tubes, 4 slides, 1 bottle) in which the specimen is placed after collection.
.... Comments 0..1stringFree text comments about the specimen.
... SpecimenContainer 0..*BackboneElementAn individual container (e.g. a specific tube) in which the specimen is placed.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ContainerId 0..1IdentifierAn identifier for the individual specimen container.
.... SpecimenId 0..1IdentifierAn identifier for the specimen in the container.
.... Type 0..1CodeableConceptThe type of container used (e.g. slide, tube, bottle).
.... SpecimenQualifier 0..1CodeableConceptA qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified.
.... PreparationTechnique 0..*CodeableConceptBreastHistoSpecimen.SpecimenContainer.PreparationTechnique
.... MediumStatus 0..1CodeableConceptWhether or not the specimen is fresh or in a medium.
.... MediumType 0..1CodeableConceptThe type of medium used for the specimen in the container.
.... Quantity 0..1QuantityThe quantity of specimen (volume, weight or count of pieces/fragments) placed in this individual container.
... SpecimenOrientationMarkers 0..1BackboneElementOrientation markers of a tissue sample (used for excision/resection specimens).
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... SpecimenId 1..1IdentifierThe identifier of the specimen.
.... Technique 0..1CodeableConceptThe orientation marker technique used (e.g. surgical, radiological).
.... Type 0..1CodeableConceptThe type of orientation marker used (e.g. suture, clip).
.... OrientationMarker 0..*BackboneElementDetails about an individual specimen orientation marker.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Position 1..1CodeableConceptThe position of the orientation marker (e.g. superior, inferior)
..... Description 0..1stringA description of the marker at the given position.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Status 1..1CodeableConceptThe status of the observation
.... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
.... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
.... ResidualCancerStatus 0..1CodeableConceptWhether or not the margin of a resected specimen is involved in the tumour.
.... InvolvedMargins 0..1stringA free text description of the margins involved with respect to the tumour.
.... MarginDetail 0..*BackboneElementAny relevant details about margins on a resected specimen.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Status 1..1CodeableConceptThe status of the observation
..... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
..... SpecimenId 0..1IdentifierAn identifier of the specimen being observed.
..... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
..... Margin 1..1CodeableConceptThe type of margin observed.
..... MarginStatus 0..1CodeableConceptWhether or not this margin of the resected specimen is involved in the given tumour.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour (preferred)
..... MarginQualifier 0..*CodeableConceptAn additional qualification of the margin description, e.g. Proximal, Distal.
..... DistanceToMarginRange 0..1CodeableConceptThe distance range between the given margin and the tumour on the resected specimen.
..... DistanceToMarginMeasurement 0..1QuantityThe measurement of the distance between the given margin and the tumour on the resected specimen.
..... NatureOfTissueBetweenTumourAndMargin 0..1CodeableConceptThe type of tissue found between the tumour and given margin on the specimen.
..... MarginComments 0..1stringAdditional free text comments about the given margin on the resected specimen.
... SpecimenImageIncluded 0..1booleanA flag to indicate whether or not an image of the specimen is included.
... Image 0..1BackboneElementAn image of the patient's tumour, specimen, or radiology.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... File 0..1AttachmentThe file containing the image.
.... Label 0..*stringA label describing the image in the file.
.... bool 0..1booleanBreastHistoSpecimen.Image.bool

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BreastHistoSpecimen-cs.Specimen.Collection.BodySite.BodyStructurepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
BreastHistoSpecimen-cs.ClinicalMarginStatus.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.MarginStatuspreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. BreastHistoSpecimen-cs 0..*BaseSpecimen (breast histopathology)
Instances of this logical model are not marked to be the target of a Reference
... Specimen 1..1BackboneElementA sample to be used for analysis.
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Id 0..*IdentifierAn identifier for the specimen, e.g. a barcode.
.... TumourIdentifier 0..*stringThe number or identifier used to reference the given lesion/tumour.
.... Category 0..1CodeableConceptThe category of specimen, e.g. biopsy specimen
.... Type 0..1CodeableConceptThe type of specimen, e.g. core biopsy specimen, lymph node excision specimen.
.... Qualifier 0..1CodeableConceptA qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified.
.... Collection 0..1BackboneElementDetails about the collection of the specimen.
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Procedure 0..*CodeableConceptThe procedure used to collect the specimen, e.g. Partial mastectomy, Wide local excision, Lumpectomy, Hookwire excision
..... CollectionDate 0..1dateTimeThe date and/or time that the sample/specimen was collected.
..... collectedBy 0..1BackboneElementThe healthcare practitioner who collected the specimen.
...... @id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... PersonName 0..1BackboneElementPerson name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
....... GivenName 0..1stringThe person’s forename or given name at birth
....... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
....... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
....... age 0..1stringBreastHistoSpecimen.Specimen.Collection.collectedBy.PersonName.age
...... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
...... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
....... RoleCode 1..1CodeableConceptThe designated the role of a health worker
....... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
....... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.
..... BodySite 0..1BackboneElementThe site from which the sample/specimen was collected.
...... @id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... BodyStructure 1..1CodeableConceptThe anatomical structure being described
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred)
...... BodyStructurePart 0..*CodeableConceptThe anatomical part of the body structure being described.
...... Clockface 0..1CodeableConceptThe clockface orientation from the landmark.
...... DistanceFromLandmark 0..1QuantityThe distance from the given landmark.
...... Comments 0..1CodeableConceptFree text comments describing the body site.
..... Technique 0..*CodeableConceptThe technique used to collect the specimen, e.g. Random specimen collection.
.... ContainerQuantity 0..1QuantityA count of the number of containers (e.g. 3 tubes, 4 slides, 1 bottle) in which the specimen is placed after collection.
.... Comments 0..1stringFree text comments about the specimen.
... SpecimenContainer 0..*BackboneElementAn individual container (e.g. a specific tube) in which the specimen is placed.
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ContainerId 0..1IdentifierAn identifier for the individual specimen container.
.... SpecimenId 0..1IdentifierAn identifier for the specimen in the container.
.... Type 0..1CodeableConceptThe type of container used (e.g. slide, tube, bottle).
.... SpecimenQualifier 0..1CodeableConceptA qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified.
.... PreparationTechnique 0..*CodeableConceptBreastHistoSpecimen.SpecimenContainer.PreparationTechnique
.... MediumStatus 0..1CodeableConceptWhether or not the specimen is fresh or in a medium.
.... MediumType 0..1CodeableConceptThe type of medium used for the specimen in the container.
.... Quantity 0..1QuantityThe quantity of specimen (volume, weight or count of pieces/fragments) placed in this individual container.
... SpecimenOrientationMarkers 0..1BackboneElementOrientation markers of a tissue sample (used for excision/resection specimens).
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... SpecimenId 1..1IdentifierThe identifier of the specimen.
.... Technique 0..1CodeableConceptThe orientation marker technique used (e.g. surgical, radiological).
.... Type 0..1CodeableConceptThe type of orientation marker used (e.g. suture, clip).
.... OrientationMarker 0..*BackboneElementDetails about an individual specimen orientation marker.
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Position 1..1CodeableConceptThe position of the orientation marker (e.g. superior, inferior)
..... Description 0..1stringA description of the marker at the given position.
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Status 1..1CodeableConceptThe status of the observation
.... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
.... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
.... ResidualCancerStatus 0..1CodeableConceptWhether or not the margin of a resected specimen is involved in the tumour.
.... InvolvedMargins 0..1stringA free text description of the margins involved with respect to the tumour.
.... MarginDetail 0..*BackboneElementAny relevant details about margins on a resected specimen.
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Status 1..1CodeableConceptThe status of the observation
..... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
..... SpecimenId 0..1IdentifierAn identifier of the specimen being observed.
..... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
..... Margin 1..1CodeableConceptThe type of margin observed.
..... MarginStatus 0..1CodeableConceptWhether or not this margin of the resected specimen is involved in the given tumour.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour (preferred)
..... MarginQualifier 0..*CodeableConceptAn additional qualification of the margin description, e.g. Proximal, Distal.
..... DistanceToMarginRange 0..1CodeableConceptThe distance range between the given margin and the tumour on the resected specimen.
..... DistanceToMarginMeasurement 0..1QuantityThe measurement of the distance between the given margin and the tumour on the resected specimen.
..... NatureOfTissueBetweenTumourAndMargin 0..1CodeableConceptThe type of tissue found between the tumour and given margin on the specimen.
..... MarginComments 0..1stringAdditional free text comments about the given margin on the resected specimen.
... SpecimenImageIncluded 0..1booleanA flag to indicate whether or not an image of the specimen is included.
... Image 0..1BackboneElementAn image of the patient's tumour, specimen, or radiology.
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... File 0..1AttachmentThe file containing the image.
.... Label 0..*stringA label describing the image in the file.
.... bool 0..1booleanBreastHistoSpecimen.Image.bool

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BreastHistoSpecimen-cs.Specimen.Collection.BodySite.BodyStructurepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
BreastHistoSpecimen-cs.ClinicalMarginStatus.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.MarginStatuspreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element (11 nested mandatory elements)

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. BreastHistoSpecimen-cs 0..*BaseSpecimen (breast histopathology)
Instances of this logical model are not marked to be the target of a Reference
... Specimen 1..1BackboneElementA sample to be used for analysis.
.... Id 0..*IdentifierAn identifier for the specimen, e.g. a barcode.
.... TumourIdentifier 0..*stringThe number or identifier used to reference the given lesion/tumour.
.... Category 0..1CodeableConceptThe category of specimen, e.g. biopsy specimen
.... Type 0..1CodeableConceptThe type of specimen, e.g. core biopsy specimen, lymph node excision specimen.
.... Qualifier 0..1CodeableConceptA qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified.
.... Collection 0..1BackboneElementDetails about the collection of the specimen.
..... Procedure 0..*CodeableConceptThe procedure used to collect the specimen, e.g. Partial mastectomy, Wide local excision, Lumpectomy, Hookwire excision
..... CollectionDate 0..1dateTimeThe date and/or time that the sample/specimen was collected.
..... collectedBy 0..1BackboneElementThe healthcare practitioner who collected the specimen.
...... PersonName 0..1BackboneElementPerson name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.
....... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
....... GivenName 0..1stringThe person’s forename or given name at birth
....... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
....... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
....... age 0..1stringBreastHistoSpecimen.Specimen.Collection.collectedBy.PersonName.age
...... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
....... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
...... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
....... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
....... RoleCode 1..1CodeableConceptThe designated the role of a health worker
....... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
....... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.
..... BodySite 0..1BackboneElementThe site from which the sample/specimen was collected.
...... BodyStructure 1..1CodeableConceptThe anatomical structure being described
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred)
...... BodyStructurePart 0..*CodeableConceptThe anatomical part of the body structure being described.
...... Clockface 0..1CodeableConceptThe clockface orientation from the landmark.
...... DistanceFromLandmark 0..1QuantityThe distance from the given landmark.
...... Comments 0..1CodeableConceptFree text comments describing the body site.
..... Technique 0..*CodeableConceptThe technique used to collect the specimen, e.g. Random specimen collection.
.... ContainerQuantity 0..1QuantityA count of the number of containers (e.g. 3 tubes, 4 slides, 1 bottle) in which the specimen is placed after collection.
.... Comments 0..1stringFree text comments about the specimen.
... SpecimenContainer 0..*BackboneElementAn individual container (e.g. a specific tube) in which the specimen is placed.
.... ContainerId 0..1IdentifierAn identifier for the individual specimen container.
.... SpecimenId 0..1IdentifierAn identifier for the specimen in the container.
.... Type 0..1CodeableConceptThe type of container used (e.g. slide, tube, bottle).
.... SpecimenQualifier 0..1CodeableConceptA qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified.
.... PreparationTechnique 0..*CodeableConceptBreastHistoSpecimen.SpecimenContainer.PreparationTechnique
.... MediumStatus 0..1CodeableConceptWhether or not the specimen is fresh or in a medium.
.... MediumType 0..1CodeableConceptThe type of medium used for the specimen in the container.
.... Quantity 0..1QuantityThe quantity of specimen (volume, weight or count of pieces/fragments) placed in this individual container.
... SpecimenOrientationMarkers 0..1BackboneElementOrientation markers of a tissue sample (used for excision/resection specimens).
.... SpecimenId 1..1IdentifierThe identifier of the specimen.
.... Technique 0..1CodeableConceptThe orientation marker technique used (e.g. surgical, radiological).
.... Type 0..1CodeableConceptThe type of orientation marker used (e.g. suture, clip).
.... OrientationMarker 0..*BackboneElementDetails about an individual specimen orientation marker.
..... Position 1..1CodeableConceptThe position of the orientation marker (e.g. superior, inferior)
..... Description 0..1stringA description of the marker at the given position.
.... Status 1..1CodeableConceptThe status of the observation
.... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
.... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
.... ResidualCancerStatus 0..1CodeableConceptWhether or not the margin of a resected specimen is involved in the tumour.
.... InvolvedMargins 0..1stringA free text description of the margins involved with respect to the tumour.
.... MarginDetail 0..*BackboneElementAny relevant details about margins on a resected specimen.
..... Status 1..1CodeableConceptThe status of the observation
..... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
..... SpecimenId 0..1IdentifierAn identifier of the specimen being observed.
..... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
..... Margin 1..1CodeableConceptThe type of margin observed.
..... MarginStatus 0..1CodeableConceptWhether or not this margin of the resected specimen is involved in the given tumour.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour (preferred)
..... MarginQualifier 0..*CodeableConceptAn additional qualification of the margin description, e.g. Proximal, Distal.
..... DistanceToMarginRange 0..1CodeableConceptThe distance range between the given margin and the tumour on the resected specimen.
..... DistanceToMarginMeasurement 0..1QuantityThe measurement of the distance between the given margin and the tumour on the resected specimen.
..... NatureOfTissueBetweenTumourAndMargin 0..1CodeableConceptThe type of tissue found between the tumour and given margin on the specimen.
..... MarginComments 0..1stringAdditional free text comments about the given margin on the resected specimen.
... SpecimenImageIncluded 0..1booleanA flag to indicate whether or not an image of the specimen is included.
... Image 0..1BackboneElementAn image of the patient's tumour, specimen, or radiology.
.... File 0..1AttachmentThe file containing the image.
.... Label 0..*stringA label describing the image in the file.
.... bool 0..1booleanBreastHistoSpecimen.Image.bool

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
BreastHistoSpecimen-cs.Specimen.Collection.BodySite.BodyStructurepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
BreastHistoSpecimen-cs.ClinicalMarginStatus.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.MarginStatuspreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. BreastHistoSpecimen-cs 0..*BaseSpecimen (breast histopathology)
Instances of this logical model are not marked to be the target of a Reference
... Specimen 1..1BackboneElementA sample to be used for analysis.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Id 0..*IdentifierAn identifier for the specimen, e.g. a barcode.
.... TumourIdentifier 0..*stringThe number or identifier used to reference the given lesion/tumour.
.... Category 0..1CodeableConceptThe category of specimen, e.g. biopsy specimen
.... Type 0..1CodeableConceptThe type of specimen, e.g. core biopsy specimen, lymph node excision specimen.
.... Qualifier 0..1CodeableConceptA qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified.
.... Collection 0..1BackboneElementDetails about the collection of the specimen.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Procedure 0..*CodeableConceptThe procedure used to collect the specimen, e.g. Partial mastectomy, Wide local excision, Lumpectomy, Hookwire excision
..... CollectionDate 0..1dateTimeThe date and/or time that the sample/specimen was collected.
..... collectedBy 0..1BackboneElementThe healthcare practitioner who collected the specimen.
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... PersonName 0..1BackboneElementPerson name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
....... GivenName 0..1stringThe person’s forename or given name at birth
....... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
....... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
....... age 0..1stringBreastHistoSpecimen.Specimen.Collection.collectedBy.PersonName.age
...... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
...... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
....... RoleCode 1..1CodeableConceptThe designated the role of a health worker
....... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
....... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.
..... BodySite 0..1BackboneElementThe site from which the sample/specimen was collected.
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... BodyStructure 1..1CodeableConceptThe anatomical structure being described
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred)
...... BodyStructurePart 0..*CodeableConceptThe anatomical part of the body structure being described.
...... Clockface 0..1CodeableConceptThe clockface orientation from the landmark.
...... DistanceFromLandmark 0..1QuantityThe distance from the given landmark.
...... Comments 0..1CodeableConceptFree text comments describing the body site.
..... Technique 0..*CodeableConceptThe technique used to collect the specimen, e.g. Random specimen collection.
.... ContainerQuantity 0..1QuantityA count of the number of containers (e.g. 3 tubes, 4 slides, 1 bottle) in which the specimen is placed after collection.
.... Comments 0..1stringFree text comments about the specimen.
... SpecimenContainer 0..*BackboneElementAn individual container (e.g. a specific tube) in which the specimen is placed.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ContainerId 0..1IdentifierAn identifier for the individual specimen container.
.... SpecimenId 0..1IdentifierAn identifier for the specimen in the container.
.... Type 0..1CodeableConceptThe type of container used (e.g. slide, tube, bottle).
.... SpecimenQualifier 0..1CodeableConceptA qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified.
.... PreparationTechnique 0..*CodeableConceptBreastHistoSpecimen.SpecimenContainer.PreparationTechnique
.... MediumStatus 0..1CodeableConceptWhether or not the specimen is fresh or in a medium.
.... MediumType 0..1CodeableConceptThe type of medium used for the specimen in the container.
.... Quantity 0..1QuantityThe quantity of specimen (volume, weight or count of pieces/fragments) placed in this individual container.
... SpecimenOrientationMarkers 0..1BackboneElementOrientation markers of a tissue sample (used for excision/resection specimens).
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... SpecimenId 1..1IdentifierThe identifier of the specimen.
.... Technique 0..1CodeableConceptThe orientation marker technique used (e.g. surgical, radiological).
.... Type 0..1CodeableConceptThe type of orientation marker used (e.g. suture, clip).
.... OrientationMarker 0..*BackboneElementDetails about an individual specimen orientation marker.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Position 1..1CodeableConceptThe position of the orientation marker (e.g. superior, inferior)
..... Description 0..1stringA description of the marker at the given position.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Status 1..1CodeableConceptThe status of the observation
.... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
.... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
.... ResidualCancerStatus 0..1CodeableConceptWhether or not the margin of a resected specimen is involved in the tumour.
.... InvolvedMargins 0..1stringA free text description of the margins involved with respect to the tumour.
.... MarginDetail 0..*BackboneElementAny relevant details about margins on a resected specimen.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Status 1..1CodeableConceptThe status of the observation
..... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
..... SpecimenId 0..1IdentifierAn identifier of the specimen being observed.
..... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
..... Margin 1..1CodeableConceptThe type of margin observed.
..... MarginStatus 0..1CodeableConceptWhether or not this margin of the resected specimen is involved in the given tumour.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour (preferred)
..... MarginQualifier 0..*CodeableConceptAn additional qualification of the margin description, e.g. Proximal, Distal.
..... DistanceToMarginRange 0..1CodeableConceptThe distance range between the given margin and the tumour on the resected specimen.
..... DistanceToMarginMeasurement 0..1QuantityThe measurement of the distance between the given margin and the tumour on the resected specimen.
..... NatureOfTissueBetweenTumourAndMargin 0..1CodeableConceptThe type of tissue found between the tumour and given margin on the specimen.
..... MarginComments 0..1stringAdditional free text comments about the given margin on the resected specimen.
... SpecimenImageIncluded 0..1booleanA flag to indicate whether or not an image of the specimen is included.
... Image 0..1BackboneElementAn image of the patient's tumour, specimen, or radiology.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... File 0..1AttachmentThe file containing the image.
.... Label 0..*stringA label describing the image in the file.
.... bool 0..1booleanBreastHistoSpecimen.Image.bool

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BreastHistoSpecimen-cs.Specimen.Collection.BodySite.BodyStructurepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
BreastHistoSpecimen-cs.ClinicalMarginStatus.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.MarginStatuspreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. BreastHistoSpecimen-cs 0..*BaseSpecimen (breast histopathology)
Instances of this logical model are not marked to be the target of a Reference
... Specimen 1..1BackboneElementA sample to be used for analysis.
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Id 0..*IdentifierAn identifier for the specimen, e.g. a barcode.
.... TumourIdentifier 0..*stringThe number or identifier used to reference the given lesion/tumour.
.... Category 0..1CodeableConceptThe category of specimen, e.g. biopsy specimen
.... Type 0..1CodeableConceptThe type of specimen, e.g. core biopsy specimen, lymph node excision specimen.
.... Qualifier 0..1CodeableConceptA qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified.
.... Collection 0..1BackboneElementDetails about the collection of the specimen.
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Procedure 0..*CodeableConceptThe procedure used to collect the specimen, e.g. Partial mastectomy, Wide local excision, Lumpectomy, Hookwire excision
..... CollectionDate 0..1dateTimeThe date and/or time that the sample/specimen was collected.
..... collectedBy 0..1BackboneElementThe healthcare practitioner who collected the specimen.
...... @id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... PersonName 0..1BackboneElementPerson name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
....... GivenName 0..1stringThe person’s forename or given name at birth
....... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
....... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
....... age 0..1stringBreastHistoSpecimen.Specimen.Collection.collectedBy.PersonName.age
...... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
...... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
....... RoleCode 1..1CodeableConceptThe designated the role of a health worker
....... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
....... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.
..... BodySite 0..1BackboneElementThe site from which the sample/specimen was collected.
...... @id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... BodyStructure 1..1CodeableConceptThe anatomical structure being described
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred)
...... BodyStructurePart 0..*CodeableConceptThe anatomical part of the body structure being described.
...... Clockface 0..1CodeableConceptThe clockface orientation from the landmark.
...... DistanceFromLandmark 0..1QuantityThe distance from the given landmark.
...... Comments 0..1CodeableConceptFree text comments describing the body site.
..... Technique 0..*CodeableConceptThe technique used to collect the specimen, e.g. Random specimen collection.
.... ContainerQuantity 0..1QuantityA count of the number of containers (e.g. 3 tubes, 4 slides, 1 bottle) in which the specimen is placed after collection.
.... Comments 0..1stringFree text comments about the specimen.
... SpecimenContainer 0..*BackboneElementAn individual container (e.g. a specific tube) in which the specimen is placed.
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ContainerId 0..1IdentifierAn identifier for the individual specimen container.
.... SpecimenId 0..1IdentifierAn identifier for the specimen in the container.
.... Type 0..1CodeableConceptThe type of container used (e.g. slide, tube, bottle).
.... SpecimenQualifier 0..1CodeableConceptA qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified.
.... PreparationTechnique 0..*CodeableConceptBreastHistoSpecimen.SpecimenContainer.PreparationTechnique
.... MediumStatus 0..1CodeableConceptWhether or not the specimen is fresh or in a medium.
.... MediumType 0..1CodeableConceptThe type of medium used for the specimen in the container.
.... Quantity 0..1QuantityThe quantity of specimen (volume, weight or count of pieces/fragments) placed in this individual container.
... SpecimenOrientationMarkers 0..1BackboneElementOrientation markers of a tissue sample (used for excision/resection specimens).
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... SpecimenId 1..1IdentifierThe identifier of the specimen.
.... Technique 0..1CodeableConceptThe orientation marker technique used (e.g. surgical, radiological).
.... Type 0..1CodeableConceptThe type of orientation marker used (e.g. suture, clip).
.... OrientationMarker 0..*BackboneElementDetails about an individual specimen orientation marker.
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Position 1..1CodeableConceptThe position of the orientation marker (e.g. superior, inferior)
..... Description 0..1stringA description of the marker at the given position.
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Status 1..1CodeableConceptThe status of the observation
.... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
.... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
.... ResidualCancerStatus 0..1CodeableConceptWhether or not the margin of a resected specimen is involved in the tumour.
.... InvolvedMargins 0..1stringA free text description of the margins involved with respect to the tumour.
.... MarginDetail 0..*BackboneElementAny relevant details about margins on a resected specimen.
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Status 1..1CodeableConceptThe status of the observation
..... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
..... SpecimenId 0..1IdentifierAn identifier of the specimen being observed.
..... TumourIdentifier 0..1IdentifierAn identifier for the tumour about which the observation is made.
..... Margin 1..1CodeableConceptThe type of margin observed.
..... MarginStatus 0..1CodeableConceptWhether or not this margin of the resected specimen is involved in the given tumour.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour (preferred)
..... MarginQualifier 0..*CodeableConceptAn additional qualification of the margin description, e.g. Proximal, Distal.
..... DistanceToMarginRange 0..1CodeableConceptThe distance range between the given margin and the tumour on the resected specimen.
..... DistanceToMarginMeasurement 0..1QuantityThe measurement of the distance between the given margin and the tumour on the resected specimen.
..... NatureOfTissueBetweenTumourAndMargin 0..1CodeableConceptThe type of tissue found between the tumour and given margin on the specimen.
..... MarginComments 0..1stringAdditional free text comments about the given margin on the resected specimen.
... SpecimenImageIncluded 0..1booleanA flag to indicate whether or not an image of the specimen is included.
... Image 0..1BackboneElementAn image of the patient's tumour, specimen, or radiology.
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... File 0..1AttachmentThe file containing the image.
.... Label 0..*stringA label describing the image in the file.
.... bool 0..1booleanBreastHistoSpecimen.Image.bool

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BreastHistoSpecimen-cs.Specimen.Collection.BodySite.BodyStructurepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography
BreastHistoSpecimen-cs.ClinicalMarginStatus.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
BreastHistoSpecimen-cs.ClinicalMarginStatus.MarginDetail.MarginStatuspreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-AJCC-residual-tumour

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element (11 nested mandatory elements)

 

Other representations of profile: CSV, Excel