@oimlsmart/primmel-packages 0.1.0

package/oiml-r144/entities/instrument.prl

@@ -0,0 +1,360 @@
+class QuantityValue#data {
+  description { "Number + optional unit — the INV-1 workhorse (\"no bare numbers\"). Instantiation of metamodel Module A QuantityValue, reduced to the two fields the R 144 parameter layer needs." }
+  helper { true }
+  value: any {
+    modality SHALL
+    definition "Decimal or string value (string for enum-like parameter values)"
+  }
+  unit: string [0..1] {
+    modality MAY
+    definition "Unit id from value-types.yaml units (ppm, degC, kPa, V, Hz, s, min, L/min, mg/m3, %, ...); absent only for dimensionless/string values"
+  }
+}
+
+class CustodyEvent#data {
+  description { "Append-only chain-of-custody record, embedded in MeasuringInstrumentSample.custody_events" }
+  helper { true }
+  sample_id: reference(MeasuringInstrumentSample) {
+    modality SHALL
+    on_delete cascade
+    required true
+  }
+  event_type: enum {
+    modality SHALL
+    enum_values { REQUESTED SHIPPED RECEIVED ASSIGNED_TO_TEST RETURNED DISPOSED }
+  }
+  from_party_id: string [0..1] {
+    modality MAY
+    definition "Party that held the sample before this event"
+  }
+  to_party_id: string {
+    modality SHALL
+    definition "Party that holds the sample after this event"
+  }
+  timestamp: datetime {
+    modality SHALL
+  }
+  notes: text [0..1] {
+    modality MAY
+  }
+}
+
+class OperationalStateEntry#data {
+  description { "One entry of a sample's operational-state trajectory (TODO.roadmap/07 + task 29, primmel StateTrajectoryEntry): the machine ENTERED `state` at `at` because `fired_by` recorded the transition fire. Append-only evidence — lands in the run's trace next to the conditions log." }
+  helper { true }
+  state: string {
+    modality SHALL
+    definition "Node of the operational machine entered (e.g. warming_up, ready)"
+  }
+  at: datetime {
+    modality SHALL
+    definition "ISO-8601 timestamp of the entry"
+  }
+  fired_by: string {
+    modality SHALL
+    definition "Who/what fired the transition (operator name, process step id; '' = genesis)"
+  }
+}
+
+class OperationalState#data {
+  description { "A sample's current node in one OPERATIONAL state machine (TODO.roadmap/07 + task 29) — instance-level data of the machine declared in data/<rec>/model/state.yaml. Strictly separate from `status` (the measuring_instrument_sample LIFECYCLE machine): the families never mix (primmel C38)." }
+  helper { true }
+  machine: string {
+    modality SHALL
+    definition "Id of the operational state machine (model/state.yaml state_machines[].id)"
+  }
+  current: string {
+    modality SHALL
+    definition "The machine's current node (e.g. off, warming_up, ready, measuring)"
+  }
+  trajectory: reference(OperationalStateEntry) [0..*] {
+    modality MAY
+    definition "Append-only state-entry log (embedded)"
+    on_delete cascade
+  }
+}
+
+class PhysicalDimensions#data {
+  description { "The sample's physical dimensions as registered on receipt (R 60-3, 4.9.10 — the report form's load-cell-dimensions entry, whose table carries the pictures/drawings of the dimensions). Every facet is an optional quantity-with-unit in mm; only the dimensions relevant to the instrument's shape are recorded (a cylindrical load cell records height + diameter, never length/width)." }
+  helper { true }
+  length: reference(QuantityValue) [0..1] {
+    modality MAY
+    definition "Overall length (QuantityValue { value, unit: mm })"
+  }
+  width: reference(QuantityValue) [0..1] {
+    modality MAY
+    definition "Overall width (QuantityValue { value, unit: mm })"
+  }
+  height: reference(QuantityValue) [0..1] {
+    modality MAY
+    definition "Overall height (QuantityValue { value, unit: mm })"
+  }
+  diameter: reference(QuantityValue) [0..1] {
+    modality MAY
+    definition "Body diameter (QuantityValue { value, unit: mm })"
+  }
+}
+
+class MeasuringInstrumentModelFamily#data {
+  store { measuringInstrumentModelFamilies }
+  description { "Family of measuring instruments (OIML V 1:2022, 4.02). HAS MANY Models (optionally via Groups). Its classification and parameters act as defaults inherited by its groups/models (INV-10)." }
+  indexes { manufacturer_id standard_id }
+  id: string {
+    modality SHALL
+  }
+  standard_id: string {
+    modality SHALL
+  }
+  family_designation: string {
+    modality SHALL
+    definition "Human-readable family designation (e.g. 'ACME GA-100 Series')"
+  }
+  family_code: string [0..1] {
+    modality MAY
+    definition "Short code used in certificate numbers and URIs"
+  }
+  manufacturer_id: reference(Manufacturer) {
+    modality SHALL
+    on_delete restrict
+    required true
+  }
+  classification: map<dimension_id, string> [0..1] {
+    modality MAY
+    definition "Family-level dimension defaults (family-scope axes: measuring_principle, sampling_approach)"
+  }
+  parameters: map<attribute_id, QuantityValue> [0..1] {
+    modality MAY
+    definition "Family-scope attribute defaults (attributes.yaml scope: family — t_min, t_max, rh_max, p_atm_min, p_atm_max, wetted_materials)"
+  }
+  created: datetime {
+    modality SHALL
+  }
+  modified: datetime {
+    modality SHALL
+  }
+}
+
+class MeasuringInstrumentModelGroup#data {
+  store { measuringInstrumentModelGroups }
+  description { "Sub-grouping within a MeasuringInstrumentModelFamily. A group carries the metrological characteristics its member Models share; Models resolve them by delegation (INV-10). Unused for R 144 (no group level)." }
+  indexes { family_id manufacturer_id standard_id }
+  id: string {
+    modality SHALL
+  }
+  standard_id: string {
+    modality SHALL
+  }
+  family_id: reference(MeasuringInstrumentModelFamily) {
+    modality SHALL
+    on_delete cascade
+    required true
+  }
+  manufacturer_id: reference(Manufacturer) {
+    modality SHALL
+    definition "Denormalized from family_id.manufacturer_id"
+    on_delete restrict
+    required true
+  }
+  group_label: string {
+    modality SHALL
+    definition "Compact label combining the group's identical characteristics"
+  }
+  classification: map<dimension_id, string> [0..1] {
+    modality MAY
+    definition "Group-scope dimensions"
+  }
+  parameters: map<attribute_id, QuantityValue> [0..1] {
+    modality MAY
+    definition "Group-identical characteristics"
+  }
+  created: datetime {
+    modality SHALL
+  }
+  modified: datetime {
+    modality SHALL
+  }
+}
+
+class MeasuringInstrumentModel#data {
+  store { measuringInstrumentModels }
+  description { "A model of measuring instrument — the subject of type evaluation and approval. Attribute values not set here resolve through group -> family delegation (INV-10)." }
+  indexes { family_id group_id manufacturer_id standard_id }
+  id: string {
+    modality SHALL
+  }
+  standard_id: string {
+    modality SHALL
+  }
+  model_designation: string {
+    modality SHALL
+    definition "Specific model designation (e.g. 'ACME-GA-100-CO-NOx')"
+  }
+  manufacturer_id: reference(Manufacturer) {
+    modality SHALL
+    on_delete restrict
+    required true
+  }
+  family_id: reference(MeasuringInstrumentModelFamily) {
+    modality SHALL
+    on_delete restrict
+    required true
+  }
+  group_id: reference(MeasuringInstrumentModelGroup) [0..1] {
+    modality MAY
+    definition "Unused for R 144 (no group level)"
+    on_delete restrict
+    required false
+  }
+  hardware_revision: string [0..1] {
+    modality MAY
+  }
+  type_approval_ref: reference(Certificate) [0..1] {
+    modality MAY
+    definition "Certificate issued for this model — filled after D3 approval"
+    on_delete nullify
+    required false
+  }
+  description: text [0..1] {
+    modality MAY
+  }
+  classification: map<dimension_id, string> [0..1] {
+    modality MAY
+    definition "Model dimension values/overrides (measurand_components, adjustment_means, power_supply; measuring_principle, sampling_approach overrides of family defaults)"
+  }
+  parameters: map<attribute_id, QuantityValue> [0..1] {
+    modality MAY
+    definition "Model-scope attributes (co_range_min/max, no_range_min/max, no2_range_min/max, response_time, warm_up_time, supply_voltage, supply_frequency, battery_voltage_min, probe/analyzer gas temp + particulate maxima, gas_flow_rate_*, vibration_severity, interfering_components, indication_unit, storage_t_min/max, software_identification)"
+  }
+  capabilities: string[] [0..*] {
+    modality MAY
+    definition "Capability ids from data/r144/model/capabilities.yaml"
+  }
+  created: datetime {
+    modality SHALL
+  }
+  modified: datetime {
+    modality SHALL
+  }
+}
+
+class MeasuringInstrumentSample#data {
+  store { measuringInstrumentSamples }
+  description { "A physical instance of a MeasuringInstrumentModel submitted for type evaluation. Tracks receipt, dispatch to test labs, and return/disposal through the embedded custody_events log (PD-05 §4.3)." }
+  indexes { model_id application_id manufacturer_id serial_number status standard_id }
+  id: string {
+    modality SHALL
+  }
+  standard_id: string {
+    modality SHALL
+  }
+  sample_number: string [0..1] {
+    modality MAY
+    definition "IA-assigned sample number (e.g. 'S-2024-001')"
+  }
+  serial_number: string {
+    modality SHALL
+    definition "Manufacturer's serial number on the physical instrument"
+  }
+  model_id: reference(MeasuringInstrumentModel) {
+    modality SHALL
+    definition "Catalog model this sample is an instance of"
+    on_delete restrict
+    required true
+  }
+  manufacturer_id: reference(Manufacturer) {
+    modality SHALL
+    on_delete restrict
+    required true
+  }
+  application_id: reference(Application) [0..1] {
+    modality MAY
+    definition "Application this sample was logged against"
+    on_delete restrict
+    required false
+  }
+  manufacturing_date: date [0..1] {
+    modality MAY
+  }
+  received_date: date [0..1] {
+    modality MAY
+  }
+  condition: enum {
+    modality SHALL
+    definition "The condition the sample arrived in, recorded at receipt registration (the physical instrument's received state)"
+    enum_values { NEW USED REFURBISHED DAMAGED }
+  }
+  condition_notes: text [0..1] {
+    modality MAY
+  }
+  photographs: reference(DocumentRef) [0..*] {
+    modality MAY
+    definition "Receipt photograph(s) of the physical instrument (R 60-3, 4.9.4 — the report form carries the sample's photographs); the document-store blob slots carry the bytes when the store is bound, the file-name reference otherwise"
+  }
+  status: enum {
+    modality SHALL
+    definition "Lifecycle per evaluation/state-machines.yaml measuring_instrument_sample machine"
+    enum_values { REQUESTED IN_TRANSIT RECEIVED IN_TESTING TESTING_COMPLETE RETURNED RETAINED DESTROYED DISPOSED }
+  }
+  current_location: string [0..1] {
+    modality MAY
+  }
+  current_custodian_id: string [0..1] {
+    modality MAY
+    definition "Reference to the org currently holding the sample (IA, lab, manufacturer)"
+  }
+  custody_events: reference(CustodyEvent) [0..*] {
+    modality SHALL
+    definition "Append-only chain-of-custody log (embedded)"
+    on_delete cascade
+  }
+  disposal_method: enum [0..1] {
+    modality MAY
+    enum_values { RETURNED RECYCLED DESTROYED RETAINED }
+  }
+  disposal_date: date [0..1] {
+    modality MAY
+  }
+  disposal_certificate: reference(DocumentRef) [0..1] {
+    modality MAY
+  }
+  test_context: map<attribute_id, QuantityValue> [0..1] {
+    modality MAY
+    definition "Sample-scope test-dependent attributes (attributes.yaml origin: test-dependent); unused for R 144 — CGM test points are run observables, not subject attributes"
+  }
+  physical_dimensions: reference(PhysicalDimensions) [0..1] {
+    modality MAY
+    definition "Physical dimensions registered on receipt (R 60-3, 4.9.10 — the report form's load-cell-dimensions entry); embedded, each facet a QuantityValue in mm"
+  }
+  selected_for_evaluation: boolean [0..1] {
+    modality MAY
+    definition "The IA's selection of this sample for the type evaluation (R 60-3, 4.7 — selection of the sample(s) tested): the evaluation tests a subset of the received samples; absent/false = not selected. Only a registered (received) sample is selectable."
+  }
+  selection_justification: text [0..1] {
+    modality MAY
+    definition "The recorded justification of the selection decision (R 60-3, 4.7.2 — justification of the selection of the test sample(s), referring to R 60-2, 2.3/2.4 and Annex D)"
+  }
+  verification_state: enum [0..1] {
+    modality MAY
+    definition "Verification lifecycle state (TODO.roadmap/21, metamodel v0.6.1) — the sample_verification state machine of evaluation/state-machines.yaml: NOT_VERIFIED → VERIFIED (a verification passes) → REVERIFICATION_DUE (timer: validity window elapsed) | INVALIDATED (signal: an out-of-cycle trigger such as a tyre change) → VERIFIED (re-verification passes). Absent = never verified."
+    enum_values { NOT_VERIFIED VERIFIED REVERIFICATION_DUE INVALIDATED }
+  }
+  seals: reference(SealStatus) [0..*] {
+    modality MAY
+    definition "Current seal status on the sample (embedded) — set/renewed by passed verifications (marking and securing, e.g. R 91-1, 7.13/8.2.4)"
+  }
+  verification_signals: reference(VerificationSignal) [0..*] {
+    modality MAY
+    definition "Posted out-of-cycle verification signals (embedded) — the signal-event channel of the re-verification triggers (e.g. tyre-change on an ego speed meter, R 91-1, 6.15.3 Note 2); consumed by the trigger engine"
+  }
+  operational_state: reference(OperationalState) [0..1] {
+    modality MAY
+    definition "The sample's current node in the rec's OPERATIONAL state machine (data/<rec>/model/state.yaml, TODO.roadmap/07 + task 29 — e.g. the R 144 warm-up machine off → warming_up → ready → measuring). Instance-level HAS state with an append-only trajectory; tests gate on it via the precondition `state:` facet (violation ⇒ run invalid, never fail). Absent = no operational state tracked (the gate reads the machine's initial node). Strictly separate from `status` (lifecycle family)."
+  }
+  created: datetime {
+    modality SHALL
+  }
+  modified: datetime {
+    modality SHALL
+  }
+}
+

