How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.

This API exposes 69 operations across 63 paths, organized into 11 resource areas, and defines 64 schemas. It is described by OpenAPI 3.0.0, at version V1.

Requests are made against a single base URL, https://partner.xcures.com.

69 operations 63 paths 64 schemas 1 DELETE56 GET9 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
V1
Base URL
https://partner.xcures.com
Authentication
HTTP Bearer
Resource Areas
11

Authentication & Security 1

xCures Public API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer).

Paths & Operations 69

Across 63 paths, the API surfaces 69 operations — 1 DELETE, 56 GET, 9 POST, 3 PUT. They span 11 resource areas, including OAuth, Application, Subject, Query, Summary, FHIR, Document, Reciprocity Template, and 3 more. Each is listed below with its method, path, parameters, and response codes.

OAuth 1

All API requests to xCures must provide an access token, retrieved via the standard OAuth authorization flow below.

POST
/oauth/token
Get Token
PublicOAuthController_token body → 200400401429
Application 3

Account creation (e.g., identity proofing, eConsent) that is required for a patient to progress on the xCures Platform.

GET
/api/v1/patient-registry/application/{id}
Get Application
PublicApplicationController_get 2 params → 200400401403429
POST
/api/v1/patient-registry/application
Create Application
PublicApplicationController_create 1 param body → 201400401403429
POST
/api/v1/patient-registry/application/{id}/resend-verification
Resend Application Invite
PublicApplicationController_resendVerification 2 params body → 201400401403429
Subject 6

An individual patient created on the xCures Platform.

GET
/api/v1/patient-registry/subject
Search Subjects
PublicSubjectController_search 40 params → 200400401403429
POST
/api/v1/patient-registry/subject
Create Subjects
PublicSubjectController_create 1 param body → 201400401403409429
GET
/api/v1/patient-registry/subject/{id}
Get Subject
PublicSubjectController_get 2 params → 200400401403404429
PUT
/api/v1/patient-registry/subject/{id}
Update Subject
PublicSubjectController_update 2 params body → 200400401403404429
GET
/api/v1/patient-registry/subject/{id}/status/clinical-concepts
Get Clinical Concepts Status
PublicSubjectController_getClinicalConceptsStatus 2 params → 200400401403404429
POST
/api/v2/patient-registry/subject
Create Subject V2
PublicSubjectControllerV2_create 1 param body → 201400401403409429500503
Query 3

A specified, approved request for patient records across the network (e.g., via Carequality/TEFCA to support treatment activities, via TEFCA for IAS queries) with an associated st…

GET
/api/v1/patient-registry/query
Search Queries
PublicQueryController_search 9 params → 400401403429default
POST
/api/v1/patient-registry/query
Create Query
PublicQueryController_create 1 param body → 201400401403429
GET
/api/v1/patient-registry/query/{id}
Get Query
PublicQueryController_get 2 params → 400401403404429default
Summary 1

The AI-generated summary of a patient’s overall records and condition(s).

GET
/api/v1/patient-registry/summary/subject/{subjectId}
Subject Summary
PublicSummaryController_subjectSummary 2 params → 200400401403429
FHIR 13

Fast Healthcare Interoperability Resource is an international data model specification developed by HL7 International to enable healthcare data exchange and interoperability betwe…

GET
/api/v1/patient-registry/fhir/allergyintolerance
Allergy Intolerances
PublicFhirController_allergyIntolerance 4 params → 400401403429default
GET
/api/v1/patient-registry/fhir/basic
Basics
PublicFhirController_basic 4 params → 400401403429default
GET
/api/v1/patient-registry/fhir/careplan
Care Plans
PublicFhirController_carePlan 4 params → 400401403429default
GET
/api/v1/patient-registry/fhir/coverage
Coverages
PublicFhirController_coverage 4 params → 400401403429default
GET
/api/v1/patient-registry/fhir/condition
Conditions
PublicFhirController_condition 4 params → 400401403429default
GET
/api/v1/patient-registry/fhir/diagnosticreport
Diagnostic Reports
PublicFhirController_diagnosticReport 4 params → 400401403429default
GET
/api/v1/patient-registry/fhir/encounter
Encounters
PublicFhirController_encounter 4 params → 400401403429default
GET
/api/v1/patient-registry/fhir/medicationstatement
Medication Statements
PublicFhirController_medicationstatement 4 params → 400401403429default
GET
/api/v1/patient-registry/fhir/patient
Patients
PublicFhirController_patient 4 params → 400401403429default
GET
/api/v1/patient-registry/fhir/procedure
Procedures
PublicFhirController_procedure 4 params → 400401403429default
GET
/api/v1/patient-registry/fhir/observation
Observations
PublicFhirController_observation 4 params → 400401403429default
GET
/api/v1/patient-registry/fhir/specimen
Specimens
PublicFhirController_specimen 4 params → 400401403429default
GET
/api/v1/patient-registry/fhir/_export
Export FHIR Resources
PublicFhirController_export 2 params → 400401403429default
Document 7

