HeyDonto FHIR R4 API Documentation (1.0)

API documentation for HeyDonto API users

Overview
Languages
Servers
Mock server
https://docs.heydonto.com/_mock/apis/fhir/openapi/
Sandbox
https://api-staging.heydonto.com/
Production
https://api.heydonto.com/

Account

Operations

ActivityDefinition

Operations

AdverseEvent

Operations

AllergyIntolerance

Operations

Appointment

Operations

AppointmentResponse

Operations

AuditEvent

Operations

Basic

Operations

Binary

Operations

BiologicallyDerivedProduct

Operations

BodyStructure

Operations

Bundle

Operations

CapabilityStatement

Operations

CarePlan

Operations

CareTeam

Operations

CatalogEntry

Operations

ChargeItem

Operations

ChargeItemDefinition

Operations

Claim

Operations

ClaimResponse

Operations

ClinicalImpression

Operations

CodeSystem

Operations

Communication

Operations

CommunicationRequest

Operations

CompartmentDefinition

Operations

Composition

Operations

ConceptMap

Operations

Condition

Operations

Contract

Operations

Coverage

Operations

CoverageEligibilityRequest

Operations

CoverageEligibilityResponse

Operations

DetectedIssue

Operations

Device

Operations

DeviceDefinition

Operations

DeviceMetric

Operations

DeviceRequest

Operations

DeviceUseStatement

Operations

DiagnosticReport

Operations

DocumentManifest

Operations

DocumentReference

Operations

EffectEvidenceSynthesis

Operations

Encounter

Operations

Endpoint

Operations

EnrollmentRequest

Operations

EnrollmentResponse

Operations

EpisodeOfCare

Operations

EventDefinition

Operations

Evidence

Operations

EvidenceVariable

Operations

ExampleScenario

Operations

ExplanationOfBenefit

Operations

FamilyMemberHistory

Operations

Get FHIR R4 FamilyMemberHistorys

Request

Path
siteIdstringrequired

Site identifier

Query
_countnumber

Number of items to return (default=20).

Example: _count=10
_page_tokenstring

Token for fetching the next page of results.

Example: _page_token=CgYK...
_sortstring

Sort the results by a given field, e.g. _sort=family or _sort=-date.

Example: _sort=family
_elementsstring

Restrict returned fields, e.g. _elements=identifier,name.

Example: _elements=identifier,name
dateArray of strings

Filter by resource date, e.g. date=ge2024-01-01. date=ge2025-01-20&date=le2025-01-29

telecomstring

Filter by resource telecom, e.g. date=[SYSTEM]|[VALUE].

Example: telecom=telecom=phone|555-555-5555
_lastUpdatedstring

Filter by last update time, e.g. _lastUpdated=ge2024-01-01.

Examples:
_lastUpdated=ge2024-01-01
_lastUpdated=lt2024-01-01
_idstring

Search for a specific resource by ID, e.g. _id=abc123.

Example: _id=abc123
identifierstring

Search for resources by identifier token, e.g. identifier=http://hospital.org|12345.

Example: identifier=http://hospital.org|12345
_includestring

Include related resources, e.g. _include=Appointment:patient.

Example: _include=Appointment:patient
_revincludestring

Reverse include related resources, e.g. _revinclude=Observation:subject.

Example: _revinclude=Observation:subject
_hasstring

Reverse chaining, e.g. _has:Observation:subject:code=http://loinc.org|1234-5.

Example: _has=Observation:subject:code=http://loinc.org|1234-5
_tagstring

Search by tag on the resource meta, e.g. _tag=http://example.org/tags|sample-tag.

Example: _tag=http://example.org/tags|sample-tag
_securitystring

Search by security label on resource meta, e.g. _security=RBAC|CONFIDENTIAL.

Example: _security=RBAC|CONFIDENTIAL
_profilestring

Search by profile in resource meta, e.g. _profile=http://example.org/fhir/StructureDefinition/custom-profile.

Example: _profile=http://example.org/fhir/StructureDefinition/custom-profile
birthdatestring

Search Patients by birthdate, e.g. birthdate=ge2000-01-01 or birthdate=lt2010-01-01.

Example: birthdate=ge2000-01-01
name:exactstring

Exact match on Patient name, e.g. name:exact=Alice.

Example: name:exact=Alice
name:containsstring

Partial match on Patient name, e.g. name:contains=lic.

Example: name:contains=lic