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.
x-source-id | string |
object | |
object (AllergyIntolerance) |
{- "context": {
- "quorum": true,
- "request-id": "string"
}, - "data": {
- "resourceType": "string",
- "id": "string",
- "text": {
- "fhir_comments": [
- { }
], - "status": "string",
- "div": "string"
}, - "identifier": [
- {
- "system": "string",
- "value": "string"
}
], - "recordedDate": "string",
- "_recordedDate": {
- "fhir_comments": [
- { }
]
}, - "recorder": {
- "fhir_comments": [
- { }
], - "reference": "string"
}, - "patient": {
- "fhir_comments": [
- { }
], - "reference": "string"
}, - "substance": {
- "fhir_comments": [
- { }
], - "coding": [
- {
- "system": "string",
- "code": "string",
- "display": "string"
}
]
}, - "status": "string",
- "_status": {
- "fhir_comments": [
- { }
]
}, - "criticality": "string",
- "type": "string",
- "_type": {
- "fhir_comments": [
- { }
]
}, - "category": "string",
- "_category": {
- "fhir_comments": [
- { }
]
}, - "lastOccurence": "string",
- "_lastOccurence": {
- "fhir_comments": [
- { }
]
}, - "reaction": [
- {
- "fhir_comments": [
- { }
], - "substance": {
- "fhir_comments": [
- { }
], - "coding": [
- {
- "system": "string",
- "code": "string",
- "display": "string"
}
]
}, - "manifestation": [
- {
- "coding": [
- {
- "system": "string",
- "code": "string",
- "display": "string"
}
]
}
], - "description": "string",
- "onset": "string",
- "severity": "string"
}
]
}
}
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 |
x-source-id | string |
id required | string |
x-source-id | string |
object | |
object (AllergyIntolerance) |
{- "context": {
- "quorum": true,
- "request-id": "string"
}, - "data": {
- "resourceType": "string",
- "id": "string",
- "text": {
- "fhir_comments": [
- { }
], - "status": "string",
- "div": "string"
}, - "identifier": [
- {
- "system": "string",
- "value": "string"
}
], - "recordedDate": "string",
- "_recordedDate": {
- "fhir_comments": [
- { }
]
}, - "recorder": {
- "fhir_comments": [
- { }
], - "reference": "string"
}, - "patient": {
- "fhir_comments": [
- { }
], - "reference": "string"
}, - "substance": {
- "fhir_comments": [
- { }
], - "coding": [
- {
- "system": "string",
- "code": "string",
- "display": "string"
}
]
}, - "status": "string",
- "_status": {
- "fhir_comments": [
- { }
]
}, - "criticality": "string",
- "type": "string",
- "_type": {
- "fhir_comments": [
- { }
]
}, - "category": "string",
- "_category": {
- "fhir_comments": [
- { }
]
}, - "lastOccurence": "string",
- "_lastOccurence": {
- "fhir_comments": [
- { }
]
}, - "reaction": [
- {
- "fhir_comments": [
- { }
], - "substance": {
- "fhir_comments": [
- { }
], - "coding": [
- {
- "system": "string",
- "code": "string",
- "display": "string"
}
]
}, - "manifestation": [
- {
- "coding": [
- {
- "system": "string",
- "code": "string",
- "display": "string"
}
]
}
], - "description": "string",
- "onset": "string",
- "severity": "string"
}
]
}
}
x-source-id | string |
object | |
object (Condition) |
{- "context": {
- "quorum": true,
- "request-id": "string"
}, - "data": {
- "resourceType": "string",
- "id": "string",
- "text": {
- "status": "string",
- "div": "string"
}, - "patient": {
- "reference": "string"
}, - "code": {
- "coding": [
- {
- "system": "string",
- "code": "string",
- "display": "string"
}
], - "text": "string"
}, - "category": {
- "coding": [
- {
- "fhir_comments": [
- { }
], - "system": "string",
- "code": "string",
- "display": "string"
}
]
}, - "verificationStatus": "string",
- "severity": {
- "coding": [
- {
- "system": "string",
- "code": "string",
- "display": "string"
}
]
}, - "onsetDateTime": "string",
- "bodySite": [
- {
- "coding": [
- {
- "system": "string",
- "code": "string",
- "display": "string"
}
], - "text": "string"
}
]
}
}
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 |
x-source-id | string |
id required | string |
x-source-id | string |
object | |
object (Condition) |
{- "context": {
- "quorum": true,
- "request-id": "string"
}, - "data": {
- "resourceType": "string",
- "id": "string",
- "text": {
- "status": "string",
- "div": "string"
}, - "patient": {
- "reference": "string"
}, - "code": {
- "coding": [
- {
- "system": "string",
- "code": "string",
- "display": "string"
}
], - "text": "string"
}, - "category": {
- "coding": [
- {
- "fhir_comments": [
- { }
], - "system": "string",
- "code": "string",
- "display": "string"
}
]
}, - "verificationStatus": "string",
- "severity": {
- "coding": [
- {
- "system": "string",
- "code": "string",
- "display": "string"
}
]
}, - "onsetDateTime": "string",
- "bodySite": [
- {
- "coding": [
- {
- "system": "string",
- "code": "string",
- "display": "string"
}
], - "text": "string"
}
]
}
}
x-source-id | string |
object | |
object (Patient) |
{- "context": {
- "quorum": true,
- "request-id": "string"
}, - "data": {
- "resourceType": "string",
- "id": "string",
- "text": {
- "status": "string",
- "div": "string"
}, - "identifier": [
- {
- "use": "string",
- "type": {
- "coding": [
- {
- "system": "string",
- "code": "string"
}
]
}, - "system": "string",
- "value": "string"
}
], - "active": true,
- "name": [
- {
- "use": "string",
- "family": [
- { }
], - "given": [
- { }
]
}
], - "gender": "string",
- "photo": [
- {
- "contentType": "string",
- "data": "string"
}
], - "contact": [
- {
- "relationship": [
- {
- "coding": [
- {
- "system": "string",
- "code": "string"
}
]
}
], - "organization": {
- "reference": "string",
- "display": "string"
}
}
], - "managingOrganization": {
- "reference": "string",
- "display": "string"
}, - "link": [
- {
- "other": {
- "reference": "string"
}, - "type": "string"
}
]
}
}
practitioner | string |
identifier | string |
name | string |
active | boolean |
deceased | boolean |
birthdate | string |
given | string |
gender | string |
nickname | string |
string | |
phone | string |
_count | string |
_offset | string |
_sort | string |
has:CareTeam:participant:member | string |
practiceId | string |
departmentId | string |
_format | string |
x-source-id | string |
id required | string |
x-source-id | string |
object | |
object (Patient) |
{- "context": {
- "quorum": true,
- "request-id": "string"
}, - "data": {
- "resourceType": "string",
- "id": "string",
- "text": {
- "status": "string",
- "div": "string"
}, - "identifier": [
- {
- "use": "string",
- "type": {
- "coding": [
- {
- "system": "string",
- "code": "string"
}
]
}, - "system": "string",
- "value": "string"
}
], - "active": true,
- "name": [
- {
- "use": "string",
- "family": [
- { }
], - "given": [
- { }
]
}
], - "gender": "string",
- "photo": [
- {
- "contentType": "string",
- "data": "string"
}
], - "contact": [
- {
- "relationship": [
- {
- "coding": [
- {
- "system": "string",
- "code": "string"
}
]
}
], - "organization": {
- "reference": "string",
- "display": "string"
}
}
], - "managingOrganization": {
- "reference": "string",
- "display": "string"
}, - "link": [
- {
- "other": {
- "reference": "string"
}, - "type": "string"
}
]
}
}
x-source-id | string |
object | |
object (Immunization) |
{- "context": {
- "quorum": true,
- "request-id": "string"
}, - "data": {
- "resourceType": "string",
- "id": "string",
- "text": {
- "status": "string",
- "div": "string"
}, - "identifier": [
- {
- "system": "string",
- "value": "string"
}
], - "status": "string",
- "date": "string",
- "vaccineCode": {
- "coding": [
- {
- "system": "string",
- "code": "string"
}
], - "text": "string"
}, - "patient": {
- "reference": "string"
}, - "wasNotGiven": true,
- "reported": true,
- "performer": {
- "reference": "string"
}, - "requester": {
- "reference": "string"
}, - "encounter": {
- "reference": "string"
}, - "manufacturer": {
- "reference": "string"
}, - "location": {
- "reference": "string"
}, - "lotNumber": "string",
- "expirationDate": "string",
- "site": {
- "coding": [
- {
- "system": "string",
- "code": "string",
- "display": "string"
}
]
}, - "route": {
- "coding": [
- {
- "system": "string",
- "code": "string",
- "display": "string"
}
]
}, - "doseQuantity": {
- "value": 0,
- "system": "string",
- "code": "string"
}, - "note": [
- {
- "text": "string"
}
], - "explanation": {
- "reason": [
- {
- "coding": [
- {
- "system": "string",
- "code": "string"
}
]
}
]
}, - "reaction": [
- {
- "date": "string",
- "detail": {
- "reference": "string"
}, - "reported": true
}
], - "vaccinationProtocol": [
- {
- "doseSequence": 0,
- "description": "string",
- "authority": {
- "reference": "string"
}, - "series": "string",
- "seriesDoses": 0,
- "targetDisease": [
- {
- "coding": [
- {
- "system": "string",
- "code": "string"
}
]
}
], - "doseStatus": {
- "coding": [
- {
- "system": "string",
- "code": "string",
- "display": "string"
}
]
}, - "doseStatusReason": {
- "coding": [
- {
- "system": "string",
- "code": "string",
- "display": "string"
}
]
}
}
]
}
}
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 |
x-source-id | string |
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 |
x-source-id | string |
x-source-id | string |
object | |
object (Appointment) |
{- "context": {
- "quorum": true,
- "request-id": "string"
}, - "data": {
- "resourceType": "string",
- "id": "string",
- "text": {
- "status": "string",
- "div": "string"
}, - "status": "string",
- "type": {
- "coding": [
- {
- "code": "string",
- "display": "string"
}
]
}, - "priority": 0,
- "description": "string",
- "start": "string",
- "end": "string",
- "comment": "string",
- "participant": [
- {
- "type": [
- {
- "coding": [
- {
- "code": "string"
}
]
}
], - "actor": {
- "reference": "string",
- "display": "string"
}, - "required": "string",
- "status": "string"
}
]
}
}
id required | string |
x-source-id | string |
object | |
object (Appointment) |
{- "context": {
- "quorum": true,
- "request-id": "string"
}, - "data": {
- "resourceType": "string",
- "id": "string",
- "text": {
- "status": "string",
- "div": "string"
}, - "status": "string",
- "type": {
- "coding": [
- {
- "code": "string",
- "display": "string"
}
]
}, - "priority": 0,
- "description": "string",
- "start": "string",
- "end": "string",
- "comment": "string",
- "participant": [
- {
- "type": [
- {
- "coding": [
- {
- "code": "string"
}
]
}
], - "actor": {
- "reference": "string",
- "display": "string"
}, - "required": "string",
- "status": "string"
}
]
}
}
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 |
x-source-id | string |
object | |
object (MedicationStatement) |
{- "context": {
- "quorum": true,
- "request-id": "string"
}, - "data": {
- "resourceType": "string",
- "id": "string",
- "text": {
- "status": "string",
- "div": "string"
}, - "patient": {
- "reference": "string"
}, - "informationSource": {
- "reference": "string"
}, - "dateAsserted": "string",
- "status": "string",
- "wasNotTaken": true,
- "reasonForUseCodeableConcept": {
- "coding": [
- {
- "system": "string",
- "code": "string",
- "display": "string"
}
]
}, - "effectiveDateTime": "string",
- "note": "string",
- "medicationReference": {
- "reference": "string"
}, - "dosage": [
- {
- "text": "string",
- "timing": {
- "repeat": {
- "frequency": 0,
- "period": 0,
- "periodUnits": "string"
}
}, - "asNeededBoolean": true,
- "route": {
- "coding": [
- {
- "system": "string",
- "code": "string",
- "display": "string"
}
]
}, - "quantityQuantity": {
- "value": 0
}, - "maxDosePerPeriod": {
- "numerator": {
- "value": 0,
- "unit": "string",
- "system": "string",
- "code": "string"
}, - "denominator": {
- "value": 0,
- "system": "string",
- "code": "string"
}
}
}
]
}
}
object | |
object (Observation) |
{- "context": {
- "quorum": true,
- "request-id": "string"
}, - "data": {
- "resourceType": "string",
- "id": "string",
- "text": {
- "fhir_comments": [
- { }
], - "status": "string",
- "div": "string"
}, - "status": "string",
- "category": {
- "fhir_comments": [
- { }
], - "coding": [
- {
- "system": "string",
- "code": "string",
- "display": "string"
}
]
}, - "code": {
- "fhir_comments": [
- { }
], - "coding": [
- {
- "fhir_comments": [
- { }
], - "system": "string",
- "code": "string",
- "display": "string"
}
]
}, - "subject": {
- "reference": "string"
}, - "encounter": {
- "reference": "string"
}, - "valueQuantity": {
- "fhir_comments": [
- { }
], - "value": 0,
- "unit": "string",
- "system": "string",
- "code": "string"
}
}
}
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 |
x-source-id | string |
object | |
object (Coverage) |
{- "context": {
- "quorum": true,
- "request-id": "string"
}, - "data": {
- "resourceType": "string",
- "id": "string",
- "text": {
- "status": "string",
- "div": "string"
}, - "issuer": {
- "reference": "string"
}, - "period": {
- "start": "string",
- "end": "string"
}, - "type": {
- "system": "string",
- "code": "string",
- "display": "string"
}, - "identifier": [
- {
- "system": "string",
- "value": "string"
}
], - "plan": "string",
- "subPlan": "string",
- "dependent": 0,
- "sequence": 0,
- "subscriber": {
- "reference": "string"
}
}
}
{- "context": {
- "quorum": true,
- "request-id": "string"
}, - "data": {
- "resourceType": "string",
- "id": "string",
- "text": {
- "status": "string",
- "div": "string"
}, - "subject": {
- "reference": "string"
}, - "status": "string",
- "code": {
- "coding": [
- {
- "system": "string",
- "code": "string",
- "display": "string"
}
], - "text": "string"
}, - "reasonCodeableConcept": {
- "text": "string"
}, - "performer": [
- {
- "actor": {
- "reference": "string",
- "display": "string"
}
}
], - "performedDateTime": "string",
- "followUp": [
- {
- "text": "string"
}
], - "notes": [
- {
- "text": "string"
}
]
}
}
object | |
object (FamilyMemberHistory) |
{- "context": {
- "quorum": true,
- "request-id": "string"
}, - "data": {
- "resourceType": "string",
- "id": "string",
- "text": {
- "status": "string",
- "div": "string"
}, - "patient": {
- "reference": "string",
- "display": "string"
}, - "date": "string",
- "status": "string",
- "relationship": {
- "coding": [
- {
- "system": "string",
- "code": "string"
}
]
}, - "condition": [
- {
- "code": {
- "coding": [
- {
- "system": "string",
- "code": "string",
- "display": "string"
}
], - "text": "string"
}, - "onsetQuantity": {
- "value": 0,
- "unit": "string",
- "system": "string"
}, - "note": {
- "text": "string"
}
}
]
}
}
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 |
object | |
object (QuestionnaireResponse) |
{- "context": {
- "quorum": true,
- "request-id": "string"
}, - "data": {
- "resourceType": "string",
- "id": "string",
- "text": {
- "status": "string",
- "div": "string"
}, - "contained": [
- {
- "resourceType": "string",
- "id": "string",
- "status": "string",
- "code": {
- "coding": [
- {
- "system": "string",
- "code": "string",
- "display": "string"
}
]
}, - "subject": {
- "reference": "string"
}, - "performer": [
- {
- "reference": "string"
}
], - "valueCodeableConcept": {
- "coding": [
- {
- "system": "string",
- "code": "string",
- "display": "string"
}
]
}
}
], - "status": "string",
- "subject": {
- "reference": "string"
}, - "author": {
- "reference": "string"
}, - "authored": "string",
- "group": {
- "fhir_comments": [
- { }
], - "title": "string",
- "group": [
- {
- "question": [
- {
- "fhir_comments": [
- { }
], - "answer": [
- {
- "valueCoding": {
- "system": null,
- "code": null,
- "display": null
}, - "group": [
- { }
]
}
]
}
]
}
]
}
}
}
id required | string |
object | |
object (QuestionnaireResponse) |
{- "context": {
- "quorum": true,
- "request-id": "string"
}, - "data": {
- "resourceType": "string",
- "id": "string",
- "text": {
- "status": "string",
- "div": "string"
}, - "contained": [
- {
- "resourceType": "string",
- "id": "string",
- "status": "string",
- "code": {
- "coding": [
- {
- "system": "string",
- "code": "string",
- "display": "string"
}
]
}, - "subject": {
- "reference": "string"
}, - "performer": [
- {
- "reference": "string"
}
], - "valueCodeableConcept": {
- "coding": [
- {
- "system": "string",
- "code": "string",
- "display": "string"
}
]
}
}
], - "status": "string",
- "subject": {
- "reference": "string"
}, - "author": {
- "reference": "string"
}, - "authored": "string",
- "group": {
- "fhir_comments": [
- { }
], - "title": "string",
- "group": [
- {
- "question": [
- {
- "fhir_comments": [
- { }
], - "answer": [
- {
- "valueCoding": {
- "system": null,
- "code": null,
- "display": null
}, - "group": [
- { }
]
}
]
}
]
}
]
}
}
}