nci-cidc-api-modules 1.2.16__py3-none-any.whl → 1.2.25__py3-none-any.whl

cidc_api/models/pydantic/stage2/medical_history.py

@@ -0,0 +1,36 @@
+from typing import Self
+
+from pydantic import NonNegativeInt, PositiveFloat, model_validator
+
+from .base import Base
+from cidc_api.models.types import TobaccoSmokingStatus
+
+
+class MedicalHistory(Base):
+    __data_category__ = "medical_history"
+    __cardinality__ = "one"
+
+    # A unique internal identifier for the medical history
+    medical_history_id: int | None = None
+
+    # The unique identifier for the associated participant
+    participant_id: int | None = None
+
+    # Text representation of a person's status relative to smoking tobacco in the form of cigarettes,
+    # based on questions about current and former use of cigarettes.
+    # CDE: https://cadsr.cancer.gov/onedata/dmdirect/NIH/NCI/CO/CDEDD?filter=CDEDD.ITEM_ID=16333929%20and%20ver_nr=1
+    tobacco_smoking_status: TobaccoSmokingStatus | None = None
+
+    # Average number of packs of cigarettes smoked per day multiplied by number of years the participant has smoked.
+    # CDE: https://cadsr.cancer.gov/onedata/dmdirect/NIH/NCI/CO/CDEDD?filter=CDEDD.ITEM_ID=6841869%20and%20ver_nr=1
+    pack_years_smoked: PositiveFloat | None = None
+
+    # Number of prior systemic therapies.
+    # CDE: https://cadsr.cancer.gov/onedata/dmdirect/NIH/NCI/CO/CDEDD?filter=CDEDD.ITEM_ID=16089302%20and%20ver_nr=1
+    num_prior_systemic_therapies: NonNegativeInt | None = None
+
+    @model_validator(mode="after")
+    def validate_pack_years_smoked_cr(self) -> Self:
+        if self.tobacco_smoking_status in ["Never Smoker", "Unknown", "Not reported"] and self.pack_years_smoked:
+            raise ValueError("If tobacco_smoking_status indicates non-smoker, please leave pack_years_smoked blank.")
+        return self

cidc_api/models/pydantic/stage2/other_clinical_endpoint.py

@@ -0,0 +1,32 @@
+from .base import Base
+from cidc_api.models.types import YNU, ResponseSystem, ResponseSystemVersion
+
+
+class OtherClinicalEndpoint(Base):
+
+    # The unique internal identifier for the other clinical endpoint
+    other_clinical_endpoint_id: int | None = None
+
+    # The unique internal identifier for the associated participant
+    participant_id: int | None = None
+
+    # The name of the clinical endpoint. e.g. "iPFS"
+    name: str
+
+    # Whether the event that defines the clinical endpoint occurred
+    event: YNU
+
+    # The number of days to the occurrence of the event
+    days: int | None = None
+
+    # A description of this clinical endpoint
+    description: str | None = None
+
+    # The formula used to calculate the clinical endpoint criteria
+    calculation: str | None = None
+
+    # The response system used to define the clinical endpoint criteria. e.g. "RECIST"
+    response_system: ResponseSystem | None = None
+
+    # The version of the system used to define the clinical endpoint criteria.
+    response_system_version: ResponseSystemVersion | None = None

cidc_api/models/pydantic/stage2/other_malignancy.py

@@ -0,0 +1,45 @@
+from typing import Self
+
+from pydantic import NonPositiveInt, model_validator
+
+from .base import Base
+from cidc_api.models.types import UberonAnatomicalTerm, ICDO3MorphologicalCode, ICDO3MorphologicalTerm, MalignancyStatus
+
+
+class OtherMalignancy(Base):
+    __data_category__ = "other_malignancy"
+    __cardinality__ = "many"
+
+    # The unique internal identifier for the OtherMalignancy record
+    other_malignancy_id: int | None = None
+
+    # The unique internal identifier for the associated MedicalHistory record
+    medical_history_id: int | None = None
+
+    # The location within the body from where the prior malignancy originated as captured in the Uberon anatomical term.
+    primary_disease_site: UberonAnatomicalTerm
+
+    # The ICD-O-3 code which identifies the specific appearance of cells and tissues (normal and abnormal) used
+    # to define the presence and nature of disease.
+    morphological_code: ICDO3MorphologicalCode | None = None
+
+    # The ICD-O-3 textual label which identifies the specific appearance of cells and tissues (normal and abnormal) used
+    # to define the presence and nature of disease.
+    morphological_term: ICDO3MorphologicalTerm | None = None
+
+    # Description of the cancer type as recorded in the trial.
+    malignancy_description: str | None = None
+
+    # Number of days since original diagnosis from the enrollment date. This may be a negative number.
+    days_since_diagnosis: NonPositiveInt | None = None
+
+    # Indicates the participant’s current clinical state regarding the cancer diagnosis.
+    malignancy_status: MalignancyStatus | None = None
+
+    @model_validator(mode="after")
+    def validate_code_or_term_or_description_cr(self) -> Self:
+        if not self.morphological_code and not self.morphological_term and not self.malignancy_description:
+            raise ValueError(
+                'Please provide at least one of "morphological_code", "morphological_term" or "malignancy_description".'
+            )
+        return self

