DSP CarePaths Developer Program API Documentation | Behavioral Health EHR Software / Practice Managment System / Therapy App

The Digital Front Door For Your Practice

Start Free Trial

CarePaths Developer Program API Documentation

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.

Procedures

Medications

Lab Orders

Lab Results

Health Concerns

Vital Signs

Goals

Immunizations

Encounters

Implantable Devices

Clinical Documents

Error Codes

Latest Version

The latest version of the developer API supports CarePaths EHR version 19.11

Software Client Requirements

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.

Security Requirements

Your client must establish connections using TLS v1.2

Getting Credentials

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 Selection and Access tokens

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.

Parameters and Expected Responses

Every request will require the ACCESS_TOKEN parameter

Optional parameters will include start_date and end_date in the form YYYY-MM-DD

Events from a specific day can be extracted by sending both the start_date and end_date with the same value.

API filtering is based on ACTIVE events. Meaning even in a date range or single date selection, can return events from earlier dates if no end time is sent.

Example: The below response bodies from the Procedures end point show a patient who had a cardiac pacemaker procedure in 2011 and Nebulizer Therapy in 2015. You can observe the request with dates does not return the procedure for the pacemaker implant.

WITHOUT DATES: GET /api/procedures?access_token=ACCESS_TOKEN

Response Body

{
	"author": {
		"owner_first_name": "ONC",
		"current_time": "202101141411-0500",
		"owner_last_name": "B2",
		"name": "Neighborhood Physicians Practice",
		"address": {
			"country": "US",
			"state": "OR",
			"city": "Beaverton",
			"zip": "97006",
			"line1": "2472, Rocky place",
			"lines2": ""
		},
		"telephone": "555-555-1002"
	},
	"custodian": {
		"owner_first_name": "ONC",
		"current_time": "202101141411-0500",
		"owner_last_name": "B2",
		"name": "Neighborhood Physicians Practice",
		"address": {
			"country": "US",
			"state": "OR",
			"city": "Beaverton",
			"zip": "97006",
			"line1": "2472, Rocky place",
			"lines2": ""
		},
		"telephone": "555-555-1002"
	},
	"procedures": {
		"list": [{
			"author": {},
			"codes_code": "56251003",
			"episode_date": "20150622",
			"codes_description": "Nebulizer therapy (procedure)",
			"procedure_type": "procedure",
			"performer": {},
			"method_code": null,
			"body_site_code": "82094008",
			"base_description": "Nebulizer therapy (procedure)",
			"method_description": null,
			"body_site_description": "Lower respiratory tract structure (body structure)"
		}, {
			"author": {},
			"codes_code": "175135009",
			"episode_date": "20111005",
			"codes_description": "Introduction of cardiac pacemaker system via vein (procedure)",
			"procedure_type": "procedure",
			"performer": {},
			"method_code": null,
			"body_site_code": "9454009",
			"base_description": "Introduction of cardiac pacemaker system via vein (procedure)",
			"method_description": null,
			"body_site_description": "Structure of subclavian vein (body structure)"
		}]
	}
}

WITH DATES: GET /api/procedures?access_token=ACCESS_TOKEN&start_date=2015-06-22&end_date=2018-06-22

Response Body

{
	"author": {
		"owner_first_name": "ONC",
		"current_time": "202101141510-0500",
		"owner_last_name": "B2",
		"name": "Neighborhood Physicians Practice",
		"address": {
			"country": "US",
			"state": "OR",
			"city": "Beaverton",
			"zip": "97006",
			"line1": "2472, Rocky place",
			"lines2": ""
		},
		"telephone": "555-555-1002"
	},
	"custodian": {
		"owner_first_name": "ONC",
		"current_time": "202101141510-0500",
		"owner_last_name": "B2",
		"name": "Neighborhood Physicians Practice",
		"address": {
			"country": "US",
			"state": "OR",
			"city": "Beaverton",
			"zip": "97006",
			"line1": "2472, Rocky place",
			"lines2": ""
		},
		"telephone": "555-555-1002"
	},
	"procedures": {
		"list": [{
			"author": {},
			"codes_code": "56251003",
			"episode_date": "20150622",
			"codes_description": "Nebulizer therapy (procedure)",
			"procedure_type": "procedure",
			"performer": {},
			"method_code": null,
			"body_site_code": "82094008",
			"base_description": "Nebulizer therapy (procedure)",
			"method_description": null,
			"body_site_description": "Lower respiratory tract structure (body structure)"
		}]
	}
}

Example: Active items with no end date can get returned if start date is outside of the date range parameters

ACTIVE ALLERGIES OUTSIDE DATE RANGE GET /api/allergies.json?access_token=ACCESST_TOKEN&start_date=2020-01-01&end_date=2020-03-30


{
	"author": {
		"owner_first_name": "ONC",
		"current_time": "202101141603-0500",
		"owner_last_name": "B2",
		"name": "Neighborhood Physicians Practice",
		"address": {
			"country": "US",
			"state": "OR",
			"city": "Beaverton",
			"zip": "97006",
			"line1": "2472, Rocky place",
			"lines2": ""
		},
		"telephone": "555-555-1002"
	},
	"custodian": {
		"owner_first_name": "ONC",
		"current_time": "202101141603-0500",
		"owner_last_name": "B2",
		"name": "Neighborhood Physicians Practice",
		"address": {
			"country": "US",
			"state": "OR",
			"city": "Beaverton",
			"zip": "97006",
			"line1": "2472, Rocky place",
			"lines2": ""
		},
		"telephone": "555-555-1002"
	},
	"medication_allergies": {
		"list": [{
			"onset_date": "1980-05-10",
			"status": "ACTIVE",
			"author": {},
			"code": "733",
			"code_system_oid": "2.16.840.1.113883.6.88",
			"code_type": "RxNorm",
			"discontinued_at": null,
			"reactions": [],
			"name": "Ampicillin Sodium"
		}, {
			"onset_date": "1980-05-10",
			"status": "ACTIVE",
			"author": {},
			"code": "7980",
			"code_system_oid": "2.16.840.1.113883.6.88",
			"code_type": "RxNorm",
			"discontinued_at": null,
			"reactions": [],
			"name": "Penicillin G benzathine"
		}]
	}
}

Terms of Use

Usage of the developer portal and CarePaths Developer Program API will fall under the linked terms.

API End Points - Example Request/Response

Patient

