Get a patient's risk factors

curl --request GET \
  --url https://api.byblend.com/api/v1/patients/{patient_id}/risk_factors \
  --header 'Authorization: Bearer <token>'

{
  "allergies": [
    {
      "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
      "name": "Penicillin",
      "type": "allergy",
      "matched": true,
      "original_name": "Peniccillin"
    }
  ],
  "conditions": [
    {
      "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
      "name": "Diabetes mellitus",
      "type": "condition",
      "matched": true,
      "original_name": "diabetes"
    }
  ],
  "medications": [
    {
      "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"
      }
    }
  ]
}

GET

api

patients

{patient_id}

risk_factors

Get a patient's risk factors

curl --request GET \
  --url https://api.byblend.com/api/v1/patients/{patient_id}/risk_factors \
  --header 'Authorization: Bearer <token>'

{
  "allergies": [
    {
      "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
      "name": "Penicillin",
      "type": "allergy",
      "matched": true,
      "original_name": "Peniccillin"
    }
  ],
  "conditions": [
    {
      "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
      "name": "Diabetes mellitus",
      "type": "condition",
      "matched": true,
      "original_name": "diabetes"
    }
  ],
  "medications": [
    {
      "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.

Example:

"98cae3a3-996c-4bf5-9143-0ab6d98bc1d0"

Query Parameters

type

string

Type of risk factor to retrieve, either 'allergy', 'condition', or 'medication'

Example:

"allergy"

Response

200 - application/json

Successful response with all risk factors, or specific type of risk factors.

All Risk Factors · object
Allergies · object[]
Conditions · object[]
Medications · object[]

allergies

object[]

Show child attributes

allergies.id

string<uuid>

Unique identifier

Example:

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

allergies.name

string

Name of the allergy

Example:

"Penicillin"

allergies.type

string

Example:

"allergy"

allergies.matched

boolean

Whether the allergy has been matched to a known allergen in the Blend database

Example:

true

allergies.original_name

string

Original freeform text of the allergy, if matched

Example:

"Peniccillin"

conditions

object[]

Show child attributes

conditions.id

string<uuid>

Unique identifier

Example:

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

conditions.name

string

Name of the condition

Example:

"Diabetes mellitus"

conditions.type

string

Example:

"condition"

conditions.matched

boolean

Whether the condition has been matched to a known condition in the Blend database

Example:

true

conditions.original_name

string

Original freeform text of the condition, if matched

Example:

"diabetes"

medications

object[]

Show child attributes

medications.id

string<uuid>

Unique identifier

Example:

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

medications.created_at

string<date-time>

Date and time of creation

Example:

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

medications.updated_at

string<date-time>

Date and time of last update

Example:

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

medications.risk_factor_id

string

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

Example:

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

medications.confidence

number

If matched, confidence score for the risk factor match

Example:

0.95

medications.is_active

boolean

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

Example:

true

medications.match_source

string

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

Example:

"autocomplete"

medications.match_type

string

For medications, type of match.

Example:

"product"

medications.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

medications.matched_via_synonym

boolean

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

Example:

false

medications.patient_id

string

ID of the patient associated with the risk factor

Example:

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

medications.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"

medications.text_chunk

string

If applicable, the matching text chunk from the freeform text

Example:

"liothyronine"

medications.medication_detail

object

Show child attributes

medications.medication_detail.brand_name

string

Brand name, if applicable, of the medication

Example:

"Benadryl"

medications.medication_detail.clinical_product_rxcui

string

RXNorm CUI of the clinical product, if applicable

Example:

"978941"

medications.medication_detail.ingredient_name

string

If applicable, ingredient name

Example:

"diphenhydramine"

medications.medication_detail.ingredient_rxcui

string

RXNorm CUI of the ingredient, if applicable

Example:

"4083"

medications.medication_detail.name

string

Representative name of the medication, typically ignored in DUR in favor of the clinical drug form

Example:

"estradiol valerate 3 MG Oral Tablet"

medications.medication_detail.normalization_key

string

Normalization key used to identify appropriate matches

Example:

"SCDG:1165185|generic"

medications.medication_detail.product_rxcui

string

RxNorm CUI of the product, if applicable

Example:

"978941"

medications.medication_detail.scdf_name

string

SCDF (Semantic Clinical Drug Form) name of the medication, if applicable

Example:

"estradiol Oral Tablet"

medications.medication_detail.scdf_rxcui

string

SCDF (Semantic Clinical Drug Form) RXCUI of the medication, if applicable

Example:

"372078"

medications.medication_detail.scdg_name

string

SCDG (Semantic Clinical Drug Group) name of the medication, if applicable

Example:

"estradiol Oral Product"

medications.medication_detail.scdg_rxcui

string

SCDG (Semantic Clinical Drug Group) RXCUI of the medication, if applicable

Example:

"1165185"

Get a patient's orders Deactivate a risk factor

⌘I

Authentication

Composite Creation

Electronic Prescriptions

Notifications

Orders

Patients

Prescribers

Products and Materials

Reports

Search

Get a patient's risk factors

Authorizations

Path Parameters

Query Parameters

Response