This page is part of the HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE) Release 1 - US Realm | STU1 (v2.1.0: STU 2) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-tumor-specimen | Version: 2.1.0 | |||
Active as of 2023-03-21 | Computable Name: TumorSpecimen |
Represents a tumor after it has been removed from the body. If there is a Tumor resource representing the tumor before it was removed from the body, use identifier
to associate this TumorSpecimen with that Tumor resource.
Used to represent a tumor or portion of a tumor that has been removed from the body.
To associate this with a specific BodyStructure conforming to the Tumor profile, add an identifier with a value that matches a persistent identifier from BodyStructure.identifier.value
that is unique in the context of the Patient.
Observation resources associated with an in-scope 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 in-scope patient that would reasonably be expected to conform to this profile SHOULD be published in this form.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Specimen
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | Specimen | Sample for analysis | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
relatedCondition | S | 0..1 | Reference(Condition) | Cancer condition associated with this specimen. URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-related-condition |
value[x] | 1..1 | Reference(Primary Cancer Condition Profile | Secondary Cancer Condition Profile) | Value of extension | |
Slices for identifier | S | 0..* | Identifier | External Identifier Slice: Unordered, Open by pattern:type |
identifier:tumorIdentifier | S | 0..* | BodyStructureIdentifier | Identifier to associate this specimen with a specific Tumor |
type | S | 0..1 | CodeableConcept | Description of identifier |
value | S | 1..1 | string | The value that is unique |
status | S | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error |
type | S | 1..1 | CodeableConcept | Kind of material that forms the specimen Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0487 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: TUMOR | |
subject | S | 0..1 | Reference(Cancer Patient Profile) | 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 | S | 0..1 | BackboneElement | Collection details |
bodySite | S | 0..1 | CodeableConcept | Anatomical collection site |
extension | S | 0..* | Extension | Extension |
locationQualifier | S | 0..* | CodeableConcept | Body Location Qualifier Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-body-location-qualifier Binding: Body Location Qualifier Value Set (required) |
lateralityQualifier | S | 0..1 | CodeableConcept | Laterality Qualifier Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-laterality-qualifier Binding: Laterality Qualifier Value Set (required) |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | Specimen | Sample for analysis | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
relatedCondition | S | 0..1 | Reference(Condition) | Cancer condition associated with this specimen. URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-related-condition |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-related-condition" | |
value[x] | 1..1 | Reference(Primary Cancer Condition Profile | Secondary Cancer Condition Profile) | Value of extension | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣ | 0..* | Identifier | External Identifier Slice: Unordered, Open by pattern:type |
identifier:tumorIdentifier | S | 0..* | BodyStructureIdentifier | Identifier to associate this specimen with a specific Tumor |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual |
type | SΣ | 0..1 | CodeableConcept | Description 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 |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/resource-types | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: BodyStructure | |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
status | ?!SΣ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. |
type | SΣ | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0487 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: TUMOR | |
subject | SΣ | 0..1 | Reference(Cancer Patient Profile) | 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 | S | 0..1 | BackboneElement | Collection details |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
bodySite | S | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
locationQualifier | S | 0..* | CodeableConcept | Body Location Qualifier Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-body-location-qualifier Binding: Body Location Qualifier Value Set (required) |
lateralityQualifier | S | 0..1 | CodeableConcept | Laterality Qualifier Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-laterality-qualifier Binding: Laterality Qualifier Value Set (required) |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Specimen.identifier:tumorIdentifier.use | required | Pattern: usual |
Specimen.identifier:tumorIdentifier.type | extensible | Pattern: BodyStructure |
Specimen.status | required | SpecimenStatus |
Specimen.type | example | Pattern: TUMOR |
Specimen.collection.bodySite | example | SNOMEDCTBodyStructures |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Specimen | 0..* | Specimen | Sample for analysis | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
relatedCondition | S | 0..1 | Reference(Condition) | Cancer condition associated with this specimen. URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-related-condition | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-related-condition" | |||||
value[x] | 1..1 | Reference(Primary Cancer Condition Profile | Secondary Cancer Condition Profile) | Value of extension | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣ | 0..* | Identifier | External Identifier Slice: Unordered, Open by pattern:type | ||||
identifier:tumorIdentifier | S | 0..* | BodyStructureIdentifier | Identifier to associate this specimen with a specific Tumor | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual | ||||
type | SΣ | 0..1 | CodeableConcept | Description 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 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/resource-types | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: BodyStructure | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
accessionIdentifier | Σ | 0..1 | Identifier | Identifier assigned by the lab | ||||
status | ?!SΣ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||
type | SΣ | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0487 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: TUMOR | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
subject | SΣ | 0..1 | Reference(Cancer Patient Profile) | 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..1 | dateTime | The 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 | S | 0..1 | BackboneElement | Collection details | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
collector | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen | ||||
collected[x] | Σ | 0..1 | Collection time | |||||
collectedDateTime | dateTime | |||||||
collectedPeriod | Period | |||||||
duration | Σ | 0..1 | Duration | How long it took to collect specimen | ||||
quantity | 0..1 | SimpleQuantity | The quantity of specimen collected | |||||
method | 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
bodySite | S | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
locationQualifier | S | 0..* | CodeableConcept | Body Location Qualifier Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-body-location-qualifier Binding: Body Location Qualifier Value Set (required) | ||||
lateralityQualifier | S | 0..1 | CodeableConcept | Laterality Qualifier Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-laterality-qualifier Binding: Laterality Qualifier Value Set (required) | ||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
fastingStatus[x] | Σ | 0..1 | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient. | |||||
fastingStatusCodeableConcept | CodeableConcept | |||||||
fastingStatusDuration | Duration | |||||||
processing | 0..* | BackboneElement | Processing and processing step details | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
description | 0..1 | string | Textual description of procedure | |||||
procedure | 0..1 | CodeableConcept | Indicates 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..1 | Date and time of specimen processing | ||||||
timeDateTime | dateTime | |||||||
timePeriod | Period | |||||||
container | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
identifier | Σ | 0..* | Identifier | Id for the container | ||||
description | 0..1 | string | Textual description of the container | |||||
type | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainerType (example): Type of specimen container. | |||||
capacity | 0..1 | SimpleQuantity | Container volume or size | |||||
specimenQuantity | 0..1 | SimpleQuantity | Quantity of specimen within container | |||||
additive[x] | 0..1 | Additive associated with container Binding: hl7VS-additivePreservative (example): Substance added to specimen container. | ||||||
additiveCodeableConcept | CodeableConcept | |||||||
additiveReference | Reference(Substance) | |||||||
condition | Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | ||||
note | 0..* | Annotation | Comments | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Specimen.language | preferred | CommonLanguages
| ||||
Specimen.identifier:tumorIdentifier.use | required | Pattern: usual | ||||
Specimen.identifier:tumorIdentifier.type | extensible | Pattern: BodyStructure | ||||
Specimen.status | required | SpecimenStatus | ||||
Specimen.type | example | Pattern: TUMOR | ||||
Specimen.collection.method | example | FHIRSpecimenCollectionMethod | ||||
Specimen.collection.bodySite | example | SNOMEDCTBodyStructures | ||||
Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformation | ||||
Specimen.processing.procedure | example | SpecimenProcessingProcedure | ||||
Specimen.container.type | example | SpecimenContainerType | ||||
Specimen.container.additive[x] | example | Hl7VSAdditivePreservative | ||||
Specimen.condition | extensible | Hl7VSSpecimenCondition |
This structure is derived from Specimen
Summary
Mandatory: 1 element
Must-Support: 13 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Specimen
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | Specimen | Sample for analysis | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
relatedCondition | S | 0..1 | Reference(Condition) | Cancer condition associated with this specimen. URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-related-condition |
value[x] | 1..1 | Reference(Primary Cancer Condition Profile | Secondary Cancer Condition Profile) | Value of extension | |
Slices for identifier | S | 0..* | Identifier | External Identifier Slice: Unordered, Open by pattern:type |
identifier:tumorIdentifier | S | 0..* | BodyStructureIdentifier | Identifier to associate this specimen with a specific Tumor |
type | S | 0..1 | CodeableConcept | Description of identifier |
value | S | 1..1 | string | The value that is unique |
status | S | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error |
type | S | 1..1 | CodeableConcept | Kind of material that forms the specimen Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0487 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: TUMOR | |
subject | S | 0..1 | Reference(Cancer Patient Profile) | 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 | S | 0..1 | BackboneElement | Collection details |
bodySite | S | 0..1 | CodeableConcept | Anatomical collection site |
extension | S | 0..* | Extension | Extension |
locationQualifier | S | 0..* | CodeableConcept | Body Location Qualifier Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-body-location-qualifier Binding: Body Location Qualifier Value Set (required) |
lateralityQualifier | S | 0..1 | CodeableConcept | Laterality Qualifier Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-laterality-qualifier Binding: Laterality Qualifier Value Set (required) |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | Specimen | Sample for analysis | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
relatedCondition | S | 0..1 | Reference(Condition) | Cancer condition associated with this specimen. URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-related-condition |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-related-condition" | |
value[x] | 1..1 | Reference(Primary Cancer Condition Profile | Secondary Cancer Condition Profile) | Value of extension | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣ | 0..* | Identifier | External Identifier Slice: Unordered, Open by pattern:type |
identifier:tumorIdentifier | S | 0..* | BodyStructureIdentifier | Identifier to associate this specimen with a specific Tumor |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual |
type | SΣ | 0..1 | CodeableConcept | Description 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 |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/resource-types | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: BodyStructure | |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
status | ?!SΣ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. |
type | SΣ | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0487 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: TUMOR | |
subject | SΣ | 0..1 | Reference(Cancer Patient Profile) | 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 | S | 0..1 | BackboneElement | Collection details |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
bodySite | S | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
locationQualifier | S | 0..* | CodeableConcept | Body Location Qualifier Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-body-location-qualifier Binding: Body Location Qualifier Value Set (required) |
lateralityQualifier | S | 0..1 | CodeableConcept | Laterality Qualifier Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-laterality-qualifier Binding: Laterality Qualifier Value Set (required) |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Specimen.identifier:tumorIdentifier.use | required | Pattern: usual |
Specimen.identifier:tumorIdentifier.type | extensible | Pattern: BodyStructure |
Specimen.status | required | SpecimenStatus |
Specimen.type | example | Pattern: TUMOR |
Specimen.collection.bodySite | example | SNOMEDCTBodyStructures |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Specimen | 0..* | Specimen | Sample for analysis | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
relatedCondition | S | 0..1 | Reference(Condition) | Cancer condition associated with this specimen. URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-related-condition | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-related-condition" | |||||
value[x] | 1..1 | Reference(Primary Cancer Condition Profile | Secondary Cancer Condition Profile) | Value of extension | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣ | 0..* | Identifier | External Identifier Slice: Unordered, Open by pattern:type | ||||
identifier:tumorIdentifier | S | 0..* | BodyStructureIdentifier | Identifier to associate this specimen with a specific Tumor | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual | ||||
type | SΣ | 0..1 | CodeableConcept | Description 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 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/resource-types | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: BodyStructure | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
accessionIdentifier | Σ | 0..1 | Identifier | Identifier assigned by the lab | ||||
status | ?!SΣ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||
type | SΣ | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0487 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: TUMOR | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
subject | SΣ | 0..1 | Reference(Cancer Patient Profile) | 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..1 | dateTime | The 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 | S | 0..1 | BackboneElement | Collection details | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
collector | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen | ||||
collected[x] | Σ | 0..1 | Collection time | |||||
collectedDateTime | dateTime | |||||||
collectedPeriod | Period | |||||||
duration | Σ | 0..1 | Duration | How long it took to collect specimen | ||||
quantity | 0..1 | SimpleQuantity | The quantity of specimen collected | |||||
method | 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
bodySite | S | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
locationQualifier | S | 0..* | CodeableConcept | Body Location Qualifier Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-body-location-qualifier Binding: Body Location Qualifier Value Set (required) | ||||
lateralityQualifier | S | 0..1 | CodeableConcept | Laterality Qualifier Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-laterality-qualifier Binding: Laterality Qualifier Value Set (required) | ||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
fastingStatus[x] | Σ | 0..1 | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient. | |||||
fastingStatusCodeableConcept | CodeableConcept | |||||||
fastingStatusDuration | Duration | |||||||
processing | 0..* | BackboneElement | Processing and processing step details | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
description | 0..1 | string | Textual description of procedure | |||||
procedure | 0..1 | CodeableConcept | Indicates 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..1 | Date and time of specimen processing | ||||||
timeDateTime | dateTime | |||||||
timePeriod | Period | |||||||
container | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
identifier | Σ | 0..* | Identifier | Id for the container | ||||
description | 0..1 | string | Textual description of the container | |||||
type | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainerType (example): Type of specimen container. | |||||
capacity | 0..1 | SimpleQuantity | Container volume or size | |||||
specimenQuantity | 0..1 | SimpleQuantity | Quantity of specimen within container | |||||
additive[x] | 0..1 | Additive associated with container Binding: hl7VS-additivePreservative (example): Substance added to specimen container. | ||||||
additiveCodeableConcept | CodeableConcept | |||||||
additiveReference | Reference(Substance) | |||||||
condition | Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | ||||
note | 0..* | Annotation | Comments | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Specimen.language | preferred | CommonLanguages
| ||||
Specimen.identifier:tumorIdentifier.use | required | Pattern: usual | ||||
Specimen.identifier:tumorIdentifier.type | extensible | Pattern: BodyStructure | ||||
Specimen.status | required | SpecimenStatus | ||||
Specimen.type | example | Pattern: TUMOR | ||||
Specimen.collection.method | example | FHIRSpecimenCollectionMethod | ||||
Specimen.collection.bodySite | example | SNOMEDCTBodyStructures | ||||
Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformation | ||||
Specimen.processing.procedure | example | SpecimenProcessingProcedure | ||||
Specimen.container.type | example | SpecimenContainerType | ||||
Specimen.container.additive[x] | example | Hl7VSAdditivePreservative | ||||
Specimen.condition | extensible | Hl7VSSpecimenCondition |
This structure is derived from Specimen
Summary
Mandatory: 1 element
Must-Support: 13 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron