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

# Get a patient's Passport profile

> The patient's profile as Patient Passport holds it: name, birth date, phone, time zone and shipping address.

**Availability:** Patient Passport answers only for organizations enabled for it. Any other organization gets 403 `ORG_NOT_ENABLED`; ask your OLH implementation contact to enable yours.

Service tokens only: a user token gets 403 `FORBIDDEN`. Every response carries `Cache-Control: no-store`.

**Permissions:** `patients:read`



## OpenAPI

````yaml /openapi.json get /passport/profile
openapi: 3.1.0
info:
  title: OpenLoop API
  version: 0.1.0
  description: >-
    Unified reference for the OpenLoop Patient (clinical) and Payments & Revenue
    APIs.
servers:
  - url: https://api.openloophealth.com/v0.1
    description: Production partner edge
  - url: https://api-staging.openloophealth.com/v0.1
    description: Staging partner edge (sandbox credentials)
security: []
paths:
  /passport/profile:
    get:
      tags:
        - Patient Passport
      summary: Get a patient's Passport profile
      description: >-
        The patient's profile as Patient Passport holds it: name, birth date,
        phone, time zone and shipping address.


        **Availability:** Patient Passport answers only for organizations
        enabled for it. Any other organization gets 403 `ORG_NOT_ENABLED`; ask
        your OLH implementation contact to enable yours.


        Service tokens only: a user token gets 403 `FORBIDDEN`. Every response
        carries `Cache-Control: no-store`.


        **Permissions:** `patients:read`
      parameters:
        - name: patient_id
          in: query
          required: true
          schema:
            type: string
            format: uuid
          description: >-
            The patient's `id` in the Partner API, the same `id` that `GET
            /patients` returns. Anything that isn't a UUID answers 404.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/PassportProfile'
                  request_id:
                    type: string
                required:
                  - data
                  - request_id
        '401':
          description: >-
            Missing or invalid access token. The Partner API answers this before
            the request reaches Patient Passport.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            `error_code` says why: `FORBIDDEN` (the token lacks `patients:read`,
            or isn't a partner service token), `ORG_NOT_MAPPED` (your
            organization has no Healthie organization linked) or
            `ORG_NOT_ENABLED` (your organization isn't enabled for Patient
            Passport).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: >-
            `PATIENT_NOT_FOUND`: no patient with that id in your organization,
            or `patient_id` isn't a UUID. The cases are deliberately
            indistinguishable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: >-
            `PATIENT_IDENTITY_UNRESOLVED`: the patient can't be matched to a
            single Patient Passport record. Quote `request_id` to support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: '`VALIDATION_ERROR`: `patient_id` is missing.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: >-
            Too many requests. The route is throttled at 100 requests per
            second, with bursts of 120. Back off and retry.
        '500':
          description: >-
            `UNHANDLED_EXCEPTION`: something failed that names no cause. Quote
            `request_id` to support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: >-
            `UPSTREAM_UNAVAILABLE`: patient data is temporarily unavailable.
            Safe to retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '504':
          description: Patient Passport didn't answer within 29 seconds. Safe to retry.
      security:
        - serviceToken:
            - patients:read
components:
  schemas:
    PassportProfile:
      type: object
      properties:
        patient_id:
          type: string
          format: uuid
          description: The patient `id` you sent, lower-cased.
        first_name:
          type: string
        last_name:
          type: string
        birth_date:
          type: string
          format: date
        phone_e164:
          type:
            - string
            - 'null'
          description: Phone number in E.164 format.
        timezone:
          type:
            - string
            - 'null'
          description: IANA time zone, e.g. `America/New_York`.
        shipping_address:
          anyOf:
            - $ref: '#/components/schemas/PassportShippingAddress'
            - type: 'null'
        synced_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When Patient Passport last synced this profile (UTC).
      required:
        - patient_id
        - first_name
        - last_name
        - birth_date
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            error_code:
              type: string
          required:
            - message
            - error_code
        request_id:
          type: string
      required:
        - error
        - request_id
    PassportShippingAddress:
      type: object
      properties:
        line1:
          type: string
        line2:
          type:
            - string
            - 'null'
        city:
          type: string
        state:
          type: string
        postal_code:
          type: string
        country:
          type: string
      required:
        - line1
        - city
        - state
        - postal_code
        - country
  securitySchemes:
    serviceToken:
      type: oauth2
      description: >-
        Service (M2M) access token issued by POST /auth/token using the
        client_credentials grant. Required scopes, where known, are listed on
        each operation below.
      flows:
        clientCredentials:
          tokenUrl: https://api.openloophealth.com/v0.1/auth/token
          scopes: {}

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.