Sign in
meal

Get the most recent meal item for a barcode

get/patients/{patient_id}/meal_items/barcode/{barcode}

Path parameters

patient_idinteger required
barcodestring required

Response

successful operation

addonsstring[] required
audio_photo_idinteger nullable
base_food_namestring
calcium_mgnumber nullable
calculated_servingsnumber
carbohydrate_gnumber required
cc_servingsCcServingsResponse nullable

Servings-weighted CC values. Keys match CcColumnsRequest fields. Values are derived from calculated servings (clamped to 0-5, rounded to 0.1) and the corresponding boolean CC flag, matching the health_data_table nutrients aggregation semantics for cc_* fields.

cholesterol_mgnumber nullable
created_by_user_idinteger nullable
created_timestring date-time required
custom_itemboolean nullable
custom_item_sourcestring nullable
custom_item_source_idstring nullable
energy_kcalnumber required
extra_addonsstring[]
fat_gnumber
fiber_gnumber
food_namestring required
food_name_aliasstring nullable
food_name_alias_translationsobject nullable
food_name_translationsobject nullable required
food_ontologystring[] nullable
food_photo_urlstring nullable required
food_replacement_namestring nullable
ghg_equivalent_kgnumber nullable
glycemic_loadstring nullable
grams_per_cubic_inchnumber nullable
idinteger required
is_foundational_itemboolean

Derived from the resolved food ontology; true for structural container items that do not contribute numeric CC servings.

k_levelstring nullable
last_updated_by_user_idinteger nullable
meal_audio_urlstring nullable
meal_nlp_phrasestring nullable
meal_photo_idinteger nullable
meal_photo_urlstring nullable
net_serving_size_gnumber
netcarb_gnumber
notestring nullable
nutrition_sourcestring nullable
original_meal_photo_urlstring nullable
parent_food_namestring nullable
patient_idinteger required
percent_eatennumber
preparation_method'' | 'homemade' | 'restaurant' | 'cpg' | 'store_bought' | 'other'
protein_gnumber
recipe_idinteger nullable
recipe_structureobject nullable
rxfood_idstring nullable
serving_type_labelstring nullable
serving_type_multipliernumber nullable
serving_unit_amountnumber required
serving_unit_labelstring required
serving_unit_label_translationsobject nullable required
servingsnumber required
similar_itemsstring[]
sodium_mgnumber nullable
source_meal_idinteger nullable

meal id the row was copied from when logging from recent items

source_meal_item_custom_addon_idinteger nullable

custom addon id the row was copied from when logging from recent items

source_meal_item_idinteger nullable

meal item id the row was copied from when logging from recent items

updated_timestring date-time required
vitamin_d_iunumber nullable

Example response

{
  "custom_addons": [
    {
      "nutrient_overrides": {
        "aa_patient": {
          "ontology": {
            "id": 42,
            "levels": [
              "food"
            ]
          }
        },
        "bb_reviewer": {
          "ontology": {
            "id": 42,
            "levels": [
              "food"
            ]
          }
        },
        "cc_external": {
          "ontology": {
            "id": 42,
            "levels": [
              "food"
            ]
          }
        },
        "dd_estimate": {
          "ontology": {
            "id": 42,
            "levels": [
              "food"
            ]
          }
        },
        "ee_validation": {
          "ontology": {
            "id": 42,
            "levels": [
              "food"
            ]
          }
        }
      },
      "serving_unit_amount": 1,
      "serving_unit_label": "gram"
    }
  ],
  "nutrient_overrides": {
    "aa_patient": {
      "ontology": {
        "id": 42,
        "levels": [
          "food"
        ]
      }
    },
    "bb_reviewer": {
      "ontology": {
        "id": 42,
        "levels": [
          "food"
        ]
      }
    },
    "cc_external": {
      "ontology": {
        "id": 42,
        "levels": [
          "food"
        ]
      }
    },
    "dd_estimate": {
      "ontology": {
        "id": 42,
        "levels": [
          "food"
        ]
      }
    },
    "ee_validation": {
      "ontology": {
        "id": 42,
        "levels": [
          "food"
        ]
      }
    }
  }
}

Changes

Changed in 1 of the 15 revisions of this API.2

  • 7d063ed4f8ca2See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added