Optum

Optum Health Check API

The Health Check API from Optum — 7 operation(s) for health check.

GitHub OpenAPI

Operations 21

GET /healthcheck Health Check #
GET /medicalnetwork/eligibility/v3/healthcheck Health Check #
GET /medicalnetwork/institutionalclaims/v1/healthcheck Health Check #
GET /medicalnetwork/professionalclaims/v3/healthcheck Health Check #
GET /medicalnetwork/payerlist/v1/healthcheck Health Check #
GET /oihub/dental/claim/inquiry/v1/healthcheck Health Check #
GET /oihub/dnt/enh/eligibility/preservice/v1/healthcheck Health Check #
GET /abm/dsrservicehc/v1 Health check endpoint for the Decision Support API (GET /abm/dsrservicehc/v1) #
GET /oihub/patient/auth/referral/v1/healthcheck Health Check #
GET /oihub/claim/actions/v1/healthcheck Health Check #
GET /oihub/claim/inquiry/v1/healthcheck Health Check #
GET /oihub/document/search/v1/healthcheck Health Check #
GET /oihub/eligibility/v1/healthcheck Health Check #
GET /rcm/eligibility/v1/healthcheck Validate the status of the system #
GET /health/formatting-rules Health check endpoint for the formatting rule engine #
GET /pre-service/v1/healthcheck Health Check #
GET /oihub/patient/benefit/check/v1/healthcheck Health Check #
GET /py/oihub/claim/dnt/submit/v1/health-check Health Check Endpoint #
GET /oihub/fhirpriorauth/v1/health-check Health Check #
GET /oihub/fhirprovideraccess/v1/health-check Health Check #
GET /health/telecom-formatter Health check endpoint for the telecom-formatter #

Documentation

📖
APIReference
https://developer.optum.com/eligibilityandclaims/reference/api-overview
📖
GettingStarted
https://developer.optum.com/eligibilityandclaims/docs/get-started-with-optum-api
📖
Authentication
https://developer.optum.com/eligibilityandclaims/docs/optum-security-and-authorization
📖
APIReference
https://developer.optum.com/optumreal-dental/reference/overview-real-dental
📖
GettingStarted
https://developer.optum.com/optumreal-dental/reference/get-started
📖
APIReference
https://developer.optum.com/pharmacysolutions/reference
📖
APIReference
https://developer.optum.com/paymentandreimbursement/reference
📖
APIReference
https://developer.optum.com/platformandinteroperability/reference
📖
APIReference
https://developer.optum.com/analyticsandinsights/reference
📖
APIReference
https://developer.optum.com/apitools/reference/security-and-authorization-v2-overview
📖
Documentation
https://developer.optum.com/apitools/docs/getting-started

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optum/refs/heads/main/openapi/optum-health-check-api-openapi.yml

Other Resources

🔗
ChangeLog
https://developer.optum.com/eligibilityandclaims/docs/eligibility-release-notes

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/optum-health-check-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

optum-health-check-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Optum Health Check API
  x-refined-note:
  - x-shortDescription differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Health Check across 13 of this provider''s published API definitions: optum-medical-network-attachment-retrieval-v1-openapi.yml, optum-medical-network-attachment-status-v1-openapi.yml, optum-medical-network-attachments-submission-v1-openapi.yml, optum-medical-network-claims-responses-and-reports-v2-openapi.yml, optum-medical-network-eligibility-v3-openapi.yml, optum-medical-network-institutional-claims-v1-openapi.yml, optum-medical-network-professional-claims-v3-openapi.yml…'
servers:
- url: https://sandbox-apigw.optum.com/medicalnetwork/attachments/retrieval/v1
- url: https://sandbox-apigw.optum.com/medicalnetwork/attachments/status/v1
- url: https://sandbox-apigw.optum.com/medicalnetwork/attachments/submission/v1/
  description: Optum
- url: https://sandbox-apigw.optum.com/medicalnetwork/reports/v2
  description: Optum
- url: https://sandbox-apigw.optum.com
  description: ''
- url: https://sandbox-apigw.optum.com/rcm/prior-authorization/v1/
- url: /processor
- url: https://sandbox-apigw.optum.com/dental/attachments/v1
  description: ''
