Create medication dispense
curl --request POST \
--url https://api.clinikapi.com/v1/medication-dispenses \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"medication": "<string>",
"patientId": "<string>",
"encounterId": "<string>",
"statusReasonCodeableConcept": "<string>",
"category": "<string>",
"performer": [
{
"actorId": "<string>",
"function": "<string>"
}
],
"locationId": "<string>",
"authorizingPrescriptionIds": [
"<string>"
],
"type": "<string>",
"quantity": {
"value": 123,
"unit": "<string>"
},
"daysSupply": 123,
"whenPrepared": "<string>",
"whenHandedOver": "<string>",
"dosageText": "<string>",
"note": "<string>"
}
'import requests
url = "https://api.clinikapi.com/v1/medication-dispenses"
payload = {
"medication": "<string>",
"patientId": "<string>",
"encounterId": "<string>",
"statusReasonCodeableConcept": "<string>",
"category": "<string>",
"performer": [
{
"actorId": "<string>",
"function": "<string>"
}
],
"locationId": "<string>",
"authorizingPrescriptionIds": ["<string>"],
"type": "<string>",
"quantity": {
"value": 123,
"unit": "<string>"
},
"daysSupply": 123,
"whenPrepared": "<string>",
"whenHandedOver": "<string>",
"dosageText": "<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({
medication: '<string>',
patientId: '<string>',
encounterId: '<string>',
statusReasonCodeableConcept: '<string>',
category: '<string>',
performer: [{actorId: '<string>', function: '<string>'}],
locationId: '<string>',
authorizingPrescriptionIds: ['<string>'],
type: '<string>',
quantity: {value: 123, unit: '<string>'},
daysSupply: 123,
whenPrepared: '<string>',
whenHandedOver: '<string>',
dosageText: '<string>',
note: '<string>'
})
};
fetch('https://api.clinikapi.com/v1/medication-dispenses', 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-dispenses",
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([
'medication' => '<string>',
'patientId' => '<string>',
'encounterId' => '<string>',
'statusReasonCodeableConcept' => '<string>',
'category' => '<string>',
'performer' => [
[
'actorId' => '<string>',
'function' => '<string>'
]
],
'locationId' => '<string>',
'authorizingPrescriptionIds' => [
'<string>'
],
'type' => '<string>',
'quantity' => [
'value' => 123,
'unit' => '<string>'
],
'daysSupply' => 123,
'whenPrepared' => '<string>',
'whenHandedOver' => '<string>',
'dosageText' => '<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/medication-dispenses"
payload := strings.NewReader("{\n \"medication\": \"<string>\",\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"statusReasonCodeableConcept\": \"<string>\",\n \"category\": \"<string>\",\n \"performer\": [\n {\n \"actorId\": \"<string>\",\n \"function\": \"<string>\"\n }\n ],\n \"locationId\": \"<string>\",\n \"authorizingPrescriptionIds\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"daysSupply\": 123,\n \"whenPrepared\": \"<string>\",\n \"whenHandedOver\": \"<string>\",\n \"dosageText\": \"<string>\",\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/medication-dispenses")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"medication\": \"<string>\",\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"statusReasonCodeableConcept\": \"<string>\",\n \"category\": \"<string>\",\n \"performer\": [\n {\n \"actorId\": \"<string>\",\n \"function\": \"<string>\"\n }\n ],\n \"locationId\": \"<string>\",\n \"authorizingPrescriptionIds\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"daysSupply\": 123,\n \"whenPrepared\": \"<string>\",\n \"whenHandedOver\": \"<string>\",\n \"dosageText\": \"<string>\",\n \"note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/medication-dispenses")
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 \"medication\": \"<string>\",\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"statusReasonCodeableConcept\": \"<string>\",\n \"category\": \"<string>\",\n \"performer\": [\n {\n \"actorId\": \"<string>\",\n \"function\": \"<string>\"\n }\n ],\n \"locationId\": \"<string>\",\n \"authorizingPrescriptionIds\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"daysSupply\": 123,\n \"whenPrepared\": \"<string>\",\n \"whenHandedOver\": \"<string>\",\n \"dosageText\": \"<string>\",\n \"note\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyMedication Dispenses
Create Medication Dispense
POST
/
v1
/
medication-dispenses
Create medication dispense
curl --request POST \
--url https://api.clinikapi.com/v1/medication-dispenses \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"medication": "<string>",
"patientId": "<string>",
"encounterId": "<string>",
"statusReasonCodeableConcept": "<string>",
"category": "<string>",
"performer": [
{
"actorId": "<string>",
"function": "<string>"
}
],
"locationId": "<string>",
"authorizingPrescriptionIds": [
"<string>"
],
"type": "<string>",
"quantity": {
"value": 123,
"unit": "<string>"
},
"daysSupply": 123,
"whenPrepared": "<string>",
"whenHandedOver": "<string>",
"dosageText": "<string>",
"note": "<string>"
}
'import requests
url = "https://api.clinikapi.com/v1/medication-dispenses"
payload = {
"medication": "<string>",
"patientId": "<string>",
"encounterId": "<string>",
"statusReasonCodeableConcept": "<string>",
"category": "<string>",
"performer": [
{
"actorId": "<string>",
"function": "<string>"
}
],
"locationId": "<string>",
"authorizingPrescriptionIds": ["<string>"],
"type": "<string>",
"quantity": {
"value": 123,
"unit": "<string>"
},
"daysSupply": 123,
"whenPrepared": "<string>",
"whenHandedOver": "<string>",
"dosageText": "<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({
medication: '<string>',
patientId: '<string>',
encounterId: '<string>',
statusReasonCodeableConcept: '<string>',
category: '<string>',
performer: [{actorId: '<string>', function: '<string>'}],
locationId: '<string>',
authorizingPrescriptionIds: ['<string>'],
type: '<string>',
quantity: {value: 123, unit: '<string>'},
daysSupply: 123,
whenPrepared: '<string>',
whenHandedOver: '<string>',
dosageText: '<string>',
note: '<string>'
})
};
fetch('https://api.clinikapi.com/v1/medication-dispenses', 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-dispenses",
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([
'medication' => '<string>',
'patientId' => '<string>',
'encounterId' => '<string>',
'statusReasonCodeableConcept' => '<string>',
'category' => '<string>',
'performer' => [
[
'actorId' => '<string>',
'function' => '<string>'
]
],
'locationId' => '<string>',
'authorizingPrescriptionIds' => [
'<string>'
],
'type' => '<string>',
'quantity' => [
'value' => 123,
'unit' => '<string>'
],
'daysSupply' => 123,
'whenPrepared' => '<string>',
'whenHandedOver' => '<string>',
'dosageText' => '<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/medication-dispenses"
payload := strings.NewReader("{\n \"medication\": \"<string>\",\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"statusReasonCodeableConcept\": \"<string>\",\n \"category\": \"<string>\",\n \"performer\": [\n {\n \"actorId\": \"<string>\",\n \"function\": \"<string>\"\n }\n ],\n \"locationId\": \"<string>\",\n \"authorizingPrescriptionIds\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"daysSupply\": 123,\n \"whenPrepared\": \"<string>\",\n \"whenHandedOver\": \"<string>\",\n \"dosageText\": \"<string>\",\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/medication-dispenses")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"medication\": \"<string>\",\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"statusReasonCodeableConcept\": \"<string>\",\n \"category\": \"<string>\",\n \"performer\": [\n {\n \"actorId\": \"<string>\",\n \"function\": \"<string>\"\n }\n ],\n \"locationId\": \"<string>\",\n \"authorizingPrescriptionIds\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"daysSupply\": 123,\n \"whenPrepared\": \"<string>\",\n \"whenHandedOver\": \"<string>\",\n \"dosageText\": \"<string>\",\n \"note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/medication-dispenses")
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 \"medication\": \"<string>\",\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"statusReasonCodeableConcept\": \"<string>\",\n \"category\": \"<string>\",\n \"performer\": [\n {\n \"actorId\": \"<string>\",\n \"function\": \"<string>\"\n }\n ],\n \"locationId\": \"<string>\",\n \"authorizingPrescriptionIds\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"quantity\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"daysSupply\": 123,\n \"whenPrepared\": \"<string>\",\n \"whenHandedOver\": \"<string>\",\n \"dosageText\": \"<string>\",\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:
preparation, in-progress, cancelled, on-hold, completed, stopped, declined Maximum string length:
200Maximum string length:
128Maximum string length:
128Maximum string length:
500Maximum string length:
200Maximum array length:
20Show child attributes
Show child attributes
Maximum string length:
128Maximum array length:
10Maximum string length:
128Maximum string length:
200Show child attributes
Show child attributes
Maximum string length:
2000Show child attributes
Show child attributes
Maximum string length:
5000Response
201
Medication dispense created
⌘I