get
https://api.humanapi.co/v1/human/medical/reports/covid_report_id/raw?format=json
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.
| Property | Type | Description |
|---|---|---|
| createdAt | Date | The time the record was created on the Human API server |
| name | String | Name of the patient |
| age | Number | Age of the patient |
| dob | Datetime | Date of birth of the patient (e.g. 1981-05-21T00:00:00.000Z) |
| Items | Array | An array of test result or immunization items. See below for details on the content of each type. |
Item (Test Result)
| Property | Type | Description |
|---|---|---|
| type | String | Identifies the data type associated with the data record (e.g. "testResult") |
| testDate | Datetime | [deprecated - use collectionDate and collectionTimeStamp] Identifies when the test was performed (e.g. "2020-09-14T17:48:00.000Z") |
| testType | String | Identifies the testing method for Covid (e.g. "PCR") |
| result | String | Returns the results of the individual test (e.g. "Negative") |
| collectionDate | Date | The date when the test/lab was taken (YYYY-MM-DD, e.g. "2021-04-16") |
| collectionDateTime | Timestamp | The date and time when the test/lab was taken (e.g. "2021-04-15T13:54:00.000Z") |
| testMethod | String | The method that the test was taken (e.g. "Probe.amp.tar") |
| data | Object | Contains details about the individual Covid test result |
Item (Immunization)
| Property | Type | Description |
|---|---|---|
| cvxCode | String | Medical code associated with the immunization (e.g. "208") |
| immunizationDates | Array | Contains 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"]) |
| vendor | String | Manufacturer of the vaccine provided to the patient |
| type | String | Data type associated with the data record e.g. "immunization" |
| doses | Number | How many doses the immunization will require |
| immunizationType | String | Biological mechanism of the vaccination (e.g. "mRNA") |
| vaccineName | String | Formal name of the vaccination (e.g. "BNT-162b2") |
| evidenceType | String | Data type that the record was originally logged as (e.g. "medication") |
| data | Object | Details about the individual Covid immunization |
Data (object)
| Property | Type | Description |
|---|---|---|
| name | String | Full 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") |
| id | String | id of the record (e.g. "607caf7581a1517a30af6eb1") |
| source | String | id of the data source (e.g. "5ce7cb45d28ec72cacb63277") |
| dates | Array | Array of string datetime stamps (e.g. ["2021-04-12T00:00:00.000Z","2020-03-19T00:00:00.000Z"]) |
| patient | Object | Profile data on the patient involved such as name |
| updatedAt | String | Datetime stamp when the record was updated at Human API |
| createdAt | String | Datetime stamp when the record was created at Human API |
| codes | Array | (optional) (See codes) |
| organization | Object | See Organizations |
| ccd | Object | Contains "id" and "href" values that point to the source ccd file when available(e.g. "ccd": {"id": "607caf7581a151727eaf6eed", "href": "/medical/ccds/607caf7581a151727eaf6eed"}) |