- url: https://sandbox-apigw.optum.com/pharmacynetwork/submitter/v1
  description: Generated server url
tags:
- name: Health Check
paths:
  /healthcheck:
    get:
      operationId: healthCheck
      summary: Health Check
      responses:
        '200':
          content:
            '*/*':
              schema:
                type: object
                properties:
                  status:
                    type: string
          description: OK
      tags:
      - Health Check
      security:
      - bearerToken: []
    servers:
    - url: https://sandbox-apigw.optum.com/medicalnetwork/attachments/retrieval/v1
  /medicalnetwork/eligibility/v3/healthcheck:
    get:
      tags:
      - Health Check
      summary: Health Check
      operationId: healthCheck
      parameters:
      - name: Authorization
        in: header
        description: 'Bearer Your-Access-Token<br/> Example: <b>Bearer eyJraWQiOiIxIiwid…</b>'
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HealthCheck_2'
    servers:
    - url: https://sandbox-apigw.optum.com
      description: ''
  /medicalnetwork/institutionalclaims/v1/healthcheck:
    get:
      tags:
      - Health Check
      summary: Health Check
      operationId: healthCheck
      parameters:
      - name: Authorization
        in: header
        description: 'Bearer Your-Access-Token<br/>Example: <b>Bearer eyJraWQiOiIxIiwid…</b>'
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
    servers:
    - url: https://sandbox-apigw.optum.com
      description: Optum
  /medicalnetwork/professionalclaims/v3/healthcheck:
    get:
      tags:
      - Health Check
      summary: Health Check
      operationId: healthCheck
      parameters:
      - name: Authorization
        in: header
        description: 'Bearer Your-Access-Token<br/>Example: <b>Bearer eyJraWQiOiIxIiwid…</b>'
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
    servers:
    - url: https://sandbox-apigw.optum.com
      description: Optum
  /medicalnetwork/payerlist/v1/healthcheck:
    get:
      tags:
      - Health Check
      summary: Health Check
      operationId: getPayerListHealthCheck
      responses:
        '200':
          description: Successful health check response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
      - bearerAuth: []
    servers:
    - url: https://sandbox-apigw.optum.com
      description: Sandbox
  /oihub/dental/claim/inquiry/v1/healthcheck:
    get:
      tags:
      - Health Check
      summary: Health Check
      description: Returns API health status.
      operationId: healthCheck
      security:
      - bearerAuth: []
      responses:
        '200':
          description: API is available
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckResponse_2'
              example:
                status: UP
        '401':
          description: Unauthorized
        '500':
          description: Internal server error
    servers:
    - url: https://sandbox-apigw.optum.com
  /oihub/dnt/enh/eligibility/preservice/v1/healthcheck:
    get:
      summary: Health Check
      description: Returns the health status for the Check Enhanced Dental Eligibility API.
      operationId: healthCheckEnhancedDentalEligibility
      tags:
      - Health Check
      security:
      - BearerAuth: []
      responses:
        '200':
          description: Health check successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: UP
        '401':
          description: Unauthorized
        '500':
          description: Internal Server Error
    servers:
    - url: https://sandbox-apigw.optum.com
  /abm/dsrservicehc/v1:
    get:
      tags:
      - Health Check
      summary: Health check endpoint for the Decision Support API (GET /abm/dsrservicehc/v1)
      responses:
        '200':
          description: OK
      operationId: getAbmDsrservicehcV1
      x-operation-id-source: derived
    servers:
    - url: https://sandbox-apigw.optum.com
      description: ABM Care Decision Support API server
  /oihub/patient/auth/referral/v1/healthcheck:
    get:
      summary: Health Check
      description: Performs a health check to validate the availability and operational status of the Auth Referral Submission Service.
      operationId: healthCheck
      security:
      - oAuth:
        - read_healthcheck
      tags:
      - Health Check
      responses:
        '200':
          description: Service is healthy - If the API engine is working correctly and if the entry points are accessible, the API operating status response shows "OK".
        '500':
          description: 'Service is unhealthy

            - **Note:** If you receive a response other than 200 OK, the health check failed. Please submit a ticket with Optum.

            '
    servers:
    - url: https://sandbox-apigw.optum.com
  /oihub/claim/actions/v1/healthcheck:
    get:
      summary: Health Check
      description: Performs a health check to validate the availability and operational status of the Claim Actions service.
      operationId: healthCheck
      security:
      - oAuth:
        - read_healthcheck
      tags:
      - Health Check
      responses:
        '200':
          description: Service is healthy - If the API engine is working correctly and if the entry points are accessible, the API operating status response shows "OK".
        '500':
          description: 'Service is unhealthy

            - **Note:** If you receive a response other than 200 OK, the health check failed. Please submit a ticket with Optum.

            '
    servers:
    - url: https://sandbox-apigw.optum.com
  /oihub/claim/inquiry/v1/healthcheck:
    get:
      summary: Health Check
      description: Performs a health check to validate the availability and operational status of the Claim Inquiry service.
      operationId: healthCheck
      security:
      - oAuth:
        - read_healthcheck
      tags:
      - Health Check
      responses:
        '200':
          description: Service is healthy - If the API engine is working correctly and if the entry points are accessible, the API operating status response shows "OK".
        '500':
          description: 'Service is unhealthy

            - **Note:** If you receive a response other than 200 OK, the health check failed. Please submit a ticket with Optum.

            '
    servers:
    - url: https://sandbox-apigw.optum.com
  /oihub/document/search/v1/healthcheck:
    get:
      summary: Health Check
      description: Performs a health check to validate the availability and operational status of the Document Search API Service.
      operationId: healthCheck
      security:
      - oAuth:
        - read_healthcheck
      tags:
      - Health Check
      responses:
        '200':
          description: Service is healthy - If the API engine is working correctly and if the entry points are accessible, the API operating status response shows "OK".
        '500':
          description: 'Service is unhealthy

            - **Note:** If you receive a response other than 200 OK, the health check failed. Please submit a ticket with Optum.

            '
    servers:
    - url: https://sandbox-apigw.optum.com
  /oihub/eligibility/v1/healthcheck:
    get:
      summary: Health Check
      description: Performs a health check to validate the availability and operational status of the Eligibility Pre Service.
      operationId: healthCheck
      security:
      - oAuth:
        - read_healthcheck
      tags:
      - Health Check
      responses:
        '200':
          description: Service is healthy - If the API engine is working correctly and if the entry points are accessible, the API operating status response shows "OK".
        '500':
          description: 'Service is unhealthy

            - **Note:** If you receive a response other than 200 OK, the health check failed. Please submit a ticket with Optum.

            '
    servers:
    - url: https://sandbox-apigw.optum.com
  /rcm/eligibility/v1/healthcheck:
    get:
      tags:
      - Health Check
      summary: Validate the status of the system
      description: A healthcheck of the Enhanced Eligibility workflow
      security:
      - oAuth:
        - read_healthcheck
      operationId: healthcheck
      responses:
        '200':
          $ref: '#/components/responses/HealthcheckHealthyResponse'
        '401':
          $ref: '#/components/responses/PermissionDeniedError'
        '500':
          $ref: '#/components/responses/HealthcheckUnhealthyResponse'
    servers:
    - url: https://sandbox-apigw.optum.com
      description: Sandbox server (uses test data)
    - url: https://apigw.optum.com
      description: Production server (uses live data)
  /health/formatting-rules:
    get:
      responses:
        '200':
          description: OK
      summary: Health check endpoint for the formatting rule engine
      tags:
      - Health Check
      security:
      - oauth2_security: []
      operationId: getHealthFormattingRules
      x-operation-id-source: derived
    servers:
    - description: Generated server url
      url: https://sandbox-apigw.optum.com/rxn/formattingrules
  /pre-service/v1/healthcheck:
    get:
      summary: Health Check
      description: API Health Check - The health check endpoint checks the operating status of our APIs. It is a ping for the APIs entry point to ensure the entry points are accessible. This is the first thing you can do if something goes wrong.
      operationId: healthCheck
      security:
      - oAuth:
        - read_healthcheck
      tags:
      - Health Check
      responses:
        '200':
          description: Service is healthy - If the API engine is working correctly and if the entry points are accessible, the API operating status response shows "OK".
        '500':
          description: 'Service is unhealthy

            - **Note:** If you receive a response other than 200 OK, the health check failed. Please submit a ticket with Optum.

            '
    servers:
    - url: https://sandbox-apigw.optum.com/oihub
  /oihub/patient/benefit/check/v1/healthcheck:
    get:
      summary: Health Check
      description: Performs a health check to validate the availability and operational status of the Patient Benefit Check Service.
      operationId: healthCheck
      security:
      - oAuth:
        - read_healthcheck
      tags:
      - Health Check
      responses:
        '200':
          description: Service is healthy - If the API engine is working correctly and if the entry points are accessible, the API operating status response shows "OK".
        '500':
          description: 'Service is unhealthy

            - **Note:** If you receive a response other than 200 OK, the health check failed. Please submit a ticket with Optum.

            '
    servers:
    - url: https://sandbox-apigw.optum.com
  /py/oihub/claim/dnt/submit/v1/health-check:
    get:
      responses:
        '200':
          description: Service is healthy
        '500':
          description: Service is unhealthy
      operationId: healthCheck
      tags:
      - Health Check
      summary: Health Check Endpoint
      security:
      - bearerAuth: []
    servers:
    - url: https://sandbox-apigw.optum.com
  /oihub/fhirpriorauth/v1/health-check:
    get:
      summary: Health Check
      description: Performs a health check to validate the availability and operational status of the FHIR Prior Auth.
      operationId: healthCheck
      security:
      - oAuth:
        - read_healthcheck
      tags:
      - Health Check
      responses:
        '200':
          description: Service is healthy - If the API engine is working correctly and if the entry points are accessible, the API operating status response shows "OK".
        '500':
          description: 'Service is unhealthy

            - **Note:** If you receive a response other than 200 OK, the health check failed. Please submit a ticket with Optum.

            '
    servers:
    - url: https://sandbox-apigw.optum.com
  /oihub/fhirprovideraccess/v1/health-check:
    get:
      summary: Health Check
      description: Performs a health check to validate the availability and operational status of the FHIR Provider Access.
      operationId: healthCheck
      security:
      - oAuth:
        - read_healthcheck
      tags:
      - Health Check
      responses:
        '200':
          description: Service is healthy - If the API engine is working correctly and if the entry points are accessible, the API operating status response shows "OK".
        '500':
          description: 'Service is unhealthy

            - **Note:** If you receive a response other than 200 OK, the health check failed. Please submit a ticket with Optum.

            '
    servers:
    - url: https://sandbox-apigw.optum.com
  /health/telecom-formatter:
    get:
      responses:
        '200':
          description: OK
      summary: Health check endpoint for the telecom-formatter
      tags:
      - Health Check
      security:
      - oauth2_security: []
      operationId: getHealthTelecomFormatter
      x-operation-id-source: derived
    servers:
    - description: Generated server url
      url: ' https://sandbox-apigw.optum.com/rxn/telecomformatter'
