Field dictionary

This dictionary explains common fields that appear across module APIs. The generated reference remains the source of truth for endpoint-specific required fields and allowed values.

Identifiers

FieldMeaningExampleSourceConfusion
providerNpi10-digit National Provider Identifier used in payer and claim workflows.1234567893Provider enrollment or organization billing settings.Not a tenant, workspace, or payer identifier.
taxIdProvider or group tax identifier used for billing and payer workflows.12-3456789Billing configuration or provider enrollment records.Sensitive value. Do not log it in application traces.
payerIdClearinghouse or payer directory identifier.87726Payer directory, routing configuration, eligibility or claims setup.Not the payer display name.
patientIdQuickRCM internal patient record ID.00000000-0000-4000-8000-000000000002Patient creation, patient list, EHR sync, or module response payloads.Not necessarily the MRN unless explicitly mapped.
externalPatientIdPatient identifier from an EHR, PM system, or customer system.athena-98323Customer source system or EHR integration mapping.Use for source-system reconciliation; do not assume it is globally unique across organizations.
claimIdQuickRCM claim record ID.00000000-0000-4000-8000-000000000003Claim creation, claims list, denial, AR, or payment posting workflows.Not the payer claim control number unless explicitly mapped.
batchIdBatch or grouped workflow identifier returned by bulk operations.00000000-0000-4000-8000-000000000004Bulk request response or generated processing metadata.Use for polling or reconciliation when a module exposes batch status.

Common fields

FieldTypeFormatExampleNotesPHI
serviceDatedate stringYYYY-MM-DD2026-06-08Use ISO date strings in JSON. Avoid MM/DD/YYYY.Contextual
dateOfBirthdate stringYYYY-MM-DD1984-03-22Patient identifier. Treat as PHI.Yes
memberIdstringPayer-specificW123456789Insurance subscriber/member identifier. Avoid logging raw values.Yes
serviceTypeCodestringX12 service type code where applicable30Used as payer transaction context for eligibility-style workflows.No
metadataobjectCaller-defined JSON{ "source": "partner-portal" }Do not place PHI or secrets in metadata unless the endpoint explicitly documents secure storage semantics.Depends