Patient records retrieved by the xCures platform and/or loaded by platform users.

POST
/api/v1/patient-registry/document
Create a Document
PublicDocumentController_create 1 param body → 201400401403429
GET
/api/v1/patient-registry/document
Search Documents
PublicDocumentController_getAll 7 params → 200400401403429
GET
/api/v1/patient-registry/document/{documentId}
Get Document
PublicDocumentController_getById 2 params → 200400401403404429
PUT
/api/v1/patient-registry/document/{documentId}
Update Document
PublicDocumentController_update 2 params body → 200400401403404429
PUT
/api/v1/patient-registry/document/{documentId}/reciprocity
Publish Document
PublicDocumentController_reciprocity 2 params body → 200400401403429
DELETE
/api/v1/patient-registry/document/{documentId}/reciprocity
Unpublish Document
PublicDocumentController_unpublish 2 params → 200400401403429
GET
/api/v1/patient-registry/document/{documentId}/pdf
Get Document PDF URL
PublicDocumentController_getPdfById 2 params → 200400401403404429
Reciprocity Template 1

Reciprocity or "Responder" workflows refer to the process of sharing clinical documentation housed within your system with other organizations/providers, when participating in hea…

GET
/api/v1/patient-registry/reciprocity-template
List Reciprocity Templates
PublicReciprocityTemplateController_list 1 param → 200400401403429
Checklist 3

AI-powered feature leveraging xCures’ targeted data extraction/processing to populate validated, customizable question/answer-style items. Responses can be highly flexible and eve…

GET
/api/v1/patient-registry/checklist
Get Checklists
PublicChecklistController_list 2 params → 200400401403429
POST
/api/v1/patient-registry/checklist/{checklistId}/evaluate
Evaluate Checklist
PublicChecklistController_evaluate 2 params body → 201400401403429
POST
/api/v1/patient-registry/checklist/{checklistId}/item/{checklistItemId}/feedback
Submit Checklist Item Feedback
PublicChecklistController_submitItemFeedback 3 params body → 200400401403429
Clinical Concepts 30

Clinical concepts is a proprietary xCures higher-level, flattened, filtered, opinionated view of medical record information, structured around FHIR guidelines.

