/ patient : Prevent API

####The Prevent API returns patient-specific recommendations for healthy behavior change

How it works

1

Create a secure identifier

2

Assemble a systems view of your patient's health

3

Generate personalized lifestyle and wellness recs

API specifications

create a unique system_ID for your patient

System does not store any protected health information (PHI) or personally identifiable information (PII) in our data. Read about our security measures.

Create a new patient

post

Create a new patient.

Authorizations

APIKeyHeader

x-api-keystringRequired

Body

application/json

Patient Input Model.

unique_patient_identifierstringRequired

Unique Patient Identifier

Responses

201

System Patient ID

application/json

400

Bad Request

422

Unprocessable Entity

post

/v1/patient

HTTPcURLJavaScriptPython

POST /v1/patient HTTP/1.1
Host: cg-api-dev.system.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "unique_patient_identifier": "text"
}

{
  "system_id": "text"
}

submit de-identified patient data to generate recs

FHIR-interoperable or customized schemas for patient_biomarkers & _history

• If customized, schemas will be included in user portal.

Get recommendations for a patient

post

Get recommendations for a patient.

Authorizations

APIKeyHeader

x-api-keystringRequired

Path parameters

system_idstringRequired

Body

application/json

Schema for Assemble API input.

patient_system_idstringRequired

System ID of the patient.

patient_biomarkersany ofOptional

Dictionary of biomarker results. Expected keys: value and unit. Can be nested.

objectOptional

or

nullOptional

patient_historyany ofOptional

Dictionary of relevant patient history (in the form of questionnaire answers). Expecting 'flat' dictionary.

or

nullOptional

patient_demographicsany ofOptional

or

nullOptional

Responses

200

Recommendations for a patient

application/json

400

Bad Request

422

Unprocessable Entity

post

/v1/patient/{system_id}

HTTPcURLJavaScriptPython

POST /v1/patient/{system_id} HTTP/1.1
Host: cg-api-dev.system.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 263

{
  "patient_system_id": "text",
  "patient_biomarkers": {},
  "patient_history": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "Answer": {
          "Value": "text",
          "$type": "text"
        },
        "EnglishLabel": "text",
        "Label": "text",
        "LanguageCode": "text",
        "QuestionId": "text"
      }
    ]
  },
  "patient_demographics": {
    "sex": 1,
    "age": 1
  }
}

{
  "summary": "text",
  "recommendations": [
    {
      "system_id": "text",
      "modifiable_factor_name": "text",
      "category": "text",
      "rank": 1,
      "notable_targets": [
        {
          "system_id": "text",
          "notable_target_name": "text",
          "system_relationship": {
            "relationship_id": "text",
            "num_findings": 1,
            "num_significant_findings": 1,
            "num_studies": 1,
            "num_experimental_trials": 1,
            "study_dois": [
              "text"
            ]
          }
        }
      ]
    }
  ],
  "recommendations_by_category": [
    {
      "system_id": "text",
      "modifiable_factor_name": "text",
      "category": "text",
      "rank": 1,
      "notable_targets": [
        {
          "system_id": "text",
          "notable_target_name": "text",
          "system_relationship": {
            "relationship_id": "text",
            "num_findings": 1,
            "num_significant_findings": 1,
            "num_studies": 1,
            "num_experimental_trials": 1,
            "study_dois": [
              "text"
            ]
          }
        }
      ],
      "rank_in_category": 1
    }
  ],
  "prevent_version": "text"
}

# Example API Call using the Python requests package

requests.post(
    url=f"{<API_URL>}/{<SYSTEM_ID>}",
    headers={'x-api-key': <API_KEY>},
    data=json.dumps(
    {
      "patient_system_id": <system_id>,
      "patient_biomarkers": sample_biomarker_data,
      "patient_history": sample_questionnaire_data,
      "patient_demographics": sample_demographic_data
    }
  )
)

Data security

To make a patient-specific requests, developers must first generate a unique system_ID for each patient. This ensures that no requests include the patient’s original identifiers, which may contain or be linkable to personally identifiable information (PII). Instead, we store an encrypted representation of the original identifier along with the associated System ID. This is used exclusively to track the number of unique patient API calls and to support traceability and observability in case providers need to audit their use of the System Clinical Graph APIs.

Developers are responsible for maintaining a crosswalk between their internal patient identifiers and the corresponding System IDs. We do not store the original patient identifiers in any form.