cidc_api/models/pydantic/stage2/participant.py

@@ -0,0 +1,47 @@
+from typing import Self
+
+from pydantic import model_validator
+
+from .base import Base
+from cidc_api.models.types import OffStudyReason
+
+
+class Participant(Base):
+    __data_category__ = "participant"
+    __cardinality__ = "one"
+
+    # The unique internal identifier for the participant
+    # CDE: https://cadsr.cancer.gov/onedata/dmdirect/NIH/NCI/CO/CDEDD?filter=CDEDD.ITEM_ID=12220014%20and%20ver_nr=1
+    participant_id: int | None = None
+
+    # The participant identifier assigned by the clinical trial team overseeing the study
+    native_participant_id: str
+
+    # The globally unique participant identifier assigned by the CIMAC network. e.g. C8P29A7
+    cimac_participant_id: str
+
+    # The unique identifier for the associated trial that the participant is participating in
+    trial_id: int | None = None
+
+    # Indicates if the individual is no longer actively participating in the clinical trial.
+    # CDE: https://cadsr.cancer.gov/onedata/dmdirect/NIH/NCI/CO/CDEDD?filter=CDEDD.ITEM_ID=14834973%20and%20ver_nr=1
+    off_study: bool
+
+    # An explanation describing why an individual is no longer participating in the clinical trial.
+    # CDE: https://cadsr.cancer.gov/onedata/dmdirect/NIH/NCI/CO/CDEDD?filter=CDEDD.ITEM_ID=13362265%20and%20ver_nr=1
+    off_study_reason: OffStudyReason | None = None
+
+    # Additional information if "Other" is selected for off_study_reason. e.g. "Transfer to another study"
+    off_study_reason_other: str | None = None
+
+    @model_validator(mode="after")
+    def off_study_reason_cr(self) -> Self:
+        if self.off_study and not self.off_study_reason:
+            raise ValueError('If "off_study" is "Yes" then "off_study_reason" is required.')
+        return self
+
+    @model_validator(mode="after")
+    def off_study_reason_other_cr(self) -> Self:
+        if self.off_study_reason == "Other" and not self.off_study_reason_other:
+            raise ValueError('If "off_study_reason" is "Other" then "off_study_reason_other" is required.')
+        return self

cidc_api/models/pydantic/stage2/prior_treatment.py

