Create immunization recommendation
curl --request POST \
--url https://api.clinikapi.com/v1/immunization-recommendations \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"patientId": "<string>",
"date": "<string>",
"recommendation": [
{
"forecastStatus": "<string>",
"vaccineCode": [
"<string>"
],
"targetDisease": "<string>",
"forecastReason": [
"<string>"
],
"description": "<string>",
"series": "<string>",
"doseNumber": 123,
"seriesDoses": 123,
"dateCriterion": [
{
"code": "<string>",
"value": "<string>"
}
]
}
],
"authorityId": "<string>"
}
'import requests
url = "https://api.clinikapi.com/v1/immunization-recommendations"
payload = {
"patientId": "<string>",
"date": "<string>",
"recommendation": [
{
"forecastStatus": "<string>",
"vaccineCode": ["<string>"],
"targetDisease": "<string>",
"forecastReason": ["<string>"],
"description": "<string>",
"series": "<string>",
"doseNumber": 123,
"seriesDoses": 123,
"dateCriterion": [
{
"code": "<string>",
"value": "<string>"
}
]
}
],
"authorityId": "<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>',
date: '<string>',
recommendation: [
{
forecastStatus: '<string>',
vaccineCode: ['<string>'],
targetDisease: '<string>',
forecastReason: ['<string>'],
description: '<string>',
series: '<string>',
doseNumber: 123,
seriesDoses: 123,
dateCriterion: [{code: '<string>', value: '<string>'}]
}
],
authorityId: '<string>'
})
};
fetch('https://api.clinikapi.com/v1/immunization-recommendations', 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/immunization-recommendations",
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>',
'date' => '<string>',
'recommendation' => [
[
'forecastStatus' => '<string>',
'vaccineCode' => [
'<string>'
],
'targetDisease' => '<string>',
'forecastReason' => [
'<string>'
],
'description' => '<string>',
'series' => '<string>',
'doseNumber' => 123,
'seriesDoses' => 123,
'dateCriterion' => [
[
'code' => '<string>',
'value' => '<string>'
]
]
]
],
'authorityId' => '<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/immunization-recommendations"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"date\": \"<string>\",\n \"recommendation\": [\n {\n \"forecastStatus\": \"<string>\",\n \"vaccineCode\": [\n \"<string>\"\n ],\n \"targetDisease\": \"<string>\",\n \"forecastReason\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"series\": \"<string>\",\n \"doseNumber\": 123,\n \"seriesDoses\": 123,\n \"dateCriterion\": [\n {\n \"code\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"authorityId\": \"<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/immunization-recommendations")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"date\": \"<string>\",\n \"recommendation\": [\n {\n \"forecastStatus\": \"<string>\",\n \"vaccineCode\": [\n \"<string>\"\n ],\n \"targetDisease\": \"<string>\",\n \"forecastReason\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"series\": \"<string>\",\n \"doseNumber\": 123,\n \"seriesDoses\": 123,\n \"dateCriterion\": [\n {\n \"code\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"authorityId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/immunization-recommendations")
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 \"date\": \"<string>\",\n \"recommendation\": [\n {\n \"forecastStatus\": \"<string>\",\n \"vaccineCode\": [\n \"<string>\"\n ],\n \"targetDisease\": \"<string>\",\n \"forecastReason\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"series\": \"<string>\",\n \"doseNumber\": 123,\n \"seriesDoses\": 123,\n \"dateCriterion\": [\n {\n \"code\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"authorityId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyImmunization Recommendations
Create Immunization Recommendation
POST
/
v1
/
immunization-recommendations
Create immunization recommendation
curl --request POST \
--url https://api.clinikapi.com/v1/immunization-recommendations \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"patientId": "<string>",
"date": "<string>",
"recommendation": [
{
"forecastStatus": "<string>",
"vaccineCode": [
"<string>"
],
"targetDisease": "<string>",
"forecastReason": [
"<string>"
],
"description": "<string>",
"series": "<string>",
"doseNumber": 123,
"seriesDoses": 123,
"dateCriterion": [
{
"code": "<string>",
"value": "<string>"
}
]
}
],
"authorityId": "<string>"
}
'import requests
url = "https://api.clinikapi.com/v1/immunization-recommendations"
payload = {
"patientId": "<string>",
"date": "<string>",
"recommendation": [
{
"forecastStatus": "<string>",
"vaccineCode": ["<string>"],
"targetDisease": "<string>",
"forecastReason": ["<string>"],
"description": "<string>",
"series": "<string>",
"doseNumber": 123,
"seriesDoses": 123,
"dateCriterion": [
{
"code": "<string>",
"value": "<string>"
}
]
}
],
"authorityId": "<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>',
date: '<string>',
recommendation: [
{
forecastStatus: '<string>',
vaccineCode: ['<string>'],
targetDisease: '<string>',
forecastReason: ['<string>'],
description: '<string>',
series: '<string>',
doseNumber: 123,
seriesDoses: 123,
dateCriterion: [{code: '<string>', value: '<string>'}]
}
],
authorityId: '<string>'
})
};
fetch('https://api.clinikapi.com/v1/immunization-recommendations', 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/immunization-recommendations",
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>',
'date' => '<string>',
'recommendation' => [
[
'forecastStatus' => '<string>',
'vaccineCode' => [
'<string>'
],
'targetDisease' => '<string>',
'forecastReason' => [
'<string>'
],
'description' => '<string>',
'series' => '<string>',
'doseNumber' => 123,
'seriesDoses' => 123,
'dateCriterion' => [
[
'code' => '<string>',
'value' => '<string>'
]
]
]
],
'authorityId' => '<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/immunization-recommendations"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"date\": \"<string>\",\n \"recommendation\": [\n {\n \"forecastStatus\": \"<string>\",\n \"vaccineCode\": [\n \"<string>\"\n ],\n \"targetDisease\": \"<string>\",\n \"forecastReason\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"series\": \"<string>\",\n \"doseNumber\": 123,\n \"seriesDoses\": 123,\n \"dateCriterion\": [\n {\n \"code\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"authorityId\": \"<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/immunization-recommendations")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"date\": \"<string>\",\n \"recommendation\": [\n {\n \"forecastStatus\": \"<string>\",\n \"vaccineCode\": [\n \"<string>\"\n ],\n \"targetDisease\": \"<string>\",\n \"forecastReason\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"series\": \"<string>\",\n \"doseNumber\": 123,\n \"seriesDoses\": 123,\n \"dateCriterion\": [\n {\n \"code\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"authorityId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/immunization-recommendations")
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 \"date\": \"<string>\",\n \"recommendation\": [\n {\n \"forecastStatus\": \"<string>\",\n \"vaccineCode\": [\n \"<string>\"\n ],\n \"targetDisease\": \"<string>\",\n \"forecastReason\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"series\": \"<string>\",\n \"doseNumber\": 123,\n \"seriesDoses\": 123,\n \"dateCriterion\": [\n {\n \"code\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"authorityId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Your ClinikAPI secret key (clk_live_* or clk_test_*)
Body
application/json
Response
201
Immunization recommendation created
⌘I