Clinical API Introduction

🚧
Enterprise feature
If you are interested in using the Medical API, send us an email at [email protected].

The Medical API provides access to user’s medical records from healthcare providers. In this section you will see some common objects to many of the Medical API endpoints.

Codes

The codes Array[Object] provides code objects with specific classifications from medical coding systems (when available).

Property	Type	Description
code	String	(optional) Medical code
codeSystem	String	(optional) The identifier of the code system that the code belongs to
codeSystemName	String	(optional) The name of the code system that the code belongs to
inferred	Boolean	(optional) Set to true if this code was inferred. If unset, this code was present in the source data
name	String	The name of the code

Organization Object

Property	Type	Description
id	String	The id of the organization
name	String	The name of the organization
href	String	Human API organizations endpoint URL to retrieve full details

Name Object

Property	Type	Description
prefix	String	(optional) The title of the provider e.g. "MD"
given	Array[String]	Name values associated with the provider e.g. ["Travis", "R"]
family	String	(optional) Family name of the provider e.g. "Liddell"

📘
What are "organizations"?
See organizations for more information.

🚧
What is "(optional)"?
Some descriptions for response properties are marked as "(optional)". This indicates that the property may be omitted from the API response.