Create medication knowledge entry
curl --request POST \
--url https://api.clinikapi.com/v1/medication-knowledge \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"code": "<string>",
"manufacturer": "<string>",
"doseForm": "<string>",
"amount": {
"value": 123,
"unit": "<string>"
},
"synonym": [
"<string>"
],
"productType": [
"<string>"
],
"ingredient": [
{
"item": "<string>",
"isActive": true,
"strength": {
"numerator": {
"value": 123,
"unit": "<string>"
},
"denominator": {
"value": 123,
"unit": "<string>"
}
}
}
],
"preparationInstruction": "<string>",
"intendedRoute": [
"<string>"
],
"cost": [
{
"type": "<string>",
"cost": {
"value": 123,
"currency": "<string>"
},
"source": "<string>"
}
],
"packaging": {
"type": "<string>",
"quantity": {
"value": 123,
"unit": "<string>"
}
}
}
'import requests
url = "https://api.clinikapi.com/v1/medication-knowledge"
payload = {
"code": "<string>",
"manufacturer": "<string>",
"doseForm": "<string>",
"amount": {
"value": 123,
"unit": "<string>"
},
"synonym": ["<string>"],
"productType": ["<string>"],
"ingredient": [
{
"item": "<string>",
"isActive": True,
"strength": {
"numerator": {
"value": 123,
"unit": "<string>"
},
"denominator": {
"value": 123,
"unit": "<string>"
}
}
}
],
"preparationInstruction": "<string>",
"intendedRoute": ["<string>"],
"cost": [
{
"type": "<string>",
"cost": {
"value": 123,
"currency": "<string>"
},
"source": "<string>"
}
],
"packaging": {
"type": "<string>",
"quantity": {
"value": 123,
"unit": "<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({
code: '<string>',
manufacturer: '<string>',
doseForm: '<string>',
amount: {value: 123, unit: '<string>'},
synonym: ['<string>'],
productType: ['<string>'],
ingredient: [
{
item: '<string>',
isActive: true,
strength: {
numerator: {value: 123, unit: '<string>'},
denominator: {value: 123, unit: '<string>'}
}
}
],
preparationInstruction: '<string>',
intendedRoute: ['<string>'],
cost: [
{type: '<string>', cost: {value: 123, currency: '<string>'}, source: '<string>'}
],
packaging: {type: '<string>', quantity: {value: 123, unit: '<string>'}}
})
};
fetch('https://api.clinikapi.com/v1/medication-knowledge', 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/medication-knowledge",
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([
'code' => '<string>',
'manufacturer' => '<string>',
'doseForm' => '<string>',
'amount' => [
'value' => 123,
'unit' => '<string>'
],
'synonym' => [
'<string>'
],
'productType' => [
'<string>'
],
'ingredient' => [
[
'item' => '<string>',
'isActive' => true,
'strength' => [
'numerator' => [
'value' => 123,
'unit' => '<string>'
],
'denominator' => [
'value' => 123,
'unit' => '<string>'
]
]
]
],
'preparationInstruction' => '<string>',
'intendedRoute' => [
'<string>'
],
'cost' => [
[
'type' => '<string>',
'cost' => [
'value' => 123,
'currency' => '<string>'
],
'source' => '<string>'
]
],
'packaging' => [
'type' => '<string>',
'quantity' => [
'value' => 123,
'unit' => '<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/medication-knowledge"
payload := strings.NewReader("{\n \"code\": \"<string>\",\n \"manufacturer\": \"<string>\",\n \"doseForm\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"synonym\": [\n \"<string>\"\n ],\n \"productType\": [\n \"<string>\"\n ],\n \"ingredient\": [\n {\n \"item\": \"<string>\",\n \"isActive\": true,\n \"strength\": {\n \"numerator\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"denominator\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n }\n }\n ],\n \"preparationInstruction\": \"<string>\",\n \"intendedRoute\": [\n \"<string>\"\n ],\n \"cost\": [\n {\n \"type\": \"<string>\",\n \"cost\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"source\": \"<string>\"\n }\n ],\n \"packaging\": {\n \"type\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n }\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/medication-knowledge")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"code\": \"<string>\",\n \"manufacturer\": \"<string>\",\n \"doseForm\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"synonym\": [\n \"<string>\"\n ],\n \"productType\": [\n \"<string>\"\n ],\n \"ingredient\": [\n {\n \"item\": \"<string>\",\n \"isActive\": true,\n \"strength\": {\n \"numerator\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"denominator\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n }\n }\n ],\n \"preparationInstruction\": \"<string>\",\n \"intendedRoute\": [\n \"<string>\"\n ],\n \"cost\": [\n {\n \"type\": \"<string>\",\n \"cost\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"source\": \"<string>\"\n }\n ],\n \"packaging\": {\n \"type\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/medication-knowledge")
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 \"code\": \"<string>\",\n \"manufacturer\": \"<string>\",\n \"doseForm\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"synonym\": [\n \"<string>\"\n ],\n \"productType\": [\n \"<string>\"\n ],\n \"ingredient\": [\n {\n \"item\": \"<string>\",\n \"isActive\": true,\n \"strength\": {\n \"numerator\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"denominator\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n }\n }\n ],\n \"preparationInstruction\": \"<string>\",\n \"intendedRoute\": [\n \"<string>\"\n ],\n \"cost\": [\n {\n \"type\": \"<string>\",\n \"cost\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"source\": \"<string>\"\n }\n ],\n \"packaging\": {\n \"type\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_bodyMedication Knowledge
Create Medication Knowledge
POST
/
v1
/
medication-knowledge
Create medication knowledge entry
curl --request POST \
--url https://api.clinikapi.com/v1/medication-knowledge \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"code": "<string>",
"manufacturer": "<string>",
"doseForm": "<string>",
"amount": {
"value": 123,
"unit": "<string>"
},
"synonym": [
"<string>"
],
"productType": [
"<string>"
],
"ingredient": [
{
"item": "<string>",
"isActive": true,
"strength": {
"numerator": {
"value": 123,
"unit": "<string>"
},
"denominator": {
"value": 123,
"unit": "<string>"
}
}
}
],
"preparationInstruction": "<string>",
"intendedRoute": [
"<string>"
],
"cost": [
{
"type": "<string>",
"cost": {
"value": 123,
"currency": "<string>"
},
"source": "<string>"
}
],
"packaging": {
"type": "<string>",
"quantity": {
"value": 123,
"unit": "<string>"
}
}
}
'import requests
url = "https://api.clinikapi.com/v1/medication-knowledge"
payload = {
"code": "<string>",
"manufacturer": "<string>",
"doseForm": "<string>",
"amount": {
"value": 123,
"unit": "<string>"
},
"synonym": ["<string>"],
"productType": ["<string>"],
"ingredient": [
{
"item": "<string>",
"isActive": True,
"strength": {
"numerator": {
"value": 123,
"unit": "<string>"
},
"denominator": {
"value": 123,
"unit": "<string>"
}
}
}
],
"preparationInstruction": "<string>",
"intendedRoute": ["<string>"],
"cost": [
{
"type": "<string>",
"cost": {
"value": 123,
"currency": "<string>"
},
"source": "<string>"
}
],
"packaging": {
"type": "<string>",
"quantity": {
"value": 123,
"unit": "<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({
code: '<string>',
manufacturer: '<string>',
doseForm: '<string>',
amount: {value: 123, unit: '<string>'},
synonym: ['<string>'],
productType: ['<string>'],
ingredient: [
{
item: '<string>',
isActive: true,
strength: {
numerator: {value: 123, unit: '<string>'},
denominator: {value: 123, unit: '<string>'}
}
}
],
preparationInstruction: '<string>',
intendedRoute: ['<string>'],
cost: [
{type: '<string>', cost: {value: 123, currency: '<string>'}, source: '<string>'}
],
packaging: {type: '<string>', quantity: {value: 123, unit: '<string>'}}
})
};
fetch('https://api.clinikapi.com/v1/medication-knowledge', 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/medication-knowledge",
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([
'code' => '<string>',
'manufacturer' => '<string>',
'doseForm' => '<string>',
'amount' => [
'value' => 123,
'unit' => '<string>'
],
'synonym' => [
'<string>'
],
'productType' => [
'<string>'
],
'ingredient' => [
[
'item' => '<string>',
'isActive' => true,
'strength' => [
'numerator' => [
'value' => 123,
'unit' => '<string>'
],
'denominator' => [
'value' => 123,
'unit' => '<string>'
]
]
]
],
'preparationInstruction' => '<string>',
'intendedRoute' => [
'<string>'
],
'cost' => [
[
'type' => '<string>',
'cost' => [
'value' => 123,
'currency' => '<string>'
],
'source' => '<string>'
]
],
'packaging' => [
'type' => '<string>',
'quantity' => [
'value' => 123,
'unit' => '<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/medication-knowledge"
payload := strings.NewReader("{\n \"code\": \"<string>\",\n \"manufacturer\": \"<string>\",\n \"doseForm\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"synonym\": [\n \"<string>\"\n ],\n \"productType\": [\n \"<string>\"\n ],\n \"ingredient\": [\n {\n \"item\": \"<string>\",\n \"isActive\": true,\n \"strength\": {\n \"numerator\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"denominator\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n }\n }\n ],\n \"preparationInstruction\": \"<string>\",\n \"intendedRoute\": [\n \"<string>\"\n ],\n \"cost\": [\n {\n \"type\": \"<string>\",\n \"cost\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"source\": \"<string>\"\n }\n ],\n \"packaging\": {\n \"type\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n }\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/medication-knowledge")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"code\": \"<string>\",\n \"manufacturer\": \"<string>\",\n \"doseForm\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"synonym\": [\n \"<string>\"\n ],\n \"productType\": [\n \"<string>\"\n ],\n \"ingredient\": [\n {\n \"item\": \"<string>\",\n \"isActive\": true,\n \"strength\": {\n \"numerator\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"denominator\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n }\n }\n ],\n \"preparationInstruction\": \"<string>\",\n \"intendedRoute\": [\n \"<string>\"\n ],\n \"cost\": [\n {\n \"type\": \"<string>\",\n \"cost\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"source\": \"<string>\"\n }\n ],\n \"packaging\": {\n \"type\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/medication-knowledge")
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 \"code\": \"<string>\",\n \"manufacturer\": \"<string>\",\n \"doseForm\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"synonym\": [\n \"<string>\"\n ],\n \"productType\": [\n \"<string>\"\n ],\n \"ingredient\": [\n {\n \"item\": \"<string>\",\n \"isActive\": true,\n \"strength\": {\n \"numerator\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"denominator\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n }\n }\n ],\n \"preparationInstruction\": \"<string>\",\n \"intendedRoute\": [\n \"<string>\"\n ],\n \"cost\": [\n {\n \"type\": \"<string>\",\n \"cost\": {\n \"value\": 123,\n \"currency\": \"<string>\"\n },\n \"source\": \"<string>\"\n }\n ],\n \"packaging\": {\n \"type\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Your ClinikAPI secret key (clk_live_* or clk_test_*)
Body
application/json
Maximum string length:
200Available options:
active, inactive Maximum string length:
200Maximum string length:
200Show child attributes
Show child attributes
Maximum array length:
20Maximum string length:
200Maximum array length:
10Maximum string length:
200Maximum array length:
50Show child attributes
Show child attributes
Maximum string length:
5000Maximum array length:
10Maximum string length:
200Maximum array length:
20Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
201
Medication knowledge entry created
⌘I