Create nutrition order
curl --request POST \
--url https://api.clinikapi.com/v1/nutrition-orders \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"patientId": "<string>",
"encounterId": "<string>",
"dateTime": "<string>",
"ordererId": "<string>",
"allergyIntoleranceIds": [
"<string>"
],
"foodPreferenceModifier": [
"<string>"
],
"excludeFoodModifier": [
"<string>"
],
"oralDiet": {
"type": [
"<string>"
],
"instruction": "<string>",
"nutrient": [
{
"modifier": "<string>",
"amount": {
"value": 123,
"unit": "<string>"
}
}
]
},
"supplement": [
{
"type": "<string>",
"productName": "<string>",
"quantity": {
"value": 123,
"unit": "<string>"
},
"instruction": "<string>"
}
],
"enteralFormula": {
"baseFormulaType": "<string>",
"baseFormulaProductName": "<string>",
"additiveType": "<string>",
"routeOfAdministration": "<string>",
"administrationInstruction": "<string>"
},
"note": "<string>"
}
'import requests
url = "https://api.clinikapi.com/v1/nutrition-orders"
payload = {
"patientId": "<string>",
"encounterId": "<string>",
"dateTime": "<string>",
"ordererId": "<string>",
"allergyIntoleranceIds": ["<string>"],
"foodPreferenceModifier": ["<string>"],
"excludeFoodModifier": ["<string>"],
"oralDiet": {
"type": ["<string>"],
"instruction": "<string>",
"nutrient": [
{
"modifier": "<string>",
"amount": {
"value": 123,
"unit": "<string>"
}
}
]
},
"supplement": [
{
"type": "<string>",
"productName": "<string>",
"quantity": {
"value": 123,
"unit": "<string>"
},
"instruction": "<string>"
}
],
"enteralFormula": {
"baseFormulaType": "<string>",
"baseFormulaProductName": "<string>",
"additiveType": "<string>",
"routeOfAdministration": "<string>",
"administrationInstruction": "<string>"
},
"note": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
patientId: '<string>',
encounterId: '<string>',
dateTime: '<string>',
ordererId: '<string>',
allergyIntoleranceIds: ['<string>'],
foodPreferenceModifier: ['<string>'],
excludeFoodModifier: ['<string>'],
oralDiet: {
type: ['<string>'],
instruction: '<string>',
nutrient: [{modifier: '<string>', amount: {value: 123, unit: '<string>'}}]
},
supplement: [
{
type: '<string>',
productName: '<string>',
quantity: {value: 123, unit: '<string>'},
instruction: '<string>'
}
],
enteralFormula: {
baseFormulaType: '<string>',
baseFormulaProductName: '<string>',
additiveType: '<string>',
routeOfAdministration: '<string>',
administrationInstruction: '<string>'
},
note: '<string>'
})
};
fetch('https://api.clinikapi.com/v1/nutrition-orders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.clinikapi.com/v1/nutrition-orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'patientId' => '<string>',
'encounterId' => '<string>',
'dateTime' => '<string>',
'ordererId' => '<string>',
'allergyIntoleranceIds' => [
'<string>'
],
'foodPreferenceModifier' => [
'<string>'
],
'excludeFoodModifier' => [
'<string>'
],
'oralDiet' => [
'type' => [
'<string>'
],
'instruction' => '<string>',
'nutrient' => [
[
'modifier' => '<string>',
'amount' => [
'value' => 123,
'unit' => '<string>'
]
]
]
],
'supplement' => [
[
'type' => '<string>',
'productName' => '<string>',
'quantity' => [
'value' => 123,
'unit' => '<string>'
],
'instruction' => '<string>'
]
],
'enteralFormula' => [
'baseFormulaType' => '<string>',
'baseFormulaProductName' => '<string>',
'additiveType' => '<string>',
'routeOfAdministration' => '<string>',
'administrationInstruction' => '<string>'
],
'note' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.clinikapi.com/v1/nutrition-orders"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"dateTime\": \"<string>\",\n \"ordererId\": \"<string>\",\n \"allergyIntoleranceIds\": [\n \"<string>\"\n ],\n \"foodPreferenceModifier\": [\n \"<string>\"\n ],\n \"excludeFoodModifier\": [\n \"<string>\"\n ],\n \"oralDiet\": {\n \"type\": [\n \"<string>\"\n ],\n \"instruction\": \"<string>\",\n \"nutrient\": [\n {\n \"modifier\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n }\n ]\n },\n \"supplement\": [\n {\n \"type\": \"<string>\",\n \"productName\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"instruction\": \"<string>\"\n }\n ],\n \"enteralFormula\": {\n \"baseFormulaType\": \"<string>\",\n \"baseFormulaProductName\": \"<string>\",\n \"additiveType\": \"<string>\",\n \"routeOfAdministration\": \"<string>\",\n \"administrationInstruction\": \"<string>\"\n },\n \"note\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.clinikapi.com/v1/nutrition-orders")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"dateTime\": \"<string>\",\n \"ordererId\": \"<string>\",\n \"allergyIntoleranceIds\": [\n \"<string>\"\n ],\n \"foodPreferenceModifier\": [\n \"<string>\"\n ],\n \"excludeFoodModifier\": [\n \"<string>\"\n ],\n \"oralDiet\": {\n \"type\": [\n \"<string>\"\n ],\n \"instruction\": \"<string>\",\n \"nutrient\": [\n {\n \"modifier\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n }\n ]\n },\n \"supplement\": [\n {\n \"type\": \"<string>\",\n \"productName\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"instruction\": \"<string>\"\n }\n ],\n \"enteralFormula\": {\n \"baseFormulaType\": \"<string>\",\n \"baseFormulaProductName\": \"<string>\",\n \"additiveType\": \"<string>\",\n \"routeOfAdministration\": \"<string>\",\n \"administrationInstruction\": \"<string>\"\n },\n \"note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/nutrition-orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"dateTime\": \"<string>\",\n \"ordererId\": \"<string>\",\n \"allergyIntoleranceIds\": [\n \"<string>\"\n ],\n \"foodPreferenceModifier\": [\n \"<string>\"\n ],\n \"excludeFoodModifier\": [\n \"<string>\"\n ],\n \"oralDiet\": {\n \"type\": [\n \"<string>\"\n ],\n \"instruction\": \"<string>\",\n \"nutrient\": [\n {\n \"modifier\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n }\n ]\n },\n \"supplement\": [\n {\n \"type\": \"<string>\",\n \"productName\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"instruction\": \"<string>\"\n }\n ],\n \"enteralFormula\": {\n \"baseFormulaType\": \"<string>\",\n \"baseFormulaProductName\": \"<string>\",\n \"additiveType\": \"<string>\",\n \"routeOfAdministration\": \"<string>\",\n \"administrationInstruction\": \"<string>\"\n },\n \"note\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyNutrition Orders
Create Nutrition Order
POST
/
v1
/
nutrition-orders
Create nutrition order
curl --request POST \
--url https://api.clinikapi.com/v1/nutrition-orders \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"patientId": "<string>",
"encounterId": "<string>",
"dateTime": "<string>",
"ordererId": "<string>",
"allergyIntoleranceIds": [
"<string>"
],
"foodPreferenceModifier": [
"<string>"
],
"excludeFoodModifier": [
"<string>"
],
"oralDiet": {
"type": [
"<string>"
],
"instruction": "<string>",
"nutrient": [
{
"modifier": "<string>",
"amount": {
"value": 123,
"unit": "<string>"
}
}
]
},
"supplement": [
{
"type": "<string>",
"productName": "<string>",
"quantity": {
"value": 123,
"unit": "<string>"
},
"instruction": "<string>"
}
],
"enteralFormula": {
"baseFormulaType": "<string>",
"baseFormulaProductName": "<string>",
"additiveType": "<string>",
"routeOfAdministration": "<string>",
"administrationInstruction": "<string>"
},
"note": "<string>"
}
'import requests
url = "https://api.clinikapi.com/v1/nutrition-orders"
payload = {
"patientId": "<string>",
"encounterId": "<string>",
"dateTime": "<string>",
"ordererId": "<string>",
"allergyIntoleranceIds": ["<string>"],
"foodPreferenceModifier": ["<string>"],
"excludeFoodModifier": ["<string>"],
"oralDiet": {
"type": ["<string>"],
"instruction": "<string>",
"nutrient": [
{
"modifier": "<string>",
"amount": {
"value": 123,
"unit": "<string>"
}
}
]
},
"supplement": [
{
"type": "<string>",
"productName": "<string>",
"quantity": {
"value": 123,
"unit": "<string>"
},
"instruction": "<string>"
}
],
"enteralFormula": {
"baseFormulaType": "<string>",
"baseFormulaProductName": "<string>",
"additiveType": "<string>",
"routeOfAdministration": "<string>",
"administrationInstruction": "<string>"
},
"note": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
patientId: '<string>',
encounterId: '<string>',
dateTime: '<string>',
ordererId: '<string>',
allergyIntoleranceIds: ['<string>'],
foodPreferenceModifier: ['<string>'],
excludeFoodModifier: ['<string>'],
oralDiet: {
type: ['<string>'],
instruction: '<string>',
nutrient: [{modifier: '<string>', amount: {value: 123, unit: '<string>'}}]
},
supplement: [
{
type: '<string>',
productName: '<string>',
quantity: {value: 123, unit: '<string>'},
instruction: '<string>'
}
],
enteralFormula: {
baseFormulaType: '<string>',
baseFormulaProductName: '<string>',
additiveType: '<string>',
routeOfAdministration: '<string>',
administrationInstruction: '<string>'
},
note: '<string>'
})
};
fetch('https://api.clinikapi.com/v1/nutrition-orders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.clinikapi.com/v1/nutrition-orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'patientId' => '<string>',
'encounterId' => '<string>',
'dateTime' => '<string>',
'ordererId' => '<string>',
'allergyIntoleranceIds' => [
'<string>'
],
'foodPreferenceModifier' => [
'<string>'
],
'excludeFoodModifier' => [
'<string>'
],
'oralDiet' => [
'type' => [
'<string>'
],
'instruction' => '<string>',
'nutrient' => [
[
'modifier' => '<string>',
'amount' => [
'value' => 123,
'unit' => '<string>'
]
]
]
],
'supplement' => [
[
'type' => '<string>',
'productName' => '<string>',
'quantity' => [
'value' => 123,
'unit' => '<string>'
],
'instruction' => '<string>'
]
],
'enteralFormula' => [
'baseFormulaType' => '<string>',
'baseFormulaProductName' => '<string>',
'additiveType' => '<string>',
'routeOfAdministration' => '<string>',
'administrationInstruction' => '<string>'
],
'note' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.clinikapi.com/v1/nutrition-orders"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"dateTime\": \"<string>\",\n \"ordererId\": \"<string>\",\n \"allergyIntoleranceIds\": [\n \"<string>\"\n ],\n \"foodPreferenceModifier\": [\n \"<string>\"\n ],\n \"excludeFoodModifier\": [\n \"<string>\"\n ],\n \"oralDiet\": {\n \"type\": [\n \"<string>\"\n ],\n \"instruction\": \"<string>\",\n \"nutrient\": [\n {\n \"modifier\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n }\n ]\n },\n \"supplement\": [\n {\n \"type\": \"<string>\",\n \"productName\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"instruction\": \"<string>\"\n }\n ],\n \"enteralFormula\": {\n \"baseFormulaType\": \"<string>\",\n \"baseFormulaProductName\": \"<string>\",\n \"additiveType\": \"<string>\",\n \"routeOfAdministration\": \"<string>\",\n \"administrationInstruction\": \"<string>\"\n },\n \"note\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.clinikapi.com/v1/nutrition-orders")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"dateTime\": \"<string>\",\n \"ordererId\": \"<string>\",\n \"allergyIntoleranceIds\": [\n \"<string>\"\n ],\n \"foodPreferenceModifier\": [\n \"<string>\"\n ],\n \"excludeFoodModifier\": [\n \"<string>\"\n ],\n \"oralDiet\": {\n \"type\": [\n \"<string>\"\n ],\n \"instruction\": \"<string>\",\n \"nutrient\": [\n {\n \"modifier\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n }\n ]\n },\n \"supplement\": [\n {\n \"type\": \"<string>\",\n \"productName\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"instruction\": \"<string>\"\n }\n ],\n \"enteralFormula\": {\n \"baseFormulaType\": \"<string>\",\n \"baseFormulaProductName\": \"<string>\",\n \"additiveType\": \"<string>\",\n \"routeOfAdministration\": \"<string>\",\n \"administrationInstruction\": \"<string>\"\n },\n \"note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/nutrition-orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"dateTime\": \"<string>\",\n \"ordererId\": \"<string>\",\n \"allergyIntoleranceIds\": [\n \"<string>\"\n ],\n \"foodPreferenceModifier\": [\n \"<string>\"\n ],\n \"excludeFoodModifier\": [\n \"<string>\"\n ],\n \"oralDiet\": {\n \"type\": [\n \"<string>\"\n ],\n \"instruction\": \"<string>\",\n \"nutrient\": [\n {\n \"modifier\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n }\n ]\n },\n \"supplement\": [\n {\n \"type\": \"<string>\",\n \"productName\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"instruction\": \"<string>\"\n }\n ],\n \"enteralFormula\": {\n \"baseFormulaType\": \"<string>\",\n \"baseFormulaProductName\": \"<string>\",\n \"additiveType\": \"<string>\",\n \"routeOfAdministration\": \"<string>\",\n \"administrationInstruction\": \"<string>\"\n },\n \"note\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Your ClinikAPI secret key (clk_live_* or clk_test_*)
Body
application/json
Available options:
draft, active, on-hold, revoked, completed Available options:
proposal, plan, directive, order Maximum string length:
128Maximum string length:
128Maximum string length:
30Maximum string length:
128Maximum array length:
10Maximum string length:
128Maximum array length:
10Maximum string length:
200Maximum array length:
10Maximum string length:
200Show child attributes
Show child attributes
Maximum array length:
10Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum string length:
5000Response
201
Nutrition order created
⌘I