Skip to content

Standardized API for patient and population services

§170.315(g)(10) Standardized API for Patient and Population Services conforms to the following documents and specifications:

Base urls for API calls published here.

Full Documentation published here.

API syntax, function names, required and optional parameters and their data types, return variables and their types/structures, exceptions and exception handling methods and their returns:

Here's the updated table with all the resources and their API endpoints:

Category API Endpoint
Allergies & Intolerances GET fhir/AllergyIntolerance/[id]
GET fhir/AllergyIntolerance
POST fhir/AllergyIntolerance/_search
Assessment & Plan of Treatment GET fhir/CarePlan/[id]
GET fhir/CarePlan
POST fhir/CarePlan/_search
GET fhir/Observation/[id]
GET fhir/Observation
POST fhir/Observation/_search
GET fhir/Observation/[id]
GET fhir/Observation
POST fhir/Observation/_search
Binary GET fhir/Binary/[id]
Care Team Members GET fhir/CareTeam/[id]
GET fhir/CareTeam
POST fhir/CareTeam/_search
GET fhir/Practitioner/[id]
GET fhir/Practitioner
POST fhir/Practitioner/_search
GET fhir/PractitionerRole/[id]
GET fhir/PractitionerRole
POST fhir/PractitionerRole/_search
GET fhir/Location/[id]
GET fhir/Location
POST fhir/Location/_search
GET fhir/Organization/[id]
GET fhir/Organization
POST fhir/Organization/_search
Clinical Notes GET fhir/DocumentReference/[id]
GET fhir/DocumentReference
POST fhir/DocumentReference/_search
GET fhir/DiagnosticReport/[id]
GET fhir/DiagnosticReport
POST fhir/DiagnosticReport/_search
Clinical Tests GET fhir/Observation/[id]
GET fhir/Observation
POST fhir/Observation/_search
GET fhir/DiagnosticReport/[id]
GET fhir/DiagnosticReport
POST fhir/DiagnosticReport/_search
Diagnostic Imaging & Clinical Tests GET fhir/Observation/[id]
GET fhir/Observation
POST fhir/Observation/_search
GET fhir/DiagnosticReport/[id]
GET fhir/DiagnosticReport
POST fhir/DiagnosticReport/_search
Encounter Information GET fhir/Encounter/[id]
GET fhir/Encounter
POST fhir/Encounter/_search
Goals GET fhir/Goal/[id]
GET fhir/Goal
POST fhir/Goal/_search
Group GET fhir/Group/[id]
GET fhir/Group
POST fhir/Group/_search
GET fhir/Group/[id]/$export
Health Insurance Information GET fhir/Coverage/[id]
GET fhir/Coverage
POST fhir/Coverage/_search
Health Status GET fhir/Observation/[id]
GET fhir/Observation
POST fhir/Observation/_search
GET fhir/Condition/[id]
GET fhir/Condition
POST fhir/Condition/_search
GET fhir/Observation/[id]
GET fhir/Observation
POST fhir/Observation/_search
GET fhir/QuestionnaireResponse/[id]
GET fhir/QuestionnaireResponse
POST fhir/QuestionnaireResponse/_search
Immunizations GET fhir/Immunization/[id]
GET fhir/Immunization
POST fhir/Immunization/_search
Health Concerns GET fhir/Condition/[id]
GET fhir/Condition
POST fhir/Condition/_search
Laboratory GET fhir/Observation/[id]
GET fhir/Observation
POST fhir/Observation/_search
GET fhir/DiagnosticReport/[id]
GET fhir/DiagnosticReport
POST fhir/DiagnosticReport/_search
GET fhir/Specimen/[id]
GET fhir/Specimen
POST fhir/Specimen/_search
Medications GET fhir/Medication/[id]
GET fhir/Medication
POST fhir/Medication/_search
GET fhir/MedicationRequest/[id]
GET fhir/MedicationRequest
POST fhir/MedicationRequest/_search
GET fhir/MedicationDispense/[id]
GET fhir/MedicationDispense
POST fhir/MedicationDispense/_search
Patient Demographics GET fhir/Patient/[id]
GET fhir/Patient
POST fhir/Patient/_search
GET fhir/Observation/[id]
GET fhir/Observation
POST fhir/Observation/_search
GET fhir/Observation/[id]
GET fhir/Observation
POST fhir/Observation/_search
Problems GET fhir/Condition/[id]
GET fhir/Condition
POST fhir/Condition/_search
Procedures GET fhir/Procedure/[id]
GET fhir/Procedure
POST fhir/Procedure/_search
GET fhir/ServiceRequest/[id]
GET fhir/ServiceRequest
POST fhir/ServiceRequest/_search
Provenance GET fhir/Provenance/[id]
GET fhir/Provenance
POST fhir/Provenance/_search
Unique Device Identifiers GET fhir/Device/[id]
GET fhir/Device
POST fhir/Device/_search
Vital Signs GET fhir/Observation/[id]
GET fhir/Observation
POST fhir/Observation/_search