Skip to main content
DELETE
/
api
/
v1
/
patients
/
{patient_id}
/
risk_factors
/
{risk_factor_id}
Deactivate a risk factor
curl --request DELETE \
  --url https://api.byblend.com/api/v1/patients/{patient_id}/risk_factors/{risk_factor_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
  "created_at": "2025-03-15T12:00:00Z",
  "updated_at": "2025-03-15T12:00:00Z",
  "risk_factor_id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
  "confidence": 0.95,
  "is_active": true,
  "match_source": "autocomplete",
  "match_type": "product",
  "matched": true,
  "matched_via_synonym": false,
  "patient_id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
  "risk_factor_text_id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
  "text_chunk": "liothyronine",
  "medication_detail": {
    "brand_name": "Benadryl",
    "clinical_product_rxcui": "978941",
    "ingredient_name": "diphenhydramine",
    "ingredient_rxcui": "4083",
    "name": "estradiol valerate 3 MG Oral Tablet",
    "normalization_key": "SCDG:1165185|generic",
    "product_rxcui": "978941",
    "scdf_name": "estradiol Oral Tablet",
    "scdf_rxcui": "372078",
    "scdg_name": "estradiol Oral Product",
    "scdg_rxcui": "1165185"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
patient_id
string<uuid>
required

Unique identifier for the patient, either UUID or external ID (e.g. my-patients-128318AA2) if you have provided one during patient creation or update.

​
risk_factor_id
string<uuid>
required

Unique (UUID) identifier for the risk factor

Response

200 - application/json

Risk factor deactivated successfully

Represents a mapping of risk factor to a patient.

​
id
string<uuid>

Unique identifier

Example:

"0227d1e5-ba9a-42b5-8fe2-38882aa65708"

​
created_at
string<date-time>

Date and time of creation

Example:

"2025-03-15T12:00:00Z"

​
updated_at
string<date-time>

Date and time of last update

Example:

"2025-03-15T12:00:00Z"

​
risk_factor_id
string

Reference ID for the Blend database entry for this unique risk factor

Example:

"0227d1e5-ba9a-42b5-8fe2-38882aa65708"

​
confidence
number

If matched, confidence score for the risk factor match

Example:

0.95

​
is_active
boolean

Whether the risk factor is active. Risk factors can be manually deactivated if not applicable.

Example:

true

​
match_source
string

Source of the match, one of autocomplete, text, or manual.

Example:

"autocomplete"

​
match_type
string

For medications, type of match.

Example:

"product"

​
matched
boolean

If the risk factor has been matched to a representative entry. Autocomplete matches are always true, as are 1.0 confidence matches, and manual confirmations.

Example:

true

​
matched_via_synonym
boolean

If the risk factor was matched via a synonym lookup to a representative entry.

Example:

false

​
patient_id
string

ID of the patient associated with the risk factor

Example:

"0227d1e5-ba9a-42b5-8fe2-38882aa65708"

​
risk_factor_text_id
string

If applicable, reference ID for the freeform text entry that produced this risk factor

Example:

"0227d1e5-ba9a-42b5-8fe2-38882aa65708"

​
text_chunk
string

If applicable, the matching text chunk from the freeform text

Example:

"liothyronine"

​
medication_detail
object