@memoarchitect/ontology 0.4.4

package/examples/gpca-pump/model/catalog/gpca_operational.sysml

@@ -0,0 +1,209 @@
+package memo_examples_gpca_pump_model_catalog_gpca_operational {
+    private import ScalarValues::*;
+
+    private import memo_architecture_operational::*;
+    private import memo_core_enumerations::*;
+
+    // ── Operational entities beyond the human actors ────────────
+    part entityPharmacy : OperationalEntity {
+        attribute :>> id = "OE-001";
+        attribute :>> name = "HospitalPharmacy";
+        attribute :>> entityKind = OperationalEntityKind::externalSystem;
+        attribute :>> operationalDomain = "medication management";
+        attribute :>> responsibility = "Prepares labeled drug reservoirs and maintains the hospital pharmacy database of drug safe values.";
+    }
+    part entityPowerInfrastructure : OperationalEntity {
+        attribute :>> id = "OE-002";
+        attribute :>> name = "WardPowerInfrastructure";
+        attribute :>> entityKind = OperationalEntityKind::environmentalEntity;
+        attribute :>> operationalDomain = "facility power";
+        attribute :>> responsibility = "Provides mains power; outages are a foreseeable operational condition.";
+    }
+    part entityGpcaPump : OperationalEntity {
+        attribute :>> id = "OE-003";
+        attribute :>> name = "GPCA_Pump";
+        attribute :>> entityKind = OperationalEntityKind::device;
+        attribute :>> operationalDomain = "patient-controlled analgesia therapy";
+        attribute :>> responsibility = "System of interest: delivers programmed basal and bolus analgesia subject to prescription limits.";
+    }
+
+    // ── External entities per CriSys Fig 2.1 ────────────────────
+    part entityPharmacyDb : OperationalEntity {
+        attribute :>> id = "OE-004";
+        attribute :>> name = "HospitalPharmacyDatabase";
+        attribute :>> entityKind = OperationalEntityKind::externalSystem;
+        attribute :>> operationalDomain = "medication safety data";
+        attribute :>> responsibility = "Repository of drug information from manufacturers; stores the safe value ranges for all drugs usable for infusion, retrieved by the GPCA for the programmed drug.";
+        attribute :>> sourceReference = "CITE-001: CriSys GPCA System Requirements (2013), §2.1 and §3.5";
+    }
+    part entityDrugReservoir : OperationalEntity {
+        attribute :>> id = "OE-005";
+        attribute :>> name = "DrugReservoir";
+        attribute :>> entityKind = OperationalEntityKind::device;
+        attribute :>> operationalDomain = "drug storage";
+        attribute :>> responsibility = "Apparatus storing the liquid analgesic drug to be infused; filled according to the prescription and connected to the GPCA by the clinician.";
+        attribute :>> sourceReference = "CITE-001: CriSys GPCA System Requirements (2013), §2.1";
+    }
+    part entityNeedle : OperationalEntity {
+        attribute :>> id = "OE-006";
+        attribute :>> name = "InfusionNeedle";
+        attribute :>> entityKind = OperationalEntityKind::device;
+        attribute :>> operationalDomain = "drug delivery path";
+        attribute :>> responsibility = "Intravenous needle inserted into the patient by the clinician and connected to the GPCA standard CCC connection point (I 5) to infuse the drug.";
+        attribute :>> sourceReference = "CITE-001: CriSys GPCA System Requirements (2013), §2.1 and §3.3 (I 5)";
+    }
+    part entityPrescription : OperationalEntity {
+        attribute :>> id = "OE-007";
+        attribute :>> name = "Prescription";
+        attribute :>> entityKind = OperationalEntityKind::informationArtifact;
+        attribute :>> operationalDomain = "plan of care";
+        attribute :>> responsibility = "Instructions governing the plan of care for an individual patient: the drug to be infused and all administration details; provided by a certified medical practitioner.";
+        attribute :>> sourceReference = "CITE-001: CriSys GPCA System Requirements (2013), §2.1";
+    }
+    part entityHospital : OperationalEntity {
+        attribute :>> id = "OE-008";
+        attribute :>> name = "Hospital";
+        attribute :>> entityKind = OperationalEntityKind::environmentalEntity;
+        attribute :>> operationalDomain = "care environment boundary";
+        attribute :>> responsibility = "Environment boundary: fixed (non-ambulatory) usage location with authorized clinicians and the pharmacy database holding drug safe values.";
+        attribute :>> sourceReference = "CITE-001: CriSys GPCA System Requirements (2013), §2.4";
+    }
+
+    // ── Operational activities (therapy lifecycle) ──────────────
+    part oaPrescribe : OperationalActivity {
+        attribute :>> id = "OA-001";
+        attribute :>> name = "PrescribeTherapy";
+        attribute :>> trigger = "patient requires titrated analgesia";
+        attribute :>> preCondition = "patient assessed; drug has safe-value records in the hospital pharmacy database";
+        attribute :>> postCondition = "prescription with basal rate, bolus volume, lockout, and max dose limits exists";
+        attribute :>> criticality = CriticalityKind::high;
+    }
+    part oaLoadReservoir : OperationalActivity {
+        attribute :>> id = "OA-002";
+        attribute :>> name = "LoadDrugReservoir";
+        attribute :>> trigger = "prescription issued or reservoir empty";
+        attribute :>> preCondition = "labeled reservoir prepared by pharmacy";
+        attribute :>> postCondition = "reservoir mounted, door closed and latched";
+        attribute :>> criticality = CriticalityKind::high;
+    }
+    part oaProgram : OperationalActivity {
+        attribute :>> id = "OA-003";
+        attribute :>> name = "ProgramPrescription";
+        attribute :>> trigger = "reservoir loaded";
+        attribute :>> preCondition = "pump in IDLE; clinician authenticated by key or code";
+        attribute :>> postCondition = "prescription entered, checked against pharmacy-database safe values (I 9-I 11), and confirmed by second review";
+        attribute :>> criticality = CriticalityKind::catastrophic;
+    }
+    part oaStartTherapy : OperationalActivity {
+        attribute :>> id = "OA-004";
+        attribute :>> name = "StartInfusion";
+        attribute :>> trigger = "prescription confirmed";
+        attribute :>> preCondition = "confirmed prescription saved; no active alarm";
+        attribute :>> postCondition = "basal infusion running";
+        attribute :>> criticality = CriticalityKind::catastrophic;
+    }
+    part oaRequestBolus : OperationalActivity {
+        attribute :>> id = "OA-005";
+        attribute :>> name = "RequestPatientBolus";
+        attribute :>> trigger = "patient presses bolus request button";
+        attribute :>> preCondition = "therapy active";
+        attribute :>> postCondition = "bolus delivered, or request ignored when lockout or max-dose limits apply";
+        attribute :>> criticality = CriticalityKind::catastrophic;
+    }
+    part oaRespondAlarm : OperationalActivity {
+        attribute :>> id = "OA-006";
+        attribute :>> name = "RespondToAlarm";
+        attribute :>> trigger = "audible or visual alarm annunciated";
+        attribute :>> preCondition = "alarm condition raised by the pump";
+        attribute :>> postCondition = "cause resolved and therapy resumed, or therapy stopped";
+        attribute :>> criticality = CriticalityKind::catastrophic;
+    }
+    part oaReviewLog : OperationalActivity {
+        attribute :>> id = "OA-007";
+        attribute :>> name = "ReviewEventLog";
+        attribute :>> trigger = "shift change, incident review, or dose audit";
+        attribute :>> preCondition = "event log populated during therapy";
+        attribute :>> postCondition = "delivered doses and alarm history reviewed";
+        attribute :>> criticality = CriticalityKind::medium;
+    }
+    part oaMaintain : OperationalActivity {
+        attribute :>> id = "OA-008";
+        attribute :>> name = "MaintainDevice";
+        attribute :>> trigger = "scheduled maintenance or fault";
+        attribute :>> preCondition = "pump out of clinical use; technician authenticated";
+        attribute :>> postCondition = "battery, calibration, and pharmacy-database connection verified";
+        attribute :>> criticality = CriticalityKind::medium;
+    }
+
+    // ── Operational capabilities ────────────────────────────────
+    part ocTitratedAnalgesia : OperationalCapability {
+        attribute :>> id = "OC-001";
+        attribute :>> name = "DeliverTitratedAnalgesia";
+        attribute :>> capabilityLevel = "primary";
+        attribute :>> preCondition = "confirmed prescription and loaded reservoir";
+        attribute :>> postCondition = "drug delivered within prescribed limits at all times";
+    }
+    part ocFailSafeTherapy : OperationalCapability {
+        attribute :>> id = "OC-002";
+        attribute :>> name = "FailSafeTherapyManagement";
+        attribute :>> capabilityLevel = "safety";
+        attribute :>> preCondition = "any single failure or foreseeable misuse";
+        attribute :>> postCondition = "pump reaches a safe state (infusion stopped or paused) and the operator is alerted";
+    }
+
+    // ── Operational scenarios ───────────────────────────────────
+    part osNominalTherapy : OperationalScenario {
+        attribute :>> id = "OS-001";
+        attribute :>> name = "NominalTherapySession";
+        attribute :>> scenarioKind = ScenarioKind::nominal;
+        attribute :>> preCondition = "prescription issued, reservoir loaded";
+        attribute :>> postCondition = "therapy completed and stopped by clinician";
+        attribute :>> sequenceDescription = "Prescribe > load reservoir > program and confirm > start basal > patient boluses within limits > stop therapy > review log.";
+        attribute :>> sourceReference = "CITE-001: CriSys GPCA System Requirements (2013), §2.2 Main GPCA System Functions";
+    }
+    part osLockoutBolus : OperationalScenario {
+        attribute :>> id = "OS-002";
+        attribute :>> name = "BolusRequestDuringLockout";
+        attribute :>> scenarioKind = ScenarioKind::error;
+        attribute :>> preCondition = "basal infusion active; lockout interval running";
+        attribute :>> postCondition = "request ignored, logged; basal continues unchanged";
+        attribute :>> sequenceDescription = "Patient presses bolus button during lockout > infusion manager rejects request > event logged > no additional drug delivered.";
+        attribute :>> sourceReference = "CITE-001: CriSys GPCA System Requirements (2013), §4.1.9 PATIENT BOLUS mode (lockout requirements)";
+    }
+    part osOcclusionAlarm : OperationalScenario {
+        attribute :>> id = "OS-003";
+        attribute :>> name = "OcclusionDetectedDuringInfusion";
+        attribute :>> scenarioKind = ScenarioKind::alarm;
+        attribute :>> preCondition = "therapy active; downstream line becomes blocked";
+        attribute :>> postCondition = "infusion paused, alarm annunciated, clinician clears occlusion and resumes";
+        attribute :>> sequenceDescription = "Occlusion sensor exceeds pressure threshold > alarm raised same step > infusion paused > audible and visual annunciation > clinician resolves and resumes.";
+        attribute :>> sourceReference = "CITE-004: GIP Hazard Analysis v1.0 (2009), §2.2 Alarms and Alerts (occlusion)";
+    }
+    part osAirInLine : OperationalScenario {
+        attribute :>> id = "OS-004";
+        attribute :>> name = "AirInLineDetected";
+        attribute :>> scenarioKind = ScenarioKind::alarm;
+        attribute :>> preCondition = "therapy active; air bubble enters tubing";
+        attribute :>> postCondition = "infusion stopped before air reaches patient; alarm annunciated";
+        attribute :>> sequenceDescription = "Air-in-line sensor detects bubble above threshold > transition to PAUSED (KVO flow) > High-priority Air embolism notification > clinician re-primes line and restarts.";
+        attribute :>> sourceReference = "CITE-001: CriSys GPCA System Requirements (2013), §4.3 Notification Requirements (REQ 59: Air embolism)";
+    }
+    part osEmptyReservoir : OperationalScenario {
+        attribute :>> id = "OS-005";
+        attribute :>> name = "ReservoirEmptyDuringTherapy";
+        attribute :>> scenarioKind = ScenarioKind::degraded;
+        attribute :>> preCondition = "therapy active; reservoir volume reaches empty threshold";
+        attribute :>> postCondition = "infusion stopped, alarm raised, reservoir replaced";
+        attribute :>> sequenceDescription = "Reservoir-empty condition detected > transition to PAUSED (KVO flow) > High-priority Empty Reservoir notification > clinician loads new reservoir > therapy resumed with saved prescription.";
+        attribute :>> sourceReference = "CITE-001: CriSys GPCA System Requirements (2013), §4.3 Notification Requirements (REQ 59: Empty Reservoir)";
+    }
+    part osPowerLoss : OperationalScenario {
+        attribute :>> id = "OS-006";
+        attribute :>> name = "MainsPowerLossAndRecovery";
+        attribute :>> scenarioKind = ScenarioKind::degraded;
+        attribute :>> preCondition = "therapy active on mains power";
+        attribute :>> postCondition = "therapy continues on battery; prescription preserved across full power loss";
+        attribute :>> sequenceDescription = "Mains lost > battery takes over with notification > if battery depletes, pump stops safely > on power restore, saved prescription recovered and therapy resumed only after clinician confirmation.";
+        attribute :>> sourceReference = "CITE-004: GIP Hazard Analysis v1.0 (2009), §2.4.3 Electrical Hazards (battery failure)";
+    }
+}

