osdu-python-models 0.5.0__py3-none-any.whl

osdu_models/masterdata/sample/v3_0_0.py

@@ -0,0 +1,775 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/sample/v3_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from ...abstract.abstract_facility_vertical_measurement import v1_0_0
+from ...abstract.abstract_ptcondition import v1_0_0 as v1_0_0_1
+from ...abstract.abstract_remark import v1_0_0 as v1_0_0_2
+from typing import Any
+from ...abstract.abstract_sample_properties import v1_1_0
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_master.v1_2_0 import AbstractMaster
+
+
+class SamplingPoint(BaseModel):
+    """
+    A free-form reference to the flow port on the Facility where this sample was acquired. The property is only used in conjunction with WellheadSampleAcquisition, SeparatorSampleAcquisition, FacilitySampleAcquisition.
+    Note:As an example, If ingesting data formatted using PRODML, this is typically  mapped as seen below:
+    SamplingPoint= [ PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<SeparatorSampleAcquisition | FacilitySampleAcquisition | SeparatorSampleAcquisition>[].Item.SamplingPoint
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    SamplingPointTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SamplingPointType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--SamplingPointType:FlowPort:'],
+        title='Sampling Point Type ID',
+    )
+    """
+    This is the OSDU record ID from a reference list containing the different types of sampling points.
+    """
+    SamplingPointName: str | None = Field(
+        None, examples=['VALVE:1723RR-01'], title='Sampling Point Name'
+    )
+    """
+    This is a description of the name of the  component or equipment used in capturing the sample. It can be used in storing the P & ID of the equipment or its component as defined within the Organisations Facility SOR / Repository.
+    """
+
+
+class SampleAcquisitionDetail(BaseModel):
+    """
+    This attribute provides information about the acquisition parameters and process used in acquiring the target sample. Other information about the sample itself can be found in the Sample object.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    VerticalMeasurement: v1_0_0.AbstractFacilityVerticalMeasurement | None = Field(
+        None,
+        examples=[
+            {
+                'EffectiveDateTime': '2020-02-13T09:13:15.55Z',
+                'VerticalMeasurement': 12345.6,
+                'TerminationDateTime': '2020-02-13T09:13:15.55Z',
+                'VerticalMeasurementTypeID': 'namespace:reference-data--VerticalMeasurementType:ArbitraryPoint:',
+                'VerticalMeasurementPathID': 'namespace:reference-data--VerticalMeasurementPath:MD:',
+                'VerticalMeasurementSourceID': 'namespace:reference-data--VerticalMeasurementSource:DRL:',
+                'WellboreTVDTrajectoryID': 'namespace:work-product-component--WellboreTrajectory:WellboreTrajectory-911bb71f-06ab-4deb-8e68-b8c9229dc76b:',
+                'VerticalMeasurementUnitOfMeasureID': 'namespace:reference-data--UnitOfMeasure:m:',
+                'VerticalCRSID': 'namespace:reference-data--CoordinateReferenceSystem:BoundProjected:EPSG::32021_EPSG::15851:',
+                'VerticalReferenceID': 'Example VerticalReferenceID',
+                'VerticalReferenceEntityID': 'namespace:master-data--Rig:SomeUniqueRigID:',
+                'VerticalMeasurementDescription': 'Example VerticalMeasurementDescription',
+            }
+        ],
+        title='Vertical Measurement',
+    )
+    """
+    Information on the list of all depths and elevations pertaining to the target wellbore involved in the Sample Acquisition event, like, plug back measured depth, total measured depth, KB elevation. The property is always used except with WellheadSampleAcquisition, SeparatorSampleAcquisition, FacilitySampleAcquisition
+    """
+    TopDepth: float | None = Field(None, examples=['10000 ft'], title='Top Depth')
+    """
+    The depth of the top of the target interval from which the sample was acquired. The reference and kind of depth (e.g. driller's depth versus logger's depth) is described in data.VerticalMeasurement. The property is always used except with WellheadSampleAcquisition, SeparatorSampleAcquisition, FacilitySampleAcquisition.
+    Note: As an example, if ingesting data formatted using PRODML, this is typically  mapped as seen below:
+    TopDepth=PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<DownholeSampleAcquisition | FormationTestSampleAcquisition>[].Item.TopMD
+    """
+    BaseDepth: float | None = Field(None, examples=[20000], title='Base Depth')
+    """
+    The depth of the base of the target interval from which the sample was acquired. The reference and kind of depth (e.g. driller's depth versus logger's depth) is described in data.VerticalMeasurement.  The property is always used except with WellheadSampleAcquisition, SeparatorSampleAcquisition, FacilitySampleAcquisition.
+    Note: As an example, If ingesting data formatted using PRODML, this is typically  mapped as seen below:
+    TopDepth=PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<DownholeSampleAcquisition | FormationTestSampleAcquisition>[].Item.BaseMD
+    """
+    ToolKind: str | None = Field(
+        None, examples=['Wireline Formation Tester'], title='Tool Kind'
+    )
+    """
+    This references the kind of tool used in acquiring the sample. The property is always used except with WellheadSampleAcquisition, SeparatorSampleAcquisition, FormationTestSampleAcquisition, FacilitySampleAcquisition.
+    Note: As an example, If ingesting data formatted using PRODML, this is typically  mapped as seen below:
+    ToolKind=PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<DownholeSampleAcquisition>[].Item.ToolKind.
+    """
+    RunNumber: str | None = Field(None, examples=[22], title='Run Number')
+    """
+    This refers to the different runs performed during the sample acquisition event and is typically identified using integers. It mostly applies to acquisition events acquired from the subsurface like downhole, coring, etc. The property is always used except with WellheadSampleAcquisition, SeparatorSampleAcquisition, FormationTestSampleAcquisition, FacilitySampleAcquisition
+    """
+    WellboreID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:master-data--Wellbore:cz2334t678900d53844-4:'],
+        title='Wellbore ID',
+    )
+    """
+    This refers to the OSDU record ID of the wellbore object from which the sample was acquired. It typically applies in scenarios where the acquisition event only pertains to a single wellbore object. The property is always used except with FacilitySampleAcquisition, Outcrop, SeparatorSampleAcquisition
+    Note: If ingesting data formatted using PRODML, this is typically  mapped as seen below:
+    WellboreID= PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<DownholeSampleAcquisition | WellheadSampleAcquisition>[].Item.Wellbore
+    """
+    WellheadOperatingCondition: v1_0_0_1.AbstractPTCondition | None = Field(
+        None, title='Wellhead Operating Condition'
+    )
+    """
+    This captures the operating conditions (prevailing pressure and temperatures) on the target facility or equipment (in this case wellhead) during the sample acquisition event.  This attribute is provided in the event that the acquisition pressure and temperature recorded at the flow port or sampling point from which the sample is acquired is different from the operating P&T at the wellhead. The property is only used in conjunction with WellheadSampleAcquisition.
+    Note:As an example, If ingesting data formatted using PRODML, this is typically  mapped as seen below:
+    wellheadOperatingCondition.Pressure=PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<WellheadSampleAcquisition>[].Item.wellheadPressure
+    wellheadOperatingCondition.Temperature=PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<WellheadSampleAcquisition>[].Item.wellheadTemperature
+    """
+    ContributingWellboreOpeningIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:master-data\-\-WellboreOpening:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Contributing Wellbore Opening IDs')
+    """
+    This refers to an array of OSDU record IDs for the wellbore completion objects (perforated or open hole interval) that contributed to the stream used in acquiring the sample. It can be used for one wellbore opening or multiple opening in the case of commingled flow. This is typically related to acquisition events from downhole where samples are comingled from multiple completions. The property is only used in conjunction with WellheadSampleAcquisition, SeparatorSampleAcquisition, DownholeSampleAcquisition.
+    Note:As an example, If ingesting data formatted using PRODML, this is typically  mapped as seen below:
+    WellboreOpeningIDs[0]=PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<WellheadSampleAcquisition | SeparatorSampleAcquisition>[].Item.WellboreCompletion
+    """
+    SeparatorOperatingCondition: v1_0_0_1.AbstractPTCondition | None = Field(
+        None, title='Separator Operating Condition'
+    )
+    """
+    This captures the operating conditions (prevailing pressure and temperatures) on the target facility or equipment (in this case separator) during the sample acquisition event.  This attribute is provided in the event that the acquisition pressure and temperature recorded at the flow port or sampling point from which the sample is acquired is different from the operating P&T for the separator. The property is only used in conjunction with SeparatorSampleAcquisition
+    Note:As an example, If ingesting data formatted using PRODML, this is typically  mapped as seen below:
+    SeparatorOperatingCondition.Pressure=PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<SeparatorSampleAcquisition>[].Item.SeparatorPressure
+    SeparatorOperatingCondition.Temperature=PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<SeparatorSampleAcquisition>[].Item.SeparatorTemperature
+    """
+    SamplingPoint_1: SamplingPoint | None = Field(
+        None, alias='SamplingPoint', title='Sampling Point'
+    )
+    """
+    A free-form reference to the flow port on the Facility where this sample was acquired. The property is only used in conjunction with WellheadSampleAcquisition, SeparatorSampleAcquisition, FacilitySampleAcquisition.
+    Note:As an example, If ingesting data formatted using PRODML, this is typically  mapped as seen below:
+    SamplingPoint= [ PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<SeparatorSampleAcquisition | FacilitySampleAcquisition | SeparatorSampleAcquisition>[].Item.SamplingPoint
+    """
+    CorrectedOilRate: float | None = Field(None, title='Corrected Oil Rate')
+    """
+    The value accounts for the application of correction procedures to the oil flow rate observed / measured during the sample acquisition event. The property is typically only used in conjunction with SeparatorSampleAcquisition
+    Note:As an example, If ingesting data formatted using PRODML, this is typically  mapped as seen below:
+    CorrectedOilRate=PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<SeparatorSampleAcquisition>[].Item.CorrectedOilRate
+    """
+    CorrectedGasRate: float | None = Field(None, title='Corrected Gas Rate')
+    """
+    The value accounts for the application of correction procedures to the gas flow rate observed / measured during the sample acquisition event. The property is typically only used in conjunction with SeparatorSampleAcquisition.
+    Note:As an example, If ingesting data formatted using PRODML, this is typically  mapped as seen below:
+    CorrectedGasRate=PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<SeparatorSampleAcquisition>[].Item.CorrectedGasRate
+    """
+    CorrectedWaterRate: float | None = Field(None, title='Corrected Water Rate')
+    """
+    The value accounts for the application of correction procedures to the water flow rate observed / measured during the sample acquisition event. The property is typically only used in conjunction with SeparatorSampleAcquisition.
+    Note:As an example, If ingesting data formatted using PRODML, this is typically  mapped as seen below:
+    CorrectedWaterRate=PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<SeparatorSampleAcquisition>[].Item.CorrectedWaterRate
+    """
+    MeasuredOilRate: float | None = Field(None, title='Measured Oil Rate')
+    """
+    This is the  observed/ measured oil rate for this sample acquisition event. The property is only used in conjunction with SeparatorSampleAcquisition
+    Note:As an example, If ingesting data formatted using PRODML, this is typically  mapped as seen below:
+    MeasuredOilRate=PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<SeparatorSampleAcquisition>[].Item.MeasuredOilRate
+    """
+    MeasuredGasRate: float | None = Field(None, title='Measured Gas Rate')
+    """
+    This is the observed/ measured gas rate for this sample acquisition event. The property is only used in conjunction with SeparatorSampleAcquisition
+    Note:As an example, If ingesting data formatted using PRODML, this is typically  mapped as seen below:
+    MeasuredGasRate=PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<SeparatorSampleAcquisition>[].Item.MeasuredGasRate
+    """
+    MeasuredWaterRate: float | None = Field(None, title='Measured Water Rate')
+    """
+    This is the observed/ measured water rate for this sample acquisition event. The property is only used in conjunction with SeparatorSampleAcquisition
+    Note:As an example, If ingesting data formatted using PRODML, this is typically  mapped as seen below:
+    MeasuredWaterRate=PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<SeparatorSampleAcquisition>[].Item.MeasuredWaterRate
+    """
+    FormationCondition: v1_0_0_1.AbstractPTCondition | None = Field(
+        None,
+        examples=[{'Pressure': 120, 'Temperature': 60}],
+        title='Formation Condition',
+    )
+    """
+    This captures the operating conditions (prevailing pressure and temperatures) on the target formation during the sample acquisition event.  This attribute is provided in the event that the acquisition pressure and temperature recorded at the downhole sampling location is different from the Formation's P&T. The property is used in conjunction with all the acquisition event types except FacilitySampleAcquisition, Cuttings and  WellheadSampleAcquisition.
+    Note:As an example, If ingesting data formatted using PRODML, this is typically  mapped as seen below:
+    FormationCondition.Pressure=PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<WellheadSampleAcquisition>[].Item.FormationPressure
+    FormationCondition.Temperature=PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<WellheadSampleAcquisition>[].Item.FormationTemperature
+    """
+    CorrectionRemarks: v1_0_0_2.AbstractRemark | None = Field(
+        None, title='Correction Remarks'
+    )
+    """
+    This is used to capture information regarding the methodology used in correcting rates acquired during the sample acquisition event. The property is only used in conjunction with SeparatorSampleAcquisition
+    """
+    SampleCarrierSlotName: str | None = Field(None, title='Sample Carrier Slot Name')
+    """
+    The name or identifier for the slot in the sample carrier where the sample was acquired. The property is only used in conjunction with FormationTestSampleAcquisition
+    Note:As an example, If ingesting data formatted using PRODML, this is typically  mapped as seen below:
+    SampleCarrierSlotName=PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<FormationTestSampleAcquisition>[].Item.SampleCarrierSlotName
+    """
+    ToolSectionName: str | None = Field(None, title='Tool Section Name')
+    """
+    The name of the formation tester tool section that was used in acquiring the sample. The property is only used in conjunction with FormationTestSampleAcquisition, ConventionalCore, Sidewall Core, Cuttings
+    Note:As an example, If ingesting data formatted using PRODML, this is typically  mapped as seen below:
+    ToolSectionName=PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<FormationTestSampleAcquisition>[].Item.ToolSectionName
+    """
+    SampleContainerCushionPressure: float | None = Field(None, title='Cushion Pressure')
+    """
+    The pressure used in charging the sample container. The property is only used in conjunction with FormationTestSampleAcquisition
+    Note: As an example, If ingesting data formatted using PRODML, this is typically  mapped as seen below:
+    SampleContainerCushionPressure=PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<FormationTestSampleAcquisition>[].Item.CushionPressure
+    """
+    GrossFluidKindID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellProductType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Gross Fluid Kind')
+    """
+    This is the OSDU record ID for the predominant fluid kind obtained from the formation during the acquisition event. The property is only used in conjunction with FormationTestSampleAcquisition
+    Note:As an example, If ingesting data formatted using PRODML, this is typically  mapped as seen below: 
+    GrossFluidKind=PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<FormationTestSampleAcquisition>[].Item.GrossFluidKind
+    """
+    FacilityEquipmentOperatingCondition: v1_0_0_1.AbstractPTCondition | None = Field(
+        None, title='Facility Equipment operating Condition'
+    )
+    """
+    This captures the operating conditions (prevailing pressure and temperatures) on the target equipment used on Topside Facilities (exclusive of wells or separators) during the sample acquisition event.  This attribute is provided in the event that the acquisition pressure and temperature recorded at the flow port or sampling point from which the sample is acquired is different from the operating P&T for the target facility or equipment. The property is only used in conjunction with FacilitySampleAcquisition
+    Note:As an example, If ingesting data formatted using PRODML, this is typically  mapped as seen below:
+    FacilityOperatingCondition.Pressure=PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<FacilitySampleAcquisition>[].Item.FacilityPressure
+    FacilityOperatingCondition.Temperature=PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<FacilitySampleAcquisition>[].Item.FacilityTemperature
+    """
+    SiteID: (
+        constr(
+            pattern=r'^[\w\-\.]+:(master-data\-\-GenericFacility|master-data\-\-GenericSite):[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Site ID')
+    """
+    Identifies the type of non-facility location (e.g. beach, oil seep, outcrop, sinkhole) that can be where the acquisition event occurred to collect a rock or fluid sample. Being different from a facility (which includes wells), a generic site is usually a natural location, not a man-made structure or a grouping of equipment.
+    """
+    SampleRecoveredLengthActual: float | None = Field(
+        None, title='Sample Recovered Length Actual'
+    )
+    """
+    Actual length of recovered sample, usually a core The property is only used in conjunction with ConventionalCore, Sidewall Core, Outcrop
+    """
+    PreservationTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-CorePreservationType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Preservation Type ID')
+    """
+    The kind of preservation applied to this sample if applied at the time of acquisition. The property is only used in conjunction with ConventionalCore, Sidewall Core, Cuttings, Outcrop, Core Plugs
+    """
+    SampleRecoveredLengthPlanned: float | None = Field(
+        None, title='Sample Recovered Length Planned'
+    )
+    """
+    Planned length of sample to be recovered, usually a core The property is only used in conjunction with ConventionalCore, Sidewall Core, Cuttings, Outcrop
+    """
+    AcquisitionCondition: v1_0_0_1.AbstractPTCondition | None = Field(
+        None,
+        examples=[{'Pressure': 120, 'Temperature': 60}],
+        title='Acquisition Condition',
+    )
+    """
+    This captures the prevailing pressure and temperature recorded at the sampling point during the sample acquisition event. The property applies to ALL sampling acquisition events.
+    Note:As an example, If ingesting data formatted using PRODML, this is typically  mapped as seen below:
+    AcquisitionCondition.Pressure=PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<FacilitySampleAcquisition|DownholeSampleAcquisition | FormationSampleAcquisition | SeparatorSampleAcquisition | WellheadSampleAcquisition >[].Item.AcquisitionPressure
+    AcquisitionCondition.Temperature=PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<FacilitySampleAcquisition|DownholeSampleAcquisition | FormationSampleAcquisition | SeparatorSampleAcquisition | WellheadSampleAcquisition >[].Item.AcquisitionTemperature
+    """
+    AcquisitionGOR: float | None = Field(None, examples=[340], title='Acquisition GOR')
+    """
+    This captures the gas oil ratio (GOR) for the sample acquired during the sample acquisition event. The property applies to ALL FLUID sampling acquisition events.
+    Note:As an example, If ingesting data formatted using PRODML, this is typically  mapped as seen below:
+    AcquisitionGOR=PRODML:2.1:FluidSampleAcquisitionJob.FluidSampleAcquisition<FacilitySampleAcquisition|DownholeSampleAcquisition | FormationSampleAcquisition | SeparatorSampleAcquisition | WellheadSampleAcquisition >[].Item.AcquisitionGOR
+    """
+    MudBaseTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-MudBaseType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Mud Base Type ID')
+    """
+    Identifies the type of fluid in the wellbore annulus used during the acquisition event or present in the sample required.
+    """
+    MudTracerTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-MudTracerType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Mud Tracer Type ID')
+    """
+    Identifies the type of tracer used during the sample acquisition event.
+    """
+    AcquisitionToolFamilyID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SampleAcquisitionToolFamily:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Identifies the category of the tool type used to acquire the sample/specimen, such as rotary or percussive sidewall tooling, or the inner barrel type for conventional coring. Note that other relevant facets of tool identification are captured by other reference lists, such as core catcher type, inner sleeve material type, drill bit, and sample container.
+    """
+    ConventionalCoreInnerSleeveMaterialID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ConventionalCoreInnerSleeveMaterial:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Identifies the category of material of the cylindrical sleeve that lines the inside of the inner core barrel during coring operations.
+    """
+    ConventionalCoreCatcherTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ConventionalCoreCatcherType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Identifies the category of the core catcher used in core acquisition. A core catcher is a device located in the core barrel of drilling tools that securely retains the core sample during its extraction from the subsurface.
+    """
+    WasCryogenicallyAcquired: bool | None = None
+    """
+    Indicates whether the rock was cryogenically frozen when it was acquired. In this process, the drilling fluid is pushed aside from the coring zone, liquid nitrogen or similar cryogenic agent is injected through a specialized cryogenic coring tool, and then a core barrel retrieves the stabilized core sample.
+    """
+    IsCommingledProductionFluid: bool | None = None
+    """
+    Indicates whether the fluid sample consists of fluids from multiple reservoir zones and/or wellbore openings mixed into one production flow stream before being collected.
+    """
+
+
+class SampleAcquisition(BaseModel):
+    """
+    This captures the acquisition parameters obtained during  the sample acquisition event associated with this sample. Note that this attribute should only be used when associating the sample with an acquisition event from its original source and not for sub-sampling or derivative sources.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    SampleAcquisitionJobID: (
+        constr(
+            pattern=r'^[\w\-\.]+:master-data\-\-SampleAcquisitionJob:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'namespace:master-data--SampleAcquisitionJob:dr23383830303032991154:'
+        ],
+        title='Sample Acquisition Job ID',
+    )
+    """
+    A reference to the parent record, which can group this sample acquisition event record with other sample acquisition event records, collected as part of the same job.
+    """
+    SampleAcquisitionDetail_1: SampleAcquisitionDetail | None = Field(
+        None, alias='SampleAcquisitionDetail', title='Sample Acquisition Detail'
+    )
+    """
+    This attribute provides information about the acquisition parameters and process used in acquiring the target sample. Other information about the sample itself can be found in the Sample object.
+    """
+    SampleAcquisitionTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SampleAcquisitionType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'namespace:reference-data--SampleAcquisitionType:DownholeSampleAcquisition:'
+        ],
+        title='Sample Acquisition Type ID',
+    )
+    """
+    This is a reference list of the different types of sample acquisition events used in acquiring samples. i.e. downhole sample acquisition type, outcrop, coring, non-facility site, etc
+    """
+    SampleAcquisitionContainerID: (
+        constr(
+            pattern=r'^[\w\-\.]+:master-data\-\-SampleContainer:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:master-data--SampleContainer:dr23383830303032991154:'],
+        title='Sample Acquisition Container ID',
+    )
+    """
+    This is the OSDU Record ID for the original sample container used in the acquired sample. This is only for the initial sample acquisition. Only populate this for the original sample.
+    """
+    AcquisitionStartDate: str | None = Field(
+        None, examples=['2023-01-01T12:00:00Z'], title='Acquisition Start Date'
+    )
+    """
+    The start date and time of the acquisition event.
+    """
+    AcquisitionEndDate: str | None = Field(
+        None, examples=['2023-01-01T12:00:00Z'], title='Acquisition End Date'
+    )
+    """
+    The end date and time of the acquisition event.
+    """
+    Remarks: list[v1_0_0_2.AbstractRemark] | None = Field(None, title='Remarks')
+    """
+    A remark object, pairing a remark text with a source, e.g. an author, and a date, which is typically included in an array.
+    """
+    CollectionServiceCompanyID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:master-data--Organisation:fg67383830303032991126:'],
+        title='Collection Service Company ID',
+    )
+    """
+    The company that managed the collection of the sample from its original / source environment.
+    """
+    HandlingServiceCompanyID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:master-data--Organisation:fg67383830303032991126:'],
+        title='Handling Service Company ID',
+    )
+    """
+    The company that handled the sample on site after the it was collected/extracted. For example, the company that applied field preservation methods, and prepared the sample for shipping.
+    """
+
+
+class RecombinationGasOilRatio(BaseModel):
+    """
+    The gas-oil ratio recorded for this sample recombination process as well as the volumetric reference conditions for both the oil and gas phases. This is typically required for fluid sample types.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    GasOilRatio: float = Field(..., examples=[3456])
+    """
+    The Gas Oil Ratio calculated at the reference conditions specified for each stream (Oil or Gas)
+    """
+    VolumeReferenceConditionGas: v1_0_0_1.AbstractPTCondition = Field(
+        ..., examples=[{'Pressure': 14.7, 'Temperature': 60}]
+    )
+    """
+    The pressure and temperature reference values for the gas stream.
+    """
+    VolumeReferenceConditionOil: v1_0_0_1.AbstractPTCondition = Field(
+        ..., examples=[{'Pressure': 200, 'Temperature': 69}]
+    )
+    """
+    The pressure and temperature reference values for the oil stream.
+    """
+
+
+class TargetSampleCompositionItem(BaseModel):
+    """
+    This object holds information about a sample or component of a sample and its contribution to a target sample created through the recombination process.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    SampleCompositionComponentID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-SampleCompositionComponent:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Sample Composition Component ID')
+    """
+    This is the OSDU Record ID of an item in the list of  sample components. This attribute references the components that make up a sample.
+    """
+    VolumeFraction: float | None = Field(None, examples=[0.2], title='Volume Fraction')
+    """
+    The volume fraction contribution of this component to the sample composition.
+    """
+    MassFraction: float | None = Field(None, examples=[0.03], title='Mass Fraction')
+    """
+    The mass fraction contribution of this component to the sample composition.
+    """
+    MoleFraction: float | None = Field(None, examples=[0.5], title='Mole Fraction')
+    """
+    The mole fraction contribution of this component to the sample composition.
+    """
+
+
+class RecombinedSampleFractionItem(BaseModel):
+    """
+    This object holds information about a sample or component of a sample and its contribution to a target sample created through the recombination process.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    SampleCompositionComponentID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-SampleCompositionComponent:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Sample Composition Component ID')
+    """
+    This is the OSDU Record ID of an item in the list of  sample components. This attribute references the components that make up a sample.
+    """
+    VolumeFraction: float | None = Field(None, examples=[0.2], title='Volume Fraction')
+    """
+    The volume fraction contribution of this component to the sample composition.
+    """
+    MassFraction: float | None = Field(None, examples=[0.03], title='Mass Fraction')
+    """
+    The mass fraction contribution of this component to the sample composition.
+    """
+    MoleFraction: float | None = Field(None, examples=[0.5], title='Mole Fraction')
+    """
+    The mole fraction contribution of this component to the sample composition.
+    """
+
+
+class RecombinationSpecification(BaseModel):
+    """
+    For a sample that has been recombined from separate samples, e.g. liquid sample and vapor sample, this object records the specified: recombination conditions (pressure and temperature), recombination ratio, the saturation pressure and  target recombined sample composition, whichever of these are appropriate for this recombination effort.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    RecombinationCondition: v1_0_0_1.AbstractPTCondition = Field(
+        ...,
+        examples=[{'Pressure': 120, 'Temperature': 60}],
+        title='Recombination Condition',
+    )
+    """
+    The prevailing operating conditions (Pressure and Temperature)  for the recombination operation.
+    """
+    RecombinationGasOilRatio_1: RecombinationGasOilRatio | None = Field(
+        None,
+        alias='RecombinationGasOilRatio',
+        examples=[
+            {
+                'GasOilRatio': 34567,
+                'VolumeReferenceConditionGas': {'Pressure': 14.7, 'Temperature': 60},
+                'VolumeReferenceConditionOil': {'Pressure': 200, 'Temperature': 69},
+            }
+        ],
+        title='Recombination Gas Oil Ratio',
+    )
+    """
+    The gas-oil ratio recorded for this sample recombination process as well as the volumetric reference conditions for both the oil and gas phases. This is typically required for fluid sample types.
+    """
+    RecombinationSaturationPressure: float | None = Field(
+        None, examples=[120], title='Recombination Saturation Pressure'
+    )
+    """
+    The observed saturation pressure for this sample recombination process. Mostly applies to fluid samples.
+    """
+    TargetSampleComposition: list[TargetSampleCompositionItem] | None = Field(
+        None,
+        examples=[
+            [
+                {
+                    'SampleCompositionComponentID': 'namespace:reference-data--SampleCompositionComponent:ETHANE:',
+                    'MassFraction': 0.2,
+                    'MoleFraction': 0.1,
+                },
+                {
+                    'SampleCompositionComponentID': 'namespace:reference-data--SampleCompositionComponent:PENTANE:',
+                    'MassFraction': 0.4,
+                    'MoleFraction': 0.4,
+                },
+                {
+                    'SampleCompositionComponentID': 'namespace:reference-data--SampleCompositionComponent:PENTANEPLUS:',
+                    'MassFraction': 0.4,
+                    'MoleFraction': 0.5,
+                },
+            ]
+        ],
+        title='Target Sample Composition',
+    )
+    """
+    This provides an array of components and their fraction contribution to the overall expected composition of the  sample generated by the recombination process. This is typically required for fluid sample types.
+    """
+    Remarks: list[v1_0_0_2.AbstractRemark] | None = Field(
+        None,
+        examples=[
+            [
+                {
+                    'Remark': 'Shaker not functioning properly.',
+                    'RemarkSource': 'Mud Logger',
+                }
+            ]
+        ],
+        title='Remarks',
+    )
+    """
+    Pertinent information about the sample recombination specification stored alongside the other attributes.
+    """
+    RecombinedSampleFraction: list[RecombinedSampleFractionItem] = Field(
+        ..., title='Recombined Sample Fraction'
+    )
+    """
+    Object capturing the mixture and contributions from multiple samples.
+    """
+
+
+class SamplePreparationItem(BaseModel):
+    """
+    This captures information about the preparation process executed after the sample acquisition event.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    SamplePreparationTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SamplePreparationType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Sample Preparation Type IDs')
+    """
+    Provides extra details on any processes applied after the sample has been acquired
+    """
+    SamplePreparationMethodID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SamplePreparationMethod:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Sample Preparation Method IDs')
+    """
+    Provide additional details on which industrial/lab method used to conduct the sample preparation
+    """
+    SamplePreparationCondition: v1_0_0_1.AbstractPTCondition | None = Field(
+        None, title='Sample Preparation Condition'
+    )
+    """
+    Used to describe the pressure and temperature conditions at which the sample preparation took place
+    """
+    SamplePreparationStartDate: str | None = Field(
+        None, title='Sample Preparation Start Date'
+    )
+    """
+    This represents the start date for the sample preparation process.
+    """
+    SamplePreparationEndDate: str | None = Field(
+        None, title='Sample Preparation End Date'
+    )
+    """
+    This represents the end date for the sample preparation process.
+    """
+    Remarks: list[v1_0_0_2.AbstractRemark] | None = Field(None, title='Remarks')
+    """
+    This captures other pertinent information regarding the sample preparation process.
+    """
+
+
+class Data(OsduCommonResources, AbstractMaster):
+    """
+    `data` payload for Sample 3.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    SampleIdentifier: str | None = Field(
+        None, examples=['sample1A'], title='Sample Identifier'
+    )
+    """
+    Identifier from a Master Data Management System or other trusted source external to OSDU - stored here in order to allow for multi-system connection and synchronization. If used, the "Source" property in AbstractCommonResources schema should identify that source system. i.e. this item is optional.
+    """
+    SampleName: str | None = Field(None, examples=['sampleA'], title='Sample Name')
+    """
+    This provides the name of the sample. If there are other names that need to be stored , leverage the Aliases available in the Abstract objects.
+    """
+    SampleOriginTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SampleOriginType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--SampleOriginType:Synthetic:'],
+        title='Sample Origin Type ID',
+    )
+    """
+    This provides information about the type of the origin of the sample. It can be used to determine if the sample was acquired from an original source location, result of recombination, subsampling or derived from some laboratory process.
+    """
+    SampleTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:(reference-data\-\-SampleType|reference-data\-\-WellFluidType|reference-data\-\-StimJobFluidType):[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--SampleType:CorePlug:'],
+        title='Sample Type ID',
+    )
+    """
+    The classification of the type of specimen/sample (e.g. whole core, cuttings, rock chip, oil extract, headspace gas), which is identified for the purpose of analysing the specimen or a subsample of it. In partnership with other reference data, the sample type may indicate the general substance type, size, shape, general source, and in certain cases, the retrieval method. In rare cases, the special purpose of a specimen might contribute to its sample type classification.
+    """
+    SampleDisposalInstructionID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-Document:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'namespace:work-product-component--Document:0e6a8fdb-0a0a-56db-955a-c62204c42cb0:'
+        ],
+        title='Sample Disposition Instruction ID',
+    )
+    """
+    This is an OSDU Record ID referencing a document that contains instructions on how the sample should be disposed.
+    """
+    SampleAcquisition_1: SampleAcquisition | None = Field(
+        None, alias='SampleAcquisition', title='Sample Acquisition'
+    )
+    """
+    This captures the acquisition parameters obtained during  the sample acquisition event associated with this sample. Note that this attribute should only be used when associating the sample with an acquisition event from its original source and not for sub-sampling or derivative sources.
+    """
+    SampleProperties: v1_1_0.AbstractSampleProperties | None = Field(
+        None, title='Sample Properties'
+    )
+    """
+    This captures information pertaining to the observed physical properties of the sample.
+    """
+    Remarks: list[v1_0_0_2.AbstractRemark] | None = Field(
+        None,
+        examples=[
+            [
+                {
+                    'Remark': 'Shaker not functioning properly.',
+                    'RemarkSource': 'Mud Logger',
+                }
+            ]
+        ],
+        title='Remarks',
+    )
+    """
+    An array containing operational or quality comments about the sample.
+    """
+    RecombinationSpecification_1: RecombinationSpecification | None = Field(
+        None, alias='RecombinationSpecification', title='Recombination Specification'
+    )
+    """
+    For a sample that has been recombined from separate samples, e.g. liquid sample and vapor sample, this object records the specified: recombination conditions (pressure and temperature), recombination ratio, the saturation pressure and  target recombined sample composition, whichever of these are appropriate for this recombination effort.
+    """
+    ParentSampleIDs: (
+        list[constr(pattern=r'^[\w\-\.]+:master-data\-\-Sample:[\w\-\.\:\%]+:[0-9]*$')]
+        | None
+    ) = Field(
+        None,
+        examples=[
+            [
+                'namespace:master-data--Sample:b7d3735f-b720-5db2-88c9-771d396d8a4e:',
+                'namespace:master-data--Sample:c7d3735f-b720-5db2-88c9-771d396d8a4e:',
+            ]
+        ],
+        title='Parent Sample IDs',
+    )
+    """
+    This attribute stores the array of OSDU record IDs for the parent samples used in creating this sample. Creation of this sample could be achieved through through extractions, sub sampling, derived sampling or recombination.
+    """
+    SamplePreparation: list[SamplePreparationItem] | None = Field(
+        None, title='Sample Preparation'
+    )
+    """
+    This captures information about the preparation process executed after the sample acquisition event.
+    """
+    ExtensionProperties: dict[str, Any] | None = None