{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"FHIR R4 API","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"__idx":0,"id":"fhir-r4-api"},"children":["FHIR R4 API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Axiomera FHIR R4 API provides a complete, standards-compliant implementation of the HL7 FHIR R4 specification for healthcare data interoperability."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"__idx":1,"id":"overview"},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["FHIR (Fast Healthcare Interoperability Resources) is a standard for exchanging healthcare information electronically. Our implementation follows the FHIR R4 specification (version 4.0.1)."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"__idx":2,"id":"resource-modules"},"children":["Resource Modules"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Select a module from the sidebar to explore its API documentation:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Module"},"children":["Module"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Foundation"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Core building blocks (Binary, Bundle, CapabilityStatement)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Implementer Support"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["StructureDefinition, ImplementationGuide, StructureMap"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Security and Privacy"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AuditEvent, Consent, Provenance"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Conformance"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CapabilityStatement, OperationDefinition, SearchParameter"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Terminology"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ValueSet, CodeSystem, ConceptMap"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Exchange"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bundle, MessageHeader, Subscription"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Administration"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Patient, Practitioner, Organization, Location"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Clinical"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Condition, Procedure, CarePlan, DocumentReference"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Diagnostic"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Observation, DiagnosticReport, ImagingStudy"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Medications"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Medication, MedicationRequest, Immunization"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Workflow"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Appointment, Schedule, Task, Encounter"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Financial"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account, Claim, Coverage, ExplanationOfBenefit"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Clinical Reasoning"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ResearchStudy, Measure, Questionnaire"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"__idx":3,"id":"base-urls"},"children":["Base URLs"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Environment"},"children":["Environment"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"URL"},"children":["URL"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Production"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.heydonto.com"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Staging"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api-staging.heydonto.com"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"__idx":4,"id":"authentication"},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All endpoints require JWT bearer token authentication. See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/get-started"},"children":["Getting Started"]}," for details."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"__idx":5,"id":"standard-operations"},"children":["Standard Operations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All FHIR resources support these operations:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Search"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /site/{siteId}/fhir/{resource}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Search resources"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /site/{siteId}/fhir/{resource}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create a resource"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /site/{siteId}/fhir/{resource}/{id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read a resource"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /site/{siteId}/fhir/{resource}/{id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update a resource"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /site/{siteId}/fhir/{resource}/{id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete a resource"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["History"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /site/{siteId}/fhir/{resource}/{id}/history"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get version history"]}]}]}]}]}]},"headings":[{"value":"FHIR R4 API","id":"fhir-r4-api","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Resource Modules","id":"resource-modules","depth":2},{"value":"Base URLs","id":"base-urls","depth":2},{"value":"Authentication","id":"authentication","depth":2},{"value":"Standard Operations","id":"standard-operations","depth":2}],"frontmatter":{"title":"FHIR R4 API","seo":{"title":"FHIR R4 API"}},"lastModified":"2026-08-09T16:14:32.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/fhir-api","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}