This report provides a summary representation of Human API-collected data pertaining to a connected patient's Covid test results and/or immunizations.

Response Properties


If no pertinent data is available, we will assign an empty string or null value.

createdAtDateThe time the record was created on the Human API server
nameStringName of the patient
ageNumberAge of the patient
dobDatetimeDate of birth of the patient (e.g. 1981-05-21T00:00:00.000Z)
ItemsArrayAn array of test result or immunization items. See below for details on the content of each type.

Item (Test Result)

typeStringIdentifies the data type associated with the data record (e.g. "testResult")
testDateDatetime[deprecated - use collectionDate and collectionTimeStamp] Identifies when the test was performed (e.g. "2020-09-14T17:48:00.000Z")
testTypeStringIdentifies the testing method for Covid (e.g. "PCR")
resultStringReturns the results of the individual test (e.g. "Negative")
collectionDateDateThe date when the test/lab was taken (YYYY-MM-DD, e.g. "2021-04-16")
collectionDateTimeTimestampThe date and time when the test/lab was taken (e.g. "2021-04-15T13:54:00.000Z")
testMethodStringThe method that the test was taken (e.g. "Probe.amp.tar")
dataObjectContains details about the individual Covid test result

Item (Immunization)

cvxCodeStringMedical code associated with the immunization (e.g. "208")
immunizationDatesArrayContains one or many dateTime stamps related to a Covid immunization, which suggests one or multiple vaccine doses recorded (e.g. [ "2020-12-22T00:00:00.000Z", "2021-01-16T00:00:00.000Z"])
vendorStringManufacturer of the vaccine provided to the patient
typeStringData type associated with the data record e.g. "immunization"
dosesNumberHow many doses the immunization will require
immunizationTypeStringBiological mechanism of the vaccination (e.g. "mRNA")
vaccineNameStringFormal name of the vaccination (e.g. "BNT-162b2")
evidenceTypeStringData type that the record was originally logged as (e.g. "medication")
dataObjectDetails about the individual Covid immunization

Data (object)

nameStringFull name or description of the individual immunization (e.g. "Pfizer SARS-COV-2 (COVID-19) vaccine, mRNA, spike protein, LNP, preservative free, 30 mcg/0.3mL dose")
idStringid of the record (e.g. "607caf7581a1517a30af6eb1")
sourceStringid of the data source (e.g. "5ce7cb45d28ec72cacb63277")
datesArrayArray of string datetime stamps (e.g. ["2021-04-12T00:00:00.000Z","2020-03-19T00:00:00.000Z"])
patientObjectProfile data on the patient involved such as name
updatedAtStringDatetime stamp when the record was updated at Human API
createdAtStringDatetime stamp when the record was created at Human API
codesArray(optional) (See codes)
organizationObjectSee Organizations
ccdObjectContains "id" and "href" values that point to the source ccd file when available(e.g. "ccd": {"id": "607caf7581a151727eaf6eed", "href": "/medical/ccds/607caf7581a151727eaf6eed"})