> ## Documentation Index > Fetch the complete documentation index at: https://docs.haau3.com/llms.txt > Use this file to discover all available pages before exploring further. # Check what a medication costs (pharmacy benefit check) > FHIR system-level operation `$process-message`, as the CARIN Consumer Real-Time Pharmacy Benefit Check (STU2 ballot, `2.0.0-ballot`) specifies. POST a FHIR `Bundle` of type `message` whose first entry is a MessageHeader with one of two events. `rtpbc-request-non-phi` asks for a medication's price without patient details: a Claim naming the product (an NDC of 11 digits with no dashes, or an RxNorm code) and the quantity, with the patient and the coverage masked, and a pharmacy or one or more ZIP codes. `rtpbc-request` asks what a medication would cost a member under their coverage: the member's Patient and Coverage, with the payer's identifier in `payor.identifier`, the prescription and its prescriber, and a pharmacy. The answer is a `message` Bundle whose MessageHeader answers the request's, with one ClaimResponse that carries either prices and coverage in `item` or the reason there are none in `error`, and for a member's request the request's Patient as it was sent. A check no connected source can answer carries `no-responder-for-coverage` or `no-price-source` from `https://haau3.com/fhir/CodeSystem/pharmacy-benefits-processing-code`. A price is an estimate; the pharmacy confirms the price. A member's request receives patient data, so send it only under an executed agreement. Nothing a request carries is stored or logged, apart from the request's ids, and every answer is sent with `Cache-Control: no-store`. The operation takes no parameters and is not offered inside a batch. The contract is published at https://fhir.haau3.com/pharmacy-benefits.html. ## OpenAPI ````yaml /api-reference/openapi.json post /v1/fhir/r4/$process-message openapi: 3.1.0 info: title: haau3 Platform API version: 1.0.0-preview.6 description: >- The haau3 platform API is in preview: it may change as we build, usually to add features or improve performance. Endpoints require an API key, sent as `Authorization: Bearer `. Requests without a valid key return 401. Create a key in the dashboard at https://platform.haau3.com; a new organization starts on the free Developer plan. From 2026-11-01 a request past one of its plan's limits (requests a minute on every plan, requests a month on Developer) returns 429 with `Retry-After`. Every error under `/v1/fhir` is a FHIR `OperationOutcome` and every other error an RFC 9457 problem; https://docs.haau3.com/errors lists every status, whether to retry it, and what a method a path does not take answers. servers: - url: https://api.haau3.com description: Production security: - bearerAuth: [] tags: - name: Scheduling description: 'Provider availability (SMART Scheduling Links): slots and publishers.' - name: FHIR base description: >- What the FHIR R4 base at `/v1/fhir/r4` answers for every service on it: the `CapabilityStatement` that lists them all, and batch Bundles that carry several requests to any of them in one round trip. - name: Terminology description: >- FHIR terminology operations over the code systems listed in TerminologyCapabilities. Some are resolved from their own source when you ask; others are held here at a named release, which that resource also names. - name: Provider directory description: >- CMS's National Provider Directory as FHIR R4: practitioners and their roles, organizations, payers and insurance networks, network membership, healthcare services, locations and endpoints. Every parameter the service serves is declared here, and any other is refused by name rather than ignored. - name: Questionnaires description: >- FHIR Questionnaire, served as its source publishes it. This service holds copies of a curated set and reaches any other questionnaire its source publishes by canonical URL, as well as forms published at their own address under places this service is set up to reach. Read one by id, and build the QuestionnaireResponse in your own application. - name: Plan Benefits description: >- FHIR InsurancePlan: what a Medicare Advantage or ACA Marketplace plan covers and what a member pays, read from the files CMS publishes. Every plan names the CMS release it was read from. Read a plan by its id, or search by identifier, name, state or county, and check whether the CMS National Provider Directory lists providers in a plan's network. - name: Pharmacy Benefits description: >- The CARIN Consumer Real-Time Pharmacy Benefit Check as FHIR messaging: what a medication would cost a member under their coverage, or its price at pharmacies near a ZIP code, in real time, from the sources this service connects to. A member's request receives patient data, so send it only under an executed agreement. - name: MedList description: >- One reconciled medication list from one patient's FHIR medication records, as US Core MedicationRequests with a Provenance for each. This operation receives patient data, so send it only under an executed agreement. paths: /v1/fhir/r4/$process-message: post: tags: - Pharmacy Benefits summary: Check what a medication costs (pharmacy benefit check) description: >- FHIR system-level operation `$process-message`, as the CARIN Consumer Real-Time Pharmacy Benefit Check (STU2 ballot, `2.0.0-ballot`) specifies. POST a FHIR `Bundle` of type `message` whose first entry is a MessageHeader with one of two events. `rtpbc-request-non-phi` asks for a medication's price without patient details: a Claim naming the product (an NDC of 11 digits with no dashes, or an RxNorm code) and the quantity, with the patient and the coverage masked, and a pharmacy or one or more ZIP codes. `rtpbc-request` asks what a medication would cost a member under their coverage: the member's Patient and Coverage, with the payer's identifier in `payor.identifier`, the prescription and its prescriber, and a pharmacy. The answer is a `message` Bundle whose MessageHeader answers the request's, with one ClaimResponse that carries either prices and coverage in `item` or the reason there are none in `error`, and for a member's request the request's Patient as it was sent. A check no connected source can answer carries `no-responder-for-coverage` or `no-price-source` from `https://haau3.com/fhir/CodeSystem/pharmacy-benefits-processing-code`. A price is an estimate; the pharmacy confirms the price. A member's request receives patient data, so send it only under an executed agreement. Nothing a request carries is stored or logged, apart from the request's ids, and every answer is sent with `Cache-Control: no-store`. The operation takes no parameters and is not offered inside a batch. The contract is published at https://fhir.haau3.com/pharmacy-benefits.html. operationId: processMessage parameters: - $ref: '#/components/parameters/XRequestId' requestBody: required: true content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' examples: A pharmacy benefit check without patient details: summary: A pharmacy benefit check without patient details value: resourceType: Bundle id: pharmacy-benefits-request-non-phi meta: profile: - >- http://hl7.org/fhir/us/carin-rtpbc/StructureDefinition/rtpbc-request-bundle-non-phi|2.0.0-ballot entry: - fullUrl: >- https://app.example.test/fhir/MessageHeader/non-phi-request resource: resourceType: MessageHeader id: non-phi-request meta: profile: - >- http://hl7.org/fhir/us/carin-rtpbc/StructureDefinition/rtpbc-request-messageheader-non-phi|2.0.0-ballot source: name: Example app endpoint: https://app.example.test focus: - reference: https://app.example.test/fhir/Claim/non-phi-claim eventCoding: code: rtpbc-request-non-phi system: >- http://hl7.org/fhir/us/carin-rtpbc/CodeSystem/rtpbc-event-type display: RTPBC Non-PHI Request definition: >- http://hl7.org/fhir/us/carin-rtpbc/MessageDefinition/rtpbc-request-non-phi - fullUrl: https://app.example.test/fhir/Claim/non-phi-claim resource: resourceType: Claim id: non-phi-claim meta: profile: - >- http://hl7.org/fhir/us/carin-rtpbc/StructureDefinition/rtpbc-request-claim-non-phi|2.0.0-ballot identifier: - value: price-check-0001 patient: extension: - url: >- http://hl7.org/fhir/StructureDefinition/data-absent-reason valueCode: masked provider: extension: - url: >- http://hl7.org/fhir/us/carin-rtpbc/StructureDefinition/rtpbc-preferredPharmacyPostalCode valueString: '33131' insurance: - coverage: extension: - url: >- http://hl7.org/fhir/StructureDefinition/data-absent-reason valueCode: masked sequence: 1 focal: false item: - productOrService: coding: - code: '311354' system: http://www.nlm.nih.gov/research/umls/rxnorm display: lisinopril 5 MG Oral Tablet text: lisinopril 5 mg tablet quantity: value: 30 unit: '{Each}' system: http://unitsofmeasure.org code: '{Each}' sequence: 1 status: active type: coding: - code: pharmacy system: http://terminology.hl7.org/CodeSystem/claim-type display: Pharmacy use: predetermination created: '2026-10-20T14:00:00Z' priority: coding: - code: normal system: >- http://terminology.hl7.org/CodeSystem/processpriority display: Normal type: message timestamp: '2026-10-20T14:00:00Z' responses: '200': description: >- The answer: a FHIR `Bundle` of type `message` with a MessageHeader and one ClaimResponse, returned as the response body itself. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' examples: No price source returned a price: summary: No price source returned a price value: resourceType: Bundle meta: profile: - >- http://hl7.org/fhir/us/carin-rtpbc/StructureDefinition/rtpbc-response-bundle-non-phi|2.0.0-ballot entry: - fullUrl: urn:uuid:cfe4fe76-8b70-4edc-af4b-7e2f8c25b3e8 resource: resourceType: MessageHeader id: cfe4fe76-8b70-4edc-af4b-7e2f8c25b3e8 meta: profile: - >- http://hl7.org/fhir/us/carin-rtpbc/StructureDefinition/rtpbc-response-messageheader-non-phi|2.0.0-ballot source: name: haau3 Pharmacy Benefits endpoint: https://api.haau3.com/v1/fhir/r4 response: identifier: non-phi-request code: ok focus: - reference: urn:uuid:a7fb50aa-3ca5-47a1-96f8-67ec1e95546e eventCoding: code: rtpbc-response-non-phi system: >- http://hl7.org/fhir/us/carin-rtpbc/CodeSystem/rtpbc-event-type display: RTPBC Non-PHI Response definition: >- http://hl7.org/fhir/us/carin-rtpbc/MessageDefinition/rtpbc-response-non-phi - fullUrl: urn:uuid:a7fb50aa-3ca5-47a1-96f8-67ec1e95546e resource: resourceType: ClaimResponse id: a7fb50aa-3ca5-47a1-96f8-67ec1e95546e meta: profile: - >- http://hl7.org/fhir/us/carin-rtpbc/StructureDefinition/rtpbc-response-claimresponse-non-phi|2.0.0-ballot identifier: - value: a7fb50aa-3ca5-47a1-96f8-67ec1e95546e patient: extension: - url: >- http://hl7.org/fhir/StructureDefinition/data-absent-reason valueCode: masked insurer: extension: - url: >- http://hl7.org/fhir/StructureDefinition/data-absent-reason valueCode: masked request: identifier: value: price-check-0001 error: - code: coding: - code: no-price-source system: >- https://haau3.com/fhir/CodeSystem/pharmacy-benefits-processing-code display: No price source returned a price status: active type: coding: - code: pharmacy system: >- http://terminology.hl7.org/CodeSystem/claim-type display: Pharmacy use: predetermination created: '2026-10-20T14:00:01Z' outcome: error disposition: >- No price source this service connects to returned a price for this request. type: message timestamp: '2026-10-20T14:00:01Z' headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' '400': description: >- The request was refused, before any source was asked: a query parameter (the operation takes none), a body that is not a `message` Bundle (a Parameters resource is refused by name), an event other than the two above (coded `not-supported`), a list over its cap (coded `too-long`: 20 entries, 10 codings on a product, 10 ZIP codes, 10 identifiers on a pharmacy, 20 coverage classes), an element the CARIN profiles require that is missing, a reference that names no entry in the Bundle, a product with no NDC or RxNorm code, a ZIP code that is not five digits or ZIP+4, a request without patient details that names its patient or coverage, or a member's request with no Coverage or no payer identifier. The OperationOutcome names the element by its FHIRPath, never a value sent. content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' '401': $ref: '#/components/responses/FhirUnauthorized' '406': $ref: '#/components/responses/FhirNotAcceptable' '413': description: The request body is over 1 MiB. content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' '415': $ref: '#/components/responses/FhirUnsupportedMediaType' '429': $ref: '#/components/responses/FhirTooManyRequests' '500': $ref: '#/components/responses/FhirServerError' '503': $ref: '#/components/responses/FhirUnavailable' x-codeSamples: - lang: bash label: cURL source: | curl -X POST "https://api.haau3.com/v1/fhir/r4/\$process-message" \ -H "Authorization: Bearer $HAAU3_API_KEY" \ -H "Content-Type: application/fhir+json" \ -d '{ "resourceType": "Bundle", "id": "pharmacy-benefits-request-non-phi", "meta": { "profile": [ "http://hl7.org/fhir/us/carin-rtpbc/StructureDefinition/rtpbc-request-bundle-non-phi|2.0.0-ballot" ] }, "entry": [ { "fullUrl": "https://app.example.test/fhir/MessageHeader/non-phi-request", "resource": { "resourceType": "MessageHeader", "id": "non-phi-request", "meta": { "profile": [ "http://hl7.org/fhir/us/carin-rtpbc/StructureDefinition/rtpbc-request-messageheader-non-phi|2.0.0-ballot" ] }, "source": { "name": "Example app", "endpoint": "https://app.example.test" }, "focus": [{ "reference": "https://app.example.test/fhir/Claim/non-phi-claim" }], "eventCoding": { "code": "rtpbc-request-non-phi", "system": "http://hl7.org/fhir/us/carin-rtpbc/CodeSystem/rtpbc-event-type", "display": "RTPBC Non-PHI Request" }, "definition": "http://hl7.org/fhir/us/carin-rtpbc/MessageDefinition/rtpbc-request-non-phi" } }, { "fullUrl": "https://app.example.test/fhir/Claim/non-phi-claim", "resource": { "resourceType": "Claim", "id": "non-phi-claim", "meta": { "profile": [ "http://hl7.org/fhir/us/carin-rtpbc/StructureDefinition/rtpbc-request-claim-non-phi|2.0.0-ballot" ] }, "identifier": [{ "value": "price-check-0001" }], "patient": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", "valueCode": "masked" } ] }, "provider": { "extension": [ { "url": "http://hl7.org/fhir/us/carin-rtpbc/StructureDefinition/rtpbc-preferredPharmacyPostalCode", "valueString": "33131" } ] }, "insurance": [ { "coverage": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", "valueCode": "masked" } ] }, "sequence": 1, "focal": false } ], "item": [ { "productOrService": { "coding": [ { "code": "311354", "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "display": "lisinopril 5 MG Oral Tablet" } ], "text": "lisinopril 5 mg tablet" }, "quantity": { "value": 30, "unit": "{Each}", "system": "http://unitsofmeasure.org", "code": "{Each}" }, "sequence": 1 } ], "status": "active", "type": { "coding": [ { "code": "pharmacy", "system": "http://terminology.hl7.org/CodeSystem/claim-type", "display": "Pharmacy" } ] }, "use": "predetermination", "created": "2026-10-20T14:00:00Z", "priority": { "coding": [ { "code": "normal", "system": "http://terminology.hl7.org/CodeSystem/processpriority", "display": "Normal" } ] } } } ], "type": "message", "timestamp": "2026-10-20T14:00:00Z" }' - lang: typescript label: TypeScript source: > import { readFile } from "node:fs/promises"; import { Haau3, type fhir4 } from "@haau3/sdk"; const haau3 = new Haau3(); // reads HAAU3_API_KEY // request.json holds a pharmacy benefit check without patient details, as a Bundle. const body: fhir4.Bundle = JSON.parse(await readFile("request.json", "utf8")); const bundle = await haau3.processMessage(body); console.log(bundle.entry?.length ?? 0); - lang: python label: Python source: > import json from haau3 import Haau3, fhir client = Haau3() # reads HAAU3_API_KEY # request.json holds a pharmacy benefit check without patient details, as a Bundle. with open("request.json") as file: body: fhir.Bundle = json.load(file) bundle = client.process_message(body) print(len(bundle.get("entry", []))) - lang: go label: Go source: "package main\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\n\t\"github.com/haau3/haau3-go\"\n\t\"github.com/haau3/haau3-go/fhir\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclient, err := haau3.NewClient() // reads HAAU3_API_KEY\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdata, err := os.ReadFile(\"request.json\") // a pharmacy benefit check without patient details\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tvar body fhir.Bundle\n\tif err := json.Unmarshal(data, &body); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tbundle, err := client.ProcessMessage(ctx, &body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Println(len(bundle.Entry))\n}\n" components: parameters: XRequestId: name: X-Request-Id in: header required: false schema: type: string format: uuid description: >- An id of your own for this request, as a UUID. It comes back in the `X-Correlation-Id` header and is kept with haau3's record of the request. Any value that is not a UUID is ignored. See https://docs.haau3.com/errors#request-ids. schemas: Bundle: type: object description: A FHIR R4 [Bundle](https://hl7.org/fhir/R4/bundle.html). properties: resourceType: type: string const: Bundle type: type: string entry: type: array items: type: object additionalProperties: true required: - resourceType additionalProperties: true OperationOutcome: type: object description: >- A FHIR R4 [OperationOutcome](https://hl7.org/fhir/R4/operationoutcome.html). properties: resourceType: type: string const: OperationOutcome issue: type: array items: type: object properties: severity: type: string enum: - fatal - error - warning - information code: type: string details: type: object properties: text: type: string additionalProperties: true diagnostics: type: string expression: type: array items: type: string required: - severity - code additionalProperties: true required: - resourceType - issue headers: XRequestId: description: >- The id haau3 gave this request, a UUID, on every response. Quote it in a question about the response. A problem carries the same id as its `instance`. schema: type: string format: uuid XCorrelationId: description: The `X-Request-Id` you sent, when it was a UUID. schema: type: string format: uuid responses: FhirUnauthorized: description: Missing or invalid API key. content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' headers: WWW-Authenticate: description: >- The scheme to authenticate with: `Bearer realm="api.haau3.com"`, with `error="invalid_token"` when a key was sent and not recognised. schema: type: string X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' FhirNotAcceptable: description: >- The request asked for a format other than JSON (`Accept` or `_format`), or for a FHIR release this endpoint does not serve (the `fhirVersion` media-type parameter). content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' FhirUnsupportedMediaType: description: >- The request body was not sent as JSON: send `Content-Type: application/fhir+json`. content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' FhirTooManyRequests: description: >- A limit of the organization's plan was reached: its requests a minute, or the Developer plan's requests a month. Send the request again after `Retry-After`, which for the monthly limit runs to the 1st of the next month (UTC). content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' headers: Retry-After: description: How many seconds to wait before sending the request again. schema: type: integer minimum: 0 X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' FhirServerError: description: The server failed to process this request. content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' FhirUnavailable: description: >- The API key could not be checked just now. Send the request again after `Retry-After`. content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' headers: Retry-After: description: How many seconds to wait before sending the request again. schema: type: integer minimum: 0 X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' securitySchemes: bearerAuth: type: http scheme: bearer description: >- Your platform API key (`haau3_sk_…`), sent as `Authorization: Bearer `. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.