@oimlsmart/primmel-packages 0.1.0

package/oiml-smart-core/entities/cs-operations.prl

@@ -0,0 +1,492 @@
+class AcceptanceReview#data {
+  store { acceptanceReviews }
+  description { "A Utilizer/Associate's acceptability evaluation of one registered certificate against its own signed Declaration (B 18:2025 §5.6.3): the category in Declaration scope, the scheme accepted, the IA/TL accepted, and the MTL policy. A non-acceptance after consulting the Issuing Authority (4.8) records the WRITTEN JUSTIFICATION addressed to the Issuing Authority, the manufacturer AND the Executive Secretary — except for MTL-originated test data, whose non-acceptance is voluntary and requires no justification (4.9)." }
+  indexes { certificate_id participant_id outcome }
+  id: string {
+    modality SHALL
+  }
+  certificate_id: reference(Certificate) {
+    modality SHALL
+    on_delete cascade
+    required true
+  }
+  participant_kind: enum {
+    modality SHALL
+    enum_values { utilizer associate }
+  }
+  participant_id: string {
+    modality SHALL
+    definition "The reviewing Utilizer/Associate id"
+  }
+  consulted_ia: boolean {
+    modality SHALL
+    definition "The reviewer consulted the Issuing Authority over its questions first (PD-06, 4.8)"
+  }
+  mtl_originated: boolean {
+    modality SHALL
+    definition "The certificate's test data originates (partly) from a Manufacturer Test Laboratory (4.9)"
+  }
+  outcome: enum {
+    modality SHALL
+    enum_values { accepted not_accepted }
+  }
+  checks: reference(AcceptabilityCheck) [0..*] {
+    modality MAY
+    definition "The per-criterion evaluation snapshot (§5.6.3 criteria)"
+  }
+  justification: text [0..1] {
+    modality MAY
+    definition "The written justification for non-acceptance (4.8) — absent for MTL-originated data (4.9)"
+  }
+  justification_addressees: string[] [0..*] {
+    modality MAY
+    definition "issuing_authority + manufacturer + executive_secretary (4.8); empty for MTL-originated data (4.9)"
+  }
+  evaluated_by: string [0..1] {
+    modality MAY
+  }
+  evaluated_at: datetime {
+    modality SHALL
+  }
+  created: datetime {
+    modality SHALL
+  }
+  modified: datetime {
+    modality SHALL
+  }
+}
+
+class AppealCase#data {
+  store { appeals }
+  description { "An appeal to the Board of Appeal (PD-01, 8): an applicant's against an Issuing Authority decision — only after exhausting the IA's own appeal procedure where applicable (8.2.1) — or a participant's against a Management Committee decision (8.3). Lodged in writing with the Executive Secretary WITHIN ONE MONTH, setting out all reasons; the BoA's written decision issues within one month of consideration (9) and a decision upholding an appeal against an MC decision is BINDING on the MC and cannot be appealed further. The status field walks the appeal_case state machine." }
+  indexes { status kind }
+  id: string {
+    modality SHALL
+  }
+  kind: enum {
+    modality SHALL
+    definition "8.2 (applicant vs IA decision) | 8.3 (participant vs MC decision)"
+    enum_values { applicant_appeal participant_appeal }
+  }
+  appellant_kind: enum {
+    modality SHALL
+    enum_values { applicant issuing_authority utilizer associate }
+  }
+  appellant_id: string [0..1] {
+    modality MAY
+  }
+  appellant_name: string {
+    modality SHALL
+  }
+  contested: text {
+    modality SHALL
+    definition "The contested decision (IA decision or MC decision), described"
+  }
+  contested_application_id: reference(ParticipantApplication) [0..1] {
+    modality MAY
+    definition "The MC participation decision appealed (8.3), where applicable"
+    on_delete nullify
+  }
+  contested_certificate_id: reference(Certificate) [0..1] {
+    modality MAY
+    definition "The certificate the contested IA decision concerns (8.2), where applicable"
+    on_delete nullify
+  }
+  ia_procedure_applicable: boolean {
+    modality SHALL
+    definition "Whether the IA has its own appeal procedure applicable to the case (8.2.1)"
+  }
+  ia_appeal_outcome: text [0..1] {
+    modality MAY
+    definition "The outcome of the IA's own appeal procedure (8.2.1 precondition evidence)"
+  }
+  reasons: text {
+    modality SHALL
+    definition "All reasons for the appeal, set out in writing (8.2/8.3)"
+  }
+  informed_at: date {
+    modality SHALL
+    definition "Date the appellant was informed of the decision (8.2.2) or concluded no agreement was reachable (8.3) — opens the one-month window"
+  }
+  lodged_at: date {
+    modality SHALL
+    definition "Date the written appeal reached the Executive Secretary — within one month of informed_at"
+  }
+  status: enum {
+    modality SHALL
+    enum_values { LODGED CIRCULATED CONSIDERED DECIDED INADMISSIBLE }
+  }
+  information_circulated_at: date [0..1] {
+    modality MAY
+    definition "Case information circulated to the BoA and the parties — at least one month before consideration (9)"
+  }
+  considered_at: date [0..1] {
+    modality MAY
+    definition "Date the BoA considered the case"
+  }
+  decision: enum [0..1] {
+    modality MAY
+    enum_values { upheld dismissed }
+  }
+  decision_issued_at: date [0..1] {
+    modality MAY
+    definition "The written BoA decision — within one month of consideration (9)"
+  }
+  binding_on_mc: boolean [0..1] {
+    modality MAY
+    definition "An upheld appeal against an MC decision binds the MC (9)"
+  }
+  further_appeal_possible: boolean [0..1] {
+    modality MAY
+    definition "False once the BoA upholds against an MC decision (9)"
+  }
+  anonymized_report_requested: boolean [0..1] {
+    modality MAY
+    definition "The report to the next MC meeting is anonymized on request (9)"
+  }
+  notes: text [0..1] {
+    modality MAY
+  }
+  created: datetime {
+    modality SHALL
+  }
+  modified: datetime {
+    modality SHALL
+  }
+}
+
+class ComplaintCase#data {
+  store { complaints }
+  description { "A complaint to the Executive Secretary with documented and substantiated evidence (PD-01, 6): incorrect technical conclusions or procedures underlying an issued OIML type evaluation report (6.2 — owner and MC notified; the Executive Secretary investigates with the Review Committee's advice; upheld ⇒ deregistration and the IA corrects the report), non-acceptance by a Utilizer or Associate (6.3), or dissatisfaction with the OIML-CS (6.4). The status field walks the complaint_case state machine. This is also the procedure PD-05 §7.1 defers to." }
+  indexes { status kind certificate_id }
+  id: string {
+    modality SHALL
+  }
+  kind: enum {
+    modality SHALL
+    enum_values { incorrect_conclusions non_acceptance dissatisfaction }
+  }
+  complainant: string {
+    modality SHALL
+  }
+  certificate_id: reference(Certificate) [0..1] {
+    modality MAY
+    definition "The certificate whose evaluation report is challenged (6.2)"
+    on_delete nullify
+  }
+  participant_id: string [0..1] {
+    modality MAY
+    definition "The Utilizer/Associate whose non-acceptance is complained of (6.3)"
+  }
+  evidence: text {
+    modality SHALL
+    definition "The documented and substantiated evidence (6)"
+  }
+  owner_notified: boolean {
+    modality SHALL
+    definition "The report owner was notified (6.2)"
+  }
+  mc_notified: boolean {
+    modality SHALL
+    definition "The Management Committee was notified (6.2/6.3)"
+  }
+  ia_consulted: boolean [0..1] {
+    modality MAY
+    definition "The Executive Secretary consulted the relevant Issuing Authority (PD-05 §7.1)"
+  }
+  rc_advice: text [0..1] {
+    modality MAY
+    definition "The Review Committee's advice on the investigation (6.2) — mandatory for incorrect_conclusions"
+  }
+  upheld: boolean [0..1] {
+    modality MAY
+  }
+  recommended_actions: text [0..1] {
+    modality MAY
+    definition "Actions recommended to the MC where the complaint is upheld (6.3/6.4) — mandatory when upheld"
+  }
+  correction_action: text [0..1] {
+    modality MAY
+    definition "The IA's correction of the type evaluation report on deregistration (6.2)"
+  }
+  status: enum {
+    modality SHALL
+    enum_values { RECEIVED INVESTIGATION UPHELD DISMISSED }
+  }
+  created: datetime {
+    modality SHALL
+  }
+  modified: datetime {
+    modality SHALL
+  }
+}
+
+class MisuseCase#data {
+  store { misuseCases }
+  description { "A certificate-misuse case (PD-06, 5.1): on documented and substantiated evidence that the owner uses the certificate contrary to the clause-4 requirements, the Executive Secretary consults the CIML Member of the issuing Member State, informs the MC, the other Member States, the Issuing Authority and interested parties, and warns the owner that continued misuse leads to corrective actions up to deregistration by the BIML (5.2/5.3 — the owner may appeal per PD-01; if not upheld, the BIML deregisters). The status field walks the misuse_case state machine." }
+  indexes { status certificate_id }
+  id: string {
+    modality SHALL
+  }
+  certificate_id: reference(Certificate) {
+    modality SHALL
+    on_delete cascade
+    required true
+  }
+  evidence: text {
+    modality SHALL
+    definition "The documented and substantiated evidence of use contrary to clause 4 (5.1)"
+  }
+  ciml_member_consulted: boolean {
+    modality SHALL
+    definition "The CIML Member of the issuing Member State was consulted (5.1)"
+  }
+  owner_warned: boolean {
+    modality SHALL
+    definition "The owner was warned that continued misuse leads to deregistration (5.1)"
+  }
+  warned_at: date [0..1] {
+    modality MAY
+  }
+  notifications: string[] [0..*] {
+    modality MAY
+    definition "Parties informed: management_committee, member_states, issuing_authority, interested_parties (5.1)"
+  }
+  appeal_outcome: enum [0..1] {
+    modality MAY
+    definition "The PD-01 appeal outcome on the deregistration proposal (5.2) — null: no appeal lodged"
+    enum_values { upheld not_upheld }
+  }
+  status: enum {
+    modality SHALL
+    enum_values { EVIDENCED WARNED CLOSED DEREGISTERED }
+  }
+  created: datetime {
+    modality SHALL
+  }
+  modified: datetime {
+    modality SHALL
+  }
+}
+
+class DeregistrationRecord#data {
+  store { deregistrations }
+  description { "The BIML-side deregistration of a registered certificate: for incorrect technical conclusions (PD-01, 6.2), for misuse (PD-06, 5.3), or for registration-fee non-payment (PD-05 §6.2 — the listing withdrawal). Records the notifications (owner, MC, Member States, Issuing Authority, interested parties) and the published notice in the OIML Bulletin and on the OIML website (PD-06, 5.3)." }
+  indexes { certificate_id reason_kind }
+  id: string {
+    modality SHALL
+  }
+  certificate_id: reference(Certificate) {
+    modality SHALL
+    on_delete cascade
+    required true
+  }
+  certificate_number: string {
+    modality SHALL
+  }
+  reason_kind: enum {
+    modality SHALL
+    enum_values { incorrect_conclusions misuse fee_non_payment }
+  }
+  complaint_id: reference(ComplaintCase) [0..1] {
+    modality MAY
+    on_delete nullify
+  }
+  misuse_case_id: reference(MisuseCase) [0..1] {
+    modality MAY
+    on_delete nullify
+  }
+  deregistered_at: date {
+    modality SHALL
+  }
+  notified: string[] [0..*] {
+    modality MAY
+    definition "owner, management_committee, member_states, issuing_authority, interested_parties (PD-06, 5.3)"
+  }
+  bulletin_notice_published: boolean {
+    modality SHALL
+    definition "The notice was published in the OIML Bulletin and on the OIML website (PD-06, 5.3)"
+  }
+  bulletin_ref: string [0..1] {
+    modality MAY
+    definition "The OIML Bulletin notice reference (e.g. Bulletin 2026-3, p. 14)"
+  }
+  notes: text [0..1] {
+    modality MAY
+  }
+  created: datetime {
+    modality SHALL
+  }
+  modified: datetime {
+    modality SHALL
+  }
+}
+
+class AnrValidationLetter#data {
+  store { validationLetters }
+  description { "Under Scheme A, where tests according to the additional national requirements included in the OIML-CS Declaration of a Utilizer or Associate have been conducted, the Issuing Authority's letter validating the conformity of the instrument to these requirements (PD-05 §5.6.3). A copy is sent to the BIML with the OIML certificate (at registration)." }
+  indexes { certificate_id issuing_authority_id }
+  id: string {
+    modality SHALL
+  }
+  certificate_id: reference(Certificate) {
+    modality SHALL
+    on_delete cascade
+    required true
+  }
+  issuing_authority_id: reference(IssuingAuthority) {
+    modality SHALL
+    on_delete restrict
+    required true
+  }
+  declaration_id: reference(ParticipantDeclaration) [0..1] {
+    modality MAY
+    definition "The Utilizer/Associate Declaration whose ANRs were validated"
+    on_delete nullify
+  }
+  anrs: string[] [0..*] {
+    modality MAY
+    definition "The additional national requirements validated (as declared)"
+  }
+  letter_text: text {
+    modality SHALL
+    definition "The validation letter text (the IA's conformity validation)"
+  }
+  sent_to_biml: boolean {
+    modality SHALL
+    definition "A copy was sent to the BIML with the certificate (§5.6.3) — flipped at registration"
+  }
+  sent_at: date [0..1] {
+    modality MAY
+  }
+  created: datetime {
+    modality SHALL
+  }
+  modified: datetime {
+    modality SHALL
+  }
+}
+
+class RegisteredCopy#data {
+  store { registeredCopies }
+  description { "The BIML-registered copy of one certificate revision — the scheme's source of truth for validity (B 18:2025 §15.8): the validity of any OIML certificate is verified with the copy registered and published on the OIML-CS pages of the OIML website (the platform's public register). One record per registered revision carrying the digest of the certificate content at registration; an error-correction revision marks the previous copy superseded (PD-05 §8.1.5) while other previous versions stay published (§8.1.7 — archived); deregistration removes the copy from the validity source." }
+  indexes { certificate_id certificate_number status }
+  id: string {
+    modality SHALL
+  }
+  certificate_id: reference(Certificate) {
+    modality SHALL
+    on_delete cascade
+    required true
+  }
+  certificate_number: string {
+    modality SHALL
+  }
+  revision: integer {
+    modality SHALL
+    definition "The certificate revision this copy registers (0 = the initial issue)"
+  }
+  registered_at: date {
+    modality SHALL
+  }
+  digest: string {
+    modality SHALL
+    definition "The SHA-256 digest of the canonical registration content (the validity reference)"
+  }
+  status: enum {
+    modality SHALL
+    definition "current = THE validity reference (§15.8); archived = previous version still published (§8.1.7); superseded = error-corrected previous (§8.1.5); deregistered = removed from the register"
+    enum_values { current archived superseded deregistered }
+  }
+  superseded_by_revision: integer [0..1] {
+    modality MAY
+  }
+  created: datetime {
+    modality SHALL
+  }
+  modified: datetime {
+    modality SHALL
+  }
+}
+
+class CertificateRegistration#data {
+  store { certificateRegistrations }
+  description { "The register-side record of one certificate's registration submission (PD-05 §6): the hub's half of the federation registration sequence. The lifecycle walks the certificate_registration state machine (evaluation/state-machines.prl): ANNOUNCED (the registrant announcement opened the shell) → SUBMITTED (the signed registration package's intake verification passed — the trust registry's check of the signature against the IA's registered org key plus the standing check, and the correlation's orphan check) → PUBLISHED (the auto_publishes hop — the decided register doctrine, the demo-flows program 2026-08-28: the verified signed submission publishes WITHOUT a human gate; the register's trust is in the signature + the receipt machinery and the published record is exactly what the IA signed and sent; the human review surfaces stay as read postures, never a gate) | REFUSED (the intake verification's refusal, the reason recorded — never a silent drop). The publication materializes the RegisteredCopy row (the validity source, B 18:2025 §15.8) and walks the certificate's PENDING_REGISTRATION → ACTIVE hop." }
+  indexes { certificate_id application_id status registrant_id }
+  id: string {
+    modality SHALL
+  }
+  registrant_id: string {
+    modality SHALL
+    definition "The registrant announcement's idempotency key — THE correlation join the registration package references (an unknown or mismatched registrant refuses the intake)"
+  }
+  certificate_id: reference(Certificate) [0..1] {
+    modality MAY
+    definition "The certificate the registration publishes (bound at the SUBMITTED hop — the announcement names the application, the package names the certificate)"
+    on_delete cascade
+    required false
+  }
+  application_id: reference(Application) [0..1] {
+    modality MAY
+    definition "The sender's application id (the chain's global id, carried by the registrant announcement)"
+    on_delete nullify
+    required false
+  }
+  origin: string [0..1] {
+    modality MAY
+    definition "Who the submission's signature verified against at intake: the federation peer instance, the submitting organization's registered key, or the honest unsigned posture (the deployment's declared dev posture) — the intake's verification provenance, never hidden"
+  }
+  registration_reference: string [0..1] {
+    modality MAY
+    definition "The hub's intake reference (the idempotent submission reference the receipts answer)"
+  }
+  registration_number: string [0..1] {
+    modality MAY
+    definition "The register's number for the published record (assigned at publication)"
+  }
+  status: enum {
+    modality SHALL
+    definition "Walks the certificate_registration state machine: ANNOUNCED → SUBMITTED → PUBLISHED (the auto-publish doctrine — no human gate between the verified intake and the publication) | REFUSED (the intake verification's refusal)"
+    enum_values { ANNOUNCED SUBMITTED PUBLISHED REFUSED }
+  }
+  refusal_reason: text [0..1] {
+    modality MAY
+    definition "The written reason the intake verification refused (required when status = REFUSED — PD-05 §6 decisions are stated, never silent)"
+  }
+  submitted_at: datetime [0..1] {
+    modality MAY
+    definition "When the signed registration package passed the intake verification"
+  }
+  published_at: datetime [0..1] {
+    modality MAY
+    definition "When the verified submission published to the register (the auto_publishes hop)"
+  }
+  refused_at: datetime [0..1] {
+    modality MAY
+  }
+  created: datetime {
+    modality SHALL
+  }
+  modified: datetime {
+    modality SHALL
+  }
+}
+
+class AcceptabilityCheck#data {
+  description { "One criterion of a Utilizer/Associate acceptability evaluation (B 18:2025 §5.6.3): the category in Declaration scope, the scheme accepted, the IA/TL accepted, or the MTL policy." }
+  helper { true }
+  id: string {
+    modality SHALL
+    definition "category_in_scope | scheme_accepted | ia_accepted | tl_accepted | mtl_policy"
+  }
+  label: string {
+    modality SHALL
+  }
+  passed: boolean {
+    modality SHALL
+  }
+  detail: string [0..1] {
+    modality MAY
+  }
+}
+