XCaliber FHIR++ APIs (1.0.0)

Download OpenAPI specification:Download

FHIR (Fast Healthcare Interoperability Resources, prounced as "Fire") is a standard for exchanging healthcare information electronically. It is designed to be a modern, flexible, and web-based alternative to older, more cumbersome standards like HL7 v2. FHIR uses a RESTful API specification to define how to interact with Resources - this means it uses standard HTTP verbs (GET, POST, PUT, DELETE). Resources are the fundamental units of data in FHIR; they can represent anything from patient demographics to clinical observations to medications.

XCaliber's APIs provides read, write, and eventing APIs to a variety of data sources used to access patient-centric data. We created FHIR++ APIs, which are FHIR conformant APIs with extensions for minimizing data loss from sources that have additional data.

Run in Postman

AllergyIntolerance

Create AllergyIntolerance

Authorizations:
bearer-key
header Parameters
x-source-id
string
Request Body schema: application/json
object
object (AllergyIntolerance)

Responses

Request samples

Content type
application/json
{
  • "context": {
    },
  • "data": {
    }
}

Get all AllergyIntolerance

Authorizations:
bearer-key
query Parameters
asserter
string
category
string
clinical-status
string
code
string
criticality
string
date
string <date>
identifier
string
last-date
string <date>
manifestation
string
onset
string <date>
patient
string
recorder
string
route
string
severity
string
type
string
verification-status
string
encounter
string
practiceId
string
departmentId
string
_count
string
_offset
string
_format
string
header Parameters
x-source-id
string

Responses

Get AllergyIntolerance

Authorizations:
bearer-key
path Parameters
id
required
string
header Parameters
x-source-id
string

Responses

Update AllergyIntolerance

Authorizations:
bearer-key
path Parameters
id
required
string
header Parameters
x-source-id
string
Request Body schema: application/json
object
object (AllergyIntolerance)

Responses

Request samples

Content type
application/json
{
  • "context": {
    },
  • "data": {
    }
}

Delete AllergyIntolerance

Authorizations:
bearer-key
path Parameters
id
required
string
header Parameters
x-source-id
string

Responses

Claim

Get all Claim

Authorizations:
bearer-key
query Parameters
patient
string
practiceId
string
departmentId
string
name
string
birthdate
string
dob
string
first_name
string
last_name
string
_count
string
_offset
string
_format
string
header Parameters
x-source-id
string

Responses

Get Claim

Authorizations:
bearer-key
path Parameters
id
required
string
header Parameters
x-source-id
string

Responses

Condition

Create Condition

Authorizations:
bearer-key
header Parameters
x-source-id
string
Request Body schema: application/json
object
object (Condition)

Responses

Request samples

Content type
application/json
{
  • "context": {
    },
  • "data": {
    }
}

Get all Condition

Authorizations:
bearer-key
query Parameters
asserter
string
category
string
clinical-status
string
code
string
criticality
string
date
string <date>
identifier
string
last-date
string <date>
manifestation
string
onset
string <date>
patient
string
recorder
string
route
string
severity
string
type
string
verification-status
string
encounter
string
practiceId
string
departmentId
string
_count
string
_offset
string
_format
string
header Parameters
x-source-id
string

Responses

Get Condition

Authorizations:
bearer-key
path Parameters
id
required
string
header Parameters
x-source-id
string

Responses

Update Condition

Authorizations:
bearer-key
path Parameters
id
required
string
header Parameters
x-source-id
string
Request Body schema: application/json
object
object (Condition)

Responses

Request samples

Content type
application/json
{
  • "context": {
    },
  • "data": {
    }
}

Patient

Create Patient

Authorizations:
bearer-key
header Parameters
x-source-id
string
Request Body schema: application/json
object
object (Patient)

Responses

Request samples

Content type
application/json
{
  • "context": {
    },
  • "data": {
    }
}

Get all Patient

Authorizations:
bearer-key
query Parameters
practitioner
string
identifier
string
name
string
active
boolean
deceased
boolean
birthdate
string
given
string
gender
string
nickname
string
email
string
phone
string
_count
string
_offset
string
_sort
string
has:CareTeam:participant:member
string
practiceId
string
departmentId
string
_format
string
header Parameters
x-source-id
string

Responses

Get Patient

Authorizations:
bearer-key
path Parameters
id
required
string
header Parameters
x-source-id
string

Responses

Update Patient

Authorizations:
bearer-key
path Parameters
id
required
string
header Parameters
x-source-id
string
Request Body schema: application/json
object
object (Patient)

Responses

Request samples

Content type
application/json
{
  • "context": {
    },
  • "data": {
    }
}

