retrieve-ccda

GET

api

2.0

ccda

{id}

Retrieve Ccda

curl --request GET \
  --url https://sandbox.elationemr.com/api/2.0/ccda/{id}/ \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandbox.elationemr.com/api/2.0/ccda/{id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.elationemr.com/api/2.0/ccda/{id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.elationemr.com/api/2.0/ccda/{id}/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox.elationemr.com/api/2.0/ccda/{id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "base64_ccda": "<string>"
}

Allergies and end_date. When you pass end_date, an allergy added to the chart after that date is excluded from the returned document. However, an allergy’s active/inactive status is not tracked with a point-in-time history: if an allergy was later marked inactive or resolved, the returned document reflects its current status, not necessarily its status as of end_date.

Assessment-to-Plan linking depends on the source visit note’s format. In the returned CCDA, a diagnosis (Assessment) is only linked to its specific plan items (Plan of Treatment) when the underlying visit note uses a format with a combined Assessment/Plan section (Assessplan category) — see Visit Note Formats. For notes using a format with separate Assessment and Plan fields (e.g. SOAP), both the diagnosis and the plan content are present in the document, but without a structural link between them.

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowClient Credentials

Token URL: /api/2.0/oauth2/token/

Path Parameters

integer

required

The id of the patient to retrieve the CCDA for.

Query Parameters

end_date

string<date>

The end date of the CCDA to retrieve.

sections

string[]

A comma-separated list of sections to include in the CCDA. If not provided, all sections will be included.

start_date

string<date>

The start date of the CCDA to retrieve.

template

enum<string>

The template used to display the desired information on the CCDA

Available options:

generateCCD,

generateCarePlan,

generateProgressNote,

generateReferralNote

Response

200 - application/json

integer<int64>

required

base64_ccda

file

read-only

⌘I

Retrieve Ccda

curl --request GET \
  --url https://sandbox.elationemr.com/api/2.0/ccda/{id}/ \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandbox.elationemr.com/api/2.0/ccda/{id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.elationemr.com/api/2.0/ccda/{id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.elationemr.com/api/2.0/ccda/{id}/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox.elationemr.com/api/2.0/ccda/{id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "base64_ccda": "<string>"
}

API Reference

REST API

FHIR API

HL7 Interface

Authorizations

Path Parameters

Query Parameters

Response