Human API

Human API Developer Hub

Welcome to the Human API Developer Hub. You'll find comprehensive guides and documentation to help you start working with Human API as quickly as possible. Let's jump right in!

Get Started
Suggest Edits

Getting Started

 

Looking for our wellness apps documentation?

Please navigate to our 2.1 API reference if you are interested in integrating wellness applications.

Welcome to Human API!

You can use Human API to retrieve normalized health data from your app’s users from thousands of unique sources.

Before you’ll be able to use Human API to query real data, you’ll need to create an account and implement Connect to authenticate external sources.

What are you waiting for? Let's get started!

Common Record Properties

Regardless of the type, most data records have a few standard properties:

Property
Type
Description

id

String

The id of the record

humanId

String

Unique Human API user identifier

source

String

The name of the originating source (all lowercase, no spaces)

sourceData

String

Unique properties from a source that do not fit the main data model

createdAt

Date

The time the record was created on the Human API server

updatedAt

Date

The time the record was updated on the Human API server

If you have not already, we highly recommend reading the Patterns and Conventions to familiarize yourself with how to filter for these parameters so you only get the data that you need. In general, data records contain information from the data source that has been normalized to standard units and parameters. Any source specific information will be passed through via the optional sourceData object.

For the full documentation including step-by-step implementation guides and information on data sources, see the Web Guide.

HAPI coding!

 
Suggest Edits

Medical API Introduction

 

Enterprise feature

If you are interested in using the Medical API send us an email at enterprise@humanapi.co.

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.

 
Suggest Edits

Allergies

Get a list of medical allergies the user has had so far

 
gethttps://api.humanapi.co/v1/human/medical/allergies

Response Properties

Property
Type
Description

id

String

The id of the resource

source

String

The name of the originating service

updatedAt

Date

The time the record was updated on the Human API server

createdAt

Date

The time the record was created on the Human API server

name

String

The name of the allergy (e.g. ‘Etomidate’, 'Fluconazole’, 'Metaxalone’)

patient

Object

Patient information (“name” and other optional attributes)

reactionsFull

Array[Object]

See reactions object

allergen

Object

See allergen object

status

String

(optional) The status of the allergy

severity

String

(optional) The severity of the allergy

dateRange

Object

(optional) See date range object

codes

Array[Object]

See codes

Allergen Object

Property
Type
Description

name

String

Name of the allergen

codes

Object

See codes

Reaction Object

Property
Type
Description

name

String

Name of the allergen

codes

Object

See codes

reactionType

Object

See reaction type object

Reaction Type Object

Property
Type
Description

name

String

Name of the reaction

codes

Object

See codes

Date Range Object

Property
Type
Description

start

Date

Start date

end

Date

End date

# Get all allergies associated with the user
curl -H "Authorization: Bearer someToken" "https://api.humanapi.co/v1/human/medical/allergies"
A binary file was returned

You couldn't be authenticated