package/examples/gpca-pump/model/catalog/gpca_physical.sysml

@@ -0,0 +1,53 @@
+package memo_examples_gpca_pump_model_catalog_gpca_physical {
+    private import ScalarValues::*;
+
+    private import memo_architecture_physical::*;
+    private import memo_core_enumerations::*;
+
+    part mainController : ProcessingNode {
+        attribute :>> id = "PN-001";
+        attribute :>> name = "MainControllerMCU";
+        attribute :>> nodeKind = ProcessingNodeKind::microcontroller;
+        attribute :>> processorArchitecture = "ARM Cortex-M4, lockstep-capable";
+        attribute :>> memoryMB = "1 MB flash / 256 KB SRAM with ECC";
+        attribute :>> operatingSystem = "bare-metal cyclic executive, 20 ms base step";
+        attribute :>> safetyPartition = true;
+        attribute :>> redundancyKind = "hardware watchdog plus independent flow cross-check";
+    }
+
+    part portSensorHarness : PhysicalPort {
+        attribute :>> id = "PP-001";
+        attribute :>> name = "SensorHarnessConnector";
+        attribute :>> portKind = InterfaceKind::digitalSignal;
+        attribute :>> connectorType = "keyed 12-pin locking header";
+        attribute :>> direction = DirectionKind::input;
+    }
+    part portMotorDrive : PhysicalPort {
+        attribute :>> id = "PP-002";
+        attribute :>> name = "MotorDriveConnector";
+        attribute :>> portKind = InterfaceKind::digitalSignal;
+        attribute :>> connectorType = "keyed 6-pin locking header with enable interlock";
+        attribute :>> direction = DirectionKind::output;
+    }
+    part portPatientPendant : PhysicalPort {
+        attribute :>> id = "PP-003";
+        attribute :>> name = "PatientPendantJack";
+        attribute :>> portKind = InterfaceKind::digitalSignal;
+        attribute :>> connectorType = "latching 3.5 mm pendant jack";
+        attribute :>> direction = DirectionKind::input;
+    }
+    part portServiceAccess : PhysicalPort {
+        attribute :>> id = "PP-004";
+        attribute :>> name = "ServiceMaintenancePort";
+        attribute :>> portKind = InterfaceKind::api;
+        attribute :>> connectorType = "covered UART/USB service connector";
+        attribute :>> direction = DirectionKind::bidirectional;
+    }
+    part portMainsInlet : PhysicalPort {
+        attribute :>> id = "PP-005";
+        attribute :>> name = "MainsPowerInlet";
+        attribute :>> portKind = InterfaceKind::power;
+        attribute :>> connectorType = "IEC 60320 C8 inlet";
+        attribute :>> direction = DirectionKind::input;
+    }
+}