Create service request
curl --request POST \
--url https://api.clinikapi.com/v1/service-requests \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"patientId": "<string>",
"encounterId": "<string>",
"code": "<string>",
"category": [
"<string>"
],
"doNotPerform": true,
"occurrenceDateTime": "2023-11-07T05:31:56Z",
"occurrencePeriod": {
"start": "<string>",
"end": "<string>"
},
"asNeeded": true,
"authoredOn": "2023-11-07T05:31:56Z",
"requesterId": "<string>",
"performerType": "<string>",
"performerIds": [
"<string>"
],
"reasonCode": [
"<string>"
],
"bodySite": [
"<string>"
],
"note": "<string>",
"patientInstruction": "<string>",
"basedOn": [
"<string>"
],
"replaces": [
"<string>"
]
}
'import requests
url = "https://api.clinikapi.com/v1/service-requests"
payload = {
"patientId": "<string>",
"encounterId": "<string>",
"code": "<string>",
"category": ["<string>"],
"doNotPerform": True,
"occurrenceDateTime": "2023-11-07T05:31:56Z",
"occurrencePeriod": {
"start": "<string>",
"end": "<string>"
},
"asNeeded": True,
"authoredOn": "2023-11-07T05:31:56Z",
"requesterId": "<string>",
"performerType": "<string>",
"performerIds": ["<string>"],
"reasonCode": ["<string>"],
"bodySite": ["<string>"],
"note": "<string>",
"patientInstruction": "<string>",
"basedOn": ["<string>"],
"replaces": ["<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>',
code: '<string>',
category: ['<string>'],
doNotPerform: true,
occurrenceDateTime: '2023-11-07T05:31:56Z',
occurrencePeriod: {start: '<string>', end: '<string>'},
asNeeded: true,
authoredOn: '2023-11-07T05:31:56Z',
requesterId: '<string>',
performerType: '<string>',
performerIds: ['<string>'],
reasonCode: ['<string>'],
bodySite: ['<string>'],
note: '<string>',
patientInstruction: '<string>',
basedOn: ['<string>'],
replaces: ['<string>']
})
};
fetch('https://api.clinikapi.com/v1/service-requests', 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/service-requests",
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>',
'code' => '<string>',
'category' => [
'<string>'
],
'doNotPerform' => true,
'occurrenceDateTime' => '2023-11-07T05:31:56Z',
'occurrencePeriod' => [
'start' => '<string>',
'end' => '<string>'
],
'asNeeded' => true,
'authoredOn' => '2023-11-07T05:31:56Z',
'requesterId' => '<string>',
'performerType' => '<string>',
'performerIds' => [
'<string>'
],
'reasonCode' => [
'<string>'
],
'bodySite' => [
'<string>'
],
'note' => '<string>',
'patientInstruction' => '<string>',
'basedOn' => [
'<string>'
],
'replaces' => [
'<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/service-requests"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"code\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"doNotPerform\": true,\n \"occurrenceDateTime\": \"2023-11-07T05:31:56Z\",\n \"occurrencePeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"asNeeded\": true,\n \"authoredOn\": \"2023-11-07T05:31:56Z\",\n \"requesterId\": \"<string>\",\n \"performerType\": \"<string>\",\n \"performerIds\": [\n \"<string>\"\n ],\n \"reasonCode\": [\n \"<string>\"\n ],\n \"bodySite\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"patientInstruction\": \"<string>\",\n \"basedOn\": [\n \"<string>\"\n ],\n \"replaces\": [\n \"<string>\"\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/service-requests")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"code\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"doNotPerform\": true,\n \"occurrenceDateTime\": \"2023-11-07T05:31:56Z\",\n \"occurrencePeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"asNeeded\": true,\n \"authoredOn\": \"2023-11-07T05:31:56Z\",\n \"requesterId\": \"<string>\",\n \"performerType\": \"<string>\",\n \"performerIds\": [\n \"<string>\"\n ],\n \"reasonCode\": [\n \"<string>\"\n ],\n \"bodySite\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"patientInstruction\": \"<string>\",\n \"basedOn\": [\n \"<string>\"\n ],\n \"replaces\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/service-requests")
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 \"code\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"doNotPerform\": true,\n \"occurrenceDateTime\": \"2023-11-07T05:31:56Z\",\n \"occurrencePeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"asNeeded\": true,\n \"authoredOn\": \"2023-11-07T05:31:56Z\",\n \"requesterId\": \"<string>\",\n \"performerType\": \"<string>\",\n \"performerIds\": [\n \"<string>\"\n ],\n \"reasonCode\": [\n \"<string>\"\n ],\n \"bodySite\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"patientInstruction\": \"<string>\",\n \"basedOn\": [\n \"<string>\"\n ],\n \"replaces\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"error": "<string>",
"message": "<string>",
"code": "<string>",
"requestId": "<string>",
"issues": [
{
"severity": "<string>",
"code": "<string>",
"diagnostics": "<string>"
}
]
}Service Requests
Create Service Request
POST
/
v1
/
service-requests
Create service request
curl --request POST \
--url https://api.clinikapi.com/v1/service-requests \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"patientId": "<string>",
"encounterId": "<string>",
"code": "<string>",
"category": [
"<string>"
],
"doNotPerform": true,
"occurrenceDateTime": "2023-11-07T05:31:56Z",
"occurrencePeriod": {
"start": "<string>",
"end": "<string>"
},
"asNeeded": true,
"authoredOn": "2023-11-07T05:31:56Z",
"requesterId": "<string>",
"performerType": "<string>",
"performerIds": [
"<string>"
],
"reasonCode": [
"<string>"
],
"bodySite": [
"<string>"
],
"note": "<string>",
"patientInstruction": "<string>",
"basedOn": [
"<string>"
],
"replaces": [
"<string>"
]
}
'import requests
url = "https://api.clinikapi.com/v1/service-requests"
payload = {
"patientId": "<string>",
"encounterId": "<string>",
"code": "<string>",
"category": ["<string>"],
"doNotPerform": True,
"occurrenceDateTime": "2023-11-07T05:31:56Z",
"occurrencePeriod": {
"start": "<string>",
"end": "<string>"
},
"asNeeded": True,
"authoredOn": "2023-11-07T05:31:56Z",
"requesterId": "<string>",
"performerType": "<string>",
"performerIds": ["<string>"],
"reasonCode": ["<string>"],
"bodySite": ["<string>"],
"note": "<string>",
"patientInstruction": "<string>",
"basedOn": ["<string>"],
"replaces": ["<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>',
code: '<string>',
category: ['<string>'],
doNotPerform: true,
occurrenceDateTime: '2023-11-07T05:31:56Z',
occurrencePeriod: {start: '<string>', end: '<string>'},
asNeeded: true,
authoredOn: '2023-11-07T05:31:56Z',
requesterId: '<string>',
performerType: '<string>',
performerIds: ['<string>'],
reasonCode: ['<string>'],
bodySite: ['<string>'],
note: '<string>',
patientInstruction: '<string>',
basedOn: ['<string>'],
replaces: ['<string>']
})
};
fetch('https://api.clinikapi.com/v1/service-requests', 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/service-requests",
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>',
'code' => '<string>',
'category' => [
'<string>'
],
'doNotPerform' => true,
'occurrenceDateTime' => '2023-11-07T05:31:56Z',
'occurrencePeriod' => [
'start' => '<string>',
'end' => '<string>'
],
'asNeeded' => true,
'authoredOn' => '2023-11-07T05:31:56Z',
'requesterId' => '<string>',
'performerType' => '<string>',
'performerIds' => [
'<string>'
],
'reasonCode' => [
'<string>'
],
'bodySite' => [
'<string>'
],
'note' => '<string>',
'patientInstruction' => '<string>',
'basedOn' => [
'<string>'
],
'replaces' => [
'<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/service-requests"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"code\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"doNotPerform\": true,\n \"occurrenceDateTime\": \"2023-11-07T05:31:56Z\",\n \"occurrencePeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"asNeeded\": true,\n \"authoredOn\": \"2023-11-07T05:31:56Z\",\n \"requesterId\": \"<string>\",\n \"performerType\": \"<string>\",\n \"performerIds\": [\n \"<string>\"\n ],\n \"reasonCode\": [\n \"<string>\"\n ],\n \"bodySite\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"patientInstruction\": \"<string>\",\n \"basedOn\": [\n \"<string>\"\n ],\n \"replaces\": [\n \"<string>\"\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/service-requests")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"encounterId\": \"<string>\",\n \"code\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"doNotPerform\": true,\n \"occurrenceDateTime\": \"2023-11-07T05:31:56Z\",\n \"occurrencePeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"asNeeded\": true,\n \"authoredOn\": \"2023-11-07T05:31:56Z\",\n \"requesterId\": \"<string>\",\n \"performerType\": \"<string>\",\n \"performerIds\": [\n \"<string>\"\n ],\n \"reasonCode\": [\n \"<string>\"\n ],\n \"bodySite\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"patientInstruction\": \"<string>\",\n \"basedOn\": [\n \"<string>\"\n ],\n \"replaces\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/service-requests")
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 \"code\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"doNotPerform\": true,\n \"occurrenceDateTime\": \"2023-11-07T05:31:56Z\",\n \"occurrencePeriod\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"asNeeded\": true,\n \"authoredOn\": \"2023-11-07T05:31:56Z\",\n \"requesterId\": \"<string>\",\n \"performerType\": \"<string>\",\n \"performerIds\": [\n \"<string>\"\n ],\n \"reasonCode\": [\n \"<string>\"\n ],\n \"bodySite\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"patientInstruction\": \"<string>\",\n \"basedOn\": [\n \"<string>\"\n ],\n \"replaces\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"error": "<string>",
"message": "<string>",
"code": "<string>",
"requestId": "<string>",
"issues": [
{
"severity": "<string>",
"code": "<string>",
"diagnostics": "<string>"
}
]
}Authorizations
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, original-order, reflex-order, filler-order, instance-order, option Available options:
routine, urgent, asap, stat Show child attributes
Show child attributes
Maximum string length:
2000Maximum string length:
2000Response
Service request created
⌘I