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

Response Properties

📘

HTTP response 404

The profile endpoint may return a 404 response when there is no profile data to return.

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

(optional) See demographics

alcohol

Object

(optional) The user’s alcohol usage

smoking

Object

(optional) The user’s smoking habits

Demographics Object

Property

Type

Description

address

Object

See address object

dob

String

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

ethnicity

String

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

gender

String

(optional) The user’s gender e.g. "male"

language

String

(optional) The user’s primary language e.g. "eng"

maritalStatus

String

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

name

Object

(optional) See name object

race

String

(optional) The user’s race e.g. "White"

ethnicityCodes

Array[Object]

(optional) CDC Race & Ethnicity and SNOMED CT Ethnicity codes: See codes

maritalStatusCodes

String

(optional) SNOMED CT Marital status codes: see codes object

genderCodes

String

(optional) SNOMED CT Gender codes: See codes

Address Object

Property

Type

Description

city

String

(optional) City of address e.g. "SAN FRANCISCO"

country

String

(optional) Country of address e.g. "US"

state

String

(optional) State of address e.g. "CA"

street

Array[String]

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

zip

String

(optional) Zip of address e.g. "94123"

Alcohol Object

Property

Type

Description

use

String

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

codes

Array[Object]

(optional) 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

Language