@@ -0,0 +1,52 @@
+from typing import Self
+
+from pydantic import NonPositiveInt, NonNegativeInt, model_validator
+
+from .base import Base
+from cidc_api.models.types import PriorTreatmentType, ConditioningRegimenType, StemCellDonorType
+
+
+class PriorTreatment(Base):
+    __data_category__ = "prior_treatment"
+    __cardinality__ = "many"
+
+    # A unique internal identifier for the prior treatment record
+    prior_treatment_id: int | None = None
+
+    # A unique internal identifier for the associated participant record
+    participant_id: int | None = None
+
+    # Number of days from the enrollment date to the first recorded administration or occurrence of
+    # the treatment modality.
+    days_to_start: NonPositiveInt | None = None
+
+    # Number of days from the enrollment date to the last recorded administration or occurrence of
+    # the treatment modality.
+    days_to_end: NonPositiveInt | None = None
+
+    # Specifies the category or kind of prior treatment modality a participant received.
+    type: PriorTreatmentType
+
+    # Description of the prior treatment such as its full generic name if it is a type of therapy agent,
+    # radiotherapy procedure name and location, or surgical procedure name and location.
+    description: str | None = None
+
+    # Best response from any response assessment system to the prior treatment if available or applicable.
+    best_response: str | None = None
+
+    # If the prior treatment is "Conditioning therapy" received before a stem cell transplant, specifies what
+    # type of conditioning regimen used.
+    conditioning_regimen_type: ConditioningRegimenType | None = None
+
+    # If prior treatment is "Stem cell transplant", indicates what stem cell donor type used.
+    stem_cell_donor_type: StemCellDonorType | None = None
+
+    # If prior treatment is "Stem cell transplant", indicates the number of days from the transplant
+    # date to the start of the current treatment.
+    days_from_transplant_to_treatment_initiation: NonNegativeInt | None = None
+
+    @model_validator(mode="after")
+    def validate_description_cr(self) -> Self:
+        if self.type == "Other therapy" and not self.description:
+            raise ValueError('If type is "Other therapy", please provide description.')
+        return self

cidc_api/models/pydantic/stage2/publication.py

@@ -0,0 +1,37 @@
+from .base import Base
+
+
+class Publication(Base):
+    # The unique internal identifier for the Publication record
+    publication_id: int | None = None
+
+    # The unique internal identifier for the associated Trial record
+    trial_id: int | None = None
+
+    # The version number of the trial dataset
+    version: str | None = None
+
+    # The digital object identifier string. www.doi.org. e.g. 10.47366/sabia.v5n1a3
+    # CDE: https://cadsr.cancer.gov/onedata/dmdirect/NIH/NCI/CO/CDEDD?filter=CDEDD.ITEM_ID=15915370%20and%20ver_nr=1
+    digital_object_id: str
+
+    # The pubmed identifier string. pubmed.ncbi.nlm.nih.gov. e.g. 41135560
+    # CDE: https://cadsr.cancer.gov/onedata/dmdirect/NIH/NCI/CO/CDEDD?filter=CDEDD.ITEM_ID=15915377%20and%20ver_nr=1
+    pubmed_id: str | None = None
+
+    # The full title of the publication stated exactly as it appears on the published work.
+    # https://cadsr.cancer.gov/onedata/dmdirect/NIH/NCI/CO/CDEDD?filter=CDEDD.ITEM_ID=16078531%20and%20ver_nr=1
+    publication_title: str | None = None
+
+    # A list of authors for the cited work.
+    # CDE: https://cadsr.cancer.gov/onedata/dmdirect/NIH/NCI/CO/CDEDD?filter=CDEDD.ITEM_ID=16081468%20and%20ver_nr=1
+    authorship: str | None = None
+
+    # The year in which the cited work was published.
+    # CDE: https://cadsr.cancer.gov/onedata/dmdirect/NIH/NCI/CO/CDEDD?filter=CDEDD.ITEM_ID=16081475%20and%20ver_nr=1
+    year_of_publication: str | None = None
+
+    # The name of the journal in which the cited work was published, inclusive of the citation itself in terms of
+    # journal volume number, part number where applicable, and page numbers.
+    # CDE: https://cadsr.cancer.gov/onedata/dmdirect/NIH/NCI/CO/CDEDD?filter=CDEDD.ITEM_ID=16081476%20and%20ver_nr=1
+    journal_citation: str | None = None

cidc_api/models/pydantic/stage2/radiotherapy_dose.py