package/oiml-r144/entities/test-execution.prl

@@ -0,0 +1,228 @@
+class TestRunEquipment#data {
+  description { "One piece of test equipment used in a run (metamodel D2 TestRun.equipment entry { id, calCert? }). Identity only — equipment is modelled as conditions (data/r144/model/conditions.yaml), not as an entity hierarchy." }
+  helper { true }
+  id: string {
+    modality SHALL
+    definition "Lab-local equipment identifier (e.g. force machine, chamber)"
+  }
+  cal_cert: string [0..1] {
+    modality MAY
+    definition "Calibration certificate reference (traceability)"
+  }
+}
+
+class ConditionsLogEntry#data {
+  description { "One logged influence-quantity value captured alongside a measurement (metamodel D2 EvidenceRecord.conditionsLog entry { quantityKind, value, unit }); quantity kinds per data/r144/model/conditions.yaml." }
+  helper { true }
+  quantity_kind: string {
+    modality SHALL
+    definition "Influence quantity kind (temperature, relative_humidity, barometric_pressure, ...)"
+  }
+  value: any {
+    modality SHALL
+  }
+  unit: string [0..1] {
+    modality MAY
+  }
+}
+
+class EvidenceRecord#data {
+  description { "A filled data-input slot of the run — mandatory evidence, typed by the form field it satisfies (metamodel D2 EvidenceRecord, embedded on TestRun.evidence). Per-measurement sign-off lives HERE (signed_by/signed_at), not on the FormInstance." }
+  helper { true }
+  field: string {
+    modality SHALL
+    definition "Form field name (data-input slot) this record fills, e.g. 'dmax', 'test_loads'"
+  }
+  value: reference(QuantityValue) {
+    modality SHALL
+    definition "Recorded value — QuantityValue { value, unit? }, never a bare number (INV-1)"
+  }
+  repetition: integer [0..1] {
+    modality MAY
+    definition "Repetition index (1-based) when the same slot is measured repeatedly"
+  }
+  conditions_log: reference(ConditionsLogEntry) [0..*] {
+    modality MAY
+    definition "Influence-quantity values logged at capture time (embedded)"
+    on_delete cascade
+  }
+  timestamp: datetime {
+    modality SHALL
+  }
+  signed_by: string [0..1] {
+    modality MAY
+    definition "Lab evaluator/supervisor name who signed this measurement off"
+  }
+  signed_by_account: string [0..1] {
+    modality MAY
+    definition "Account id of the signing operator (per-entry attribution for multi-operator runs, TODO.deploying/05); signed_by stays the display name"
+  }
+  signed_at: datetime [0..1] {
+    modality MAY
+  }
+}
+
+class RunOperator#data {
+  description { "One lab operator of a multi-operator test run (TODO.deploying/05 — loads need two people: one moves masses, one reads the instrument). Embedded on TestRun.operators; every evidence entry's sign-off attributes to one of these accounts. Provenance is per-entry and per-run — never just 'the lab'." }
+  helper { true }
+  account_id: string {
+    modality SHALL
+    definition "The operator's account id (the auth account's id; provenance key)"
+  }
+  name: string {
+    modality SHALL
+    definition "Display name"
+  }
+  role_note: string [0..1] {
+    modality MAY
+    definition "What this operator did on the run (lead, load handling, readings, …)"
+  }
+  signed_off_at: datetime [0..1] {
+    modality MAY
+    definition "When this operator signed off their part of the run's evidence"
+  }
+}
+
+class ConstraintCheckResult#data {
+  description { "Execution of one instrument-description.Constraint (R 144 profile DL.5, e.g. constr:r144:fig3-2b) against the run's bound values (metamodel D2 ConstraintCheck, embedded on TestRun.constraint_checks). A violated test-setup constraint invalidates the run AS A TEST, regardless of results." }
+  helper { true }
+  constraint: string {
+    modality SHALL
+    definition "Constraint id from the Recommendation profile (e.g. 'constr:r144:fig3-2b')"
+  }
+  evaluated_values: object {
+    modality SHALL
+    definition "Input name -> numeric value the OCL invariant was evaluated with"
+  }
+  result: enum {
+    modality SHALL
+    enum_values { satisfied violated }
+  }
+  effect_on_admissibility: string {
+    modality SHALL
+    definition "'invalidates_run' when a violated test-setup constraint voids the run; 'none' otherwise"
+  }
+}
+
+class RunAdmissibility#data {
+  description { "The admissibility gate of a run (metamodel D2 TestRunResult.admissibility map). Computed by the test-run service from evidence coverage, evidence units, and constraint-check outcomes." }
+  helper { true }
+  all_required_slots_filled: boolean {
+    modality SHALL
+  }
+  units_valid: boolean {
+    modality SHALL
+  }
+  conditions_within_envelope: boolean {
+    modality SHALL
+  }
+  status: enum {
+    modality SHALL
+    enum_values { admissible inadmissible }
+  }
+}
+
+class TestRun#data {
+  store { testRuns }
+  description { "One execution of one conformance test on one MeasuringInstrumentSample (metamodel D2 TestRun). Created per TestAssignment by the test-run service (one run per assignment, idempotent); bridged 1:1 to the FormInstance that acts as the run's evidence template. FACTS ONLY — verdicts belong to evaluation (Module D3)." }
+  indexes { test_assignment_id test_request_id sample_id laboratory_id standard_id status form_instance_id }
+  id: string {
+    modality SHALL
+  }
+  standard_id: string {
+    modality SHALL
+  }
+  conformance_test: string {
+    modality SHALL
+    definition "Conformance test id this run executes (form's conformance_test URN when declared, else the R 144-3 form id)"
+  }
+  test_assignment_id: reference(TestAssignment) {
+    modality SHALL
+    definition "The assignment (form × sample tuple) this run executes — one run per assignment"
+    on_delete cascade
+    required true
+  }
+  test_request_id: reference(TestRequest) [0..1] {
+    modality MAY
+    definition "Denormalized from the assignment for query efficiency"
+    on_delete nullify
+    required false
+  }
+  sample_id: reference(MeasuringInstrumentSample) {
+    modality SHALL
+    definition "The physical sample under test"
+    on_delete restrict
+    required true
+  }
+  laboratory_id: reference(TestLaboratory) {
+    modality SHALL
+    definition "Lab performing the run (denormalized from the assignment)"
+    on_delete restrict
+    required true
+  }
+  method_version: string [0..1] {
+    modality MAY
+    definition "Version pin of the test method/form schema (metamodel D2 methodVersion)"
+  }
+  operator: string [0..1] {
+    modality MAY
+    definition "Lab evaluator performing the run — the derived LEAD (operators[0].name) for compatibility; the full team lives in operators"
+  }
+  operators: reference(RunOperator) [0..*] {
+    modality MAY
+    definition "The lab operators who ran this run (multi-operator runs, TODO.deploying/05 — e.g. load handling needs two people); each entry signs off its own part of the evidence. operators[0] is the lead (the singular `operator` mirrors its name)"
+    on_delete cascade
+  }
+  started: datetime {
+    modality SHALL
+  }
+  ended: datetime [0..1] {
+    modality MAY
+  }
+  status: enum {
+    modality SHALL
+    definition "Lifecycle: PLANNED (created, no evidence yet) → IN_PROGRESS (evidence being recorded) → COMPLETED (admissible, form submitted) | INVALIDATED (a test-setup constraint was violated or the evidence is inadmissible — the run is void AS A TEST)."
+    enum_values { PLANNED IN_PROGRESS COMPLETED INVALIDATED }
+  }
+  equipment: reference(TestRunEquipment) [0..*] {
+    modality SHALL
+    definition "Equipment used, with calibration references (embedded)"
+    on_delete cascade
+  }
+  evidence: reference(EvidenceRecord) [0..*] {
+    modality SHALL
+    definition "Recorded data-input values with per-measurement sign-off (embedded)"
+    on_delete cascade
+  }
+  superseded_evidence: reference(EvidenceRecord) [0..*] {
+    modality MAY
+    definition "Evidence archive of a redone run (embedded): when an INVALIDATED run is redone (redoRun), its current evidence moves here verbatim — history is kept but no longer participates in admissibility."
+    on_delete cascade
+  }
+  redo_count: integer [0..1] {
+    modality MAY
+    definition "Number of times this run was redone from INVALIDATED (redoRun)"
+  }
+  constraint_checks: reference(ConstraintCheckResult) [0..*] {
+    modality SHALL
+    definition "Executed test-setup constraint checks (embedded; fig3-1/2a/2b, interval-consistency)"
+    on_delete cascade
+  }
+  form_instance_id: reference(FormInstance) [0..1] {
+    modality MAY
+    definition "1:1 link to the FormInstance that is the run's evidence template"
+    on_delete nullify
+    required false
+  }
+  admissibility: reference(RunAdmissibility) [0..1] {
+    modality MAY
+    definition "Computed admissibility gate (embedded helper); refreshed by computeAdmissibility"
+  }
+  created: datetime {
+    modality SHALL
+  }
+  modified: datetime {
+    modality SHALL
+  }
+}
+