GET
/api/v1/patient-registry/clinical-concepts/condition
Search Clinical Concepts Conditions
PublicClinicalConceptsController_searchConditions 12 params → 200400401403429
GET
/api/v1/patient-registry/clinical-concepts/condition/{id}
Get Clinical Concept Condition
PublicClinicalConceptsController_getCondition 3 params → 200400401403404429
GET
/api/v1/patient-registry/clinical-concepts/medication
Search Clinical Concepts Medications
PublicClinicalConceptsController_searchMedications 12 params → 200400401403429
GET
/api/v1/patient-registry/clinical-concepts/medication/{id}
Get Clinical Concept Medication
PublicClinicalConceptsController_getMedication 3 params → 200400401403404429
GET
/api/v1/patient-registry/clinical-concepts/allergy
Search Clinical Concepts Allergies
PublicClinicalConceptsController_searchAllergies 12 params → 200400401403429
GET
/api/v1/patient-registry/clinical-concepts/allergy/{id}
Get Clinical Concept Allergy
PublicClinicalConceptsController_getAllergy 3 params → 200400401403404429
GET
/api/v1/patient-registry/clinical-concepts/procedure
Search Clinical Concepts Procedures
PublicClinicalConceptsController_searchProcedures 12 params → 200400401403429
GET
/api/v1/patient-registry/clinical-concepts/procedure/{id}
Get Clinical Concept Procedure
PublicClinicalConceptsController_getProcedure 3 params → 200400401403404429
GET
/api/v1/patient-registry/clinical-concepts/biomarker
Search Clinical Concepts Biomarkers
PublicClinicalConceptsController_searchBiomarkers 12 params → 200400401403429
GET
/api/v1/patient-registry/clinical-concepts/biomarker/{id}
Get Clinical Concept Biomarker
PublicClinicalConceptsController_getBiomarker 3 params → 200400401403404429
GET
/api/v1/patient-registry/clinical-concepts/coverage
Search Clinical Concepts Coverage
PublicClinicalConceptsController_searchCoverage 12 params → 200400401403429
GET
/api/v1/patient-registry/clinical-concepts/coverage/{id}
Get Clinical Concept Coverage
PublicClinicalConceptsController_getCoverage 3 params → 200400401403404429
GET
/api/v1/patient-registry/clinical-concepts/demographic
Search Clinical Concepts Demographics
PublicClinicalConceptsController_searchDemographics 12 params → 200400401403429
GET
/api/v1/patient-registry/clinical-concepts/demographic/{id}
Get Clinical Concept Demographic
PublicClinicalConceptsController_getDemographic 3 params → 200400401403404429
GET
/api/v1/patient-registry/clinical-concepts/encounter
Search Clinical Concepts Encounters
PublicClinicalConceptsController_searchEncounters 12 params → 200400401403429
GET
/api/v1/patient-registry/clinical-concepts/encounter/{id}
Get Clinical Concept Encounter
PublicClinicalConceptsController_getEncounter 3 params → 200400401403404429
GET
/api/v1/patient-registry/clinical-concepts/family_history
Search Clinical Concepts Family History
PublicClinicalConceptsController_searchFamilyHistory 12 params → 200400401403429
GET
/api/v1/patient-registry/clinical-concepts/family_history/{id}
Get Clinical Concept Family History
PublicClinicalConceptsController_getFamilyHistory 3 params → 200400401403404429
GET
/api/v1/patient-registry/clinical-concepts/imaging
Search Clinical Concepts Imaging
PublicClinicalConceptsController_searchImaging 12 params → 200400401403429
GET
/api/v1/patient-registry/clinical-concepts/imaging/{id}
Get Clinical Concept Imaging
PublicClinicalConceptsController_getImaging 3 params → 200400401403404429
GET
/api/v1/patient-registry/clinical-concepts/lab
Search Clinical Concepts Labs
PublicClinicalConceptsController_searchLabs 12 params → 200400401403429
GET
/api/v1/patient-registry/clinical-concepts/lab/{id}
Get Clinical Concept Lab
PublicClinicalConceptsController_getLab 3 params → 200400401403404429
GET
/api/v1/patient-registry/clinical-concepts/social_history
Search Clinical Concepts Social History
PublicClinicalConceptsController_searchSocialHistory 12 params → 200400401403429
GET
/api/v1/patient-registry/clinical-concepts/social_history/{id}
Get Clinical Concept Social History
PublicClinicalConceptsController_getSocialHistory 3 params → 200400401403404429
GET
/api/v1/patient-registry/clinical-concepts/survey
Search Clinical Concepts Surveys
PublicClinicalConceptsController_searchSurveys 12 params → 200400401403429
GET
/api/v1/patient-registry/clinical-concepts/survey/{id}
Get Clinical Concept Survey
PublicClinicalConceptsController_getSurvey 3 params → 200400401403404429
GET
/api/v1/patient-registry/clinical-concepts/radiation
Search Clinical Concepts Radiation
PublicClinicalConceptsController_searchRadiation 12 params → 200400401403429
GET
/api/v1/patient-registry/clinical-concepts/radiation/{id}
Get Clinical Concept Radiation
PublicClinicalConceptsController_getRadiation 3 params → 200400401403404429
GET
/api/v1/patient-registry/clinical-concepts/vital
Search Clinical Concepts Vitals
PublicClinicalConceptsController_searchVitals 12 params → 200400401403429
GET
/api/v1/patient-registry/clinical-concepts/vital/{id}
Get Clinical Concept Vital
PublicClinicalConceptsController_getVital 3 params → 200400401403404429
Project 1

