API Reference

Integrations & Technical Specifications

ChartScribe is built on modern standards for maximum compatibility and future-proofing. FHIR R4 + US Core IG + SMART on FHIR v2.2 — all documented, all ready to implement.

Base URL: https://api.chartscribe.io/fhir

FHIR R4 + US Core

Real-time bidirectional sync with any modern EHR

  • Composition & Observation resources
  • US Core v6+ profiles
  • Bulk Data $export for population health
  • LOINC 11488-4 (Consultation Note)
  • Document Bundle type (not transaction)
View FHIR API Docs

C-CDA & Legacy Support

Full compatibility with older systems

  • CCD, Progress Note, Consultation Note
  • Companion Guide R4.1 (2026 standard)
  • 10 LOINC-coded C-CDA sections
  • Jinja2 templating engine
  • NIST validator compatible XML output
View C-CDA Docs

SMART on FHIR Ready

Secure app launch for patients and clinicians

  • 3 launch types (patient, EHR, carer)
  • OAuth2 + CSRF protection
  • Patient context auto-passed
  • .care portal app connectivity
  • Apple Health, MyFitnessPal, Epic
View SMART Docs

Authentication & Base Configuration

Base URL
https://api.chartscribe.io/fhir
Auth Type
OAuth2 Bearer + SMART scopes
FHIR Version
R4.0.1 (Normative)
Content-Type
application/fhir+json
Endpoints

FHIR API Reference

4 core endpoints. Copy, paste, and integrate.

POST/Composition

Push a completed clinical note to a connected EHR, or return a FHIR document Bundle for download.

Bearer token + SMART scope

Request
POST https://api.chartscribe.io/fhir/Composition
Content-Type: application/fhir+json
Authorization: Bearer {access_token}

{
  "resourceType": "Bundle",
  "id": "bundle-note-20260621-001",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2026-06-21T10:00:00Z"
  },
  "type": "document",
  "entry": [
    {
      "fullUrl": "https://api.chartscribe.io/fhir/Composition/note-001",
      "resource": {
        "resourceType": "Composition",
        "id": "note-001",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
          ]
        },
        "status": "final",
        "type": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "11488-4",
              "display": "Consultation note"
            }
          ],
          "text": "Consultation Note"
        },
        "subject": {
          "reference": "Patient/12345",
          "display": "John Doe"
        },
        "date": "2026-06-21T10:00:00Z",
        "author": [
          {
            "reference": "Practitioner/dr456",
            "display": "Dr. Jane Smith"
          }
        ],
        "title": "Consultation Note - John Doe",
        "attester": [
          {
            "mode": "legal",
            "party": {
              "reference": "Practitioner/dr456"
            }
          }
        ],
        "section": [
          {
            "title": "Subjective",
            "code": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "10164-2"
                }
              ]
            },
            "text": {
              "status": "generated",
              "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Patient reports chest pain for 2 days, radiating to left arm.</div>"
            }
          },
          {
            "title": "Objective",
            "code": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "61149-1"
                }
              ]
            },
            "text": {
              "status": "generated",
              "div": "<div>BP 142/88 mmHg. HR 86 bpm. SpO2 98% on room air.</div>"
            }
          },
          {
            "title": "Assessment",
            "code": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "51848-6"
                }
              ]
            },
            "text": {
              "status": "generated",
              "div": "<div>1. Unstable angina (ICD-10: I20.0)</div>"
            }
          },
          {
            "title": "Plan",
            "code": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "18776-5"
                }
              ]
            },
            "text": {
              "status": "generated",
              "div": "<div>1. ECG ordered stat. 2. Cardiology consult. 3. Continue metoprolol.</div>"
            }
          }
        ]
      }
    },
    {
      "fullUrl": "https://api.chartscribe.io/fhir/Patient/12345",
      "resource": {
        "resourceType": "Patient",
        "id": "12345",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
          ]
        },
        "identifier": [
          {
            "system": "https://chartscribe.io/mrn",
            "value": "MRN-12345"
          }
        ],
        "name": [
          {
            "use": "official",
            "family": "Doe",
            "given": ["John"]
          }
        ],
        "gender": "male",
        "birthDate": "1978-04-15"
      }
    }
  ]
}
Response
HTTP/1.1 201 Created
Content-Type: application/fhir+json
Location: https://api.chartscribe.io/fhir/Bundle/bundle-note-20260621-001

{
  "resourceType": "OperationOutcome",
  "id": "create-response",
  "issue": [
    {
      "severity": "information",
      "code": "informational",
      "diagnostics": "Bundle created successfully. 2 resources processed."
    }
  ]
}

SMART Scope Reference

patient/*.read

Read all patient data

patient/Composition.write

Write clinical notes

launch/patient

Launch with patient context

system/*.read

Bulk data access (Enterprise)

openid

Identity verification

profile

User profile access

user/*.read

Carer relationship data

patient/Observation.read

Read vitals only

Download Full Technical Specifications

PDF includes all endpoints, schemas, authentication flows, error codes, and integration checklists for your IT team.

We use cookies to improve your experience

Necessary cookies are always active. Analytics and marketing cookies help us improve ChartScribe and show relevant content. You can manage your preferences at any time.

We use cookies to improve your experience

Necessary cookies are always active. Analytics and marketing cookies help us improve ChartScribe and show relevant content. You can manage your preferences at any time.