xCures

xCures Public API

REST API for the xCures Clinical Clarity Engine. Register patients (Subjects), dispatch and poll queries against Carequality/TEFCA health information networks, retrieve and publish clinical documents (including reciprocity back to the network), read normalized FHIR R4 resources and a FHIR bulk export, search fifteen Clinical Concepts domains (conditions, medications, labs, biomarkers, imaging, procedures, allergies, vitals, encounters, demographics, coverage, family history, social history, surveys, radiation), evaluate AI Checklists, and fetch AI-generated subject summaries. OAuth 2.0 client-credentials bearer auth with a required ProjectId header on nearly every operation.

GitHub OpenAPI

Operations 69

POST /oauth/token Get Token #
GET /api/v1/patient-registry/application/{id} Get Application #
POST /api/v1/patient-registry/application Create Application #
POST /api/v1/patient-registry/application/{id}/resend-verification Resend Application Invite #
POST /api/v1/patient-registry/subject Create Subjects #
GET /api/v1/patient-registry/subject/{id} Get Subject #
PUT /api/v1/patient-registry/subject/{id} Update Subject #
GET /api/v1/patient-registry/subject/{id}/status/clinical-concepts Get Clinical Concepts Status #
POST /api/v1/patient-registry/query Create Query #
GET /api/v1/patient-registry/query/{id} Get Query #
GET /api/v1/patient-registry/summary/subject/{subjectId} Subject Summary #
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 #
POST /api/v1/patient-registry/document Create a Document #
GET /api/v1/patient-registry/document Search Documents #
GET /api/v1/patient-registry/document/{documentId} Get Document #
PUT /api/v1/patient-registry/document/{documentId} Update Document #
PUT /api/v1/patient-registry/document/{documentId}/reciprocity Publish Document #
DELETE /api/v1/patient-registry/document/{documentId}/reciprocity Unpublish Document #
GET /api/v1/patient-registry/document/{documentId}/pdf Get Document PDF URL #
GET /api/v1/patient-registry/reciprocity-template List Reciprocity Templates #
GET /api/v1/patient-registry/checklist Get Checklists #
POST /api/v1/patient-registry/checklist/{checklistId}/evaluate Evaluate Checklist #
POST /api/v1/patient-registry/checklist/{checklistId}/item/{checklistItemId}/feedback Submit Checklist Item Feedback #
GET /api/v1/patient-registry/clinical-concepts/condition Search Clinical Concepts Conditions #
GET /api/v1/patient-registry/clinical-concepts/condition/{id} Get Clinical Concept Condition #
GET /api/v1/patient-registry/clinical-concepts/medication Search Clinical Concepts Medications #
GET /api/v1/patient-registry/clinical-concepts/medication/{id} Get Clinical Concept Medication #
GET /api/v1/patient-registry/clinical-concepts/allergy Search Clinical Concepts Allergies #
GET /api/v1/patient-registry/clinical-concepts/allergy/{id} Get Clinical Concept Allergy #
GET /api/v1/patient-registry/clinical-concepts/procedure Search Clinical Concepts Procedures #
GET /api/v1/patient-registry/clinical-concepts/procedure/{id} Get Clinical Concept Procedure #
GET /api/v1/patient-registry/clinical-concepts/biomarker Search Clinical Concepts Biomarkers #
GET /api/v1/patient-registry/clinical-concepts/biomarker/{id} Get Clinical Concept Biomarker #
GET /api/v1/patient-registry/clinical-concepts/coverage Search Clinical Concepts Coverage #
GET /api/v1/patient-registry/clinical-concepts/coverage/{id} Get Clinical Concept Coverage #
GET /api/v1/patient-registry/clinical-concepts/demographic Search Clinical Concepts Demographics #
GET /api/v1/patient-registry/clinical-concepts/demographic/{id} Get Clinical Concept Demographic #
GET /api/v1/patient-registry/clinical-concepts/encounter Search Clinical Concepts Encounters #
GET /api/v1/patient-registry/clinical-concepts/encounter/{id} Get Clinical Concept Encounter #
GET /api/v1/patient-registry/clinical-concepts/family_history Search Clinical Concepts Family History #
GET /api/v1/patient-registry/clinical-concepts/family_history/{id} Get Clinical Concept Family History #
GET /api/v1/patient-registry/clinical-concepts/imaging Search Clinical Concepts Imaging #
GET /api/v1/patient-registry/clinical-concepts/imaging/{id} Get Clinical Concept Imaging #
GET /api/v1/patient-registry/clinical-concepts/lab Search Clinical Concepts Labs #
GET /api/v1/patient-registry/clinical-concepts/lab/{id} Get Clinical Concept Lab #
GET /api/v1/patient-registry/clinical-concepts/social_history Search Clinical Concepts Social History #
GET /api/v1/patient-registry/clinical-concepts/social_history/{id} Get Clinical Concept Social History #
GET /api/v1/patient-registry/clinical-concepts/survey Search Clinical Concepts Surveys #
GET /api/v1/patient-registry/clinical-concepts/survey/{id} Get Clinical Concept Survey #
GET /api/v1/patient-registry/clinical-concepts/radiation Search Clinical Concepts Radiation #
GET /api/v1/patient-registry/clinical-concepts/radiation/{id} Get Clinical Concept Radiation #
GET /api/v1/patient-registry/clinical-concepts/vital Search Clinical Concepts Vitals #
GET /api/v1/patient-registry/clinical-concepts/vital/{id} Get Clinical Concept Vital #
GET /api/v1/patient-registry/project List Projects #
POST /api/v2/patient-registry/subject Create Subject V2 #