@@ -0,0 +1,79 @@
+from typing import Self
+
+from pydantic import NonNegativeInt, NonNegativeFloat, model_validator
+
+from .base import Base
+from cidc_api.models.types import (
+    YNU,
+    RadiotherapyProcedure,
+    UberonAnatomicalTerm,
+    RadiotherapyDoseUnits,
+    RadiationExtent,
+)
+
+
+class RadiotherapyDose(Base):
+    __data_category__ = "radiotherapy_dose"
+    __cardinality__ = "many"
+
+    # The unique internal identifier for the radiotherapy dose record
+    therapy_agent_dose_id: int | None = None
+
+    # The unique internal identifier for the associated treatment record
+    treatment_id: int | None = None
+
+    # Number of days from enrollment date to the start of the radiotherapy dose.
+    days_to_start: NonNegativeInt
+
+    # Number of days from enrollment date to the end of the radiotherapy dose.
+    days_to_end: NonNegativeInt
+
+    # The term that describes the kind of radiotherapy procedure administered.
+    procedure: RadiotherapyProcedure
+
+    # The Uberon anatomical term for the site of surgery.
+    # CDE: https://cadsr.cancer.gov/onedata/dmdirect/NIH/NCI/CO/CDEDD?filter=CDEDD.ITEM_ID=14461856%20and%20ver_nr=1
+    anatomical_location: UberonAnatomicalTerm | None = None
+
+    # Indicates whether the record represents the total dose for a radiotherapy treatment course (which may be either
+    # a multi-fractionated or a single-fraction dose).
+    is_total_dose: bool
+
+    # The number of fractions a participant received to deliver the radiation dose.
+    number_of_fractions: NonNegativeInt | None = None
+
+    # The dose amount received by the participant.
+    # CDE: https://cadsr.cancer.gov/onedata/dmdirect/NIH/NCI/CO/CDEDD?filter=CDEDD.ITEM_ID=13433490%20and%20ver_nr=1
+    received_dose: NonNegativeFloat
+
+    # Unit of measure for the dose of the radiotherapy to be received by the participant.
+    # CDE: https://cadsr.cancer.gov/onedata/dmdirect/NIH/NCI/CO/CDEDD?filter=CDEDD.ITEM_ID=13383458%20and%20ver_nr=1
+    received_dose_units: RadiotherapyDoseUnits
+
+    # The planned dose amount for the participant.
+    planned_dose: NonNegativeFloat | None = None
+
+    # Unit of measure for the planned total dose of the radiotherapy to be received by the participant.
+    planned_dose_units: RadiotherapyDoseUnits | None = None
+
+    # Indicates if the radiotherapy dose was changed, missed, or delayed.
+    dose_changes_delays: YNU
+
+    # Description of the radiotherapy dose changes, misses, or delays.
+    changes_delays_description: str | None = None
+
+    # The extent of radiation exposure administered to the patient's body during radiation therapy.
+    # CDE: https://cadsr.cancer.gov/onedata/dmdirect/NIH/NCI/CO/CDEDD?filter=CDEDD.ITEM_ID=7063755%20and%20ver_nr=1
+    radiation_extent: RadiationExtent
+
+    @model_validator(mode="after")
+    def validate_changes_delays_description_cr(self) -> Self:
+        if self.dose_changes_delays == "Yes" and not self.changes_delays_description:
+            raise ValueError('If dose_changes_delays is "Yes", please provide changes_delays_description.')
+        return self
+
+    @model_validator(mode="after")
+    def validate_planned_dose_units_cr(self) -> Self:
+        if self.planned_dose and not self.planned_dose_units:
+            raise ValueError("If planned_dose is provided, please provide planned_dose_units.")
+        return self

cidc_api/models/pydantic/stage2/response.py

