minimal Common Oncology Data Elements (mCODE) Implementation Guide, published by HL7 International / Clinical Interoperability Council. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-mCODE-ig/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-human-specimen | Version: 4.0.0-ballot | |||
Active as of 2024-10-30 | Maturity Level: 1 | Computable Name: HumanSpecimen | ||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.15.42.26 |
A specimen taken from a Patient for the purpose of oncology-related testing. The profile includes extensions to specify a more precise body site and an identifier of source body structure at that site (for example, a tumor identifier).
Usage:
Changes since version true:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreSpecimenProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | USCoreSpecimenProfile | |||
Slices for identifier | S | 0..* | Identifier | External Identifier Slice: Unordered, Open by pattern:type |
identifier:bodyStructureIdentifier | S | 0..* | BodyStructureIdentifier | An identifier associating the specimen with a identified body structure, such as a tumor with a tumor identifier. |
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 | 1..1 | CodeableConcept | (USCDI) Kind of material that forms the specimen Binding: Human Specimen Type Value Set (extensible) | |
subject | 0..1 | Reference(Cancer Patient Profile) | (USCDI) The patient where the specimen came from. | |
collection | S | 0..1 | BackboneElement | Collection details |
bodySite | S | 0..1 | CodeableConcept | Anatomical collection site |
extension | S | 0..* | Extension | Extension |
Slices for extension | Content/Rules for all slices | |||
locationQualifier | S | 0..* | CodeableConcept | General location qualifier (excluding laterality) for this bodySite 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 for this bodySite URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-laterality-qualifier Binding: Laterality Qualifier Value Set (required) |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Specimen.type | extensible | HumanSpecimenTypeVShttp://hl7.org/fhir/us/mcode/ValueSet/mcode-human-specimen-type-vs from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | USCoreSpecimenProfile | Sample for analysis | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣ | 0..* | Identifier | External Identifier Slice: Unordered, Open by pattern:type |
identifier:bodyStructureIdentifier | S | 0..* | BodyStructureIdentifier | An identifier associating the specimen with a identified body structure, such as a tumor with a tumor identifier. |
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 | (USCDI) Kind of material that forms the specimen Binding: Human Specimen Type Value Set (extensible) |
subject | SΣ | 0..1 | Reference(Cancer Patient Profile) | (USCDI) The patient where the specimen came from. |
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 | General location qualifier (excluding laterality) for this bodySite 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 for this bodySite 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 | URI |
Specimen.identifier:bodyStructureIdentifier.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Specimen.identifier:bodyStructureIdentifier.type | extensible | Pattern: BodyStructurehttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard | |
Specimen.type | extensible | HumanSpecimenTypeVShttp://hl7.org/fhir/us/mcode/ValueSet/mcode-human-specimen-type-vs from this IG | |
Specimen.collection.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Specimen | 0..* | USCoreSpecimenProfile | 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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣ | 0..* | Identifier | External Identifier Slice: Unordered, Open by pattern:type | ||||
identifier:bodyStructureIdentifier | S | 0..* | BodyStructureIdentifier | An identifier associating the specimen with a identified body structure, such as a tumor with a tumor identifier. | ||||
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 | (USCDI) Kind of material that forms the specimen Binding: Human Specimen Type Value Set (extensible) | ||||
subject | SΣ | 0..1 | Reference(Cancer Patient Profile) | (USCDI) The patient where the specimen came from. | ||||
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 | General location qualifier (excluding laterality) for this bodySite 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 for this bodySite 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 | URI | |||
Specimen.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Specimen.identifier:bodyStructureIdentifier.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Specimen.identifier:bodyStructureIdentifier.type | extensible | Pattern: BodyStructurehttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard | ||||
Specimen.type | extensible | HumanSpecimenTypeVShttp://hl7.org/fhir/us/mcode/ValueSet/mcode-human-specimen-type-vs from this IG | ||||
Specimen.collection.method | example | FHIRSpecimenCollectionMethodhttp://hl7.org/fhir/ValueSet/specimen-collection-method from the FHIR Standard | ||||
Specimen.collection.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformationhttp://terminology.hl7.org/ValueSet/v2-0916 | ||||
Specimen.processing.procedure | example | SpecimenProcessingProcedurehttp://hl7.org/fhir/ValueSet/specimen-processing-procedure from the FHIR Standard | ||||
Specimen.container.type | example | SpecimenContainerTypehttp://hl7.org/fhir/ValueSet/specimen-container-type from the FHIR Standard | ||||
Specimen.container.additive[x] | example | Hl7VSAdditivePreservativehttp://terminology.hl7.org/ValueSet/v2-0371 | ||||
Specimen.condition | extensible | Hl7VSSpecimenConditionhttp://terminology.hl7.org/ValueSet/v2-0493 |
This structure is derived from USCoreSpecimenProfile
Summary
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
Differential View
This structure is derived from USCoreSpecimenProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | USCoreSpecimenProfile | |||
Slices for identifier | S | 0..* | Identifier | External Identifier Slice: Unordered, Open by pattern:type |
identifier:bodyStructureIdentifier | S | 0..* | BodyStructureIdentifier | An identifier associating the specimen with a identified body structure, such as a tumor with a tumor identifier. |
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 | 1..1 | CodeableConcept | (USCDI) Kind of material that forms the specimen Binding: Human Specimen Type Value Set (extensible) | |
subject | 0..1 | Reference(Cancer Patient Profile) | (USCDI) The patient where the specimen came from. | |
collection | S | 0..1 | BackboneElement | Collection details |
bodySite | S | 0..1 | CodeableConcept | Anatomical collection site |
extension | S | 0..* | Extension | Extension |
Slices for extension | Content/Rules for all slices | |||
locationQualifier | S | 0..* | CodeableConcept | General location qualifier (excluding laterality) for this bodySite 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 for this bodySite URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-laterality-qualifier Binding: Laterality Qualifier Value Set (required) |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Specimen.type | extensible | HumanSpecimenTypeVShttp://hl7.org/fhir/us/mcode/ValueSet/mcode-human-specimen-type-vs from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | USCoreSpecimenProfile | Sample for analysis | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣ | 0..* | Identifier | External Identifier Slice: Unordered, Open by pattern:type |
identifier:bodyStructureIdentifier | S | 0..* | BodyStructureIdentifier | An identifier associating the specimen with a identified body structure, such as a tumor with a tumor identifier. |
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 | (USCDI) Kind of material that forms the specimen Binding: Human Specimen Type Value Set (extensible) |
subject | SΣ | 0..1 | Reference(Cancer Patient Profile) | (USCDI) The patient where the specimen came from. |
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 | General location qualifier (excluding laterality) for this bodySite 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 for this bodySite 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 | URI |
Specimen.identifier:bodyStructureIdentifier.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Specimen.identifier:bodyStructureIdentifier.type | extensible | Pattern: BodyStructurehttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard | |
Specimen.type | extensible | HumanSpecimenTypeVShttp://hl7.org/fhir/us/mcode/ValueSet/mcode-human-specimen-type-vs from this IG | |
Specimen.collection.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Specimen | 0..* | USCoreSpecimenProfile | 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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣ | 0..* | Identifier | External Identifier Slice: Unordered, Open by pattern:type | ||||
identifier:bodyStructureIdentifier | S | 0..* | BodyStructureIdentifier | An identifier associating the specimen with a identified body structure, such as a tumor with a tumor identifier. | ||||
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 | (USCDI) Kind of material that forms the specimen Binding: Human Specimen Type Value Set (extensible) | ||||
subject | SΣ | 0..1 | Reference(Cancer Patient Profile) | (USCDI) The patient where the specimen came from. | ||||
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 | General location qualifier (excluding laterality) for this bodySite 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 for this bodySite 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 | URI | |||
Specimen.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Specimen.identifier:bodyStructureIdentifier.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Specimen.identifier:bodyStructureIdentifier.type | extensible | Pattern: BodyStructurehttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard | ||||
Specimen.type | extensible | HumanSpecimenTypeVShttp://hl7.org/fhir/us/mcode/ValueSet/mcode-human-specimen-type-vs from this IG | ||||
Specimen.collection.method | example | FHIRSpecimenCollectionMethodhttp://hl7.org/fhir/ValueSet/specimen-collection-method from the FHIR Standard | ||||
Specimen.collection.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformationhttp://terminology.hl7.org/ValueSet/v2-0916 | ||||
Specimen.processing.procedure | example | SpecimenProcessingProcedurehttp://hl7.org/fhir/ValueSet/specimen-processing-procedure from the FHIR Standard | ||||
Specimen.container.type | example | SpecimenContainerTypehttp://hl7.org/fhir/ValueSet/specimen-container-type from the FHIR Standard | ||||
Specimen.container.additive[x] | example | Hl7VSAdditivePreservativehttp://terminology.hl7.org/ValueSet/v2-0371 | ||||
Specimen.condition | extensible | Hl7VSSpecimenConditionhttp://terminology.hl7.org/ValueSet/v2-0493 |
This structure is derived from USCoreSpecimenProfile
Summary
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron