MANSOQ Knowledge
← Technical API reference

Backend resource · STATIC DECLARATIONS

Coverage Eligibility Request API reference · mansoq-nhcx

Static source contract for Coverage Eligibility Request: 8 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}/coverage-eligibility-request/. 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}/coverage-eligibility-request/ list declared/inherited method
POST /api/{installed_plugin_prefix}/coverage-eligibility-request/ create declared/inherited method
GET /api/{installed_plugin_prefix}/coverage-eligibility-request/{external_id}/ retrieve declared/inherited method
DELETE /api/{installed_plugin_prefix}/coverage-eligibility-request/{external_id}/ destroy declared/inherited method
GET /api/{installed_plugin_prefix}/coverage-eligibility-request/latest/ latest @action declaration
POST /api/{installed_plugin_prefix}/coverage-eligibility-request/{external_id}/check/ check @action declaration
POST /api/{installed_plugin_prefix}/coverage-eligibility-request/{external_id}/wallet_check/ wallet_check @action declaration
POST /api/{installed_plugin_prefix}/coverage-eligibility-request/{external_id}/link_encounter/ link_encounter @action declaration

list · GET

GET /api/{installed_plugin_prefix}/coverage-eligibility-request/ — 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

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

Location Field Declared/inferred read type Requiredness evidence
query unique_by_policy not declared at read site not established

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

Field Type Required Constraints
meta dict false No extra constraint extracted
id UUID4 false No extra constraint extracted
created_date datetime | None false No extra constraint extracted
modified_date datetime | None false No extra constraint extracted
status str true No extra constraint extracted
priority str true No extra constraint extracted
purpose list[str] true No extra constraint extracted
insurer dict true No extra constraint extracted
supporting_info list[dict] true No extra constraint extracted
insurance list[dict] true No extra constraint extracted
item list[dict] true No extra constraint extracted
dispatched_at datetime | None false No extra constraint extracted
dispatch_error str false No extra constraint extracted
dispatch_status str false No extra constraint extracted
is_automatic bool false No extra constraint extracted
provider UUID4 true No extra constraint extracted
patient UUID4 true No extra constraint extracted
encounter UUID4 | None false No extra constraint extracted
appointment UUID4 | None false No extra constraint extracted
latest_response dict | None false No extra constraint extracted
created_by dict | None false No extra constraint extracted
updated_by dict | None 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.

create · POST

POST /api/{installed_plugin_prefix}/coverage-eligibility-request/ — action create. 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
body form_submission not declared at read site not established

request: CoverageEligibilityRequestCreateSpec. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
meta dict false No extra constraint extracted
id UUID4 false No extra constraint extracted
created_date datetime | None false No extra constraint extracted
modified_date datetime | None false No extra constraint extracted
status CoverageEligibilityRequestStatusChoices true No extra constraint extracted
priority CoverageEligibilityRequestPriorityChoices true No extra constraint extracted
purpose list[CoverageEligibilityRequestPurposeChoices] false min_length: 1
facility UUID4 true No extra constraint extracted
patient UUID4 true No extra constraint extracted
encounter UUID4 | None false No extra constraint extracted
appointment UUID4 | None false No extra constraint extracted
supporting_info list[CoverageEligibilityRequestSupportingInfoSpec] false No extra constraint extracted
insurance list[CoverageEligibilityRequestInsuranceSpec] false min_length: 1
item list[CoverageEligibilityRequestItemSpec] false No extra constraint extracted

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

Field Type Required Constraints
meta dict false No extra constraint extracted
id UUID4 false No extra constraint extracted
created_date datetime | None false No extra constraint extracted
modified_date datetime | None false No extra constraint extracted
status str true No extra constraint extracted
priority str true No extra constraint extracted
purpose list[str] true No extra constraint extracted
insurer dict true No extra constraint extracted
supporting_info list[dict] true No extra constraint extracted
insurance list[dict] true No extra constraint extracted
item list[dict] true No extra constraint extracted
dispatched_at datetime | None false No extra constraint extracted
dispatch_error str false No extra constraint extracted
dispatch_status str false No extra constraint extracted
is_automatic bool false No extra constraint extracted
provider UUID4 true No extra constraint extracted
patient UUID4 true No extra constraint extracted
encounter UUID4 | None false No extra constraint extracted
appointment UUID4 | None false No extra constraint extracted
latest_response dict | None false No extra constraint extracted
created_by dict | None false No extra constraint extracted
updated_by dict | None 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}/coverage-eligibility-request/{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: CoverageEligibilityRequestRetrieveSpec. 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.

destroy · DELETE

DELETE /api/{installed_plugin_prefix}/coverage-eligibility-request/{external_id}/ — action destroy. 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

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.

Explicit response statuses in observed code: status.HTTP_204_NO_CONTENT. Other branches/framework exception handling may differ.

Declared refusal/error evidence: ValidationError: This coverage eligibility request has already been submitted to the payer and can no longer be removed..

latest · GET

GET /api/{installed_plugin_prefix}/coverage-eligibility-request/latest/ — action latest. 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

decorator responses: CoverageEligibilityRequestRetrieveSpec. 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.

check · POST

POST /api/{installed_plugin_prefix}/coverage-eligibility-request/{external_id}/check/ — action check. 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

decorator responses: CoverageEligibilityRequestRetrieveSpec. 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.

Explicit response statuses in observed code: status.HTTP_200_OK. Other branches/framework exception handling may differ.

Declared refusal/error evidence: ValidationError: An encounter is required before submitting the coverage eligibility request.

wallet_check · POST

POST /api/{installed_plugin_prefix}/coverage-eligibility-request/{external_id}/wallet_check/ — action wallet_check. 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

decorator responses: CoverageEligibilityRequestRetrieveSpec. 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.

Explicit response statuses in observed code: status.HTTP_200_OK. Other branches/framework exception handling may differ.

link_encounter · POST

POST /api/{installed_plugin_prefix}/coverage-eligibility-request/{external_id}/link_encounter/ — action link_encounter. 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

body validation: CoverageEligibilityRequestLinkEncounterSpec. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
encounter UUID4 true No extra constraint extracted

decorator request: CoverageEligibilityRequestLinkEncounterSpec. 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.

decorator responses: CoverageEligibilityRequestRetrieveSpec. 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.

Explicit response statuses in observed code: status.HTTP_200_OK. Other branches/framework exception handling may differ.

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.