GET /api/me?access_token=ACCESS_TOKEN

  • Request (application/json)

    • Headers

      Accept: application/json
  • Response 200 (application/json; charset=utf-8)

    • Headers

      X-Runtime: 0.167126
      X-XSS-Protection: 1; mode=block
      X-Cloud-Trace-Context: bc36aee36c4f490acbf75fa1d9062499;o=1
      X-Download-Options: noopen
      Transfer-Encoding: chunked
      X-Permitted-Cross-Domain-Policies: none
      Referrer-Policy: strict-origin-when-cross-origin
      Cache-Control: max-age=0, private, must-revalidate
      X-Request-Id: bf9aca90-16c5-42bb-af32-769d3690a840
      X-Content-Type-Options: nosniff
      Etag: W/"c5fc50316d5ef3994b028cbba8579e1e"
      X-Frame-Options: SAMEORIGIN
    • Body

      
      {
      	"author": {
      		"owner_first_name": "onc",
      		"owner_last_name": "user",
      		"current_time": "201912201216-0500",
      		"name": "ONC 2015-1216",
      		"address": {
      			"zip": "32963-1794",
      			"line1": "505 Beachland Blvd",
      			"country": "US",
      			"city": "Vero Beach",
      			"lines2": "",
      			"state": "FL"
      		},
      		"telephone": "8003571200"
      	},
      	"sex": {
      		"author": {
      			"owner_first_name": "onc",
      			"owner_last_name": "user",
      			"current_time": "201912201216-0500",
      			"name": "ONC 2015-1216",
      			"address": {
      				"zip": "32963-1794",
      				"line1": "505 Beachland Blvd",
      				"country": "US",
      				"city": "Vero Beach",
      				"lines2": "",
      				"state": "FL"
      			},
      			"telephone": "8003571200"
      		},
      		"gender_identity": "",
      		"gender": "M",
      		"gender_describe": "",
      		"gender_display_name": "Male"
      	},
      	"patient_name": {
      		"last_name": "Bates",
      		"suffix": "JR",
      		"middle_name": "V",
      		"first_name": "Jeremy",
      		"preferred_name": ""
      	},
      	"date_of_birth": "1980-08-01T00:00:00-04:00",
      	"custodian": {
      		"owner_first_name": "onc",
      		"owner_last_name": "user",
      		"current_time": "201912201216-0500",
      		"name": "ONC 2015-1216",
      		"address": {
      			"zip": "32963-1794",
      			"line1": "505 Beachland Blvd",
      			"country": "US",
      			"city": "Vero Beach",
      			"lines2": "",
      			"state": "FL"
      		},
      		"telephone": "8003571200"
      	},
      	"preferred_language": {
      		"language_name": "English",
      		"hl7_code": "en-US",
      		"code": "en"
      	},
      	"ethnicity": null,
      	"smoking_status": {
      		"display_name": "Tobacco smoking consumption unknown",
      		"author": {
      			"owner_first_name": "onc",
      			"owner_last_name": "user",
      			"current_time": "201912201216-0500",
      			"name": "ONC 2015-1216",
      			"address": {
      				"zip": "32963-1794",
      				"line1": "505 Beachland Blvd",
      				"country": "US",
      				"city": "Vero Beach",
      				"lines2": "",
      				"state": "FL"
      			},
      			"telephone": "8003571200"
      		},
      		"snomed_code": "266927001",
      		"current_time": "2019-12-20T12:16:22-05:00",
      		"title_display": "Tobacco smoking consumption unknown",
      		"smoking_details": "",
      		"episode_date": "2015-07-22T00:00:00-04:00"
      	},
      	"race": {
      		"granular": {
      			"display_name": null,
      			"code": null
      		},
      		"primary": {
      			"display_name": null,
      			"code": null
      		}
      	}
      }
      

Back to Menu

Care Team

The below below link returns patient Care Team

GET /api/clinical/care_team?access_token=ACCESS_TOKEN

  • Request (application/json)

    • Headers

      Accept: application/json
  • Response 200 (application/json; charset=utf-8)

    • Headers

      X-Runtime: 0.029607
      X-XSS-Protection: 1; mode=block
      X-Cloud-Trace-Context: d212c414f1ff433e81c9920b12936c60;o=1
      X-Download-Options: noopen
      Transfer-Encoding: chunked
      X-Permitted-Cross-Domain-Policies: none
      Referrer-Policy: strict-origin-when-cross-origin
      Cache-Control: max-age=0, private, must-revalidate
      X-Request-Id: e7c2337f-34f0-4cf6-8f25-a7e4965946e4
      X-Content-Type-Options: nosniff
      Etag: W/"4f53cda18c2baa0c0354bb5f9a3ecbe5"
      X-Frame-Options: SAMEORIGIN
    • Body

      
      {
      	"author": {
      		"current_time": "201912231004-0500",
      		"telephone": "8003571200",
      		"owner_first_name": "onc",
      		"owner_last_name": "user",
      		"address": {
      			"country": "US",
      			"zip": "32963-1794",
      			"state": "FL",
      			"line1": "505 Beachland Blvd",
      			"city": "Vero Beach",
      			"lines2": ""
      		},
      		"name": "ONC 2015-1216"
      	},
      	"care_team_members": {
      		"author": {
      			"current_time": "201912231004-0500",
      			"telephone": "8003571200",
      			"owner_first_name": "onc",
      			"owner_last_name": "user",
      			"address": {
      				"country": "US",
      				"zip": "32963-1794",
      				"state": "FL",
      				"line1": "505 Beachland Blvd",
      				"city": "Vero Beach",
      				"lines2": ""
      			},
      			"name": "ONC 2015-1216"
      		},
      		"list": [{
      			"discharge_date": null,
      			"org_name": null,
      			"suffix": null,
      			"performed_at": null,
      			"npi": null,
      			"code_system_name": null,
      			"last_name": "Davis",
      			"code_type": null,
      			"middle_name": null,
      			"address": {
      				"address_line_1": null,
      				"country": null,
      				"postal_code": null,
      				"state": null,
      				"city": null
      			},
      			"code_display_name": null,
      			"code_point": null,
      			"prefix": "Dr.",
      			"phone_number": null,
      			"admit_date": null,
      			"first_name": "Albert"
      		}, {
      			"discharge_date": "2015-06-22T00:00:00-04:00",
      			"org_name": null,
      			"suffix": null,
      			"performed_at": "2015-06-22T00:00:00-04:00",
      			"npi": null,
      			"code_system_name": null,
      			"last_name": "Davis",
      			"code_type": null,
      			"middle_name": null,
      			"address": {
      				"address_line_1": null,
      				"country": null,
      				"postal_code": null,
      				"state": null,
      				"city": null
      			},
      			"code_display_name": null,
      			"code_point": null,
      			"prefix": null,
      			"phone_number": null,
      			"admit_date": "2015-06-22T00:00:00-04:00",
      			"first_name": "Tracy"
      		}]
      	},
      	"custodian": {
      		"current_time": "201912231004-0500",
      		"telephone": "8003571200",
      		"owner_first_name": "onc",
      		"owner_last_name": "user",
      		"address": {
      			"country": "US",
      			"zip": "32963-1794",
      			"state": "FL",
      			"line1": "505 Beachland Blvd",
      			"city": "Vero Beach",
      			"lines2": ""
      		},
      		"name": "ONC 2015-1216"
      	}
      }
      

Back to Menu

Allergies

The below below link returns patient allergies

GET /api/clinical/allergies?access_token=ACCESS_TOKEN

  • Request (application/json)

    • Headers

      Accept: application/json
  • Response 200 (application/json; charset=utf-8)

    • Headers

      X-Runtime: 0.029607
      X-XSS-Protection: 1; mode=block
      X-Cloud-Trace-Context: d212c414f1ff433e81c9920b12936c60;o=1
      X-Download-Options: noopen
      Transfer-Encoding: chunked
      X-Permitted-Cross-Domain-Policies: none
      Referrer-Policy: strict-origin-when-cross-origin
      Cache-Control: max-age=0, private, must-revalidate
      X-Request-Id: e7c2337f-34f0-4cf6-8f25-a7e4965946e4
      X-Content-Type-Options: nosniff
      Etag: W/"4f53cda18c2baa0c0354bb5f9a3ecbe5"
      X-Frame-Options: SAMEORIGIN
    • Body

      {
      	"author": {
      		"owner_first_name": null,
      		"owner_last_name": null,
      		"current_time": "201912050845-0500",
      		"name": "ONC 2015",
      		"address": {
      			"zip": null,
      			"line1": null,
      			"country": "US",
      			"city": null,
      			"lines2": null,
      			"state": null
      		},
      		"telephone": "5555555555"
      	},
      	"custodian": {
      		"owner_first_name": null,
      		"owner_last_name": null,
      		"current_time": "201912050845-0500",
      		"name": "ONC 2015",
      		"address": {
      			"zip": null,
      			"line1": null,
      			"country": "US",
      			"city": null,
      			"lines2": null,
      			"state": null
      		},
      		"telephone": "5555555555"
      	},
      	"medication_allergies": {
      		"author": {
      			"owner_first_name": null,
      			"owner_last_name": null,
      			"current_time": "201912050845-0500",
      			"name": "ONC 2015",
      			"address": {
      				"zip": null,
      				"line1": null,
      				"country": "US",
      				"city": null,
      				"lines2": null,
      				"state": null
      			},
      			"telephone": "5555555555"
      		},
      		"list": [{
      			"status": "ACTIVE",
      			"onset_date": "2019-11-20T09:24:35-05:00",
      			"code_system_oid": "2.16.840.1.113883.6.88",
      			"code_type": "RxNorm",
      			"discontinued_at": null,
      			"name": "ampicillin",
      			"reactions": [],
      			"code": "733"
      		}, {
      			"status": "ACTIVE",
      			"onset_date": "2019-11-20T09:24:35-05:00",
      			"code_system_oid": "2.16.840.1.113883.6.88",
      			"code_type": "RxNorm",
      			"discontinued_at": null,
      			"name": "penicillin G",
      			"reactions": [],
      			"code": "7980"
      		}]
      	}
      }

Back to Menu

Assessment and Plan of Treatment

GET /api/clinical/risk_assessments?access_token=ACCESS_TOKEN

  • Request (application/json)

    • Headers

      Accept: application/json
  • Response 200 (application/json; charset=utf-8)

    • Headers

      X-Runtime: 0.030063
      X-XSS-Protection: 1; mode=block
      X-Cloud-Trace-Context: 54d097e4724e419d8972434a12925105;o=1
      X-Download-Options: noopen
      Transfer-Encoding: chunked
      X-Permitted-Cross-Domain-Policies: none
      Referrer-Policy: strict-origin-when-cross-origin
      Cache-Control: max-age=0, private, must-revalidate
      X-Request-Id: 21fb95da-37ae-4839-b8b8-4524f89a2954
      X-Content-Type-Options: nosniff
      Etag: W/"4f53cda18c2baa0c0354bb5f9a3ecbe5"
      X-Frame-Options: SAMEORIGIN
    • Body

      {
      	"author": {
      		"owner_first_name": "onc",
      		"owner_last_name": "user",
      		"current_time": "201912181433-0500",
      		"name": "ONC 2015-1216",
      		"address": {
      			"zip": "32963-1794",
      			"line1": "505 Beachland Blvd",
      			"country": "US",
      			"city": "Vero Beach",
      			"lines2": "",
      			"state": "FL"
      		},
      		"telephone": "8003571200"
      	},
      	"list": [{
      		"plan": {
      			"substance_supply": [],
      			"procedures": [],
      			"schedule": [],
      			"generic_items": [{
      				"narrative": "Get EKG by 6/23/2015"
      			}, {
      				"narrative": "Get a Chest X-ray done on 6/23/2015 showing the Lower Respiratory Tract\n"
      			}, {
      				"narrative": "Take Clindamycin 300mg three times a day as needed if pain does not subside/"
      			}, {
      				"narrative": "Schedule follow on visit with Neighborhood Physicians Practice on 7/1/2015."
      			}],
      			"medications": [],
      			"substance_admin": []
      		},
      		"assessment": "The patient was found to have fever and Dr Davis is suspecting Anemia\nbased on the patient history. So Dr Davis asked the patient to closely monitor the temperature and blood pressure and get admitted to Community Health Hospitals if the fever does not subside within a day.",
      		"name": "Anemia co-occurrent and due to end stage renal disease (disorder)",
      		"codes": "707324008"
      	}]
      }

Back to Menu

Problems

GET /api/clinical/problems?access_token=ACCESS_TOKEN

  • Request (application/json)

    • Headers

      Accept: application/json
  • Response 200 (application/json; charset=utf-8)

    • Headers

      X-Runtime: 0.010869
      X-XSS-Protection: 1; mode=block
      X-Cloud-Trace-Context: 07ccb0e996ba4c1c89bcc34162927026;o=1
      X-Download-Options: noopen
      Transfer-Encoding: chunked
      X-Permitted-Cross-Domain-Policies: none
      Referrer-Policy: strict-origin-when-cross-origin
      Cache-Control: max-age=0, private, must-revalidate
      X-Request-Id: cc9c3bcc-f546-4b26-910d-21f8b359768b
      X-Content-Type-Options: nosniff
      Etag: W/"1ffc1c51ede05937f5f7d615d2ce947d"
      X-Frame-Options: SAMEORIGIN
    • Body

      {
      	"author": {
      		"owner_first_name": "onc",
      		"owner_last_name": "user",
      		"current_time": "201912201224-0500",
      		"name": "ONC 2015-1216",
      		"address": {
      			"zip": "32963-1794",
      			"line1": "505 Beachland Blvd",
      			"country": "US",
      			"city": "Vero Beach",
      			"lines2": "",
      			"state": "FL"
      		},
      		"telephone": "8003571200"
      	},
      	"custodian": {
      		"owner_first_name": "onc",
      		"owner_last_name": "user",
      		"current_time": "201912201224-0500",
      		"name": "ONC 2015-1216",
      		"address": {
      			"zip": "32963-1794",
      			"line1": "505 Beachland Blvd",
      			"country": "US",
      			"city": "Vero Beach",
      			"lines2": "",
      			"state": "FL"
      		},
      		"telephone": "8003571200"
      	},
      	"problems": {
      		"author": {
      			"owner_first_name": "onc",
      			"owner_last_name": "user",
      			"current_time": "201912201224-0500",
      			"name": "ONC 2015-1216",
      			"address": {
      				"zip": "32963-1794",
      				"line1": "505 Beachland Blvd",
      				"country": "US",
      				"city": "Vero Beach",
      				"lines2": "",
      				"state": "FL"
      			},
      			"telephone": "8003571200"
      		},
      		"list": [{
      			"status": "active",
      			"author": {
      				"owner_first_name": "onc",
      				"owner_last_name": "user",
      				"current_time": "201912201224-0500",
      				"name": "ONC 2015-1216",
      				"address": {
      					"zip": "32963-1794",
      					"line1": "505 Beachland Blvd",
      					"country": "US",
      					"city": "Vero Beach",
      					"lines2": "",
      					"state": "FL"
      				},
      				"telephone": "8003571200"
      			},
      			"start_date": "20130607000000+0000",
      			"end_date": null,
      			"snomed_ct": [],
      			"name": "Problem"
      		}]
      	}
      }

Back to Menu

Procedures

GET /api/clinical/procedures?access_token=ACCESS_TOKEN

  • Request (application/json)

    • Headers

      Accept: application/json
  • Response 200 (application/json; charset=utf-8)

    • Headers

      X-Runtime: 0.011571
      X-XSS-Protection: 1; mode=block
      X-Cloud-Trace-Context: d43ddf8a591e493189b1983ca1bdb649;o=1
      X-Download-Options: noopen
      Transfer-Encoding: chunked
      X-Permitted-Cross-Domain-Policies: none
      Referrer-Policy: strict-origin-when-cross-origin
      Cache-Control: max-age=0, private, must-revalidate
      X-Request-Id: a961b29b-4c19-4411-8c77-8b5337160f93
      X-Content-Type-Options: nosniff
      Etag: W/"dc0eb191ac1a5f72d42874ba4f46c4c9"
      X-Frame-Options: SAMEORIGIN
    • Body

      {
      	"author": {
      		"owner_first_name": "onc",
      		"owner_last_name": "user",
      		"current_time": "201912201236-0500",
      		"name": "ONC 2015-1216",
      		"address": {
      			"zip": "32963-1794",
      			"line1": "505 Beachland Blvd",
      			"country": "US",
      			"city": "Vero Beach",
      			"lines2": "",
      			"state": "FL"
      		},
      		"telephone": "8003571200"
      	},
      	"procedures": {
      		"list": [{
      			"author": {},
      			"codes_description": "Nebulizer therapy (procedure)",
      			"method_code": null,
      			"procedure_type": "procedure",
      			"body_site_code": null,
      			"method_description": null,
      			"base_description": "Nebulizer therapy (procedure)",
      			"body_site_description": null,
      			"performer": {},
      			"episode_date": "20150622",
      			"codes_code": "56251003"
      		}, {
      			"author": {},
      			"codes_description": "Introduction of cardiac pacemaker system via vein (procedure)",
      			"method_code": "175135009",
      			"procedure_type": "procedure",
      			"body_site_code": "9454009",
      			"method_description": "Introduction of cardiac pacemaker system via vein",
      			"base_description": "Introduction of cardiac pacemaker system via vein (procedure)",
      			"body_site_description": "Structure of subclavian vein",
      			"performer": {},
      			"episode_date": "20111005",
      			"codes_code": "175135009"
      		}]
      	},
      	"custodian": {
      		"owner_first_name": "onc",
      		"owner_last_name": "user",
      		"current_time": "201912201236-0500",
      		"name": "ONC 2015-1216",
      		"address": {
      			"zip": "32963-1794",
      			"line1": "505 Beachland Blvd",
      			"country": "US",
      			"city": "Vero Beach",
      			"lines2": "",
      			"state": "FL"
      		},
      		"telephone": "8003571200"
      	}
      }

Back to Menu

Medications

GET /api/medications/medications?access_token=ACCESS_TOKEN

  • Request (application/json)

    • Headers

      Accept: application/json
  • Response 200 (application/json; charset=utf-8)

    • Headers

      X-Runtime: 0.010231
      X-XSS-Protection: 1; mode=block
      X-Cloud-Trace-Context: f6cb0296490c4a0dc5049675da49eab4;o=0
      X-Download-Options: noopen
      Transfer-Encoding: chunked
      X-Permitted-Cross-Domain-Policies: none
      Referrer-Policy: strict-origin-when-cross-origin
      Cache-Control: max-age=0, private, must-revalidate
      X-Request-Id: a3852628-0fcb-46b9-b3ee-bf02d7c966cc
      X-Content-Type-Options: nosniff
      Etag: W/"4f53cda18c2baa0c0354bb5f9a3ecbe5"
      X-Frame-Options: SAMEORIGIN
    • Body

      {
      	"author": {
      		"owner_first_name": "onc",
      		"owner_last_name": "user",
      		"current_time": "201912201236-0500",
      		"name": "ONC 2015-1216",
      		"address": {
      			"zip": "32963-1794",
      			"line1": "505 Beachland Blvd",
      			"country": "US",
      			"city": "Vero Beach",
      			"lines2": "",
      			"state": "FL"
      		},
      		"telephone": "8003571200"
      	},
      	"procedures": {
      		"list": [{
      			"author": {},
      			"codes_description": "Nebulizer therapy (procedure)",
      			"method_code": null,
      			"procedure_type": "procedure",
      			"body_site_code": null,
      			"method_description": null,
      			"base_description": "Nebulizer therapy (procedure)",
      			"body_site_description": null,
      			"performer": {},
      			"episode_date": "20150622",
      			"codes_code": "56251003"
      		}, {
      			"author": {},
      			"codes_description": "Introduction of cardiac pacemaker system via vein (procedure)",
      			"method_code": "175135009",
      			"procedure_type": "procedure",
      			"body_site_code": "9454009",
      			"method_description": "Introduction of cardiac pacemaker system via vein",
      			"base_description": "Introduction of cardiac pacemaker system via vein (procedure)",
      			"body_site_description": "Structure of subclavian vein",
      			"performer": {},
      			"episode_date": "20111005",
      			"codes_code": "175135009"
      		}]
      	},
      	"custodian": {
      		"owner_first_name": "onc",
      		"owner_last_name": "user",
      		"current_time": "201912201236-0500",
      		"name": "ONC 2015-1216",
      		"address": {
      			"zip": "32963-1794",
      			"line1": "505 Beachland Blvd",
      			"country": "US",
      			"city": "Vero Beach",
      			"lines2": "",
      			"state": "FL"
      		},
      		"telephone": "8003571200"
      	}
      }

Back to Menu

Lab Orders

GET /api/clinical/lab_orders?access_token=ACCESS_TOKEN

  • Request (application/json)

    • Headers

      Accept: application/json
  • Response 200 (application/json; charset=utf-8)

    • Headers

      X-Runtime: 0.011193
      X-XSS-Protection: 1; mode=block
      X-Cloud-Trace-Context: f3b64f0499314d68cbf2ed5b81af0505;o=0
      X-Download-Options: noopen
      Transfer-Encoding: chunked
      X-Permitted-Cross-Domain-Policies: none
      Referrer-Policy: strict-origin-when-cross-origin
      Cache-Control: max-age=0, private, must-revalidate
      X-Request-Id: 47a49b1a-af40-4aea-990a-7f1241789a21
      X-Content-Type-Options: nosniff
      Etag: W/"4f53cda18c2baa0c0354bb5f9a3ecbe5"
      X-Frame-Options: SAMEORIGIN
    • Body

      {
      	"author": {
      		"current_time": "201912201501-0500",
      		"telephone": "8003571200",
      		"owner_first_name": "onc",
      		"owner_last_name": "user",
      		"address": {
      			"country": "US",
      			"zip": "32963-1794",
      			"state": "FL",
      			"line1": "505 Beachland Blvd",
      			"city": "Vero Beach",
      			"lines2": ""
      		},
      		"name": "ONC 2015-1216"
      	},
      	"results": {
      		"author": {
      			"current_time": "201912201501-0500",
      			"telephone": "8003571200",
      			"owner_first_name": "onc",
      			"owner_last_name": "user",
      			"address": {
      				"country": "US",
      				"zip": "32963-1794",
      				"state": "FL",
      				"line1": "505 Beachland Blvd",
      				"city": "Vero Beach",
      				"lines2": ""
      			},
      			"name": "ONC 2015-1216"
      		},
      		"list": [{
      			"episode_date": "2015-06-22T00:00:00-04:00",
      			"status": "COM",
      			"results": [{
      				"episode_date": "2015-06-22T00:00:00-04:00",
      				"value_type": "ordinal_value",
      				"reference_range": "YELLOW",
      				"code_type": "LOINC",
      				"notes": "",
      				"result": "YELLOW",
      				"name": " Color of Urine",
      				"unit": "",
      				"code": "5778-6"
      			}, {
      				"episode_date": "2015-06-22T00:00:00-04:00",
      				"value_type": "ordinal_value",
      				"reference_range": "CLEAR",
      				"code_type": "LOINC",
      				"notes": "",
      				"result": "CLEAR",
      				"name": " Appearance of Urine",
      				"unit": "",
      				"code": "5767-9"
      			}, {
      				"episode_date": "2015-06-22T00:00:00-04:00",
      				"value_type": "positive_negative_value",
      				"reference_range": "NEGATIVE",
      				"code_type": "LOINC",
      				"notes": "",
      				"result": "NEGATIVE",
      				"name": " Ketones [Mass/volume] in Urine by Test strip",
      				"unit": "",
      				"code": "5797-6"
      			}, {
      				"episode_date": "2015-06-22T00:00:00-04:00",
      				"value_type": "physical_quantity_value",
      				"reference_range": "NEGATIVE",
      				"code_type": "LOINC",
      				"notes": "",
      				"result": "50",
      				"name": " Glucose [Mass/volume] in Urine by Test strip",
      				"unit": "mg/dL",
      				"code": "5792-7"
      			}, {
      				"episode_date": "2015-06-22T00:00:00-04:00",
      				"value_type": "physical_quantity_value",
      				"reference_range": "NEGATIVE",
      				"code_type": "LOINC",
      				"notes": "",
      				"result": "100",
      				"name": " Protein [Mass/volume] in Urine by Test strip",
      				"unit": "mg/dL",
      				"code": "5804-0"
      			}, {
      				"episode_date": "2015-06-22T00:00:00-04:00",
      				"value_type": "physical_quantity_value",
      				"reference_range": "5.0-8/0",
      				"code_type": "LOINC",
      				"notes": "",
      				"result": "5.0",
      				"name": " pH of Urine by Test strip",
      				"unit": "[pH]",
      				"code": "5803-2"
      			}, {
      				"episode_date": "2015-06-22T00:00:00-04:00",
      				"value_type": "ordinal_value",
      				"reference_range": "1.005-1.030",
      				"code_type": "LOINC",
      				"notes": "",
      				"result": "1.015",
      				"name": " Specific gravity of 24 hour Urine",
      				"unit": "",
      				"code": "5811-5"
      			}],
      			"order_type": "LAB",
      			"code_type": "LOINC",
      			"name": "Urinalysis macro (dipstick) panel - Urine",
      			"code": "24357-6"
      		}]
      	},
      	"custodian": {
      		"current_time": "201912201501-0500",
      		"telephone": "8003571200",
      		"owner_first_name": "onc",
      		"owner_last_name": "user",
      		"address": {
      			"country": "US",
      			"zip": "32963-1794",
      			"state": "FL",
      			"line1": "505 Beachland Blvd",
      			"city": "Vero Beach",
      			"lines2": ""
      		},
      		"name": "ONC 2015-1216"
      	}
      }

Back to Menu

Lab Results

GET /api/clinical/lab_results?access_token=ACCESS_TOKEN

  • Request (application/json)

    • Headers

      Accept: application/json
  • Response 200 (application/json; charset=utf-8)

    • Headers

      X-Runtime: 0.011193
      X-XSS-Protection: 1; mode=block
      X-Cloud-Trace-Context: f3b64f0499314d68cbf2ed5b81af0505;o=0
      X-Download-Options: noopen
      Transfer-Encoding: chunked
      X-Permitted-Cross-Domain-Policies: none
      Referrer-Policy: strict-origin-when-cross-origin
      Cache-Control: max-age=0, private, must-revalidate
      X-Request-Id: 47a49b1a-af40-4aea-990a-7f1241789a21
      X-Content-Type-Options: nosniff
      Etag: W/"4f53cda18c2baa0c0354bb5f9a3ecbe5"
      X-Frame-Options: SAMEORIGIN
    • Body

      {
      	"author": {
      		"current_time": "201912201501-0500",
      		"telephone": "8003571200",
      		"owner_first_name": "onc",
      		"owner_last_name": "user",
      		"address": {
      			"country": "US",
      			"zip": "32963-1794",
      			"state": "FL",
      			"line1": "505 Beachland Blvd",
      			"city": "Vero Beach",
      			"lines2": ""
      		},
      		"name": "ONC 2015-1216"
      	},
      	"results": {
      		"author": {
      			"current_time": "201912201501-0500",
      			"telephone": "8003571200",
      			"owner_first_name": "onc",
      			"owner_last_name": "user",
      			"address": {
      				"country": "US",
      				"zip": "32963-1794",
      				"state": "FL",
      				"line1": "505 Beachland Blvd",
      				"city": "Vero Beach",
      				"lines2": ""
      			},
      			"name": "ONC 2015-1216"
      		},
      		"list": [{
      			"episode_date": "2015-06-22T00:00:00-04:00",
      			"status": "COM",
      			"results": [{
      				"episode_date": "2015-06-22T00:00:00-04:00",
      				"value_type": "ordinal_value",
      				"reference_range": "YELLOW",
      				"code_type": "LOINC",
      				"notes": "",
      				"result": "YELLOW",
      				"name": " Color of Urine",
      				"unit": "",
      				"code": "5778-6"
      			}, {
      				"episode_date": "2015-06-22T00:00:00-04:00",
      				"value_type": "ordinal_value",
      				"reference_range": "CLEAR",
      				"code_type": "LOINC",
      				"notes": "",
      				"result": "CLEAR",
      				"name": " Appearance of Urine",
      				"unit": "",
      				"code": "5767-9"
      			}, {
      				"episode_date": "2015-06-22T00:00:00-04:00",
      				"value_type": "positive_negative_value",
      				"reference_range": "NEGATIVE",
      				"code_type": "LOINC",
      				"notes": "",
      				"result": "NEGATIVE",
      				"name": " Ketones [Mass/volume] in Urine by Test strip",
      				"unit": "",
      				"code": "5797-6"
      			}, {
      				"episode_date": "2015-06-22T00:00:00-04:00",
      				"value_type": "physical_quantity_value",
      				"reference_range": "NEGATIVE",
      				"code_type": "LOINC",
      				"notes": "",
      				"result": "50",
      				"name": " Glucose [Mass/volume] in Urine by Test strip",
      				"unit": "mg/dL",
      				"code": "5792-7"
      			}, {
      				"episode_date": "2015-06-22T00:00:00-04:00",
      				"value_type": "physical_quantity_value",
      				"reference_range": "NEGATIVE",
      				"code_type": "LOINC",
      				"notes": "",
      				"result": "100",
      				"name": " Protein [Mass/volume] in Urine by Test strip",
      				"unit": "mg/dL",
      				"code": "5804-0"
      			}, {
      				"episode_date": "2015-06-22T00:00:00-04:00",
      				"value_type": "physical_quantity_value",
      				"reference_range": "5.0-8/0",
      				"code_type": "LOINC",
      				"notes": "",
      				"result": "5.0",
      				"name": " pH of Urine by Test strip",
      				"unit": "[pH]",
      				"code": "5803-2"
      			}, {
      				"episode_date": "2015-06-22T00:00:00-04:00",
      				"value_type": "ordinal_value",
      				"reference_range": "1.005-1.030",
      				"code_type": "LOINC",
      				"notes": "",
      				"result": "1.015",
      				"name": " Specific gravity of 24 hour Urine",
      				"unit": "",
      				"code": "5811-5"
      			}],
      			"order_type": "LAB",
      			"code_type": "LOINC",
      			"name": "Urinalysis macro (dipstick) panel - Urine",
      			"code": "24357-6"
      		}]
      	},
      	"custodian": {
      		"current_time": "201912201501-0500",
      		"telephone": "8003571200",
      		"owner_first_name": "onc",
      		"owner_last_name": "user",
      		"address": {
      			"country": "US",
      			"zip": "32963-1794",
      			"state": "FL",
      			"line1": "505 Beachland Blvd",
      			"city": "Vero Beach",
      			"lines2": ""
      		},
      		"name": "ONC 2015-1216"
      	}
      }

Back to Menu

Health Concerns

GET /api/patient_administrative/health_concerns?access_token=ACCESS_TOKEN

  • Request (application/json)

    • Headers

      Accept: application/json
  • Response 200 (application/json; charset=utf-8)

    • Headers

      X-Runtime: 0.011193
      X-XSS-Protection: 1; mode=block
      X-Cloud-Trace-Context: f3b64f0499314d68cbf2ed5b81af0505;o=0
      X-Download-Options: noopen
      Transfer-Encoding: chunked
      X-Permitted-Cross-Domain-Policies: none
      Referrer-Policy: strict-origin-when-cross-origin
      Cache-Control: max-age=0, private, must-revalidate
      X-Request-Id: 47a49b1a-af40-4aea-990a-7f1241789a21
      X-Content-Type-Options: nosniff
      Etag: W/"4f53cda18c2baa0c0354bb5f9a3ecbe5"
      X-Frame-Options: SAMEORIGIN
    • Body

      {
      	"author": {
      		"current_time": "201912201749-0500",
      		"telephone": "8003571200",
      		"owner_first_name": "onc",
      		"owner_last_name": "user",
      		"address": {
      			"country": "US",
      			"zip": "32963-1794",
      			"state": "FL",
      			"line1": "505 Beachland Blvd",
      			"city": "Vero Beach",
      			"lines2": ""
      		},
      		"name": "ONC 2015-1216"
      	},
      	"custodian": {
      		"current_time": "201912201749-0500",
      		"telephone": "8003571200",
      		"owner_first_name": "onc",
      		"owner_last_name": "user",
      		"address": {
      			"country": "US",
      			"zip": "32963-1794",
      			"state": "FL",
      			"line1": "505 Beachland Blvd",
      			"city": "Vero Beach",
      			"lines2": ""
      		},
      		"name": "ONC 2015-1216"
      	},
      	"health_concerns": {
      		"author": {
      			"current_time": "201912201749-0500",
      			"telephone": "8003571200",
      			"owner_first_name": "onc",
      			"owner_last_name": "user",
      			"address": {
      				"country": "US",
      				"zip": "32963-1794",
      				"state": "FL",
      				"line1": "505 Beachland Blvd",
      				"city": "Vero Beach",
      				"lines2": ""
      			},
      			"name": "ONC 2015-1216"
      		},
      		"list": [{
      			"narrative": "Watch Weight of patient\n",
      			"problem": {
      				"clinical_problem": {
      					"code_type": "SNOMED-CT",
      					"notes": null,
      					"id": 2000581,
      					"specifier": null,
      					"org_id": 4389,
      					"dx_code_id": null,
      					"source": "PRO",
      					"suggested_snomed_codes": null,
      					"created_at": "2019-12-16T14:17:42-05:00",
      					"end_date": null,
      					"data": {},
      					"record_id": 1263752,
      					"code_name": "Essential hypertension (disorder)",
      					"selected_snomed_codes": null,
      					"start_date": "2011-10-05",
      					"code_point": "59621000",
      					"updated_at": "2019-12-16T14:17:42-05:00",
      					"version": null,
      					"parent_id": null,
      					"status": "ACT"
      				}
      			},
      			"date_time": "2015-06-22T00:00:00-04:00"
      		}, {
      			"narrative": "Documented HypoThyroidism problem",
      			"problem": {
      				"clinical_problem": {
      					"code_type": "SNOMED-CT",
      					"notes": "",
      					"id": 2000580,
      					"specifier": null,
      					"org_id": 4389,
      					"dx_code_id": null,
      					"source": "PRO",
      					"suggested_snomed_codes": null,
      					"created_at": "2019-12-16T14:17:42-05:00",
      					"end_date": null,
      					"data": {},
      					"record_id": 1263752,
      					"code_name": "Severe hypothyroidism (disorder)",
      					"selected_snomed_codes": null,
      					"start_date": "2006-12-31",
      					"code_point": "83986005",
      					"updated_at": "2019-12-17T11:24:25-05:00",
      					"version": null,
      					"parent_id": null,
      					"status": "ACT"
      				}
      			},
      			"date_time": "2015-06-22T00:00:00-04:00"
      		}, {
      			"narrative": "Documented HyperTension problem\n",
      			"problem": {
      				"clinical_problem": {
      					"code_type": "SNOMED-CT",
      					"notes": null,
      					"id": 2000581,
      					"specifier": null,
      					"org_id": 4389,
      					"dx_code_id": null,
      					"source": "PRO",
      					"suggested_snomed_codes": null,
      					"created_at": "2019-12-16T14:17:42-05:00",
      					"end_date": null,
      					"data": {},
      					"record_id": 1263752,
      					"code_name": "Essential hypertension (disorder)",
      					"selected_snomed_codes": null,
      					"start_date": "2011-10-05",
      					"code_point": "59621000",
      					"updated_at": "2019-12-16T14:17:42-05:00",
      					"version": null,
      					"parent_id": null,
      					"status": "ACT"
      				}
      			},
      			"date_time": "2016-06-22T00:00:00-04:00"
      		}, {
      			"narrative": "Chronic Sickness exhibited by patient",
      			"problem": {},
      			"date_time": "2015-06-22T00:00:00-04:00"
      		}]
      	}
      }

Back to Menu

Vital Signs

GET /api/patient_administrative/vital_signs?access_token=ACCESS_TOKEN

  • Request (application/json)

    • Headers

      Accept: application/json
  • Response 200 (application/json; charset=utf-8)

    • Headers

      X-Runtime: 0.011193
      X-XSS-Protection: 1; mode=block
      X-Cloud-Trace-Context: f3b64f0499314d68cbf2ed5b81af0505;o=0
      X-Download-Options: noopen
      Transfer-Encoding: chunked
      X-Permitted-Cross-Domain-Policies: none
      Referrer-Policy: strict-origin-when-cross-origin
      Cache-Control: max-age=0, private, must-revalidate
      X-Request-Id: 47a49b1a-af40-4aea-990a-7f1241789a21
      X-Content-Type-Options: nosniff
      Etag: W/"4f53cda18c2baa0c0354bb5f9a3ecbe5"
      X-Frame-Options: SAMEORIGIN
    • Body

      {
      	"author": {
      		"current_time": "201912201721-0500",
      		"telephone": "8003571200",
      		"owner_first_name": "onc",
      		"owner_last_name": "user",
      		"address": {
      			"country": "US",
      			"zip": "32963-1794",
      			"state": "FL",
      			"line1": "505 Beachland Blvd",
      			"city": "Vero Beach",
      			"lines2": ""
      		},
      		"name": "ONC 2015-1216"
      	},
      	"vital_signs": {
      		"episodes": {
      			"1434945600": {
      				"temperature": {
      					"episode_date": "2015-06-22T00:00:00-04:00",
      					"value": "38",
      					"code": "8310-5"
      				},
      				"respiratory_rate": {
      					"episode_date": "2015-06-22T00:00:00-04:00",
      					"value": "18",
      					"code": "9279-1"
      				},
      				"bmi": {
      					"episode_date": "2015-06-22T00:00:00-04:00",
      					"value": "0.0",
      					"code": "39156-5"
      				},
      				"blood_pressure": {
      					"episode_date": "2015-06-22T00:00:00-04:00",
      					"systolic": "145",
      					"diastolic": "88",
      					"systolic_bp_code": "8480-6",
      					"diastolic_bp_code": "8462-4"
      				},
      				"inhaled_O2": {
      					"episode_date": "2015-06-22T00:00:00-04:00",
      					"units": "%",
      					"value": "36",
      					"code": "3150-0"
      				},
      				"pulse": {
      					"episode_date": "2015-06-22T00:00:00-04:00",
      					"value": "80",
      					"code": "8867-4"
      				},
      				"weight": {
      					"episode_date": "2015-06-22T00:00:00-04:00",
      					"units": "kg",
      					"value": "88",
      					"code": "29463-7"
      				},
      				"saO2": {
      					"episode_date": "2015-06-22T00:00:00-04:00",
      					"units": "%",
      					"value": "95",
      					"code": "59408-5"
      				},
      				"height": {
      					"episode_date": "2015-06-22T00:00:00-04:00",
      					"units": "cm",
      					"value": "177",
      					"code": "8302-2"
      				}
      			}
      		}
      	},
      	"custodian": {
      		"current_time": "201912201721-0500",
      		"telephone": "8003571200",
      		"owner_first_name": "onc",
      		"owner_last_name": "user",
      		"address": {
      			"country": "US",
      			"zip": "32963-1794",
      			"state": "FL",
      			"line1": "505 Beachland Blvd",
      			"city": "Vero Beach",
      			"lines2": ""
      		},
      		"name": "ONC 2015-1216"
      	}
      }

Back to Menu

Goals

GET /api/clinical/goals?access_token=ACCESS_TOKEN

  • Request (application/json)

    • Headers

      Accept: application/json
  • Response 200 (application/json; charset=utf-8)

    • Headers

      X-Runtime: 0.010770
      X-XSS-Protection: 1; mode=block
      X-Cloud-Trace-Context: 9e4c3a1fd6294229cb8a777367b5beb7;o=0
      X-Download-Options: noopen
      Transfer-Encoding: chunked
      X-Permitted-Cross-Domain-Policies: none
      Referrer-Policy: strict-origin-when-cross-origin
      Cache-Control: max-age=0, private, must-revalidate
      X-Request-Id: 29a8b194-8d26-4b46-9128-c83e3a8692bb
      X-Content-Type-Options: nosniff
      Etag: W/"4f53cda18c2baa0c0354bb5f9a3ecbe5"
      X-Frame-Options: SAMEORIGIN
    • Body

      {
      	"author": {
      		"owner_first_name": "onc",
      		"owner_last_name": "user",
      		"current_time": "201912201216-0500",
      		"name": "ONC 2015-1216",
      		"address": {
      			"zip": "32963-1794",
      			"line1": "505 Beachland Blvd",
      			"country": "US",
      			"city": "Vero Beach",
      			"lines2": "",
      			"state": "FL"
      		},
      		"telephone": "8003571200"
      	},
      	"sex": {
      		"author": {
      			"owner_first_name": "onc",
      			"owner_last_name": "user",
      			"current_time": "201912201216-0500",
      			"name": "ONC 2015-1216",
      			"address": {
      				"zip": "32963-1794",
      				"line1": "505 Beachland Blvd",
      				"country": "US",
      				"city": "Vero Beach",
      				"lines2": "",
      				"state": "FL"
      			},
      			"telephone": "8003571200"
      		},
      		"gender_identity": "",
      		"gender": "M",
      		"gender_describe": "",
      		"gender_display_name": "Male"
      	},
      	"patient_name": {
      		"last_name": "Bates",
      		"suffix": "JR",
      		"middle_name": "V",
      		"first_name": "Jeremy",
      		"preferred_name": ""
      	},
      	"date_of_birth": "1980-08-01T00:00:00-04:00",
      	"custodian": {
      		"owner_first_name": "onc",
      		"owner_last_name": "user",
      		"current_time": "201912201216-0500",
      		"name": "ONC 2015-1216",
      		"address": {
      			"zip": "32963-1794",
      			"line1": "505 Beachland Blvd",
      			"country": "US",
      			"city": "Vero Beach",
      			"lines2": "",
      			"state": "FL"
      		},
      		"telephone": "8003571200"
      	},
      	"preferred_language": {
      		"language_name": "English",
      		"hl7_code": "en-US",
      		"code": "en"
      	},
      	"ethnicity": null,
      	"smoking_status": {
      		"display_name": "Tobacco smoking consumption unknown",
      		"author": {
      			"owner_first_name": "onc",
      			"owner_last_name": "user",
      			"current_time": "201912201216-0500",
      			"name": "ONC 2015-1216",
      			"address": {
      				"zip": "32963-1794",
      				"line1": "505 Beachland Blvd",
      				"country": "US",
      				"city": "Vero Beach",
      				"lines2": "",
      				"state": "FL"
      			},
      			"telephone": "8003571200"
      		},
      		"snomed_code": "266927001",
      		"current_time": "2019-12-20T12:16:22-05:00",
      		"title_display": "Tobacco smoking consumption unknown",
      		"smoking_details": "",
      		"episode_date": "2015-07-22T00:00:00-04:00"
      	},
      	"race": {
      		"granular": {
      			"display_name": null,
      			"code": null
      		},
      		"primary": {
      			"display_name": null,
      			"code": null
      		}
      	}
      }

Back to Menu

Immunizations

GET /api/medications/immunizations?access_token=ACCESS-TOKEN

  • Request (application/json)

    • Headers

      Accept: application/json
  • Response 200 (application/json; charset=utf-8)

    • Headers

      X-Runtime: 0.011193
      X-XSS-Protection: 1; mode=block
      X-Cloud-Trace-Context: f3b64f0499314d68cbf2ed5b81af0505;o=0
      X-Download-Options: noopen
      Transfer-Encoding: chunked
      X-Permitted-Cross-Domain-Policies: none
      Referrer-Policy: strict-origin-when-cross-origin
      Cache-Control: max-age=0, private, must-revalidate
      X-Request-Id: 47a49b1a-af40-4aea-990a-7f1241789a21
      X-Content-Type-Options: nosniff
      Etag: W/"4f53cda18c2baa0c0354bb5f9a3ecbe5"
      X-Frame-Options: SAMEORIGIN
    • Body

      {
      	"author": {
      		"current_time": "201912201743-0500",
      		"telephone": "8003571200",
      		"owner_first_name": "onc",
      		"owner_last_name": "user",
      		"address": {
      			"country": "US",
      			"zip": "32963-1794",
      			"state": "FL",
      			"line1": "505 Beachland Blvd",
      			"city": "Vero Beach",
      			"lines2": ""
      		},
      		"name": "ONC 2015-1216"
      	},
      	"immunizations": {
      		"author": {
      			"current_time": "201912201743-0500",
      			"telephone": "8003571200",
      			"owner_first_name": "onc",
      			"owner_last_name": "user",
      			"address": {
      				"country": "US",
      				"zip": "32963-1794",
      				"state": "FL",
      				"line1": "505 Beachland Blvd",
      				"city": "Vero Beach",
      				"lines2": ""
      			},
      			"name": "ONC 2015-1216"
      		},
      		"list": [{
      			"status": "Completed",
      			"date_received": "2014-05-10T00:00:00-04:00",
      			"code_type": "CVX",
      			"description": "influenza virus vaccine, unspecified formulation",
      			"code": 88
      		}, {
      			"status": "Completed",
      			"date_received": "2012-01-04T00:00:00-05:00",
      			"code_type": "CVX",
      			"description": "diphtheria, tetanus toxoids and acellular pertussis vaccine, 5 pertussis antigens",
      			"code": 106
      		}, {
      			"status": "Cancelled",
      			"date_received": "2015-06-22T00:00:00-04:00",
      			"code_type": "CVX",
      			"description": "influenza, intradermal, quadrivalent, preservative free, injectable",
      			"code": 166
      		}]
      	},
      	"custodian": {
      		"current_time": "201912201743-0500",
      		"telephone": "8003571200",
      		"owner_first_name": "onc",
      		"owner_last_name": "user",
      		"address": {
      			"country": "US",
      			"zip": "32963-1794",
      			"state": "FL",
      			"line1": "505 Beachland Blvd",
      			"city": "Vero Beach",
      			"lines2": ""
      		},
      		"name": "ONC 2015-1216"
      	}
      }

Back to Menu

Encounters

GET /api/patient_administration/encounters?access_token=ACCESS_TOKEN

  • Request (application/json)

    • Headers

      Accept: application/json
  • Response 200 (application/json; charset=utf-8)

    • Headers

      X-Runtime: 0.010498
      X-XSS-Protection: 1; mode=block
      X-Cloud-Trace-Context: de2a4a9197e940f68b8e81a406d59eda;o=0
      X-Download-Options: noopen
      Transfer-Encoding: chunked
      X-Permitted-Cross-Domain-Policies: none
      Referrer-Policy: strict-origin-when-cross-origin
      Cache-Control: max-age=0, private, must-revalidate
      X-Request-Id: 9045fbe6-9a8c-4f10-9710-1be22fbeb582
      X-Content-Type-Options: nosniff
      Etag: W/"4f53cda18c2baa0c0354bb5f9a3ecbe5"
      X-Frame-Options: SAMEORIGIN
    • Body

      
      {
      	"author": {
      		"current_time": "201912201720-0500",
      		"telephone": "8003571200",
      		"owner_first_name": "onc",
      		"owner_last_name": "user",
      		"address": {
      			"country": "US",
      			"zip": "32963-1794",
      			"state": "FL",
      			"line1": "505 Beachland Blvd",
      			"city": "Vero Beach",
      			"lines2": ""
      		},
      		"name": "ONC 2015-1216"
      	},
      	"encounters": {
      		"author": {
      			"current_time": "201912201720-0500",
      			"telephone": "8003571200",
      			"owner_first_name": "onc",
      			"owner_last_name": "user",
      			"address": {
      				"country": "US",
      				"zip": "32963-1794",
      				"state": "FL",
      				"line1": "505 Beachland Blvd",
      				"city": "Vero Beach",
      				"lines2": ""
      			},
      			"name": "ONC 2015-1216"
      		},
      		"list": []
      	},
      	"functional_status": {
      		"author": {
      			"current_time": "201912201720-0500",
      			"telephone": "8003571200",
      			"owner_first_name": "onc",
      			"owner_last_name": "user",
      			"address": {
      				"country": "US",
      				"zip": "32963-1794",
      				"state": "FL",
      				"line1": "505 Beachland Blvd",
      				"city": "Vero Beach",
      				"lines2": ""
      			},
      			"name": "ONC 2015-1216"
      		},
      		"list": []
      	},
      	"cognitive_status": {
      		"author": {
      			"current_time": "201912201720-0500",
      			"telephone": "8003571200",
      			"owner_first_name": "onc",
      			"owner_last_name": "user",
      			"address": {
      				"country": "US",
      				"zip": "32963-1794",
      				"state": "FL",
      				"line1": "505 Beachland Blvd",
      				"city": "Vero Beach",
      				"lines2": ""
      			},
      			"name": "ONC 2015-1216"
      		},
      		"list": []
      	},
      	"custodian": {
      		"current_time": "201912201720-0500",
      		"telephone": "8003571200",
      		"owner_first_name": "onc",
      		"owner_last_name": "user",
      		"address": {
      			"country": "US",
      			"zip": "32963-1794",
      			"state": "FL",
      			"line1": "505 Beachland Blvd",
      			"city": "Vero Beach",
      			"lines2": ""
      		},
      		"name": "ONC 2015-1216"
      	}
      }
      

Back to Menu

Implantable Devices

GET /api/patient_administration/devices?access_token=ACCESS_TOKEN

  • Request (application/json)

    • Headers

      Accept: application/json
  • Response 200 (application/json; charset=utf-8)

    • Headers

      X-Runtime: 0.012905
      X-XSS-Protection: 1; mode=block
      X-Cloud-Trace-Context: 5d66b5bbc3dd4bb480e44189d360b802;o=0
      X-Download-Options: noopen
      Transfer-Encoding: chunked
      X-Permitted-Cross-Domain-Policies: none
      Referrer-Policy: strict-origin-when-cross-origin
      Cache-Control: max-age=0, private, must-revalidate
      X-Request-Id: f9651dc7-c79a-4844-8299-e052ddba54f5
      X-Content-Type-Options: nosniff
      Etag: W/"4f53cda18c2baa0c0354bb5f9a3ecbe5"
      X-Frame-Options: SAMEORIGIN
    • Body

      {
      	"author": {
      		"current_time": "201912201328-0500",
      		"telephone": "8003571200",
      		"owner_first_name": "onc",
      		"owner_last_name": "user",
      		"address": {
      			"country": "US",
      			"zip": "32963-1794",
      			"state": "FL",
      			"line1": "505 Beachland Blvd",
      			"city": "Vero Beach",
      			"lines2": ""
      		},
      		"name": "ONC 2015-1216"
      	},
      	"custodian": {
      		"current_time": "201912201328-0500",
      		"telephone": "8003571200",
      		"owner_first_name": "onc",
      		"owner_last_name": "user",
      		"address": {
      			"country": "US",
      			"zip": "32963-1794",
      			"state": "FL",
      			"line1": "505 Beachland Blvd",
      			"city": "Vero Beach",
      			"lines2": ""
      		},
      		"name": "ONC 2015-1216"
      	},
      	"udis_for_patient_implantable_devices": {
      		"list": [{
      			"status": "COM",
      			"episode_date": "2011-10-05T00:00:00-04:00",
      			"author": {
      				"current_time": "201912201328-0500",
      				"telephone": "8003571200",
      				"owner_first_name": "onc",
      				"owner_last_name": "user",
      				"address": {
      					"country": "US",
      					"zip": "32963-1794",
      					"state": "FL",
      					"line1": "505 Beachland Blvd",
      					"city": "Vero Beach",
      					"lines2": ""
      				},
      				"name": "ONC 2015-1216"
      			},
      			"procedure": {
      				"code_description": "Introduction of cardiac pacemaker system via vein (procedure)",
      				"method": {
      					"code_system": "SNOMED-CT",
      					"description": "Introduction of cardiac pacemaker system via vein",
      					"code_point": "175135009"
      				},
      				"body_site": {
      					"code_system": "SNOMED-CT",
      					"description": "Structure of subclavian vein",
      					"code_point": "9454009"
      				},
      				"code_point": "175135009"
      			},
      			"name": "Cardiac Pacemaker - CRT-D DTBA1QQ VIVA QUAD XT US IS4/DF4",
      			"udi": "(01)00643169007222(17)160128(21)BLC200461H",
      			"assigning_authority": "FDA"
      		}]
      	}
      }

Back to Menu

Clinical Documents

The clinical documents end point can produce a complete clinical summary for a patient. That is to say, a CCDA v2.1 xml document. Without dates it will give a full readout of the patient's clinical data on file. With start and end date parameters, only clinical data relevant to the date range will be returned. This includes United States Core Data for Interoperability (USCDI) covering the scope of the clinical data present in the other API end points, reporting during the time frame and any active data from prior dates if no end date given. For example, a problem like hypertension without an end date would appear in the output if it was reported before the start date. This is the only end point will and must accept the xml content header and will return XML.

GET /api/cda_documents?access_token=ACCESS_TOKEN

  • Request (application/xml)

    • Headers

      Accept: application/xml
  • Response 200 (application/json; charset=utf-8)

    • Headers

      X-Runtime: 0.011193
      X-XSS-Protection: 1; mode=block
      X-Cloud-Trace-Context: f3b64f0499314d68cbf2ed5b81af0505;o=0
      X-Download-Options: noopen
      Transfer-Encoding: chunked
      X-Permitted-Cross-Domain-Policies: none
      Referrer-Policy: strict-origin-when-cross-origin
      Cache-Control: max-age=0, private, must-revalidate
      X-Request-Id: 47a49b1a-af40-4aea-990a-7f1241789a21
      X-Content-Type-Options: nosniff
      Etag: W/"4f53cda18c2baa0c0354bb5f9a3ecbe5"
      X-Frame-Options: SAMEORIGIN
    • Body: XML

Error Codes

Back to Menu

200 - OKEverything worked as expected.
400 - Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 - UnauthorizedNo valid API key provided.
402 - Request FailedThe parameters were valid but the request failed.
403 - ForbiddenThe API key doesn't have permissions to perform the request.
404 - Not FoundThe requested resource doesn't exist.
409 - ConflictThe request conflicts with another request (perhaps due to using the same idempotent key).
429 - Too Many RequestsToo many requests hit the API too quickly. We recommend an exponential backoff of your requests.
500, 502, 503, 504 - Server ErrorsSomething went wrong on our end.