Delete Patient

Authorizations:
bearer-key
path Parameters
id
required
string
header Parameters
x-source-id
string

Responses

Immunization

Create Immunization

Authorizations:
bearer-key
header Parameters
x-source-id
string
Request Body schema: application/json
object
object (Immunization)

Responses

Request samples

Content type
application/json
{
  • "context": {
    },
  • "data": {
    }
}

Get all Immunization

Authorizations:
bearer-key
query Parameters
asserter
string
category
string
clinical-status
string
code
string
criticality
string
date
string <date>
identifier
string
last-date
string <date>
manifestation
string
onset
string <date>
patient
string
recorder
string
route
string
severity
string
type
string
verification-status
string
encounter
string
practiceId
string
departmentId
string
_count
string
_offset
string
_format
string
header Parameters
x-source-id
string

Responses

Get Immunization

Authorizations:
bearer-key
path Parameters
id
required
string
header Parameters
x-source-id
string

Responses

Invoice

Get all Invoice

Authorizations:
bearer-key
query Parameters
account
string
date
string <date>
identifier
string
issuer
string
participant
string
participant-role
string
patient
string
recipient
string
status
string
subject
string
totalgross
integer
totalnet
integer
type
string
_content
string
_id
string
_lastUpdated
string <date>
_profile
string
_query
string
_security
string
_source
string
_tag
string
_text
string
_format
string
header Parameters
x-source-id
string

Responses

Get Invoice

Authorizations:
bearer-key
path Parameters
id
required
string
header Parameters
x-source-id
string

Responses

Appointment

Create Appointment

Authorizations:
bearer-key
header Parameters
x-source-id
string
Request Body schema: application/json
object
object (Appointment)

Responses

Request samples

Content type
application/json
{
  • "context": {
    },
  • "data": {
    }
}

Get all Appointment

Authorizations:
bearer-key
query Parameters
practitioner
string
patient
string
practiceId
string
departmentId
string
_count
string
_offset
string
_format
string
header Parameters
x-source-id
string

Responses

Get Appointment

Authorizations:
bearer-key
path Parameters
id
required
string
header Parameters
x-source-id
string

Responses

Update Appointment

Authorizations:
bearer-key
path Parameters
id
required
string
header Parameters
x-source-id
string
Request Body schema: application/json
object
object (Appointment)

Responses

Request samples

Content type
application/json
{
  • "context": {
    },
  • "data": {
    }
}

Medication

Get all Medication

Authorizations:
bearer-key
query Parameters
code
string
expiration-date
string <date>
form
string
identifier
string
ingredient
string
ingredient-code
string
lot-number
string
manufacturer
string
status
string
_content
string
_id
string
_lastUpdated
string <date>
_profile
string
_query
string
_security
string
_source
string
_tag
string
_text
string
_format
string
header Parameters
x-source-id
string

Responses

Get Medication

Authorizations:
bearer-key
path Parameters
id
required
string
header Parameters
x-source-id
string

Responses

Medication Request

Create Medication Request

Authorizations:
bearer-key
header Parameters
x-source-id
string
Request Body schema: application/json
object
data
any (Medication_Request)

Responses

Request samples

Content type
application/json
{
  • "context": {
    },
  • "data": null
}

Get all Medication Request

query Parameters
patient
string
practiceId
string
encounterId
string
_count
string
_offset
string
_format
string
header Parameters
x-source-id
string

Responses

Get Medication Request

Authorizations:
bearer-key
path Parameters
id
required
string
header Parameters
x-source-id
string

Responses

MedicationStatement

Create MedicationStatement

Authorizations:
bearer-key
Request Body schema: application/json
object
object (MedicationStatement)

Responses

Request samples

Content type
application/json
{
  • "context": {
    },
  • "data": {
    }
}

Get all MedicationStatement

Authorizations:
bearer-key
query Parameters
visitType
string
status
string
patient
string
practiceId
string
departmentId
string
encounter
string
_count
string
_offset
string
_format
string
header Parameters
x-source-id
string

Responses

Get MedicationStatement

Authorizations:
bearer-key
path Parameters
id
required
string

Responses

Observation

Create Observation

Authorizations:
bearer-key
Request Body schema: application/json
object
object (Observation)

Responses

Request samples

Content type
application/json
{
  • "context": {
    },
  • "data": {
    }
}

Get all Observation

Authorizations:
bearer-key
query Parameters
asserter
string
category
string
clinical-status
string
code
string
criticality
string
date
string <date>
identifier
string
last-date
string <date>
manifestation
string
onset
string <date>
patient
string
recorder
string
route
string
severity
string
type
string
verification-status
string
encounter
string
practiceId
string
departmentId
string
_count
string
_offset
string
_format
string
header Parameters
x-source-id
string

