Edvak Docs
HomeFHIR APICCDA API
HomeFHIR APICCDA API
LinkedIn
  1. Getting Started
  • Getting Started
    • Introduction
    • Supported Standards, Frameworks & API Versions
    • Standardized API Details – Patient and Population Services
    • Environment Endpoints
    • Errors and Exceptions
  • Authentication & Authorization
    • Overview – Authorization & Security Standards
    • Authorization
      • Well-known configuration
      • Authorize
      • Request
      • Revoke
      • Introspect
  • Developer Onboarding
    • App Registration & Credentials
  • API Usage Guidelines
    • FHIR API Interaction Conventions
  • US Core & USCDI Mapping
    • Overview
  • APIs
    • Allergies and Intolerances
      • By Patient ID
      • By Resource ID
    • Assessment and Plan of Treatment
      • By Patient and Category
    • Care Team Members
      • Care Teams
        • By Patient and Status
        • By Patient and Role
      • Related Person
        • By ID
        • By Patient
      • Practitioner
        • By Name
        • By Resource ID
        • By Identifier
      • Practioner Role
        • By Specialty
        • By Practitioner ID
        • By Practitioner Identifier
        • By Practitioner Name
      • Location
        • By Name
        • By Address
        • By City
        • By State
        • By Postal Code
      • Organization
        • By Name
        • By Address
    • Clinical Notes
      • Document References
        • By ID
        • By Patient
        • By Patient and Category
        • By Patient, Category, and Date
        • By Patient and Type
        • By Patient and Status
        • By Patient, Type, and Period
      • Diagnostic Report
        • By Patient ID
        • By Patient and Category
        • By Patient and Code
        • By Patient, Category, and Date
        • By Patient and Status
    • Goals
      • Get Goals by Patient ID
      • Get Goal by ID
      • Get Goals by Patient and Lifecycle Status
      • Get Goals by Patient and Target Date
      • Get Goals by Patient and Description
      • Get Diagnostic Reports by Patient, Code, and Date
    • Clinical Tests
      • Observation
        • By Patient and Category
        • By Patient and Code
        • By Patient, Code, and Date
        • By Patient, Category, and Date
        • By Patient, Category, and Status
      • Lab Diagnostic Report
        • By Patient
        • By Patient and Code
        • By Patient, Code, and Date
        • By Patient and Category
        • By Patient, Category, and Date
        • By Patient and Status
    • Diagnostic Imaging
      • Imaging Observations
        • By Patient
        • By Patient and Category
        • By Patient, Category, and Date
        • By Patient, Category, and Status
        • By Patient and Code
        • By Patient, Code and Date
    • Encounter Information
      • Encounter
        • By ID
        • By Patient ID
        • By Patient and Date Range
        • By Identifier
        • By Patient and Class
        • By Patient and Type
        • By Patient and Location
        • By Patient and Status
        • By Patient and Discharge Disposition
      • Encounter Diagnosis
        • By Patient ID
        • By Patient ID and Clinical Status
        • By Patient ID and Category
        • By Patient ID and Code
        • By Patient ID and Asserted Date
        • By Patient ID, Category, and Encounter
        • By Patient ID and Onset Date
        • By Patient ID and Recorded Date
        • By Patient ID and Abatement Date
    • Group
      • By ID
      • By $export (Group-level Bulk Export)
    • Health Concerns
      • By Patient
      • By Patient and Clinical Status
      • By Patient and Category
      • By Patient and Category and Encounter
      • By Patient and Code
      • By Patient and Asserted Date
      • By Patient and Onset Date
      • By Patient and Recorded Date
      • By Patient and Abatement Date
    • Implantable Devices
      • By Patient
      • By ID
      • By Patient and Type
    • Immunizations
      • By ID
      • By Patient
      • By Patient and Date
      • By Patient and Status
    • Laboratory
      • Laboratory Result Observation
        • By ID
        • By Patient and Category
        • By Patient, Category, and Date
        • By Patient, Category, and Status
        • By Patient and Code
        • By Patient, Code, and Date
    • Medications
      • Medications
        • By ID
        • By Patient
      • Medication Request
        • Get MedicationRequests by Patient
        • Get MedicationRequest by ID
        • Get MedicationRequests by Patient and Intent
        • Get MedicationRequests by Patient, Intent, and Encounter
        • Get MedicationRequests by Patient, Intent, and AuthoredOn Date
    • Patient Demographics
      • Patient
        • Get Patient by ID
        • Get Patient by Identifier
        • Get Patient by Name
        • Get Patient by Birthdate and Name
        • Get Patient by Gender and Name
        • Get Patient by Birthdate and Family Name
      • Observation Sexual Orientation
        • Get Observations by Patient ID
        • Get Observation by ID
        • Get Observations by Patient and Code
        • Get Observations by Patient, Code, and Date
        • Get Observations by Patient, Code, and Date
    • Procedures
      • Procedure
        • Get Procedures by Patient
        • Get Procedure by ID
        • Get Procedures by Patient and Date
        • Get Procedures by Patient and Status
        • Get Procedures by Patient, Code, and Date
      • Service Request
        • Get ServiceRequests by Patient
        • Get ServiceRequest by ID
        • Get ServiceRequests by Patient and Category
        • Get ServiceRequests by Patient and Code
        • Get ServiceRequests by Patient, Category, and Authored Date
        • Get ServiceRequests by Patient, Code, and Authored Date
        • Get ServiceRequests by Patient and Status
    • Provenance
      • Provenance
        • Get Provenance by ID
        • Get resource and Provenance using _revinclude
    • Smoking Status
      • Smoking Status
        • Get Observation by ID
        • Get Observations by Patient
        • Get Smoking Status by Patient and Code
    • Vital Signs
      • Vital Signs
        • Get Observation by ID
        • Get Observations by Patient and Category
        • Get Observations by Patient and Code
        • Get Observations by Patient, Category, and Date
        • Get Observations by Patient, Category, and Status
        • Get Observations by Patient, Code, and Date
  • Legal & Compliance
    • API Terms of Use
  1. Getting Started

