HL7 FHIR R4

FHIR R4 Documentation

Full HL7 FHIR R4 compliance for seamless EHR integration. US Core profiles, USCDI V3 data elements, and SMART on FHIR authorization.

View Resources REST API Docs

FHIR R4

Full specification compliance

US Core

Profile implementation

USCDI V3

Data elements supported

SMART on FHIR

OAuth 2.0 authorization

FHIR Base URL

https://api.vsumup-health.com/fhir

All FHIR endpoints are prefixed with /fhir. The CapabilityStatement is available at /fhir/metadata.

Supported Resources

Patient

Demographics, identifiers, and contact information

US Core Patient

readsearchcreateupdate

Example Resource

{
  "resourceType": "Patient",
  "id": "patient-123",
  "identifier": [{
    "system": "urn:oid:2.16.840.1.113883.4.1",
    "value": "123-45-6789"
  }],
  "name": [{
    "family": "Smith",
    "given": ["John", "Robert"]
  }],
  "birthDate": "1980-01-15",
  "gender": "male",
  "address": [{
    "line": ["123 Main St"],
    "city": "Boston",
    "state": "MA",
    "postalCode": "02101"
  }]
}

Observation

Vital signs, lab results, and clinical measurements

US Core Vital Signs

readsearchcreate

Example Resource

{
  "resourceType": "Observation",
  "id": "obs-bp-123",
  "status": "final",
  "category": [{
    "coding": [{
      "system": "http://terminology.hl7.org/CodeSystem/observation-category",
      "code": "vital-signs"
    }]
  }],
  "code": {
    "coding": [{
      "system": "http://loinc.org",
      "code": "85354-9",
      "display": "Blood pressure panel"
    }]
  },
  "subject": {
    "reference": "Patient/patient-123"
  },
  "effectiveDateTime": "2025-01-31T10:30:00Z",
  "component": [
    {
      "code": {
        "coding": [{
          "system": "http://loinc.org",
          "code": "8480-6",
          "display": "Systolic blood pressure"
        }]
      },
      "valueQuantity": {
        "value": 142,
        "unit": "mmHg",
        "system": "http://unitsofmeasure.org",
        "code": "mm[Hg]"
      }
    },
    {
      "code": {
        "coding": [{
          "system": "http://loinc.org",
          "code": "8462-4",
          "display": "Diastolic blood pressure"
        }]
      },
      "valueQuantity": {
        "value": 88,
        "unit": "mmHg"
      }
    }
  ]
}

Condition

Diagnoses, problems, and health concerns

US Core Condition

readsearch

Example Resource

{
  "resourceType": "Condition",
  "id": "condition-htn-123",
  "clinicalStatus": {
    "coding": [{
      "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
      "code": "active"
    }]
  },
  "verificationStatus": {
    "coding": [{
      "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
      "code": "confirmed"
    }]
  },
  "category": [{
    "coding": [{
      "system": "http://terminology.hl7.org/CodeSystem/condition-category",
      "code": "problem-list-item"
    }]
  }],
  "code": {
    "coding": [{
      "system": "http://hl7.org/fhir/sid/icd-10-cm",
      "code": "I10",
      "display": "Essential hypertension"
    }]
  },
  "subject": {
    "reference": "Patient/patient-123"
  },
  "onsetDateTime": "2023-06-15"
}

MedicationStatement

Current and historical medication records

US Core MedicationStatement

readsearchcreate

Example Resource

{
  "resourceType": "MedicationStatement",
  "id": "medstmt-123",
  "status": "active",
  "medicationCodeableConcept": {
    "coding": [{
      "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
      "code": "314076",
      "display": "Lisinopril 10 MG Oral Tablet"
    }]
  },
  "subject": {
    "reference": "Patient/patient-123"
  },
  "effectivePeriod": {
    "start": "2024-01-01"
  },
  "dosage": [{
    "text": "10mg once daily",
    "timing": {
      "repeat": {
        "frequency": 1,
        "period": 1,
        "periodUnit": "d"
      }
    },
    "doseAndRate": [{
      "doseQuantity": {
        "value": 10,
        "unit": "mg"
      }
    }]
  }]
}

Practitioner

Healthcare provider information

US Core Practitioner

readsearch

Example Resource

{
  "resourceType": "Practitioner",
  "id": "practitioner-456",
  "identifier": [{
    "system": "http://hl7.org/fhir/sid/us-npi",
    "value": "1234567890"
  }],
  "name": [{
    "family": "Jones",
    "given": ["Sarah"],
    "prefix": ["Dr."]
  }],
  "qualification": [{
    "code": {
      "coding": [{
        "system": "http://terminology.hl7.org/CodeSystem/v2-0360",
        "code": "MD"
      }]
    }
  }]
}

Search Parameters

Resource	Supported Parameters
Patient	`_ididentifiernamebirthdategender`
Observation	`_idpatientcodedatecategorystatus`
Condition	`_idpatientcodeclinical-statusonset-date`
MedicationStatement	`_idpatientmedicationstatus`
Practitioner	`_ididentifiername`

Example search: GET /fhir/Observation?patient=patient-123&code=85354-9&date=ge2025-01-01

USCDI V3 Data Elements

VitalEdge supports all United States Core Data for Interoperability (USCDI) V3 data elements required for 21st Century Cures Act compliance.

Patient Demographics

Name
Date of Birth
Gender
Race
Ethnicity
Address

Clinical Data

Problems/Conditions
Medications
Allergies
Vital Signs
Lab Results

Social Determinants

Housing Status
Food Security
Transportation
Education

Care Information

Care Team
Goals
Health Concerns
Assessments

Ready for EHR Integration

Connect VitalEdge with major EHR systems using our FHIR R4 API. Pre-built adapters for Epic, Cerner, and other FHIR-enabled systems.

Bidirectional data sync with Epic MyChart
Cerner Millennium integration support
SMART on FHIR app launcher compatible
Bulk Data Export for analytics

CapabilityStatement

GET /fhir/metadata

{
  "resourceType": "CapabilityStatement",
  "status": "active",
  "fhirVersion": "4.0.1",
  "format": ["json"],
  "rest": [{
    "mode": "server",
    "resource": [
      {
        "type": "Patient",
        "interaction": [
          { "code": "read" },
          { "code": "search-type" },
          { "code": "create" },
          { "code": "update" }
        ],
        "searchParam": [...]
      },
      ...
    ]
  }]
}

Start Your FHIR Integration

Get sandbox access to test FHIR endpoints with sample data. Our integration team is ready to help with your EHR connectivity needs.

Request Sandbox Access View REST API Docs