Create immunization
curl --request POST \
--url https://api.clinikapi.com/v1/immunizations \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"vaccineCode": "<string>",
"patientId": "<string>",
"encounterId": "<string>",
"occurrenceDateTime": "<string>",
"recorded": "<string>",
"primarySource": true,
"manufacturer": "<string>",
"lotNumber": "<string>",
"expirationDate": "<string>",
"site": "<string>",
"route": "<string>",
"doseQuantity": {
"value": 123,
"unit": "<string>"
},
"performer": [
{
"actorId": "<string>",
"function": "<string>"
}
],
"note": "<string>",
"reasonCode": [
"<string>"
],
"statusReason": "<string>",
"isSubpotent": true,
"reaction": [
{
"date": "<string>",
"reported": true
}
],
"protocolApplied": [
{
"series": "<string>",
"doseNumber": 123,
"seriesDoses": 123,
"targetDisease": [
"<string>"
]
}
]
}
'import requests
url = "https://api.clinikapi.com/v1/immunizations"
payload = {
"vaccineCode": "<string>",
"patientId": "<string>",
"encounterId": "<string>",
"occurrenceDateTime": "<string>",
"recorded": "<string>",
"primarySource": True,
"manufacturer": "<string>",
"lotNumber": "<string>",
"expirationDate": "<string>",
"site": "<string>",
"route": "<string>",
"doseQuantity": {
"value": 123,
"unit": "<string>"
},
"performer": [
{
"actorId": "<string>",
"function": "<string>"
}
],
"note": "<string>",
"reasonCode": ["<string>"],
"statusReason": "<string>",
"isSubpotent": True,
"reaction": [
{
"date": "<string>",
"reported": True
}
],
"protocolApplied": [
{
"series": "<string>",
"doseNumber": 123,
"seriesDoses": 123,
"targetDisease": ["<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({
vaccineCode: '<string>',
patientId: '<string>',
encounterId: '<string>',
occurrenceDateTime: '<string>',
recorded: '<string>',
primarySource: true,
manufacturer: '<string>',
lotNumber: '<string>',
expirationDate: '<string>',
site: '<string>',
route: '<string>',
doseQuantity: {value: 123, unit: '<string>'},
performer: [{actorId: '<string>', function: '<string>'}],
note: '<string>',
reasonCode: ['<string>'],
statusReason: '<string>',
isSubpotent: true,
reaction: [{date: '<string>', reported: true}],
protocolApplied: [
{
series: '<string>',
doseNumber: 123,
seriesDoses: 123,
targetDisease: ['<string>']
}
]
})
};
fetch('https://api.clinikapi.com/v1/immunizations', 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/immunizations",
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([
'vaccineCode' => '<string>',
'patientId' => '<string>',
'encounterId' => '<string>',
'occurrenceDateTime' => '<string>',
'recorded' => '<string>',
'primarySource' => true,
'manufacturer' => '<string>',
'lotNumber' => '<string>',
'expirationDate' => '<string>',
'site' => '<string>',
'route' => '<string>',
'doseQuantity' => [
'value' => 123,
'unit' => '<string>'
],
'performer' => [
[
'actorId' => '<string>',
'function' => '<string>'
]
],
'note' => '<string>',
'reasonCode' => [
'<string>'
],
'statusReason' => '<string>',
'isSubpotent' => true,
'reaction' => [
[
'date' => '<string>',
'reported' => true
]
],
'protocolApplied' => [
[
'series' => '<string>',
'doseNumber' => 123,
'seriesDoses' => 123,
'targetDisease' => [
'<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/immunizations"
payload := strings.NewReader("{\n \"vaccineCode\": \"<string>\",\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"occurrenceDateTime\": \"<string>\",\n \"recorded\": \"<string>\",\n \"primarySource\": true,\n \"manufacturer\": \"<string>\",\n \"lotNumber\": \"<string>\",\n \"expirationDate\": \"<string>\",\n \"site\": \"<string>\",\n \"route\": \"<string>\",\n \"doseQuantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"performer\": [\n {\n \"actorId\": \"<string>\",\n \"function\": \"<string>\"\n }\n ],\n \"note\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"statusReason\": \"<string>\",\n \"isSubpotent\": true,\n \"reaction\": [\n {\n \"date\": \"<string>\",\n \"reported\": true\n }\n ],\n \"protocolApplied\": [\n {\n \"series\": \"<string>\",\n \"doseNumber\": 123,\n \"seriesDoses\": 123,\n \"targetDisease\": [\n \"<string>\"\n ]\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/immunizations")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"vaccineCode\": \"<string>\",\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"occurrenceDateTime\": \"<string>\",\n \"recorded\": \"<string>\",\n \"primarySource\": true,\n \"manufacturer\": \"<string>\",\n \"lotNumber\": \"<string>\",\n \"expirationDate\": \"<string>\",\n \"site\": \"<string>\",\n \"route\": \"<string>\",\n \"doseQuantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"performer\": [\n {\n \"actorId\": \"<string>\",\n \"function\": \"<string>\"\n }\n ],\n \"note\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"statusReason\": \"<string>\",\n \"isSubpotent\": true,\n \"reaction\": [\n {\n \"date\": \"<string>\",\n \"reported\": true\n }\n ],\n \"protocolApplied\": [\n {\n \"series\": \"<string>\",\n \"doseNumber\": 123,\n \"seriesDoses\": 123,\n \"targetDisease\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/immunizations")
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 \"vaccineCode\": \"<string>\",\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"occurrenceDateTime\": \"<string>\",\n \"recorded\": \"<string>\",\n \"primarySource\": true,\n \"manufacturer\": \"<string>\",\n \"lotNumber\": \"<string>\",\n \"expirationDate\": \"<string>\",\n \"site\": \"<string>\",\n \"route\": \"<string>\",\n \"doseQuantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"performer\": [\n {\n \"actorId\": \"<string>\",\n \"function\": \"<string>\"\n }\n ],\n \"note\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"statusReason\": \"<string>\",\n \"isSubpotent\": true,\n \"reaction\": [\n {\n \"date\": \"<string>\",\n \"reported\": true\n }\n ],\n \"protocolApplied\": [\n {\n \"series\": \"<string>\",\n \"doseNumber\": 123,\n \"seriesDoses\": 123,\n \"targetDisease\": [\n \"<string>\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyImmunizations
Create Immunization
POST
/
v1
/
immunizations
Create immunization
curl --request POST \
--url https://api.clinikapi.com/v1/immunizations \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"vaccineCode": "<string>",
"patientId": "<string>",
"encounterId": "<string>",
"occurrenceDateTime": "<string>",
"recorded": "<string>",
"primarySource": true,
"manufacturer": "<string>",
"lotNumber": "<string>",
"expirationDate": "<string>",
"site": "<string>",
"route": "<string>",
"doseQuantity": {
"value": 123,
"unit": "<string>"
},
"performer": [
{
"actorId": "<string>",
"function": "<string>"
}
],
"note": "<string>",
"reasonCode": [
"<string>"
],
"statusReason": "<string>",
"isSubpotent": true,
"reaction": [
{
"date": "<string>",
"reported": true
}
],
"protocolApplied": [
{
"series": "<string>",
"doseNumber": 123,
"seriesDoses": 123,
"targetDisease": [
"<string>"
]
}
]
}
'import requests
url = "https://api.clinikapi.com/v1/immunizations"
payload = {
"vaccineCode": "<string>",
"patientId": "<string>",
"encounterId": "<string>",
"occurrenceDateTime": "<string>",
"recorded": "<string>",
"primarySource": True,
"manufacturer": "<string>",
"lotNumber": "<string>",
"expirationDate": "<string>",
"site": "<string>",
"route": "<string>",
"doseQuantity": {
"value": 123,
"unit": "<string>"
},
"performer": [
{
"actorId": "<string>",
"function": "<string>"
}
],
"note": "<string>",
"reasonCode": ["<string>"],
"statusReason": "<string>",
"isSubpotent": True,
"reaction": [
{
"date": "<string>",
"reported": True
}
],
"protocolApplied": [
{
"series": "<string>",
"doseNumber": 123,
"seriesDoses": 123,
"targetDisease": ["<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({
vaccineCode: '<string>',
patientId: '<string>',
encounterId: '<string>',
occurrenceDateTime: '<string>',
recorded: '<string>',
primarySource: true,
manufacturer: '<string>',
lotNumber: '<string>',
expirationDate: '<string>',
site: '<string>',
route: '<string>',
doseQuantity: {value: 123, unit: '<string>'},
performer: [{actorId: '<string>', function: '<string>'}],
note: '<string>',
reasonCode: ['<string>'],
statusReason: '<string>',
isSubpotent: true,
reaction: [{date: '<string>', reported: true}],
protocolApplied: [
{
series: '<string>',
doseNumber: 123,
seriesDoses: 123,
targetDisease: ['<string>']
}
]
})
};
fetch('https://api.clinikapi.com/v1/immunizations', 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/immunizations",
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([
'vaccineCode' => '<string>',
'patientId' => '<string>',
'encounterId' => '<string>',
'occurrenceDateTime' => '<string>',
'recorded' => '<string>',
'primarySource' => true,
'manufacturer' => '<string>',
'lotNumber' => '<string>',
'expirationDate' => '<string>',
'site' => '<string>',
'route' => '<string>',
'doseQuantity' => [
'value' => 123,
'unit' => '<string>'
],
'performer' => [
[
'actorId' => '<string>',
'function' => '<string>'
]
],
'note' => '<string>',
'reasonCode' => [
'<string>'
],
'statusReason' => '<string>',
'isSubpotent' => true,
'reaction' => [
[
'date' => '<string>',
'reported' => true
]
],
'protocolApplied' => [
[
'series' => '<string>',
'doseNumber' => 123,
'seriesDoses' => 123,
'targetDisease' => [
'<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/immunizations"
payload := strings.NewReader("{\n \"vaccineCode\": \"<string>\",\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"occurrenceDateTime\": \"<string>\",\n \"recorded\": \"<string>\",\n \"primarySource\": true,\n \"manufacturer\": \"<string>\",\n \"lotNumber\": \"<string>\",\n \"expirationDate\": \"<string>\",\n \"site\": \"<string>\",\n \"route\": \"<string>\",\n \"doseQuantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"performer\": [\n {\n \"actorId\": \"<string>\",\n \"function\": \"<string>\"\n }\n ],\n \"note\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"statusReason\": \"<string>\",\n \"isSubpotent\": true,\n \"reaction\": [\n {\n \"date\": \"<string>\",\n \"reported\": true\n }\n ],\n \"protocolApplied\": [\n {\n \"series\": \"<string>\",\n \"doseNumber\": 123,\n \"seriesDoses\": 123,\n \"targetDisease\": [\n \"<string>\"\n ]\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/immunizations")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"vaccineCode\": \"<string>\",\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"occurrenceDateTime\": \"<string>\",\n \"recorded\": \"<string>\",\n \"primarySource\": true,\n \"manufacturer\": \"<string>\",\n \"lotNumber\": \"<string>\",\n \"expirationDate\": \"<string>\",\n \"site\": \"<string>\",\n \"route\": \"<string>\",\n \"doseQuantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"performer\": [\n {\n \"actorId\": \"<string>\",\n \"function\": \"<string>\"\n }\n ],\n \"note\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"statusReason\": \"<string>\",\n \"isSubpotent\": true,\n \"reaction\": [\n {\n \"date\": \"<string>\",\n \"reported\": true\n }\n ],\n \"protocolApplied\": [\n {\n \"series\": \"<string>\",\n \"doseNumber\": 123,\n \"seriesDoses\": 123,\n \"targetDisease\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/immunizations")
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 \"vaccineCode\": \"<string>\",\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"occurrenceDateTime\": \"<string>\",\n \"recorded\": \"<string>\",\n \"primarySource\": true,\n \"manufacturer\": \"<string>\",\n \"lotNumber\": \"<string>\",\n \"expirationDate\": \"<string>\",\n \"site\": \"<string>\",\n \"route\": \"<string>\",\n \"doseQuantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"performer\": [\n {\n \"actorId\": \"<string>\",\n \"function\": \"<string>\"\n }\n ],\n \"note\": \"<string>\",\n \"reasonCode\": [\n \"<string>\"\n ],\n \"statusReason\": \"<string>\",\n \"isSubpotent\": true,\n \"reaction\": [\n {\n \"date\": \"<string>\",\n \"reported\": true\n }\n ],\n \"protocolApplied\": [\n {\n \"series\": \"<string>\",\n \"doseNumber\": 123,\n \"seriesDoses\": 123,\n \"targetDisease\": [\n \"<string>\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Your ClinikAPI secret key (clk_live_* or clk_test_*)
Body
application/json
Available options:
completed, not-done Maximum string length:
500Maximum string length:
128Maximum string length:
128Maximum string length:
50Maximum string length:
50Maximum string length:
500Maximum string length:
100Maximum string length:
50Maximum string length:
200Maximum string length:
200Show child attributes
Show child attributes
Maximum array length:
10Show child attributes
Show child attributes
Maximum string length:
5000Maximum array length:
10Maximum string length:
500Maximum string length:
500Maximum array length:
10Show child attributes
Show child attributes
Maximum array length:
10Show child attributes
Show child attributes
Response
201
Immunization created
⌘I