Responses

Get Observation

Authorizations:
bearer-key
path Parameters
id
required
string

Responses

Location

Get all Location

Authorizations:
bearer-key
query Parameters
patient
string
practiceId
string
departmentId
string
_count
string
_offset
string
_format
string
header Parameters
x-source-id
string

Responses

Get Location

Authorizations:
bearer-key
path Parameters
id
required
string
header Parameters
x-source-id
string

Responses

Coverage

Create Coverage

Authorizations:
bearer-key
Request Body schema: application/json
object
object (Coverage)

Responses

Request samples

Content type
application/json
{
  • "context": {
    },
  • "data": {
    }
}

Get all Coverage

query Parameters
patient
string
practiceId
string
departmentId
string
name
string
birthdate
string
dob
string
first_name
string
last_name
string
_count
string
_offset
string
deleted
boolean
_format
string

Responses

Person

Get all Person

Authorizations:
bearer-key
query Parameters
practiceId
string
departmentId
string
_count
string
_offset
string
name
string
given
string
family
string
_format
string

Responses

Practitioner

Get all Practitioner

Authorizations:
bearer-key
query Parameters
practiceId
string
departmentId
string
_count
string
_offset
string
name
string
given
string
family
string
_format
string
header Parameters
x-source-id
string

Responses

Get Practitioner

Authorizations:
bearer-key
path Parameters
id
required
string
header Parameters
x-source-id
string

Responses

PractitionerRole

Get all PractitionerRole

query Parameters
practiceId
string
practitioner
string
_count
string
_offset
string
_format
string

Responses

Procedure

Create Procedure

Request Body schema: application/json
object
object (Procedure)

Responses

Request samples

Content type
application/json
{
  • "context": {
    },
  • "data": {
    }
}

Get all Procedure

query Parameters
patient
string
practiceId
string
departmentId
string
code
string
_count
string
_offset
string
_format
string

Responses

Get Procedure

path Parameters
id
required
string

Responses

FamilyMemberHistory

Create FamilyMemberHistory

Request Body schema: application/json
object
object (FamilyMemberHistory)

Responses

Request samples

Content type
application/json
{
  • "context": {
    },
  • "data": {
    }
}

Get all FamilyMemberHistory

query Parameters
asserter
string
category
string
clinical-status
string
code
string
criticality
string
date
string <date>
identifier
string
last-date
string <date>
manifestation
string
onset
string <date>
patient
string
recorder
string
route
string
severity
string
type
string
verification-status
string
encounter
string
practiceId
string
departmentId
string
_count
string
_offset
string
_format
string

Responses

Service Request

Create Service Request

Request Body schema: application/json
object
data
any (Service_Request)

Responses

Request samples

Content type
application/json
{
  • "context": {
    },
  • "data": null
}

Get all Service Request

query Parameters
practitioner
string
departmentId
string
practiceId
string
encounterId
string
patient
string
encounter
string
_count
string
_offset
string
_format
string

Responses

Update Service Request

path Parameters
id
required
string
Request Body schema: application/json
object
data
any (Service_Request)

Responses

Request samples

Content type
application/json
{
  • "context": {
    },
  • "data": null
}

ServiceRequest

Create ServiceRequest

Request Body schema: application/json
object
data
any (ServiceRequest)

Responses

Request samples

Content type
application/json
{
  • "context": {
    },
  • "data": null
}

Get all ServiceRequest

query Parameters
categorycode
string
patient
string
practiceId
string
encounterId
string
_count
string
_offset
string
_format
string

Responses

Update ServiceRequest

path Parameters
id
required
string
Request Body schema: application/json
object
data
any (ServiceRequest)

Responses

Request samples

Content type
application/json
{
  • "context": {
    },
  • "data": null
}

QuestionnaireResponse

Create QuestionnaireResponse

Request Body schema: application/json
object
object (QuestionnaireResponse)

Responses

Request samples

Content type
application/json
{
  • "context": {
    },
  • "data": {
    }
}

Get all QuestionnaireResponse

query Parameters
patient
string
practiceId
string
departmentId
string
name
string
birthdate
string
dob
string
first_name
string
last_name
string
_count
string
_offset
string
_format
string

Responses

Get QuestionnaireResponse

path Parameters
id
required
string

Responses

Update QuestionnaireResponse

path Parameters
id
required
string
Request Body schema: application/json
object
object (QuestionnaireResponse)

Responses

Request samples

Content type
application/json
{
  • "context": {
    },
  • "data": {
    }
}