oehrpy 0.1.1__py3-none-any.whl → 0.2.0__py3-none-any.whl

{oehrpy-0.1.1.dist-info → oehrpy-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: oehrpy
-Version: 0.1.1
+Version: 0.2.0
 Summary: A Python SDK for openEHR with type-safe Reference Model classes, template builders, and EHRBase client
 Project-URL: Homepage, https://github.com/platzhersh/oehrpy
 Project-URL: Documentation, https://github.com/platzhersh/oehrpy#readme

{oehrpy-0.1.1.dist-info → oehrpy-0.2.0.dist-info}/RECORD

@@ -1,8 +1,8 @@
 openehr_sdk/__init__.py,sha256=Rzs3NFgVa-P2ljZu2-OXcgkKBrhE_mAwWf9HnnVwrB8,1295
 openehr_sdk/aql/__init__.py,sha256=auR0SKnnnAhzRzq2nU0YZSzUPKmAzYoXXdWs9Kxzoq8,958
 openehr_sdk/aql/builder.py,sha256=XptfUJVuMbUAa-LY-XFWxWDXFzBbMSHZStNloz2PAGo,17053
-openehr_sdk/client/__init__.py,sha256=swqiwHCbwyIvq_newgkUEfGq6FvHV_CFfU_fYw2rw08,626
-openehr_sdk/client/ehrbase.py,sha256=m3Ml8MZ0YBzY6oWOWgpxc2aqWytfTth35E7e3FVWr-k,22242
+openehr_sdk/client/__init__.py,sha256=GTa8fnE-6tLCYGCthxF_PAVVoJ_ESVkPfVWFdlemAlE,822
+openehr_sdk/client/ehrbase.py,sha256=ZVR7sySYfIc6aB5WZnnx3-TDnAjCT7vPFJZr61ziJww,28480
 openehr_sdk/rm/__init__.py,sha256=yS5JAFaUuoo3D-k_Q9V78j2cBQKTW4EMK9LYEl34ZAc,457
 openehr_sdk/rm/rm_types.py,sha256=7DLcfubGplYPIhF6byBsrnEO0ayOw_bBeJbzrDqbZ-Q,50518
 openehr_sdk/serialization/__init__.py,sha256=aucmds3NXlq1nQrjQNZnYR6PzqT63lAcCLh3og2AtM8,748
@@ -12,7 +12,7 @@ openehr_sdk/templates/__init__.py,sha256=_9Fwua5Mw_mM5n9CaKqXql12GSQyVvqdc_-J-jx
 openehr_sdk/templates/builder_generator.py,sha256=oTYcsvmwGasUfGU3zmW9O79eCFyyprO4hkGJ5SvMB5I,13679
 openehr_sdk/templates/builders.py,sha256=CJuOrobrCNWBbEyHbVJTzGqxApZ7CAyZrhUmY9ctvWg,13665
 openehr_sdk/templates/opt_parser.py,sha256=WzOFYUHgAYTn7hk8LWghqP2gjiG9t3LWlYpQ3-999pg,12423
-oehrpy-0.1.1.dist-info/METADATA,sha256=oxbOaOJ4OQ0btd6x7NvUsWlz6Leo5N1KdeuJpWjb80g,11972
-oehrpy-0.1.1.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
-oehrpy-0.1.1.dist-info/licenses/LICENSE,sha256=2RQ4UN7dGDVJh_e9NTzuaUzdMWMDsy1jgLPxKxJahus,1073
-oehrpy-0.1.1.dist-info/RECORD,,
+oehrpy-0.2.0.dist-info/METADATA,sha256=l4yTTO-SCYrJRjifCxqQ4wJUEN2i5gt8-jVuC-wCqKQ,11972
+oehrpy-0.2.0.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
+oehrpy-0.2.0.dist-info/licenses/LICENSE,sha256=2RQ4UN7dGDVJh_e9NTzuaUzdMWMDsy1jgLPxKxJahus,1073
+oehrpy-0.2.0.dist-info/RECORD,,

openehr_sdk/client/__init__.py

@@ -9,13 +9,16 @@ from .ehrbase import (
     AuthenticationError,
     CompositionFormat,
     CompositionResponse,
+    CompositionVersionResponse,
     EHRBaseClient,
     EHRBaseConfig,
     EHRBaseError,
     EHRResponse,
     NotFoundError,
+    PreconditionFailedError,
     QueryResponse,
     ValidationError,
+    VersionedCompositionResponse,
 )
 
 __all__ = [
@@ -24,9 +27,12 @@ __all__ = [
     "EHRResponse",
     "CompositionResponse",
     "CompositionFormat",
+    "CompositionVersionResponse",
     "QueryResponse",
+    "VersionedCompositionResponse",
     "EHRBaseError",
     "AuthenticationError",
     "NotFoundError",
+    "PreconditionFailedError",
     "ValidationError",
 ]

openehr_sdk/client/ehrbase.py

@@ -72,6 +72,12 @@ class ValidationError(EHRBaseError):
     pass
 
 
+class PreconditionFailedError(EHRBaseError):
+    """Version conflict — the If-Match header did not match (HTTP 412)."""
+
+    pass
+
+
 # Response dataclasses
 
 
@@ -178,6 +184,58 @@ class TemplateResponse:
         )
 
 
+@dataclass
+class VersionedCompositionResponse:
+    """Response from versioned composition metadata endpoint."""
+
+    uid: str
+    owner_id: str | None = None
+    time_created: str | None = None
+
+    @classmethod
+    def from_response(cls, data: dict[str, Any]) -> VersionedCompositionResponse:
+        """Create from API response."""
+        uid_data = data.get("uid", {})
+        uid = uid_data.get("value", "") if isinstance(uid_data, dict) else uid_data or ""
+        owner_data = data.get("owner_id", {})
+        owner_id = owner_data.get("value", "") if isinstance(owner_data, dict) else owner_data
+        time_created_data = data.get("time_created", {})
+        time_created = (
+            time_created_data.get("value", "")
+            if isinstance(time_created_data, dict)
+            else time_created_data
+        )
+        return cls(uid=uid, owner_id=owner_id, time_created=time_created)
+
+
+@dataclass
+class CompositionVersionResponse:
+    """Response from a specific composition version endpoint."""
+
+    version_uid: str
+    preceding_version_uid: str | None = None
+    lifecycle_state: str | None = None
+    commit_audit: dict[str, Any] | None = None
+    data: dict[str, Any] | None = None
+
+    @classmethod
+    def from_response(cls, data: dict[str, Any]) -> CompositionVersionResponse:
+        """Create from API response."""
+        uid_data = data.get("uid", {})
+        version_uid = uid_data.get("value", "") if isinstance(uid_data, dict) else uid_data or ""
+        preceding = data.get("preceding_version_uid", {})
+        preceding_uid = preceding.get("value", "") if isinstance(preceding, dict) else preceding
+        lifecycle = data.get("lifecycle_state", {})
+        lifecycle_state = lifecycle.get("value", "") if isinstance(lifecycle, dict) else lifecycle
+        return cls(
+            version_uid=version_uid,
+            preceding_version_uid=preceding_uid or None,
+            lifecycle_state=lifecycle_state or None,
+            commit_audit=data.get("commit_audit"),
+            data=data.get("data"),
+        )
+
+
 @dataclass
 class EHRBaseConfig:
     """Configuration for EHRBase client."""
@@ -280,6 +338,11 @@ class EHRBaseClient:
                 "Resource not found",
                 status_code=response.status_code,
             )