Documentation

📖
Documentation
https://docs.xcures.com/api-introduction
📖
APIReference
https://docs.xcures.com/apis/current
📖
GettingStarted
https://docs.xcures.com/api-introduction
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/xcures/refs/heads/main/authentication/xcures-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/xcures/refs/heads/main/rate-limits/xcures-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/xcures/refs/heads/main/openapi/xcures-patient-registry-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://raw.githubusercontent.com/api-evangelist/xcures/refs/heads/main/asyncapi/xcures-application-webhooks.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/xcures/refs/heads/main/errors/xcures-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/xcures/refs/heads/main/data-model/xcures-data-model.yml
🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/xcures/refs/heads/main/overlays/xcures-patient-registry-api-overlay.yaml
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/xcures/refs/heads/main/apis.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-public-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 email required.

GitHub Google LinkedIn

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

OpenAPI Specification

xcures-patient-registry-api-openapi.yml Raw ↑ 
openapi: 3.0.0
paths:
  /oauth/token:
    post:
      operationId: PublicOAuthController_token
      summary: Get Token
      description: Obtain an access token that is authorized to make API calls.
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OAuthTokenRequestDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthTokenResponseDto'
        '400':
          description: ''
        '401':
          description: ''
        '429':
          description: ''
      tags:
      - OAuth
  /api/v1/patient-registry/application/{id}:
    get:
      operationId: PublicApplicationController_get
      summary: Get Application
      description: Get a specific application by ID.
      parameters:
      - name: ProjectId
        in: header
        required: true
        schema:
          type: string
          format: uuid
          example: e6b01018-a333-4732-917e-fe38e91b0fdf
      - name: id
        required: true
        in: path
        description: The ID of the application to retrieve.
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
        '400':
          description: ''
        '401':
          description: ''
        '403':
          description: ''
        '429':
          description: ''
      tags:
      - Application
      security:
      - bearer: []
  /api/v1/patient-registry/application:
    post:
      operationId: PublicApplicationController_create
      summary: Create Application
      description: Create a new application. The application will be created in the system and an email will be sent to the
        applicant requesting consent.
      parameters:
      - name: ProjectId
        in: header
        required: true
        schema:
          type: string
          format: uuid
          example: e6b01018-a333-4732-917e-fe38e91b0fdf
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateApplication'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateApplicationResponse'
        '400':
          description: ''
        '401':
          description: ''
        '403':
          description: ''
        '429':
          description: ''
      tags:
      - Application
      security:
      - bearer: []
  /api/v1/patient-registry/application/{id}/resend-verification:
    post:
      operationId: PublicApplicationController_resendVerification
      summary: Resend Application Invite
      description: Resends an email to the applicant requesting consent. Also updates the webhooks for the application.
      parameters:
      - name: ProjectId
        in: header
        required: true
        schema:
          type: string
          format: uuid
          example: e6b01018-a333-4732-917e-fe38e91b0fdf
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationWebhooks'
      responses:
        '201':
          description: ''
        '400':
          description: ''
        '401':
          description: ''
        '403':
          description: ''
        '429':
          description: ''
      tags:
      - Application
      security:
      - bearer: []
  /api/v1/patient-registry/subject:
    get:
      operationId: PublicSubjectController_search
      summary: Search Subjects
      description: Search subjects
      parameters:
      - name: ProjectId
        in: header
        required: true
        schema:
          type: string
          format: uuid
          example: e6b01018-a333-4732-917e-fe38e91b0fdf
      - name: pageNumber
        required: false
        in: query
        description: Page number to retrieve (1-based index)
        schema:
          default: 1
          type: number
      - name: pageSize
        required: false
        in: query
        description: Number of items per page
        schema:
          default: 50
          type: number
      - name: sortField
        required: false
        in: query
        description: Field name to sort by
        schema:
          default: identifier
          type: string
      - name: sortIsDescending
        required: false
        in: query
        description: Whether to sort in descending order
        schema:
          default: false
          type: boolean
      - name: deleted
        required: false
        in: query
        schema:
          type: boolean
      - name: identifier
        required: false
        in: query
        schema:
          type: string
      - name: subjectIds
        required: false
        in: query
        schema:
          format: uuid
          type: array
          items:
            type: string
      - name: firstName
        required: false
        in: query
        schema:
          type: string
      - name: lastName
        required: false
        in: query
        schema:
          type: string
      - name: city
        required: false
        in: query
        schema:
          type: string
      - name: state
        required: false
        in: query
        schema:
          type: string
      - name: addressLine1
        required: false
        in: query
        schema:
          type: string
      - name: addressLine2
        required: false
        in: query
        schema:
          type: string
      - name: postalCode
        required: false
        in: query
        schema:
          type: string
      - name: gender
        required: false
        in: query
        schema:
          type: string
      - name: birthDate
        required: false
        in: query
        schema:
          type: string
      - name: birthDateStart
        required: false
        in: query
        schema:
          type: string
      - name: birthDateEnd
        required: false
        in: query
        schema:
          type: string
      - name: deathDate
        required: false
        in: query
        schema:
          type: string
      - name: deathDateStart
        required: false
        in: query
        schema:
          type: string
      - name: deathDateEnd
        required: false
        in: query
        schema:
          type: string
      - name: email
        required: false
        in: query
        schema:
          type: string
      - name: created
        required: false
        in: query
        schema:
          type: string
      - name: createdStart
        required: false
        in: query
        schema:
          type: string
      - name: createdEnd
        required: false
        in: query
        schema:
          type: string
      - name: updated
        required: false
        in: query
        schema:
          type: string
      - name: updatedStart
        required: false
        in: query
        schema:
          type: string
      - name: updatedEnd
        required: false
        in: query
        schema:
          type: string
      - name: phoneNumber
        required: false
        in: query
        schema:
          type: string
      - name: externalIdentifiers
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
      - name: labels
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
      - name: cohortIds
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
      - name: programDeliveryId
        required: false
        in: query
        schema:
          type: string
      - name: programDeliveryStatus
        required: false
        in: query
        schema:
          type: string
      - name: additionalNames
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
      - name: totalQueries
        required: false
        in: query
        schema:
          type: number
      - name: successfulQueries
        required: false
        in: query
        schema:
          type: number
      - name: inflightQueries
        required: false
        in: query
        schema:
          type: number
      - name: viewId
        required: false
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubjectPaginationResult'
        '400':
          description: ''
        '401':
          description: ''
        '403':
          description: ''
        '429':
          description: ''
      tags:
      - Subject
      security:
      - bearer: []
    post:
      operationId: PublicSubjectController_create
      summary: Create Subjects
      description: Creates all the subjects defined in the array. Maximum of 10 subjects allowed.
      parameters:
      - name: ProjectId
        in: header
        required: true
        schema:
          type: string
          format: uuid
          example: e6b01018-a333-4732-917e-fe38e91b0fdf
      requestBody:
        required: true
        description: Array of subjects to create, or a batch object with subjects array and optional batch-level options.
          Maximum of 10 subjects allowed.
        content:
          application/json:
            schema:
              oneOf:
              - type: array
                items:
                  $ref: '#/components/schemas/CreateSubject'
                description: Array of subjects to create. Maximum of 10 subjects allowed.
              - $ref: '#/components/schemas/CreateSubjectBatch'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CreateSubjectResult'
        '400':
          description: ''
        '401':
          description: ''
        '403':
          description: ''
        '409':
          description: ''
        '429':
          description: ''
      tags:
      - Subject
      security:
      - bearer: []
  /api/v1/patient-registry/subject/{id}:
    get:
      operationId: PublicSubjectController_get
      summary: Get Subject
      description: Get a specific subject by ID.
      parameters:
      - name: ProjectId
        in: header
        required: true
        schema:
          type: string
          format: uuid
          example: e6b01018-a333-4732-917e-fe38e91b0fdf
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subject'
        '400':
          description: ''
        '401':
          description: ''
        '403':
          description: ''
        '404':
          description: ''
        '429':
          description: ''
      tags:
      - Subject
      security:
      - bearer: []
    put:
      operationId: PublicSubjectController_update
      summary: Update Subject
      description: Update a subject.
      parameters:
      - name: ProjectId
        in: header
        required: true
        schema:
          type: string
          format: uuid
          example: e6b01018-a333-4732-917e-fe38e91b0fdf
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSubject'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subject'
        '400':
          description: ''
        '401':
          description: ''
        '403':
          description: ''
        '404':
          description: ''
        '429':
          description: ''
      tags:
      - Subject
      security:
      - bearer: []
  /api/v1/patient-registry/subject/{id}/status/clinical-concepts:
    get:
      operationId: PublicSubjectController_getClinicalConceptsStatus
      summary: Get Clinical Concepts Status
      description: Get information regarding the availability of clinical concepts for a subject.
      parameters:
      - name: ProjectId
        in: header
        required: true
        schema:
          type: string
          format: uuid
          example: e6b01018-a333-4732-917e-fe38e91b0fdf
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClinicalConceptsStatusDto'
        '400':
          description: ''
        '401':
          description: ''
        '403':
          description: ''
        '404':
          description: ''
        '429':
          description: ''
      tags:
      - Subject
      security:
      - bearer: []
  /api/v1/patient-registry/query:
    get:
      operationId: PublicQueryController_search
      summary: Search Queries
      description: Search Queries
      parameters:
      - name: ProjectId
        in: header
        required: true
        schema:
          type: string
          format: uuid
          example: e6b01018-a333-4732-917e-fe38e91b0fdf
      - name: pageNumber
        required: false
        in: query
        description: Page number to retrieve (1-based index)
        schema:
          default: 1
          type: number
      - name: pageSize
        required: false
        in: query
        description: Number of items per page
        schema:
          default: 50
          type: number
      - name: sortField
        required: false
        in: query
        description: Field name to sort by
        schema:
          default: created
          enum:
          - created
          - ccdaStatus
          - externalSystem
          type: string
      - name: sortIsDescending
        required: false
        in: query
        description: Whether to sort in descending order
        schema:
          default: false
          type: boolean
      - name: subjectId
        required: false
        in: query
        schema:
          format: uuid
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          type: string
      - name: status
        required: false
        in: query
        description: Filter applies specifically to property ccdaStatus
        schema:
          enum:
          - delayed
          - initiated
          - pending
          - inProgress
          - completed
          - exhausted
          - error
          type: string
      - name: createdFrom
        required: false
        in: query
        readOnly: true
        description: Include queries created on or after this date (inclusive)
        schema:
          format: ISO 8601
          example: '2025-05-26T23:30:40.912Z'
          type: string
      - name: createdTo
        required: false
        in: query
        readOnly: true
        description: Include queries created before this date (exclusive)
        schema:
          format: ISO 8601
          example: '2025-05-26T23:30:40.912Z'
          type: string
      responses:
        '400':
          description: ''
        '401':
          description: ''
        '403':
          description: ''
        '429':
          description: ''
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryPaginationResult'
      tags:
      - Query
      security:
      - bearer: []
    post:
      operationId: PublicQueryController_create
      summary: Create Query
      description: Create a new query by providing the necessary details. The query will be stored and can be used for further
        operations.
      parameters:
      - name: ProjectId
        in: header
        required: true
        schema:
          type: string
          format: uuid
          example: e6b01018-a333-4732-917e-fe38e91b0fdf
      requestBody:
        required: true
        description: The data required to create a new query.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateQueryDto'
            examples:
              example1:
                summary: Example Query Creation
                value:
                  subjectId: 1782b464-ab03-4c03-9810-83d42b86e587
                  organizationIds:
                  - 2.16.840.1.113883.3.3126.2.3.32103.16
      responses:
        '201':
          description: The query was successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryDto'
        '400':
          description: Bad Request. The input data is invalid.
        '401':
          description: Unauthorized. The user is not authenticated.
        '403':
          description: Forbidden. The user does not have permission to create a query.
        '429':
          description: Too Many Requests. The user has exceeded the rate limit.
      tags:
      - Query
      security:
      - bearer: []
  /api/v1/patient-registry/query/{id}:
    get:
      operationId: PublicQueryController_get
      summary: Get Query
      description: Get a specific query by ID.
      parameters:
      - name: ProjectId
        in: header
        required: true
        schema:
          type: string
          format: uuid
          example: e6b01018-a333-4732-917e-fe38e91b0fdf
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '400':
          description: ''
        '401':
          description: ''
        '403':
          description: ''
        '404':
          description: ''
        '429':
          description: ''
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetQueryResponse'
      tags:
      - Query
      security:
      - bearer: []
  /api/v1/patient-registry/summary/subject/{subjectId}:
    get:
      operationId: PublicSummaryController_subjectSummary
      summary: Subject Summary
      description: Fetches the summary for a given subject. Throws a Forbidden error if the summary feature is disabled for
        the project.
      parameters:
      - name: ProjectId
        in: header
        required: true
        schema:
          type: string
          format: uuid
          example: e6b01018-a333-4732-917e-fe38e91b0fdf
      - name: subjectId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubjectSummaryDto'
        '400':
          description: ''
        '401':
          description: ''
        '403':
          description: 'Forbidden: The summary feature is not enabled for the project.'
        '429':
          description: ''
      tags:
      - Summary
      security:
      - bearer: []
  /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 <a href="https://hl7.org/fhir/R4/bundle.html" target="_blank">Resource Bundle definition in the FHIR spec.</a>
      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 <a href="https://hl7.org/fhir/R4/bundle.html" target="_blank">Resource Bundle definition in the FHIR spec.</a>
      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 <a href="https://hl7.org/fhir/R4/bundle.html" target="_blank">Resource Bundle definition in the FHIR spec.</a>
      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 <a href="https://hl7.org/fhir/R4/bundle.html" target="_blank">Resource Bundle definition in the FHIR spec.</a>
      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 <a href="https://hl7.org/fhir/R4/bundle.html" target="_blank">Resource Bundle definition in the FHIR spec.</a>
      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 <a href="https://hl7.org/fhir/R4/bundle.html" target="_blank">Resource Bundle definition in the FHIR spec.</a>
      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 <a href="https://hl7.org/fhir/R4/bundle.html" target="_blank">Resource Bundle definition in the FHIR spec.</a>
      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 <a href="https://hl7.org/fhir/R4/bundle.html" target="_blank">Resource Bundle definition in the FHIR spec.</a>
      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 <a href="https://hl7.org/fhir/R4/bundle.html" target="_blank">Reso

# --- truncated at 32 KB (197 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/xcures/refs/heads/main/openapi/xcures-patient-registry-api-openapi.yml