The CarePaths Developer Program API is organized around REST. Our API has predictable resource-oriented URLS and returns JSON-encoded responses (some XML too), and uses standard HTTP response codes, authentication, and verbs.
As a user of the CarePaths developer API you will need to use a http client that can support sending requests over https. There is no requirement for the type of system the client software runs on. There are plenty of http client programs that can run on Windows, MacOS, Linux and more. If you are planning on developing your own application you will find there are suitable https libraries for your programming language of choice.
Your client must establish connections using TLS v1.2 or greater
The CarePaths Developer Program API uses API keys to authenticate requests. You can view and manage your applications's API keys in the developer dashboard.
The CarePaths Developer Program API requires that all requests come with patient authorized access tokens linked to your application's authentication keys.
Sandbox apps will not require approval and will not interface with live data. Your app profile will need to get reviewed and your app approved for use on the live system.
Your API keys and access tokens carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Patient authorized access tokens are required to interact with the CarePaths Developer Program API. This means that your application must require patients to authorize your app to interact with their CarePaths EHR data, using their PATIENT PORTAL credentials. The developer dashboard provides a form authorizing patients for your application. Once they authorize your application, a patient will be redirected back to your app with their access token for you to store. This access token will be used in future CarePaths Developer Program API requests directed towards the authorized patient.
To access sandbox use
https://developer-sandbox.carepaths.com
To access live data
https://developer.carepaths.com
Usage of the developer portal and CarePaths Developer Program API will fall under the linked terms.
| Resource | Description |
|---|---|
| GET /api/AllergyIntolerance | Allergy Intolerances |
| POST /api/AlleryIntolerance/_search | Allergy Intolerances by POST |
| GET /api/AllergyIntolerance/:id | Allergy Intolerance by ID |
| Resource | Description |
|---|---|
| GET /api/AssessmentItems | Assessment Items |
| Resource | Description |
|---|---|
| GET /api/Assessments | Assessments |
| Resource | Description |
|---|---|
| GET /api/CareTeam | Care Team Members |
| POST /api/CareTeam/_search | Care Team by POST |
| GET /api/CareTeam/:id | Care team by ID |
| Resource | Description |
|---|---|
| GET /api/DocumentReference | Document Reference |
| GET /api/cda_documents | CDDA Documents |
| Resource | Description |
|---|---|
| GET /api/Coverage | Coverages |
| POST /api/Coverage/_search | Coverages by POST |
| GET /api/Coverage/:id | Coverage by ID |
| Resource | Description |
|---|---|
| GET /api/Device | Implantable Devices |
| POST /api/Device/_search | Devices by POST |
| GET /api/Device/:id | Implantable Device by ID |
| Resource | Description |
|---|---|
| GET /api/DiagnosticReport | Diagnostic Reports |
| POST /api/DiagnosticReport/_search | Diagnostic Reports by POST |
| GET /api/DiagnosticReport/:id | Diagnostic Report by ID |
| Resource | Description |
|---|---|
| GET /api/DocumentReference | Document References |
| POST /api/DocumentReference/_search | Document Reference by POST |
| GET /api/DocumentReference/:id | Document Reference by ID |
| Resource | Description |
|---|---|
| GET /api/Encounter | Encounters |
| POST /api/Encounter/_search | Encounter by POST |
| GET /api/Encounter/:id | Encounter by ID |
| Resource | Description |
|---|---|
| GET /api/Goal | Goals |
| POST /api/Goal/_search | Goals by POST |
| GET /api/Goal/:id | Goals |
| Resource | Description |
|---|---|
| GET /api/Immunization | Immunizations |
| POST /api/Immunization/_search | Immunization by POST |
| GET /api/Immunization/:id | Immunization by ID |
| Resource | Description |
|---|---|
| GET /api/Location | Locations |
| POST /api/Location/_search | Location by POST |
| GET /api/Location/:id | Location by ID |
| Resource | Description |
|---|---|
| GET /api/MedicationDispense | Medication Dispenses |
| POST /api/MedicationDispense | Medication Dispense by POST |
| GET /api/MecicationDispense/:id | Medication Dispense by ID |
| Resource | Description |
|---|---|
| GET /api/MedicationRequest | Medication Requests |
| POST /api/MedicationRequest/_search | Medication Requests by POST |
| GET /api/MedicationRequest/:id | Medication Request by ID |
| Resource | Description |
|---|---|
| GET /api/Medication | Medications |
| Resource | Description |
|---|---|
| GET /api/patients/clinical/monitoring_assessments | Assessments |
| POST /api/patients/clinical/monitoring_assessments | creates a MonitoringAssessment |
| GET /api/patients/clinical/monitoring_assessments/:id | returns an Assessment reports |
| Resource | Description |
|---|---|
| GET /api/Observation | Observations |
| POST /api/Observation/_search | Observations by POST |
| GET /api/Observation | Observation by ID |
| Resource | Description |
|---|---|
| GET /api/Orders | Orders |
| Resource | Description |
|---|---|
| GET /api/Organization | Organizations |
| GET /api/Organization/:id | Organization by ID |
| Resource | Description |
|---|---|
| GET /api/Patient | Patient Information |
| POST /api/Patient/_search | Patient Search by POST |
| GET /api/Patient/:id | Patient Information by ID |
| Resource | Description |
|---|---|
| GET /api/CarePlan | Care Plans |
| POST /api/CarePlan/_search | Care Plans by POST |
| GET /api/CarePlan/:id | Care Plan by ID |
| Resource | Description |
|---|---|
| GET /api/Practitioner | Practitioners |
| GET /api/Practitioner/:id | Practitioner by ID |
| Resource | Description |
|---|---|
| GET /api/Condition | Conditions |
| POST /api/Condition/_search | Conditions by POST |
| GET /api/Condition/:id | Condition by ID |
| Resource | Description |
|---|---|
| GET /api/Procedure | Procedures |
| POST /api/Procedure/_search | Procedures by POST |
| GET /api/Procedure/:id | Procedure by ID |
| Resource | Description |
|---|---|
| GET /api/Provenance/Resource | Provenance for Resource + Resource ID ('/Provenance/Patient1') |
| Resource | Description |
|---|---|
| GET /api/QuestionnaireResponse | Questionnaire Responses |
| GET /api/QuestionnaireResponse/:id | Questionnaire Response by ID |
| Resource | Description |
|---|---|
| GET /api/RelatedPerson | Related Persons |
| GET /api/RelatedPerson/:id | Related Person by ID |
| Resource | Description |
|---|---|
| GET /api/RiskAssessment | Risk Assessments |
| Resource | Description |
|---|---|
| GET /api/SDOHAssessments | SDOH Assessments |
| Resource | Description |
|---|---|
| GET /api/SDOHGoal | SDOH Goals |
| GET /api/SDOHGoal/:id | SDOH Goal by ID |
| Resource | Description |
|---|---|
| GET /api/SDOHCondition | SDOH Conditions |
| GET /api/SDOHCondition/:id | SDOH Condition by ID |
| Resource | Description |
|---|---|
| GET /api/SDOHProcedure | SDOH Procedures |
| GET /api/SDOHProcedure/:id | SDOH Procedure by ID |
| Resource | Description |
|---|---|
| GET /api/ServiceRequest | Service Requests |
| POST /api/ServiceRequest/_search | Service Requests by POST |
| GET /api/ServiceRequest/:id | Service Request by ID |
| Resource | Description |
|---|---|
| GET /api/Specimen | Specimens |
| GET /api/Specimen/:id | Specimen by ID |