{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
# Returns a json array of allergies:
[
    {
        "createdAt": "2014-10-19T21:02:17.949Z",
        "id": "544323ae5b48098829dcc437",
        "name": "Oxycodone",
        "organization": {
            "href": "/medical/organizations/53c050ac51c69003200aa998",
            "id": "53c050ac51c69003200aa998",
            "name": "Cleveland Clinic"
        },
        "patient": {
            "name": "Maxwell Forrest"
        },
        "reactionsFull": [],
        "source": "emr-1-320",
        "updatedAt": "2014-10-19T21:02:17.949Z"
        "allergen": {
            "codes": [
                {
                    "code": "10831",
                    "codeSystem": "2.16.840.1.113883.6.88",
                    "codeSystemName": "RxNorm",
                    "name": "Bactrim"
                },
                {
                    "code": "N0000008034",
                    "codeSystem": "2.16.840.1.113883.3.26.1.5",
                    "codeSystemName": "NDF-RT",
                    "name": "Sulfa (Sulfonamide Antibiotics)"
                }
            ]
        },
        "codes": [
            {
                "code": "10831",
                "codeSystem": "2.16.840.1.113883.6.88",
                "codeSystemName": "RxNorm",
                "name": "Bactrim"
            },
            {
                "code": "N0000008034",
                "codeSystem": "2.16.840.1.113883.3.26.1.5",
                "codeSystemName": "NDF-RT",
                "name": "Sulfa (Sulfonamide Antibiotics)"
            }
        ]
    },
    {
        "id": "544323ae5b48098829dcc438",
        "name": "Metaxalone",
        "organization": {
            "href": "/medical/organizations/53c050ac51c69003200aa998",
            "id": "53c050ac51c69003200aa998",
            "name": "Cleveland Clinic"
        },
        "patient": {
            "name": "Maxwell Forrest"
        },
        "reactionsFull": [],
        "source": "emr-1-320",
        "createdAt": "2014-10-19T21:02:17.949Z",
        "updatedAt": "2014-10-19T21:02:17.949Z",
        "allergen": {
            "codes": [
                {
                    "code": "10831",
                    "codeSystem": "2.16.840.1.113883.6.88",
                    "codeSystemName": "RxNorm",
                    "name": "Bactrim"
                },
                {
                    "code": "N0000008034",
                    "codeSystem": "2.16.840.1.113883.3.26.1.5",
                    "codeSystemName": "NDF-RT",
                    "name": "Sulfa (Sulfonamide Antibiotics)"
                }
            ]
        },
        "codes": [
            {
                "code": "10831",
                "codeSystem": "2.16.840.1.113883.6.88",
                "codeSystemName": "RxNorm",
                "name": "Bactrim"
            },
            {
                "code": "N0000008034",
                "codeSystem": "2.16.840.1.113883.3.26.1.5",
                "codeSystemName": "NDF-RT",
                "name": "Sulfa (Sulfonamide Antibiotics)"
            }
        ]
    }
]
# Returns a json array of allergies:
[
    {
        "createdAt": "2014-10-19T21:02:17.949Z",
        "id": "544323ae5b48098829dcc437",
        "name": "Oxycodone",
        "organization": {
            "href": "/medical/organizations/53c050ac51c69003200aa998",
            "id": "53c050ac51c69003200aa998",
            "name": "Cleveland Clinic"
        },
        "patient": {
            "name": "Maxwell Forrest"
        },
        "reactionsFull": [],
        "source": "emr-1-320",
        "updatedAt": "2014-10-19T21:02:17.949Z"
        "allergen": {
            "codes": [
                {
                    "code": "10831",
                    "codeSystem": "2.16.840.1.113883.6.88",
                    "codeSystemName": "RxNorm",
                    "name": "Bactrim"
                },
                {
                    "code": "N0000008034",
                    "codeSystem": "2.16.840.1.113883.3.26.1.5",
                    "codeSystemName": "NDF-RT",
                    "name": "Sulfa (Sulfonamide Antibiotics)"
                }
            ]
        },
        "codes": [
            {
                "code": "10831",
                "codeSystem": "2.16.840.1.113883.6.88",
                "codeSystemName": "RxNorm",
                "name": "Bactrim"
            },
            {
                "code": "N0000008034",
                "codeSystem": "2.16.840.1.113883.3.26.1.5",
                "codeSystemName": "NDF-RT",
                "name": "Sulfa (Sulfonamide Antibiotics)"
            }
        ]
    },
    {
        "id": "544323ae5b48098829dcc438",
        "name": "Metaxalone",
        "organization": {
            "href": "/medical/organizations/53c050ac51c69003200aa998",
            "id": "53c050ac51c69003200aa998",
            "name": "Cleveland Clinic"
        },
        "patient": {
            "name": "Maxwell Forrest"
        },
        "reactionsFull": [],
        "source": "emr-1-320",
        "createdAt": "2014-10-19T21:02:17.949Z",
        "updatedAt": "2014-10-19T21:02:17.949Z",
        "allergen": {
            "codes": [
                {
                    "code": "10831",
                    "codeSystem": "2.16.840.1.113883.6.88",
                    "codeSystemName": "RxNorm",
                    "name": "Bactrim"
                },
                {
                    "code": "N0000008034",
                    "codeSystem": "2.16.840.1.113883.3.26.1.5",
                    "codeSystemName": "NDF-RT",
                    "name": "Sulfa (Sulfonamide Antibiotics)"
                }
            ]
        },
        "codes": [
            {
                "code": "10831",
                "codeSystem": "2.16.840.1.113883.6.88",
                "codeSystemName": "RxNorm",
                "name": "Bactrim"
            },
            {
                "code": "N0000008034",
                "codeSystem": "2.16.840.1.113883.3.26.1.5",
                "codeSystemName": "NDF-RT",
                "name": "Sulfa (Sulfonamide Antibiotics)"
            }
        ]
    }
]
 
# Get all allergies associated with the user
curl -H "Authorization: Bearer demo" "https://api.humanapi.co/v1/human/medical/allergies"
Suggest Edits

Encounters

Get a list of medical encounters the user has had so far

 
gethttps://api.humanapi.co/v1/human/medical/encounters

Response Properties

Property
Type
Description

id

String

The id of the resource

source

String

The name of the originating service

updatedAt

Date

The time the record was updated on the Human API server

createdAt

Date

The time the record was created on the Human API server

dateTime

Date

The date of the encounter

visitType

String

The type of visit

provider

Object

The provider for the encounter (see provider object)

prescriptions

Array[Object]

A list of prescriptions provided during the encounter (see link object)

diagnoses

Array[Object]

A list of diagnoses for the encounter (see link object)

vitals

Object

(optional) Vitals captured during the encounter (e.g. {"temperature" : 95.2 [degF]","weight" : 180 [lb_av]","height" : "69 [in_us]"})

vitalSigns

Array[Object]

A list of vital signs from the encounter (see link object)

reasons

Array[String]

A list of reasons for the encounter (e.g. [‘Follow-up’, 'Consult’, 'DYSPHONIA', 'Back Pain’])

orders

Array[Object]

A list of medication orders for the patient (see orders object)

testResults

Array[Object]

A list of test results for the patient (see link object)

plansOfCare

Array[Object]

A list of plans of care from the encounter (see link object)

medications

Array[Object]

A list of medications used by the patient. Objects in array can have some or many of the properties of medications. Common properties are "name", "productName", "startDate", "endDate", "instructions".

followUpInstructions

String

(optional) Follow-up instructions

patientInstruction

Object

Patient information (“name” and other optional attributes)

organization

Object

See organizations object

codes

Array[Object]

See codes

Orders Object

Property
Type
Description

name

String

The name of the order

codeType

String

The code type of the order (e.g. “CPT( R )”, “Custom”)

expectedDate

Date

The date the order is expected

expireDate

Date

The date the order expires

procedureCode

String

The procedure code of the order

type

String

The type of the order (e.g. “Lab”, “Procedures”)

codes

Array[Object]

See codes

Provider Object

Property
Type
Description

name

String

Name of the provider

departmentName

String

(optional) Name of the provider department

address

String

(optional) Address of the provider

Link Object

Property
Type
Description

name

String

Name of the data element

href

String

API path to the full data object

# Get all encounters associated with the user
curl -H "Authorization: Bearer someToken" "https://api.humanapi.co/v1/human/medical/encounters"
A binary file was returned

You couldn't be authenticated

{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
# Returns a json array of encounters:
[
    {
        "codes": [
            {
                "code": "3",
                "codeSystem": "1.2.840.114350.1.13.106.2.7.4.698084.30",
                "codeSystemName": "Epic.EncounterType",
                "name": "Hospital Encounter"
            }
        ],
        "createdAt": "2014-10-19T21:33:19.971Z",
        "dateTime": "2014-07-21T17:30:00.000Z",
        "diagnoses": [],
        "id": "54442e1f8bbb040d5388e842",
        "medications": [
            {
                "canRefill": false,
                "codes": [],
                "genericProductIndicator": "42200032301810",
                "hasPendingRefill": false,
                "name": "FLUTICASONE PROPIONATE (NASAL) 50 MCG/ACT NA SUSP",
                "ndcCode": "0054-3270-99",
                "startDate": "2010-09-17T04:00:00.000Z"
            },
            {
                "canRefill": false,
                "codes": [],
                "genericProductIndicator": "01200010100315",
                "hasPendingRefill": false,
                "name": "Amoxicillin 875 MG OR TABS",
                "ndcCode": "0093-2264-01",
                "startDate": "2010-09-17T04:00:00.000Z"
            }
        ],
        "orders": [
            {
                "codeType": "Custom",
                "codes": [],
                "expectedDate": "2012-01-19T05:00:00.000Z",
                "expireDate": "2013-01-18T05:00:00.000Z",
                "name": "LIPID PROFILE",
                "procedureCode": "LABLIPID",
                "type": "LAB CHEMISTRY"
            }
        ],
        "organization": {
            "href": "/medical/organizations/54dc427aaa6b4cb7d6203061",
            "id": "54dc427aaa6b4cb7d6203061",
            "name": "Cleveland Clinic"
        },
        "patient": {},
        "plansOfCare": [],
        "prescriptions": [],
        "provider": {
            "address": "1064 Goosetown Drive\nAsheville, NC 28801",
            "departmentName": "Asheville Goosetown Laboratory",
            "name": "LAB"
        },
        "reasons": [
            "Ear Problem"
        ],
        "source": "emr-1-320",
        "testResults": [],
        "updatedAt": "2014-10-19T21:33:19.971Z",
        "visitType": "Office Visit",
        "vitalSigns": []
    }
]
 
Suggest Edits

Functional Statuses

Get a list of medical functional statuses associated with the user

 
gethttps://api.humanapi.co/v1/human/medical/functional_statuses

Response Properties

Property
Type
Description

id

String

The id of the resource

source

String

The name of the originating service

updatedAt

Date

The time the record was updated on the Human API server

createdAt

Date

The time the record was created on the Human API server

dateTime

Date

(optional) The date of the functional status

name

String

The name of the functional status

codes

Array[Object]

See codes

# Get all functional statuses associated with the user
curl -H "Authorization: Bearer someToken" "https://api.humanapi.co/v1/human/medical/functional_statuses"
A binary file was returned

You couldn't be authenticated

{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
# Returns a json array of functional statuses:
[
    {
        "id": "55e692d20c7deefb7cfe90f8",
        "createdAt": "2014-09-01T21:42:09.969Z",
        "updatedAt": "2014-09-01T21:42:10.072Z",
        "dateTime": "2014-02-11T09:30:00.000Z",
        "source": "emr-1-320",
        "name": "Memory impairment",
        "codes": []
    }
]
 
Suggest Edits

Immunizations

Get a list of immunizations the user has had so far

 
gethttps://api.humanapi.co/v1/human/medical/immunizations

Response Properties

Property
Type
Description

id

String

The id of the resource

source

String

The name of the originating service

updatedAt

Date

The time the record was updated on the Human API server

createdAt

Date

The time the record was created on the Human API server

dates

Array[Date]

The dates immunization was given.

name

String

The name of the immunization (e.g. ‘Tetanus+Dip ADULT (Td)’, 'Varicella’, 'Influenza Virus Vaccine’)

patient

Object

Patient information (“name” and other optional attributes)

organization

Object

See organizations object

codes

Array[Object]

See codes

# Get all immunizations associated with the user
curl -H "Authorization: Bearer someToken" "https://api.humanapi.co/v1/human/medical/immunizations"
A binary file was returned

You couldn't be authenticated

{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
# Returns a json array of immunizations:
[{
  "id": "5443d24d0d2a0e0c4b3672e8",
  "name": "Tetanus+Dip ADULT (Td)",
  "source": "emr-1-320",
  "dates": ["2005-09-27T04:00:00.000Z", "1995-01-01T05:00:00.000Z"],
  "patient": {
    "name": "Maxwell Forrest"
  },
  "updatedAt": "2014-10-19T21:02:17.949Z",
  "createdAt": "2014-10-19T21:02:17.949Z",
  "organization": {
    "id": "53c050ac51c69003200aa998",
    "name": "Cleveland Clinic",
    "href": "/medical/organizations/53c050ac51c69003200aa998"
  }
}, {
  "id": "5443d24d0d2a0e0c4b3672eb",
  "name": "Pneumococcal Conjugate PCV13",
  "source": "emr-1-320",
  "dates": ["2014-03-14T04:00:00.000Z"],
  "patient": {
    "name": "Maxwell Forrest"
  },
  "updatedAt": "2014-10-19T21:02:17.949Z",
  "createdAt": "2014-10-19T21:02:17.949Z",
  "organization": {
    "id": "53c050ac51c69003200aa998",
    "name": "Cleveland Clinic",
    "href": "/medical/organizations/53c050ac51c69003200aa998"
  },
  "codes": []
}]
 
Suggest Edits

Instructions

Get a list of medical instructions associated with the user

 
gethttps://api.humanapi.co/v1/human/medical/instructions

Response Properties

Property
Type
Description

id

String

The id of the resource

source

String

The name of the originating service

updatedAt

Date

The time the record was updated on the Human API server

createdAt

Date

The time the record was created on the Human API server

dateTime

String

(optional) The date of the instruction

name

String

The name of the instruction (ex. “instructions”, or “discharge instructions”, etc.)

text

String

Text content of the instruction

codes

Array[Object]

See codes

# Get all instructions associated with the user
curl -H "Authorization: Bearer someToken" "https://api.humanapi.co/v1/human/medical/instructions"
A binary file was returned

You couldn't be authenticated

{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
# Returns a json array of instructions:
[
    {
        "id": "55e692d20c7deefb7cfe90f8",
        "createdAt": "2015-09-01T21:42:09.969Z",
        "updatedAt": "2015-09-01T21:42:10.072Z",
        "dateTime": "2015-02-11T09:30:00.000Z",
        "source": "emr-1-320",
        "name": "Instructions",
        "text": "Please forward scans to \nDr. Reddy\nDepartment of Children's medicine\n 123 Main St.\nCedarCity, CA 00000\n\nI encourage you to visit my website",
        "codes": []
    }
]
 
Suggest Edits

Medications

Get a list of medical medications the user has had so far

 
gethttps://api.humanapi.co/v1/human/medical/medications

Response Properties

Property
Type
Description

id

String

The id of the resource

source

String

The name of the originating service

updatedAt

Date

The time the record was updated on the Human API server

createdAt

Date

The time the record was created on the Human API server

instructions

String

(optional) The instructions provided for the medication (e.g. ‘Take 1 tablet by mouth daily.’)

details

Object

(optional) Parsed dosage and instruction information (see below)

genericProductIndicator

String

(optional) Generic Product Identifier of the medication

patient

Object

Patient information (“name” and other optional attributes)

name

String

The name of the medication (e.g. 'Cyanocobalamin (VITAMIN B12 PO)’)

provider

String

(optional) The name of the provider - if available (e.g. 'Jacob Smith, MD’, 'Outside Provider’, 'Unknown’)

providerID

String

(optional) The id of the provider

ndcCode

String

(optional) The National Drug Code of the medication (if provided)

productName

String

(optional) The product name of the medication - if provided (e.g. 'zolpidem’, 'gabapentin’, 'aspirin’)

commonBrandName

String

(optional) The common brand name of the medication - if provided (e.g. 'NORCO’, 'XANAX’, 'NEURONTIN’)

dosageInfo

String

(optional) The dosage information - if provided (e.g. '10 MG tablet’, '100 UNIT/ML injection’, '5mg Tab’)

pharmacy

Object

(optional) Pharmacy information - if provided (see pharmacy below)

organization

Object

See organizations object

expiration

Date

(optional) The expiration date of the medication - if provided

refillsRemaining

Number

(optional) The number of refills remaining - if available

refillsTotal

Number

(optional) The total number of refills - if available

status

String

(optional) Prescription status for a medication - if available (e.g. 'Active’, 'On Hold’)

startDate

Date

(optional) Start date of the medication

endDate

Date

(optional) End date of the medication

codes

Array[Object]

See codes

Pharmacy Object

Property
Type
Description

id

String

The id of the resource

name

String

The name of the pharmacy

address

String

The address of the pharmacy

phone

String

The phone number of the pharmacy

hours

String

The opening hours of the pharmacy (if provided)

Details Object

Property
Type
Description

dosage

Object

(optional) The 'form’ and 'value’ of a dosage if applicable e.g. "dosage": {"form: "capsule", "value": "3"}

frequency

Object

(optional) The frequency that the medication should be taken e.g. "frequency": {"number": "1", "unit": "day"}

route

String

(optional) The route the medication is taken e.g. "route": "enteral_oral"

strength

Object

(optional) The strength of the dosage e.g. "strength": {"number": "100, "unit": "mg"}

# Get all medications associated with the user
curl -H "Authorization: Bearer someToken" "https://api.humanapi.co/v1/human/medical/medications"
A binary file was returned

You couldn't be authenticated

{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
# Returns a json array of medications:
[{
  "id": "55a2ff2d197f25c42f2e84b7",
  "updatedAt": "2014-12-09T18:06:42.100Z",
  "createdAt": "2014-12-09T18:06:42.100Z",
  "commonBrandName": "CLARITIN",
  "details": {
      "dosage": {
          "form": "tablet",
          "value": "1"
      },
      "frequency": {
          "number": "1",
          "unit": "as-needed"
      },
      "route": "enteral_oral",
      "strength": {
          "number": "10",
          "unit": "mg"
      }
  },
  "dosageInfo": "10 MG tablet",
  "genericProductIndicator": "41550030000320",
  "instructions": "Take 1 tab by mouth as needed (allergies).",
  "name": "loratadine (CLARITIN) 10 MG tablet",
  "ndcCode": "0781-5077-01",
  "organization": {
      "href": "/medical/organizations/53c050ac51c69003200aa998",
      "id": "53c050ac51c69003200aa998",
      "name": "Cleveland Clinic"
  },
  "patient": {
      "name": "Maxwell Forrest"
  },
  "productName": "loratadine",
  "provider": "Isaias Kingston, MD",
  "providerID": "34665",
  "source": "emr-1-320",
  "status": "Active",
  "startDate": "2012-01-26T00:00:00.000Z",
  "endDate": "2014-01-26T00:00:00.000Z",
  "codes": []
},
{
  "id": "55a2fef4197f25c42f2e849f",
  "updatedAt": "2014-12-09T18:06:42.100Z"
  "createdAt": "2014-12-09T18:06:42.100Z",
  "commonBrandName": "LEXAPRO",
  "details": {
      "dosage": {
          "form": "tablet",
          "value": "1"
      },
      "frequency": {
          "number": "1",
          "unit": "day"
      },
      "route": "enteral_oral",
      "strength": {
          "number": "5",
          "unit": "mg"
      }
  },
  "dosageInfo": "5 mg tablet",
  "genericProductIndicator": "58160034100310",
  "instructions": "Take 1 tablet by mouth every day",
  "name": "escitalopram (LEXAPRO) 5 mg tablet",
  "ndcCode": "0378-3855-77",
  "organization": {
      "href": "/medical/organizations/53c050ac51c69003200aa998",
      "id": "53c050ac51c69003200aa998",
      "name": "Cleveland Clinic"
  },
  "patient": {
      "name": "Maxwell Forrest"
  },
  "productName": "escitalopram",
  "provider": "Isaias Kingston, MD",
  "providerID": "34665",
  "source": "emr-1-320",
  "status": "On Hold",
  "startDate": "2012-01-26T00:00:00.000Z",
  "endDate": "2014-01-26T00:00:00.000Z",
  "codes": []
}]
 
Suggest Edits

Narratives

Get a list of medical narratives associated with the user

 
gethttps://api.humanapi.co/v1/human/medical/narratives

Response Properties

Property
Type
Description

id

String

The id of the resource

source

String

The name of the originating service

updatedAt

Date

The time the record was updated on the Human API server

createdAt

Date

The time the record was created on the Human API server

dateTime

Date

The date of the narrative

author

String

The name of the author

entries

Array[Object]

Array of entry objects (See below)

Entry Object

Property
Type
Description

title

String

The title of the entry

text

String

The description text of the entry

# Get all narratives associated with the user
curl -H "Authorization: Bearer someToken" "https://api.humanapi.co/v1/human/medical/narratives"
A binary file was returned

You couldn't be authenticated

{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
# Returns a json array of narratives:
[{
  "id": "54e3521f79192a2e4993dfdc",
  "source": "emr-1-320",
  "updatedAt": "2015-02-11T06:26:53.217Z",
  "createdAt": "2015-02-11T06:26:53.217Z",
  "dateTime": "Mon Jul 07 2014 14:40:26 GMT-0700 (PDT)",
  "author": "Christine Johnson",
  "entries": [{
    "title": "Note from Sutter Health Affiliates and Community Connect Practices",
    "text": "This document contains information that was shared with Maxwell Forrest. It may not contain the entire record from Sutter Health Affiliates and Community Connect Practices."
  }, {
    "title": "Reason for Visit",
    "text": "Reason Comments Diarrhea"
  }, {
    "title": "Encounter Details",
    "text": "Date Type Department Care Team 07/07/2014 Office Visit Palo Alto Family Medicine 795 El Camino Real Palo Alto, CA 94301 650-333-4444 Johnson, Christine, NP 795 EL CAMINO REAL Palo Alto, CA 94301 650-333-4444 650-333-4444 (Fax)"
  }, {
    "title": "Active Allergies and Adverse Reactions - as of 02/09/2015",
    "text": "No Known Allergies"
  }, {
    "title": "Current Medications - as of 02/09/2015",
    "text": "No known medications"
  }, {
    "title": "Active Problems - as of 02/09/2015",
    "text": "Problem Noted Date No Active Medical Problems 04/14/2014"
  }, {
    "title": "Social History - as of 02/09/2015",
    "text": "Tobacco Use Types Packs/Day Years Used Date Never smoker 0 0 Alcohol Use Drinks/Week oz/Week Yes 1 Drinks containing 0.5 oz of alcohol 0.5"
  }, {
    "title": "Last Filed Vital Signs",
    "text": "Vital Sign Reading Time Taken Blood Pressure 120 / 70 07/07/2014  2:47 PM PDT Pulse 75 07/07/2014  2:47 PM PDT Temperature 36.4 °C (97.6 °F) 07/07/2014  2:47 PM PDT Respiratory Rate - - Height - - Weight 84.823 kg (187 lb) 07/07/2014  2:47 PM PDT Body Mass Index 23.52 07/07/2014  2:47 PM PDT Oxygen Saturation 98% 07/07/2014  2:47 PM PDT"
  }, {
    "title": "Plan of Care",
    "text": "Not on file"
  }, {
    "title": "Procedures",
    "text": ""
  }, {
    "title": "Results",
    "text": "Not on file"
  }, {
    "title": "Visit Diagnoses",
    "text": "Viral enteritis - Primary Intestinal infection due to other organism, not elsewhere classified Diarrhea Diarrhea"
  }, {
    "title": "Insurance",
    "text": "Payer Benefit Plan / Group Subscriber ID Type Phone Address BLUE SHIELD BLUE SHIELD PPO XEK901245582 PRIVATE FFS PPO/EPO PO BOX 272550 CHICO, CA 95927 Guarantor Name Account Type Relation to Patient Date of Birth Phone Billing Address FORREST,MAXWELL Personal/Family Self 05/30/1978 Work: +1-650-333-4444 Home: +1-650-333-4444 1 MILKY WAY WAY APT E MENLO PARK, CA 94025"
  }],
  "organization": {
    "id": "53c050ac51c69003200aa998",
    "name": "Cleveland Clinic",
    "href": "/medical/organizations/53c050ac51c69003200aa998"
  }
}]
 
Suggest Edits

Organizations

Get basic medical organization data in Human API associated with the user

 
gethttps://api.humanapi.co/v1/human/medical/organizations/id

Response Properties

Property
Type
Description

id

String

The id of the resource

name

String

The name of the organization

Organization Object (from other endpoints)

Property
Type
Description

id

String

The id of the resource

name

String

The name of the organization

href

String

Human API organizations endpoint URL to retrieve full details

# Get an organization by id
curl -H "Authorization: Bearer someToken" "https://api.humanapi.co/v1/human/medical/organizations/54dc427aaa6b4cb7d6203061"
A binary file was returned

You couldn't be authenticated

{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
{
  "id": "54dc427aaa6b4cb7d6203061",
  "name": "Cleveland Clinic"
}
 
Suggest Edits

Plans of Care

Get a list of medical plans of care associated with the user

 
gethttps://api.humanapi.co/v1/human/medical/plans_of_care

Response Properties

Property
Type
Description

id

String

The id of the resource

source

String

The name of the originating service

updatedAt

Date

The time the record was updated on the Human API server

createdAt

Date

The time the record was created on the Human API server

name

String

The name of the plan of care

text

String

The text description of the author

date

Date

The date of the plan of care

type

String

The type of the plan of care

specialty

String

(optional) The specialty of the plan of care

provider

Object

See provider object

organization

Object

See organizations object

codes

Array[Object]

See codes

Provider Object

Property
Type
Description

name

Object

See name object

address

String

(optional) Address of the provider e.g. "CORE ORTHOPEDICS, SIOUX FALLS, SD, 57103"

# Get all plans of care associated with the user
curl -H "Authorization: Bearer someToken" "https://api.humanapi.co/v1/human/medical/plans_of_care"
A binary file was returned

You couldn't be authenticated

{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
# Returns a json array of plans of care:
[ {
    "id": "55e692540c7deefb7cfe90f7",
    "createdAt": "2014-09-01T20:46:35.731Z",
    "updatedAt": "2014-09-01T20:46:35.731Z",
    "source": "emr-1-320",
    "name": "encounter",
    "text": "11/13/2015 Appointment Physical Therapy ",
    "organization": {
        "href": "/medical/organizations/53c050ac51c69003200aa998",
        "id": "53c050ac51c69003200aa998",
        "name": "Cleveland Clinic"
    },
    "codes": []
} ]
 
Suggest Edits

Problems

Get a list of medical problems the user has had so far

 
gethttps://api.humanapi.co/v1/human/medical/issues

Response Properties

Property
Type
Description

id

String

The id of the resource

source

String

The name of the originating service

updatedAt

Date

The time the record was updated on the Human API server

createdAt

Date

The time the record was created on the Human API server

name

String

The name of the problem e.g. "Generalized abdominal pain"

patient

Object

Patient information (“name” and other optional attributes)

status

String

Status of the problem e.g. "Active"

organization

Object

See organizations object

codes

Array[Object]

See codes

# Get all problems associated with the user
curl -H "Authorization: Bearer someToken" "https://api.humanapi.co/v1/human/medical/issues"
A binary file was returned

You couldn't be authenticated

{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
# Returns a json array of problems:
[
    {
        "codes": [
            {
                "code": "6142004",
                "codeSystem": "2.16.840.1.113883.6.96",
                "codeSystemName": "SNOMED-CT",
                "name": "Influenza"
            }
        ],
        "createdAt": "2014-10-19T21:02:17.949Z",
        "dateTime": "2014-08-29T04:00:00.000Z",
        "id": "5443d6ca71b5c7f1a243879f",
        "name": "Influenza",
        "organization": {
            "href": "/medical/organizations/54dc427aaa6b4cb7d6203061",
            "id": "54dc427aaa6b4cb7d6203061",
            "name": "Cleveland Clinic"
        },
        "patient": {},
        "source": "emr-1-320",
        "updatedAt": "2014-10-19T21:02:17.949Z"
    },
    {
        "codes": [
            {
                "code": "729.89",
                "codeSystem": "2.16.840.1.113883.6.103",
                "codeSystemName": "ICD-9CM",
                "name": "WEAKNESS OF LEFT LEG"
            },
            {
                "code": "R53.1",
                "codeSystem": "2.16.840.1.113883.6.90",
                "codeSystemName": "ICD-10-CM",
                "name": "WEAKNESS OF LEFT LEG"
            }
        ],
        "createdAt": "2014-10-19T21:02:17.949Z",
        "dateTime": "2011-05-02T04:00:00.000Z",
        "id": "5443d6ca71b5c7f1a243879e",
        "name": "Pain in left leg",
        "organization": {
            "href": "/medical/organizations/54dc427aaa6b4cb7d6203061",
            "id": "54dc427aaa6b4cb7d6203061",
            "name": "Cleveland Clinic"
        },
        "patient": {},
        "source": "emr-1-320",
        "updatedAt": "2014-10-19T21:02:17.949Z"
    },
    {
        "codes": [
            {
                "code": "38341003",
                "codeSystem": "2.16.840.1.113883.6.96",
                "codeSystemName": "SNOMED-CT",
                "name": "Hypertensive disorder"
            }
        ],
        "createdAt": "2014-10-19T21:02:17.949Z",
        "dateTime": "2011-03-02T05:00:00.000Z",
        "id": "5443d6ca71b5c7f1a24387a0",
        "name": "Hypertensive disorder",
        "organization": {
            "href": "/medical/organizations/54dc427aaa6b4cb7d6203061",
            "id": "54dc427aaa6b4cb7d6203061",
            "name": "Cleveland Clinic"
        },
        "patient": {},
        "source": "emr-1-320",
        "updatedAt": "2014-10-19T21:02:17.949Z"
    }
]
 
Suggest Edits

Procedures

Get a list of medical procedures associated with the user

 
gethttps://api.humanapi.co/v1/human/medical/procedures

Response Properties

Property
Type
Description

id

String

The id of the resource

source

String

The name of the originating service

updatedAt

Date

The time the record was updated on the Human API server

createdAt

Date

The time the record was created on the Human API server

dateTime

Date

(optional) The date of the procedure

source

String

The name of the originating service

device

String

(optional) Device Note: presence of this value is rare

deviceCodes

Array[Object]

Device codes Note: presence of this value is rare

name

String

Name of the procedure

performer

Object

See performer information)

specimen

String

(optional) Specimen related to the procedure (if applicable) Note: presence of this value is rare

specimenCodes

Array[Object]

Specimen codes Note: presence of this value is rare

organization

Object

See organizations object

codes

Array[Object]

See codes

Performer Object

Property
Type
Description

address

String

Address of the performer

organizationName

String

Name of the performer’s organization

phone

String

Phone number of the performer

# Get all procedures associated with the user
curl -H "Authorization: Bearer someToken" "https://api.humanapi.co/v1/human/medical/procedures"
A binary file was returned

You couldn't be authenticated

{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
# Returns a json array of procedures:
[
    {
        "id": "55e692d20c7deefb7cfe90f8",
        "createdAt": "2014-09-01T21:42:09.969Z",
        "updatedAt": "2014-09-01T21:42:10.072Z",
        "dateTime": "2014-02-11T09:30:00.000Z",
        "source": "emr-1-320",
        "device": null,
        "deviceCodes": [],
        "name": "HCHG CYSTOURETHROSCOPY",
        "organization": {
            "href": "/medical/organizations/53c050ac51c69003200aa998",
            "id": "53c050ac51c69003200aa998",
            "name": "Cleveland Clinic"
        },
        "performer": {
            "address": null,
            "organizationName": null,
            "phone": null
        },
        "specimen": null,
        "specimenCodes": [],
        "codes": [
            {
                "code": "52000",
                "codeSystem": "2.16.840.1.113883.6.12",
                "codeSystemName": "CPT-4",
                "name": "HCHG CYSTOURETHROSCOPY"
            }
        ]
    }
]
 
Suggest Edits

Profile

Get the medical health profile of the user. This includes observations about the user such as demographics, smoking status, alcohol use, etc.

 
gethttps://api.humanapi.co/v1/human/medical/profile

Response Properties

Property
Type
Description

id

String

The id of the resource

source

String

The name of the originating service

updatedAt

Date

The time the record was updated on the Human API server

createdAt

Date

The time the record was created on the Human API server

demographics

Object

See demographics

alcohol

Object

The user’s alcohol usage

smoking

Object

The user’s smoking habits

Demographics Object

Property
Type
Description

address

Object

See address object

dob

String

The user’s date of birth e.g. "04/21/1965"

ethnicity

String

The ethnicity of the user e.g. "Not Hispanic of Latino"

gender

String

The user’s gender e.g. "male"

language

String

The user’s primary language e.g. "eng"

maritalStatus

String

The user’s marital status (eg: “married”, “single”)

name

Object

See name object

race

String

The user’s race e.g. "White"

ethnicityCodes

Array[Object]

CDC Race & Ethnicity and SNOMED CT Ethnicity codes: See codes

maritalStatusCodes

String

SNOMED CT Marital status codes: see codes object

genderCodes

String

SNOMED CT Gender codes: See codes

Address Object

Property
Type
Description

city

String

City of address e.g. "SAN FRANCISCO"

country

String

Country of address e.g. "US"

state

String

State of address e.g. "CA"

street

Array[String]

Street of address e.g. ["156 22ND AVE NW"]

zip

String

Zip of address e.g. "94123"

Alcohol Object

Property
Type
Description

use

String

The user’s alcohol usage e.g. “yes”, “no”

codes

Array[Object]

SNOMED CT Alcohol use codes: See codes

Smoking

Property
Type
Description

status

String

The user’s smoking status (e.g. “Never Smoker”)

codes

Array[Object]

SNOMED CT Smoking use codes: See codes

# Get user's medical profile
curl -H "Authorization: Bearer someToken" "https://api.humanapi.co/v1/human/medical/profile"
A binary file was returned

You couldn't be authenticated

{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
# Returns a json object as profile:
{
  "id": "54e344fa79192a2e4993dfda",
  "updatedAt": "2015-02-13T21:27:42.078Z",
  "createdAt": "2015-02-13T21:27:42.078Z",
  "demographics": {
    "address": {
      "city": "Vulcun City",
      "country": "USA",
      "state": "CA",
      "street": ["1 Milky way"],
      "zip": "94025"
    },
    "ethnicity": "Non Hispanic",
    "gender": "male",
    "language": "ENG",
    "maritalStatus": "married",
    "race": "White/Caucasian",
    "dob": "03-05-1985",
    "name": {
      "family": "Forrest",
      "given": ["Maxwell"]
    },
    "ethnicityCodes": [
      {
        "code" : "2186-5",
        "codeSystemName" : "RACE&ETHNICITY-CDC"
        "inferred" : true
      },
      {
        "code" : "2131-1",
        "codeSystemName" : "RACE&ETHNICITY-CDC",
        "inferred" : true
      },
      {
        "code" : "413655005",
        "codeSystemName" : "SNOMED-CT",
        "inferred" : true
      },
      {
        "code" : "413774005",
        "codeSystemName" : "SNOMED-CT",
        "inferred" : true
      }
    ],
    "maritalStatusCodes": [
      {
        "code" : "87915002",
        "codeSystemName" : "SNOMED-CT",
        "inferred" : true
      }
    ],
    "genderCodes": [
      {
        "code" : "703117000",
        "codeSystemName" : "SNOMED-CT",
        "inferred" : true
      }
    ]
  },
  "alcohol": {
    "use": "yes",
    "codes": [
      {
        "code" : "704197006",
        "codeSystemName" : "SNOMED-CT",
        "inferred" : true
      }
    ]
  },
  "smoking": {
    "status": "Never smoker",
    "codes": [
      {
        "code" : "266919005",
        "codeSystemName" : "SNOMED-CT",
        "inferred" : true
      }
    ]
  }
}
 
Suggest Edits

Test Results

Get a list of medical lab results for a user.

 
gethttps://api.humanapi.co/v1/human/medical/test_results

Response Properties

Property
Type
Description

id

String

The id of the resource

source

String

The name of the originating service

updatedAt

Date

The time the record was updated on the Human API server

createdAt

Date

The time the record was created on the Human API server

components

Array[Object]

A list of components of the test (See component below)

name

String

The name of the test preformed e.g. ‘COMPREHENSIVE METABOLIC PANEL’, 'LIPID PANEL’, 'URINE CULTURE’

device

String

(optional) Device name Note: presence of this value is rare

deviceCodes

Array[Object]

(optional) Device codes Note: presence of this value is rare

patient

Object

Patient information (“name” and other optional attributes)

specimen

String

(optional) Specimen related to the procedure Note: presence of this value is rare

orderedBy

String

(optional) The name of the ordering physician or entity

recipients

Array[Object]

See recipient object Note: presence of this value is rare

resultDateTime

Date

The date of the test result

status

String

(optional) The status of the test result (e.g. 'Final result’, 'Edited’, 'Edited Result - FINAL’)

allResults

Array[Object]

[Deprecated] Use components instead

comments

String

(optional) Comments for the test result

narrative

String

(optional) Narrative for the test result

impression

String

(optional) Impression for the test result

transcriptions

String

(optional) Transcriptions for the test result

codes

Array[Object]

See codes

Component Object

Property
Type
Description

name

String

The name of the test component (e.g. 'Potassium’, 'MCHC’, 'MCV’)

value

String

The test result value

unit

String

(optional) The unit of the value - e.g. 'mg/dL’, ’%’, 'mmol/L’

low

String

(optional) The low value for the component

high

String

(optional) The high value for the component

refRange

String

(optional) The reference range for the value - if provided (e.g. 'Negative’, ’>60’, ’<150’)

componentComments

String

(optional) Comments provided for the component

codes

Array[Object]

See codes

Recipient Object

Property
Type
Description

objectID

String

The id of the recipient e.g. "856983"

name

String

The name of the recipient

isPCP

Boolean

Indicates if the provider is the Primary Care Provider of the user e.g. true

recipTemplate

String

The recipient template e.g. 'WPMessageRecipientTemplateUnknown’

# Get all test results associated with the user
curl -H "Authorization: Bearer someToken" "https://api.humanapi.co/v1/human/medical/test_results"
A binary file was returned

You couldn't be authenticated

{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
# Returns a json array of test results:
[  {
    "allResults": [ ],
    "components": [
        {
            "codes": [],
            "high": "8.3",
            "low": "5.7",
            "name": "Protein Total, Serum",
            "unit": "g/dL",
            "value": "7.1"
        },
        {
            "codes": [],
            "high": "5.0",
            "low": "3.4",
            "name": "Albumin (Serum)",
            "unit": "g/dL",
            "value": "4.3"
        },
        {
            "codes": [],
            "high": "3.9",
            "low": "1.8",
            "name": "Globulin Serum",
            "unit": "g/dL",
            "value": "2.8"
        }
    ],
    "codes": [
        {
            "codeSystem": "2.16.840.1.113883.6.1",
            "codeSystemName": "LOINC",
            "name": "DIAGNOSIS"
        }
    ],
    "createdAt": "2014-10-30T21:02:17.956Z",
    "id": "546d44478a6d23e01a72865a",
    "name": "LAB TOTAL PROTEIN+ALB",
    "orderedBy": "James Kirk, MD",
    "organization": {
        "href": "/medical/organizations/53c050ac51c69003200aa998",
        "id": "53c050ac51c69003200aa998",
        "name": "Cleveland Clinic"
    },
    "patient": {
        "name": "Maxwell Forrest"
    },
    "recipients": [
        {
            "isPCP": true,
            "name": "Jean-Luc Picard, MD",
            "objectID": "50006",
            "recipTemplate": "WPMessageRecipientTemplateUnknown"
        }
    ],
    "resultDateTime": "2010-09-10T04:00:00.000Z",
    "source": "emr-1-320",
    "status": "Final result",
    "updatedAt": "2014-10-20T21:02:17.956Z"
}]
 
Suggest Edits

Vitals

Get the user’s vitals readings

 
gethttps://api.humanapi.co/v1/human/medical/vitals

Response Properties

Property
Type
Description

id

String

The Id of the resource

source

String

The name of the originating service

updatedAt

Date

The time the record was updated on the Human API server

createdAt

Date

The time the record was created on the Human API server

dateTime

String

(optional) The date of the vitals reading

author

String

The name of the vitals reading author (e.g. doctor)

results

Array[Object]

A list of all test results (see results object)

organization

Object

See organizations object

Results Object

Property
Type
Description

name

String

The name of the test component e.g. ‘HEIGHT’, 'WEIGHT’, 'BODY TEMPERATURE’

value

String

The test result value

unit

String

(optional) The unit of the value - if provided e.g. 'kg’, ’%’, 'Cel’

codes

Array[Object]

See codes

normalizedName

String

(optional) The normalized name of the measurement e.g. "Body Mass Index (BMI)"

# Get all vitals readings associated with the user
curl -H "Authorization: Bearer someToken" "https://api.humanapi.co/v1/human/medical/vitals"
A binary file was returned

You couldn't be authenticated

{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
# Returns a json array of vitals:
[
    {
        "author": "Maxwell Forrest",
        "createdAt": "2014-09-02T05:50:22.654Z",
        "dateTime": "2014-08-18T16:04:00.000Z",
        "id": "55e6914a0c7deefb7cfe90f6",
        "organization": {
            "href": "/medical/organizations/53c050ac51c69003200aa998",
            "id": "53c050ac51c69003200aa998",
            "name": "Cleveland Clinic"
        },
        "results": [
            {
                "codes": [
                    {
                        "code": "8480-6",
                        "codeSystem": "2.16.840.1.113883.6.1",
                        "codeSystemName": "LOINC",
                        "name": "SYSTOLIC BLOOD PRESSURE"
                    }
                ],
                "name": "SYSTOLIC BLOOD PRESSURE",
                "unit": "mm[Hg]",
                "value": "102"
            },
            {
                "codes": [
                    {
                        "code": "8462-4",
                        "codeSystem": "2.16.840.1.113883.6.1",
                        "codeSystemName": "LOINC",
                        "name": "DIASTOLIC BLOOD PRESSURE"
                    }
                ],
                "name": "DIASTOLIC BLOOD PRESSURE",
                "unit": "mm[Hg]",
                "value": "70"
            },
            {
                "codes": [
                    {
                        "code": "8867-4",
                        "codeSystem": "2.16.840.1.113883.6.1",
                        "codeSystemName": "LOINC",
                        "name": "HEART RATE"
                    }
                ],
                "name": "HEART RATE",
                "unit": "/min",
                "value": "80"
            },
            {
                "codes": [
                    {
                        "code": "8302-2",
                        "codeSystem": "2.16.840.1.113883.6.1",
                        "codeSystemName": "LOINC",
                        "name": "HEIGHT"
                    }
                ],
                "name": "HEIGHT",
                "unit": "cm",
                "value": "157.5"
            },
            {
                "codes": [
                    {
                        "code": "3141-9",
                        "codeSystem": "2.16.840.1.113883.6.1",
                        "codeSystemName": "LOINC",
                        "name": "WEIGHT"
                    }
                ],
                "name": "WEIGHT",
                "unit": "kg",
                "value": "61.871"
            },
            {
                "codes": [
                    {
                        "code": "39156-5",
                        "codeSystem": "2.16.840.1.113883.6.1",
                        "codeSystemName": "LOINC",
                        "name": "BODY MASS INDEX"
                    }
                ],
                "name": "BODY MASS INDEX",
                "unit": "kg/m2",
                "value": "24.94"
            }
        ],
        "source": "emr-1-320",
        "updatedAt": "2014-09-02T05:50:22.654Z"
    }
]
 
Suggest Edits

CCD

Returns full CCDs available for the user including the raw xml

 
gethttps://api.humanapi.co/v1/human/medical/ccds

Click here for full XML example (Chrome or Firefox only)

Returns single CCD raw payload in XML format
GET https://api.humanapi.co/v1/human/medical/ccds/{id}/raw

Response Properties

Property
Type
Description

id

String

The id of the resource

source

String

The name of the originating service

updatedAt

Date

The time the record was updated on the Human API server

createdAt

Date

The time the record was created on the Human API server

dateTime

String

The date of the CCD

author

String

CCD author’s name

organization

Object

See organizations object

Response Headers (Raw CCD)

Header
Value

Content-Type

text/xml

# Get all ccds associated with the user
curl -H "Authorization: Bearer someToken" "https://api.humanapi.co/v1/human/medical/ccds"
A binary file was returned

You couldn't be authenticated

{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
# Returns a json array of ccds:
[{
  "id": "54e35f5de0b3d53af2c65921",
  "source": "emr-1-320",
  "updatedAt": "2015-02-17T16:54:24.778Z",
  "createdAt": "2015-02-10T00:09:36.679Z",
  "dateTime": "2014-04-14T18:38:44.000Z",
  "author": "John Smith",
  "organization": {
    "id": "53c050ac51c69003200aa998",
    "name": "Cleveland Clinic",
    "href": "/medical/organizations/53c050ac51c69003200aa998"
  }
}]
 
Suggest Edits

Demographics

Get a list of demographics data associated with the user

 
gethttps://api.humanapi.co/v1/human/medical/demographics

Response Properties

Property
Type
Description

id

String

Id of the resource

updatedAt

Date

Time the record was updated on the Human API server

createdAt

Date

Time the record was created on the Human API server

name

Object

See name object

dob

String

Date of birth of the patient e.g. "05/20/1971"

dobDateTime

String

Date of birth of the patient e.g. "1971-05-20T00:00:00.000Z"

ethnicity

String

Ethnicity of the patient e.g. "Not Hispanic or Latino"

ethnicityCodes

Array[Object]

CDC Race & Ethnicity and SNOMED CT Ethnicity codes: See codes

gender

String

Gender of the patient e.g. "male"

genderCodes

Array[Object]

SNOMED CT Gender codes: See codes

language

String

Preferred spoken language of the patient e.g. "eng"

languageCodes

Array[Object]

SNOMED CT Language codes: See codes

martialStatus

String

Marital status of the patient e.g. "married"

maritalStatusCodes

Array[Object]

SNOMED CT Martial codes: See codes

provider

Object

See Provider Object details below

organization

Object

See organizations

race

String

Race of the patient e.g. "White"

raceCodes

Array[Object]

SNOMED CT Martial codes: See codes

codes

Array[Object]

See codes

ccd

Object

See CCD Object details below

CCD Object

Property
Type
Description

href

String

Link to a more detailed CCD object

id

String

id of the CCD

Provider Object

Property
Type
Description

organization

String

The name of the medical source

address

Object

See Address Object below

Address Object (from Provider Object)

Property
Type
Description

city

String

City of the provider e.g. "San Francisco"

country

String

Country of the provider e.g. "USA"

state

String

State of the provider e.g. "CA"

zip

String

Zip code of the provider e.g. "94156"

street

Array[String]

Street and number of the address e.g. '["123 Lucas Drive"]'

# Get all demographics data associated with the user
# Note that the demo access token currently returns an empty array. The results in the JSON tab are fictional values. 
curl -H "Authorization: Bearer someToken" "https://api.humanapi.co/v1/human/medical/demographics"
A binary file was returned

You couldn't be authenticated

{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
# Returns a json array of demographics:
[
    {
        "address": {
            "city": "SAN FRANCISCO",
            "country": "USA",
            "state": "CA",
            "street": [
                "123 Lucas Drive"
            ],
            "zip": "95131"
        },
        "ccd": {
            "href": "/medical/ccds/5b3056dd711be0bff640e105",
            "id": "5c3056db711b20bff610e105"
        },
        "createdAt": "2018-07-12T20:16:36.159Z",
        "dob": "05/20/1971",
        "dobDateTime": "1971-05-20T00:00:00.000Z",
        "ethnicity": "Not Hispanic or Latino",
        "ethnicityCodes": [
            {
                "code": "2186-5",
                "codeSystemName": "RACE&ETHNICITY-CDC",
                "inferred": true
            },
            {
                "code": "2131-1",
                "codeSystemName": "RACE&ETHNICITY-CDC",
                "inferred": true
            }
        ],
        "gender": "male",
        "genderCodes": [
            {
                "code": "703117000",
                "codeSystemName": "SNOMED-CT",
                "inferred": true
            }
        ],
        "id": "5b47b7344e72eb0022b9b5a2",
        "language": "eng",
        "languageCodes": [
            {
                "code": "315570003",
                "codeSystemName": "SNOMED-CT",
                "inferred": true
            }
        ],
        "maritalStatus": "married",
        "maritalStatusCodes": [
            {
                "code": "87915002",
                "codeSystemName": "SNOMED-CT",
                "inferred": true
            }
        ],
        "name": {
            "family": "Archer",
            "given": [
                "Archer",
                "B"
            ]
        },
        "organization": {
            "href": "/medical/organizations/54dc427aaa6b4cb7d620302f",
            "id": "54dc427aaa6b4cb7d620302f",
            "name": "Starfleet Medical"
        },
        "provider": {
            "address": {
                "city": "San Francisco",
                "country": "USA",
                "state": "CA",
                "zip": "94156"
            },
            "organization": "Starfleet Medical"
        },
        "race": "White",
        "raceCodes": [
            {
                "code": "185984009",
                "codeSystemName": "SNOMED-CT",
                "inferred": true
            },
            {
                "code": "2106-3",
                "codeSystemName": "RACE&ETHNICITY-CDC",
                "inferred": true
            }
        ],
        "updatedAt": "2018-07-12T20:16:36.159Z"
    }
]
 
Suggest Edits

Sources

The Sources endpoint returns the synchronization status of the different sources that a specific user has connected.

 

Returns a sources array
GET https://api.humanapi.co/v1/human/sources

Response Properties

Property
Type
Description

source

String

Name or id of the connected source (all lowercase, no spaces)

supportedDataTypes

Array[String]

(Deprecated) List of data types supported by the source

devices

Array[String]

(Deprecated) List of devices or medical source id (when available)

id

String

Non-unique id for an external data account

connectedSince

Date

Date that the source was connected to Human API

sourceName

String

Name of medical source (only for medical sources)

historySync

Object

See historySync object

syncStatus

Object

See syncStatus object

resync

Object

See resync object

organization

Object

See organization object

historySync Object

Property
Type
Description

status

String

Status of the historical sync

oldestDate

Date

Oldest date of the data retrieved from the service

For some services, oldestDate is just an indication of how far back the synchronization tasks attempted to retrieve data.

syncStatus Object

Property
Type
Description

status

String

Status of the most recent sync

synchedAt

Date

The last time the synchronization task ran for this user

newestDate

Date

(Deprecated) The timestamp of the most recently retrieved data

details

String

Identifies details about the status property when appropriate

resync Object

Property
Type
Description

active

Boolean

Identifies if the data source belonging to the user has continuous capability

# Returns a json object of sources:
// example
[
	{
    "id": "551ac6ef15eab1445e527c64",
    "source": "55a83bdc8d1eb1420aa1a71b",
    "sourceName": "Starfleet Medical",
    "supportedDataTypes": [
    ], // deprecated supportedDataTypes property
    "devices": [
			"55a83bdc8d1eb1420aa1a71b"
    ], // deprecated devices property 
    "connectedSince": "2018-07-20T21:07:13.136Z",
    "historySync": {
        "status": "completed",
        "oldestDate": "2015-03-21T00:00:00.000Z"
    },
    "organization": {
      "href": "/medical/organizations/55a83bdc8d1eb1420aa1a71b",
      "id": "55a83bdc8d1eb1420aa1a71b",
      "name": "Starfleet Medical"
    },
    "resync" : {
      "active" : true
    },
    "syncStatus": {
        "status": "ok",
        "details" : "ok",
        "synchedAt": "2018-07-20T21:07:13.136Z",
        "newestDate": "2018-04-20T19:06:11.151Z"
    }
  }
]
 
# Get sources measurement associated with the user
curl -H "Authorization: Bearer demo" "https://api.humanapi.co/v1/human/sources"