Payerbox Docs

Resources

FHIR resources Payerbox exposes, tagged by the API surface(s) that use them.

The authoritative list per deployment is in the Capability Statement (/fhir/metadata). The table below is the design intent across surfaces.

Member and coverage

ResourcePatient AccessProvider AccessPayer-to-PayerProvider DirectoryPrior Auth
Patient
Coverage
RelatedPerson
Group
Consent

Clinical (US Core)

ResourcePatient AccessProvider AccessPayer-to-PayerPrior Auth
AllergyIntolerance
Condition
Observation
MedicationRequest
MedicationStatement
Procedure
DiagnosticReport
Immunization
CarePlan
Goal
Encounter
ServiceRequest
DocumentReference
Device
Location

Claims, EOB, prior auth

ResourcePatient AccessProvider AccessPayer-to-PayerPrior Auth
Claim✓ (PA only, from 2027)
ClaimResponse✓ (PA only, from 2027)
ExplanationOfBenefit✓ (no remittance / cost-sharing)✓ (no remittance / cost-sharing)
Task

Provider directory (Plan Net)

ResourceProvider DirectoryPatient Access (MA-PD)
Practitioner
PractitionerRole
Organization
OrganizationAffiliation
Location
HealthcareService
InsurancePlan
Endpoint

Formulary (MA-PD only)

ResourcePatient Access (MA-PD)
MedicationKnowledge
InsurancePlan✓ (with formulary extension)

DTR (Questionnaire workflow)

ResourceUsed by
QuestionnaireDTR $questionnaire-package
QuestionnaireResponseDTR completion → PAS submission
LibraryDTR CQL bundle
ValueSet, CodeSystemDTR Questionnaire constraints

Audit and operations

ResourceUsed by
AuditEventBALP audit log; produced for every member-data access
OperationOutcomeError responses across all surfaces
SubscriptionOptional — for notifications
BundleTransaction, batch, search results, and PAS Request/Response

Profile conformance

Each resource above is constrained by the relevant IG profile when interacting with a specific surface. For example, Patient on Patient Access conforms to us-core-patient; Practitioner on Provider Directory conforms to plannet-Practitioner.

The CapabilityStatement at <base>/fhir/metadata lists the exact supportedProfile for each resource per surface.

Last updated: