sha-claim 0.1.2__tar.gz

sha_claim-0.1.2/.gitignore

@@ -0,0 +1,29 @@
+# secrets — never commit
+.env
+.env.*
+!.env.example
+
+# python
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.venv/
+venv/
+/.venv/
+/.venv
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+.import_linter_cache/
+.hypothesis/
+.coverage
+coverage.xml
+htmlcov/
+
+# os / ide
+.DS_Store
+.idea/
+.vscode/
+postman/*.local.json

sha_claim-0.1.2/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+
+All notable changes to this project are documented here. Format: [Keep a Changelog](https://keepachangelog.com), versioning: [SemVer](https://semver.org).
+
+## [Unreleased]
+
+## [0.1.2] — 2026-09-20
+
+First public release. 49/49 published eClaims endpoints. Live-verified on DHA UAT through visit → diagnosis → line →
+preview; `submit` verified up to the doctor-attachment rule (needs an HWR-registered practitioner). Pre-auth nested
+request arrays remain unverified (docs/api/WORKFLOWS.md Q3). API is 0.x: expect breaking changes before 1.0.
+### Added
+- `consent.send_otp()` (`POST /claims/otp`), `consent.list(patient)`, `session.add_doctor()`; `submit()` takes `discharge_reason` + discharge `otp` (all required by UAT, none documented). `discharge()` now takes a tz-aware `discharged_at`.
+- Wire models treat `null` as absent. `ClaimWorkflowState` / `AuthorizationStatus` populated from live observations.
+- `on_event` hook on `AsyncSHAClient`: one `SDKEvent` per HTTP attempt (operation, status, duration, attempt, trace_id, redacted consent token, error). Emit-only.
+- `VirtualClaim.submission_blockers()` — pure pre-submit check over the server's preview snapshot.
+- `.github/workflows/live.yml` — scheduled UAT smoke run.
+- `docs/GUIDE.md` — consumer guide: every method with parameters, wire call and result fields; recipes; gotchas; generated appendix.
+- Project skeleton, quality gates (ruff, mypy strict, import-linter, pytest ≥ 90 % coverage), CI.
+- Endpoint reference and workflow documentation generated from the DHA AfyaConnect portal, including the portal's example request/response JSON for every endpoint.
+- `Invoice` (with `lines`) on `VirtualClaim`; typed `PayerClaimRecord` (`workflow_state`, `tracking_number`, `proposed_value`, …).
+- `AsyncSHAClient` with OAuth2 client-credentials auth (cached, single-flight refresh, 401 replay), idempotent-only retries with jittered backoff, typed error translation (incl. `trace_id`).
+- `sha.eligibility.check()` — `GET /patients/eligibility` mapped to an `Eligibility` read model; verified against DHA UAT.
+- `sha.eligibility.benefits/sub_benefits/interventions()` — benefit hierarchy with tariffs and preauth flags; `InterventionCoverage.service_type_for_authorization` encodes the CAPITATION rule observed on UAT.
+- `sha.consent.authorize/get/reject()` — two-step OTP consent (authorize sends the OTP); verified live incl. reject.
+- `sha.claims.open_visit()` — opens the virtual claim with `Otp`, `BiometricGuid` or `MatchId` proof; returns `VirtualClaim` with a redacted `ConsentToken`.
+- `ClaimSession` (from `sha.claims.open_visit()` or `sha.claims.resume(token)`): add/retire/restore interventions, add/remove diagnoses, add/remove/edit billing lines, attach/remove documents, `preview`, `submit` (attempted once; ambiguity → `SubmissionOutcomeUnknownError`), `close`, `payer_status`. 15 endpoints, contract-tested against the published spec.
+- Pre-authorisation on `ClaimSession`: `request_preauth`, `preauths`, `remove_preauth_diagnosis`, `remove_preauth_doctor`, `cancel_preauth`, `request_doctor_consent`. Nested array encoding follows the API's own field vocabulary and is isolated in one function pending UAT confirmation.
+- Inpatient discharge (`send_discharge_otp`, `discharge`), `add_next_of_kin`, `resubmit_lines` on `ClaimSession`.
+- ePrescriptions on `ClaimSession`: `prescribe` (`MedicationOrder` items), `prescription`, `dispense` (`DispensedProduct`), `remove_prescription_doctor`. Request bodies asserted against the portal's published item shapes.
+- Emergency: `sha.emergency.open_case()` (identified or unidentified casualty) → `ClaimSession`; `sha.emergency.protocols()`; on the session `add_protocol`, `add_emergency_doctor`, `remove_emergency_doctor`, `open_emt_claim`.
+- `ClaimGateways` bundle: `ClaimSession` takes one gateway set instead of a growing argument list.
+- `switch_intervention` on `ClaimSession`; `sha.eligibility.utilization / pomsf_balances / bed_occupancy`; `sha.files.upload / download_link`. All 49 published endpoints now have a request builder, guarded by a test.
+- Error translation unwraps upstream JSON blobs in `error`, `details[]`, and trailing JSON in `message`.
+- Domain value objects: identifiers (redacted `ConsentToken`), ICD/intervention codes, `Money`, documented enums, lenient server-status enums.

sha_claim-0.1.2/LICENSE

@@ -0,0 +1,176 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+         Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+         stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+         that You distribute, all copyright, patent, trademark, and
+         attribution notices from the Source form of the Work,
+         excluding those notices that do not pertain to any part of
+         the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+         distribution, then any Derivative Works that You distribute must
+         include a readable copy of the attribution notices contained
+         within such NOTICE file, excluding those notices that do not
+         pertain to any part of the Derivative Works, in at least one
+         of the following places: within a NOTICE text file distributed
+         as part of the Derivative Works; within the Source form or
+         documentation, if provided along with the Derivative Works; or,
+         within a display generated by the Derivative Works, if and
+         wherever such third-party notices normally appear. The contents
+         of the NOTICE file are for informational purposes only and
+         do not modify the License. You may add Your own attribution
+         notices within Derivative Works that You distribute, alongside
+         or as an addendum to the NOTICE text from the Work, provided
+         that such additional attribution notices cannot be construed
+         as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

sha_claim-0.1.2/PKG-INFO

@@ -0,0 +1,152 @@
+Metadata-Version: 2.5
+Name: sha-claim
+Version: 0.1.2
+Summary: Python SDK for Kenya SHA claims via the DHA AfyaConnect HIE eClaims API
+Project-URL: Homepage, https://github.com/kahdichienja/rocket
+Project-URL: Documentation, https://github.com/kahdichienja/rocket/blob/main/docs/GUIDE.md
+Project-URL: Changelog, https://github.com/kahdichienja/rocket/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/kahdichienja/rocket/issues
+Author: NaCare
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: afyaconnect,claims,dha,health,hie,kenya,sha
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Healthcare Industry
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.27
+Requires-Dist: pydantic>=2.7
+Provides-Extra: dev
+Requires-Dist: hypothesis>=6; extra == 'dev'
+Requires-Dist: import-linter>=2; extra == 'dev'
+Requires-Dist: mypy>=1.11; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
+Requires-Dist: pytest-cov>=5; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: python-dotenv>=1; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# sha-claim
+
+Python SDK for **Social Health Authority (SHA, Kenya)** claims through the Digital Health Agency's
+**AfyaConnect HIE eClaims API**. Async-first, typed, framework-free.
+
+> Status: pre-release (`0.1.0.dev0`). All 49 published endpoints implemented. Eligibility, benefits and consent are
+> verified live against DHA UAT; the claim lifecycle (`ClaimSession`) is contract-tested against the published
+> spec and awaits a UAT beneficiary with a reachable phone for live verification. See [PLAN.md](PLAN.md).
+
+## Install
+
+```bash
+pip install sha-claim
+```
+
+## Configure
+
+Credentials come from DHA onboarding. The facility is implied by the credential (it is embedded in the token).
+
+```bash
+export SHA_ENVIRONMENT=uat          # uat | production (production also needs SHA_BASE_URL)
+export SHA_CLIENT_ID=...
+export SHA_CLIENT_SECRET=...
+```
+
+## Use
+
+```python
+import asyncio
+from datetime import date
+from sha_claim import AsyncSHAClient, IdentificationType, BadRequestError
+
+
+async def main() -> None:
+    async with AsyncSHAClient.from_env() as sha:
+        try:
+            e = await sha.eligibility.check("12345678", IdentificationType.NATIONAL_ID)
+        except BadRequestError as err:  # server-side validation, carries trace_id
+            print(err.trace_id, err)
+            return
+        if e.is_covered_on(date.today()):
+            print(e.full_name, e.patient_id, [s.name for s in e.active_schemes_on(date.today())])
+
+
+asyncio.run(main())
+```
+
+### A claim, end to end
+
+```python
+from sha_claim import (
+    AsyncSHAClient,
+    Money,
+    Otp,
+    ServiceType,
+    DocumentType,
+    Attachment,
+    SubmissionOutcomeUnknownError,
+)
+
+async with AsyncSHAClient.from_env() as sha:
+    patient = (await sha.eligibility.check("12345678", IdentificationType.NATIONAL_ID)).patient_id
+    coverage = await sha.eligibility.interventions(patient, "SHA-12-SC-01")
+    consultation = next(c for c in coverage if c.name == "Consultation")
+
+    # 1. consent: this sends the OTP to the beneficiary's registered phone
+    auth = await sha.consent.authorize(
+        patient, consultation.service_type_for_authorization, [consultation.code]
+    )
+
+    # 2. open the server-side virtual claim with the OTP the patient read out
+    session = await sha.claims.open_visit(
+        patient, consultation.service_type_for_authorization, [consultation.code], Otp("123456")
+    )
+
+    # 3. build it — every call is keyed by the session's consent_token
+    await session.add_diagnosis("1A00", consultation.code)
+    await session.add_line(consultation.code, Money.kes("1500"), quantity=1, diagnoses=["1A00"])
+    await session.attach(Attachment.from_path("invoice.pdf", DocumentType.INVOICE), consultation.code)
+
+    # 4. verify, then submit exactly once
+    preview = await session.preview()
+    try:
+        claim = await session.submit(invoice_number="INV-2026-000123")
+    except SubmissionOutcomeUnknownError:
+        claim = await session.preview()  # the server knows whether it went through; ask it
+
+    # later, from any process that persisted the token:
+    status = await sha.claims.resume(claim.consent_token).payer_status("INV-2026-000123")
+```
+
+Every error is a subclass of `sha_claim.SHAClaimError`; see `sha_claim.errors`.
+
+**New to the SDK?** Read the [Consumer Guide](docs/GUIDE.md) — every method, its parameters, the HTTP call it makes, and the object it returns, plus end-to-end recipes.
+
+## Design in one paragraph
+
+The server owns the claim: you open a *virtual claim*, receive a `consent_token`, mutate the claim
+call by call, then submit. The SDK mirrors that faithfully — it holds **snapshots**, not a local
+state machine — and only rejects locally what the server will certainly reject. Reads are retried
+with backoff; `submit` is attempted exactly once. Layers follow Clean Architecture and are enforced
+by `import-linter`. Details: [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md); API reference generated
+from the official portal: [docs/api/](docs/api/README.md).
+
+## Develop
+
+```bash
+make install      # venv + editable install with dev extras
+make check        # ruff, mypy --strict, import-linter, pytest (≥ 90 % coverage)
+make live         # RUN_LIVE=1: smoke tests against DHA UAT (needs .env)
+```
+
+## License
+
+Apache-2.0

sha_claim-0.1.2/README.md

@@ -0,0 +1,115 @@
+# sha-claim
+
+Python SDK for **Social Health Authority (SHA, Kenya)** claims through the Digital Health Agency's
+**AfyaConnect HIE eClaims API**. Async-first, typed, framework-free.
+
+> Status: pre-release (`0.1.0.dev0`). All 49 published endpoints implemented. Eligibility, benefits and consent are
+> verified live against DHA UAT; the claim lifecycle (`ClaimSession`) is contract-tested against the published
+> spec and awaits a UAT beneficiary with a reachable phone for live verification. See [PLAN.md](PLAN.md).
+
+## Install
+
+```bash
+pip install sha-claim
+```
+
+## Configure
+
+Credentials come from DHA onboarding. The facility is implied by the credential (it is embedded in the token).
+
+```bash
+export SHA_ENVIRONMENT=uat          # uat | production (production also needs SHA_BASE_URL)
+export SHA_CLIENT_ID=...
+export SHA_CLIENT_SECRET=...
+```
+
+## Use
+
+```python
+import asyncio
+from datetime import date
+from sha_claim import AsyncSHAClient, IdentificationType, BadRequestError
+
+
+async def main() -> None:
+    async with AsyncSHAClient.from_env() as sha:
+        try:
+            e = await sha.eligibility.check("12345678", IdentificationType.NATIONAL_ID)
+        except BadRequestError as err:  # server-side validation, carries trace_id
+            print(err.trace_id, err)
+            return
+        if e.is_covered_on(date.today()):
+            print(e.full_name, e.patient_id, [s.name for s in e.active_schemes_on(date.today())])
+
+
+asyncio.run(main())
+```
+
+### A claim, end to end
+
+```python
+from sha_claim import (
+    AsyncSHAClient,
+    Money,
+    Otp,
+    ServiceType,
+    DocumentType,
+    Attachment,
+    SubmissionOutcomeUnknownError,
+)
+
+async with AsyncSHAClient.from_env() as sha:
+    patient = (await sha.eligibility.check("12345678", IdentificationType.NATIONAL_ID)).patient_id
+    coverage = await sha.eligibility.interventions(patient, "SHA-12-SC-01")
+    consultation = next(c for c in coverage if c.name == "Consultation")
+
+    # 1. consent: this sends the OTP to the beneficiary's registered phone
+    auth = await sha.consent.authorize(
+        patient, consultation.service_type_for_authorization, [consultation.code]
+    )
+
+    # 2. open the server-side virtual claim with the OTP the patient read out
+    session = await sha.claims.open_visit(
+        patient, consultation.service_type_for_authorization, [consultation.code], Otp("123456")
+    )
+
+    # 3. build it — every call is keyed by the session's consent_token
+    await session.add_diagnosis("1A00", consultation.code)
+    await session.add_line(consultation.code, Money.kes("1500"), quantity=1, diagnoses=["1A00"])
+    await session.attach(Attachment.from_path("invoice.pdf", DocumentType.INVOICE), consultation.code)
+
+    # 4. verify, then submit exactly once
+    preview = await session.preview()
+    try:
+        claim = await session.submit(invoice_number="INV-2026-000123")
+    except SubmissionOutcomeUnknownError:
+        claim = await session.preview()  # the server knows whether it went through; ask it
+
+    # later, from any process that persisted the token:
+    status = await sha.claims.resume(claim.consent_token).payer_status("INV-2026-000123")
+```
+
+Every error is a subclass of `sha_claim.SHAClaimError`; see `sha_claim.errors`.
+
+**New to the SDK?** Read the [Consumer Guide](docs/GUIDE.md) — every method, its parameters, the HTTP call it makes, and the object it returns, plus end-to-end recipes.
+
+## Design in one paragraph
+
+The server owns the claim: you open a *virtual claim*, receive a `consent_token`, mutate the claim
+call by call, then submit. The SDK mirrors that faithfully — it holds **snapshots**, not a local
+state machine — and only rejects locally what the server will certainly reject. Reads are retried
+with backoff; `submit` is attempted exactly once. Layers follow Clean Architecture and are enforced
+by `import-linter`. Details: [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md); API reference generated
+from the official portal: [docs/api/](docs/api/README.md).
+
+## Develop
+
+```bash
+make install      # venv + editable install with dev extras
+make check        # ruff, mypy --strict, import-linter, pytest (≥ 90 % coverage)
+make live         # RUN_LIVE=1: smoke tests against DHA UAT (needs .env)
+```
+
+## License
+
+Apache-2.0