> ## Documentation Index
> Fetch the complete documentation index at: https://docs.haau3.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Read a Location

> Read one location by id. Served read-only so that `Location` references returned by this service resolve here; locations cannot be searched.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/fhir/r4/Location/{id}
openapi: 3.1.0
info:
  title: haau3 Platform API
  version: 1.0.0
  description: >-
    The haau3 platform API (non-PHI). Endpoints require a free API key — send it
    as `Authorization: Bearer <key>`. Requests without a valid key return 401.
    Create a key in the dashboard at https://platform.haau3.com.
servers:
  - url: https://api.haau3.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Scheduling
    description: Provider availability (SMART Scheduling Links) — slots and publishers.
  - name: Terminology
    description: FHIR terminology operations — CodeSystem lookups against LOINC.
  - name: Provider directory
    description: >-
      FHIR Practitioner and PractitionerRole, resolved from the national
      provider directory. Resolution, not discovery: bring an NPI and get what
      the directory publishes for it.
paths:
  /v1/fhir/r4/Location/{id}:
    get:
      tags:
        - Provider directory
      summary: Read a Location
      description: >-
        Read one location by id. Served read-only so that `Location` references
        returned by this service resolve here; locations cannot be searched.
      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.
      responses:
        '200':
          description: The Location, as the directory publishes it.
          content:
            application/fhir+json:
              schema:
                type: object
                additionalProperties: true
        '400':
          description: >-
            The id is not a valid FHIR id. 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'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '404':
          description: No such resource, or no such interaction on this base.
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '406':
          description: >-
            A FHIR release this endpoint does not serve was requested via the
            `fhirVersion` media-type parameter.
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '502':
          description: >-
            The directory could not be reached, or answered in a shape that
            cannot be served. 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'
        '503':
          description: The directory is rate limiting requests.
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '504':
          description: The directory did not respond in time.
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
components:
  schemas:
    OperationOutcome:
      type: object
      properties:
        resourceType:
          type: string
          enum:
            - 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
    AuthError:
      type: object
      properties:
        error:
          type: string
          examples:
            - API key required
        message:
          type: string
      required:
        - error
        - message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your platform API key (`haau3_sk_…`), sent as `Authorization: Bearer
        <key>`.

````