+        if response.status_code == 412:
+            raise PreconditionFailedError(
+                "Version conflict: the preceding version UID does not match the latest version",
+                status_code=response.status_code,
+            )
         if response.status_code == 400 or response.status_code == 422:
             try:
                 error_data = response.json()
@@ -483,7 +546,8 @@ class EHRBaseClient:
     async def update_composition(
         self,
         ehr_id: str,
-        composition_uid: str,
+        versioned_object_uid: str,
+        preceding_version_uid: str,
         composition: dict[str, Any],
         template_id: str | None = None,
         format: str | CompositionFormat = CompositionFormat.FLAT,
@@ -492,24 +556,27 @@ class EHRBaseClient:
 
         Args:
             ehr_id: The EHR ID.
-            composition_uid: The composition UID (versioned).
+            versioned_object_uid: The composition's UUID (used in the request path).
+            preceding_version_uid: Full version string (e.g. ``uuid::domain::1``),
+                sent as the ``If-Match`` header for optimistic concurrency.
             composition: The updated composition data.
             template_id: Template ID.
             format: Composition format.
 
         Returns:
             CompositionResponse with updated composition.
+
+        Raises:
+            PreconditionFailedError: If the preceding version UID does not match
+                the latest version (HTTP 412).
+            NotFoundError: If the composition has been deleted (HTTP 404).
         """
         format_str = format.value if isinstance(format, CompositionFormat) else format
 
-        # Extract versioned object UID (uuid::system::version -> uuid::system)
-        uid_parts = composition_uid.split("::")
-        versioned_object_uid = "::".join(uid_parts[:2]) if len(uid_parts) >= 2 else composition_uid
-
         headers = {
             "Prefer": "return=representation",
             "Content-Type": "application/json",
-            "If-Match": composition_uid,
+            "If-Match": preceding_version_uid,
         }
 
         params = {}
@@ -548,6 +615,111 @@ class EHRBaseClient:
         )
         self._handle_response(response)
 
+    # Composition Versioning Operations
+
+    async def get_composition_at_time(
+        self,
+        ehr_id: str,
+        versioned_object_uid: str,
+        version_at_time: str,
+        format: str | CompositionFormat = CompositionFormat.CANONICAL,
+    ) -> CompositionResponse:
+        """Get a composition as it existed at a specific point in time.
+
+        Args:
+            ehr_id: The EHR ID.
+            versioned_object_uid: The composition's UUID.
+            version_at_time: ISO 8601 timestamp.
+            format: Desired response format.
+
+        Returns:
+            CompositionResponse with the composition at that time.
+        """
+        format_str = format.value if isinstance(format, CompositionFormat) else format
+
+        params: dict[str, str] = {"version_at_time": version_at_time}
+        if format_str:
+            params["format"] = format_str
+
+        response = await self.client.get(
+            f"/rest/openehr/v1/ehr/{ehr_id}/composition/{versioned_object_uid}",
+            params=params,
+        )
+
+        data = self._handle_response(response)
+        return CompositionResponse.from_response(data, ehr_id)
+
+    async def get_versioned_composition(
+        self,
+        ehr_id: str,
+        versioned_object_uid: str,
+    ) -> VersionedCompositionResponse:
+        """Get versioned composition metadata.
+
+        Args:
+            ehr_id: The EHR ID.
+            versioned_object_uid: The composition's UUID.
+
+        Returns:
+            VersionedCompositionResponse with metadata (UID, owner ID, time created).
+        """
+        response = await self.client.get(
+            f"/rest/openehr/v1/ehr/{ehr_id}/versioned_composition/{versioned_object_uid}",
+        )
+
+        data = self._handle_response(response)
+        return VersionedCompositionResponse.from_response(data)
+
+    async def get_composition_version(
+        self,
+        ehr_id: str,
+        versioned_object_uid: str,
+        version_uid: str,
+    ) -> CompositionVersionResponse:
+        """Get a specific version of a composition.
+
+        Args:
+            ehr_id: The EHR ID.
+            versioned_object_uid: The composition's UUID.
+            version_uid: The specific version UID (e.g. ``uuid::domain::1``).
+
+        Returns:
+            CompositionVersionResponse with full version and audit metadata.
+        """
+        response = await self.client.get(
+            f"/rest/openehr/v1/ehr/{ehr_id}/versioned_composition/{versioned_object_uid}/version/{version_uid}",
+        )
+
+        data = self._handle_response(response)
+        return CompositionVersionResponse.from_response(data)
+
+    async def list_composition_versions(
+        self,
+        ehr_id: str,
+        versioned_object_uid: str,
+    ) -> list[CompositionVersionResponse]:
+        """List all versions of a composition.
+
+        Args:
+            ehr_id: The EHR ID.
+            versioned_object_uid: The composition's UUID.
+
+        Returns:
+            List of CompositionVersionResponse with version descriptors.
+        """
+        response = await self.client.get(
+            f"/rest/openehr/v1/ehr/{ehr_id}/versioned_composition/{versioned_object_uid}/version",
+        )
+
+        data = self._handle_response(response)
+        if isinstance(data, list):
+            return [CompositionVersionResponse.from_response(v) for v in data]
+        # Some servers return the list under a key
+        versions = data.get("versions", data.get("items", []))
+        if isinstance(versions, list):
+            return [CompositionVersionResponse.from_response(v) for v in versions]
+        return []
+
     # Query Operations
 
     async def query(