components:
  schemas:
    HealthCheck:
      title: HealthCheck
      required:
      - version
      type: object
      properties:
        version:
          type: string
        status:
          type: string
          description: NM101 60 char, required
    HealthCheck_2:
      type: object
      properties:
        status:
          type: string
          description: Health Status
        version:
          type: string
          description: API version
    HealthCheckResponse:
      type: object
      additionalProperties: true
      description: Health check response. Exact schema was not provided in the source collection.
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        details:
          type: array
          items:
            type: string
    ErrorResponse_2:
      type: object
      properties:
        type:
          type: string
          format: uri
          default: about/blank
          example: https://api-stg.uhg.com/errors/attachment-type-detection
          description: The problem type URI. Defaults to `about:blank`.
        title:
          type: string
          example: Invalid Attachment Format
          description: A short, human-readable summary of the problem.
        detail:
          type: string
          example: The provided attachment format is not supported.
          description: A detailed explanation of the problem.
        status:
          type: integer
          format: int32
          example: 400
          maximum: 599
          minimum: 100
          description: The HTTP status code for the problem.
        instance:
          type: string
          format: uri
          example: https://api-stg.uhg.com/errors/attachment-type-detection/12345
          description: A URI reference that identifies the specific occurrence of the problem.
        properties:
          type: object
          properties:
            errors:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                    example: DENTATT_113
                    description: A code that can be correlated to this error.
                  field:
                    type: string
                    example: DataService.attachments.find.notFound
                    description: The field in a request that is related to this error, if applicable.
                  message:
                    type: string
                    example: Attachment not found.
                    description: A human readable message that describes the error.
              description: A collection that gives specifics about the errors that occurred.
          description: A map of additional, non-standard properties.
      description: Representation for an RFC 9457 problem detail.
    HealthCheckResponse_2:
      type: object
      properties:
        status:
          type: string
          example: UP
    HealthCheck_3:
      type: object
      properties:
        status:
          type: string
          description: Health Status
        version:
          type: string
          description: API version
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    HealthcheckHealthyResponse:
      description: OK
      headers:
        x-optum-tenant-id:
          $ref: '#/components/headers/tenantid'
        x-optum-correlation-id:
          $ref: '#/components/headers/correlationid'
        x-optum-trace-id:
          $ref: '#/components/headers/traceid'
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                example: ok
    HealthcheckUnhealthyResponse:
      description: Internal Server Error
      headers:
        x-optum-tenant-id:
          $ref: '#/components/headers/tenantid'
        x-optum-correlation-id:
          $ref: '#/components/headers/correlationid'
        x-optum-trace-id:
          $ref: '#/components/headers/traceid'
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                example: unhealthy
    PermissionDeniedError:
      description: Unauthorized.
      headers:
        x-optum-subtenant-id:
          $ref: '#/components/headers/subtenantid'
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: invalid_product
              error_description:
                type: string
                example: Permission Denied.
              traceId:
                type: string
                example: 942537e6-d544-ed7c-469b-a27efc4a6cff
  securitySchemes:
    bearerToken:
      type: apiKey
      name: Authorization
      in: header
    bearer-key:
      type: http
      scheme: bearer
      bearerFormat: JWT
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    oAuth:
      type: oauth2
      description: This API uses OAuth 2 with the client_credentials grant flow.
      flows:
        clientCredentials:
          tokenUrl: /apip/auth/sntl/v1/token
          scopes:
            read_txn: read transactions
            create_txn: submit a new transaction request
            read_coveragediscovery: read coverage discovery tasks
            create_coveragediscovery: submit a new coverage discovery task
            read_healthcheck: check the status of the system
    oauth2_security:
      flows:
        clientCredentials:
          scopes: {}
          tokenUrl: https://idx-stage.linkhealth.com/auth/realms/developer-platform/protocol/openid-connect/token
      type: oauth2
  headers:
    traceid:
      schema:
        type: string
        example: 9fb77454-8c58-4345-aa50-43f133e06d20
      description: A unique identifier value that is attached to the response that allow reference to the original request.
    correlationid:
      schema:
        type: string
        example: 9fb77454-8c58-4345-aa50-43f133e06d20
      description: A unique identifier value that is attached to the response that allow reference to the original request. Differs from `x-optum-trace-id` as the correlation-id is stored within the datastore for future queryability.
    tenantid:
      schema:
        type: string
        example: 9fb77454-8c58-4345-aa50-43f133e06d20
      description: The unique ID of the tenant that invoking user belongs to. Used to enforce data tenancy.
    subtenantid:
      schema:
        type: string
        example: 5e2f9f4f-6f1d-4b37-92b5-6c5a9d1f8a21
      description: (Optional) Identifies an Optum-assigned sub-tenant configuration for your organization. Include this header only when Optum has provided a value for a specific enabled customer configuration. Clients must not generate or infer this value.
x-refined-from:
- optum-medical-network-attachment-retrieval-v1-openapi.yml
- optum-medical-network-attachment-status-v1-openapi.yml
- optum-medical-network-attachments-submission-v1-openapi.yml
- optum-medical-network-claims-responses-and-reports-v2-openapi.yml
- optum-medical-network-eligibility-v3-openapi.yml
- optum-medical-network-institutional-claims-v1-openapi.yml
- optum-medical-network-professional-claims-v3-openapi.yml
- optum-payer-list-api-v1-openapi.yml
- optum-prior-authorization-v1-openapi.yml
- optum-real-dental-attachments-api-openapi.yml
- optum-real-dental-claim-status-api-openapi.yml
- optum-real-dental-pre-care-eligibility-intelligence-api-openapi.yml
- optum-submitter-api-openapi.yml
x-readme:
  explorer-enabled: true
  proxy-enabled: true