Gateway docs adjustment

Author: jenniferjiangkells

healthchain/gateway/fhir/base.py

@@ -98,15 +98,23 @@ def _register_base_routes(self):
         def capability_statement(
             fhir: "BaseFHIRGateway" = Depends(get_self_gateway),
         ):
-            """Return the FHIR capability statement for this gateway's services."""
+            """Return the FHIR capability statement for this gateway's services.
+
+            Includes both custom transform/aggregate operations (via REST endpoints)
+            and standard FHIR CRUD operations (via Python gateway methods).
+            """
             return fhir.build_capability_statement().model_dump()
 
         # Gateway status endpoint - returns operational metadata
         @self.get("/status", response_class=JSONResponse)
         def gateway_status(
             fhir: "BaseFHIRGateway" = Depends(get_self_gateway),
         ):
-            """Return operational status and metadata for this gateway."""
+            """Return operational status and metadata for this gateway.
+
+            Includes information about supported FHIR CRUD operations,
+            custom transform/aggregate operations, and connected sources.
+            """
             return fhir.get_gateway_status()
 
     def build_capability_statement(self) -> CapabilityStatement:
@@ -117,7 +125,7 @@ def build_capability_statement(self) -> CapabilityStatement:
         handlers, available FHIR sources, and supported operations.
 
         Returns:
-            CapabilityStatement: Enhanced FHIR-compliant capability statement
+            CapabilityStatement: FHIR-compliant capability statement for gateway operations
         """
         # Build resource entries based on registered handlers
         resources = []
@@ -128,12 +136,22 @@ def build_capability_statement(self) -> CapabilityStatement:
             # Add supported interactions based on registered handlers
             for operation in operations:
                 if operation == "transform":
-                    interactions.append({"code": "read"})
+                    interactions.append(
+                        {
+                            "code": "read",
+                            "documentation": "Custom transformation via REST endpoint",
+                        }
+                    )
                     operation_details.append(
                         "Transform: Custom resource transformation"
                     )
                 elif operation == "aggregate":
-                    interactions.append({"code": "search-type"})
+                    interactions.append(
+                        {
+                            "code": "search-type",
+                            "documentation": "Multi-source aggregation via REST endpoint",
+                        }
+                    )
                     operation_details.append("Aggregate: Multi-source data aggregation")
 
             if interactions:
@@ -154,9 +172,15 @@ def build_capability_statement(self) -> CapabilityStatement:
                 sources_info.append(f"Source: {source_name}")
 
         # Enhanced documentation with examples
+        sources_list = (
+            ", ".join(self.connection_manager.sources.keys())
+            if self.connection_manager and hasattr(self.connection_manager, "sources")
+            else "None configured"
+        )
         rest_documentation = (
             "HealthChain FHIR Gateway provides transformation and aggregation services. "
-            f"Available sources: {', '.join(self.connection_manager.sources.keys()) if self.connection_manager and hasattr(self.connection_manager, 'sources') else 'None configured'}. "
+            f"Gateway also provides standard FHIR CRUD operations (create, read, update, delete, search) to connected FHIR servers via Python API. "
+            f"Available sources: {sources_list}. "
             "Use /status endpoint for operational details."
         )
 
@@ -209,7 +233,8 @@ def get_gateway_status(self) -> Dict[str, Any]:
         """
         Get operational status and metadata for this gateway.
 
-        Enhanced with detailed FHIR operation discovery information.
+        Enhanced with detailed FHIR operation discovery information including
+        both standard CRUD operations and custom transform/aggregate operations.
 
         Returns:
             Dict containing gateway operational status and metadata