xCures

xCures FHIR API

**F**ast **H**ealthcare **I**nteroperability **R**esource is an international data model specification developed by HL7 International to enable healthcare data exchange and interoperability between different systems.

GitHub OpenAPI

Operations 13

GET /api/v1/patient-registry/fhir/allergyintolerance Allergy Intolerances #
GET /api/v1/patient-registry/fhir/basic Basics #
GET /api/v1/patient-registry/fhir/careplan Care Plans #
GET /api/v1/patient-registry/fhir/coverage Coverages #
GET /api/v1/patient-registry/fhir/condition Conditions #
GET /api/v1/patient-registry/fhir/diagnosticreport Diagnostic Reports #
GET /api/v1/patient-registry/fhir/encounter Encounters #
GET /api/v1/patient-registry/fhir/medicationstatement Medication Statements #
GET /api/v1/patient-registry/fhir/patient Patients #
GET /api/v1/patient-registry/fhir/procedure Procedures #
GET /api/v1/patient-registry/fhir/observation Observations #
GET /api/v1/patient-registry/fhir/specimen Specimens #
GET /api/v1/patient-registry/fhir/_export Export FHIR Resources #

Documentation

📖
Documentation
https://docs.xcures.com/api-introduction
📖
APIReference
https://docs.xcures.com/apis/current
📖
GettingStarted
https://docs.xcures.com/api-introduction
📖
Authentication
https://artifacts.apis.io/xcures/authentication/xcures-authentication.yml
📖
RateLimits
https://artifacts.apis.io/xcures/rate-limits/xcures-rate-limits.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/xcures/openapi/xcures-fhir-api-openapi.yml

Other Resources

🔗
Postman
https://docs.xcures.com/downloads/xCures_SDK_Workflows.postman_collection.json
🔗
ChangeLog
https://docs.xcures.com/changelog
🔗
Webhooks
https://artifacts.apis.io/xcures/asyncapi/xcures-application-webhooks.yml
🔗
ErrorCatalog
https://artifacts.apis.io/xcures/errors/xcures-problem-types.yml
🔗
DataModel
https://artifacts.apis.io/xcures/data-model/xcures-data-model.yml

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/xcures:xcures-fhir-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

xcures-fhir-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: xCures FHIR API
  description: '# Authentication

    Our API requires a Bearer Token in the `Authorization` header for auth.'
  version: V1
  x-logo:
    url: https://prod-xc-public-marketing.s3.us-west-2.amazonaws.com/xCures-emails-logo.png
servers:
- url: https://partner.xcures.com
tags:
- name: FHIR
  description: '**F**ast **H**ealthcare **I**nteroperability **R**esource is an international data model specification developed by HL7 International to enable healthcare data exchange and interoperability between different systems.'