A configured workspace on the xCures Platform. Use this endpoint to discover the projectId value(s) required by other API calls, without needing to log into the portal.

GET
/api/v1/patient-registry/project
List Projects
PublicProjectController_getAll → 200400401403429

Schemas 64

The contract defines 64 schemas that model the data the API accepts and returns. The most detailed are CreateSubjectResult (25 properties), Subject (24 properties), Application (22 properties), CreateApplicationResponse (21 properties). Each schema is shown below with its type and property counts.

OAuthTokenRequestDto
object
3 properties 3 required
OAuthTokenResponseDto
object
2 properties 2 required
Application
object
22 properties 9 required
CreateApplication
object
17 properties 7 required
CreateApplicationResponse
object
21 properties 9 required
ApplicationWebhooks
object
3 properties
SubjectExternalIdentifier
object
2 properties 2 required
SubjectAdditionalName
object
3 properties
SubjectAddressDto
object
5 properties
SubjectTagDto
object
11 properties 2 required
Subject
object
24 properties 6 required
SubjectPaginationResult
object
6 properties 2 required
CreateSubject
object
19 properties 3 required
CreateSubjectBatchOptions
object
1 property
CreateSubjectBatch
object
2 properties 1 required
CreateSubjectResult
object
25 properties 6 required
UpdateSubject
object
18 properties 2 required
ClinicalConceptsStatusDto
object
2 properties 1 required
QueryAttempt
object
5 properties 2 required
Query
object
7 properties 4 required
QueryPaginationResult
object
6 properties 2 required
GetQueryResponse
object
6 properties 4 required
CreateQueryDto
object
2 properties 1 required
QueryDto
object
9 properties 9 required
ReferencedDocumentDto
object
2 properties 2 required
SubjectSummaryDto
object
2 properties 2 required
FhirExportResponseDto
object
4 properties 4 required
CreateDocumentRequest
object
6 properties 3 required
CreateDocumentResponse
object
2 properties 2 required
DocumentSummary
object
12 properties 5 required
DocumentPaginationResult
object
6 properties 2 required
DocumentDetail
object
12 properties 6 required
UpdateDocumentRequest
object
3 properties
DocumentReciprocityDto
object
1 property 1 required
DocumentPdfUrlDto
object
2 properties 2 required
PublishDocumentTemplateDto
object
17 properties 9 required
ChecklistItem
object
4 properties 4 required
Checklist
object
4 properties 4 required
ChecklistEvaluationRequest
object
2 properties 1 required
ClinicalConceptDto
object
2 properties 2 required
DocumentSectionDto
object
9 properties 4 required
ChecklistItemEvaluationResult
object
9 properties 6 required
ChecklistEvaluationResult
object
5 properties 5 required
ChecklistItemFeedbackRequest
object
3 properties 2 required
PaginationResultDto
object
6 properties 2 required
ClinicalConceptConditionDto
object
12 properties 2 required
ClinicalConceptMedicationDto
object
19 properties 2 required
ClinicalConceptAllergyDto
object
8 properties 2 required
ClinicalConceptProcedureDto
object
11 properties 2 required
ClinicalConceptBiomarkerDto
object
16 properties 2 required
ClinicalConceptCoverageDto
object
12 properties 2 required
ClinicalConceptDemographicDto
object
11 properties 2 required
ClinicalConceptEncounterDto
object
20 properties 2 required
ClinicalConceptFamilyHistoryDto
object
9 properties 2 required
ClinicalConceptImagingDto
object
19 properties 2 required
ClinicalConceptLabDto
object
11 properties 2 required
ClinicalConceptSocialHistoryDto
object
6 properties 2 required
ClinicalConceptSurveyDto
object
6 properties 2 required
ClinicalConceptRadiationDto
object
15 properties 2 required
ClinicalConceptVitalDto
object
10 properties 2 required
Project
object
4 properties 4 required
ProblemDetails
object
3 properties
CreateSubjectOptions
object
1 property
CreateSubjectV2
object
20 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xcures-patient-registry-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of xCures Public API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.