minimal Common Oncology Data Elements (mCODE) Implementation Guide
1.16.0 - STU Release 2 (Ballot Version)

This page is part of the HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE) Release 1 - US Realm | STU1 (v1.16.0: STU 2 Ballot 1) based on FHIR R4. The current version which supercedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: Tumor Specimen

Defining URL:http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-tumor-specimen
Version:1.16.0
Name:TumorSpecimen
Title:Tumor Specimen
Status:Active as of 2021-04-15T12:44:45+00:00
Definition:

Represents a tumor after it has been removed from the body. Prior to excision, use Tumor (a BodyStructure) instead. If this tumor was represented by Tumor while still in the body, use identifier to associate with that resource.

Publisher:HL7 International Clinical Interoperability Council
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-tumor-specimen

Usage

Used to represent a tumor or portion of a tumor that has been removed from the body.

Conformance

Observation resources associated with an mCODE patient with an Specimen.type of TUMOR (from http://terminology.hl7.org/CodeSystem/v2-0487) MUST conform to this profile. Beyond this requirement, a producer of resources SHOULD ensure that any resource instance associated with an mCODE patient that would reasonably be expected to conform to this profile SHOULD be published in this form.

Formal Views of Profile Content

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

This structure is derived from Specimen

This structure is derived from Specimen

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... mcode-condition-related S0..1Reference(Condition)Cancer condition associated with this sample.
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-condition-related
.... value[x] 0..1Reference(Primary Cancer Condition | Secondary Cancer Condition)Value of extension
... identifier S0..*(Slice Definition)External Identifier
Slice: Unordered, Open by pattern:type
.... identifier:tumorIdentifier S0..*BodyStructureIdentifierIdentifier to associate this specimen with a specific Tumor
..... type S0..1CodeableConceptDescription of identifier
..... value S1..1stringThe value that is unique
... type S1..1CodeableConceptKind of material that forms the specimen
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0487
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: TUMOR
... subject S0..1Reference(Cancer Patient)Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
... collection S0..1BackboneElementCollection details
.... bodySite S0..1CodeableConceptAnatomical collection site
..... extension S0..*ExtensionExtension
..... mcode-location-qualifier S0..*CodeableConceptLocation Qualifier
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-location-qualifier
Binding: Location Qualifier Value Set (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... mcode-condition-related S0..1Reference(Condition)Cancer condition associated with this sample.
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-condition-related
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-condition-related"
.... value[x] 0..1Reference(Primary Cancer Condition | Secondary Cancer Condition)Value of extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*(Slice Definition)External Identifier
Slice: Unordered, Open by pattern:type
.... identifier:tumorIdentifier S0..*BodyStructureIdentifierIdentifier to associate this specimen with a specific Tumor
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: BodyStructure
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... accessionIdentifier Σ0..1IdentifierIdentifier assigned by the lab
... status ?!SΣ0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... type SΣ1..1CodeableConceptKind of material that forms the specimen
Binding: hl7VS-specimenType (example): The type of the specimen.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0487
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: TUMOR
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subject SΣ0..1Reference(Cancer Patient)Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
... receivedTime Σ0..1dateTimeThe time when specimen was received for processing
... parent 0..*Reference(Specimen)Specimen from which this specimen originated
... request 0..*Reference(ServiceRequest)Why the specimen was collected
... collection S0..1BackboneElementCollection details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... collector Σ0..1Reference(Practitioner | PractitionerRole)Who collected the specimen
.... collected[x] Σ0..1Collection time
..... collectedDateTimedateTime
..... collectedPeriodPeriod
.... duration Σ0..1DurationHow long it took to collect specimen
.... quantity 0..1SimpleQuantityThe quantity of specimen collected
.... method 0..1CodeableConceptTechnique used to perform collection
Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure.

.... bodySite S0..1CodeableConceptAnatomical collection site
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

..... id 0..1stringUnique id for inter-element referencing
..... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... mcode-location-qualifier S0..*CodeableConceptLocation Qualifier
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-location-qualifier
Binding: Location Qualifier Value Set (required)
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
.... fastingStatus[x] Σ0..1Whether or how long patient abstained from food and/or drink
Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient.

..... fastingStatusCodeableConceptCodeableConcept
..... fastingStatusDurationDuration
... processing 0..*BackboneElementProcessing and processing step details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 0..1stringTextual description of procedure
.... procedure 0..1CodeableConceptIndicates the treatment step applied to the specimen
Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen.

.... additive 0..*Reference(Substance)Material used in the processing step
.... time[x] 0..1Date and time of specimen processing
..... timeDateTimedateTime
..... timePeriodPeriod
... container 0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ0..*IdentifierId for the container
.... description 0..1stringTextual description of the container
.... type 0..1CodeableConceptKind of container directly associated with specimen
Binding: SpecimenContainerType (example): Type of specimen container.

.... capacity 0..1SimpleQuantityContainer volume or size
.... specimenQuantity 0..1SimpleQuantityQuantity of specimen within container
.... additive[x] 0..1Additive associated with container
Binding: hl7VS-additivePreservative (example): Substance added to specimen container.

..... additiveCodeableConceptCodeableConcept
..... additiveReferenceReference(Substance)
... condition Σ0..*CodeableConceptState of the specimen
Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen.


... note 0..*AnnotationComments

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... mcode-condition-related 0..1Reference(Condition)Cancer condition associated with this sample.
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-condition-related
... identifier Σ0..*(Slice Definition)External Identifier
Slice: Unordered, Open by pattern:type
.... identifier:tumorIdentifier 0..*BodyStructureIdentifierIdentifier to associate this specimen with a specific Tumor
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: BodyStructure
..... value Σ1..1stringThe value that is unique
... status ?!Σ0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0487
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: TUMOR
... subject Σ0..1Reference(Cancer Patient)Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
... collection 0..1BackboneElementCollection details
.... bodySite 0..1CodeableConceptAnatomical collection site
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... mcode-location-qualifier 0..*CodeableConceptLocation Qualifier
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-location-qualifier
Binding: Location Qualifier Value Set (required)

doco Documentation for this format

This structure is derived from Specimen

Differential View

This structure is derived from Specimen

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... mcode-condition-related S0..1Reference(Condition)Cancer condition associated with this sample.
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-condition-related
.... value[x] 0..1Reference(Primary Cancer Condition | Secondary Cancer Condition)Value of extension
... identifier S0..*(Slice Definition)External Identifier
Slice: Unordered, Open by pattern:type
.... identifier:tumorIdentifier S0..*BodyStructureIdentifierIdentifier to associate this specimen with a specific Tumor
..... type S0..1CodeableConceptDescription of identifier
..... value S1..1stringThe value that is unique
... type S1..1CodeableConceptKind of material that forms the specimen
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0487
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: TUMOR
... subject S0..1Reference(Cancer Patient)Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
... collection S0..1BackboneElementCollection details
.... bodySite S0..1CodeableConceptAnatomical collection site
..... extension S0..*ExtensionExtension
..... mcode-location-qualifier S0..*CodeableConceptLocation Qualifier
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-location-qualifier
Binding: Location Qualifier Value Set (required)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... mcode-condition-related S0..1Reference(Condition)Cancer condition associated with this sample.
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-condition-related
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-condition-related"
.... value[x] 0..1Reference(Primary Cancer Condition | Secondary Cancer Condition)Value of extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*(Slice Definition)External Identifier
Slice: Unordered, Open by pattern:type
.... identifier:tumorIdentifier S0..*BodyStructureIdentifierIdentifier to associate this specimen with a specific Tumor
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: BodyStructure
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... accessionIdentifier Σ0..1IdentifierIdentifier assigned by the lab
... status ?!SΣ0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... type SΣ1..1CodeableConceptKind of material that forms the specimen
Binding: hl7VS-specimenType (example): The type of the specimen.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0487
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: TUMOR
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subject SΣ0..1Reference(Cancer Patient)Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
... receivedTime Σ0..1dateTimeThe time when specimen was received for processing
... parent 0..*Reference(Specimen)Specimen from which this specimen originated
... request 0..*Reference(ServiceRequest)Why the specimen was collected
... collection S0..1BackboneElementCollection details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... collector Σ0..1Reference(Practitioner | PractitionerRole)Who collected the specimen
.... collected[x] Σ0..1Collection time
..... collectedDateTimedateTime
..... collectedPeriodPeriod
.... duration Σ0..1DurationHow long it took to collect specimen
.... quantity 0..1SimpleQuantityThe quantity of specimen collected
.... method 0..1CodeableConceptTechnique used to perform collection
Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure.

.... bodySite S0..1CodeableConceptAnatomical collection site
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

..... id 0..1stringUnique id for inter-element referencing
..... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... mcode-location-qualifier S0..*CodeableConceptLocation Qualifier
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-location-qualifier
Binding: Location Qualifier Value Set (required)
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
.... fastingStatus[x] Σ0..1Whether or how long patient abstained from food and/or drink
Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient.

..... fastingStatusCodeableConceptCodeableConcept
..... fastingStatusDurationDuration
... processing 0..*BackboneElementProcessing and processing step details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 0..1stringTextual description of procedure
.... procedure 0..1CodeableConceptIndicates the treatment step applied to the specimen
Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen.

.... additive 0..*Reference(Substance)Material used in the processing step
.... time[x] 0..1Date and time of specimen processing
..... timeDateTimedateTime
..... timePeriodPeriod
... container 0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ0..*IdentifierId for the container
.... description 0..1stringTextual description of the container
.... type 0..1CodeableConceptKind of container directly associated with specimen
Binding: SpecimenContainerType (example): Type of specimen container.

.... capacity 0..1SimpleQuantityContainer volume or size
.... specimenQuantity 0..1SimpleQuantityQuantity of specimen within container
.... additive[x] 0..1Additive associated with container
Binding: hl7VS-additivePreservative (example): Substance added to specimen container.

..... additiveCodeableConceptCodeableConcept
..... additiveReferenceReference(Substance)
... condition Σ0..*CodeableConceptState of the specimen
Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen.


... note 0..*AnnotationComments

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
Specimen.languagepreferredCommonLanguages
Max Binding: AllLanguages
Specimen.identifier:tumorIdentifier.userequiredPattern: usual
Specimen.identifier:tumorIdentifier.typeextensiblePattern: BodyStructure
Specimen.statusrequiredSpecimenStatus
Specimen.typeexamplePattern: TUMOR
Specimen.collection.methodexampleFHIRSpecimenCollectionMethod
Specimen.collection.bodySiteexampleSNOMEDCTBodyStructures
Specimen.collection.fastingStatus[x]extensibleHl7VSRelevantClincialInformation
Specimen.processing.procedureexampleSpecimenProcessingProcedure
Specimen.container.typeexampleSpecimenContainerType
Specimen.container.additive[x]exampleHl7VSAdditivePreservative
Specimen.conditionextensibleHl7VSSpecimenCondition