{"openapi":"3.1.0","info":{"title":"haau3 Platform API","version":"1.0.0-preview.4","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 <key>`. 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":"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/scheduling/provider-locations":{"get":{"tags":["Scheduling"],"summary":"Search provider locations","description":"Returns the matching slots grouped by provider location: each item in `providerLocations` is one provider at one location, or a location with no provider, with its total slot count and soonest availability, paginated by provider location. Its opaque `key` drills down to its individual slots via `GET /v1/scheduling/slots?providerLocationKey=<key>`. Same filters as `/slots`. Requires a valid API key.","operationId":"searchProviderLocations","parameters":[{"name":"status","in":"query","required":false,"description":"Slot availability state to return. Defaults to `free`.","schema":{"default":"free","type":"string","enum":["free","busy","busy-unavailable","busy-tentative"]}},{"name":"publisher","in":"query","required":false,"description":"Filter to a single publisher (source) by slug, such as `zocdoc` or `defacto`. See `GET /v1/scheduling/publishers` for the available slugs.","schema":{"type":"string","minLength":1},"example":"haau3"},{"name":"serviceTypeCode","in":"query","required":false,"description":"Filter by service type code (as published by the source). A slot matches when any of its `serviceTypes` carries the code. A comma-separated list (up to 100) matches a slot carrying any of them.","schema":{"type":"string","minLength":1}},{"name":"npi","in":"query","required":false,"description":"Filter by the provider's National Provider Identifier: a clinician's, or an organization's when a healthcare service is the provider. Ten digits; a comma-separated list (up to 100) matches a slot whose provider carries any of them. Matched as the publisher sent it, in either NPI identifier system, across every publisher.","schema":{"type":"string","minLength":1}},{"name":"specialty","in":"query","required":false,"description":"Filter by specialty: a slot matches when its provider's `specialties` or its schedule's `specialties` carry the code. Send `code` to match it in any code system, or `system|code` to match it in that system only. Codes are each publisher's own and are not translated between code systems, so one code finds the publishers that use it; `GET /v1/scheduling/specialties` lists them. A specialty sent as text only cannot be matched. A comma-separated list (up to 100) matches any of them.","schema":{"type":"string","minLength":1}},{"name":"appointmentType","in":"query","required":false,"description":"Filter by appointment type.","schema":{"type":"string","minLength":1}},{"name":"acceptingPatients","in":"query","required":false,"description":"Filter to slots accepting patients of this kind (HL7 `accepting-patients` CodeSystem: `newpt` | `existptonly` | `existptfam`). Slots marked `nopt` (not accepting patients) are never served, so `nopt` is not a valid filter value. Lenient: a slot that does not declare an accepting-patients code matches any value (absence never hides a slot); a slot that declares one must equal the requested value.","schema":{"type":"string","enum":["newpt","existptonly","existptfam"]}},{"name":"isVirtual","in":"query","required":false,"description":"Filter to virtual (`true`) or in-person (`false`) slots.","schema":{"type":"boolean"}},{"name":"city","in":"query","required":false,"description":"Filter by the location's city.","schema":{"type":"string","minLength":1}},{"name":"state","in":"query","required":false,"description":"Filter by the location's state.","schema":{"type":"string","minLength":1}},{"name":"startAfter","in":"query","required":false,"description":"Only slots starting at or after this instant: ISO 8601 with seconds and an offset, such as `2026-07-06T13:00:00-04:00` or `2026-07-06T17:00:00Z`. A value without seconds is refused. When absent, slots start from now unless `includePast=true`.","schema":{"type":"string","format":"date-time"}},{"name":"startBefore","in":"query","required":false,"description":"Only slots starting at or before this instant: ISO 8601 with seconds and an offset, such as `2026-07-06T13:00:00-04:00` or `2026-07-06T17:00:00Z`. A value without seconds is refused.","schema":{"type":"string","format":"date-time"}},{"name":"includePast","in":"query","required":false,"description":"Include slots that started before now. Defaults to `false`: with no `startAfter`, results start from now. An explicit `startAfter` applies as given either way.","schema":{"default":false,"type":"boolean"}},{"name":"limit","in":"query","required":false,"description":"Page size: the number of provider locations, from 1 to 100. Defaults to 25.","schema":{"default":25,"type":"integer","minimum":1,"maximum":100},"example":1},{"name":"offset","in":"query","required":false,"description":"Number of provider locations to skip for pagination. Defaults to 0.","schema":{"default":0,"type":"integer","minimum":0,"maximum":9007199254740991}},{"$ref":"#/components/parameters/XRequestId"}],"responses":{"200":{"description":"The matching provider locations, and their total number before paging.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchProviderLocationsResponse"},"examples":{"Provider locations with slots from one publisher":{"summary":"Provider locations with slots from one publisher","value":{"total":5,"providerLocations":[{"key":"haau3|loc:idr|https://haau3.com/synthetic/location|loc-haau3-telehealth|prov:idr|https://haau3.com/synthetic/practitioner|prac-haau3-psych","publisher":"haau3","provider":{"id":"prac-haau3-psych","identifier":[{"value":"prac-haau3-psych","system":"https://haau3.com/synthetic/practitioner"}],"type":"practitioner-role","name":"Dr. Sarah Whitefeather","specialty":"Psychiatry Physician","specialties":[{"system":"http://nucc.org/provider-taxonomy","code":"2084P0800X","display":"Psychiatry Physician"}]},"location":{"id":"loc-haau3-telehealth","identifier":[{"value":"loc-haau3-telehealth","system":"https://haau3.com/synthetic/location"}],"name":"haau3 Telehealth","phone":["+1-617-555-0199"],"website":["https://haau3.com/telehealth"],"physicalType":{"system":"http://terminology.hl7.org/CodeSystem/location-physical-type","code":"vi"}},"serviceTypes":[{"system":"http://terminology.hl7.org/CodeSystem/service-type","code":"124","display":"General Practice"}],"specialties":[],"bookingMethod":"online","isVirtual":true,"acceptingPatients":"newpt","nextAvailableStart":"2026-10-18T21:00:00.000Z","totalSlots":155}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"A query parameter is not valid, is not one this endpoint takes, or was sent more than once. The problem's `issues` names each one and says why.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"401":{"$ref":"#/components/responses/ProblemUnauthorized"},"406":{"$ref":"#/components/responses/ProblemNotAcceptable"},"429":{"$ref":"#/components/responses/ProblemTooManyRequests"},"500":{"$ref":"#/components/responses/ProblemServerError"},"503":{"description":"The scheduling service is unavailable, or its database did not answer in time. Send the request again after `Retry-After`. It is also the answer when the API key could not be checked just now, with `Retry-After`.","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"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/scheduling/slots":{"get":{"tags":["Scheduling"],"summary":"Search appointment slots","description":"Returns provider availability slots matching the filters, with pagination. Requires a valid API key.","operationId":"searchSlots","parameters":[{"name":"status","in":"query","required":false,"description":"Slot availability state to return. Defaults to `free`.","schema":{"default":"free","type":"string","enum":["free","busy","busy-unavailable","busy-tentative"]}},{"name":"publisher","in":"query","required":false,"description":"Filter to a single publisher (source) by slug, such as `zocdoc` or `defacto`. See `GET /v1/scheduling/publishers` for the available slugs.","schema":{"type":"string","minLength":1},"example":"haau3"},{"name":"serviceTypeCode","in":"query","required":false,"description":"Filter by service type code (as published by the source). A slot matches when any of its `serviceTypes` carries the code. A comma-separated list (up to 100) matches a slot carrying any of them.","schema":{"type":"string","minLength":1}},{"name":"npi","in":"query","required":false,"description":"Filter by the provider's National Provider Identifier: a clinician's, or an organization's when a healthcare service is the provider. Ten digits; a comma-separated list (up to 100) matches a slot whose provider carries any of them. Matched as the publisher sent it, in either NPI identifier system, across every publisher.","schema":{"type":"string","minLength":1}},{"name":"specialty","in":"query","required":false,"description":"Filter by specialty: a slot matches when its provider's `specialties` or its schedule's `specialties` carry the code. Send `code` to match it in any code system, or `system|code` to match it in that system only. Codes are each publisher's own and are not translated between code systems, so one code finds the publishers that use it; `GET /v1/scheduling/specialties` lists them. A specialty sent as text only cannot be matched. A comma-separated list (up to 100) matches any of them.","schema":{"type":"string","minLength":1}},{"name":"appointmentType","in":"query","required":false,"description":"Filter by appointment type.","schema":{"type":"string","minLength":1}},{"name":"acceptingPatients","in":"query","required":false,"description":"Filter to slots accepting patients of this kind (HL7 `accepting-patients` CodeSystem: `newpt` | `existptonly` | `existptfam`). Slots marked `nopt` (not accepting patients) are never served, so `nopt` is not a valid filter value. Lenient: a slot that does not declare an accepting-patients code matches any value (absence never hides a slot); a slot that declares one must equal the requested value.","schema":{"type":"string","enum":["newpt","existptonly","existptfam"]}},{"name":"isVirtual","in":"query","required":false,"description":"Filter to virtual (`true`) or in-person (`false`) slots.","schema":{"type":"boolean"}},{"name":"city","in":"query","required":false,"description":"Filter by the location's city.","schema":{"type":"string","minLength":1}},{"name":"state","in":"query","required":false,"description":"Filter by the location's state.","schema":{"type":"string","minLength":1}},{"name":"startAfter","in":"query","required":false,"description":"Only slots starting at or after this instant: ISO 8601 with seconds and an offset, such as `2026-07-06T13:00:00-04:00` or `2026-07-06T17:00:00Z`. A value without seconds is refused. When absent, slots start from now unless `includePast=true`.","schema":{"type":"string","format":"date-time"}},{"name":"startBefore","in":"query","required":false,"description":"Only slots starting at or before this instant: ISO 8601 with seconds and an offset, such as `2026-07-06T13:00:00-04:00` or `2026-07-06T17:00:00Z`. A value without seconds is refused.","schema":{"type":"string","format":"date-time"}},{"name":"includePast","in":"query","required":false,"description":"Include slots that started before now. Defaults to `false`: with no `startAfter`, results start from now. An explicit `startAfter` applies as given either way.","schema":{"default":false,"type":"boolean"}},{"name":"providerLocationKey","in":"query","required":false,"description":"Opaque key of one provider location from `GET /v1/scheduling/provider-locations`. When set, returns exactly that provider location's slots. Treat the value as opaque; do not parse it.","schema":{"type":"string","minLength":1}},{"name":"limit","in":"query","required":false,"description":"Page size, from 1 to 100. Defaults to 25.","schema":{"default":25,"type":"integer","minimum":1,"maximum":100},"example":1},{"name":"offset","in":"query","required":false,"description":"Number of slots to skip for pagination. Defaults to 0.","schema":{"default":0,"type":"integer","minimum":0,"maximum":9007199254740991}},{"$ref":"#/components/parameters/XRequestId"}],"responses":{"200":{"description":"Matching slots and the total pre-pagination count.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchSlotsResponse"},"examples":{"Slots from one publisher":{"summary":"Slots from one publisher","value":{"total":699,"slots":[{"id":"slot-haau3-psych-20261018-1700","publisher":"haau3","scheduleId":"sched-haau3-psych","status":"free","start":"2026-10-18T21:00:00.000Z","end":"2026-10-18T21:50:00.000Z","serviceTypeCode":"124","serviceTypeText":"General Practice","serviceTypes":[{"system":"http://terminology.hl7.org/CodeSystem/service-type","code":"124","display":"General Practice"}],"acceptingPatients":"newpt","isVirtual":true,"bookingPhone":"+1-617-555-0100","location":{"id":"loc-haau3-telehealth","identifier":[{"system":"https://haau3.com/synthetic/location","value":"loc-haau3-telehealth"}],"name":"haau3 Telehealth","phone":["+1-617-555-0199"],"website":["https://haau3.com/telehealth"],"physicalType":{"system":"http://terminology.hl7.org/CodeSystem/location-physical-type","code":"vi"}},"provider":{"id":"prac-haau3-psych","identifier":[{"system":"https://haau3.com/synthetic/practitioner","value":"prac-haau3-psych"}],"type":"practitioner-role","name":"Dr. Sarah Whitefeather","specialty":"Psychiatry Physician","specialties":[{"system":"http://nucc.org/provider-taxonomy","code":"2084P0800X","display":"Psychiatry Physician"}]},"source":{"publisher":"haau3","resourceId":"slot-haau3-psych-20261018-1700","transactionTime":"2026-10-18T00:00:00.000Z","syncedAt":"2026-10-18T12:01:36.474Z"}}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"A query parameter is not valid, is not one this endpoint takes, or was sent more than once. The problem's `issues` names each one and says why.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"401":{"$ref":"#/components/responses/ProblemUnauthorized"},"406":{"$ref":"#/components/responses/ProblemNotAcceptable"},"429":{"$ref":"#/components/responses/ProblemTooManyRequests"},"500":{"$ref":"#/components/responses/ProblemServerError"},"503":{"description":"The scheduling service is unavailable, or its database did not answer in time. Send the request again after `Retry-After`. It is also the answer when the API key could not be checked just now, with `Retry-After`.","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"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/scheduling/publishers":{"get":{"tags":["Scheduling"],"summary":"List scheduling publishers","description":"Returns the SMART Scheduling Links publishers (sources) the platform ingests. Requires a valid API key.","operationId":"listPublishers","responses":{"200":{"description":"The configured publishers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPublishersResponse"},"examples":{"The publishers":{"summary":"The publishers","value":{"publishers":[{"slug":"defacto","displayName":"Defacto","manifestUrl":"https://smart-scheduling-defacto.s3.us-east-2.amazonaws.com/public/$bulk-publish","enabled":true},{"slug":"haau3","displayName":"haau3 (demo feed)","manifestUrl":"https://api.haau3.com/scheduling/$bulk-publish","enabled":true},{"slug":"parker-health","displayName":"Parker Health","manifestUrl":"https://raw.githubusercontent.com/ParkerApex/apex-atlas/main/samples/cms-connectathon-2026/scheduling/$bulk-publish","enabled":true},{"slug":"rendeva-smart-aligned","displayName":"Rendeva (smart-aligned)","manifestUrl":"https://www.rendeva.org/api/datasets/smart-aligned/$bulk-publish","enabled":false},{"slug":"smart-scheduling-links","displayName":"SMART Scheduling Links","manifestUrl":"https://raw.githubusercontent.com/smart-on-fhir/smart-scheduling-links/master/examples/$bulk-publish","enabled":false},{"slug":"zocdoc","displayName":"Zocdoc","manifestUrl":"https://zocdoc-smartscheduling-api.netlify.app/$bulk-publish","enabled":false},{"slug":"zocdoc-live","displayName":"Zocdoc (live feed)","manifestUrl":"https://zocdoc-smartscheduling-api.netlify.app/zocdoc/$bulk-publish","enabled":false},{"slug":"zocdoc-prod","displayName":"Zocdoc (production)","manifestUrl":"https://www.zocdoc.com/smart-scheduling-link/v1/network/5513/$bulk-publish","enabled":true}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"A query parameter is not valid, is not one this endpoint takes, or was sent more than once. The problem's `issues` names each one and says why.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"401":{"$ref":"#/components/responses/ProblemUnauthorized"},"406":{"$ref":"#/components/responses/ProblemNotAcceptable"},"429":{"$ref":"#/components/responses/ProblemTooManyRequests"},"500":{"$ref":"#/components/responses/ProblemServerError"},"503":{"description":"The scheduling service is unavailable, or its database did not answer in time. Send the request again after `Retry-After`. It is also the answer when the API key could not be checked just now, with `Retry-After`.","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"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"parameters":[{"$ref":"#/components/parameters/XRequestId"}]}},"/v1/scheduling/service-types":{"get":{"tags":["Scheduling"],"summary":"List service types","description":"Returns the distinct service types observed across served slots, each with its `system` and a `count` of the slots carrying it. It is a discovery aid for the `serviceTypeCode` filter on `GET /v1/scheduling/slots`. Requires a valid API key.","operationId":"listServiceTypes","parameters":[{"name":"includePast","in":"query","required":false,"description":"Also count slots that started before now. Defaults to `false`, so the counts cover the slots a search with no `startAfter` returns.","schema":{"default":false,"type":"boolean"}},{"$ref":"#/components/parameters/XRequestId"}],"responses":{"200":{"description":"The distinct service types across served slots.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListServiceTypesResponse"},"examples":{"The service types":{"summary":"The service types","value":{"serviceTypes":[{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_-maCOVIWgUGq7_BH1h5nVB","display":"Dermatology Consultation","count":2196},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_TlZW-r06U0W3pCsIGtSI5B","display":"Dental Consultation","count":1849},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_FRO-18leckytNKtruw5dLR","display":"Illness","count":1431},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_XtIIIaJ2qkmCvfRfrNTCmh","display":"Eyeglasses","count":601},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_ScjCEdje7U-bsLzXVK-QSh","display":"Chiropractic Consultation","count":463},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_z-XC40xg6Uq61dk7tWXPUB","display":"Pediatric Consultation","count":348},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_zZWhkaURvEGlZpSimNILaB","display":"General Consultation","count":302},{"system":"http://terminology.hl7.org/CodeSystem/service-type","code":"124","display":"General Practice","count":285},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_PMBWq1Fvf0iSyADJevNHLx","display":"Therapy","count":284},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_jL57dJbLT0y5AGae2izsSR","display":"Annual Pap Smear / GYN Exam","count":221},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_dLx_aTKEDUyzsFch0FRmpx","display":"Foot Consultation","count":194},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_T1T3MOA0kUuE201i1ZfIWR","display":"Orthopedic Consultation","count":154},{"system":"http://terminology.hl7.org/CodeSystem/service-type","code":"209","display":"Diagnostic Radiology/Xray/CT/Fluoroscopy","count":142},{"system":"http://terminology.hl7.org/CodeSystem/service-type","code":"57","display":"Immunization","count":142},{"system":"http://terminology.hl7.org/CodeSystem/service-type","code":"554","display":"Chronic Disease Management","count":130},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_6OZ_tCH8E0ipVtz40nv4gx","display":"ENT Consultation","count":114},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_2rvYrf9iikmawWs5xMw7IR","display":"Physical Therapy Consultation","count":97},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_mLdGog6Fwkev_8amkyM4uB","display":"Psychiatry Consultation","count":88},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_j0mh3-I3QEawzG6h08xrlR","display":"Gastroenterology Consultation","count":71},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_fgebPJsoZ0OEw98hapBL5x","display":"Allergy Consultation","count":57},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_Vljnj0Fxrkq-bfZx5NuFVB","display":"Cardiology Consultation ","count":56},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_pVrIHze7E067YgpX3QxD3B","display":"Anti-Aging Treatment","count":52},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_wWed6YKAj0eUfnHC3x997x","display":"Foot Problems","count":50},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_YWAS2niyPE2v4zui4akrWB","display":"General Eye Consultation","count":49},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_D12_FBb-0E2zvgSfkeLfUB","display":"Periodontist Consultation","count":38},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_DLyOVDs86ky-WjC-gd1l3x","display":"Hand Surgery Consultation","count":38},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_pQHZ8-tjRUqjEiVc2B16zR","display":"Orthodontic Consultation","count":38},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_Wc5AAEjb8UKUK-ChS-hgHh","display":"Pain Management Consultation","count":36},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_eWQnfg4qPUSe83q8DqzBph","display":"Acupuncture","count":36},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_ys0YO4BWiUi-MJ3DUNuXeB","display":"Depression","count":35},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_S3jS6nwQq0SLzUGj-O45lx","display":"Pediatric Acne","count":30},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_Wqd-Q62VLU6ZS_dF9-EnRh","display":"Pediatric Dentist Consultation","count":29},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_6EAgilerx0qjJHpTp_ik-x","display":"Sports Injury","count":28},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_MmupBi07Wk26y4j6LCNcGB","display":"Pulmonology Consultation","count":28},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_QFRp0PMZ9ku7QkeT0F8O5h","display":"Neurology Consultation","count":26},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_fsu-qCYl7064W9TZcQn0DB","display":"Root Canal","count":23},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_bWwTFhNqIEyx26npLz8nFx","display":"Bridge","count":22},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_9cYi0oM8ukqMUjzO5MCgSh","display":"Pregnancy Problem","count":16},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_0GwNcmCbPECT_e1vrPWO0x","display":"Carotid Doppler","count":12},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_FA92fulbYUerRfXtkLX90R","display":"Language / Speech Problems","count":12},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_NYyA_I3Aw0eOa_Eps3sgZR","display":"Knee Pain","count":11},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_3HZc8u45d0iyTSh4V_dkzR","display":"Surgery Consultation","count":10},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_AzuCINZywUm7bDnbjom3Nx","display":"Occupational Therapy Consultation","count":10},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_Opg2I2cPf02Jd3EGKpaYXB","display":"Fracture","count":10},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_BxZvVM8JOEyzUXOcWDKzWx","display":"Weight Loss Consultation","count":8},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_PLB_O-9RsES2KPwF6c6A6x","display":"Pediatric Endocrinology Consultation","count":8},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_WxicKn6KqEm8pq6wg-gnuh","display":"Botox Treatment","count":8},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc__sbHUVqotku5msuvXKmpRh","display":"Teeth Whitening","count":8},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_pWAVSqOQh0OMqayl-amaEx","display":"Massage Therapy Consultation","count":8},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_qAJNbrMly060eHbpxjz9lx","display":"Spine Specialist Consultation","count":8},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_XbXd6pGmFUmodydiM0ieXB","display":"Spinal Cord Surgery Consultation","count":7},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_7cryxcnAqkmmgC8g0KdINh","display":"Vascular Surgery ","count":6},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_AF2As9jDAUyGMlPDE6MtSB","display":"Varicose Vein Treatment","count":6},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_PpYZiRxIFECE0hJF-sfPeh","display":"Endocrinology Consultation","count":6},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_Qoff_3dot0-TYSu_RK1G1B","display":"Face Reconstructive Surgery Consultation","count":6},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_X5xIx_dVeU61AtrSmZfT5R","display":"Glaucoma Consultation","count":6},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_c2TMoMIXoESzotVV4a5F0B","display":"Elbow Problems","count":6},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_rDX3UcMDbU2HlWEdSnuPZx","display":"Hand Problems","count":5},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_BKnsAepKBkGG_Zine11pdB","display":"Arthritis","count":4},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_CWKfhzdHv0aMXIgSP_Kn3B","display":"Colon Cancer Screening","count":4},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_ONiL7KsfL02_hvkt5m3PkR","display":"Sleep Problems","count":4},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_TcRaKUwbEUaayhPqISah3h","display":"Neuropsychology Evaluation","count":4},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_WVYoszFGKkuRRGaXTOSMtR","count":4},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_n0c5jRypF0CBOwXoNyERRh","display":"Neck Surgery Consultation","count":4},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_6930bt-I60ukmsonVnnj3h","display":"Infection Consultation","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_C_JNjmk-6keUz1xF8yvWOx","display":"Infertility Consultation","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_DTxKUMQzPUSL5IqGVcDMhx","display":"Urology Consultation","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_DdmwjZeVUUm_QrprbFqrRB","display":"Behavior Analyst Consultation","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_Idvxg4_Pq0mSORYOwdFJXh","display":"Family Therapy/ Marriage Therapy","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_KjuombbdxkSp0DGrnkrPHh","display":"Breast Surgery","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_MrafVWxZAU6AnPlxOrrb8x","display":"Emergency Consultation","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_PV_3VYt1eU2-Qh6Rr33Kfx","display":"Bruise / Contusion","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_PjUzcB0FkkK5awf_iHNsOR","display":"Mohs Surgery","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_cy3425zVYEGm3N2I6xwoFR","display":"Neurosurgery Consultation","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_o5HfMdgR9kKQ_GZ2A23Nrx","display":"Nose Surgery","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_rwMGP9XfCEeW5UgLz-4xjx","display":"Pediatric Allergy Consultation","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_vSFc7WzSXUi8LgJ__s80uh","display":"Hoarseness","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_6jJAiz4-uk6rntuMj1TCtB","display":"Geriatric Medicine Consultation","count":1},{"system":"https://www.zocdoc.com/fhir/CodeSystem/visit-reason","code":"pc_BwLyqcMvgUCtGkIekY7U7x","display":"Physical Medicine / Rehab Consultation","count":1}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"A query parameter is not valid, is not one this endpoint takes, or was sent more than once. The problem's `issues` names each one and says why.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"401":{"$ref":"#/components/responses/ProblemUnauthorized"},"406":{"$ref":"#/components/responses/ProblemNotAcceptable"},"429":{"$ref":"#/components/responses/ProblemTooManyRequests"},"500":{"$ref":"#/components/responses/ProblemServerError"},"503":{"description":"The scheduling service is unavailable, or its database did not answer in time. Send the request again after `Retry-After`. It is also the answer when the API key could not be checked just now, with `Retry-After`.","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"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/scheduling/specialties":{"get":{"tags":["Scheduling"],"summary":"List specialties","description":"Returns the distinct specialties observed across served slots, from the provider's `specialties` and the schedule's, each with its `system` and a `count` of the slots carrying it. It is a discovery aid for the `specialty` filter on `GET /v1/scheduling/slots`. Codes are each publisher's own. Requires a valid API key.","operationId":"listSpecialties","parameters":[{"name":"includePast","in":"query","required":false,"description":"Also count slots that started before now. Defaults to `false`, so the counts cover the slots a search with no `startAfter` returns.","schema":{"default":false,"type":"boolean"}},{"$ref":"#/components/parameters/XRequestId"}],"responses":{"200":{"description":"The distinct specialties across served slots.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSpecialtiesResponse"},"examples":{"The specialties":{"summary":"The specialties","value":{"specialties":[{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_98","display":"Dentist","count":1788},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_101","display":"Dermatologist","count":1013},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_518","display":"Physician Assistant (Dermatology)","count":886},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_157","display":"Optometrist","count":601},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_156","display":"Chiropractor","count":463},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_102","display":"Family Physician","count":420},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_401","display":"Family Nurse Practitioner","count":415},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_381","display":"Physician Assistant","count":302},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_99","display":"Internist","count":298},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_522","display":"Nurse Practitioner (Dermatology)","count":293},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_100","display":"Pediatrician","count":281},{"system":"http://nucc.org/provider-taxonomy","code":"207Q00000X","display":"Family Medicine","count":272},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_352","display":"Psychotherapist","count":271},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_121","display":"Podiatrist","count":194},{"system":"http://nucc.org/provider-taxonomy","code":"2084P0800X","display":"Psychiatry Physician","count":155},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_153","display":"Primary Care Doctor","count":151},{"system":"http://nucc.org/provider-taxonomy","code":"2085R0202X","display":"Diagnostic Radiology Physician","count":142},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_399","display":"Nurse Practitioner","count":131},{"system":"http://nucc.org/provider-taxonomy","code":"207RC0000X","display":"Cardiovascular Disease Physician","count":130},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_104","display":"OB-GYN","count":114},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_117","display":"Orthopedic Surgeon","count":108},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_335","display":"Physical Therapist","count":97},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_130","display":"Ear, Nose & Throat Doctor","count":82},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_151","display":"Oral Surgeon","count":61},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_106","display":"Gastroenterologist","count":57},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_367","display":"Cosmetic Dermatologist","count":52},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_279","display":"Foot & Ankle Specialist","count":50},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_406","display":"Family Psychiatric & Mental Health Nurse Practitioner","count":50},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_116","display":"Ophthalmologist","count":49},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_105","display":"Cardiologist","count":48},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_132","display":"Allergist","count":47},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_402","display":"Pediatric Nurse Practitioner","count":44},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_135","display":"Orthodontist","count":38},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_136","display":"Periodontist","count":38},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_144","display":"Hand Surgeon","count":38},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_368","display":"Gynecologist","count":38},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_539","display":"Physician Assistant (Orthopedics)","count":38},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_345","display":"Acupuncturist","count":36},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_528","display":"Physician Assistant (ENT)","count":32},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_338","display":"Pediatric Dermatologist","count":30},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_523","display":"Nurse Practitioner (OB-GYN)","count":30},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_152","display":"Pediatric Dentist","count":29},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_405","display":"Adult Psychiatric & Mental Health Nurse Practitioner","count":29},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_129","display":"Sports Medicine Specialist","count":28},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_108","display":"Pulmonologist","count":26},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_520","display":"Physician Assistant (OB-GYN)","count":25},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_128","display":"Neurologist","count":24},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_139","display":"Pain Management Specialist","count":24},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_122","display":"Psychiatrist","count":23},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_134","display":"Endodontist","count":23},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_137","display":"Prosthodontist","count":22},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_362","display":"Midwife","count":16},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_400","display":"Adult Nurse Practitioner","count":16},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_552","display":"Nurse Practitioner (Pediatrics)","count":15},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_403","display":"Women's Health Nurse Practitioner","count":14},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_337","display":"Psychologist","count":13},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_355","display":"Interventional Cardiologist","count":12},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_456","display":"Speech-Language Pathologist","count":12},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_541","display":"Physician Assistant (Psychiatry)","count":12},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_363","display":"Hip and Knee Surgeon","count":11},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_158","display":"Surgeon","count":10},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_258","display":"Trauma Surgeon","count":10},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_374","display":"Occupational Therapist","count":10},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_532","display":"Physician Assistant (Allergy)","count":10},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_242","display":"Pediatric Endocrinologist","count":8},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_290","display":"Spine Specialist","count":8},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_333","display":"Cosmetic Dentist","count":8},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_371","display":"Massage Therapist","count":8},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_525","display":"Nurse Practitioner (Gastroenterology)","count":8},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_549","display":"Physician Assistant (Pediatrics)","count":8},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_550","display":"Nurse Practitioner (Orthopedics)","count":8},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_565","display":"Nurse Injector","count":8},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_511","display":"Spine Surgeon","count":7},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_127","display":"Endocrinologist","count":6},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_142","display":"Vascular Surgeon","count":6},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_167","display":"Facial Plastic & Reconstructive Surgeon","count":6},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_353","display":"Shoulder & Elbow Surgeon","count":6},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_407","display":"Mental Health Nurse Practitioner","count":6},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_526","display":"Nurse Practitioner (Pain Management)","count":6},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_534","display":"Physician Assistant (Gastroenterology)","count":6},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_538","display":"Physician Assistant (Vascular Surgery)","count":6},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_540","display":"Physician Assistant (Pain Management)","count":6},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_185","display":"Hand & Microsurgery Specialist","count":5},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_109","display":"Rheumatologist","count":4},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_133","display":"Colorectal Surgeon","count":4},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_155","display":"Sleep Medicine Specialist","count":4},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_164","display":"Head & Neck Surgeon","count":4},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_256","display":"Bariatric Surgeon","count":4},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_364","display":"Bariatric Physician","count":4},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_376","display":"Optometric Glaucoma Specialist","count":4},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_448","display":"Dermatology Nurse Practitioner","count":4},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_455","display":"Neuropsychologist","count":4},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_519","display":"Nurse Practitioner (Cardiology)","count":4},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_537","display":"Physician Assistant (Cardiology)","count":4},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_585","display":"Nurse Practitioner (Endocrinology)","count":4},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_531","display":"Nurse Practitioner (Psychiatry)","count":3},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_113","display":"Neurosurgeon","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_114","display":"Infectious Disease Specialist","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_126","display":"Urologist","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_146","display":"Emergency Medicine Physician","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_170","display":"Sinus Surgeon / Rhinologist","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_197","display":"Laryngologist","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_212","display":"Glaucoma Specialist","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_255","display":"Breast Surgeon","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_296","display":"Pediatric Sports Medicine Specialist","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_297","display":"Procedural Dermatology Specialist","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_339","display":"Reproductive Endocrinologist","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_347","display":"Pediatric Allergist","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_438","display":"Marriage and Family Therapist","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_509","display":"Behavior Analyst","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_553","display":"Physician Assistant (Neurology)","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_558","display":"Nurse Practitioner (Pulmonology)","count":2},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_336","display":"Physiatrist","count":1},{"system":"https://www.zocdoc.com/fhir/CodeSystem/specialty","code":"sp_447","display":"Gerontology Nurse Practitioner","count":1}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"A query parameter is not valid, is not one this endpoint takes, or was sent more than once. The problem's `issues` names each one and says why.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"401":{"$ref":"#/components/responses/ProblemUnauthorized"},"406":{"$ref":"#/components/responses/ProblemNotAcceptable"},"429":{"$ref":"#/components/responses/ProblemTooManyRequests"},"500":{"$ref":"#/components/responses/ProblemServerError"},"503":{"description":"The scheduling service is unavailable, or its database did not answer in time. Send the request again after `Retry-After`. It is also the answer when the API key could not be checked just now, with `Retry-After`.","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"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/fhir/r4/metadata":{"get":{"tags":["FHIR base"],"summary":"Capability statement","description":"FHIR `[base]/metadata`. Returns the `CapabilityStatement` for this service, or a `TerminologyCapabilities` when called with `?mode=terminology`, which lists the code systems served and names those that are recognised but not served. `mode` is the only parameter it takes.","operationId":"fhirMetadata","parameters":[{"name":"mode","in":"query","required":false,"description":"Pass `terminology` for a `TerminologyCapabilities` resource instead of the `CapabilityStatement`. `full`, the default, returns the `CapabilityStatement`. No other mode is served.","schema":{"type":"string","enum":["full","terminology"]}},{"$ref":"#/components/parameters/XRequestId"}],"responses":{"200":{"description":"A FHIR `CapabilityStatement`, or a `TerminologyCapabilities` when `mode=terminology`.","content":{"application/fhir+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CapabilityStatement"},{"$ref":"#/components/schemas/TerminologyCapabilities"}]},"examples":{"The CapabilityStatement":{"summary":"The CapabilityStatement","value":{"resourceType":"CapabilityStatement","status":"active","date":"2026-10-13","kind":"instance","fhirVersion":"4.0.1","format":["application/fhir+json","json"],"instantiates":["http://hl7.org/fhir/CapabilityStatement/terminology-server"],"software":{"name":"haau3 platform FHIR API"},"implementation":{"description":"haau3 platform FHIR R4 API. Four services and one operation are served from this one base: terminology (CodeSystem, ValueSet), the provider directory (Practitioner, PractitionerRole, Organization, OrganizationAffiliation, HealthcareService, Location, Endpoint), questionnaires (Questionnaire), Plan Benefits (InsurancePlan), and MedList's reconcile-medications. Note that `/v1/` versions the haau3 platform API contract, not FHIR; the FHIR release is `r4`, and is echoed on every response as the `fhirVersion` media-type parameter.","url":"https://api.haau3.com/v1/fhir/r4"},"copyright":"This material contains content from LOINC (http://loinc.org). LOINC is copyright © Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license at http://loinc.org/license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc.\n\nThis product uses publicly available data courtesy of the U.S. National Library of Medicine (NLM), National Institutes of Health, Department of Health and Human Services; NLM is not responsible for the product and does not endorse or recommend this or any other product.\n\nCode systems this service holds locally are served from a dated release, named in the version of every answer and in this statement's TerminologyCapabilities. A held release may not reflect the most current data available from its publisher.\n\nFHIR® is the registered trademark of Health Level Seven International and its use here does not constitute endorsement by HL7.","rest":[{"mode":"server","documentation":"All operations accept GET with query parameters and POST with a Parameters resource. Complex inputs — coding, and codeableConcept on the validate-code operations — are accepted on POST only, as the operations framework requires; on GET pass system and code as separate parameters. A codeableConcept validates if ANY of its codings is a member, which fits data whose elements carry a vendor-local coding alongside a standard one; per-coding membership deliberately ignores each coding's display (a wrong label must not veto a right code — display checking is available on the single-coding form). A coding's version is honoured where the operation defines a version parameter (the CodeSystem operations); ValueSet validation always uses the current code-system version and refuses a versioned coding rather than silently ignoring it. A coding whose system disagrees with an explicitly supplied system or url parameter is refused. Value sets and code systems are addressed by canonical url only; instance-level operation paths ([type]/[id]/$operation) are not offered. An expansion is returned whole: displayLanguage, includeDesignations and activeOnly are refused by name on $expand, and filter, count and offset narrow only a value set this service hosts, being refused for one resolved from its own source. A batch Bundle POSTed to the base runs several operations in one round trip; each entry succeeds or fails independently.\n\nProvider directory resources are proxied from the CMS National Provider Directory and served as published, without modification. Search is GET only. Every search parameter is either declared here or refused by name: a parameter this service does not serve is never silently ignored. Where the directory requires a parameter to be sent beside another (`network` on PractitionerRole and HealthcareService), the rule is applied here, before the directory is asked.\n\nA curated set of questionnaires is served from copies vendored at a recorded release of their source, so those forms render the same way on every request. A search that names a canonical URL this service holds no copy of is answered from the source directly, and depends on that source being reachable. A search with no parameters lists the curated set. Search is GET only, and every search parameter is either declared here or refused by name. No operations are served on Questionnaire, and no QuestionnaireResponse is accepted or stored: a completed response is built by the application that collected it and references the questionnaire as `{url}|{version}`.\n\nPlan Benefits (InsurancePlan): what a Medicare Advantage or ACA Marketplace plan covers and what a member pays, read from the files CMS publishes. Each plan conforms to the haau3 Plan Benefits profile (https://haau3.com/fhir/StructureDefinition/haau3-insurance-plan) and to the SBC InsurancePlan profile of the CARIN Digital Insurance Card guide, 2.0.0-ballot, and names the CMS release it was read from.\n\nMedList: POST [base]/$reconcile-medications reconciles one patient's medication records into one clean list, returned as a Bundle of reconciled MedicationRequests with a Provenance for each. The operation receives patient data, so send it only under an executed agreement. Nothing a request carries is stored or logged. It is invoked directly and is not offered inside a batch.","interaction":[{"code":"batch"}],"resource":[{"type":"CodeSystem","operation":[{"name":"lookup","definition":"http://hl7.org/fhir/OperationDefinition/CodeSystem-lookup"},{"name":"validate-code","definition":"http://hl7.org/fhir/OperationDefinition/CodeSystem-validate-code"}]},{"type":"ValueSet","operation":[{"name":"expand","definition":"http://hl7.org/fhir/OperationDefinition/ValueSet-expand"},{"name":"validate-code","definition":"http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code"}]},{"type":"Practitioner","interaction":[{"code":"read"},{"code":"search-type"}],"searchRevInclude":["PractitionerRole:practitioner"],"searchParam":[{"name":"identifier","definition":"http://hl7.org/fhir/SearchParameter/Practitioner-identifier","type":"token","documentation":"An NPI, as `{system}|{npi}` or a bare 10-digit value. Accepted systems: http://terminology.hl7.org/NamingSystem/npi, http://hl7.org/fhir/sid/us-npi, urn:oid:2.16.840.1.113883.4.6. All of them resolve the same provider. Responses carry the directory's own system, `http://hl7.org/fhir/sid/us-npi`, which may differ from the one you sent. One NPI per search; use a batch Bundle to resolve several. Any other identifier system is refused by name rather than searched, because a system the source does not index would answer with an empty result that reads as 'no such provider'."},{"name":"name","definition":"http://hl7.org/fhir/SearchParameter/Practitioner-name","type":"string","documentation":"Matches across the whole name."},{"name":"family","definition":"http://hl7.org/fhir/SearchParameter/individual-family","type":"string","documentation":"The family name."},{"name":"given","definition":"http://hl7.org/fhir/SearchParameter/individual-given","type":"string","documentation":"A given name."},{"name":"address-city","definition":"http://hl7.org/fhir/SearchParameter/individual-address-city","type":"string","documentation":"Narrows a search by city; cannot be used on its own. Matches any of the practitioner's addresses, so a result can still list addresses in another city."},{"name":"address-state","definition":"http://hl7.org/fhir/SearchParameter/individual-address-state","type":"string","documentation":"Narrows a search by state; cannot be used on its own. Matches any of the practitioner's addresses, so a result can still list addresses in another state."},{"name":"active","definition":"http://hl7.org/fhir/SearchParameter/Practitioner-active","type":"token","documentation":"`true` or `false`. Narrows a search; cannot be used on its own."},{"name":"_id","definition":"http://hl7.org/fhir/SearchParameter/Resource-id","type":"token","documentation":"A Practitioner id. Searching by id rather than reading it lets one request also bring the records an `_include` or `_revinclude` names."},{"name":"_summary","type":"token","documentation":"`count` only: answers how many records match, as `total`, with no entries. Cannot be combined with `_include`, `_revinclude`, `_count` or `page`."},{"name":"_count","definition":"http://hl7.org/fhir/SearchParameter/Resource-count","type":"number","documentation":"Results are paged. `_count` sets the page size (1 to 100); a larger value is refused rather than quietly reduced. Follow `link` with relation `next` to continue. The cursor it carries is opaque and must not be constructed or modified."}],"documentation":"Search by NPI to resolve an identifier you already hold, or by name to find one. A search needs an identifier, a name or an id: `address-city`, `address-state` and `active` narrow a search but cannot stand alone. Resources are served as the source publishes them, unmodified. Add `_revinclude=PractitionerRole:practitioner` to get the practitioner's roles in the same bundle."},{"type":"PractitionerRole","interaction":[{"code":"read"},{"code":"search-type"}],"searchInclude":["PractitionerRole:practitioner","PractitionerRole:organization","PractitionerRole:location","PractitionerRole:network","PractitionerRole:endpoint"],"searchParam":[{"name":"practitioner","definition":"http://hl7.org/fhir/SearchParameter/PractitionerRole-practitioner","type":"reference","documentation":"The roles one practitioner holds. Give a Practitioner id, `Practitioner/{id}`, or the `fullUrl` this service returned. An address on another server is refused."},{"name":"organization","definition":"http://hl7.org/fhir/SearchParameter/PractitionerRole-organization","type":"reference","documentation":"The roles held at one organization. Give a Organization id, `Organization/{id}`, or the `fullUrl` this service returned. An address on another server is refused."},{"name":"location","definition":"http://hl7.org/fhir/SearchParameter/PractitionerRole-location","type":"reference","documentation":"The roles held at one location. Give a Location id, `Location/{id}`, or the `fullUrl` this service returned. An address on another server is refused."},{"name":"endpoint","definition":"http://hl7.org/fhir/SearchParameter/PractitionerRole-endpoint","type":"reference","documentation":"The roles reached through one endpoint. Give a Endpoint id, `Endpoint/{id}`, or the `fullUrl` this service returned. An address on another server is refused."},{"name":"specialty","definition":"http://hl7.org/fhir/SearchParameter/PractitionerRole-specialty","type":"token","documentation":"A NUCC Health Care Provider Taxonomy code, bare or as `http://nucc.org/provider-taxonomy|{code}` (for example `207RC0000X`, cardiovascular disease). Any other system is refused, because the directory codes specialties in NUCC alone and would answer another system with nothing. Narrows a search; cannot be used on its own."},{"name":"network","definition":"http://hl7.org/fhir/us/ndh/SearchParameter/practitionerrole-network","type":"reference","documentation":"The roles the directory lists in one insurance network (an Organization of type `ntwk`). Cannot be used on its own: send it beside `practitioner`, `organization`, `location` or `specialty`. A search that breaks this rule is refused before the directory is asked. Beside a specialty or a busy location the directory can take 10 to 15 seconds. A role the network's records do not list is not shown to be out of network: the directory's network data is sparse. Give a Organization id, `Organization/{id}`, or the `fullUrl` this service returned. An address on another server is refused."},{"name":"new-patient-from-network","definition":"http://hl7.org/fhir/us/ndh/SearchParameter/practitionerrole-new-patient-from-network","type":"reference","documentation":"The roles accepting new patients from one insurance network. Cannot be used on its own: send it beside `practitioner`, `organization`, `location` or `specialty`. A search that breaks this rule is refused before the directory is asked. Give a Organization id, `Organization/{id}`, or the `fullUrl` this service returned. An address on another server is refused."},{"name":"new-patient","definition":"http://hl7.org/fhir/us/ndh/SearchParameter/practitionerrole-new-patient","type":"token","documentation":"Whether the role accepts new patients: `newpt`, `nopt`, `existptonly` or `existptfam`, bare or under `http://terminology.hl7.org/CodeSystem/accepting-patients`. Narrows a search; cannot be used on its own."},{"name":"active","definition":"http://hl7.org/fhir/SearchParameter/PractitionerRole-active","type":"token","documentation":"`true` or `false`. Narrows a search; cannot be used on its own."},{"name":"_id","definition":"http://hl7.org/fhir/SearchParameter/Resource-id","type":"token","documentation":"A PractitionerRole id. Searching by id rather than reading it lets one request also bring the records an `_include` or `_revinclude` names."},{"name":"_summary","type":"token","documentation":"`count` only: answers how many records match, as `total`, with no entries. Cannot be combined with `_include`, `_revinclude`, `_count` or `page`."},{"name":"_count","definition":"http://hl7.org/fhir/SearchParameter/Resource-count","type":"number","documentation":"Results are paged. `_count` sets the page size (1 to 100); a larger value is refused rather than quietly reduced. Follow `link` with relation `next` to continue. The cursor it carries is opaque and must not be constructed or modified."}],"documentation":"The roles practitioners hold: organization, specialty, locations, networks and whether they accept new patients. A search needs a practitioner, organization, location, endpoint or id; `specialty`, `new-patient` and `active` narrow it. `network` and `new-patient-from-network` need a practitioner, organization, location or specialty beside them. `identifier` is not offered because the source does not carry identifiers on these resources."},{"type":"Organization","interaction":[{"code":"read"},{"code":"search-type"}],"searchInclude":["Organization:partof"],"searchRevInclude":["PractitionerRole:organization","OrganizationAffiliation:primary-organization","OrganizationAffiliation:participating-organization","Location:organization","Endpoint:organization","Organization:partof"],"searchParam":[{"name":"name","definition":"http://hl7.org/fhir/SearchParameter/Organization-name","type":"string","documentation":"Matches the organization's name."},{"name":"identifier","definition":"http://hl7.org/fhir/SearchParameter/Organization-identifier","type":"token","documentation":"An organization's NPI, as `{system}|{npi}` or a bare 10-digit value, under the same systems `Practitioner` accepts. An NPI search can return more than the practice that holds the NPI: a parent organization that lists it among several NPIs is a match too, because it carries the NPI as an NPI."},{"name":"partof","definition":"http://hl7.org/fhir/SearchParameter/Organization-partof","type":"reference","documentation":"The organizations that are part of one organization. Give a Organization id, `Organization/{id}`, or the `fullUrl` this service returned. An address on another server is refused."},{"name":"type","definition":"http://hl7.org/fhir/SearchParameter/Organization-type","type":"token","documentation":"An organization type from `http://terminology.hl7.org/CodeSystem/organization-type`, bare or with that system: `prov` for healthcare providers, `pay` for payers, `ntwk` for insurance networks. `ntwk` is also accepted under Plan-Net's `http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/OrgTypeCS`. `type=ntwk` and `type=pay` may stand alone, to list every network or every payer; any other type narrows a search. The directory records networks by the text of their type rather than a code; this service searches that text and confirms each answer is a network, and answers 502 rather than serve one that is not."},{"name":"active","definition":"http://hl7.org/fhir/SearchParameter/Organization-active","type":"token","documentation":"`true` or `false`. Narrows a search; cannot be used on its own."},{"name":"address-city","definition":"http://hl7.org/fhir/SearchParameter/Organization-address-city","type":"string","documentation":"Narrows a search by city; cannot be used on its own. Matches any of the organization's addresses, so a result can still list addresses in another city."},{"name":"address-state","definition":"http://hl7.org/fhir/SearchParameter/Organization-address-state","type":"string","documentation":"Narrows a search by state; cannot be used on its own. Matches any of the organization's addresses, so a result can still list addresses in another state."},{"name":"address-postalcode","definition":"http://hl7.org/fhir/SearchParameter/Organization-address-postalcode","type":"string","documentation":"Narrows a search by postal code; cannot be used on its own. Matches any of the organization's addresses, so a result can still list addresses in another postal code."},{"name":"_id","definition":"http://hl7.org/fhir/SearchParameter/Resource-id","type":"token","documentation":"A Organization id. Searching by id rather than reading it lets one request also bring the records an `_include` or `_revinclude` names."},{"name":"_summary","type":"token","documentation":"`count` only: answers how many records match, as `total`, with no entries. Cannot be combined with `_include`, `_revinclude`, `_count` or `page`."},{"name":"_count","definition":"http://hl7.org/fhir/SearchParameter/Resource-count","type":"number","documentation":"Results are paged. `_count` sets the page size (1 to 100); a larger value is refused rather than quietly reduced. Follow `link` with relation `next` to continue. The cursor it carries is opaque and must not be constructed or modified."}],"documentation":"Healthcare providers, payers and insurance networks. A search needs a name, an NPI, a parent (`partof`), an id, or `type=ntwk` or `type=pay`; other types, `active` and the address parameters narrow it. `_revinclude` brings the roles, affiliations, locations and endpoints that point at each match."},{"type":"OrganizationAffiliation","interaction":[{"code":"read"},{"code":"search-type"}],"searchInclude":["OrganizationAffiliation:participating-organization","OrganizationAffiliation:primary-organization","OrganizationAffiliation:network"],"searchParam":[{"name":"network","definition":"http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-network","type":"reference","documentation":"The affiliations the directory lists in one insurance network. An organization the network's records do not list is not shown to be out of network: the directory's network data is sparse. Give a Organization id, `Organization/{id}`, or the `fullUrl` this service returned. An address on another server is refused."},{"name":"primary-organization","definition":"http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-primary-organization","type":"reference","documentation":"The affiliations whose primary organization is this one. Give a Organization id, `Organization/{id}`, or the `fullUrl` this service returned. An address on another server is refused."},{"name":"participating-organization","definition":"http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-participating-organization","type":"reference","documentation":"The affiliations one organization participates in. Give a Organization id, `Organization/{id}`, or the `fullUrl` this service returned. An address on another server is refused."},{"name":"active","definition":"http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-active","type":"token","documentation":"`true` or `false`. Narrows a search; cannot be used on its own."},{"name":"_id","definition":"http://hl7.org/fhir/SearchParameter/Resource-id","type":"token","documentation":"A OrganizationAffiliation id. Searching by id rather than reading it lets one request also bring the records an `_include` or `_revinclude` names."},{"name":"_summary","type":"token","documentation":"`count` only: answers how many records match, as `total`, with no entries. Cannot be combined with `_include`, `_revinclude`, `_count` or `page`."},{"name":"_count","definition":"http://hl7.org/fhir/SearchParameter/Resource-count","type":"number","documentation":"Results are paged. `_count` sets the page size (1 to 100); a larger value is refused rather than quietly reduced. Follow `link` with relation `next` to continue. The cursor it carries is opaque and must not be constructed or modified."}],"documentation":"Which organizations take part in which networks. A search needs a network, a primary or participating organization, or an id. `network` with `participating-organization` asks whether the directory lists one organization in one network."},{"type":"HealthcareService","interaction":[{"code":"read"},{"code":"search-type"}],"searchParam":[{"name":"location","definition":"http://hl7.org/fhir/SearchParameter/HealthcareService-location","type":"reference","documentation":"The services offered at one location. Give a Location id, `Location/{id}`, or the `fullUrl` this service returned. An address on another server is refused."},{"name":"network","definition":"http://hl7.org/fhir/us/ndh/SearchParameter/healthcareservice-network","type":"reference","documentation":"The services the directory lists in one insurance network. Cannot be used on its own: send it beside `location`. A search that breaks this rule is refused before the directory is asked. Give a Organization id, `Organization/{id}`, or the `fullUrl` this service returned. An address on another server is refused."},{"name":"active","definition":"http://hl7.org/fhir/SearchParameter/HealthcareService-active","type":"token","documentation":"`true` or `false`. Narrows a search; cannot be used on its own."},{"name":"_id","definition":"http://hl7.org/fhir/SearchParameter/Resource-id","type":"token","documentation":"A HealthcareService id. Searching by id rather than reading it lets one request also bring the records an `_include` or `_revinclude` names."},{"name":"_summary","type":"token","documentation":"`count` only: answers how many records match, as `total`, with no entries. Cannot be combined with `_include`, `_revinclude`, `_count` or `page`."},{"name":"_count","definition":"http://hl7.org/fhir/SearchParameter/Resource-count","type":"number","documentation":"Results are paged. `_count` sets the page size (1 to 100); a larger value is refused rather than quietly reduced. Follow `link` with relation `next` to continue. The cursor it carries is opaque and must not be constructed or modified."}],"documentation":"The services the directory lists. Its service records name a network and, for a few, a location; none names an organization. A search needs a location or an id; `network` needs a location beside it."},{"type":"Location","interaction":[{"code":"read"},{"code":"search-type"}],"searchInclude":["Location:organization"],"searchRevInclude":["PractitionerRole:location"],"searchParam":[{"name":"organization","definition":"http://hl7.org/fhir/SearchParameter/Location-organization","type":"reference","documentation":"The locations one organization manages. Give a Organization id, `Organization/{id}`, or the `fullUrl` this service returned. An address on another server is refused."},{"name":"name","definition":"http://hl7.org/fhir/SearchParameter/Location-name","type":"string","documentation":"Matches the location's name."},{"name":"address-city","definition":"http://hl7.org/fhir/SearchParameter/Location-address-city","type":"string","documentation":"Narrows a search by city; cannot be used on its own."},{"name":"address-state","definition":"http://hl7.org/fhir/SearchParameter/Location-address-state","type":"string","documentation":"Narrows a search by state; cannot be used on its own."},{"name":"address-postalcode","definition":"http://hl7.org/fhir/SearchParameter/Location-address-postalcode","type":"string","documentation":"Narrows a search by postal code; cannot be used on its own."},{"name":"status","definition":"http://hl7.org/fhir/SearchParameter/Location-status","type":"token","documentation":"`active`, `suspended` or `inactive`. Narrows a search; cannot be used on its own."},{"name":"_id","definition":"http://hl7.org/fhir/SearchParameter/Resource-id","type":"token","documentation":"A Location id. Searching by id rather than reading it lets one request also bring the records an `_include` or `_revinclude` names."},{"name":"_summary","type":"token","documentation":"`count` only: answers how many records match, as `total`, with no entries. Cannot be combined with `_include`, `_revinclude`, `_count` or `page`."},{"name":"_count","definition":"http://hl7.org/fhir/SearchParameter/Resource-count","type":"number","documentation":"Results are paged. `_count` sets the page size (1 to 100); a larger value is refused rather than quietly reduced. Follow `link` with relation `next` to continue. The cursor it carries is opaque and must not be constructed or modified."}],"documentation":"Practice locations. A search needs an organization, a name or an id; the address parameters and `status` narrow it. `_revinclude=PractitionerRole:location` brings the roles held at each location."},{"type":"Endpoint","interaction":[{"code":"read"},{"code":"search-type"}],"searchInclude":["Endpoint:organization"],"searchParam":[{"name":"organization","definition":"http://hl7.org/fhir/SearchParameter/Endpoint-organization","type":"reference","documentation":"The endpoints one organization manages. Give a Organization id, `Organization/{id}`, or the `fullUrl` this service returned. An address on another server is refused."},{"name":"connection-type","definition":"http://hl7.org/fhir/SearchParameter/Endpoint-connection-type","type":"token","documentation":"A connection type from `http://terminology.hl7.org/CodeSystem/endpoint-connection-type`, bare or with that system: for example `hl7-fhir-rest` or `direct-project`. Narrows a search; cannot be used on its own."},{"name":"status","definition":"http://hl7.org/fhir/SearchParameter/Endpoint-status","type":"token","documentation":"`active`, `suspended`, `error`, `off`, `entered-in-error` or `test`. Narrows a search; cannot be used on its own."},{"name":"name","definition":"http://hl7.org/fhir/SearchParameter/Endpoint-name","type":"string","documentation":"Matches the endpoint's name. Narrows a search; cannot be used on its own, because most of the directory's endpoints share one name."},{"name":"_id","definition":"http://hl7.org/fhir/SearchParameter/Resource-id","type":"token","documentation":"A Endpoint id. Searching by id rather than reading it lets one request also bring the records an `_include` or `_revinclude` names."},{"name":"_summary","type":"token","documentation":"`count` only: answers how many records match, as `total`, with no entries. Cannot be combined with `_include`, `_revinclude`, `_count` or `page`."},{"name":"_count","definition":"http://hl7.org/fhir/SearchParameter/Resource-count","type":"number","documentation":"Results are paged. `_count` sets the page size (1 to 100); a larger value is refused rather than quietly reduced. Follow `link` with relation `next` to continue. The cursor it carries is opaque and must not be constructed or modified."}],"documentation":"Technical endpoints: Direct addresses and FHIR servers. A search needs an organization or an id; `connection-type`, `status` and `name` narrow it."},{"type":"Questionnaire","interaction":[{"code":"read"},{"code":"search-type"}],"searchParam":[{"name":"url","definition":"http://hl7.org/fhir/SearchParameter/Questionnaire-url","type":"uri","documentation":"Exact match on the canonical URL. `{url}|{version}` is accepted and matches that version only. A canonical this server holds a copy of is answered from that copy at every version. Any other LOINC canonical is fetched from LOINC. A canonical that is the address of a form published under `https://smart-health-checkin.org/connectathon/Questionnaire/`, or under another place this server is set up to reach, is fetched from that address; any other canonical matches nothing."},{"name":"version","definition":"http://hl7.org/fhir/SearchParameter/Questionnaire-version","type":"token","documentation":"Exact match on the business version. On its own it filters the copies this server holds; with `url` it names the release to fetch."}],"documentation":"Questionnaires served as their source (LOINC) publishes them, without modification of any content element, `status` included (the source publishes the current set as `draft`); the resource `id` is assigned by this server and `meta.versionId` and `meta.tag` are not carried. A form published at its own address, under `https://smart-health-checkin.org/connectathon/Questionnaire/` or another place this server is set up to reach, is reached only by its canonical `url` and served exactly as published, with its own copyright, its entry addressed where it is published. A search with no parameters lists the curated set, the questionnaires this server holds copies of, which are answered from those copies and render the same way on every request. A search naming a canonical `url` this server holds no copy of is answered from the source directly and depends on the source being reachable; when it cannot answer, the response is an OperationOutcome with a 5xx and never an empty searchset. Results are never paged: every search returns all matches in one page with `total` set; `_count` is refused by name. Search is GET only. Every other parameter, `status` included, is refused by name, never silently ignored. No operation is offered on Questionnaire; QuestionnaireResponse is not stored or accepted: build it client-side and reference the questionnaire as `{url}|{version}`. No SDC profile conformance is asserted."},{"type":"InsurancePlan","profile":"https://haau3.com/fhir/StructureDefinition/haau3-insurance-plan","supportedProfile":["https://haau3.com/fhir/StructureDefinition/haau3-insurance-plan","http://hl7.org/fhir/us/insurance-card/StructureDefinition/sbc-insurance-plan|2.0.0-ballot"],"interaction":[{"code":"read"},{"code":"search-type"}],"searchParam":[{"name":"identifier","definition":"http://hl7.org/fhir/SearchParameter/InsurancePlan-identifier","type":"token","documentation":"A plan id, as `value` or `system|value`. A Medicare Advantage plan is found by CMS's plan id (http://cms.gov/medicare/ma-plan-id, segment in three digits: H2406-013-000) or its bid_id (https://haau3.com/fhir/NamingSystem/cms-ma-bid-id: H2406_013_0); a Marketplace plan by its HIOS plan id (https://haau3.com/fhir/NamingSystem/hios-plan-id: 19898FL0340001-01) or its standard component (https://haau3.com/fhir/NamingSystem/hios-standard-component-id: 19898FL0340001), which finds every variant. A drug-only or dental-only plan is not served; an identifier search that finds one answers no plan and an OperationOutcome entry saying why."},{"name":"name","definition":"http://hl7.org/fhir/SearchParameter/InsurancePlan-name","type":"string","documentation":"The plan's name, ignoring case and accents: bare `name` matches the start, `name:contains` anywhere, `name:exact` the whole name exactly."},{"name":"coverage-area-state","definition":"https://haau3.com/fhir/SearchParameter/InsurancePlan-coverage-area-state","type":"token","documentation":"A two-letter state code: the plans sold in that state."},{"name":"coverage-area-county","definition":"https://haau3.com/fhir/SearchParameter/InsurancePlan-coverage-area-county","type":"token","documentation":"A five-digit FIPS county code (12086), bare or with the system http://terminology.hl7.org/CodeSystem/FIPS64: the plans sold in that county, in whole or in part. InsurancePlan/$counties?state= lists a state's counties and their codes."},{"name":"type","definition":"http://hl7.org/fhir/SearchParameter/InsurancePlan-type","type":"token","documentation":"`mediadv` (Medicare Advantage) or `qhp` (Marketplace), from http://terminology.hl7.org/CodeSystem/insurance-product-type. Narrows a search; it is not one by itself."},{"name":"sold-to","definition":"https://haau3.com/fhir/SearchParameter/InsurancePlan-sold-to","type":"token","documentation":"`individuals` or `employer-groups`: plans a person can buy on their own, or plans sold only to employer and union groups (Medicare Advantage) or to small employers (Marketplace SHOP plans). Narrows a search; it is not one by itself."},{"name":"_count","definition":"http://hl7.org/fhir/SearchParameter/Resource-count","type":"number","documentation":"Page size, 1 to 50, 10 by default; a larger value is refused rather than quietly reduced. Follow `link` with relation `next` to continue: its cursor is opaque, belongs to the one search, and is refused once the plans are updated, so a search never skips or repeats a plan unseen."}],"operation":[{"name":"counties","definition":"https://haau3.com/fhir/OperationDefinition/InsurancePlan-counties"},{"name":"in-network","definition":"https://haau3.com/fhir/OperationDefinition/InsurancePlan-in-network"}],"documentation":"Read a plan by its id, or search by identifier, name, state or county. A search needs at least one of these. Every result is the whole plan, sorted by name and then id, and every page states the total. Releases being served. Medicare Advantage: ma-2027-2026-10-01 (plan year 2027); ACA Marketplace: aca-2026-2026-08-10 (plan year 2026)."}],"operation":[{"name":"reconcile-medications","definition":"https://haau3.com/fhir/OperationDefinition/reconcile-medications","documentation":"Reconciles one patient's medication records into one medication list. POST a Bundle of the records, or a Parameters resource with resource parts and an optional asOf."}]}]}},"The TerminologyCapabilities":{"summary":"The TerminologyCapabilities","value":{"resourceType":"TerminologyCapabilities","status":"active","date":"2026-08-12","kind":"instance","fhirVersion":"4.0.1","software":{"name":"haau3 platform terminology service"},"implementation":{"description":"haau3 FHIR R4 terminology service. Note that `/v1/` versions the haau3 platform API contract, not FHIR; the FHIR release is `r4`, and is echoed on every response as the `fhirVersion` media-type parameter.","url":"https://api.haau3.com/v1/fhir/r4"},"copyright":"This material contains content from LOINC (http://loinc.org). LOINC is copyright © Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license at http://loinc.org/license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc.\n\nThis product uses publicly available data courtesy of the U.S. National Library of Medicine (NLM), National Institutes of Health, Department of Health and Human Services; NLM is not responsible for the product and does not endorse or recommend this or any other product.\n\nCode systems this service holds locally are served from a dated release, named in the version of every answer and in this statement's TerminologyCapabilities. A held release may not reflect the most current data available from its publisher.\n\nFHIR® is the registered trademark of Health Level Seven International and its use here does not constitute endorsement by HL7.","description":"Recognised but not served here: http://snomed.info/sct (SNOMED CT is free in the United States only through a UMLS Metathesaurus licence, and NLM does not permit a vendor to cover its customers under its own licence. Callers holding their own UMLS credentials will be able to use them here; there is no path that serves SNOMED CT to an unlicensed caller.); http://www.ama-assn.org/go/cpt (CPT is licensed by the American Medical Association and requires a paid distributor licence per product. haau3 does not hold one, so this service will not answer about CPT codes at all.); http://hl7.org/fhir/sid/icd-10-cm (ICD-10-CM is public domain and carries no licence restriction, but this service does not yet have a source configured for it.); http://unitsofmeasure.org (UCUM is a grammar rather than a list of codes, so it is validated by a unit parser rather than looked up on a terminology server. A lookup endpoint is the wrong shape for the question.). A request naming one of these returns an OperationOutcome with issue code not-supported, never a guess.","codeSearch":"all","codeSystem":[{"uri":"http://loinc.org"},{"uri":"http://www.nlm.nih.gov/research/umls/rxnorm","version":[{"code":"10052026","isDefault":true,"compositional":false,"language":["en"],"property":["TTY","SUPPRESS","CVF","inactive","boss_of","consists_of","constitutes","contained_in","contains","dose_form_of","doseformgroup_of","form_of","has_boss","has_dose_form","has_doseformgroup","has_form","has_ingredient","has_ingredients","has_part","has_precise_ingredient","has_quantified_form","has_tradename","ingredient_of","ingredients_of","inverse_isa","isa","part_of","precise_ingredient_of","quantified_form_of","reformulated_to","reformulation_of","tradename_of","NDC","ORIG_CODE","ORIG_SOURCE","RXN_ACTIVATED","RXN_AI","RXN_AM","RXN_AVAILABLE_STRENGTH","RXN_BN_CARDINALITY","RXN_BOSS_FROM","RXN_BOSS_STRENGTH_DENOM_UNIT","RXN_BOSS_STRENGTH_DENOM_VALUE","RXN_BOSS_STRENGTH_NUM_UNIT","RXN_BOSS_STRENGTH_NUM_VALUE","RXN_HUMAN_DRUG","RXN_IN_EXPRESSED_FLAG","RXN_OBSOLETED","RXN_QUALITATIVE_DISTINCTION","RXN_QUANTITY","RXN_STRENGTH","RXN_VET_DRUG","RXTERM_FORM"]}]}],"expansion":{"hierarchical":false,"paging":true},"validateCode":{"translations":false}}}}}},"headers":{"Cache-Control":{"description":"`private, max-age=300`: keep this answer up to five minutes. `no-store` when the answer says a store it reports on could not be read just now.","schema":{"type":"string"}},"ETag":{"description":"Send it back in `If-None-Match` to get a `304` when nothing has changed.","schema":{"type":"string"}},"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"304":{"description":"Not modified: the `ETag` sent in `If-None-Match` still matches, so the copy you hold is current. No body.","headers":{"Cache-Control":{"description":"`private, max-age=300`: keep this answer up to five minutes. `no-store` when the answer says a store it reports on could not be read just now.","schema":{"type":"string"}},"ETag":{"description":"Send it back in `If-None-Match` to get a `304` when nothing has changed.","schema":{"type":"string"}},"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"Two different FHIR versions were named in one request, a parameter other than `mode` was sent, `mode` was sent more than once, or `mode` has a value this base does not serve.","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"},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"503":{"$ref":"#/components/responses/FhirUnavailable"}}}},"/v1/fhir/r4":{"post":{"tags":["FHIR base"],"summary":"Run several operations in one request (batch)","description":"POST a FHIR `Bundle` with `type: batch` to send several requests in one round trip. Each entry's `request.url` is relative to this base and may be any read, search or operation of any service on it, except `$reconcile-medications`, which a batch refuses by name. Entries are independent: one that fails, such as a lookup of an unknown code, does not fail the others, and each carries its own status in the `batch-response`. For example, a batch of 50 terminology lookups measured about 4.8 ms per code, against 181 ms each when sent one at a time. Transaction bundles are not accepted: nothing on this base writes, so all or nothing would only turn one bad entry into a wholly failed request. A batch carries at most 100 entries in at most 1 MiB, and has 60 seconds: an entry still running then answers `504` inside the `200`. See https://docs.haau3.com/errors#limits.","operationId":"fhirBatch","requestBody":{"required":true,"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Bundle"},"examples":{"Two lookups and a state's counties in one request":{"summary":"Two lookups and a state's counties in one request","value":{"resourceType":"Bundle","type":"batch","entry":[{"request":{"method":"GET","url":"CodeSystem/$lookup?system=http://loinc.org&code=2345-7&property=SHORTNAME"}},{"request":{"method":"GET","url":"CodeSystem/$lookup?system=http://loinc.org&code=8867-4&property=SHORTNAME"}},{"request":{"method":"GET","url":"InsurancePlan/$counties?state=DE"}}]}}}}}},"responses":{"200":{"description":"A FHIR `Bundle` with `type: batch-response`, one entry per request entry.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Bundle"},"examples":{"Two lookups and a state's counties in one request":{"summary":"Two lookups and a state's counties in one request","value":{"resourceType":"Bundle","type":"batch-response","entry":[{"response":{"status":"200"},"resource":{"resourceType":"Parameters","parameter":[{"name":"code","valueCode":"2345-7"},{"name":"system","valueString":"http://loinc.org"},{"name":"name","valueString":"LOINC"},{"name":"version","valueString":"2.83"},{"name":"display","valueString":"Glucose [Mass/volume] in Serum or Plasma"},{"name":"status","valueCode":"active"},{"name":"property","part":[{"name":"code","valueCode":"SHORTNAME"},{"name":"value","valueString":"Glucose SerPl-mCnc"}]}]}},{"response":{"status":"200"},"resource":{"resourceType":"Parameters","parameter":[{"name":"code","valueCode":"8867-4"},{"name":"system","valueString":"http://loinc.org"},{"name":"name","valueString":"LOINC"},{"name":"version","valueString":"2.83"},{"name":"display","valueString":"Heart rate"},{"name":"status","valueCode":"active"},{"name":"property","part":[{"name":"code","valueCode":"SHORTNAME"},{"name":"value","valueString":"Heart rate"}]}]}},{"response":{"status":"200"},"resource":{"resourceType":"Parameters","parameter":[{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"10001","display":"Kent County"}},{"name":"state","valueString":"DE"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"10003","display":"New Castle County"}},{"name":"state","valueString":"DE"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"10005","display":"Sussex County"}},{"name":"state","valueString":"DE"}]},{"name":"source","valueString":"U.S. Census Bureau, 2020 FIPS codes for counties and county equivalents: https://www2.census.gov/geo/docs/reference/codes2020/national_county2020.txt"}]}}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"The body was not a batch Bundle, it carried more than 100 entries (`too-long`), or the request carried a query parameter: a batch takes none, and each entry carries its own in its `request.url`.","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, the most this base reads from one request. Send a large batch as several smaller ones.","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"}},"parameters":[{"$ref":"#/components/parameters/XRequestId"}]}},"/v1/fhir/r4/CodeSystem/$lookup":{"get":{"tags":["Terminology"],"summary":"Look up a code","description":"FHIR `CodeSystem/$lookup`. Returns a code's display and requested properties. On POST, a `coding` parameter may stand in for `system` + `code`.","responses":{"200":{"description":"A FHIR `Parameters` resource describing the code.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"},"examples":{"A LOINC code's short name":{"summary":"A LOINC code's short name","value":{"resourceType":"Parameters","parameter":[{"name":"code","valueCode":"2345-7"},{"name":"system","valueString":"http://loinc.org"},{"name":"name","valueString":"LOINC"},{"name":"version","valueString":"2.83"},{"name":"display","valueString":"Glucose [Mass/volume] in Serum or Plasma"},{"name":"status","valueCode":"active"},{"name":"property","part":[{"name":"code","valueCode":"SHORTNAME"},{"name":"value","valueString":"Glucose SerPl-mCnc"}]}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"Invalid request: a parameter is not valid, is not one this operation takes, or was sent more than once (only `property` on `$lookup` repeats). The `OperationOutcome` names each one.","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"},"404":{"description":"The code system is not served here, or the code was not found. The `OperationOutcome` says which, and why: an unrecognised system, a system we are not licensed to serve, and a genuinely missing code are different answers.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"406":{"$ref":"#/components/responses/FhirNotAcceptable"},"422":{"description":"The request is well formed, but this service does not answer it in that form: an operation it does not offer for a code system it holds, or the expansion of a value set defined by a rule too large to list, the whole of LOINC included. The `OperationOutcome` says which, and what to ask instead.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"502":{"description":"The code system's source could not be reached: an upstream terminology server, or the local store for a code system this service holds.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"No source is configured for this code system on this deployment, no release has been published to it, or its source is rate limiting requests (with `Retry-After`). The service returns no answer rather than guessing one. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The code system's source did not respond in time.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}},"operationId":"codeSystemLookup","parameters":[{"name":"code","in":"query","required":true,"description":"The code to look up in the code system.","schema":{"type":"string","minLength":1},"example":"2345-7"},{"name":"system","in":"query","required":false,"description":"Code system URI to look up against. Defaults to LOINC (`http://loinc.org`).","schema":{"default":"http://loinc.org","type":"string","minLength":1},"example":"http://loinc.org"},{"name":"version","in":"query","required":false,"description":"Optional code system version. Defaults to the server's current version.","schema":{"type":"string","minLength":1}},{"name":"property","in":"query","required":false,"description":"Property to return, repeatable up to 100 times. Narrows the response to the named properties of the code system; omit it to receive all of them. An unrecognised property name is silently omitted from the response, so treat an absent property as 'no answer', never as a negative. More than 100 is refused with a `400` coded `too-long`.","schema":{"anyOf":[{"type":"string","minLength":1},{"maxItems":100,"type":"array","items":{"type":"string","minLength":1}}]},"example":"SHORTNAME"},{"name":"displayLanguage","in":"query","required":false,"description":"Language for the returned display and designations. Defaults to `en-US`, which also keeps answers small, since a code can have about 30 translations.","schema":{"type":"string","minLength":1}},{"name":"date","in":"query","required":false,"description":"The date for which the lookup should be valid.","schema":{"type":"string","minLength":1}},{"$ref":"#/components/parameters/XRequestId"}]},"post":{"tags":["Terminology"],"summary":"Look up a code","description":"FHIR `CodeSystem/$lookup`. Returns a code's display and requested properties. On POST, a `coding` parameter may stand in for `system` + `code`.","responses":{"200":{"description":"A FHIR `Parameters` resource describing the code.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"},"examples":{"A LOINC code's short name":{"summary":"A LOINC code's short name","value":{"resourceType":"Parameters","parameter":[{"name":"code","valueCode":"2345-7"},{"name":"system","valueString":"http://loinc.org"},{"name":"name","valueString":"LOINC"},{"name":"version","valueString":"2.83"},{"name":"display","valueString":"Glucose [Mass/volume] in Serum or Plasma"},{"name":"status","valueCode":"active"},{"name":"property","part":[{"name":"code","valueCode":"SHORTNAME"},{"name":"value","valueString":"Glucose SerPl-mCnc"}]}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"Invalid request: a parameter is not valid, is not one this operation takes, or was sent more than once (only `property` on `$lookup` repeats). The `OperationOutcome` names each one.","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"},"404":{"description":"The code system is not served here, or the code was not found. The `OperationOutcome` says which, and why: an unrecognised system, a system we are not licensed to serve, and a genuinely missing code are different answers.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"406":{"$ref":"#/components/responses/FhirNotAcceptable"},"413":{"description":"The request body is over 1 MiB, the most this base reads from one request. Send a large batch as several smaller ones.","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"},"422":{"description":"The request is well formed, but this service does not answer it in that form: an operation it does not offer for a code system it holds, or the expansion of a value set defined by a rule too large to list, the whole of LOINC included. The `OperationOutcome` says which, and what to ask instead.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"502":{"description":"The code system's source could not be reached: an upstream terminology server, or the local store for a code system this service holds.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"No source is configured for this code system on this deployment, no release has been published to it, or its source is rate limiting requests (with `Retry-After`). The service returns no answer rather than guessing one. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The code system's source did not respond in time.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}},"operationId":"codeSystemLookupPost","requestBody":{"required":true,"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"},"examples":{"A LOINC code's short name":{"summary":"A LOINC code's short name","value":{"resourceType":"Parameters","parameter":[{"name":"system","valueUri":"http://loinc.org"},{"name":"code","valueCode":"2345-7"},{"name":"property","valueCode":"SHORTNAME"}]}}}}}},"parameters":[{"$ref":"#/components/parameters/XRequestId"}]}},"/v1/fhir/r4/CodeSystem/$validate-code":{"get":{"tags":["Terminology"],"summary":"Validate a code in a code system","description":"FHIR `CodeSystem/$validate-code`. Asks whether a code exists in a code system. The ValueSet operation of the same name asks about membership of a particular set instead. On POST, a `coding` or `codeableConcept` parameter may stand in for `url` + `code`; a codeableConcept validates if any of its codings does.","responses":{"200":{"description":"A FHIR `Parameters` resource carrying `result`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"},"examples":{"Is this a LOINC code?":{"summary":"Is this a LOINC code?","value":{"resourceType":"Parameters","parameter":[{"name":"result","valueString":"true"},{"name":"code","valueString":"2345-7"},{"name":"display","valueString":"Glucose [Mass/volume] in Serum or Plasma"},{"name":"active","valueBoolean":true},{"name":"system","valueString":"http://loinc.org"},{"name":"version","valueString":"2.83"}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"Invalid request: a parameter is not valid, is not one this operation takes, or was sent more than once (only `property` on `$lookup` repeats). The `OperationOutcome` names each one.","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"},"404":{"description":"The code system is not served here, or the code was not found. The `OperationOutcome` says which, and why: an unrecognised system, a system we are not licensed to serve, and a genuinely missing code are different answers.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"406":{"$ref":"#/components/responses/FhirNotAcceptable"},"422":{"description":"The request is well formed, but this service does not answer it in that form: an operation it does not offer for a code system it holds, or the expansion of a value set defined by a rule too large to list, the whole of LOINC included. The `OperationOutcome` says which, and what to ask instead.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"502":{"description":"The code system's source could not be reached: an upstream terminology server, or the local store for a code system this service holds.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"No source is configured for this code system on this deployment, no release has been published to it, or its source is rate limiting requests (with `Retry-After`). The service returns no answer rather than guessing one. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The code system's source did not respond in time.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}},"operationId":"codeSystemValidateCode","parameters":[{"name":"url","in":"query","required":false,"description":"Canonical URL of the **code system**. Defaults to LOINC (`http://loinc.org`).","schema":{"default":"http://loinc.org","type":"string","minLength":1},"example":"http://loinc.org"},{"name":"code","in":"query","required":true,"description":"The code to validate.","schema":{"type":"string","minLength":1},"example":"2345-7"},{"name":"version","in":"query","required":false,"description":"Optional code system version.","schema":{"type":"string","minLength":1}},{"name":"display","in":"query","required":false,"description":"Optional display to check against the code's own display. A mismatch returns `result: false` with the expected display alongside, which means the code is valid and only the label differs. Do not read that as an invalid code.","schema":{"type":"string","minLength":1}},{"name":"displayLanguage","in":"query","required":false,"description":"Language to use when checking the display.","schema":{"type":"string","minLength":1}},{"name":"date","in":"query","required":false,"description":"The date for which the validation should be valid.","schema":{"type":"string","minLength":1}},{"$ref":"#/components/parameters/XRequestId"}]},"post":{"tags":["Terminology"],"summary":"Validate a code in a code system","description":"FHIR `CodeSystem/$validate-code`. Asks whether a code exists in a code system. The ValueSet operation of the same name asks about membership of a particular set instead. On POST, a `coding` or `codeableConcept` parameter may stand in for `url` + `code`; a codeableConcept validates if any of its codings does.","responses":{"200":{"description":"A FHIR `Parameters` resource carrying `result`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"},"examples":{"Is this a LOINC code?":{"summary":"Is this a LOINC code?","value":{"resourceType":"Parameters","parameter":[{"name":"result","valueString":"true"},{"name":"code","valueString":"2345-7"},{"name":"display","valueString":"Glucose [Mass/volume] in Serum or Plasma"},{"name":"active","valueBoolean":true},{"name":"system","valueString":"http://loinc.org"},{"name":"version","valueString":"2.83"}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"Invalid request: a parameter is not valid, is not one this operation takes, or was sent more than once (only `property` on `$lookup` repeats). The `OperationOutcome` names each one.","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"},"404":{"description":"The code system is not served here, or the code was not found. The `OperationOutcome` says which, and why: an unrecognised system, a system we are not licensed to serve, and a genuinely missing code are different answers.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"406":{"$ref":"#/components/responses/FhirNotAcceptable"},"413":{"description":"The request body is over 1 MiB, the most this base reads from one request. Send a large batch as several smaller ones.","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"},"422":{"description":"The request is well formed, but this service does not answer it in that form: an operation it does not offer for a code system it holds, or the expansion of a value set defined by a rule too large to list, the whole of LOINC included. The `OperationOutcome` says which, and what to ask instead.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"502":{"description":"The code system's source could not be reached: an upstream terminology server, or the local store for a code system this service holds.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"No source is configured for this code system on this deployment, no release has been published to it, or its source is rate limiting requests (with `Retry-After`). The service returns no answer rather than guessing one. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The code system's source did not respond in time.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}},"operationId":"codeSystemValidateCodePost","requestBody":{"required":true,"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"},"examples":{"Is this a LOINC code?":{"summary":"Is this a LOINC code?","value":{"resourceType":"Parameters","parameter":[{"name":"url","valueUri":"http://loinc.org"},{"name":"code","valueCode":"2345-7"}]}}}}}},"parameters":[{"$ref":"#/components/parameters/XRequestId"}]}},"/v1/fhir/r4/ValueSet/$expand":{"get":{"tags":["Terminology"],"summary":"Expand a value set","description":"FHIR `ValueSet/$expand`. Expands a value set canonical to its member codes, with an optional text filter and paging (`count=0` returns the total only).","responses":{"200":{"description":"A FHIR `ValueSet` carrying an `expansion`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/ValueSet"},"examples":{"A LOINC answer list's codes":{"summary":"A LOINC answer list's codes","value":{"resourceType":"ValueSet","id":"dc064ed9-6a62-48c7-b039-bea72c5348c3","url":"http://loinc.org/vs/LL360-9","identifier":[{"system":"urn:ietf:rfc:3986","value":"urn:oid:1.3.6.1.4.1.12009.10.1.2247"}],"version":"2.83","name":"Pos|Neg","status":"active","publisher":"Regenstrief Institute, Inc.","contact":[{"name":"Regenstrief Institute, Inc.","telecom":[{"system":"url","value":"http://loinc.org"}]}],"copyright":"This material contains content from LOINC (http://loinc.org). LOINC is copyright Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license at http://loinc.org/license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc.","expansion":{"id":"0e3930d7-e98e-4552-b45b-5760ed56409b","identifier":"b4efb9d1-77f2-4bed-babe-3384083fc113","timestamp":"2026-10-18T16:32:16+00:00","total":2,"offset":0,"parameter":[{"name":"offset","valueInteger":0},{"name":"count","valueInteger":100}],"contains":[{"system":"http://loinc.org","code":"LA6577-6","display":"Negative"},{"system":"http://loinc.org","code":"LA6576-8","display":"Positive"}]}}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"Invalid request: a parameter is not valid, is not one this operation takes, or was sent more than once (only `property` on `$lookup` repeats). The `OperationOutcome` names each one.","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"},"404":{"description":"The code system is not served here, or the code was not found. The `OperationOutcome` says which, and why: an unrecognised system, a system we are not licensed to serve, and a genuinely missing code are different answers.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"406":{"$ref":"#/components/responses/FhirNotAcceptable"},"422":{"description":"The request is well formed, but this service does not answer it in that form: an operation it does not offer for a code system it holds, or the expansion of a value set defined by a rule too large to list, the whole of LOINC included. The `OperationOutcome` says which, and what to ask instead.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"502":{"description":"The code system's source could not be reached: an upstream terminology server, or the local store for a code system this service holds.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"No source is configured for this code system on this deployment, no release has been published to it, or its source is rate limiting requests (with `Retry-After`). The service returns no answer rather than guessing one. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The code system's source did not respond in time.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}},"operationId":"valueSetExpand","parameters":[{"name":"url","in":"query","required":false,"description":"Canonical URL of the value set to expand. Defaults to the implicit all-LOINC value set (`http://loinc.org?fhir_vs`), which is every LOINC code. That expansion is not served and answers `422`: expand a LOINC group or answer list instead, or ask `$validate-code` whether a code is in LOINC.","schema":{"default":"http://loinc.org?fhir_vs","type":"string","minLength":1},"example":"http://loinc.org/vs/LL360-9"},{"name":"filter","in":"query","required":false,"description":"Text filter to narrow the expansion to matching concepts. Applies to value sets this service hosts. For a value set resolved from its own source, narrowing is refused with a `400` naming this parameter, because that source answers a whole expansion or nothing: expand it whole and filter the result.","schema":{"type":"string","minLength":1}},{"name":"count","in":"query","required":false,"description":"Maximum number of concepts to return (`0` returns the total only). Applies to value sets this service hosts. For a value set resolved from its own source, narrowing is refused with a `400` naming this parameter, because that source answers a whole expansion or nothing: expand it whole and filter the result.","schema":{"type":"integer","minimum":0,"maximum":1000}},{"name":"offset","in":"query","required":false,"description":"Number of concepts to skip for pagination. Applies to value sets this service hosts. For a value set resolved from its own source, narrowing is refused with a `400` naming this parameter, because that source answers a whole expansion or nothing: expand it whole and filter the result.","schema":{"type":"integer","minimum":0,"maximum":9007199254740991}},{"name":"displayLanguage","in":"query","required":false,"description":"Not supported on this operation, and refused with a `400` naming it. Expansions are returned whole, in their source's own language and order.","schema":{"type":"string","minLength":1}},{"name":"includeDesignations","in":"query","required":false,"description":"Not supported on this operation, and refused with a `400` naming it. Expansions are returned whole.","schema":{"type":"boolean"}},{"name":"activeOnly","in":"query","required":false,"description":"Not supported on this operation, and refused with a `400` naming it. Expansions are returned whole.","schema":{"type":"boolean"}},{"$ref":"#/components/parameters/XRequestId"}]},"post":{"tags":["Terminology"],"summary":"Expand a value set","description":"FHIR `ValueSet/$expand`. Expands a value set canonical to its member codes, with an optional text filter and paging (`count=0` returns the total only).","responses":{"200":{"description":"A FHIR `ValueSet` carrying an `expansion`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/ValueSet"},"examples":{"A LOINC answer list's codes":{"summary":"A LOINC answer list's codes","value":{"resourceType":"ValueSet","id":"dc064ed9-6a62-48c7-b039-bea72c5348c3","url":"http://loinc.org/vs/LL360-9","identifier":[{"system":"urn:ietf:rfc:3986","value":"urn:oid:1.3.6.1.4.1.12009.10.1.2247"}],"version":"2.83","name":"Pos|Neg","status":"active","publisher":"Regenstrief Institute, Inc.","contact":[{"name":"Regenstrief Institute, Inc.","telecom":[{"system":"url","value":"http://loinc.org"}]}],"copyright":"This material contains content from LOINC (http://loinc.org). LOINC is copyright Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license at http://loinc.org/license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc.","expansion":{"id":"0e3930d7-e98e-4552-b45b-5760ed56409b","identifier":"b4efb9d1-77f2-4bed-babe-3384083fc113","timestamp":"2026-10-18T16:32:16+00:00","total":2,"offset":0,"parameter":[{"name":"offset","valueInteger":0},{"name":"count","valueInteger":100}],"contains":[{"system":"http://loinc.org","code":"LA6577-6","display":"Negative"},{"system":"http://loinc.org","code":"LA6576-8","display":"Positive"}]}}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"Invalid request: a parameter is not valid, is not one this operation takes, or was sent more than once (only `property` on `$lookup` repeats). The `OperationOutcome` names each one.","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"},"404":{"description":"The code system is not served here, or the code was not found. The `OperationOutcome` says which, and why: an unrecognised system, a system we are not licensed to serve, and a genuinely missing code are different answers.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"406":{"$ref":"#/components/responses/FhirNotAcceptable"},"413":{"description":"The request body is over 1 MiB, the most this base reads from one request. Send a large batch as several smaller ones.","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"},"422":{"description":"The request is well formed, but this service does not answer it in that form: an operation it does not offer for a code system it holds, or the expansion of a value set defined by a rule too large to list, the whole of LOINC included. The `OperationOutcome` says which, and what to ask instead.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"502":{"description":"The code system's source could not be reached: an upstream terminology server, or the local store for a code system this service holds.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"No source is configured for this code system on this deployment, no release has been published to it, or its source is rate limiting requests (with `Retry-After`). The service returns no answer rather than guessing one. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The code system's source did not respond in time.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}},"operationId":"valueSetExpandPost","requestBody":{"required":true,"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"},"examples":{"A LOINC answer list's codes":{"summary":"A LOINC answer list's codes","value":{"resourceType":"Parameters","parameter":[{"name":"url","valueUri":"http://loinc.org/vs/LL360-9"}]}}}}}},"parameters":[{"$ref":"#/components/parameters/XRequestId"}]}},"/v1/fhir/r4/ValueSet/$validate-code":{"get":{"tags":["Terminology"],"summary":"Validate a code against a value set","description":"FHIR `ValueSet/$validate-code`. A code that is not in the set is a successful `200` with `result: false`, not an error. On POST, a `coding` or `codeableConcept` parameter may stand in for `system` + `code`; a codeableConcept validates if any of its codings is in the set, which helps when an element carries a vendor-local coding alongside a standard one.","responses":{"200":{"description":"A FHIR `Parameters` resource carrying `result`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"},"examples":{"Is this code a vital sign?":{"summary":"Is this code a vital sign?","value":{"resourceType":"Parameters","parameter":[{"name":"result","valueBoolean":true},{"name":"copyright","valueString":"This content from LOINC® is copyright © 1995 Regenstrief Institute, Inc. and the LOINC Committee, and available at no cost under the license at http://loinc.org/terms-of-use"}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"Invalid request: a parameter is not valid, is not one this operation takes, or was sent more than once (only `property` on `$lookup` repeats). The `OperationOutcome` names each one.","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"},"404":{"description":"The code system is not served here, or the code was not found. The `OperationOutcome` says which, and why: an unrecognised system, a system we are not licensed to serve, and a genuinely missing code are different answers.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"406":{"$ref":"#/components/responses/FhirNotAcceptable"},"422":{"description":"The request is well formed, but this service does not answer it in that form: an operation it does not offer for a code system it holds, or the expansion of a value set defined by a rule too large to list, the whole of LOINC included. The `OperationOutcome` says which, and what to ask instead.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"502":{"description":"The code system's source could not be reached: an upstream terminology server, or the local store for a code system this service holds.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"No source is configured for this code system on this deployment, no release has been published to it, or its source is rate limiting requests (with `Retry-After`). The service returns no answer rather than guessing one. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The code system's source did not respond in time.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}},"operationId":"valueSetValidateCode","parameters":[{"name":"url","in":"query","required":false,"description":"Canonical URL of the value set to validate against. Defaults to the implicit all-LOINC value set (`http://loinc.org?fhir_vs`), which is every LOINC code.","schema":{"default":"http://loinc.org?fhir_vs","type":"string","minLength":1},"example":"http://hl7.org/fhir/ValueSet/observation-vitalsignresult"},{"name":"code","in":"query","required":true,"description":"The code to validate.","schema":{"type":"string","minLength":1},"example":"8867-4"},{"name":"system","in":"query","required":false,"description":"Code system URI of the code. Defaults to LOINC (`http://loinc.org`).","schema":{"default":"http://loinc.org","type":"string","minLength":1},"example":"http://loinc.org"},{"name":"display","in":"query","required":false,"description":"Optional display to check against the code's own display. A mismatch returns `result: false` with the expected display alongside, which means the code is valid and only the label differs. Do not read that as an invalid code.","schema":{"type":"string","minLength":1}},{"name":"displayLanguage","in":"query","required":false,"description":"Language to use when checking the display.","schema":{"type":"string","minLength":1}},{"name":"date","in":"query","required":false,"description":"The date for which the validation should be valid.","schema":{"type":"string","minLength":1}},{"$ref":"#/components/parameters/XRequestId"}]},"post":{"tags":["Terminology"],"summary":"Validate a code against a value set","description":"FHIR `ValueSet/$validate-code`. A code that is not in the set is a successful `200` with `result: false`, not an error. On POST, a `coding` or `codeableConcept` parameter may stand in for `system` + `code`; a codeableConcept validates if any of its codings is in the set, which helps when an element carries a vendor-local coding alongside a standard one.","responses":{"200":{"description":"A FHIR `Parameters` resource carrying `result`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"},"examples":{"Is this code a vital sign?":{"summary":"Is this code a vital sign?","value":{"resourceType":"Parameters","parameter":[{"name":"result","valueBoolean":true},{"name":"copyright","valueString":"This content from LOINC® is copyright © 1995 Regenstrief Institute, Inc. and the LOINC Committee, and available at no cost under the license at http://loinc.org/terms-of-use"}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"Invalid request: a parameter is not valid, is not one this operation takes, or was sent more than once (only `property` on `$lookup` repeats). The `OperationOutcome` names each one.","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"},"404":{"description":"The code system is not served here, or the code was not found. The `OperationOutcome` says which, and why: an unrecognised system, a system we are not licensed to serve, and a genuinely missing code are different answers.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"406":{"$ref":"#/components/responses/FhirNotAcceptable"},"413":{"description":"The request body is over 1 MiB, the most this base reads from one request. Send a large batch as several smaller ones.","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"},"422":{"description":"The request is well formed, but this service does not answer it in that form: an operation it does not offer for a code system it holds, or the expansion of a value set defined by a rule too large to list, the whole of LOINC included. The `OperationOutcome` says which, and what to ask instead.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"502":{"description":"The code system's source could not be reached: an upstream terminology server, or the local store for a code system this service holds.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"No source is configured for this code system on this deployment, no release has been published to it, or its source is rate limiting requests (with `Retry-After`). The service returns no answer rather than guessing one. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The code system's source did not respond in time.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}},"operationId":"valueSetValidateCodePost","requestBody":{"required":true,"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"},"examples":{"Is this code a vital sign?":{"summary":"Is this code a vital sign?","value":{"resourceType":"Parameters","parameter":[{"name":"url","valueUri":"http://hl7.org/fhir/ValueSet/observation-vitalsignresult"},{"name":"coding","valueCoding":{"system":"http://loinc.org","code":"8867-4"}}]}}}}}},"parameters":[{"$ref":"#/components/parameters/XRequestId"}]}},"/v1/fhir/r4/Practitioner":{"get":{"tags":["Provider directory"],"summary":"Find a practitioner by NPI or name","description":"Search `Practitioner` by `identifier` to resolve an NPI you already hold, or by name to find someone. A search needs one or the other (or an `_id`): `address-city`, `address-state` and `active` narrow a search but cannot stand alone. Specialties are searched on `PractitionerRole`.\n\nThree identifier systems are accepted, `http://terminology.hl7.org/NamingSystem/npi`, `http://hl7.org/fhir/sid/us-npi` and `urn:oid:2.16.840.1.113883.4.6`, as well as a bare 10-digit value. All of them resolve the same provider. **Responses carry the directory's own system, `http://hl7.org/fhir/sid/us-npi`**, which may differ from the one you sent. Any other identifier system is refused by name: a system the directory does not index would answer with an empty result, which reads as 'no such provider'.\n\nOne NPI per search. To resolve several, POST a batch `Bundle` with one entry each.","operationId":"searchPractitioner","parameters":[{"name":"identifier","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":256},"description":"An NPI, as `{system}|{npi}` or a bare 10-digit value. Accepted systems: http://terminology.hl7.org/NamingSystem/npi, http://hl7.org/fhir/sid/us-npi, urn:oid:2.16.840.1.113883.4.6. All of them resolve the same provider. Responses carry the directory's own system, `http://hl7.org/fhir/sid/us-npi`, which may differ from the one you sent. One NPI per search; use a batch Bundle to resolve several. Any other identifier system is refused by name rather than searched, because a system the source does not index would answer with an empty result that reads as 'no such provider'.","example":"1093209884"},{"name":"name","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":100},"description":"Matches across the whole name."},{"name":"family","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":100},"description":"The family name."},{"name":"given","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":100},"description":"A given name."},{"name":"address-city","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":100},"description":"Narrows a search by city; cannot be used on its own. Matches any of the practitioner's addresses, so a result can still list addresses in another city."},{"name":"address-state","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":50},"description":"Narrows a search by state; cannot be used on its own. Matches any of the practitioner's addresses, so a result can still list addresses in another state."},{"name":"active","in":"query","required":false,"schema":{"type":"string","enum":["true","false"]},"description":"`true` or `false`. Narrows a search; cannot be used on its own."},{"name":"_revinclude","in":"query","required":false,"schema":{"minItems":1,"maxItems":16,"type":"array","items":{"type":"string","enum":["PractitionerRole:practitioner"]}},"style":"form","explode":true,"description":"`PractitionerRole:practitioner` brings the practitioner's roles into the same bundle. Repeat the parameter to include several. Included entries do not count toward `_count`. The directory returns at most 100 included records per page; a page with more is refused with a 502 rather than served short."},{"name":"_id","in":"query","required":false,"schema":{"type":"string","pattern":"^[A-Za-z0-9\\-.]{1,64}$"},"description":"A Practitioner id. Searching by id rather than reading it lets one request also bring the records an `_include` or `_revinclude` names."},{"name":"_summary","in":"query","required":false,"schema":{"type":"string","enum":["count"]},"description":"`count` only: answers how many records match, as `total`, with no entries. Cannot be combined with `_include`, `_revinclude`, `_count` or `page`."},{"name":"_count","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"Results are paged. `_count` sets the page size (1 to 100); a larger value is refused rather than quietly reduced. Follow `link` with relation `next` to continue. The cursor it carries is opaque and must not be constructed or modified."},{"name":"page","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":8192},"description":"Continuation cursor. Opaque: follow the `next` link from a previous response, and never construct or modify it. Cursors expire."},{"$ref":"#/components/parameters/XRequestId"}],"responses":{"200":{"description":"A FHIR `Bundle` with `type: searchset`. Entries carry `fullUrl`s and `link`s on this service. `total` is present when the directory sends one, and is never computed here.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Bundle"},"examples":{"A practitioner by NPI":{"summary":"A practitioner by NPI","value":{"resourceType":"Bundle","type":"searchset","link":[{"relation":"self","url":"https://api.haau3.com/v1/fhir/r4/Practitioner?identifier=1093209884"}],"entry":[{"fullUrl":"https://api.haau3.com/v1/fhir/r4/Practitioner/Practitioner-1093209884","resource":{"resourceType":"Practitioner","id":"Practitioner-1093209884","meta":{"versionId":"1","lastUpdated":"2026-10-14T19:24:16.999300087Z","profile":["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Practitioner"]},"extension":[{"url":"https://directory.cms.gov/fhir/StructureDefinition/base-ext-cms-identity-verified","valueBoolean":false},{"url":"https://directory.cms.gov/fhir/StructureDefinition/base-ext-cms_medicare_enrollment","valueBoolean":true},{"url":"https://directory.cms.gov/fhir/StructureDefinition/base-ext-hhs-in-exclusion-list","valueBoolean":false},{"url":"https://directory.cms.gov/fhir/StructureDefinition/base-ext-cms_aligned_with_data_network","valueBoolean":true}],"identifier":[{"use":"official","type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0203","code":"PRN","display":"Provider number"}],"text":"NPI"},"system":"http://hl7.org/fhir/sid/us-npi","value":"1093209884","period":{"start":"2018-06-15T00:00:00Z"}}],"active":true,"name":[{"use":"official","family":"LEREW","given":["JAISHREE"]},{"use":"usual","family":"PALANISAMY","given":["JAISHREE","CHANDRAN"],"period":{"start":"2023-05-01T00:00:00Z"}},{"use":"official","family":"LEREW","given":["JAISHREE","PALANISAMY"]}],"telecom":[{"system":"phone","value":"2483385392","use":"work"},{"system":"phone","value":"6053287595","use":"work"},{"system":"phone","value":"6053288200","use":"work"},{"system":"phone","value":"6053289000","use":"work"},{"system":"phone","value":"6053289419","use":"work"},{"system":"phone","value":"6053331000","use":"work"},{"system":"phone","value":"6059955635","use":"work"}],"address":[{"use":"work","type":"physical","line":["1305 W 18th St"],"city":"Sioux Falls","state":"SD","postalCode":"57105","country":"US"},{"use":"work","type":"physical","line":["1310 W 22nd St"],"city":"Sioux Falls","state":"SD","postalCode":"57105","country":"US"},{"use":"work","type":"physical","line":["4405 E 26th St"],"city":"Sioux Falls","state":"SD","postalCode":"57103","country":"US"},{"use":"work","type":"physical","line":["525 N Foster St"],"city":"Mitchell","state":"SD","postalCode":"57301","country":"US"}],"gender":"female","qualification":[{"code":{"coding":[{"system":"http://nucc.org/provider-taxonomy","code":"207Y00000X","display":"Otolaryngology Physician"}],"text":"Otolaryngology Physician"}},{"identifier":[{"use":"official","type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0203","code":"MD","display":"Medical license number"}]},"value":"5101024069"}],"code":{"coding":[{"system":"http://nucc.org/provider-taxonomy","code":"207Y00000X","display":"Otolaryngology Physician"}]},"issuer":{"reference":"Organization/Organization-State-MI"}},{"identifier":[{"use":"official","type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0203","code":"MD","display":"Medical license number"}]},"value":"15452"}],"code":{"coding":[{"system":"http://nucc.org/provider-taxonomy","code":"207Y00000X","display":"Otolaryngology Physician"}]},"issuer":{"reference":"Organization/Organization-State-SD"}},{"code":{"coding":[{"system":"http://hl7.org/fhir/us/ndh/CodeSystem/FaCeT-credentialCS","code":"DO","display":"Doctor of Osteopathy"}]}},{"code":{"coding":[{"system":"http://hl7.org/fhir/us/ndh/CodeSystem/FaCeT-credentialCS","code":"MD","display":"Doctor of Medicine"}]}}]},"search":{"mode":"match"}}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"The request named a parameter, identifier system or value this service does not serve. Every unsupported parameter is refused by name, and none is silently ignored, so a search that returns results applied every filter you 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"},"404":{"description":"No such resource, or no such interaction on this base.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"406":{"$ref":"#/components/responses/FhirNotAcceptable"},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"502":{"description":"The directory could not be reached, answered in a shape that cannot be served, or answered with more than is served at once: a `_revinclude` past the directory's 100 records on a page, or an answer over 8 MiB. No answer is given: this is never reported as an empty result, which would read as 'no such provider'.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"The directory is rate limiting requests. Send the request again after `Retry-After`. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The directory did not respond in time.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}}}},"/v1/fhir/r4/Practitioner/{id}":{"get":{"tags":["Provider directory"],"summary":"Read a Practitioner","description":"Read one practitioner by id, as returned by a search on this service.","operationId":"readPractitioner","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9\\-.]{1,64}$"},"description":"The resource id, as returned by a search on this service. Ids are opaque: they are not constructed from an NPI or any other identifier.","example":"Practitioner-1093209884"},{"$ref":"#/components/parameters/XRequestId"}],"responses":{"200":{"description":"The Practitioner, as the directory publishes it.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Practitioner"},"examples":{"A practitioner":{"summary":"A practitioner","value":{"resourceType":"Practitioner","id":"Practitioner-1093209884","meta":{"lastUpdated":"2026-10-14T19:24:16.999300087Z","profile":["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Practitioner"],"versionId":"1"},"extension":[{"url":"https://directory.cms.gov/fhir/StructureDefinition/base-ext-cms-identity-verified","valueBoolean":false},{"url":"https://directory.cms.gov/fhir/StructureDefinition/base-ext-cms_medicare_enrollment","valueBoolean":true},{"url":"https://directory.cms.gov/fhir/StructureDefinition/base-ext-hhs-in-exclusion-list","valueBoolean":false},{"url":"https://directory.cms.gov/fhir/StructureDefinition/base-ext-cms_aligned_with_data_network","valueBoolean":true}],"identifier":[{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0203","code":"PRN","display":"Provider number"}],"text":"NPI"},"system":"http://hl7.org/fhir/sid/us-npi","use":"official","value":"1093209884","period":{"start":"2018-06-15T00:00:00Z"}}],"active":true,"name":[{"given":["JAISHREE"],"family":"LEREW","use":"official"},{"given":["JAISHREE","CHANDRAN"],"family":"PALANISAMY","use":"usual","period":{"start":"2023-05-01T00:00:00Z"}},{"given":["JAISHREE","PALANISAMY"],"family":"LEREW","use":"official"}],"telecom":[{"system":"phone","value":"2483385392","use":"work"},{"system":"phone","value":"6053287595","use":"work"},{"system":"phone","value":"6053288200","use":"work"},{"system":"phone","value":"6053289000","use":"work"},{"system":"phone","value":"6053289419","use":"work"},{"system":"phone","value":"6053331000","use":"work"},{"system":"phone","value":"6059955635","use":"work"}],"address":[{"line":["1305 W 18th St"],"city":"Sioux Falls","state":"SD","postalCode":"57105","country":"US","type":"physical","use":"work"},{"line":["1310 W 22nd St"],"city":"Sioux Falls","state":"SD","postalCode":"57105","country":"US","type":"physical","use":"work"},{"line":["4405 E 26th St"],"city":"Sioux Falls","state":"SD","postalCode":"57103","country":"US","type":"physical","use":"work"},{"line":["525 N Foster St"],"city":"Mitchell","state":"SD","postalCode":"57301","country":"US","type":"physical","use":"work"}],"gender":"female","qualification":[{"code":{"coding":[{"system":"http://nucc.org/provider-taxonomy","code":"207Y00000X","display":"Otolaryngology Physician"}],"text":"Otolaryngology Physician"}},{"code":{"coding":[{"system":"http://nucc.org/provider-taxonomy","code":"207Y00000X","display":"Otolaryngology Physician"}]},"issuer":{"reference":"Organization/Organization-State-MI"},"identifier":[{"use":"official","type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0203","code":"MD","display":"Medical license number"}]},"value":"5101024069"}]},{"code":{"coding":[{"system":"http://nucc.org/provider-taxonomy","code":"207Y00000X","display":"Otolaryngology Physician"}]},"issuer":{"reference":"Organization/Organization-State-SD"},"identifier":[{"use":"official","type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0203","code":"MD","display":"Medical license number"}]},"value":"15452"}]},{"code":{"coding":[{"system":"http://hl7.org/fhir/us/ndh/CodeSystem/FaCeT-credentialCS","code":"DO","display":"Doctor of Osteopathy"}]}},{"code":{"coding":[{"system":"http://hl7.org/fhir/us/ndh/CodeSystem/FaCeT-credentialCS","code":"MD","display":"Doctor of Medicine"}]}}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"The id is not a valid FHIR id, or a query parameter was sent: a read takes none. Ids come from search results; they are not constructed from an NPI or any other identifier.","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"},"404":{"description":"No such resource, or no such interaction on this base.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"406":{"$ref":"#/components/responses/FhirNotAcceptable"},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"502":{"description":"The directory could not be reached, answered in a shape that cannot be served, or answered with more than is served at once: a `_revinclude` past the directory's 100 records on a page, or an answer over 8 MiB. No answer is given: this is never reported as an empty result, which would read as 'no such provider'.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"The directory is rate limiting requests. Send the request again after `Retry-After`. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The directory did not respond in time.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}}}},"/v1/fhir/r4/PractitionerRole":{"get":{"tags":["Provider directory"],"summary":"Find practitioner roles","description":"Search `PractitionerRole`: the organizations, specialties, locations and networks practitioners are associated with. A search names a practitioner, an organization, a location or an endpoint; `specialty` (NUCC), `new-patient` and `active` narrow it.\n\n`network` and `new-patient-from-network` follow the directory's own rule: each needs a practitioner, organization, location or specialty beside it, and a search without one is refused before the directory is asked. A network search beside a practitioner or an organization answers in under a second; beside a specialty or a busy location the directory can take 10 to 15 seconds. The directory's network data is sparse, so a role a network's records do not list is not shown to be out of network.\n\n`identifier` is not offered because the directory does not carry identifiers on these resources.","operationId":"searchPractitionerRole","parameters":[{"name":"practitioner","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":256},"description":"The roles one practitioner holds. Give a Practitioner id, `Practitioner/{id}`, or the `fullUrl` this service returned. An address on another server is refused.","example":"Practitioner-1093209884"},{"name":"organization","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":256},"description":"The roles held at one organization. Give a Organization id, `Organization/{id}`, or the `fullUrl` this service returned. An address on another server is refused."},{"name":"location","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":256},"description":"The roles held at one location. Give a Location id, `Location/{id}`, or the `fullUrl` this service returned. An address on another server is refused."},{"name":"endpoint","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":256},"description":"The roles reached through one endpoint. Give a Endpoint id, `Endpoint/{id}`, or the `fullUrl` this service returned. An address on another server is refused."},{"name":"specialty","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":256},"description":"A NUCC Health Care Provider Taxonomy code, bare or as `http://nucc.org/provider-taxonomy|{code}` (for example `207RC0000X`, cardiovascular disease). Any other system is refused, because the directory codes specialties in NUCC alone and would answer another system with nothing. Narrows a search; cannot be used on its own."},{"name":"network","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":256},"description":"The roles the directory lists in one insurance network (an Organization of type `ntwk`). Cannot be used on its own: send it beside `practitioner`, `organization`, `location` or `specialty`. A search that breaks this rule is refused before the directory is asked. Beside a specialty or a busy location the directory can take 10 to 15 seconds. A role the network's records do not list is not shown to be out of network: the directory's network data is sparse. Give a Organization id, `Organization/{id}`, or the `fullUrl` this service returned. An address on another server is refused."},{"name":"new-patient-from-network","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":256},"description":"The roles accepting new patients from one insurance network. Cannot be used on its own: send it beside `practitioner`, `organization`, `location` or `specialty`. A search that breaks this rule is refused before the directory is asked. Give a Organization id, `Organization/{id}`, or the `fullUrl` this service returned. An address on another server is refused."},{"name":"new-patient","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":256},"description":"Whether the role accepts new patients: `newpt`, `nopt`, `existptonly` or `existptfam`, bare or under `http://terminology.hl7.org/CodeSystem/accepting-patients`. Narrows a search; cannot be used on its own."},{"name":"active","in":"query","required":false,"schema":{"type":"string","enum":["true","false"]},"description":"`true` or `false`. Narrows a search; cannot be used on its own."},{"name":"_include","in":"query","required":false,"schema":{"minItems":1,"maxItems":16,"type":"array","items":{"type":"string","enum":["PractitionerRole:practitioner","PractitionerRole:organization","PractitionerRole:location","PractitionerRole:network","PractitionerRole:endpoint"]}},"style":"form","explode":true,"description":"Bring the records a role points to into the same bundle: `PractitionerRole:practitioner`, `PractitionerRole:organization`, `PractitionerRole:location`, `PractitionerRole:network` or `PractitionerRole:endpoint`. Repeat the parameter to include several. Included entries do not count toward `_count`."},{"name":"_id","in":"query","required":false,"schema":{"type":"string","pattern":"^[A-Za-z0-9\\-.]{1,64}$"},"description":"A PractitionerRole id. Searching by id rather than reading it lets one request also bring the records an `_include` or `_revinclude` names."},{"name":"_summary","in":"query","required":false,"schema":{"type":"string","enum":["count"]},"description":"`count` only: answers how many records match, as `total`, with no entries. Cannot be combined with `_include`, `_revinclude`, `_count` or `page`."},{"name":"_count","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"Results are paged. `_count` sets the page size (1 to 100); a larger value is refused rather than quietly reduced. Follow `link` with relation `next` to continue. The cursor it carries is opaque and must not be constructed or modified.","example":2},{"name":"page","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":8192},"description":"Continuation cursor. Opaque: follow the `next` link from a previous response, and never construct or modify it. Cursors expire."},{"$ref":"#/components/parameters/XRequestId"}],"responses":{"200":{"description":"A FHIR `Bundle` with `type: searchset`. `total` is present when the directory sends one.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Bundle"},"examples":{"A practitioner's roles":{"summary":"A practitioner's roles","value":{"resourceType":"Bundle","type":"searchset","link":[{"relation":"self","url":"https://api.haau3.com/v1/fhir/r4/PractitionerRole?practitioner=Practitioner-1093209884&_count=2"},{"relation":"next","url":"https://api.haau3.com/v1/fhir/r4/PractitionerRole?practitioner=Practitioner-1093209884&_count=2&page=AAMA-EFRSURBSGd2bzlHTkh2NkZNeXNGMkNKelNQaUp6aCtWTXNCNXh6R0owVG0xQ1RtRzZRSHhvWlEzNFJSWHQza0tnaEdWM0haYUFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTWFORzVkbjloMHNFMSsrNm5BZ0VRZ0Rzb3kzRTBRczhLbmFocjhwN01lWktWWDZkcXJhNFZLdXI4Z0xHTXN6M1lCRDY0Tk93SjZSMCtqSlc3RDZxSDlBaEhzL0Nwc3JlR3ZGaVBxZz09f_DsjRpKEixXbrlvCvUC7gZLCZZmP--xZPgTrdKMf2PmkUIG_P9qov8JINwWhj7TWPOMyo_Q2djzvPN1pTlAC2FhzC6QPk_co8qGuEKM7s08xE7hT4GPMHM_DRnijBykV4A-Jkezg7xMdJwzw1s9ccQKv5-On-DN-RxdGnJbSOwv1r5YGz-YD7lN-K37bVwGeL7yGdK9-UObPc5emRevcRgzsZ7RX0krSCjv_LoddGitY_QLBN0lpYvy373aeipj7FzudYhmJ-9Ti1xzbVwKr2GI-0OkI3Mupv8mjt-bAt6p42BoxIzs0N3j3IdS5_r-zs6wJRNhs76IrmWy5qeSW4M8zB-_jVyzM0d67gVc7Z93smouP8lX5vDkeFPsoUbiFl57eKo5pFsOQ5Y1WALdFBJBPhNubRAS8oME3VxpMgs2Pi9ZQfuxJHyFe7RG4uEWwe5uJ9AGc1XbWeUJhlrUVbfN4QIVIg0cTi4h48yLKWaRak049q9q3fOmrIZOCqTZNmKXzxw5mNseSGEQ51ys78pBZCmY03gUlLV_hDdSy9xbDzmloslxEK9ZVzf8H0KJnbNArGXPs5lMSotAvCh00dGwfOWaquzN44cuUS5_OO-Wr8HgjDHNPdRkTqL_uVT_-5KBA9P9GZc3wfZQRoXKeP9aky2HGzkpxVblIj0ztGxd-cJvy-JXOSRctP7Q_tFpEuRnmhpkgoj2LDFiNI611wfoOEKfod1M_7FJg6QZFkt-LIqoZ3IxR8JII-S-4OPvTuYrFQM5OUvTIPqutl8E8e4wGzoAO3aPA08IYyN-VGQmodY5F5C8vuzuSx0f0U7u3Ktte35N7nchDtgMuNfn05Xg0Y72XlXCb0gOqg3G0vUaq-7ItbCOExHnUYBzayYaaG-XjfyqAsgo1SGi0D4F6ZIzYgdOysOhqwU4aCVha9cIc8netagd1B-gn7cWMbb7S5LE0UGKjW9P_sch1Z5EECNVsfgOuk-jyMudmK-NRn16ExmcTG8odSvvUPw5s21EkLI3Xz7aacI8amu1CXShiQ%3D%3D"}],"entry":[{"fullUrl":"https://api.haau3.com/v1/fhir/r4/PractitionerRole/PractitionerRole-179421b5-5919-4f54-84c9-a4473b68f74c","resource":{"resourceType":"PractitionerRole","id":"PractitionerRole-179421b5-5919-4f54-84c9-a4473b68f74c","meta":{"versionId":"1","lastUpdated":"2026-10-14T20:22:07.148389167Z","profile":["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-PractitionerRole"]},"extension":[{"url":"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients","extension":[{"url":"acceptingPatients","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/accepting-patients","code":"newpt","display":"Accepting new and existing patients"}]}}]}],"active":true,"period":{"start":"2024-09-09T00:00:00Z"},"practitioner":{"reference":"Practitioner/Practitioner-1093209884"},"organization":{"reference":"Organization/Organization-1417927559"},"location":[{"reference":"Location/Location-91b06a35-8b0e-4aad-abdf-583fa4f132a9"}],"telecom":[{"system":"phone","value":"6053289419","use":"work"}]},"search":{"mode":"match"}},{"fullUrl":"https://api.haau3.com/v1/fhir/r4/PractitionerRole/PractitionerRole-4dc9b35e-c888-4a59-b33e-0658eee88e4c","resource":{"resourceType":"PractitionerRole","id":"PractitionerRole-4dc9b35e-c888-4a59-b33e-0658eee88e4c","meta":{"versionId":"1","lastUpdated":"2026-10-14T20:18:20.113892082Z","profile":["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-PractitionerRole"]},"extension":[{"url":"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients","extension":[{"url":"acceptingPatients","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/accepting-patients","code":"newpt","display":"Accepting new and existing patients"}]}}]}],"active":true,"period":{"start":"2024-09-09T00:00:00Z"},"practitioner":{"reference":"Practitioner/Practitioner-1093209884"},"organization":{"reference":"Organization/Organization-1093090342"},"location":[{"reference":"Location/Location-91b06a35-8b0e-4aad-abdf-583fa4f132a9"},{"reference":"Location/Location-b0f5435e-f842-4790-9103-1b07d3b2caf1"},{"reference":"Location/Location-be799f58-4bbc-4f3a-9af4-e04f9d8b6314"},{"reference":"Location/Location-e009883a-9bf1-40ab-8cd9-c57ba2f7546d"}],"telecom":[{"system":"phone","value":"6053288200","use":"work"},{"system":"phone","value":"6053289000","use":"work"},{"system":"phone","value":"6053289419","use":"work"},{"system":"phone","value":"6053331000","use":"work"},{"system":"phone","value":"6059955635","use":"work"}]},"search":{"mode":"match"}}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"The request named a parameter, identifier system or value this service does not serve. Every unsupported parameter is refused by name, and none is silently ignored, so a search that returns results applied every filter you 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"},"404":{"description":"No such resource, or no such interaction on this base.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"406":{"$ref":"#/components/responses/FhirNotAcceptable"},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"502":{"description":"The directory could not be reached, answered in a shape that cannot be served, or answered with more than is served at once: a `_revinclude` past the directory's 100 records on a page, or an answer over 8 MiB. No answer is given: this is never reported as an empty result, which would read as 'no such provider'.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"The directory is rate limiting requests. Send the request again after `Retry-After`. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The directory did not respond in time.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}}}},"/v1/fhir/r4/PractitionerRole/{id}":{"get":{"tags":["Provider directory"],"summary":"Read a PractitionerRole","description":"Read one practitioner role by id, as returned by a search on this service.","operationId":"readPractitionerRole","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9\\-.]{1,64}$"},"description":"The resource id, as returned by a search on this service. Ids are opaque: they are not constructed from an NPI or any other identifier.","example":"PractitionerRole-179421b5-5919-4f54-84c9-a4473b68f74c"},{"$ref":"#/components/parameters/XRequestId"}],"responses":{"200":{"description":"The PractitionerRole, as the directory publishes it.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/PractitionerRole"},"examples":{"A practitioner's role":{"summary":"A practitioner's role","value":{"resourceType":"PractitionerRole","id":"PractitionerRole-179421b5-5919-4f54-84c9-a4473b68f74c","meta":{"lastUpdated":"2026-10-14T20:22:07.148389167Z","profile":["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-PractitionerRole"],"versionId":"1"},"extension":[{"url":"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients","extension":[{"url":"acceptingPatients","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/accepting-patients","code":"newpt","display":"Accepting new and existing patients"}]}}]}],"active":true,"practitioner":{"reference":"Practitioner/Practitioner-1093209884"},"organization":{"reference":"Organization/Organization-1417927559"},"period":{"start":"2024-09-09T00:00:00Z"},"location":[{"reference":"Location/Location-91b06a35-8b0e-4aad-abdf-583fa4f132a9"}],"telecom":[{"system":"phone","value":"6053289419","use":"work"}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"The id is not a valid FHIR id, or a query parameter was sent: a read takes none. Ids come from search results; they are not constructed from an NPI or any other identifier.","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"},"404":{"description":"No such resource, or no such interaction on this base.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"406":{"$ref":"#/components/responses/FhirNotAcceptable"},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"502":{"description":"The directory could not be reached, answered in a shape that cannot be served, or answered with more than is served at once: a `_revinclude` past the directory's 100 records on a page, or an answer over 8 MiB. No answer is given: this is never reported as an empty result, which would read as 'no such provider'.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"The directory is rate limiting requests. Send the request again after `Retry-After`. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The directory did not respond in time.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}}}},"/v1/fhir/r4/Organization":{"get":{"tags":["Provider directory"],"summary":"Find organizations, payers and networks","description":"Search `Organization` by name, NPI, parent (`partof`) or type. `type=ntwk` lists the insurance networks the directory holds and `type=pay` its payers; any other type, `active` and the address parameters narrow a search but cannot stand alone.\n\nThe directory records networks by the text of their type rather than a code. This service searches that text for `type=ntwk` and confirms every answer is a network; if the directory changes how it records them, the search answers 502 rather than serve something else.\n\nAn NPI search can return a parent organization beside the practice, when the parent lists the NPI among several. `_revinclude` brings the roles, affiliations, locations and endpoints that point at each match, up to 100 per page.","operationId":"searchOrganization","parameters":[{"name":"name","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":100},"description":"Matches the organization's name."},{"name":"identifier","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":256},"description":"An organization's NPI, as `{system}|{npi}` or a bare 10-digit value, under the same systems `Practitioner` accepts. An NPI search can return more than the practice that holds the NPI: a parent organization that lists it among several NPIs is a match too, because it carries the NPI as an NPI."},{"name":"partof","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":256},"description":"The organizations that are part of one organization. Give a Organization id, `Organization/{id}`, or the `fullUrl` this service returned. An address on another server is refused."},{"name":"type","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":256},"description":"An organization type from `http://terminology.hl7.org/CodeSystem/organization-type`, bare or with that system: `prov` for healthcare providers, `pay` for payers, `ntwk` for insurance networks. `ntwk` is also accepted under Plan-Net's `http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/OrgTypeCS`. `type=ntwk` and `type=pay` may stand alone, to list every network or every payer; any other type narrows a search. The directory records networks by the text of their type rather than a code; this service searches that text and confirms each answer is a network, and answers 502 rather than serve one that is not.","example":"ntwk"},{"name":"active","in":"query","required":false,"schema":{"type":"string","enum":["true","false"]},"description":"`true` or `false`. Narrows a search; cannot be used on its own."},{"name":"address-city","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":100},"description":"Narrows a search by city; cannot be used on its own. Matches any of the organization's addresses, so a result can still list addresses in another city."},{"name":"address-state","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":50},"description":"Narrows a search by state; cannot be used on its own. Matches any of the organization's addresses, so a result can still list addresses in another state."},{"name":"address-postalcode","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":100},"description":"Narrows a search by postal code; cannot be used on its own. Matches any of the organization's addresses, so a result can still list addresses in another postal code."},{"name":"_include","in":"query","required":false,"schema":{"minItems":1,"maxItems":16,"type":"array","items":{"type":"string","enum":["Organization:partof"]}},"style":"form","explode":true,"description":"`Organization:partof` brings the organization each match is part of. Repeat the parameter to include several. Included entries do not count toward `_count`."},{"name":"_revinclude","in":"query","required":false,"schema":{"minItems":1,"maxItems":16,"type":"array","items":{"type":"string","enum":["PractitionerRole:organization","OrganizationAffiliation:primary-organization","OrganizationAffiliation:participating-organization","Location:organization","Endpoint:organization","Organization:partof"]}},"style":"form","explode":true,"description":"Bring the records that point at each match: `PractitionerRole:organization`, `OrganizationAffiliation:primary-organization`, `OrganizationAffiliation:participating-organization`, `Location:organization`, `Endpoint:organization` or `Organization:partof`. Repeat the parameter to include several. Included entries do not count toward `_count`. The directory returns at most 100 included records per page; a page with more is refused with a 502 rather than served short."},{"name":"_id","in":"query","required":false,"schema":{"type":"string","pattern":"^[A-Za-z0-9\\-.]{1,64}$"},"description":"A Organization id. Searching by id rather than reading it lets one request also bring the records an `_include` or `_revinclude` names."},{"name":"_summary","in":"query","required":false,"schema":{"type":"string","enum":["count"]},"description":"`count` only: answers how many records match, as `total`, with no entries. Cannot be combined with `_include`, `_revinclude`, `_count` or `page`."},{"name":"_count","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"Results are paged. `_count` sets the page size (1 to 100); a larger value is refused rather than quietly reduced. Follow `link` with relation `next` to continue. The cursor it carries is opaque and must not be constructed or modified.","example":2},{"name":"page","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":8192},"description":"Continuation cursor. Opaque: follow the `next` link from a previous response, and never construct or modify it. Cursors expire."},{"$ref":"#/components/parameters/XRequestId"}],"responses":{"200":{"description":"A FHIR `Bundle` with `type: searchset`. `total` is present when the directory sends one.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Bundle"},"examples":{"Insurance networks":{"summary":"Insurance networks","value":{"resourceType":"Bundle","type":"searchset","link":[{"relation":"self","url":"https://api.haau3.com/v1/fhir/r4/Organization?type=ntwk&_count=2"},{"relation":"next","url":"https://api.haau3.com/v1/fhir/r4/Organization?type=ntwk&_count=2&page=AAMA-EFRSURBSGd2bzlHTkh2NkZNeXNGMkNKelNQaUp6aCtWTXNCNXh6R0owVG0xQ1RtRzZRRlFsZHdrMHBleFdXNHJWUWdqdVFnUkFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTUcwNjZ1RHRDSHg2cmFmSjhBZ0VRZ0R2TlNZOHNEOC9Bdk1xQTR4ZG1PT3gzWGo5eTI2KzFFVm1ndnE0ZThIMllBVXU0bUlBL2NkaDd6NFg4dGNLWFFhWHBaTFBnNGdNZUp3Y1lHZz0983p39CwCUjpWSugnFrlXI6R_qkjtsw1vB86p5RVBZjMXTQbnDC-9W1MfBa0AXsABVevK4CtJA4sduYGsCDLx6RquJ7XNsC9I1aLOys1oap16pqiMZpy5SQQs_00NkQMjBC5aon49YGXY9w1ScGWcPNEYjj1JX6FTBlC0OQH21mLj5wDj_m3LL3e4Hp80rIx1D2IZfOJZhxS2eCXMxW8F4CUx-RXEdRkK9BxPhoDHiTTc8TzRRXghyeO7E5uamGV3gekBMm1IUxPJlS6Sn_Gzcy2W_gwcz3TdxMXwgcCrQ_JyeCHwTbuAgQz4vTCIXDaSVjVuNH_KbLdHet6OQ9UcFqtTJyZlldVz5Y-Q0yZvPZi4pKa6WUymNEmcH0hLYcPsAjBYlkKWkv3nr5_5nyP12QuIt0KKA5fOoX8UGf4SUtdIYFFPrNMOuAWLTGGrXRIvS_QSGiLAsVJjmq3QXd2Rjt_OOjuLJTiQGvRMljPahGyZuS2HrzDU7PIsENSF2w3ViieOKVEtbQPW3jtth4QdtJmx7s0m7gsv6xokEzfffObWlDirjnmmUVnvlxsC9YkHER-VpsRDF_Uk2jh9ufasN-INBU8jj2trOfMPsce2TVMlgp9Ei8W5ydEaZsj3959ErJ_k_bwbeOOJipZCNwBeyBRmCY5E0ZGGY-LeKP0z0dkTE1eLSZqMFKPEFcs_xhXe12JXJeAGzjxZ7D-jLZtKcUjLviLdblNE7VxfkcgeAquZPPzjVG83_KNkMswh4fZ479bRKLnRZvdT5yjJed-gDbfxXL5IOMM4BbranhQJf_9SzkZYZu8le-1i3kI_4FtP8VJYOdPopvDmXZLV8TJMbq_dp_imQh_6pk8XbTPegFYqrU1l3x4n3YZpOABK2VI9Qgj9-BYH3oUfqX6njGKyV9blC1VAsDIDac7BtwlN0dcWPactGT3NUae-lPiPgok8QmUwMyZPB0X_6pDGy3hrlWhhxBvq0Olz7lxJ9scXUN3IIudDrv90l-FTmFCoN2sWN-jq11fPwFUXyC3_"}],"entry":[{"fullUrl":"https://api.haau3.com/v1/fhir/r4/Organization/Organization-0061f2ad-76fd-4eb3-906f-43bac6d6ea2b","resource":{"resourceType":"Organization","id":"Organization-0061f2ad-76fd-4eb3-906f-43bac6d6ea2b","meta":{"versionId":"1","lastUpdated":"2026-10-14T20:49:01.200431720Z","profile":["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Organization"]},"extension":[{"url":"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/us/ndh/CodeSystem/NdhVerificationStatusCS","code":"complete","display":"Complete"}]}}],"active":true,"type":[{"text":"ntwk"}],"name":"FAMILY HEALTH ALLIANCE MEDICAL GROUP"},"search":{"mode":"match"}},{"fullUrl":"https://api.haau3.com/v1/fhir/r4/Organization/Organization-0379b9dd-f3f2-4680-aeee-402fcbcace00","resource":{"resourceType":"Organization","id":"Organization-0379b9dd-f3f2-4680-aeee-402fcbcace00","meta":{"versionId":"1","lastUpdated":"2026-10-14T20:49:01.202445008Z","profile":["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Organization"]},"extension":[{"url":"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/us/ndh/CodeSystem/NdhVerificationStatusCS","code":"complete","display":"Complete"}]}}],"active":true,"type":[{"text":"ntwk"}],"name":"ATLAS HEALTHCARE PHYSICIANS"},"search":{"mode":"match"}}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"The request named a parameter, identifier system or value this service does not serve. Every unsupported parameter is refused by name, and none is silently ignored, so a search that returns results applied every filter you 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"},"404":{"description":"No such resource, or no such interaction on this base.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"406":{"$ref":"#/components/responses/FhirNotAcceptable"},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"502":{"description":"The directory could not be reached, answered in a shape that cannot be served, or answered with more than is served at once: a `_revinclude` past the directory's 100 records on a page, or an answer over 8 MiB. No answer is given: this is never reported as an empty result, which would read as 'no such provider'.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"The directory is rate limiting requests. Send the request again after `Retry-After`. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The directory did not respond in time.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}}}},"/v1/fhir/r4/Organization/{id}":{"get":{"tags":["Provider directory"],"summary":"Read an Organization","description":"Read one organization, payer or network by id, as returned by a search on this service.","operationId":"readOrganization","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9\\-.]{1,64}$"},"description":"The resource id, as returned by a search on this service. Ids are opaque: they are not constructed from an NPI or any other identifier.","example":"Organization-ea579d05-454e-4359-8751-900c940a599a"},{"$ref":"#/components/parameters/XRequestId"}],"responses":{"200":{"description":"The Organization, as the directory publishes it.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Organization"},"examples":{"An insurance network":{"summary":"An insurance network","value":{"resourceType":"Organization","id":"Organization-ea579d05-454e-4359-8751-900c940a599a","meta":{"lastUpdated":"2026-10-14T20:49:01.245180701Z","profile":["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Organization"],"versionId":"1"},"extension":[{"url":"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/us/ndh/CodeSystem/NdhVerificationStatusCS","code":"complete","display":"Complete"}]}}],"active":true,"type":[{"text":"ntwk"}],"name":"BSC 65 PLUS INDIVIDUAL MAPD"}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"The id is not a valid FHIR id, or a query parameter was sent: a read takes none. Ids come from search results; they are not constructed from an NPI or any other identifier.","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"},"404":{"description":"No such resource, or no such interaction on this base.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"406":{"$ref":"#/components/responses/FhirNotAcceptable"},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"502":{"description":"The directory could not be reached, answered in a shape that cannot be served, or answered with more than is served at once: a `_revinclude` past the directory's 100 records on a page, or an answer over 8 MiB. No answer is given: this is never reported as an empty result, which would read as 'no such provider'.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"The directory is rate limiting requests. Send the request again after `Retry-After`. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The directory did not respond in time.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}}}},"/v1/fhir/r4/OrganizationAffiliation":{"get":{"tags":["Provider directory"],"summary":"Find the organizations in a network","description":"Search `OrganizationAffiliation`: which organizations take part in which networks. `network` lists a network's members; with `participating-organization` beside it, it asks whether the directory lists that organization in that network. The directory's network data is sparse, so an organization a network's records do not list is not shown to be out of network. For a network, the primary organization is the network itself.","operationId":"searchOrganizationAffiliation","parameters":[{"name":"network","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":256},"description":"The affiliations the directory lists in one insurance network. An organization the network's records do not list is not shown to be out of network: the directory's network data is sparse. Give a Organization id, `Organization/{id}`, or the `fullUrl` this service returned. An address on another server is refused.","example":"Organization-ea579d05-454e-4359-8751-900c940a599a"},{"name":"primary-organization","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":256},"description":"The affiliations whose primary organization is this one. Give a Organization id, `Organization/{id}`, or the `fullUrl` this service returned. An address on another server is refused."},{"name":"participating-organization","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":256},"description":"The affiliations one organization participates in. Give a Organization id, `Organization/{id}`, or the `fullUrl` this service returned. An address on another server is refused."},{"name":"active","in":"query","required":false,"schema":{"type":"string","enum":["true","false"]},"description":"`true` or `false`. Narrows a search; cannot be used on its own."},{"name":"_include","in":"query","required":false,"schema":{"minItems":1,"maxItems":16,"type":"array","items":{"type":"string","enum":["OrganizationAffiliation:participating-organization","OrganizationAffiliation:primary-organization","OrganizationAffiliation:network"]}},"style":"form","explode":true,"description":"Bring the organizations an affiliation names: `OrganizationAffiliation:participating-organization`, `OrganizationAffiliation:primary-organization` or `OrganizationAffiliation:network`. Repeat the parameter to include several. Included entries do not count toward `_count`."},{"name":"_id","in":"query","required":false,"schema":{"type":"string","pattern":"^[A-Za-z0-9\\-.]{1,64}$"},"description":"A OrganizationAffiliation id. Searching by id rather than reading it lets one request also bring the records an `_include` or `_revinclude` names."},{"name":"_summary","in":"query","required":false,"schema":{"type":"string","enum":["count"]},"description":"`count` only: answers how many records match, as `total`, with no entries. Cannot be combined with `_include`, `_revinclude`, `_count` or `page`."},{"name":"_count","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"Results are paged. `_count` sets the page size (1 to 100); a larger value is refused rather than quietly reduced. Follow `link` with relation `next` to continue. The cursor it carries is opaque and must not be constructed or modified.","example":2},{"name":"page","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":8192},"description":"Continuation cursor. Opaque: follow the `next` link from a previous response, and never construct or modify it. Cursors expire."},{"$ref":"#/components/parameters/XRequestId"}],"responses":{"200":{"description":"A FHIR `Bundle` with `type: searchset`. `total` is present when the directory sends one.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Bundle"},"examples":{"A network's members":{"summary":"A network's members","value":{"resourceType":"Bundle","type":"searchset","link":[{"relation":"self","url":"https://api.haau3.com/v1/fhir/r4/OrganizationAffiliation?network=Organization-ea579d05-454e-4359-8751-900c940a599a&_count=2"},{"relation":"next","url":"https://api.haau3.com/v1/fhir/r4/OrganizationAffiliation?network=Organization-ea579d05-454e-4359-8751-900c940a599a&_count=2&page=AAMA-EFRSURBSGd2bzlHTkh2NkZNeXNGMkNKelNQaUp6aCtWTXNCNXh6R0owVG0xQ1RtRzZRSFFVaE43NWhqL0RpZURPb1Y3b1lCRkFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTVY5SmxtMisyZzNZNWxtczJBZ0VRZ0R2WmtUK1k2dEhnSkVzZmpid2RNVmxsaWFnNGhUcmVXck54Q2NQQVFIQlBxV25PRisvNjcrRDU0MzY1OTIzczc4dFlFSTIvNWo5cWg4ZXU2dz09O6lhnDedPtaQSgXxE1mpybg5ZuW6Bg8a0GxRUshtbccMOKGc20OQY0VoHnQmdEkcc_ujkS5zaJGKeGnfdG99X4kqwYWB28EzQEFbW4lZktWA7N95LIMpplFREOzrh-HC8Kcvys84QycEvjWDcLfbL6Hdeva4zXEuTN3UOvV4mTsxvneZkCZ3myrjTKLJ8lpDIE1HjyEXTC_dTbhLMCmEe5tJXOKyUu87_xRxtA5C0Gv1mssjTlAZVYSR4CnOx8-Zq4LNY_Axf9G6E41mqe0rUOXZP7YjedeIpu7AeDcIWbzZpHs4CLpip-1hSQxXmuQemDbVLTrCMZPX2jnkAxFsFf_WHaJ248qpRyVV3zdG2xLrPOHjyPO4bHsAfaziMG2xJhzYoBHyccvWHaUB0Qmq5xUTRaA7KXBHAjniV8c7wmdRxbe3CVPWVXHaD2KocLSK6ajsn5qdr4_rujLVRvnIHA4OWfzHSWpAXXeKrrIxgJGEJ3oWCZhG90I50YgTYZ2iBpFV_yA0Ru3H5UhEOcYeKb_LLguhuWJcQd_wYKx3wG_rwkaaGLBhLOI6n4jGdvbpc73UclkFi3KI3eNwuWYs3gI2i3e2seeH_AKZJ2d-t_XVnz5qzSmbxSQms4tnpiXLYaVLuxv6EZGS3B13y_6mqrF28GHS4LclFbgEyvt8FX1HdCbjMov2R7H2-sH0ag-p5e-VdwFw2I__XWUE2IWT1T6DS8uT_eaBUuVSLuLr09Hh7OIS_ngJjCLCLUyjLAL8uYsow1YYqfZoFknKMb19n2Ze_sFZPgsAzUOdRMYOfGo7Lm3QbIQ0hFikMuePB75dwosqxgUET6Ts-nPKJlASOG7hRouXQjcufZuRnlA1xC2Y2MXYfbiWcpqNXIkIwm_1VBdLZ2SpwP41gQnF-W8WTfU8jBsJxY0ZrcG-Edl2-F834R48yXvNFuyIC3AlSvT2Fb3hT-sszQeCyOHeHqiiVeAgSXiXRTI55cU2mvxxt2xU7bNie0OkaKMpluB5NXjK3-OFrvN9p-8cYOxNfVqaXVE4CpEiY-yg"}],"entry":[{"fullUrl":"https://api.haau3.com/v1/fhir/r4/OrganizationAffiliation/OrganizationAffiliation-000cc9b9-738c-43cd-b923-03ac9ab4714d","resource":{"resourceType":"OrganizationAffiliation","id":"OrganizationAffiliation-000cc9b9-738c-43cd-b923-03ac9ab4714d","meta":{"versionId":"1","lastUpdated":"2026-10-14T21:12:38.183722348Z","profile":["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-OrganizationAffiliation"]},"active":true,"organization":{"reference":"Organization/Organization-ea579d05-454e-4359-8751-900c940a599a"},"participatingOrganization":{"reference":"Organization/Organization-1972503142"},"network":[{"reference":"Organization/Organization-ea579d05-454e-4359-8751-900c940a599a"}]},"search":{"mode":"match"}},{"fullUrl":"https://api.haau3.com/v1/fhir/r4/OrganizationAffiliation/OrganizationAffiliation-00143df2-30a6-454b-a82c-c3ea8a2d59ae","resource":{"resourceType":"OrganizationAffiliation","id":"OrganizationAffiliation-00143df2-30a6-454b-a82c-c3ea8a2d59ae","meta":{"versionId":"1","lastUpdated":"2026-10-14T21:12:37.946536507Z","profile":["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-OrganizationAffiliation"]},"active":true,"organization":{"reference":"Organization/Organization-ea579d05-454e-4359-8751-900c940a599a"},"participatingOrganization":{"reference":"Organization/Organization-1932757820"},"network":[{"reference":"Organization/Organization-ea579d05-454e-4359-8751-900c940a599a"}]},"search":{"mode":"match"}}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"The request named a parameter, identifier system or value this service does not serve. Every unsupported parameter is refused by name, and none is silently ignored, so a search that returns results applied every filter you 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"},"404":{"description":"No such resource, or no such interaction on this base.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"406":{"$ref":"#/components/responses/FhirNotAcceptable"},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"502":{"description":"The directory could not be reached, answered in a shape that cannot be served, or answered with more than is served at once: a `_revinclude` past the directory's 100 records on a page, or an answer over 8 MiB. No answer is given: this is never reported as an empty result, which would read as 'no such provider'.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"The directory is rate limiting requests. Send the request again after `Retry-After`. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The directory did not respond in time.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}}}},"/v1/fhir/r4/OrganizationAffiliation/{id}":{"get":{"tags":["Provider directory"],"summary":"Read an OrganizationAffiliation","description":"Read one organization affiliation by id, as returned by a search on this service.","operationId":"readOrganizationAffiliation","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9\\-.]{1,64}$"},"description":"The resource id, as returned by a search on this service. Ids are opaque: they are not constructed from an NPI or any other identifier.","example":"OrganizationAffiliation-000cc9b9-738c-43cd-b923-03ac9ab4714d"},{"$ref":"#/components/parameters/XRequestId"}],"responses":{"200":{"description":"The OrganizationAffiliation, as the directory publishes it.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OrganizationAffiliation"},"examples":{"A network membership":{"summary":"A network membership","value":{"resourceType":"OrganizationAffiliation","id":"OrganizationAffiliation-000cc9b9-738c-43cd-b923-03ac9ab4714d","meta":{"lastUpdated":"2026-10-14T21:12:38.183722348Z","profile":["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-OrganizationAffiliation"],"versionId":"1"},"active":true,"organization":{"reference":"Organization/Organization-ea579d05-454e-4359-8751-900c940a599a"},"participatingOrganization":{"reference":"Organization/Organization-1972503142"},"network":[{"reference":"Organization/Organization-ea579d05-454e-4359-8751-900c940a599a"}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"The id is not a valid FHIR id, or a query parameter was sent: a read takes none. Ids come from search results; they are not constructed from an NPI or any other identifier.","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"},"404":{"description":"No such resource, or no such interaction on this base.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"406":{"$ref":"#/components/responses/FhirNotAcceptable"},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"502":{"description":"The directory could not be reached, answered in a shape that cannot be served, or answered with more than is served at once: a `_revinclude` past the directory's 100 records on a page, or an answer over 8 MiB. No answer is given: this is never reported as an empty result, which would read as 'no such provider'.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"The directory is rate limiting requests. Send the request again after `Retry-After`. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The directory did not respond in time.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}}}},"/v1/fhir/r4/HealthcareService":{"get":{"tags":["Provider directory"],"summary":"Find healthcare services","description":"Search `HealthcareService` by location, or by network beside a location. The directory's service records name a network and, for a few, a location; none names an organization, so `organization` is refused rather than answered with nothing.","operationId":"searchHealthcareService","parameters":[{"name":"location","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":256},"description":"The services offered at one location. Give a Location id, `Location/{id}`, or the `fullUrl` this service returned. An address on another server is refused.","example":"Location-ba334cb2-a0f9-4147-ab31-1c5af4ab9a4d"},{"name":"network","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":256},"description":"The services the directory lists in one insurance network. Cannot be used on its own: send it beside `location`. A search that breaks this rule is refused before the directory is asked. Give a Organization id, `Organization/{id}`, or the `fullUrl` this service returned. An address on another server is refused."},{"name":"active","in":"query","required":false,"schema":{"type":"string","enum":["true","false"]},"description":"`true` or `false`. Narrows a search; cannot be used on its own."},{"name":"_id","in":"query","required":false,"schema":{"type":"string","pattern":"^[A-Za-z0-9\\-.]{1,64}$"},"description":"A HealthcareService id. Searching by id rather than reading it lets one request also bring the records an `_include` or `_revinclude` names."},{"name":"_summary","in":"query","required":false,"schema":{"type":"string","enum":["count"]},"description":"`count` only: answers how many records match, as `total`, with no entries. Cannot be combined with `_include`, `_revinclude`, `_count` or `page`."},{"name":"_count","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"Results are paged. `_count` sets the page size (1 to 100); a larger value is refused rather than quietly reduced. Follow `link` with relation `next` to continue. The cursor it carries is opaque and must not be constructed or modified.","example":2},{"name":"page","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":8192},"description":"Continuation cursor. Opaque: follow the `next` link from a previous response, and never construct or modify it. Cursors expire."},{"$ref":"#/components/parameters/XRequestId"}],"responses":{"200":{"description":"A FHIR `Bundle` with `type: searchset`. `total` is present when the directory sends one.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Bundle"},"examples":{"The services at a location":{"summary":"The services at a location","value":{"resourceType":"Bundle","type":"searchset","link":[{"relation":"self","url":"https://api.haau3.com/v1/fhir/r4/HealthcareService?location=Location-ba334cb2-a0f9-4147-ab31-1c5af4ab9a4d&_count=2"}],"entry":[{"fullUrl":"https://api.haau3.com/v1/fhir/r4/HealthcareService/HealthcareService-0009bcae-631e-45c0-9d3c-5691acb4a05d","resource":{"resourceType":"HealthcareService","id":"HealthcareService-0009bcae-631e-45c0-9d3c-5691acb4a05d","meta":{"versionId":"1","lastUpdated":"2026-10-14T21:17:34.307230248Z","profile":["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-HealthcareService"]},"extension":[{"url":"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference","valueReference":{"reference":"Organization/Organization-ea579d05-454e-4359-8751-900c940a599a"}}],"active":true,"location":[{"reference":"Location/Location-ba334cb2-a0f9-4147-ab31-1c5af4ab9a4d"}]},"search":{"mode":"match"}}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"The request named a parameter, identifier system or value this service does not serve. Every unsupported parameter is refused by name, and none is silently ignored, so a search that returns results applied every filter you 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"},"404":{"description":"No such resource, or no such interaction on this base.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"406":{"$ref":"#/components/responses/FhirNotAcceptable"},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"502":{"description":"The directory could not be reached, answered in a shape that cannot be served, or answered with more than is served at once: a `_revinclude` past the directory's 100 records on a page, or an answer over 8 MiB. No answer is given: this is never reported as an empty result, which would read as 'no such provider'.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"The directory is rate limiting requests. Send the request again after `Retry-After`. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The directory did not respond in time.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}}}},"/v1/fhir/r4/HealthcareService/{id}":{"get":{"tags":["Provider directory"],"summary":"Read a HealthcareService","description":"Read one healthcare service by id, as returned by a search on this service.","operationId":"readHealthcareService","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9\\-.]{1,64}$"},"description":"The resource id, as returned by a search on this service. Ids are opaque: they are not constructed from an NPI or any other identifier.","example":"HealthcareService-0009bcae-631e-45c0-9d3c-5691acb4a05d"},{"$ref":"#/components/parameters/XRequestId"}],"responses":{"200":{"description":"The HealthcareService, as the directory publishes it.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/HealthcareService"},"examples":{"A healthcare service":{"summary":"A healthcare service","value":{"resourceType":"HealthcareService","id":"HealthcareService-0009bcae-631e-45c0-9d3c-5691acb4a05d","meta":{"lastUpdated":"2026-10-14T21:17:34.307230248Z","profile":["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-HealthcareService"],"versionId":"1"},"active":true,"location":[{"reference":"Location/Location-ba334cb2-a0f9-4147-ab31-1c5af4ab9a4d"}],"extension":[{"url":"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference","valueReference":{"reference":"Organization/Organization-ea579d05-454e-4359-8751-900c940a599a"}}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"The id is not a valid FHIR id, or a query parameter was sent: a read takes none. Ids come from search results; they are not constructed from an NPI or any other identifier.","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"},"404":{"description":"No such resource, or no such interaction on this base.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"406":{"$ref":"#/components/responses/FhirNotAcceptable"},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"502":{"description":"The directory could not be reached, answered in a shape that cannot be served, or answered with more than is served at once: a `_revinclude` past the directory's 100 records on a page, or an answer over 8 MiB. No answer is given: this is never reported as an empty result, which would read as 'no such provider'.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"The directory is rate limiting requests. Send the request again after `Retry-After`. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The directory did not respond in time.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}}}},"/v1/fhir/r4/Location":{"get":{"tags":["Provider directory"],"summary":"Find practice locations","description":"Search `Location` by managing organization or name; the address parameters and `status` narrow a search but cannot stand alone. A distance search (`near`) is refused because the directory does not apply it.","operationId":"searchLocation","parameters":[{"name":"organization","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":256},"description":"The locations one organization manages. Give a Organization id, `Organization/{id}`, or the `fullUrl` this service returned. An address on another server is refused.","example":"Organization-1093090342"},{"name":"name","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":100},"description":"Matches the location's name."},{"name":"address-city","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":100},"description":"Narrows a search by city; cannot be used on its own."},{"name":"address-state","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":50},"description":"Narrows a search by state; cannot be used on its own."},{"name":"address-postalcode","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":100},"description":"Narrows a search by postal code; cannot be used on its own."},{"name":"status","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":256},"description":"`active`, `suspended` or `inactive`. Narrows a search; cannot be used on its own."},{"name":"_include","in":"query","required":false,"schema":{"minItems":1,"maxItems":16,"type":"array","items":{"type":"string","enum":["Location:organization"]}},"style":"form","explode":true,"description":"`Location:organization` brings the organization that manages each location. Repeat the parameter to include several. Included entries do not count toward `_count`."},{"name":"_revinclude","in":"query","required":false,"schema":{"minItems":1,"maxItems":16,"type":"array","items":{"type":"string","enum":["PractitionerRole:location"]}},"style":"form","explode":true,"description":"`PractitionerRole:location` brings the roles held at each location. Repeat the parameter to include several. Included entries do not count toward `_count`. The directory returns at most 100 included records per page; a page with more is refused with a 502 rather than served short."},{"name":"_id","in":"query","required":false,"schema":{"type":"string","pattern":"^[A-Za-z0-9\\-.]{1,64}$"},"description":"A Location id. Searching by id rather than reading it lets one request also bring the records an `_include` or `_revinclude` names."},{"name":"_summary","in":"query","required":false,"schema":{"type":"string","enum":["count"]},"description":"`count` only: answers how many records match, as `total`, with no entries. Cannot be combined with `_include`, `_revinclude`, `_count` or `page`."},{"name":"_count","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"Results are paged. `_count` sets the page size (1 to 100); a larger value is refused rather than quietly reduced. Follow `link` with relation `next` to continue. The cursor it carries is opaque and must not be constructed or modified.","example":2},{"name":"page","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":8192},"description":"Continuation cursor. Opaque: follow the `next` link from a previous response, and never construct or modify it. Cursors expire."},{"$ref":"#/components/parameters/XRequestId"}],"responses":{"200":{"description":"A FHIR `Bundle` with `type: searchset`. `total` is present when the directory sends one.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Bundle"},"examples":{"An organization's locations":{"summary":"An organization's locations","value":{"resourceType":"Bundle","type":"searchset","link":[{"relation":"self","url":"https://api.haau3.com/v1/fhir/r4/Location?organization=Organization-1093090342&_count=2"},{"relation":"next","url":"https://api.haau3.com/v1/fhir/r4/Location?organization=Organization-1093090342&_count=2&page=AAMA-EFRSURBSGd2bzlHTkh2NkZNeXNGMkNKelNQaUp6aCtWTXNCNXh6R0owVG0xQ1RtRzZRSFYrVWVUaXNmMW1uT2R0blB3TzlaQUFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTVVSeGw1WmpNUHlzTHhwQkRBZ0VRZ0R1MDNCRmxyalc0ODhlRkhCUk5JS2xpcmtPSUlYeDZ6dWpnMnBGbFBBWEdwSy9ENTBtS3NWRk5BOXlycW5VK0FZc2htb1JxeFcwa2kvUk4wZz09Q3F5uM4EUvNqzomohLSqIkCV4eWlofCoKUy2qmGw20wX56X-dEkL05DRKciQwBgqF0un_m3MQXTUgcXiBaPYGxUgP_5KCbItOjprTWTPFlnno11u4b8cfr3AQ-vjNKAct5dPw7YBtd81XGSgavrT6KEqreKfbS_gHF1LQHcxVcPcngHry6Q1d9KN6nj7rXqNWZWK0NC6kNX2ANEgBWhAj_4g5A5E1RMMKoY2IW5GIb-aWDY1NrWqOBU2GXE4PgpueouEMBESe_Uw3Jx8N311Uh4SV08H2QLdXpLpWrgPYFrwizjb6eXygnWVpBRbzfMJrzJKH137w-jWQqyIe7kpZAqMIzFHokChI6uAifmsvZ1V0uq2WbkbK6qrghKuU1UNPAVpFkpnxUIx-FHTi5Z2WRJUFJJ3jflT1FrArVyU2hOspNbowsl0bulGhq05BY1WPfF_WmwwbeTyvH6W93vlVXr7nywckBi-jdSzO42mjgM07i5MGeiiZN9Yh2Jz4XJV6XhkO8Z2qwgL4xskdMczQBJnHAYY4uVF7chDZ1UqY_G71lXgqU1RdcmRQJ1EE1c96zf8kMZwOUeb3dpvEV2KFv-4dfQ-U172EiHW9zSJCaWNgpaN-N1jv-WOWUM67cT4kTjRa_zoFQKTKe9xIoIc4CG_K4iTFHdAzGw3P6i1VUsBReI3cm0rxqc_fdRiuadIhyb4OR8pE_yP-I0fCwEX7u9TeZ6iBrsyEc_feeuRj_oOX25aR4LwdvC6iBcpHy591XaZGY_yjHrapfe-pAWI3ndAEydpQ_KalQrihraoGGQEhc6Ka1_qxhMyQVEckm43J-GSXxeDe1QITwbAjQVXR778OznOf8RWYqyXOtl70XBWX5dM6IRtP_M5NrxtTKumqg_pDqYB47gYPnU0t8fA2AcDVjY5yHtkxgTwt3Plq0ZiwMImCOOyu62QxCYBdwNNGvyrX5WTd5gYjgHn4DqS4-owEvQgwiit1Wk6fXuqx8QM53cRYUzBxgwpTgaKwKqKWthKXw%3D%3D"}],"entry":[{"fullUrl":"https://api.haau3.com/v1/fhir/r4/Location/Location-19ee3838-0fb8-4af1-a912-2906f6a315f7","resource":{"resourceType":"Location","id":"Location-19ee3838-0fb8-4af1-a912-2906f6a315f7","meta":{"versionId":"1","lastUpdated":"2026-10-14T20:57:02.131435914Z","profile":["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Location"]},"status":"active","name":"7511 S Louise Ave","description":"7511 S Louise Ave","mode":"instance","telecom":[{"system":"fax","value":"6053353282","use":"work"},{"system":"phone","value":"6053128700","use":"work"},{"system":"phone","value":"6053345850","use":"work"}],"address":{"type":"physical","line":["7511 S Louise Ave"],"city":"Sioux Falls","state":"SD","postalCode":"57108","country":"US"},"position":{"longitude":-96.76733,"latitude":43.47856},"managingOrganization":{"reference":"Organization/Organization-1093090342"}},"search":{"mode":"match"}},{"fullUrl":"https://api.haau3.com/v1/fhir/r4/Location/Location-1c36f608-52f8-4d45-8bac-158ef184882d","resource":{"resourceType":"Location","id":"Location-1c36f608-52f8-4d45-8bac-158ef184882d","meta":{"versionId":"1","lastUpdated":"2026-10-14T20:59:16.681817075Z","profile":["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Location"]},"status":"active","name":"5920 E Madison St","description":"5920 E Madison St","mode":"instance","telecom":[{"system":"fax","value":"6053282957","use":"work"},{"system":"fax","value":"6056100661","use":"work"},{"system":"phone","value":"6053125000","use":"work"}],"address":{"type":"physical","line":["5920 E Madison St"],"city":"Sioux Falls","state":"SD","postalCode":"57110","country":"US"},"position":{"longitude":-96.64536,"latitude":43.51173},"managingOrganization":{"reference":"Organization/Organization-1093090342"}},"search":{"mode":"match"}}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"The request named a parameter, identifier system or value this service does not serve. Every unsupported parameter is refused by name, and none is silently ignored, so a search that returns results applied every filter you 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"},"404":{"description":"No such resource, or no such interaction on this base.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"406":{"$ref":"#/components/responses/FhirNotAcceptable"},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"502":{"description":"The directory could not be reached, answered in a shape that cannot be served, or answered with more than is served at once: a `_revinclude` past the directory's 100 records on a page, or an answer over 8 MiB. No answer is given: this is never reported as an empty result, which would read as 'no such provider'.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"The directory is rate limiting requests. Send the request again after `Retry-After`. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The directory did not respond in time.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}}}},"/v1/fhir/r4/Location/{id}":{"get":{"tags":["Provider directory"],"summary":"Read a Location","description":"Read one location by id, as returned by a search on this service.","operationId":"readLocation","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9\\-.]{1,64}$"},"description":"The resource id, as returned by a search on this service. Ids are opaque: they are not constructed from an NPI or any other identifier.","example":"Location-26e6731f-5e6a-48e4-aa2f-9f4c40cf402b"},{"$ref":"#/components/parameters/XRequestId"}],"responses":{"200":{"description":"The Location, as the directory publishes it.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Location"},"examples":{"A practice location":{"summary":"A practice location","value":{"resourceType":"Location","id":"Location-26e6731f-5e6a-48e4-aa2f-9f4c40cf402b","meta":{"lastUpdated":"2026-10-14T20:54:15.371019820Z","profile":["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Location"],"versionId":"1"},"status":"active","name":"Atlanta-Sandy Springs-Roswell, GA","description":"Atlanta-Sandy Springs-Roswell, GA","mode":"instance","telecom":[{"system":"phone","value":"4047787525","use":"work"}],"address":{"line":["1365 Clifton Rd NE"],"city":"Atlanta","state":"GA","postalCode":"30322","country":"US","type":"physical"},"position":{"longitude":-84.32084,"latitude":33.79225},"managingOrganization":{"reference":"Organization/Organization-1437493467"}}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"The id is not a valid FHIR id, or a query parameter was sent: a read takes none. Ids come from search results; they are not constructed from an NPI or any other identifier.","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"},"404":{"description":"No such resource, or no such interaction on this base.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"406":{"$ref":"#/components/responses/FhirNotAcceptable"},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"502":{"description":"The directory could not be reached, answered in a shape that cannot be served, or answered with more than is served at once: a `_revinclude` past the directory's 100 records on a page, or an answer over 8 MiB. No answer is given: this is never reported as an empty result, which would read as 'no such provider'.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"The directory is rate limiting requests. Send the request again after `Retry-After`. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The directory did not respond in time.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}}}},"/v1/fhir/r4/Endpoint":{"get":{"tags":["Provider directory"],"summary":"Find endpoints","description":"Search `Endpoint` by managing organization; `connection-type`, `status` and `name` narrow a search but cannot stand alone.","operationId":"searchEndpoint","parameters":[{"name":"organization","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":256},"description":"The endpoints one organization manages. Give a Organization id, `Organization/{id}`, or the `fullUrl` this service returned. An address on another server is refused.","example":"Organization-1326655846"},{"name":"connection-type","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":256},"description":"A connection type from `http://terminology.hl7.org/CodeSystem/endpoint-connection-type`, bare or with that system: for example `hl7-fhir-rest` or `direct-project`. Narrows a search; cannot be used on its own."},{"name":"status","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":256},"description":"`active`, `suspended`, `error`, `off`, `entered-in-error` or `test`. Narrows a search; cannot be used on its own."},{"name":"name","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":100},"description":"Matches the endpoint's name. Narrows a search; cannot be used on its own, because most of the directory's endpoints share one name."},{"name":"_include","in":"query","required":false,"schema":{"minItems":1,"maxItems":16,"type":"array","items":{"type":"string","enum":["Endpoint:organization"]}},"style":"form","explode":true,"description":"`Endpoint:organization` brings the organization that manages each endpoint. Repeat the parameter to include several. Included entries do not count toward `_count`."},{"name":"_id","in":"query","required":false,"schema":{"type":"string","pattern":"^[A-Za-z0-9\\-.]{1,64}$"},"description":"A Endpoint id. Searching by id rather than reading it lets one request also bring the records an `_include` or `_revinclude` names."},{"name":"_summary","in":"query","required":false,"schema":{"type":"string","enum":["count"]},"description":"`count` only: answers how many records match, as `total`, with no entries. Cannot be combined with `_include`, `_revinclude`, `_count` or `page`."},{"name":"_count","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"Results are paged. `_count` sets the page size (1 to 100); a larger value is refused rather than quietly reduced. Follow `link` with relation `next` to continue. The cursor it carries is opaque and must not be constructed or modified.","example":2},{"name":"page","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":8192},"description":"Continuation cursor. Opaque: follow the `next` link from a previous response, and never construct or modify it. Cursors expire."},{"$ref":"#/components/parameters/XRequestId"}],"responses":{"200":{"description":"A FHIR `Bundle` with `type: searchset`. `total` is present when the directory sends one.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Bundle"},"examples":{"An organization's endpoints":{"summary":"An organization's endpoints","value":{"resourceType":"Bundle","type":"searchset","link":[{"relation":"self","url":"https://api.haau3.com/v1/fhir/r4/Endpoint?organization=Organization-1326655846&_count=2"}],"entry":[{"fullUrl":"https://api.haau3.com/v1/fhir/r4/Endpoint/Endpoint-000508b0-e3f0-4108-8d1d-a610f0675358","resource":{"resourceType":"Endpoint","id":"Endpoint-000508b0-e3f0-4108-8d1d-a610f0675358","meta":{"versionId":"1","lastUpdated":"2026-10-14T21:06:26.920943075Z","profile":["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Endpoint"]},"extension":[{"url":"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/us/ndh/CodeSystem/NdhVerificationStatusCS","code":"complete","display":"Complete"}]}}],"status":"active","connectionType":{"system":"http://terminology.hl7.org/CodeSystem/endpoint-connection-type","code":"hl7-fhir-rest","display":"HL7 FHIR"},"managingOrganization":{"reference":"Organization/Organization-1326655846"},"payloadType":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/data-absent-reason","version":"1.0.0","code":"not-applicable"}]}],"address":"https://api.platform.athenahealth.com/22363/brand/1/csg/1/fhir/r4"},"search":{"mode":"match"}}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"The request named a parameter, identifier system or value this service does not serve. Every unsupported parameter is refused by name, and none is silently ignored, so a search that returns results applied every filter you 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"},"404":{"description":"No such resource, or no such interaction on this base.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"406":{"$ref":"#/components/responses/FhirNotAcceptable"},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"502":{"description":"The directory could not be reached, answered in a shape that cannot be served, or answered with more than is served at once: a `_revinclude` past the directory's 100 records on a page, or an answer over 8 MiB. No answer is given: this is never reported as an empty result, which would read as 'no such provider'.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"The directory is rate limiting requests. Send the request again after `Retry-After`. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The directory did not respond in time.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}}}},"/v1/fhir/r4/Endpoint/{id}":{"get":{"tags":["Provider directory"],"summary":"Read an Endpoint","description":"Read one endpoint by id, as returned by a search on this service.","operationId":"readEndpoint","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9\\-.]{1,64}$"},"description":"The resource id, as returned by a search on this service. Ids are opaque: they are not constructed from an NPI or any other identifier.","example":"Endpoint-000508b0-e3f0-4108-8d1d-a610f0675358"},{"$ref":"#/components/parameters/XRequestId"}],"responses":{"200":{"description":"The Endpoint, as the directory publishes it.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Endpoint"},"examples":{"An endpoint":{"summary":"An endpoint","value":{"resourceType":"Endpoint","id":"Endpoint-000508b0-e3f0-4108-8d1d-a610f0675358","meta":{"lastUpdated":"2026-10-14T21:06:26.920943075Z","profile":["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Endpoint"],"versionId":"1"},"extension":[{"url":"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/us/ndh/CodeSystem/NdhVerificationStatusCS","code":"complete","display":"Complete"}]}}],"status":"active","connectionType":{"system":"http://terminology.hl7.org/CodeSystem/endpoint-connection-type","code":"hl7-fhir-rest","display":"HL7 FHIR"},"managingOrganization":{"reference":"Organization/Organization-1326655846"},"address":"https://api.platform.athenahealth.com/22363/brand/1/csg/1/fhir/r4","payloadType":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/data-absent-reason","version":"1.0.0","code":"not-applicable"}]}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"The id is not a valid FHIR id, or a query parameter was sent: a read takes none. Ids come from search results; they are not constructed from an NPI or any other identifier.","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"},"404":{"description":"No such resource, or no such interaction on this base.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"406":{"$ref":"#/components/responses/FhirNotAcceptable"},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"502":{"description":"The directory could not be reached, answered in a shape that cannot be served, or answered with more than is served at once: a `_revinclude` past the directory's 100 records on a page, or an answer over 8 MiB. No answer is given: this is never reported as an empty result, which would read as 'no such provider'.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"The directory is rate limiting requests. Send the request again after `Retry-After`. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The directory did not respond in time.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}}}},"/v1/fhir/r4/Questionnaire":{"get":{"tags":["Questionnaires"],"summary":"List or find a questionnaire","description":"With no parameters, this lists the questionnaires this service holds copies of. Those render the same way on every request, and that list is what you can rely on.\n\nNaming a canonical `url` reaches any questionnaire the source publishes, including ones this service holds no copy of. Those depend on the source being reachable, and when it cannot answer you get a `502`, `503` or `504` carrying an `OperationOutcome`, so a failure never arrives looking like an empty result.\n\nA canonical that is the address of a form published at its own address, under `https://smart-health-checkin.org/connectathon/Questionnaire/` or another place this service is set up to reach, is fetched from that address and served exactly as published, its entry's `fullUrl` the address it was fetched from. Any other canonical matches nothing.\n\nTwo parameters are offered: `url` (the canonical, optionally as `{url}|{version}`) and `version`. Every other parameter, `status` included, is refused by name rather than ignored, so a search never quietly answers a different question than the one asked. Results are never paged: one page, with `total` set.\n\nQuestionnaires are served exactly as their source publishes them. Each carries its own `copyright`, which must be kept with the form wherever it goes.","operationId":"searchQuestionnaire","parameters":[{"name":"url","in":"query","required":false,"description":"Exact match on the canonical URL, for example `http://loinc.org/q/44249-1`. The `{url}|{version}` form is accepted and matches that version only, and never answers a different version than the one asked for. A canonical this service holds a copy of is answered from that copy at every version; any other LOINC canonical is fetched from LOINC, where a version names a release of its catalogue. A canonical that is the address of a form under a place this service is set up to reach is fetched from that address; any other canonical matches nothing.","schema":{"type":"string"},"example":"http://loinc.org/q/44249-1"},{"name":"version","in":"query","required":false,"description":"Exact match on the business version. On its own it filters the copies this service holds; with `url` it names the release to fetch.","schema":{"type":"string"}},{"$ref":"#/components/parameters/XRequestId"}],"responses":{"200":{"description":"A `searchset` Bundle with `total` set. Every match is in this one page.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Bundle"},"examples":{"The PHQ-9 by its canonical URL":{"summary":"The PHQ-9 by its canonical URL","value":{"resourceType":"Bundle","type":"searchset","total":1,"link":[{"relation":"self","url":"https://api.haau3.com/v1/fhir/r4/Questionnaire?url=http%3A%2F%2Floinc.org%2Fq%2F44249-1"}],"entry":[{"fullUrl":"https://api.haau3.com/v1/fhir/r4/Questionnaire/44249-1","resource":{"resourceType":"Questionnaire","id":"44249-1","meta":{"lastUpdated":"2026-08-19T00:00:00+00:00"},"url":"http://loinc.org/q/44249-1","version":"2.83","name":"PHQ_quick_depression_assessment_panel","title":"PHQ-9 quick depression assessment panel","status":"draft","subjectType":["Patient"],"publisher":"Regenstrief Institute, Inc.","contact":[{"name":"Regenstrief Institute, Inc.","telecom":[{"system":"url","value":"http://loinc.org"}]}],"description":"PHQ-9 quick depression assessment panel [Reported.PHQ]","copyright":"This material contains content from LOINC (http://loinc.org). LOINC is copyright Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license at http://loinc.org/license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc.\r\nCopyright © Pfizer Inc. All rights reserved. Developed by Drs. Robert L. Spitzer, Janet B.W. Williams, Kurt Kroenke and colleagues, with an educational grant from Pfizer Inc. No permission required to reproduce, translate, display or distribute.","code":[{"system":"http://loinc.org","code":"44249-1","display":"PHQ-9 quick depression assessment panel"}],"item":[{"linkId":"14363","code":[{"system":"http://loinc.org","code":"44250-9","display":"Little interest or pleasure in doing things"}],"prefix":"PHQ-9.1","text":"Little interest or pleasure in doing things","type":"choice","required":true,"repeats":false,"answerOption":[{"valueCoding":{"system":"http://loinc.org","code":"LA6569-3","display":"Several days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6570-1","display":"More than half the days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6568-5","display":"Not at all"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6571-9","display":"Nearly every day"}}]},{"linkId":"14364","code":[{"system":"http://loinc.org","code":"44255-8","display":"Feeling down, depressed, or hopeless"}],"prefix":"PHQ-9.2","text":"Feeling down, depressed, or hopeless","type":"choice","required":true,"repeats":false,"answerOption":[{"valueCoding":{"system":"http://loinc.org","code":"LA6569-3","display":"Several days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6570-1","display":"More than half the days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6568-5","display":"Not at all"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6571-9","display":"Nearly every day"}}]},{"linkId":"14365","code":[{"system":"http://loinc.org","code":"44259-0","display":"Trouble falling or staying asleep, or sleeping too much"}],"text":"Trouble falling or staying asleep, or sleeping too much","type":"choice","required":true,"repeats":false,"answerOption":[{"valueCoding":{"system":"http://loinc.org","code":"LA6569-3","display":"Several days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6570-1","display":"More than half the days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6568-5","display":"Not at all"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6571-9","display":"Nearly every day"}}]},{"linkId":"14366","code":[{"system":"http://loinc.org","code":"44254-1","display":"Feeling tired or having little energy"}],"text":"Feeling tired or having little energy","type":"choice","required":true,"repeats":false,"answerOption":[{"valueCoding":{"system":"http://loinc.org","code":"LA6569-3","display":"Several days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6570-1","display":"More than half the days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6568-5","display":"Not at all"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6571-9","display":"Nearly every day"}}]},{"linkId":"14367","code":[{"system":"http://loinc.org","code":"44251-7","display":"Poor appetite or overeating"}],"text":"Poor appetite or overeating","type":"choice","required":true,"repeats":false,"answerOption":[{"valueCoding":{"system":"http://loinc.org","code":"LA6569-3","display":"Several days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6570-1","display":"More than half the days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6568-5","display":"Not at all"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6571-9","display":"Nearly every day"}}]},{"linkId":"14368","code":[{"system":"http://loinc.org","code":"44258-2","display":"Feeling bad about yourself-or that you are a failure or have let yourself or your family down"}],"text":"Feeling bad about yourself-or that you are a failure or have let yourself or your family down","type":"choice","required":true,"repeats":false,"answerOption":[{"valueCoding":{"system":"http://loinc.org","code":"LA6569-3","display":"Several days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6570-1","display":"More than half the days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6568-5","display":"Not at all"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6571-9","display":"Nearly every day"}}]},{"linkId":"14369","code":[{"system":"http://loinc.org","code":"44252-5","display":"Trouble concentrating on things, such as reading the newspaper or watching television"}],"text":"Trouble concentrating on things, such as reading the newspaper or watching television","type":"choice","required":true,"repeats":false,"answerOption":[{"valueCoding":{"system":"http://loinc.org","code":"LA6569-3","display":"Several days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6570-1","display":"More than half the days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6568-5","display":"Not at all"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6571-9","display":"Nearly every day"}}]},{"linkId":"14370","code":[{"system":"http://loinc.org","code":"44253-3","display":"Moving or speaking so slowly that other people could have noticed. Or the opposite – being so fidgety or restless that you were moving around a lot more than usual"}],"text":"Moving or speaking so slowly that other people could have noticed. Or the opposite – being so fidgety or restless that you were moving around a lot more than usual","type":"choice","required":true,"repeats":false,"answerOption":[{"valueCoding":{"system":"http://loinc.org","code":"LA6569-3","display":"Several days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6570-1","display":"More than half the days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6568-5","display":"Not at all"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6571-9","display":"Nearly every day"}}]},{"linkId":"14371","code":[{"system":"http://loinc.org","code":"44260-8","display":"Thoughts that you would be better off dead, or of hurting yourself in some way"}],"text":"Thoughts that you would be better off dead, or of hurting yourself in some way","type":"choice","repeats":false,"answerOption":[{"valueCoding":{"system":"http://loinc.org","code":"LA6569-3","display":"Several days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6570-1","display":"More than half the days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6568-5","display":"Not at all"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6571-9","display":"Nearly every day"}}]},{"linkId":"57492","code":[{"system":"http://loinc.org","code":"69722-7","display":"How difficult have these problems made it for you to do your work, take care of things at home, or get along with other people?"}],"text":"How difficult have these problems made it for you to do your work, take care of things at home, or get along with other people?","type":"choice","repeats":false,"answerOption":[{"valueCoding":{"system":"http://loinc.org","code":"LA6572-7","display":"Not difficult at all"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6573-5","display":"Somewhat difficult"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6574-3","display":"Extremely difficult"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6575-0","display":"Very difficult"}}]},{"linkId":"14372","text":"Patient health questionnaire 9 item total score","type":"decimal"}]},"search":{"mode":"match"}}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"A parameter this service does not serve, a repeated parameter, or a comma-separated list of values. One issue per offending parameter, naming it.","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"},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"502":{"description":"The source could not be reached, or answered with something this service will not pass on. Never returned for a questionnaire this service holds a copy of.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"The source is throttling requests (with `Retry-After`), or is not configured on this deployment. Never returned for a questionnaire this service holds a copy of. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The source did not answer in time. Never returned for a questionnaire this service holds a copy of.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}}}},"/v1/fhir/r4/Questionnaire/{id}":{"get":{"tags":["Questionnaires"],"summary":"Read a questionnaire","description":"Read one questionnaire by id. Ids are the identifier its source gives the instrument, for example `44249-1`. A search with no parameters lists the ids this service holds copies of; any other id its source publishes is fetched live.\n\nThe resource is returned exactly as its source publishes it, including its `copyright` and the order of every answer option.","operationId":"readQuestionnaire","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9\\-.]{1,64}$"},"description":"The questionnaire id, as listed by a search on this service.","example":"44249-1"},{"$ref":"#/components/parameters/XRequestId"}],"responses":{"200":{"description":"The `Questionnaire`, as its source publishes it.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Questionnaire"},"examples":{"The PHQ-9":{"summary":"The PHQ-9","value":{"resourceType":"Questionnaire","id":"44249-1","meta":{"lastUpdated":"2026-08-19T00:00:00+00:00"},"url":"http://loinc.org/q/44249-1","version":"2.83","name":"PHQ_quick_depression_assessment_panel","title":"PHQ-9 quick depression assessment panel","status":"draft","subjectType":["Patient"],"publisher":"Regenstrief Institute, Inc.","contact":[{"name":"Regenstrief Institute, Inc.","telecom":[{"system":"url","value":"http://loinc.org"}]}],"description":"PHQ-9 quick depression assessment panel [Reported.PHQ]","copyright":"This material contains content from LOINC (http://loinc.org). LOINC is copyright Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license at http://loinc.org/license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc.\r\nCopyright © Pfizer Inc. All rights reserved. Developed by Drs. Robert L. Spitzer, Janet B.W. Williams, Kurt Kroenke and colleagues, with an educational grant from Pfizer Inc. No permission required to reproduce, translate, display or distribute.","code":[{"system":"http://loinc.org","code":"44249-1","display":"PHQ-9 quick depression assessment panel"}],"item":[{"linkId":"14363","code":[{"system":"http://loinc.org","code":"44250-9","display":"Little interest or pleasure in doing things"}],"prefix":"PHQ-9.1","text":"Little interest or pleasure in doing things","type":"choice","required":true,"repeats":false,"answerOption":[{"valueCoding":{"system":"http://loinc.org","code":"LA6569-3","display":"Several days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6570-1","display":"More than half the days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6568-5","display":"Not at all"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6571-9","display":"Nearly every day"}}]},{"linkId":"14364","code":[{"system":"http://loinc.org","code":"44255-8","display":"Feeling down, depressed, or hopeless"}],"prefix":"PHQ-9.2","text":"Feeling down, depressed, or hopeless","type":"choice","required":true,"repeats":false,"answerOption":[{"valueCoding":{"system":"http://loinc.org","code":"LA6569-3","display":"Several days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6570-1","display":"More than half the days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6568-5","display":"Not at all"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6571-9","display":"Nearly every day"}}]},{"linkId":"14365","code":[{"system":"http://loinc.org","code":"44259-0","display":"Trouble falling or staying asleep, or sleeping too much"}],"text":"Trouble falling or staying asleep, or sleeping too much","type":"choice","required":true,"repeats":false,"answerOption":[{"valueCoding":{"system":"http://loinc.org","code":"LA6569-3","display":"Several days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6570-1","display":"More than half the days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6568-5","display":"Not at all"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6571-9","display":"Nearly every day"}}]},{"linkId":"14366","code":[{"system":"http://loinc.org","code":"44254-1","display":"Feeling tired or having little energy"}],"text":"Feeling tired or having little energy","type":"choice","required":true,"repeats":false,"answerOption":[{"valueCoding":{"system":"http://loinc.org","code":"LA6569-3","display":"Several days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6570-1","display":"More than half the days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6568-5","display":"Not at all"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6571-9","display":"Nearly every day"}}]},{"linkId":"14367","code":[{"system":"http://loinc.org","code":"44251-7","display":"Poor appetite or overeating"}],"text":"Poor appetite or overeating","type":"choice","required":true,"repeats":false,"answerOption":[{"valueCoding":{"system":"http://loinc.org","code":"LA6569-3","display":"Several days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6570-1","display":"More than half the days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6568-5","display":"Not at all"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6571-9","display":"Nearly every day"}}]},{"linkId":"14368","code":[{"system":"http://loinc.org","code":"44258-2","display":"Feeling bad about yourself-or that you are a failure or have let yourself or your family down"}],"text":"Feeling bad about yourself-or that you are a failure or have let yourself or your family down","type":"choice","required":true,"repeats":false,"answerOption":[{"valueCoding":{"system":"http://loinc.org","code":"LA6569-3","display":"Several days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6570-1","display":"More than half the days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6568-5","display":"Not at all"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6571-9","display":"Nearly every day"}}]},{"linkId":"14369","code":[{"system":"http://loinc.org","code":"44252-5","display":"Trouble concentrating on things, such as reading the newspaper or watching television"}],"text":"Trouble concentrating on things, such as reading the newspaper or watching television","type":"choice","required":true,"repeats":false,"answerOption":[{"valueCoding":{"system":"http://loinc.org","code":"LA6569-3","display":"Several days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6570-1","display":"More than half the days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6568-5","display":"Not at all"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6571-9","display":"Nearly every day"}}]},{"linkId":"14370","code":[{"system":"http://loinc.org","code":"44253-3","display":"Moving or speaking so slowly that other people could have noticed. Or the opposite – being so fidgety or restless that you were moving around a lot more than usual"}],"text":"Moving or speaking so slowly that other people could have noticed. Or the opposite – being so fidgety or restless that you were moving around a lot more than usual","type":"choice","required":true,"repeats":false,"answerOption":[{"valueCoding":{"system":"http://loinc.org","code":"LA6569-3","display":"Several days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6570-1","display":"More than half the days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6568-5","display":"Not at all"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6571-9","display":"Nearly every day"}}]},{"linkId":"14371","code":[{"system":"http://loinc.org","code":"44260-8","display":"Thoughts that you would be better off dead, or of hurting yourself in some way"}],"text":"Thoughts that you would be better off dead, or of hurting yourself in some way","type":"choice","repeats":false,"answerOption":[{"valueCoding":{"system":"http://loinc.org","code":"LA6569-3","display":"Several days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6570-1","display":"More than half the days"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6568-5","display":"Not at all"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6571-9","display":"Nearly every day"}}]},{"linkId":"57492","code":[{"system":"http://loinc.org","code":"69722-7","display":"How difficult have these problems made it for you to do your work, take care of things at home, or get along with other people?"}],"text":"How difficult have these problems made it for you to do your work, take care of things at home, or get along with other people?","type":"choice","repeats":false,"answerOption":[{"valueCoding":{"system":"http://loinc.org","code":"LA6572-7","display":"Not difficult at all"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6573-5","display":"Somewhat difficult"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6574-3","display":"Extremely difficult"}},{"valueCoding":{"system":"http://loinc.org","code":"LA6575-0","display":"Very difficult"}}]},{"linkId":"14372","text":"Patient health questionnaire 9 item total score","type":"decimal"}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"The id is not a valid FHIR id, or a query parameter was sent: a read takes none.","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"},"404":{"description":"Neither this service nor its source publishes a questionnaire with that id.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"406":{"$ref":"#/components/responses/FhirNotAcceptable"},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"502":{"description":"The source could not be reached, or answered with something this service will not pass on. Never returned for a questionnaire this service holds a copy of.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"The source is throttling requests (with `Retry-After`), or is not configured on this deployment. Never returned for a questionnaire this service holds a copy of. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The source did not answer in time. Never returned for a questionnaire this service holds a copy of.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}}}},"/v1/fhir/r4/InsurancePlan":{"get":{"tags":["Plan Benefits"],"summary":"Find a plan","description":"Search the Medicare Advantage and ACA Marketplace plans being served, by identifier, name, or the state or county a plan is sold in. A search needs at least one of `identifier`, a form of `name`, `coverage-area-state` or `coverage-area-county`; `type` and `sold-to` narrow a search but are not one. Every result is the whole plan, sorted by name and then id, and every page states the total. Follow the `next` link to continue.\n\nA plan sold in only part of a county matches the whole county. `GET /v1/fhir/r4/InsurancePlan/$counties?state=FL` lists a state's counties and their codes.\n\nEvery other parameter is refused by name rather than ignored, so a search never quietly answers a different question than the one asked. `address-state` and `address-postalcode` are refused with a pointer to the coverage-area parameters, because in FHIR R4 they search a plan's contact address.\n\nDrug-only and dental-only plans are not served. An identifier search that finds one answers no plan and an `OperationOutcome` entry saying why.","operationId":"searchInsurancePlan","parameters":[{"name":"identifier","in":"query","required":false,"description":"A plan id, as `value` or `system|value`. A Medicare Advantage plan by CMS's plan id (`http://cms.gov/medicare/ma-plan-id`, the segment in three digits: `H2406-013-000`) or its bid_id (`https://haau3.com/fhir/NamingSystem/cms-ma-bid-id`: `H2406_013_0`). A Marketplace plan by its HIOS plan id (`https://haau3.com/fhir/NamingSystem/hios-plan-id`: `19898FL0340001-01`) or its standard component (`https://haau3.com/fhir/NamingSystem/hios-standard-component-id`: `19898FL0340001`), which finds every variant.","schema":{"type":"string"},"example":"H2406-013-000"},{"name":"name","in":"query","required":false,"description":"The start of the plan's name, ignoring case and accents. `name:contains` matches anywhere in the name and `name:exact` the whole name exactly; give one form.","schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"name:contains","in":"query","required":false,"description":"Part of the plan's name, anywhere in it, ignoring case and accents.","schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"name:exact","in":"query","required":false,"description":"The plan's whole name, exactly.","schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"coverage-area-state","in":"query","required":false,"description":"A two-letter state code: the plans sold in that state. Defined by the haau3 implementation guide (`https://haau3.com/fhir/SearchParameter/InsurancePlan-coverage-area-state`).","schema":{"type":"string","pattern":"^[A-Za-z]{2}$"}},{"name":"coverage-area-county","in":"query","required":false,"description":"A five-digit FIPS state and county code (`12086`, Miami-Dade County, Florida), bare or as `http://terminology.hl7.org/CodeSystem/FIPS64|12086`: the plans sold in that county, in whole or in part. A code that names no county is refused. Defined by the haau3 implementation guide (`https://haau3.com/fhir/SearchParameter/InsurancePlan-coverage-area-county`).","schema":{"type":"string"}},{"name":"type","in":"query","required":false,"description":"`mediadv` for Medicare Advantage or `qhp` for the Marketplace, from `http://terminology.hl7.org/CodeSystem/insurance-product-type`.","schema":{"type":"string"}},{"name":"sold-to","in":"query","required":false,"description":"`individuals` for the plans a person can buy on their own, or `employer-groups` for the plans sold only to employer and union groups (Medicare Advantage) or to small employers (Marketplace SHOP plans). Narrows a search; it is not one by itself. Defined by the haau3 implementation guide (`https://haau3.com/fhir/SearchParameter/InsurancePlan-sold-to`).","schema":{"type":"string","enum":["individuals","employer-groups"]}},{"name":"_count","in":"query","required":false,"description":"Page size. A larger value is refused rather than quietly reduced.","schema":{"default":10,"type":"integer","minimum":1,"maximum":50}},{"name":"page","in":"query","required":false,"description":"The cursor a `next` link carries. It is opaque and belongs to one search; once the plans are updated a later page answers `410`, so start the search again.","schema":{"type":"string"}},{"$ref":"#/components/parameters/XRequestId"}],"responses":{"200":{"description":"A `searchset` Bundle with `total` set.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Bundle"},"examples":{"A plan by its CMS plan id":{"summary":"A plan by its CMS plan id","value":{"resourceType":"Bundle","type":"searchset","total":1,"link":[{"relation":"self","url":"https://api.haau3.com/v1/fhir/r4/InsurancePlan?identifier=H2406-013-000"}],"entry":[{"fullUrl":"https://api.haau3.com/v1/fhir/r4/InsurancePlan/H2406-013-000","resource":{"resourceType":"InsurancePlan","id":"H2406-013-000","meta":{"profile":["https://haau3.com/fhir/StructureDefinition/haau3-insurance-plan","http://hl7.org/fhir/us/insurance-card/StructureDefinition/sbc-insurance-plan|2.0.0-ballot"]},"contained":[{"resourceType":"Organization","id":"issuer","identifier":[{"type":{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/payor-identifier-types-cs","code":"cms-contract-id","display":"CMS Contract ID"}]},"system":"https://haau3.com/fhir/NamingSystem/cms-ma-contract-id","value":"H2406"}],"name":"UnitedHealthcare","alias":["CARE IMPROVEMENT PLUS SOUTH CENTRAL INSURANCE CO."]},{"resourceType":"Location","id":"state-FL","physicalType":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/location-physical-type","code":"jdn","display":"Jurisdiction"}]},"address":{"state":"FL"}}],"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-source-release","extension":[{"url":"release","valueString":"ma-2027-2026-10-01"},{"url":"file","extension":[{"url":"downloadUrl","valueUri":"https://www.cms.gov/files/zip/pbp-benefits-2027.zip"},{"url":"lastModified","valueDate":"2026-10-01"},{"url":"sha256","valueString":"6d8430e2ecb51acf3cc8547f12dd73506aa73f0dccf034cc3c3393868576ff47"}]}]},{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-plan-facts","extension":[{"url":"specialNeeds","valueBoolean":false},{"url":"employerOnly","valueBoolean":false},{"url":"partBOnly","valueBoolean":false},{"url":"filesCostData","valueBoolean":true},{"url":"outOfNetworkBenefit","valueBoolean":true},{"url":"pointOfService","valueBoolean":false}]}],"identifier":[{"system":"http://cms.gov/medicare/ma-plan-id","value":"H2406-013-000"},{"system":"https://haau3.com/fhir/NamingSystem/cms-ma-bid-id","value":"H2406_013_0"}],"type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/insurance-product-type","code":"mediadv","display":"Medicare Advantage"}]}],"status":"active","name":"AARP Medicare Advantage from UHC FL-0021 (PPO)","period":{"start":"2027","end":"2027"},"ownedBy":{"reference":"#issuer","display":"UnitedHealthcare"},"contact":[{"purpose":{"text":"General Questions"},"telecom":[{"system":"phone","value":"(866)627-7806"},{"system":"url","value":"AARPMedicarePlans.com"}]},{"purpose":{"text":"Provider directory"},"telecom":[{"system":"url","value":"AARPMedicarePlans.com"}]}],"coverageArea":[{"reference":"#state-FL"}],"coverage":[{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ActCode","code":"HIP","display":"health insurance plan policy"}]},"benefit":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"primary-care-visit","display":"Primary Care Visit"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"7a","display":"Primary Care Physician Services"}]}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"specialist-visit","display":"Specialist Visit"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"7d","display":"Physician Specialist Services"}]}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"urgent-care","display":"Urgent Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"4b","display":"Urgently Needed Services"}]}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"emergency-room-care","display":"Emergency Room Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"4a","display":"Emergency Services"}]}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"hospital-inpatient","display":"Hospital Inpatient Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"1a","display":"Inpatient Hospital-Acute"}]}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"hospital-outpatient","display":"Hospital Outpatient Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"9a1","display":"Outpatient Hospital Services"}]}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"facility-fee","display":"Facility Fee"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"9b","display":"Ambulatory Surgical Center (ASC) Services"}]}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"imaging","display":"Imaging (CT/PET/MRI)"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"8b1","display":"Diagnostic Radiological Services"}]}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"rehabilitation","display":"Rehabilitation Services"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"7i","display":"Physical Therapy and Speech-Language Pathology Services"}]}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"mental-health-outpatient","display":"Mental/Behavioral Health Outpatient Services"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"7e1","display":"Individual Sessions for Mental Health Specialty Services"}]}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"emergency-medical-transport","display":"Emergency Medical Transportation"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"10a1","display":"Ground Ambulance Services"}]}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"skilled-nursing","display":"Skilled Nursing Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"2","display":"Skilled Nursing Facility (SNF)"}]}}]}],"plan":[{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-additional-benefit","extension":[{"url":"category","valueCodeableConcept":{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"8a2","display":"Lab Services"}]}},{"url":"cost","extension":[{"url":"type","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"}},{"url":"applicability","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]}},{"url":"amount","valueQuantity":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}]},{"url":"cost","extension":[{"url":"type","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"}},{"url":"applicability","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]}},{"url":"amount","valueQuantity":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}]}]},{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-additional-benefit","extension":[{"url":"category","valueCodeableConcept":{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"9a2","display":"Observation Services"}]}},{"url":"cost","extension":[{"url":"type","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"}},{"url":"applicability","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]}},{"url":"qualifier","valueCodeableConcept":{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier","code":"per-day","display":"Per day"}]}},{"url":"amount","valueQuantity":{"value":550,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}]},{"url":"cost","extension":[{"url":"type","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay-percent","display":"Copayment Percent per service"}],"text":"Coinsurance"}},{"url":"applicability","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]}},{"url":"amount","valueQuantity":{"value":40,"code":"%","system":"http://unitsofmeasure.org","unit":"%"}}]}]},{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-additional-benefit","extension":[{"url":"category","valueCodeableConcept":{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"6","display":"Home Health Services"}]}},{"url":"cost","extension":[{"url":"type","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"}},{"url":"applicability","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]}},{"url":"amount","valueQuantity":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}]},{"url":"cost","extension":[{"url":"type","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay-percent","display":"Copayment Percent per service"}],"text":"Coinsurance"}},{"url":"applicability","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]}},{"url":"amount","valueQuantity":{"value":50,"code":"%","system":"http://unitsofmeasure.org","unit":"%"}}]}]}],"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-plan-type","code":"PPO","display":"Preferred Provider Organization (PPO)"}],"text":"Local PPO"},"coverageArea":[{"reference":"#state-FL"}],"generalCost":[{"type":{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-general-cost-type","code":"monthly-premium","display":"Monthly premium"}],"text":"Monthly premium"},"cost":{"value":0,"currency":"USD"}},{"type":{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-general-cost-type","code":"part-b-premium-reduction","display":"Part B premium reduction"}],"text":"Part B premium reduction"},"comment":"None"},{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-scope","extension":[{"url":"network","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/benefit-network","code":"out","display":"Out of Network"}},{"url":"member","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/benefit-unit","code":"individual","display":"Individual"}},{"url":"appliesTo","valueCoding":{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-scope","code":"medical","display":"Medical"}}]}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/coverage-copay-type","code":"deductible","display":"Deductible"}],"text":"Individual Deductible"},"cost":{"value":1000,"currency":"USD"},"comment":"Out of network, for medical care"},{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-scope","extension":[{"url":"network","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/benefit-network","code":"in","display":"In Network"}},{"url":"member","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/benefit-unit","code":"individual","display":"Individual"}},{"url":"appliesTo","valueCoding":{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-scope","code":"medical","display":"Medical"}}]}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/coverage-copay-type","code":"maxoutofpocket","display":"Maximum out of pocket"}],"text":"Individual Out-of-Pocket Maximum"},"cost":{"value":7150,"currency":"USD"},"comment":"In network, for medical care"},{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-scope","extension":[{"url":"network","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/benefit-network","code":"out","display":"Out of Network"}},{"url":"member","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/benefit-unit","code":"individual","display":"Individual"}},{"url":"appliesTo","valueCoding":{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-scope","code":"medical","display":"Medical"}}]}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/coverage-copay-type","code":"maxoutofpocket","display":"Maximum out of pocket"}],"text":"Individual Out-of-Pocket Maximum"},"comment":"Out of network, for medical care: none"},{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-scope","extension":[{"url":"network","valueCoding":{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-scope","code":"combined","display":"In and out of network combined"}},{"url":"member","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/benefit-unit","code":"individual","display":"Individual"}},{"url":"appliesTo","valueCoding":{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-scope","code":"medical","display":"Medical"}}]}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/coverage-copay-type","code":"maxoutofpocket","display":"Maximum out of pocket"}],"text":"Individual Out-of-Pocket Maximum"},"cost":{"value":10750,"currency":"USD"},"comment":"In and out of network combined, for medical care"}],"specificCost":[{"category":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"primary-care-visit","display":"Primary Care Visit"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"7a","display":"Primary Care Physician Services"}]},"benefit":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"primary-care-visit","display":"Primary Care Visit"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"7a","display":"Primary Care Physician Services"}]},"cost":[{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}},{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]},"value":{"value":45,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}]}]},{"category":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"specialist-visit","display":"Specialist Visit"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"7d","display":"Physician Specialist Services"}]},"benefit":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"specialist-visit","display":"Specialist Visit"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"7d","display":"Physician Specialist Services"}]},"cost":[{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-range","valueRange":{"low":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"},"high":{"value":65,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":65,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD","comparator":"<="}},{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]},"value":{"value":100,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}]}]},{"category":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"urgent-care","display":"Urgent Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"4b","display":"Urgently Needed Services"}]},"benefit":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"urgent-care","display":"Urgent Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"4b","display":"Urgently Needed Services"}]},"cost":[{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-range","valueRange":{"low":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"},"high":{"value":50,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"qualifiers":[{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier","code":"one-price-both-networks","display":"One price in and out of network"}]}],"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":50,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD","comparator":"<="}},{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-range","valueRange":{"low":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"},"high":{"value":50,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"qualifiers":[{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier","code":"one-price-both-networks","display":"One price in and out of network"}]}],"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]},"value":{"value":50,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD","comparator":"<="}}]}]},{"category":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"emergency-room-care","display":"Emergency Room Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"4a","display":"Emergency Services"}]},"benefit":[{"extension":[{"url":"http://hl7.org/fhir/us/insurance-card/StructureDefinition/benefit-limitation","extension":[{"url":"limitText","valueString":"Copay waived if admitted to the hospital within 24 hours"}]}],"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"emergency-room-care","display":"Emergency Room Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"4a","display":"Emergency Services"}]},"cost":[{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"qualifiers":[{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier","code":"one-price-both-networks","display":"One price in and out of network"}]}],"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":130,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}},{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"qualifiers":[{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier","code":"one-price-both-networks","display":"One price in and out of network"}]}],"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]},"value":{"value":130,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}]}]},{"category":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"hospital-inpatient","display":"Hospital Inpatient Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"1a","display":"Inpatient Hospital-Acute"}]},"benefit":[{"extension":[{"url":"http://hl7.org/fhir/us/insurance-card/StructureDefinition/benefit-limitation","extension":[{"url":"limitText","valueString":"Benefit period (in network): Per Admission or Per Stay"}]}],"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"hospital-inpatient","display":"Hospital Inpatient Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"1a","display":"Inpatient Hospital-Acute"}]},"cost":[{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-day-range","valueRange":{"low":{"value":1,"code":"d","system":"http://unitsofmeasure.org","unit":"d"},"high":{"value":5,"code":"d","system":"http://unitsofmeasure.org","unit":"d"}}}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"qualifiers":[{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier","code":"per-day","display":"Per day"}]}],"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":550,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}},{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-day-range","valueRange":{"low":{"value":6,"code":"d","system":"http://unitsofmeasure.org","unit":"d"},"high":{"value":90,"code":"d","system":"http://unitsofmeasure.org","unit":"d"}}}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"qualifiers":[{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier","code":"per-day","display":"Per day"}]}],"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}},{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"qualifiers":[{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier","code":"per-stay","display":"Per stay"}]}],"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}},{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay-percent","display":"Copayment Percent per service"}],"text":"Coinsurance"},"qualifiers":[{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier","code":"per-stay","display":"Per stay"}]}],"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]},"value":{"value":40,"code":"%","system":"http://unitsofmeasure.org","unit":"%"}}]}]},{"category":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"hospital-outpatient","display":"Hospital Outpatient Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"9a1","display":"Outpatient Hospital Services"}]},"benefit":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"hospital-outpatient","display":"Hospital Outpatient Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"9a1","display":"Outpatient Hospital Services"}]},"cost":[{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-range","valueRange":{"low":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"},"high":{"value":550,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":550,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD","comparator":"<="}},{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay-percent","display":"Copayment Percent per service"}],"text":"Coinsurance"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]},"value":{"value":40,"code":"%","system":"http://unitsofmeasure.org","unit":"%"}}]}]},{"category":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"facility-fee","display":"Facility Fee"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"9b","display":"Ambulatory Surgical Center (ASC) Services"}]},"benefit":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"facility-fee","display":"Facility Fee"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"9b","display":"Ambulatory Surgical Center (ASC) Services"}]},"cost":[{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-range","valueRange":{"low":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"},"high":{"value":500,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":500,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD","comparator":"<="}},{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay-percent","display":"Copayment Percent per service"}],"text":"Coinsurance"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]},"value":{"value":40,"code":"%","system":"http://unitsofmeasure.org","unit":"%"}}]}]},{"category":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"imaging","display":"Imaging (CT/PET/MRI)"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"8b1","display":"Diagnostic Radiological Services"}]},"benefit":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"imaging","display":"Imaging (CT/PET/MRI)"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"8b1","display":"Diagnostic Radiological Services"}]},"cost":[{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-range","valueRange":{"low":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"},"high":{"value":320,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":320,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD","comparator":"<="}},{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay-percent","display":"Copayment Percent per service"}],"text":"Coinsurance"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]},"value":{"value":40,"code":"%","system":"http://unitsofmeasure.org","unit":"%"}}]}]},{"category":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"rehabilitation","display":"Rehabilitation Services"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"7i","display":"Physical Therapy and Speech-Language Pathology Services"}]},"benefit":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"rehabilitation","display":"Rehabilitation Services"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"7i","display":"Physical Therapy and Speech-Language Pathology Services"}]},"cost":[{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":65,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}},{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]},"value":{"value":100,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}]}]},{"category":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"mental-health-outpatient","display":"Mental/Behavioral Health Outpatient Services"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"7e1","display":"Individual Sessions for Mental Health Specialty Services"}]},"benefit":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"mental-health-outpatient","display":"Mental/Behavioral Health Outpatient Services"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"7e1","display":"Individual Sessions for Mental Health Specialty Services"}]},"cost":[{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-range","valueRange":{"low":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"},"high":{"value":25,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":25,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD","comparator":"<="}},{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]},"value":{"value":40,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}]}]},{"category":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"emergency-medical-transport","display":"Emergency Medical Transportation"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"10a1","display":"Ground Ambulance Services"}]},"benefit":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"emergency-medical-transport","display":"Emergency Medical Transportation"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"10a1","display":"Ground Ambulance Services"}]},"cost":[{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":380,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}},{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]},"value":{"value":380,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}]}]},{"category":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"skilled-nursing","display":"Skilled Nursing Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"2","display":"Skilled Nursing Facility (SNF)"}]},"benefit":[{"extension":[{"url":"http://hl7.org/fhir/us/insurance-card/StructureDefinition/benefit-limitation","extension":[{"url":"limitText","valueString":"Benefit period (in network): Original Medicare"}]}],"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"skilled-nursing","display":"Skilled Nursing Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"2","display":"Skilled Nursing Facility (SNF)"}]},"cost":[{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-day-range","valueRange":{"low":{"value":1,"code":"d","system":"http://unitsofmeasure.org","unit":"d"},"high":{"value":20,"code":"d","system":"http://unitsofmeasure.org","unit":"d"}}}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"qualifiers":[{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier","code":"per-day","display":"Per day"}]}],"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}},{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-day-range","valueRange":{"low":{"value":21,"code":"d","system":"http://unitsofmeasure.org","unit":"d"},"high":{"value":100,"code":"d","system":"http://unitsofmeasure.org","unit":"d"}}}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"qualifiers":[{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier","code":"per-day","display":"Per day"}]}],"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":221,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}},{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-day-range","valueRange":{"low":{"value":1,"code":"d","system":"http://unitsofmeasure.org","unit":"d"},"high":{"value":100,"code":"d","system":"http://unitsofmeasure.org","unit":"d"}}}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"qualifiers":[{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier","code":"per-day","display":"Per day"}]}],"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]},"value":{"value":250,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}},{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"qualifiers":[{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier","code":"per-stay","display":"Per stay"}]}],"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]},"value":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}]}]}]}]},"search":{"mode":"match"}}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"A parameter this service does not serve, a repeated parameter, a comma-separated list of values, a value of the wrong form, a search with no criteria, or a page that is not this search's. One issue per offending parameter, naming it.","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"},"404":{"description":"No such interaction on this base.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"406":{"$ref":"#/components/responses/FhirNotAcceptable"},"410":{"description":"The plans were updated since this search began, so its later pages no longer exist. Start the search again.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"502":{"description":"The plan store could not be read. No answer is given: this is never reported as an empty result or a missing plan.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"No release of the plan files this request needs is being served on this deployment, or, for a county search, where a served release's plans are sold is not loaded yet. The `OperationOutcome` names the program. The service returns no answer rather than guessing one. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The plan store did not respond in time.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}}}},"/v1/fhir/r4/InsurancePlan/$counties":{"get":{"tags":["Plan Benefits"],"summary":"List a state's counties","description":"FHIR type-level operation `$counties` on InsurancePlan: the counties and county equivalents of a state, the District of Columbia or a territory, sorted by name, each with the five-digit FIPS code `coverage-area-county` takes. The answer is a `Parameters` resource: one `county` parameter per county, whose `code` part is a Coding in `http://terminology.hl7.org/CodeSystem/FIPS64` with the county's name as its display and whose `state` part is the state's code, then a `source` parameter naming the list: the U.S. Census Bureau's 2020 county codes. It answers whether or not a plan is sold in a county. GET only. Defined by the haau3 implementation guide (`https://haau3.com/fhir/OperationDefinition/InsurancePlan-counties`).","operationId":"listInsurancePlanCounties","parameters":[{"name":"state","in":"query","required":true,"description":"The two-letter USPS code of a state, the District of Columbia or a territory: `FL`.","schema":{"type":"string","pattern":"^[A-Za-z]{2}$"},"example":"FL"},{"$ref":"#/components/parameters/XRequestId"}],"responses":{"200":{"description":"A `Parameters` resource listing the state's counties, then the list's source.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"},"examples":{"Florida's counties":{"summary":"Florida's counties","value":{"resourceType":"Parameters","parameter":[{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12001","display":"Alachua County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12003","display":"Baker County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12005","display":"Bay County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12007","display":"Bradford County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12009","display":"Brevard County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12011","display":"Broward County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12013","display":"Calhoun County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12015","display":"Charlotte County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12017","display":"Citrus County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12019","display":"Clay County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12021","display":"Collier County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12023","display":"Columbia County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12027","display":"DeSoto County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12029","display":"Dixie County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12031","display":"Duval County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12033","display":"Escambia County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12035","display":"Flagler County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12037","display":"Franklin County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12039","display":"Gadsden County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12041","display":"Gilchrist County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12043","display":"Glades County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12045","display":"Gulf County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12047","display":"Hamilton County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12049","display":"Hardee County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12051","display":"Hendry County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12053","display":"Hernando County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12055","display":"Highlands County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12057","display":"Hillsborough County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12059","display":"Holmes County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12061","display":"Indian River County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12063","display":"Jackson County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12065","display":"Jefferson County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12067","display":"Lafayette County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12069","display":"Lake County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12071","display":"Lee County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12073","display":"Leon County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12075","display":"Levy County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12077","display":"Liberty County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12079","display":"Madison County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12081","display":"Manatee County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12083","display":"Marion County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12085","display":"Martin County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12086","display":"Miami-Dade County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12087","display":"Monroe County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12089","display":"Nassau County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12091","display":"Okaloosa County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12093","display":"Okeechobee County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12095","display":"Orange County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12097","display":"Osceola County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12099","display":"Palm Beach County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12101","display":"Pasco County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12103","display":"Pinellas County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12105","display":"Polk County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12107","display":"Putnam County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12113","display":"Santa Rosa County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12115","display":"Sarasota County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12117","display":"Seminole County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12109","display":"St. Johns County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12111","display":"St. Lucie County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12119","display":"Sumter County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12121","display":"Suwannee County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12123","display":"Taylor County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12125","display":"Union County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12127","display":"Volusia County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12129","display":"Wakulla County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12131","display":"Walton County"}},{"name":"state","valueString":"FL"}]},{"name":"county","part":[{"name":"code","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/FIPS64","code":"12133","display":"Washington County"}},{"name":"state","valueString":"FL"}]},{"name":"source","valueString":"U.S. Census Bureau, 2020 FIPS codes for counties and county equivalents: https://www2.census.gov/geo/docs/reference/codes2020/national_county2020.txt"}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"A state that is not two letters, a missing or repeated `state`, or another parameter, named.","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"},"404":{"description":"No state, district or territory has this code.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"406":{"$ref":"#/components/responses/FhirNotAcceptable"},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"503":{"$ref":"#/components/responses/FhirUnavailable"}}}},"/v1/fhir/r4/InsurancePlan/{id}":{"get":{"tags":["Plan Benefits"],"summary":"Read a plan","description":"Read one plan by its id. A Medicare Advantage plan's id is CMS's plan id with the segment in three digits (`H2406-013-000`); a Marketplace plan's is its HIOS plan id with the variant (`19898FL0340001-01`). The plan conforms to the haau3 Plan Benefits profile and to the SBC InsurancePlan profile of the CARIN Digital Insurance Card guide, 2.0.0-ballot, and names the CMS release it was read from.","operationId":"readInsurancePlan","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9\\-.]{1,64}$"},"description":"The plan's id: `H2406-013-000` or `19898FL0340001-01`.","example":"H2406-013-000"},{"$ref":"#/components/parameters/XRequestId"}],"responses":{"200":{"description":"The `InsurancePlan`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/InsurancePlan"},"examples":{"A Medicare Advantage plan":{"summary":"A Medicare Advantage plan","value":{"resourceType":"InsurancePlan","id":"H2406-013-000","meta":{"profile":["https://haau3.com/fhir/StructureDefinition/haau3-insurance-plan","http://hl7.org/fhir/us/insurance-card/StructureDefinition/sbc-insurance-plan|2.0.0-ballot"]},"contained":[{"resourceType":"Organization","id":"issuer","identifier":[{"type":{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/payor-identifier-types-cs","code":"cms-contract-id","display":"CMS Contract ID"}]},"system":"https://haau3.com/fhir/NamingSystem/cms-ma-contract-id","value":"H2406"}],"name":"UnitedHealthcare","alias":["CARE IMPROVEMENT PLUS SOUTH CENTRAL INSURANCE CO."]},{"resourceType":"Location","id":"state-FL","physicalType":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/location-physical-type","code":"jdn","display":"Jurisdiction"}]},"address":{"state":"FL"}}],"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-source-release","extension":[{"url":"release","valueString":"ma-2027-2026-10-01"},{"url":"file","extension":[{"url":"downloadUrl","valueUri":"https://www.cms.gov/files/zip/pbp-benefits-2027.zip"},{"url":"lastModified","valueDate":"2026-10-01"},{"url":"sha256","valueString":"6d8430e2ecb51acf3cc8547f12dd73506aa73f0dccf034cc3c3393868576ff47"}]}]},{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-plan-facts","extension":[{"url":"specialNeeds","valueBoolean":false},{"url":"employerOnly","valueBoolean":false},{"url":"partBOnly","valueBoolean":false},{"url":"filesCostData","valueBoolean":true},{"url":"outOfNetworkBenefit","valueBoolean":true},{"url":"pointOfService","valueBoolean":false}]}],"identifier":[{"system":"http://cms.gov/medicare/ma-plan-id","value":"H2406-013-000"},{"system":"https://haau3.com/fhir/NamingSystem/cms-ma-bid-id","value":"H2406_013_0"}],"type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/insurance-product-type","code":"mediadv","display":"Medicare Advantage"}]}],"status":"active","name":"AARP Medicare Advantage from UHC FL-0021 (PPO)","period":{"start":"2027","end":"2027"},"ownedBy":{"reference":"#issuer","display":"UnitedHealthcare"},"contact":[{"purpose":{"text":"General Questions"},"telecom":[{"system":"phone","value":"(866)627-7806"},{"system":"url","value":"AARPMedicarePlans.com"}]},{"purpose":{"text":"Provider directory"},"telecom":[{"system":"url","value":"AARPMedicarePlans.com"}]}],"coverageArea":[{"reference":"#state-FL"}],"coverage":[{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ActCode","code":"HIP","display":"health insurance plan policy"}]},"benefit":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"primary-care-visit","display":"Primary Care Visit"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"7a","display":"Primary Care Physician Services"}]}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"specialist-visit","display":"Specialist Visit"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"7d","display":"Physician Specialist Services"}]}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"urgent-care","display":"Urgent Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"4b","display":"Urgently Needed Services"}]}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"emergency-room-care","display":"Emergency Room Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"4a","display":"Emergency Services"}]}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"hospital-inpatient","display":"Hospital Inpatient Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"1a","display":"Inpatient Hospital-Acute"}]}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"hospital-outpatient","display":"Hospital Outpatient Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"9a1","display":"Outpatient Hospital Services"}]}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"facility-fee","display":"Facility Fee"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"9b","display":"Ambulatory Surgical Center (ASC) Services"}]}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"imaging","display":"Imaging (CT/PET/MRI)"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"8b1","display":"Diagnostic Radiological Services"}]}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"rehabilitation","display":"Rehabilitation Services"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"7i","display":"Physical Therapy and Speech-Language Pathology Services"}]}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"mental-health-outpatient","display":"Mental/Behavioral Health Outpatient Services"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"7e1","display":"Individual Sessions for Mental Health Specialty Services"}]}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"emergency-medical-transport","display":"Emergency Medical Transportation"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"10a1","display":"Ground Ambulance Services"}]}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"skilled-nursing","display":"Skilled Nursing Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"2","display":"Skilled Nursing Facility (SNF)"}]}}]}],"plan":[{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-additional-benefit","extension":[{"url":"category","valueCodeableConcept":{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"8a2","display":"Lab Services"}]}},{"url":"cost","extension":[{"url":"type","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"}},{"url":"applicability","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]}},{"url":"amount","valueQuantity":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}]},{"url":"cost","extension":[{"url":"type","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"}},{"url":"applicability","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]}},{"url":"amount","valueQuantity":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}]}]},{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-additional-benefit","extension":[{"url":"category","valueCodeableConcept":{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"9a2","display":"Observation Services"}]}},{"url":"cost","extension":[{"url":"type","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"}},{"url":"applicability","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]}},{"url":"qualifier","valueCodeableConcept":{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier","code":"per-day","display":"Per day"}]}},{"url":"amount","valueQuantity":{"value":550,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}]},{"url":"cost","extension":[{"url":"type","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay-percent","display":"Copayment Percent per service"}],"text":"Coinsurance"}},{"url":"applicability","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]}},{"url":"amount","valueQuantity":{"value":40,"code":"%","system":"http://unitsofmeasure.org","unit":"%"}}]}]},{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-additional-benefit","extension":[{"url":"category","valueCodeableConcept":{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"6","display":"Home Health Services"}]}},{"url":"cost","extension":[{"url":"type","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"}},{"url":"applicability","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]}},{"url":"amount","valueQuantity":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}]},{"url":"cost","extension":[{"url":"type","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay-percent","display":"Copayment Percent per service"}],"text":"Coinsurance"}},{"url":"applicability","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]}},{"url":"amount","valueQuantity":{"value":50,"code":"%","system":"http://unitsofmeasure.org","unit":"%"}}]}]}],"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-plan-type","code":"PPO","display":"Preferred Provider Organization (PPO)"}],"text":"Local PPO"},"coverageArea":[{"reference":"#state-FL"}],"generalCost":[{"type":{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-general-cost-type","code":"monthly-premium","display":"Monthly premium"}],"text":"Monthly premium"},"cost":{"value":0,"currency":"USD"}},{"type":{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-general-cost-type","code":"part-b-premium-reduction","display":"Part B premium reduction"}],"text":"Part B premium reduction"},"comment":"None"},{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-scope","extension":[{"url":"network","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/benefit-network","code":"out","display":"Out of Network"}},{"url":"member","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/benefit-unit","code":"individual","display":"Individual"}},{"url":"appliesTo","valueCoding":{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-scope","code":"medical","display":"Medical"}}]}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/coverage-copay-type","code":"deductible","display":"Deductible"}],"text":"Individual Deductible"},"cost":{"value":1000,"currency":"USD"},"comment":"Out of network, for medical care"},{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-scope","extension":[{"url":"network","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/benefit-network","code":"in","display":"In Network"}},{"url":"member","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/benefit-unit","code":"individual","display":"Individual"}},{"url":"appliesTo","valueCoding":{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-scope","code":"medical","display":"Medical"}}]}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/coverage-copay-type","code":"maxoutofpocket","display":"Maximum out of pocket"}],"text":"Individual Out-of-Pocket Maximum"},"cost":{"value":7150,"currency":"USD"},"comment":"In network, for medical care"},{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-scope","extension":[{"url":"network","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/benefit-network","code":"out","display":"Out of Network"}},{"url":"member","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/benefit-unit","code":"individual","display":"Individual"}},{"url":"appliesTo","valueCoding":{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-scope","code":"medical","display":"Medical"}}]}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/coverage-copay-type","code":"maxoutofpocket","display":"Maximum out of pocket"}],"text":"Individual Out-of-Pocket Maximum"},"comment":"Out of network, for medical care: none"},{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-scope","extension":[{"url":"network","valueCoding":{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-scope","code":"combined","display":"In and out of network combined"}},{"url":"member","valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/benefit-unit","code":"individual","display":"Individual"}},{"url":"appliesTo","valueCoding":{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-scope","code":"medical","display":"Medical"}}]}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/coverage-copay-type","code":"maxoutofpocket","display":"Maximum out of pocket"}],"text":"Individual Out-of-Pocket Maximum"},"cost":{"value":10750,"currency":"USD"},"comment":"In and out of network combined, for medical care"}],"specificCost":[{"category":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"primary-care-visit","display":"Primary Care Visit"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"7a","display":"Primary Care Physician Services"}]},"benefit":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"primary-care-visit","display":"Primary Care Visit"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"7a","display":"Primary Care Physician Services"}]},"cost":[{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}},{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]},"value":{"value":45,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}]}]},{"category":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"specialist-visit","display":"Specialist Visit"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"7d","display":"Physician Specialist Services"}]},"benefit":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"specialist-visit","display":"Specialist Visit"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"7d","display":"Physician Specialist Services"}]},"cost":[{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-range","valueRange":{"low":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"},"high":{"value":65,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":65,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD","comparator":"<="}},{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]},"value":{"value":100,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}]}]},{"category":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"urgent-care","display":"Urgent Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"4b","display":"Urgently Needed Services"}]},"benefit":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"urgent-care","display":"Urgent Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"4b","display":"Urgently Needed Services"}]},"cost":[{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-range","valueRange":{"low":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"},"high":{"value":50,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"qualifiers":[{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier","code":"one-price-both-networks","display":"One price in and out of network"}]}],"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":50,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD","comparator":"<="}},{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-range","valueRange":{"low":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"},"high":{"value":50,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"qualifiers":[{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier","code":"one-price-both-networks","display":"One price in and out of network"}]}],"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]},"value":{"value":50,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD","comparator":"<="}}]}]},{"category":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"emergency-room-care","display":"Emergency Room Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"4a","display":"Emergency Services"}]},"benefit":[{"extension":[{"url":"http://hl7.org/fhir/us/insurance-card/StructureDefinition/benefit-limitation","extension":[{"url":"limitText","valueString":"Copay waived if admitted to the hospital within 24 hours"}]}],"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"emergency-room-care","display":"Emergency Room Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"4a","display":"Emergency Services"}]},"cost":[{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"qualifiers":[{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier","code":"one-price-both-networks","display":"One price in and out of network"}]}],"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":130,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}},{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"qualifiers":[{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier","code":"one-price-both-networks","display":"One price in and out of network"}]}],"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]},"value":{"value":130,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}]}]},{"category":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"hospital-inpatient","display":"Hospital Inpatient Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"1a","display":"Inpatient Hospital-Acute"}]},"benefit":[{"extension":[{"url":"http://hl7.org/fhir/us/insurance-card/StructureDefinition/benefit-limitation","extension":[{"url":"limitText","valueString":"Benefit period (in network): Per Admission or Per Stay"}]}],"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"hospital-inpatient","display":"Hospital Inpatient Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"1a","display":"Inpatient Hospital-Acute"}]},"cost":[{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-day-range","valueRange":{"low":{"value":1,"code":"d","system":"http://unitsofmeasure.org","unit":"d"},"high":{"value":5,"code":"d","system":"http://unitsofmeasure.org","unit":"d"}}}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"qualifiers":[{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier","code":"per-day","display":"Per day"}]}],"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":550,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}},{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-day-range","valueRange":{"low":{"value":6,"code":"d","system":"http://unitsofmeasure.org","unit":"d"},"high":{"value":90,"code":"d","system":"http://unitsofmeasure.org","unit":"d"}}}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"qualifiers":[{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier","code":"per-day","display":"Per day"}]}],"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}},{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"qualifiers":[{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier","code":"per-stay","display":"Per stay"}]}],"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}},{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay-percent","display":"Copayment Percent per service"}],"text":"Coinsurance"},"qualifiers":[{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier","code":"per-stay","display":"Per stay"}]}],"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]},"value":{"value":40,"code":"%","system":"http://unitsofmeasure.org","unit":"%"}}]}]},{"category":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"hospital-outpatient","display":"Hospital Outpatient Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"9a1","display":"Outpatient Hospital Services"}]},"benefit":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"hospital-outpatient","display":"Hospital Outpatient Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"9a1","display":"Outpatient Hospital Services"}]},"cost":[{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-range","valueRange":{"low":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"},"high":{"value":550,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":550,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD","comparator":"<="}},{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay-percent","display":"Copayment Percent per service"}],"text":"Coinsurance"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]},"value":{"value":40,"code":"%","system":"http://unitsofmeasure.org","unit":"%"}}]}]},{"category":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"facility-fee","display":"Facility Fee"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"9b","display":"Ambulatory Surgical Center (ASC) Services"}]},"benefit":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"facility-fee","display":"Facility Fee"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"9b","display":"Ambulatory Surgical Center (ASC) Services"}]},"cost":[{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-range","valueRange":{"low":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"},"high":{"value":500,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":500,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD","comparator":"<="}},{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay-percent","display":"Copayment Percent per service"}],"text":"Coinsurance"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]},"value":{"value":40,"code":"%","system":"http://unitsofmeasure.org","unit":"%"}}]}]},{"category":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"imaging","display":"Imaging (CT/PET/MRI)"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"8b1","display":"Diagnostic Radiological Services"}]},"benefit":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"imaging","display":"Imaging (CT/PET/MRI)"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"8b1","display":"Diagnostic Radiological Services"}]},"cost":[{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-range","valueRange":{"low":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"},"high":{"value":320,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":320,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD","comparator":"<="}},{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay-percent","display":"Copayment Percent per service"}],"text":"Coinsurance"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]},"value":{"value":40,"code":"%","system":"http://unitsofmeasure.org","unit":"%"}}]}]},{"category":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"rehabilitation","display":"Rehabilitation Services"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"7i","display":"Physical Therapy and Speech-Language Pathology Services"}]},"benefit":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"rehabilitation","display":"Rehabilitation Services"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"7i","display":"Physical Therapy and Speech-Language Pathology Services"}]},"cost":[{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":65,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}},{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]},"value":{"value":100,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}]}]},{"category":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"mental-health-outpatient","display":"Mental/Behavioral Health Outpatient Services"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"7e1","display":"Individual Sessions for Mental Health Specialty Services"}]},"benefit":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"mental-health-outpatient","display":"Mental/Behavioral Health Outpatient Services"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"7e1","display":"Individual Sessions for Mental Health Specialty Services"}]},"cost":[{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-cost-range","valueRange":{"low":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"},"high":{"value":25,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":25,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD","comparator":"<="}},{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]},"value":{"value":40,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}]}]},{"category":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"emergency-medical-transport","display":"Emergency Medical Transportation"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"10a1","display":"Ground Ambulance Services"}]},"benefit":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"emergency-medical-transport","display":"Emergency Medical Transportation"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"10a1","display":"Ground Ambulance Services"}]},"cost":[{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":380,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}},{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]},"value":{"value":380,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}]}]},{"category":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"skilled-nursing","display":"Skilled Nursing Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"2","display":"Skilled Nursing Facility (SNF)"}]},"benefit":[{"extension":[{"url":"http://hl7.org/fhir/us/insurance-card/StructureDefinition/benefit-limitation","extension":[{"url":"limitText","valueString":"Benefit period (in network): Original Medicare"}]}],"type":{"coding":[{"system":"http://hl7.org/fhir/us/insurance-card/CodeSystem/sbc-benefit-category","code":"skilled-nursing","display":"Skilled Nursing Care"},{"system":"https://haau3.com/fhir/CodeSystem/cms-pbp-service-category","code":"2","display":"Skilled Nursing Facility (SNF)"}]},"cost":[{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-day-range","valueRange":{"low":{"value":1,"code":"d","system":"http://unitsofmeasure.org","unit":"d"},"high":{"value":20,"code":"d","system":"http://unitsofmeasure.org","unit":"d"}}}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"qualifiers":[{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier","code":"per-day","display":"Per day"}]}],"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}},{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-day-range","valueRange":{"low":{"value":21,"code":"d","system":"http://unitsofmeasure.org","unit":"d"},"high":{"value":100,"code":"d","system":"http://unitsofmeasure.org","unit":"d"}}}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"qualifiers":[{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier","code":"per-day","display":"Per day"}]}],"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"in-network","display":"In Network"}]},"value":{"value":221,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}},{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/plan-benefits-day-range","valueRange":{"low":{"value":1,"code":"d","system":"http://unitsofmeasure.org","unit":"d"},"high":{"value":100,"code":"d","system":"http://unitsofmeasure.org","unit":"d"}}}],"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"qualifiers":[{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier","code":"per-day","display":"Per day"}]}],"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]},"value":{"value":250,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}},{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/benefit-type","code":"copay","display":"Copayment per service"}],"text":"Copayment"},"qualifiers":[{"coding":[{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-cost-qualifier","code":"per-stay","display":"Per stay"}]}],"applicability":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/applicability","code":"out-of-network","display":"Out of Network"}]},"value":{"value":0,"code":"USD","system":"urn:iso:std:iso:4217","unit":"USD"}}]}]}]}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"The request could not be read: the id is not a valid FHIR id, or a query parameter was sent, and a read takes none.","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"},"404":{"description":"No plan with that id is in the releases being served, or the plan is held but is not a medical plan. The `OperationOutcome` says which.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"406":{"$ref":"#/components/responses/FhirNotAcceptable"},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"502":{"description":"The plan store could not be read. No answer is given: this is never reported as an empty result or a missing plan.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"No release of the plan files this request needs is being served on this deployment, and the `OperationOutcome` names the program. The service returns no answer rather than guessing one. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The plan store did not respond in time.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}}}},"/v1/fhir/r4/InsurancePlan/{id}/$in-network":{"get":{"tags":["Plan Benefits"],"summary":"Check providers against a plan's network","description":"FHIR instance-level operation `$in-network` on InsurancePlan: for each NPI, whether the CMS National Provider Directory lists the provider in a network this plan names, for the plan's year. The answer is a `Parameters` resource: the `plan`; the directory's `data-date`; one `network` per network checked, with the number of organizations it lists; a `reason` when there is no network data; a Marketplace plan's own `directory`; one `provider` per NPI, in the order sent, with its `status` (`in-network`, `not-found`, `not-in-directory` or `no-network-data`) and, when listed, `evidence` references to the directory's records on this base; then a `source` when the directory was asked. `not-found` never means out of network: the directory's network data is incomplete, and a listing is not a statement of a contract. All or nothing: a lookup that fails fails the whole answer. GET only. Defined by the haau3 implementation guide (`https://haau3.com/fhir/OperationDefinition/InsurancePlan-in-network`).","operationId":"checkInsurancePlanNetwork","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9\\-.]{1,64}$"},"description":"The plan's id: `H2406-013-000` or `19898FL0340001-01`.","example":"H3359-038-000"},{"name":"npi","in":"query","required":true,"style":"form","explode":true,"description":"Up to 20 NPIs, ten digits each, as repeated `npi` parameters or separated by commas: `npi=1992700001&npi=1992700002` or `npi=1992700001,1992700002`. Duplicates count once.","schema":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","pattern":"^[0-9]{10}(,[0-9]{10})*$"}},"example":["1518929058","1992700001"]},{"$ref":"#/components/parameters/XRequestId"}],"responses":{"200":{"description":"A `Parameters` resource with each NPI's status, in the order sent.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"},"examples":{"Two providers checked against a plan's network":{"summary":"Two providers checked against a plan's network","value":{"resourceType":"Parameters","parameter":[{"name":"plan","valueReference":{"reference":"InsurancePlan/H3359-038-000"}},{"name":"data-date","valueDate":"2026-10-14"},{"name":"network","part":[{"name":"network","valueReference":{"reference":"Organization/Organization-ed682d9f-98da-4ada-a081-04b4f80fe9f3","display":"Healthfirst Medicare Network H3359"}},{"name":"organizations-listed","valueInteger":0}]},{"name":"provider","part":[{"name":"npi","valueIdentifier":{"system":"http://hl7.org/fhir/sid/us-npi","value":"1518929058"}},{"name":"status","valueCoding":{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-network-status","code":"in-network","display":"In network"}},{"name":"evidence","valueReference":{"reference":"PractitionerRole/PractitionerRole-0000099c-a432-43eb-a399-61a936d5cc60"}}]},{"name":"provider","part":[{"name":"npi","valueIdentifier":{"system":"http://hl7.org/fhir/sid/us-npi","value":"1992700001"}},{"name":"status","valueCoding":{"system":"https://haau3.com/fhir/CodeSystem/plan-benefits-network-status","code":"not-in-directory","display":"Not in the directory"}}]},{"name":"source","valueString":"CMS National Provider Directory: https://directory.cms.gov/fhir"}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"A missing `npi`, an NPI that is not ten digits, more than 20 NPIs, or another parameter, named.","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"},"404":{"description":"No plan with that id is in the releases being served, or the plan is held but is not a medical plan. The `OperationOutcome` says which.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"406":{"$ref":"#/components/responses/FhirNotAcceptable"},"429":{"$ref":"#/components/responses/FhirTooManyRequests"},"500":{"$ref":"#/components/responses/FhirServerError"},"502":{"description":"The plan store could not be read, or the directory failed a lookup or answered in a way that could not be read with confidence. No answer is given: this is never reported as a provider not found.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"No release of the plan files is being served for the plan's program, or the directory is rate limiting requests (with `Retry-After`). No answer is given. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The plan store or the directory did not answer within the operation's time. No answer is given, never a partial one.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}}}},"/v1/fhir/r4/$reconcile-medications":{"post":{"tags":["MedList"],"summary":"Reconcile one patient's medication records","description":"FHIR system-level operation `$reconcile-medications`. POST one patient's MedicationRequest, MedicationStatement, MedicationDispense and MedicationAdministration records, with the Medications they reference, as a `collection` or `searchset` Bundle; every entry needs a `fullUrl`. The response is one reconciled medication list: a `collection` Bundle holding one reconciled MedicationRequest per clinical drug, a Provenance for each naming the records behind it, and an OperationOutcome when a record was skipped. To evaluate the list as of another date, POST a Parameters resource with `resource` parts, or one `bundle` part, and an `asOf` part. This operation 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 the operation is not offered inside a batch. The contract is published at https://fhir.haau3.com/OperationDefinition-reconcile-medications.html.","operationId":"reconcileMedications","requestBody":{"required":true,"content":{"application/fhir+json":{"schema":{"oneOf":[{"type":"object","properties":{"resourceType":{"type":"string","const":"Bundle"},"type":{"type":"string","minLength":1},"entry":{"maxItems":50000,"type":"array","items":{"type":"object","properties":{"fullUrl":{"type":"string"},"resource":{"type":"object","properties":{"resourceType":{"type":"string","minLength":1}},"required":["resourceType"],"additionalProperties":{}},"search":{"type":"object","properties":{"mode":{"type":"string"}},"additionalProperties":{}}},"additionalProperties":{}}}},"required":["resourceType","type"],"additionalProperties":{}},{"type":"object","properties":{"resourceType":{"type":"string","const":"Parameters"},"parameter":{"maxItems":50000,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"resource":{"type":"object","properties":{"resourceType":{"type":"string","minLength":1}},"required":["resourceType"],"additionalProperties":{}},"valueDateTime":{"type":"string"}},"required":["name"],"additionalProperties":{}}}},"required":["resourceType"],"additionalProperties":{}}]},"examples":{"One patient's medication records":{"summary":"One patient's medication records","value":{"resourceType":"Bundle","id":"medlist-request-bundle","type":"collection","timestamp":"2026-09-25T11:59:00Z","entry":[{"fullUrl":"http://example.org/fhir/MedicationRequest/janumet-order","resource":{"resourceType":"MedicationRequest","id":"janumet-order","medicationReference":{"reference":"Medication/janumet"},"subject":{"reference":"http://example.org/fhir/Patient/example"},"requester":{"display":"Example Prescriber, MD"},"status":"active","intent":"order","authoredOn":"2026-08-30"}},{"fullUrl":"http://example.org/fhir/Medication/janumet","resource":{"resourceType":"Medication","id":"janumet","code":{"coding":[{"code":"861821","system":"http://www.nlm.nih.gov/research/umls/rxnorm","display":"metformin hydrochloride 500 MG / sitagliptin phosphate 50 MG Oral Tablet [Janumet]"}],"text":"Janumet 50 mg-500 mg tablet"}}},{"fullUrl":"http://example.org/fhir/MedicationStatement/janumet-statement","resource":{"resourceType":"MedicationStatement","id":"janumet-statement","medicationCodeableConcept":{"coding":[{"code":"861821","system":"http://www.nlm.nih.gov/research/umls/rxnorm","display":"metformin hydrochloride 500 MG / sitagliptin phosphate 50 MG Oral Tablet [Janumet]"}]},"subject":{"reference":"http://example.org/fhir/Patient/example"},"informationSource":{"reference":"http://example.org/fhir/Patient/example"},"dosage":[{"text":"1 tablet twice a day"}],"status":"active","dateAsserted":"2026-09-10"}},{"fullUrl":"http://example.org/fhir/MedicationStatement/lisinopril-statement","resource":{"resourceType":"MedicationStatement","id":"lisinopril-statement","medicationCodeableConcept":{"coding":[{"code":"311354","system":"http://www.nlm.nih.gov/research/umls/rxnorm","display":"lisinopril 5 MG Oral Tablet"}],"text":"lisinopril 5 mg tablet"},"subject":{"reference":"http://example.org/fhir/Patient/example"},"informationSource":{"reference":"http://example.org/fhir/Patient/example"},"dosage":[{"text":"5 mg once daily"}],"status":"active","dateAsserted":"2026-09-05"}},{"fullUrl":"http://example.org/fhir/MedicationRequest/unnamed-order","resource":{"resourceType":"MedicationRequest","id":"unnamed-order","medicationCodeableConcept":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/data-absent-reason","valueCode":"unknown"}]},"subject":{"reference":"http://example.org/fhir/Patient/example"},"status":"active","intent":"order"}}]}}}}}},"responses":{"200":{"description":"The reconciled list: a FHIR `Bundle` of type `collection` conforming to haau3 Reconciled Medication Bundle, returned as the response body itself.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Bundle"},"examples":{"The reconciled list":{"summary":"The reconciled list","value":{"resourceType":"Bundle","meta":{"profile":["https://haau3.com/fhir/StructureDefinition/haau3-reconciled-medication-bundle"]},"type":"collection","timestamp":"2026-09-25T12:00:00Z","entry":[{"fullUrl":"urn:uuid:cca79014-be8b-4a29-b062-d4df7bd4ea4c","resource":{"resourceType":"MedicationRequest","meta":{"profile":["https://haau3.com/fhir/StructureDefinition/haau3-reconciled-medication-request"]},"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/medlist-evidence","valueCoding":{"code":"patient-reported","system":"https://haau3.com/fhir/CodeSystem/medlist-evidence","display":"Patient-reported use"}}],"medicationCodeableConcept":{"coding":[{"code":"861821","system":"http://www.nlm.nih.gov/research/umls/rxnorm","display":"metformin hydrochloride 500 MG / sitagliptin phosphate 50 MG Oral Tablet [Janumet]"},{"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/medlist-added-coding","valueCode":"rxnorm-clinical-drug"}],"code":"2709491","system":"http://www.nlm.nih.gov/research/umls/rxnorm","display":"metformin hydrochloride 500 MG / sitagliptin phosphate 50 MG Oral Tablet","id":"haau3-added-coding"}],"text":"Janumet 50 mg-500 mg tablet"},"subject":{"reference":"http://example.org/fhir/Patient/example"},"requester":{"display":"Example Prescriber, MD"},"dosageInstruction":[{"text":"1 tablet twice a day"}],"status":"active","intent":"order","reportedBoolean":false,"authoredOn":"2026-08-30"}},{"fullUrl":"urn:uuid:e9f58b63-dfcf-427b-a99a-5bd212786511","resource":{"resourceType":"Provenance","meta":{"profile":["https://haau3.com/fhir/StructureDefinition/haau3-reconciled-medication-provenance"]},"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/medlist-ruleset-version","valueString":"2026-09-27.v3"},{"url":"https://haau3.com/fhir/StructureDefinition/medlist-rxnorm-release","valueString":"09082026"}],"contained":[{"resourceType":"Organization","id":"haau3","meta":{"profile":["http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization|6.1.0"]},"telecom":[{"system":"url","value":"https://haau3.com"}],"active":true,"name":"haau3"}],"target":[{"reference":"urn:uuid:cca79014-be8b-4a29-b062-d4df7bd4ea4c"}],"agent":[{"who":{"reference":"#haau3"},"type":{"coding":[{"code":"assembler","system":"http://terminology.hl7.org/CodeSystem/provenance-participant-type","display":"Assembler"}]}}],"entity":[{"what":{"reference":"http://example.org/fhir/MedicationRequest/janumet-order"},"role":"source"},{"what":{"reference":"http://example.org/fhir/MedicationStatement/janumet-statement"},"role":"source"}],"recorded":"2026-09-25T12:00:00Z","occurredDateTime":"2026-09-25T12:00:00Z"}},{"fullUrl":"urn:uuid:f7203088-a8ca-494f-9df4-d4d5795d69b9","resource":{"resourceType":"Provenance","meta":{"profile":["https://haau3.com/fhir/StructureDefinition/haau3-reconciled-medication-additions-provenance"]},"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/medlist-ruleset-version","valueString":"2026-09-27.v3"},{"url":"https://haau3.com/fhir/StructureDefinition/medlist-rxnorm-release","valueString":"09082026"}],"contained":[{"resourceType":"Organization","id":"haau3","meta":{"profile":["http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization|6.1.0"]},"telecom":[{"system":"url","value":"https://haau3.com"}],"active":true,"name":"haau3"}],"target":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/targetElement","valueUri":"haau3-added-coding"}],"reference":"urn:uuid:cca79014-be8b-4a29-b062-d4df7bd4ea4c"}],"agent":[{"who":{"reference":"#haau3"},"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/provenance-participant-type","code":"author","display":"Author"}]}}],"activity":{"coding":[{"code":"APPEND","system":"http://terminology.hl7.org/CodeSystem/v3-DataOperation","display":"append"}]},"recorded":"2026-09-25T12:00:00Z","occurredDateTime":"2026-09-25T12:00:00Z"}},{"fullUrl":"urn:uuid:6ed091b4-5154-4341-a5a0-db38571c584b","resource":{"resourceType":"MedicationRequest","meta":{"profile":["https://haau3.com/fhir/StructureDefinition/haau3-reconciled-medication-request"]},"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/medlist-evidence","valueCoding":{"code":"patient-reported","system":"https://haau3.com/fhir/CodeSystem/medlist-evidence","display":"Patient-reported use"}}],"reportedReference":{"reference":"http://example.org/fhir/Patient/example"},"medicationCodeableConcept":{"coding":[{"code":"311354","system":"http://www.nlm.nih.gov/research/umls/rxnorm","display":"lisinopril 5 MG Oral Tablet"}],"text":"lisinopril 5 mg tablet"},"subject":{"reference":"http://example.org/fhir/Patient/example"},"requester":{"reference":"http://example.org/fhir/Patient/example"},"dosageInstruction":[{"text":"5 mg once daily"}],"status":"active","intent":"plan"}},{"fullUrl":"urn:uuid:37832b15-3a07-4084-b779-6bb3078cab3b","resource":{"resourceType":"Provenance","meta":{"profile":["https://haau3.com/fhir/StructureDefinition/haau3-reconciled-medication-provenance"]},"extension":[{"url":"https://haau3.com/fhir/StructureDefinition/medlist-ruleset-version","valueString":"2026-09-27.v3"},{"url":"https://haau3.com/fhir/StructureDefinition/medlist-rxnorm-release","valueString":"09082026"}],"contained":[{"resourceType":"Organization","id":"haau3","meta":{"profile":["http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization|6.1.0"]},"telecom":[{"system":"url","value":"https://haau3.com"}],"active":true,"name":"haau3"}],"target":[{"reference":"urn:uuid:6ed091b4-5154-4341-a5a0-db38571c584b"}],"agent":[{"who":{"reference":"#haau3"},"type":{"coding":[{"code":"assembler","system":"http://terminology.hl7.org/CodeSystem/provenance-participant-type","display":"Assembler"}]}}],"entity":[{"what":{"reference":"http://example.org/fhir/MedicationStatement/lisinopril-statement"},"role":"source"}],"recorded":"2026-09-25T12:00:00Z","occurredDateTime":"2026-09-25T12:00:00Z"}},{"fullUrl":"urn:uuid:8f0d3f75-6138-4cb4-bea4-6b539e3c2894","resource":{"resourceType":"OperationOutcome","issue":[{"details":{"text":"This record names no medication and was not reconciled."},"severity":"warning","code":"required","diagnostics":"http://example.org/fhir/MedicationRequest/unnamed-order"}]}}]}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"400":{"description":"The request was refused: a query parameter (the operation takes its input in the body only), a resource of another type, a Bundle of another type, a resource part with no id, more than 50,000 entries or parameters (coded `too-long`), or malformed content. The OperationOutcome names the reason.","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 16 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"},"502":{"description":"The terminology store behind RxNorm could not be reached. No partial list is returned.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}},"503":{"description":"RxNorm is not configured on this deployment, no release has been published to it, or the release changed while the request was being answered. No partial list is returned. It is also the answer when the API key could not be checked just now, with `Retry-After`.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"Retry-After":{"description":"Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. 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"}}},"504":{"description":"The terminology store behind RxNorm did not respond in time. No partial list is returned.","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}}}},"parameters":[{"$ref":"#/components/parameters/XRequestId"}]}}},"components":{"responses":{"ProblemUnauthorized":{"description":"Missing or invalid API key.","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"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"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"}}},"ProblemNotAcceptable":{"description":"The request's `Accept` header admits no JSON.","headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"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"}}},"ProblemUnsupportedMediaType":{"description":"The request body was not sent as JSON: send `Content-Type: application/fhir+json`.","headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"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"}}},"ProblemTooManyRequests":{"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).","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"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"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"}}},"ProblemServerError":{"description":"The server failed to process this request.","headers":{"X-Request-Id":{"$ref":"#/components/headers/XRequestId"},"X-Correlation-Id":{"$ref":"#/components/headers/XCorrelationId"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"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"}}},"ProblemUnavailable":{"description":"The API key could not be checked just now. Send the request again after `Retry-After`.","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"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"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"}}}},"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."}},"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"}}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Your platform API key (`haau3_sk_…`), sent as `Authorization: Bearer <key>`."}},"schemas":{"Problem":{"type":"object","properties":{"type":{"type":"string","format":"uri","description":"What kind of problem this is: an anchor on https://docs.haau3.com/errors.","examples":["https://docs.haau3.com/errors#invalid-request"]},"title":{"type":"string","description":"A short summary, the same for every occurrence of the type."},"status":{"type":"integer","description":"The HTTP status code of this response."},"detail":{"type":"string","description":"What went wrong this time, and how to correct it."},"instance":{"type":"string","format":"uri","description":"This request's id as `urn:uuid:<id>`, the same id as the `X-Request-Id` header.","examples":["urn:uuid:0b6f2d4e-8c1a-4e3b-9f5d-2a7c6e1b4d90"]},"issues":{"type":"array","description":"On a 400: one entry per parameter that is not valid.","items":{"$ref":"#/components/schemas/ProblemIssue"}}},"required":["type","title","status","detail","instance"]},"ProblemIssue":{"type":"object","properties":{"path":{"type":"array","description":"The parameter, or the field within it, that is not valid.","items":{"type":["string","integer"]}},"message":{"type":"string","description":"Why it is not valid."}},"required":["path","message"]},"SchedulingSlot":{"type":"object","properties":{"id":{"type":"string"},"publisher":{"type":"string"},"scheduleId":{"type":"string"},"status":{"type":"string","enum":["free","busy","busy-unavailable","busy-tentative"]},"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"serviceTypeCode":{"type":"string"},"serviceTypeText":{"type":"string"},"serviceTypes":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"system":{"type":"string"},"code":{"type":"string"},"display":{"type":"string"}},"additionalProperties":false}},"specialties":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"system":{"type":"string"},"code":{"type":"string"},"display":{"type":"string"}},"additionalProperties":false}},"appointmentType":{"type":"string"},"acceptingPatients":{"type":"string","enum":["nopt","newpt","existptonly","existptfam"]},"isVirtual":{"type":"boolean"},"bookingDeepLink":{"type":"string","format":"uri"},"bookingPhone":{"type":"string"},"location":{"type":"object","properties":{"id":{"type":"string"},"identifier":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"system":{"type":"string"},"value":{"type":"string"}},"required":["value"],"additionalProperties":false}},"name":{"type":"string"},"phone":{"maxItems":100,"type":"array","items":{"type":"string"}},"website":{"maxItems":100,"type":"array","items":{"type":"string"}},"addressLine":{"maxItems":100,"type":"array","items":{"type":"string"}},"city":{"type":"string"},"state":{"type":"string"},"postalCode":{"type":"string"},"physicalType":{"type":"object","properties":{"system":{"type":"string"},"code":{"type":"string"}},"required":["code"],"additionalProperties":false},"description":{"type":"string"},"position":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}},"required":["latitude","longitude"],"additionalProperties":false}},"additionalProperties":false},"provider":{"type":"object","properties":{"id":{"type":"string"},"identifier":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"system":{"type":"string"},"value":{"type":"string"}},"required":["value"],"additionalProperties":false}},"type":{"type":"string","enum":["practitioner","practitioner-role","healthcare-service"]},"name":{"type":"string"},"specialty":{"type":"string"},"specialties":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"system":{"type":"string"},"code":{"type":"string"},"display":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"source":{"type":"object","properties":{"publisher":{"type":"string"},"resourceId":{"type":"string"},"transactionTime":{"type":"string","format":"date-time"},"syncedAt":{"type":"string","format":"date-time"}},"required":["publisher","resourceId","transactionTime","syncedAt"],"additionalProperties":false}},"required":["id","publisher","scheduleId","status","start","end"],"additionalProperties":false},"SchedulingProviderLocation":{"type":"object","properties":{"key":{"type":"string"},"publisher":{"type":"string"},"provider":{"type":"object","properties":{"id":{"type":"string"},"identifier":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"system":{"type":"string"},"value":{"type":"string"}},"required":["value"],"additionalProperties":false}},"type":{"type":"string","enum":["practitioner","practitioner-role","healthcare-service"]},"name":{"type":"string"},"specialty":{"type":"string"},"specialties":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"system":{"type":"string"},"code":{"type":"string"},"display":{"type":"string"}},"additionalProperties":false}},"npi":{"type":"string"}},"additionalProperties":false},"location":{"type":"object","properties":{"id":{"type":"string"},"identifier":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"system":{"type":"string"},"value":{"type":"string"}},"required":["value"],"additionalProperties":false}},"name":{"type":"string"},"phone":{"maxItems":100,"type":"array","items":{"type":"string"}},"website":{"maxItems":100,"type":"array","items":{"type":"string"}},"addressLine":{"maxItems":100,"type":"array","items":{"type":"string"}},"city":{"type":"string"},"state":{"type":"string"},"postalCode":{"type":"string"},"physicalType":{"type":"object","properties":{"system":{"type":"string"},"code":{"type":"string"}},"required":["code"],"additionalProperties":false},"description":{"type":"string"},"position":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}},"required":["latitude","longitude"],"additionalProperties":false}},"additionalProperties":false},"serviceTypes":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string"},"code":{"type":"string"},"display":{"type":"string"}},"additionalProperties":false}},"specialties":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string"},"code":{"type":"string"},"display":{"type":"string"}},"additionalProperties":false}},"bookingMethod":{"type":"string","enum":["online","phone","contact"]},"isVirtual":{"type":"boolean"},"acceptingPatients":{"type":"string","enum":["nopt","newpt","existptonly","existptfam"]},"nextAvailableStart":{"type":"string","format":"date-time"},"totalSlots":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["key","publisher","serviceTypes","specialties","bookingMethod","totalSlots"],"additionalProperties":false},"SchedulingPublisher":{"type":"object","properties":{"slug":{"type":"string","minLength":1},"displayName":{"type":"string","minLength":1},"manifestUrl":{"type":"string","format":"uri"},"enabled":{"type":"boolean"}},"required":["slug","displayName","manifestUrl","enabled"],"additionalProperties":false},"SchedulingServiceType":{"type":"object","properties":{"system":{"type":"string"},"code":{"type":"string"},"display":{"type":"string"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["count"],"additionalProperties":false},"SchedulingSpecialty":{"type":"object","properties":{"system":{"type":"string"},"code":{"type":"string"},"display":{"type":"string"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["count"],"additionalProperties":false},"SearchSlotsResponse":{"type":"object","properties":{"slots":{"type":"array","items":{"$ref":"#/components/schemas/SchedulingSlot"}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["slots","total"],"additionalProperties":false},"SearchProviderLocationsResponse":{"type":"object","properties":{"providerLocations":{"type":"array","items":{"$ref":"#/components/schemas/SchedulingProviderLocation"}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["providerLocations","total"],"additionalProperties":false},"ListPublishersResponse":{"type":"object","properties":{"publishers":{"type":"array","items":{"$ref":"#/components/schemas/SchedulingPublisher"}}},"required":["publishers"],"additionalProperties":false},"ListServiceTypesResponse":{"type":"object","properties":{"serviceTypes":{"type":"array","items":{"$ref":"#/components/schemas/SchedulingServiceType"}}},"required":["serviceTypes"],"additionalProperties":false},"ListSpecialtiesResponse":{"type":"object","properties":{"specialties":{"type":"array","items":{"$ref":"#/components/schemas/SchedulingSpecialty"}}},"required":["specialties"],"additionalProperties":false},"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"]},"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},"Parameters":{"type":"object","description":"A FHIR R4 [Parameters](https://hl7.org/fhir/R4/parameters.html).","properties":{"resourceType":{"type":"string","const":"Parameters"},"parameter":{"type":"array","items":{"type":"object","additionalProperties":true}}},"required":["resourceType"],"additionalProperties":true},"CapabilityStatement":{"type":"object","description":"A FHIR R4 [CapabilityStatement](https://hl7.org/fhir/R4/capabilitystatement.html).","properties":{"resourceType":{"type":"string","const":"CapabilityStatement"}},"required":["resourceType"],"additionalProperties":true},"TerminologyCapabilities":{"type":"object","description":"A FHIR R4 [TerminologyCapabilities](https://hl7.org/fhir/R4/terminologycapabilities.html).","properties":{"resourceType":{"type":"string","const":"TerminologyCapabilities"}},"required":["resourceType"],"additionalProperties":true},"ValueSet":{"type":"object","description":"A FHIR R4 [ValueSet](https://hl7.org/fhir/R4/valueset.html).","properties":{"resourceType":{"type":"string","const":"ValueSet"}},"required":["resourceType"],"additionalProperties":true},"Practitioner":{"type":"object","description":"A FHIR R4 [Practitioner](https://hl7.org/fhir/R4/practitioner.html).","properties":{"resourceType":{"type":"string","const":"Practitioner"}},"required":["resourceType"],"additionalProperties":true},"PractitionerRole":{"type":"object","description":"A FHIR R4 [PractitionerRole](https://hl7.org/fhir/R4/practitionerrole.html).","properties":{"resourceType":{"type":"string","const":"PractitionerRole"}},"required":["resourceType"],"additionalProperties":true},"Organization":{"type":"object","description":"A FHIR R4 [Organization](https://hl7.org/fhir/R4/organization.html).","properties":{"resourceType":{"type":"string","const":"Organization"}},"required":["resourceType"],"additionalProperties":true},"OrganizationAffiliation":{"type":"object","description":"A FHIR R4 [OrganizationAffiliation](https://hl7.org/fhir/R4/organizationaffiliation.html).","properties":{"resourceType":{"type":"string","const":"OrganizationAffiliation"}},"required":["resourceType"],"additionalProperties":true},"HealthcareService":{"type":"object","description":"A FHIR R4 [HealthcareService](https://hl7.org/fhir/R4/healthcareservice.html).","properties":{"resourceType":{"type":"string","const":"HealthcareService"}},"required":["resourceType"],"additionalProperties":true},"Location":{"type":"object","description":"A FHIR R4 [Location](https://hl7.org/fhir/R4/location.html).","properties":{"resourceType":{"type":"string","const":"Location"}},"required":["resourceType"],"additionalProperties":true},"Endpoint":{"type":"object","description":"A FHIR R4 [Endpoint](https://hl7.org/fhir/R4/endpoint.html).","properties":{"resourceType":{"type":"string","const":"Endpoint"}},"required":["resourceType"],"additionalProperties":true},"Questionnaire":{"type":"object","description":"A FHIR R4 [Questionnaire](https://hl7.org/fhir/R4/questionnaire.html).","properties":{"resourceType":{"type":"string","const":"Questionnaire"}},"required":["resourceType"],"additionalProperties":true},"InsurancePlan":{"type":"object","description":"A FHIR R4 [InsurancePlan](https://hl7.org/fhir/R4/insuranceplan.html).","properties":{"resourceType":{"type":"string","const":"InsurancePlan"}},"required":["resourceType"],"additionalProperties":true}}}}