Standardized API Details – Patient and Population Services

Edvak EHR's API conforms to ONC’s §170.315(g)(10) requirements and supports seamless access to patient and population-level health data using the following specifications:

Supported Standards#

SpecificationVersion
HL7® FHIR® APIR4 - v4.0.1
US Core Data for Interoperability (USCDI)v3
US Core Implementation Guidev6.1.0
FHIR® Bulk Data Accessv1.0.1
HL7 SMART App Launch Frameworkv2.0.0
AuthorizationOAuth 2.0 & OpenID Connect

API Syntax & Endpoints by Category#

INFO
All endpoint paths below are relative to your selected Base URL -
View published Base URLs here
CategoryMethodEndpoint
Allergies & IntolerancesGETfhir/AllergyIntolerance/[id]
GETfhir/AllergyIntolerance
POSTfhir/AllergyIntolerance/_search
Assessment & Plan of TreatmentGETfhir/CarePlan/[id]
GETfhir/CarePlan
POSTfhir/CarePlan/_search
SDOH AssessmentGETfhir/Observation/[id]
GETfhir/Observation
POSTfhir/Observation/_search
SurveyGETfhir/Observation/[id]
GETfhir/Observation
POSTfhir/Observation/_search
Social HistoryGETfhir/Observation/[id]
GETfhir/Observation
POSTfhir/Observation/_search
Questionnaire ResponsesGETfhir/QuestionnaireResponse/[id]
GETfhir/QuestionnaireResponse
POSTfhir/QuestionnaireResponse/_search
Care Team MembersGETfhir/CareTeam/[id]
GETfhir/CareTeam
POSTfhir/CareTeam/_search
GETfhir/RelatedPerson/[id]
GETfhir/RelatedPerson
POSTfhir/RelatedPerson/_search
Clinical NotesGETfhir/DocumentReference/[id]
GETfhir/DocumentReference
POSTfhir/DocumentReference/_search
GETfhir/DiagnosticReport/[id]
GETfhir/DiagnosticReport
POSTfhir/DiagnosticReport/_search
Clinical TestsGETfhir/Observation/[id]
GETfhir/Observation
POSTfhir/Observation/_search
GETfhir/DiagnosticReport/[id]
GETfhir/DiagnosticReport
POSTfhir/DiagnosticReport/_search
Diagnostic ImagingGETfhir/Observation/[id]
GETfhir/Observation
POSTfhir/Observation/_search
GETfhir/DiagnosticReport/[id]
GETfhir/DiagnosticReport
POSTfhir/DiagnosticReport/_search
EncountersGETfhir/Encounter/[id]
GETfhir/Encounter
POSTfhir/Encounter/_search
GETfhir/Condition/[id]
GETfhir/Condition
POSTfhir/Condition/_search
GoalsGETfhir/Goal/[id]
GETfhir/Goal
POSTfhir/Goal/_search
Health ConcernsGETfhir/Condition/[id]
GETfhir/Condition
POSTfhir/Condition/_search
ImmunizationsGETfhir/Immunization/[id]
GETfhir/Immunization
POSTfhir/Immunization/_search
Laboratory ResultsGETfhir/Observation/[id]
GETfhir/Observation
POSTfhir/Observation/_search
GETfhir/DiagnosticReport/[id]
GETfhir/DiagnosticReport
POSTfhir/DiagnosticReport/_search
MedicationsGETfhir/Medication/[id]
GETfhir/Medication
POSTfhir/Medication/_search
GETfhir/MedicationRequest/[id]
GETfhir/MedicationRequest
POSTfhir/MedicationRequest/_search
Patient DemographicsGETfhir/Patient/[id]
GETfhir/Patient
POSTfhir/Patient/_search
ProblemsGETfhir/Condition/[id]
GETfhir/Condition
POSTfhir/Condition/_search
ProceduresGETfhir/Procedure/[id]
GETfhir/Procedure
POSTfhir/Procedure/_search
GETfhir/ServiceRequest/[id]
GETfhir/ServiceRequest
POSTfhir/ServiceRequest/_search
ProvenanceGETfhir/Provenance/[id]
GETfhir/Provenance
POSTfhir/Provenance/_search
Smoking StatusGETfhir/Observation/[id]
GETfhir/Observation
POSTfhir/Observation/_search
Vital SignsGETfhir/Observation/[id]
GETfhir/Observation
POSTfhir/Observation/_search
Unique Device IdentifiersGETfhir/Device/[id]
GETfhir/Device
POSTfhir/Device/_search
OthersGETfhir/Binary/[id]
GETfhir/Location/[id]
GETfhir/Location
POSTfhir/Location/_search
GETfhir/Practitioner/[id]
GETfhir/Practitioner
POSTfhir/Practitioner/_search
GETfhir/PractitionerRole/[id]
GETfhir/PractitionerRole
POSTfhir/PractitionerRole/_search
Bulk ExportGETfhir/Group/[id]/$export
NOTE
All search endpoints follow _search convention with FHIR POST.
All resources support GET by ID and search parameters.
JSON is the default and required content type.
OAuth 2.0 is required for all access.
Previous
Supported Standards, Frameworks & API Versions
Next
Environment Endpoints
Built with