paths:
  /api/v1/patient-registry/fhir/allergyintolerance:
    get:
      operationId: PublicFhirController_allergyIntolerance
      summary: Allergy Intolerances
      description: Search the specific FHIR resources by `subjectId`. For the latest documentation of the response, please see the Resource Bundle definition in the FHIR spec.
      parameters:
      - name: ProjectId
        in: header
        required: true
        schema:
          type: string
          format: uuid
          example: e6b01018-a333-4732-917e-fe38e91b0fdf
      - name: pageNumber
        required: true
        in: query
        schema:
          default: 1
          type: number
      - name: pageSize
        required: true
        in: query
        schema:
          default: 50
          type: number
      - name: subjectId
        required: true
        in: query
        schema:
          format: uuid
          type: string
      responses:
        '400':
          description: ''
        '401':
          description: ''
        '403':
          description: ''
        '429':
          description: ''
        default:
          description: Please see the <a href="https://hl7.org/fhir/R4/bundle.html" target="_blank">Resource Bundle definition in the FHIR spec.</a>
          headers:
            content-type:
              schema:
                type: string
                enum:
                - application/json+fhir
      tags:
      - FHIR
      security:
      - bearer: []
  /api/v1/patient-registry/fhir/basic:
    get:
      operationId: PublicFhirController_basic
      summary: Basics
      description: Search the specific FHIR resources by `subjectId`. For the latest documentation of the response, please see the Resource Bundle definition in the FHIR spec.
      parameters:
      - name: ProjectId
        in: header
        required: true
        schema:
          type: string
          format: uuid
          example: e6b01018-a333-4732-917e-fe38e91b0fdf
      - name: pageNumber
        required: true
        in: query
        schema:
          default: 1
          type: number
      - name: pageSize
        required: true
        in: query
        schema:
          default: 50
          type: number
      - name: subjectId
        required: true
        in: query
        schema:
          format: uuid
          type: string
      responses:
        '400':
          description: ''
        '401':
          description: ''
        '403':
          description: ''
        '429':
          description: ''
        default:
          description: Please see the <a href="https://hl7.org/fhir/R4/bundle.html" target="_blank">Resource Bundle definition in the FHIR spec.</a>
          headers:
            content-type:
              schema:
                type: string
                enum:
                - application/json+fhir
      tags:
      - FHIR
      security:
      - bearer: []
  /api/v1/patient-registry/fhir/careplan:
    get:
      operationId: PublicFhirController_carePlan
      summary: Care Plans
      description: Search the specific FHIR resources by `subjectId`. For the latest documentation of the response, please see the Resource Bundle definition in the FHIR spec.
      parameters:
      - name: ProjectId
        in: header
        required: true
        schema:
          type: string
          format: uuid
          example: e6b01018-a333-4732-917e-fe38e91b0fdf
      - name: pageNumber
        required: true
        in: query
        schema:
          default: 1
          type: number
      - name: pageSize
        required: true
        in: query
        schema:
          default: 50
          type: number
      - name: subjectId
        required: true
        in: query
        schema:
          format: uuid
          type: string
      responses:
        '400':
          description: ''
        '401':
          description: ''
        '403':
          description: ''
        '429':
          description: ''
        default:
          description: Please see the <a href="https://hl7.org/fhir/R4/bundle.html" target="_blank">Resource Bundle definition in the FHIR spec.</a>
          headers:
            content-type:
              schema:
                type: string
                enum:
                - application/json+fhir
      tags:
      - FHIR
      security:
      - bearer: []
  /api/v1/patient-registry/fhir/coverage:
    get:
      operationId: PublicFhirController_coverage
      summary: Coverages
      description: Search the specific FHIR resources by `subjectId`. For the latest documentation of the response, please see the Resource Bundle definition in the FHIR spec.
      parameters:
      - name: ProjectId
        in: header
        required: true
        schema:
          type: string
          format: uuid
          example: e6b01018-a333-4732-917e-fe38e91b0fdf
      - name: pageNumber
        required: true
        in: query
        schema:
          default: 1
          type: number
      - name: pageSize
        required: true
        in: query
        schema:
          default: 50
          type: number
      - name: subjectId
        required: true
        in: query
        schema:
          format: uuid
          type: string
      responses:
        '400':
          description: ''
        '401':
          description: ''
        '403':
          description: ''
        '429':
          description: ''
        default:
          description: Please see the <a href="https://hl7.org/fhir/R4/bundle.html" target="_blank">Resource Bundle definition in the FHIR spec.</a>
          headers:
            content-type:
              schema:
                type: string
                enum:
                - application/json+fhir
      tags:
      - FHIR
      security:
      - bearer: []
  /api/v1/patient-registry/fhir/condition:
    get:
      operationId: PublicFhirController_condition
      summary: Conditions
      description: Search the specific FHIR resources by `subjectId`. For the latest documentation of the response, please see the Resource Bundle definition in the FHIR spec.
      parameters:
      - name: ProjectId
        in: header
        required: true
        schema:
          type: string
          format: uuid
          example: e6b01018-a333-4732-917e-fe38e91b0fdf
      - name: pageNumber
        required: true
        in: query
        schema:
          default: 1
          type: number
      - name: pageSize
        required: true
        in: query
        schema:
          default: 50
          type: number
      - name: subjectId
        required: true
        in: query
        schema:
          format: uuid
          type: string
      responses:
        '400':
          description: ''
        '401':
          description: ''
        '403':
          description: ''
        '429':
          description: ''
        default:
          description: Please see the <a href="https://hl7.org/fhir/R4/bundle.html" target="_blank">Resource Bundle definition in the FHIR spec.</a>
          headers:
            content-type:
              schema:
                type: string
                enum:
                - application/json+fhir
      tags:
      - FHIR
      security:
      - bearer: []
  /api/v1/patient-registry/fhir/diagnosticreport:
    get:
      operationId: PublicFhirController_diagnosticReport
      summary: Diagnostic Reports
      description: Search the specific FHIR resources by `subjectId`. For the latest documentation of the response, please see the Resource Bundle definition in the FHIR spec.
      parameters:
      - name: ProjectId
        in: header
        required: true
        schema:
          type: string
          format: uuid
          example: e6b01018-a333-4732-917e-fe38e91b0fdf
      - name: pageNumber
        required: true
        in: query
        schema:
          default: 1
          type: number
      - name: pageSize
        required: true
        in: query
        schema:
          default: 50
          type: number
      - name: subjectId
        required: true
        in: query
        schema:
          format: uuid
          type: string
      responses:
        '400':
          description: ''
        '401':
          description: ''
        '403':
          description: ''
        '429':
          description: ''
        default:
          description: Please see the <a href="https://hl7.org/fhir/R4/bundle.html" target="_blank">Resource Bundle definition in the FHIR spec.</a>
          headers:
            content-type:
              schema:
                type: string
                enum:
                - application/json+fhir
      tags:
      - FHIR
      security:
      - bearer: []
  /api/v1/patient-registry/fhir/encounter:
    get:
      operationId: PublicFhirController_encounter
      summary: Encounters
      description: Search the specific FHIR resources by `subjectId`. For the latest documentation of the response, please see the Resource Bundle definition in the FHIR spec.
      parameters:
      - name: ProjectId
        in: header
        required: true
        schema:
          type: string
          format: uuid
          example: e6b01018-a333-4732-917e-fe38e91b0fdf
      - name: pageNumber
        required: true
        in: query
        schema:
          default: 1
          type: number
      - name: pageSize
        required: true
        in: query
        schema:
          default: 50
          type: number
      - name: subjectId
        required: true
        in: query
        schema:
          format: uuid
          type: string
      responses:
        '400':
          description: ''
        '401':
          description: ''
        '403':
          description: ''
        '429':
          description: ''
        default:
          description: Please see the <a href="https://hl7.org/fhir/R4/bundle.html" target="_blank">Resource Bundle definition in the FHIR spec.</a>
          headers:
            content-type:
              schema:
                type: string
                enum:
                - application/json+fhir
      tags:
      - FHIR
      security:
      - bearer: []
  /api/v1/patient-registry/fhir/medicationstatement:
    get:
      operationId: PublicFhirController_medicationstatement
      summary: Medication Statements
      description: Search the specific FHIR resources by `subjectId`. For the latest documentation of the response, please see the Resource Bundle definition in the FHIR spec.
      parameters:
      - name: ProjectId
        in: header
        required: true
        schema:
          type: string
          format: uuid
          example: e6b01018-a333-4732-917e-fe38e91b0fdf
      - name: pageNumber
        required: true
        in: query
        schema:
          default: 1
          type: number
      - name: pageSize
        required: true
        in: query
        schema:
          default: 50
          type: number
      - name: subjectId
        required: true
        in: query
        schema:
          format: uuid
          type: string
      responses:
        '400':
          description: ''
        '401':
          description: ''
        '403':
          description: ''
        '429':
          description: ''
        default:
          description: Please see the <a href="https://hl7.org/fhir/R4/bundle.html" target="_blank">Resource Bundle definition in the FHIR spec.</a>
          headers:
            content-type:
              schema:
                type: string
                enum:
                - application/json+fhir
      tags:
      - FHIR
      security:
      - bearer: []
  /api/v1/patient-registry/fhir/patient:
    get:
      operationId: PublicFhirController_patient
      summary: Patients
      description: Search the specific FHIR resources by `subjectId`. For the latest documentation of the response, please see the Resource Bundle definition in the FHIR spec.
      parameters:
      - name: ProjectId
        in: header
        required: true
        schema:
          type: string
          format: uuid
          example: e6b01018-a333-4732-917e-fe38e91b0fdf
      - name: pageNumber
        required: true
        in: query
        schema:
          default: 1
          type: number
      - name: pageSize
        required: true
        in: query
        schema:
          default: 50
          type: number
      - name: subjectId
        required: true
        in: query
        schema:
          format: uuid
          type: string
      responses:
        '400':
          description: ''
        '401':
          description: ''
        '403':
          description: ''
        '429':
          description: ''
        default:
          description: Please see the <a href="https://hl7.org/fhir/R4/bundle.html" target="_blank">Resource Bundle definition in the FHIR spec.</a>
          headers:
            content-type:
              schema:
                type: string
                enum:
                - application/json+fhir
      tags:
      - FHIR
      security:
      - bearer: []
  /api/v1/patient-registry/fhir/procedure:
    get:
      operationId: PublicFhirController_procedure
      summary: Procedures
      description: Search the specific FHIR resources by `subjectId`. For the latest documentation of the response, please see the Resource Bundle definition in the FHIR spec.
      parameters:
      - name: ProjectId
        in: header
        required: true
        schema:
          type: string
          format: uuid
          example: e6b01018-a333-4732-917e-fe38e91b0fdf
      - name: pageNumber
        required: true
        in: query
        schema:
          default: 1
          type: number
      - name: pageSize
        required: true
        in: query
        schema:
          default: 50
          type: number
      - name: subjectId
        required: true
        in: query
        schema:
          format: uuid
          type: string
      responses:
        '400':
          description: ''
        '401':
          description: ''
        '403':
          description: ''
        '429':
          description: ''
        default:
          description: Please see the <a href="https://hl7.org/fhir/R4/bundle.html" target="_blank">Resource Bundle definition in the FHIR spec.</a>
          headers:
            content-type:
              schema:
                type: string
                enum:
                - application/json+fhir
      tags:
      - FHIR
      security:
      - bearer: []
  /api/v1/patient-registry/fhir/observation:
    get:
      operationId: PublicFhirController_observation
      summary: Observations
      description: Search the specific FHIR resources by `subjectId`. For the latest documentation of the response, please see the Resource Bundle definition in the FHIR spec.
      parameters:
      - name: ProjectId
        in: header
        required: true
        schema:
          type: string
          format: uuid
          example: e6b01018-a333-4732-917e-fe38e91b0fdf
      - name: pageNumber
        required: true
        in: query
        schema:
          default: 1
          type: number
      - name: pageSize
        required: true
        in: query
        schema:
          default: 50
          type: number
      - name: subjectId
        required: true
        in: query
        schema:
          format: uuid
          type: string
      responses:
        '400':
          description: ''
        '401':
          description: ''
        '403':
          description: ''
        '429':
          description: ''
        default:
          description: Please see the <a href="https://hl7.org/fhir/R4/bundle.html" target="_blank">Resource Bundle definition in the FHIR spec.</a>
          headers:
            content-type:
              schema:
                type: string
                enum:
                - application/json+fhir
      tags:
      - FHIR
      security:
      - bearer: []
  /api/v1/patient-registry/fhir/specimen:
    get:
      operationId: PublicFhirController_specimen
      summary: Specimens
      description: Search the specific FHIR resources by `subjectId`. For the latest documentation of the response, please see the Resource Bundle definition in the FHIR spec.
      parameters:
      - name: ProjectId
        in: header
        required: true
        schema:
          type: string
          format: uuid
          example: e6b01018-a333-4732-917e-fe38e91b0fdf
      - name: pageNumber
        required: true
        in: query
        schema:
          default: 1
          type: number
      - name: pageSize
        required: true
        in: query
        schema:
          default: 50
          type: number
      - name: subjectId
        required: true
        in: query
        schema:
          format: uuid
          type: string
      responses:
        '400':
          description: ''
        '401':
          description: ''
        '403':
          description: ''
        '429':
          description: ''
        default:
          description: Please see the <a href="https://hl7.org/fhir/R4/bundle.html" target="_blank">Resource Bundle definition in the FHIR spec.</a>
          headers:
            content-type:
              schema:
                type: string
                enum:
                - application/json+fhir
      tags:
      - FHIR
      security:
      - bearer: []
  /api/v1/patient-registry/fhir/_export:
    get:
      operationId: PublicFhirController_export
      summary: Export FHIR Resources
      description: Export a FHIR Bundle containing all of the subject's resources. The resulting FHIR Bundle will be in JSON Lines format.
      parameters:
      - name: ProjectId
        in: header
        required: true
        schema:
          type: string
          format: uuid
          example: e6b01018-a333-4732-917e-fe38e91b0fdf
      - name: subjectId
        required: true
        in: query
        schema:
          format: uuid
          type: string
      responses:
        '400':
          description: ''
        '401':
          description: ''
        '403':
          description: ''
        '429':
          description: ''
        default:
          description: The result of the FHIR resource export.
          headers:
            content-type:
              schema:
                type: string
                enum:
                - application/json
            expires:
              description: Indicates when the resulting output URL(s) will expire.
              schema:
                type: string
                example: Wed, 21 Oct 2023 07:28:00 GMT
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FhirExportResponseDto'
      tags:
      - FHIR
      security:
      - bearer: []
components:
  schemas:
    FhirExportResponseDto:
      type: object
      properties:
        transactionTime:
          format: date-time
          type: string
          description: When the export request was made.
        expires:
          format: date-time
          type: string
          description: When the resulting output URL(s) will expire.
        requiresAccessToken:
          type: boolean
          description: Whether the requests represented by in the `output` array require an access token.
        output:
          description: The resulting FHIR resource output will be a collection of FHIR resources in <a href="https://jsonlines.org/" target="_blank">JSON Lines</a> format, with one FHIR resource per line. Please see the <a href="https://hl7.org/fhir/R4/bundle.html" target="_blank">FHIR R4 resource definitions.</a>
          type: array
          items:
            type: string
      required:
      - transactionTime
      - expires
      - requiresAccessToken
      - output
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http