Interoperability APIs (FHIR++)

Number of APIs: 114

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.

We provide a set of common capabilities that can be applied to any FHIR resource or bundle of resources:

  • Create: Create and persist new FHIR resources by sending POST requests.

  • Read: Retrieve existing resources by ID or search parameters using GET requests.

  • Update: Update existing resources by sending PUT requests with modified data.

  • Delete: Delete resources by sending DELETE requests by ID.

  • Search: Find and filter for resources based on search criteria.

  • Query: Structured data retrieval by requesting defining criteria using parameters or filters.

These operations are available for all resources like Patient, Observation, Encounter and more.

For example, you can:

  • Create a new Patient

  • Read a Patient by ID

  • Update the Patient's demographics

  • Search for Patients by name

  • Get notified if the Patient is deleted

We are compatible with FHIR Release 4.2 (R4) - our APIs are fully compliant with FHIR R4 and passes official FHIR R4 validation testing. All resources can be used as standard FHIR R4 resources.

Source Ids:

  • Athena: 083fe714-e36e-4851-b2e7-a7166b439f67

  • Elation: 2341a165-3168-4961-9e99-be1aa6c29b9f

  1. api-v2-AllergyIntolerance-{allergy-intolerance-id} - Get Allergy by ID GET {{baseUrl}}/api/v2/AllergyIntolerance/:allergy-intolerance-id?patient=<string>&departmentId=<string>

  2. api-v2-AllergyIntolerance-{allergy-intolerance-id} - Update Allergy PUT {{baseUrl}}/api/v2/AllergyIntolerance/:allergy-intolerance-id

  3. api-v2-AllergyIntolerance - Create Allergy POST {{baseUrl}}/api/v2/AllergyIntolerance

  4. api-v2-AllergyIntolerance - Get a list of Allergies GET {{baseUrl}}/api/v2/AllergyIntolerance?patient=<string>&departmentId=<string>&_count=<integer>&_offset=<integer>&category=environment&asserter=<string>&clinical-status=resolved&code=<string>&criticality=high&date=<date>&encounter=<string>&identifier=<string>&include=<string>&last-date=<date>&manifestation=<string>&onset=<date>&patient-facing-call=<boolean>&practitioner=<string>&quorum=<boolean>&recorder=<string>&route=<string>&severity=mild&third-party-user-name=<string>&type=findings&verification-status=entered-in-error

  5. api-v2-Appointment-{appointment-id} - Get Appointment by ID GET {{baseUrl}}/api/v2/Appointment/:appointment-id

  6. api-v2-Appointment-{appointment-id} - Update Appointment PUT {{baseUrl}}/api/v2/Appointment/:appointment-id

  7. api-v2-Appointment-{appointment-id} - Delete Appointment DELETE {{baseUrl}}/api/v2/Appointment/:appointment-id

  8. api-v2-Appointment - Get a list of Appointments GET {{baseUrl}}/api/v2/Appointment?_id=<string>&date=<date>&scheduled-start-date=<dateTime>&ignore-restrictions=<boolean>&appointment-type-id=<string>&end-last-modified=<dateTime>&status=<string>&start-last-modified=<dateTime>&patient=<string>&scheduled-end-date=<dateTime>&count=<integer>&_offset=<integer>&end-date=<date>&start-date=<date>&sort-order=<string>&include=<string>&include=<string>&departmentId=<integer>&practitioner=<string>

  9. api-v2-Coverage - Create Coverage POST {{baseUrl}}/api/v2/Coverage?patient=<integer>

  10. api-v2-CoverageEligibilityRequest - Create Coverage Eligibility Request POST {{baseUrl}}/api/v2/CoverageEligibilityRequest