Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kareo Encounters API

Clinical encounter and document management

Kareo Encounters API is one of 8 APIs that Kareo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Encounters. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 6 paths, and defines 14 schemas. It is described by OpenAPI 3.0.3, at version 2.1.

Requests are made against a single base URL, https://webservice.kareo.com/services/soap/2.1.

6 operations 6 paths 14 schemas 6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.1
Base URL
https://webservice.kareo.com/services/soap/2.1/KareoServices.svc
Terms of Service
Resource Areas
1

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 6 POST. Each is listed below with its method, path, parameters, and response codes.

Encounters 6

Clinical encounter and document management

POST
/KareoServices.svc/CreateEncounter
Create a clinical encounter
createEncounter body → 200401
POST
/KareoServices.svc/UpdateEncounterStatus
Update encounter status
updateEncounterStatus body → 200401404
POST
/KareoServices.svc/GetEncounterDetails
Retrieve encounter details
getEncounterDetails body → 200401404
POST
/KareoServices.svc/UpdatePrimaryPatientCase
Update the primary case for a patient
updatePrimaryPatientCase body → 200401
POST
/KareoServices.svc/CreateDocument
Create a clinical document
createDocument body → 200401
POST
/KareoServices.svc/DeleteDocument
Delete a clinical document
deleteDocument body → 200401404

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Encounter (8 properties), CreateDocumentRequest (6 properties), UpdatePrimaryPatientCaseRequest (4 properties), DeleteDocumentResponse (3 properties). Each schema is shown below with its type and property counts.

DeleteDocumentRequest
object
2 properties
CreateDocumentRequest
object
6 properties
GetEncounterDetailsRequest
object
2 properties
CreateEncounterRequest
object
2 properties
UpdatePrimaryPatientCaseResponse
object
3 properties
GetEncounterDetailsResponse
object
3 properties
UpdateEncounterStatusResponse
object
3 properties
UpdateEncounterStatusRequest
object
3 properties
CreateDocumentResponse
object
3 properties
CreateEncounterResponse
object
3 properties
UpdatePrimaryPatientCaseRequest
object
4 properties
Encounter
object
8 properties
DeleteDocumentResponse
object
3 properties
RequestHeader
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kareo-encounters-api-openapi.yml Raw ↑

Other APIs Kareo publishes across the network.

Kareo Integration SOAP API
Kareo Clinical Open API
Kareo Administrative API
Kareo Appointments API
Kareo Billing API
Kareo Patients API
Kareo Providers API