MANSOQ Knowledge
← Technical API reference

Backend resource · STATIC DECLARATIONS

Claim Consent API reference · mansoq-nhcx

Static source contract for Claim Consent: 3 declared or inherited operation mappings, schema/field evidence and authorization/refusal references. Deployment and behavioral review remain explicit.

Static API contract — behavior review pending. Source baseline f6e9f05f76d4.

Enable JavaScript to inspect structured operation, parameter, schema and permission evidence. Download this reference and its evidence.

Declared route and availability

This resource is declared in mansoq-nhcx at /api/{installed_plugin_prefix}/claim-consent/. plugin/local mount; actual prefix and enablement require deployment verification A registered path and an indexed handler do not prove deployment availability, user permission or production readiness.

Operation map

Method Path Action Evidence
GET /api/{installed_plugin_prefix}/claim-consent/ list declared/inherited method
GET /api/{installed_plugin_prefix}/claim-consent/{external_id}/ retrieve declared/inherited method
GET /api/{installed_plugin_prefix}/claim-consent/lookup/ lookup @action declaration

list · GET

GET /api/{installed_plugin_prefix}/claim-consent/ — action list. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
deployment mount installed_plugin_prefix deployment-selected mount prefix true

response: ClaimConsentRetrieveSpec. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
meta dict false No extra constraint extracted
id UUID4 | None false No extra constraint extracted
created_date datetime | None false No extra constraint extracted
modified_date datetime | None false No extra constraint extracted
stage str true No extra constraint extracted
payer_id str true No extra constraint extracted
claim UUID4 | None false No extra constraint extracted
encounter UUID4 | None false No extra constraint extracted
patient UUID4 | None false No extra constraint extracted
account UUID4 | None false No extra constraint extracted
cycle int | None false No extra constraint extracted
expires_in int true No extra constraint extracted
refresh_expires_in int true No extra constraint extracted
accounts list[dict] false No extra constraint extracted

Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.

retrieve · GET

GET /api/{installed_plugin_prefix}/claim-consent/{external_id}/ — action retrieve. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
deployment mount installed_plugin_prefix deployment-selected mount prefix true
path external_id router lookup string; semantic ID validation requires handler/schema review true

response: ClaimConsentRetrieveSpec. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.

lookup · GET

GET /api/{installed_plugin_prefix}/claim-consent/lookup/ — action lookup. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
deployment mount installed_plugin_prefix deployment-selected mount prefix true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location Field Declared/inferred read type Requiredness evidence
query payer_id not declared at read site not established
query encounter_id not declared at read site not established
query stage not declared at read site not established

decorator responses: ClaimConsentRetrieveSpec. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.

Declared refusal/error evidence: ValidationError: Query parameters payerId and encounterId are required (aliases: payer_id, encounter_id, encounter)..

Integration review checklist

Confirm the installed route and full schema; review authentication, organization/facility scoping, all accepted fields, value-state and date/time semantics, idempotency, pagination, response/exception branches and the allowed correction/reversal workflow. Test positive and negative cases with synthetic data. This source reference does not establish external certification or replace an illustrated user procedure.

Pinned source evidence

Links require access to the private source repository.