Edvak Docs
HomeFHIR APICCDA API
HomeFHIR APICCDA API
LinkedIn
  1. Authorization
  • 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
        GET
      • Authorize
        GET
      • Request
        POST
      • Revoke
        POST
      • Introspect
        POST
  • 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. Authorization

Request

Developing
Sandbox
https://fhir-dev.edvak.com
Sandbox
https://fhir-dev.edvak.com
POST
https://fhir-dev.edvak.com
/realms/EDVAK/protocol/openid-connect/token
Once the application has successfully received an authorization code via the authorization endpoint, it must exchange this code for an access token. This is done by making a POST request to the EHR's token endpoint using the application/x-www-form-urlencoded content type.

Client Authentication:#

For confidential apps, use HTTP Basic Authentication in the request header. The format is:
Authorization: Basic Base64Encode(client_id:client_secret)
Example:
If your client_id is my-app and client_secret is my-app-secret-123, the encoded value would be:
Authorization: Basic bXktYXBwOm15LWFwcC1zZWNyZXQtMTIz
For public apps, the client_id is passed as a parameter in the request body, and no authentication header is required since these clients do not have a client secret.
POST /realms/EDVAK/protocol/openid-connect/token
Content-Type: application/x-www-form-urlencoded

code=abc123&
code_verifier=xyz456&
grant_type=authorization_code&
redirect_uri=https%3A%2F%2Fexample.com%2Fcallback&
client_id=my-public-client

Request

Authorization
Add the parameter
Authorization
to Headers
,whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
Header Params
Content-Type
string 
required
Example:
application/x-www-form-urlencoded
Body Params application/x-www-form-urlencoded
grant_type
string 
required
Example:
authorization_code
code
string 
required
The authorization code previously obtained from the authorization step.
Example:
<code>
redirect_uri
string 
required
This must match the redirect URI used in the original authorization request to ensure request integrity.
Example:
<redirect_uri>
code_verifier
string 
required
Used to validate the code_challenge previously provided in the authorization request. This is part of the PKCE protocol.
Example:
<code_verifier>
client_id
string 
optional
Required only for public clients (those without a client secret). Confidential clients typically authenticate using basic authentication instead.
Example:
<client_id>

Responses

🟢200Success
application/json
Body
message
string 
required
token
object 
required
access_token
string 
required
expires_in
integer 
required
refresh_expires_in
integer 
required
refresh_token
string 
required
token_type
string 
required
not-before-policy
integer 
required
session_state
string 
required
scope
string 
required
patient
string 
required
tenant
string 
required
Example
{
  "message": "Token generated successfully",
  "token": {
    "access_token": "ey2e8mzoih38wLeJH50QsrWpYkIL0p8c8Jr5.lxBJ4xUHUdrVf1uP76yow7jxaeOgXCpzby1oZiB4eaAOj4Z3TaKF460EH2H3Rnp3rblBkys9l1PjCzWS.ehdIzNVT4385CrKXlEIQ8gtlo4Y0MyBI0kY5Dt5B...",
    "expires_in": 900,
    "refresh_expires_in": 8208000,
    "refresh_token": "ey2e8mzoih38wLeJH50QsrWpYkIL0p8c8Jr5.lxBJ4xUHUdrVf1uP76yow7jxaeOgXCpzby1oZiB4eaAOj4Z3TaKF460EH2H3Rnp3rblBkys9l1PjCzWS.ehdIzNVT4385CrKXlEIQ8gtlo4Y0MyBI0kY5Dt5B...",
    "token_type": "Bearer",
    "not-before-policy": 1741856296,
    "session_state": "712430d3-da39-4cad-884b-862d32ac9c6d",
    "scope": "patient/MedicationDispense.rs profile patient/Patient.rs tenant patient/ServiceRequest.rs patient fhirUser patient/Coverage.rs email",
    "patient": "3",
    "tenant": "TENANT_AB"
  }
}
Previous
Authorize
Next
Revoke
Built with