@@ -0,0 +1,71 @@
+from typing import Self
+
+from pydantic import NonNegativeInt, model_validator
+
+from .base import Base
+from cidc_api.models.types import SurvivalStatus, YNUNA, CauseOfDeath
+
+
+class Response(Base):
+    __data_category__ = "response"
+    __cardinality__ = "one"
+
+    # The unique internal identifier for the response record
+    response_id: int | None = None
+
+    # The unique internal identifier for the associated participant
+    # CDE: https://cadsr.cancer.gov/onedata/dmdirect/NIH/NCI/CO/CDEDD?filter=CDEDD.ITEM_ID=12220014%20and%20ver_nr=1
+    participant_id: int | None = None
+
+    # The response to a question that describes a participant's survival status.
+    # CDE: https://cadsr.cancer.gov/onedata/dmdirect/NIH/NCI/CO/CDEDD?filter=CDEDD.ITEM_ID=2847330%20and%20ver_nr=1
+    survival_status: SurvivalStatus
+
+    # Number of days from enrollment date to death date.
+    overall_survival: NonNegativeInt | None = None
+
+    # Indicator for whether there was an abscopal effect on disease after local therapy.
+    abscopal_response: YNUNA | None = None
+
+    # Indicates if pathological complete response (pCR) occurred.
+    pathological_complete_response: YNUNA | None = None
+
+    # Number of days between enrollment date and date of death, if applicable.
+    days_to_death: NonNegativeInt | None = None
+
+    # The circumstance or condition of greatest rank or importance that results in the death of the participant
+    # CDE: https://cadsr.cancer.gov/onedata/dmdirect/NIH/NCI/CO/CDEDD?filter=CDEDD.ITEM_ID=4783274%20and%20ver_nr=1
+    cause_of_death: CauseOfDeath | None = None
+
+    # Indicates whether participant was evaluable for toxicity (adverse events, DLT, etc.) overall.
+    evaluable_for_toxicity: bool
+
+    # Indicates whether participant was evaluable for efficacy (for example, response, PFS, OS, etc.) overall.
+    evaluable_for_efficacy: bool
+
+    # Days from enrollment date to the last time patient had follow-up.
+    days_to_last_follow_up: NonNegativeInt | None = None
+
+    @model_validator(mode="after")
+    def validate_overall_survival_cr(self) -> Self:
+        if self.survival_status != "Unknown" and not self.overall_survival:
+            raise ValueError('If survival_status is not "Unknown" then overall_survival is required.')
+        return self
+
+    @model_validator(mode="after")
+    def validate_cause_of_death_cr(self) -> Self:
+        if self.survival_status == "Dead" and not self.cause_of_death:
+            raise ValueError('If survival_status is "Dead" then cause_of_death is required.')
+        return self
+
+    @model_validator(mode="after")
+    def validate_cause_of_death_cr2(self) -> Self:
+        if self.survival_status == "Alive" and self.cause_of_death:
+            raise ValueError('If survival_status is "Alive", please leave cause_of_death blank.')
+        return self
+
+    @model_validator(mode="after")
+    def validate_days_to_death_cr(self) -> Self:
+        if self.survival_status in ["Alive", "Unknown"] and self.days_to_death:
+            raise ValueError("If survival_status does not indicate death, please leave days_to_death blank.")
+        return self

cidc_api/models/pydantic/stage2/response_by_system.py

@@ -0,0 +1,109 @@
+from typing import Self
+
+from pydantic import PositiveInt, model_validator
+
+from .base import Base
+from cidc_api.models.types import ResponseSystem, ResponseSystemVersion, BestOverallResponse, YNUNA
+
+
+negative_response_values = [
+    "Progressive Disease",
+    "Stable Disease",
+    "immune Unconfirmed Progressive Disease",
+    "immune Confirmed Progressive Disease",
+    "immune Stable Disease",
+    "Not available",
+    "Not assessed",
+]
+
+
+class ResponseBySystem(Base):
+    __data_category__ = "response_by_system"
+    __cardinality__ = "many"
+
+    # The unique internal identifier for this ResponseBySystem record
+    response_by_system_id: int | None = None
+
+    # The unique internal identifier for the associated participant
+    # CDE: https://cadsr.cancer.gov/onedata/dmdirect/NIH/NCI/CO/CDEDD?filter=CDEDD.ITEM_ID=12220014%20and%20ver_nr=1
+    participant_id: int | None = None
+
+    # A standardized method used to evaluate and categorize the participant’s clinical response to treatment based on predefined criteria.
+    # CDE: https://cadsr.cancer.gov/onedata/dmdirect/NIH/NCI/CO/CDEDD?filter=CDEDD.ITEM_ID=13381490%20and%20ver_nr=1
+    response_system: ResponseSystem
+
+    # The release version of the clinical assessment system used to evaluate a participant’s response to treatment.
+    response_system_version: ResponseSystemVersion
+
+    # Confirmed best overall response to study treatment by the corresponding response system.
+    best_overall_response: BestOverallResponse
+
+    # Days from first response to progression.
+    response_duration: PositiveInt | None = None
+
+    # Indicates whether a patient achieved a durable clinical benefit.
+    durable_clinical_benefit: bool | None = None
+
+    # Number of days between enrollment date and the date of first response to trial treatment.
+    days_to_first_response: PositiveInt | None = None
+
+    # Number of days between enrollment date and the date of the best response to trial treatment.
+    days_to_best_response: PositiveInt | None = None
+
+    # Indicates whether a participant's disease progressed.
+    progression: YNUNA
+
+    # Number of days between enrollment date and date of disease progression.
+    days_to_disease_progression: PositiveInt | None = None
+
+    # Indicator to identify whether a patient had a Progression-Free Survival (PFS) event.
+    progression_free_survival_event: YNUNA
+
+    # The number of days from the date the patient was enrolled in the study to the date the patient was last verified to be free of progression.
+    # CDE: https://cadsr.cancer.gov/onedata/dmdirect/NIH/NCI/CO/CDEDD?filter=CDEDD.ITEM_ID=5143957%20and%20ver_nr=1
+    progression_free_survival: PositiveInt | None = None
+
+    @model_validator(mode="after")
+    def validate_response_duration_cr(self) -> Self:
+        if self.best_overall_response in negative_response_values and self.response_duration:
+            raise ValueError(
+                "If best_overall_response does not indicate a positive response, \
+                please leave response_duration blank."
+            )
+        return self
+
+    @model_validator(mode="after")
+    def validate_days_to_first_response_cr(self) -> Self:
+        if self.best_overall_response in negative_response_values and self.days_to_first_response:
+            raise ValueError(
+                "If best_overall_response does not indicate a positive response, \
+                please leave days_to_first_response blank."
+            )
+        return self
+
+    @model_validator(mode="after")
+    def validate_days_to_best_response_cr(self) -> Self:
+        if self.best_overall_response in negative_response_values and self.days_to_best_response:
+            raise ValueError(
+                "If best_overall_response does not indicate a positive response, \
+                please leave days_to_best_response blank."
+            )
+        return self
+
+    @model_validator(mode="after")
+    def validate_days_to_disease_progression_cr(self) -> Self:
+        if self.progression in ["No", "Unknown", "Not Applicable"] and self.days_to_disease_progression:
+            raise ValueError(
+                "If progression does not indicate confirmed progression of the disease, \
+                please leave days_to_disease_progress blank."
+            )
+        return self
+
+    @model_validator(mode="after")
+    def validate_progression_free_survival_cr(self) -> Self:
+        if self.progression_free_survival_event in ["Unknown", "Not Applicable"] and self.progression_free_survival:
+            raise ValueError(
+                "If progression_free_survival_event is not known, \
+                please leave progression_free_survival blank."
+            )
+        return self

cidc_api/models/pydantic/stage2/shipment.py

@@ -0,0 +1,48 @@
+from datetime import datetime
+
+from .base import Base
+from cidc_api.models.types import AssayPriority, AssayType, Courier, ShipmentCondition, ShipmentQuality
+
+
+class Shipment(Base):
+    # The unique internal identifier for the shipment record.
+    shipment_id: int | None = None
+
+    # The unique internal identifier for the associated institution.
+    institution_id: int | None = None
+
+    # The unique internal identifier for the associated trial.
+    trial_id: int | None = None
+
+    # The version number of the trial dataset
+    version: str | None = None
+
+    # The identifier of the manifest used to ship this sample. e.g. "E4412_PBMC"
+    manifest_id: str
+
+    # Priority of the assay as it appears on the intake form. e.g. "10"
+    assay_priority: AssayPriority | None = None
+
+    # The type of assay used. e.g. "Olink"
+    assay_type: AssayType | None = None
+
+    # Courier utilized for shipment. e.g. "FedEx"
+    courier: Courier | None = None
+
+    # Air bill number assigned to shipment. e.g. "4567788343"
+    tracking_number: str | None = None
+
+    # The environmental conditions of the shipment. e.g. "Frozen Dry Ice"
+    condition: ShipmentCondition | None = None
+
+    # Details of shipping condition when condition is "Other"
+    condition_other: str | None = None
+
+    # Date the shipment was posted
+    date_shipped: datetime | None = None
+
+    # Date the shipment was received
+    date_received: datetime | None = None
+
+    # Indication of the quality/condition of the specimens after receipt. e.g. "Damaged"
+    quality: ShipmentQuality | None = None

cidc_api/models/pydantic/stage2/shipment_specimen.py

@@ -0,0 +1,15 @@
+from .base import Base
+
+
+class ShipmentSpecimen(Base):
+    # The unique internal identifier of the associated specimen
+    specimen_id: int | None = None
+
+    # The unique internal identifier of the associated shipment
+    shipment_id: int | None = None
+
+    # Identifier if sample shipment container includes multiple boxes for each assay. e.g. "1", "X"
+    box_number: str
+
+    # Sample location within the shipping container. e.g. "A1"
+    sample_location: str