set -eu
umask 077
# Path values must be URL-encoded; query string excludes the leading question mark.
url="${HD_BASE_URL:?Set API origin}/v1/partner/consultations/${HD_QUERY_STRING:+?${HD_QUERY_STRING}}"
printf 'Accept: application/json\n' > "${HD_REQUEST_HEADERS_FILE:?Private header file}"
printf 'Authorization: Bearer %s\n' "${HD_PARTNER_API_KEY:?Set partner API key}" >> "$HD_REQUEST_HEADERS_FILE"
# Create the Idempotency-Key once per logical request, store it before the first attempt and send the same value on every retry.
printf 'Idempotency-Key: %s\n' "${HD_IDEMPOTENCY_KEY:?Set the stored Idempotency-Key; reuse it on retry}" >> "$HD_REQUEST_HEADERS_FILE"
curl --silent --show-error --max-time 30 --request POST \
--header "@$HD_REQUEST_HEADERS_FILE" \
--dump-header "${HD_HEADERS_FILE:?Private response header file}" \
--output "${HD_RESPONSE_FILE:?Private response file}" \
--write-out '%{http_code}\n%{content_type}\n' \
--header 'Content-Type: application/json' \
--data-binary "@${HD_REQUEST_FILE:?JSON fixture file}" \
"$url"import os, json
from pathlib import Path
from urllib.parse import quote
import requests
os.umask(0o077)
url = os.environ["HD_BASE_URL"].rstrip("/") + '/v1/partner/consultations/'
if os.environ.get("HD_QUERY_STRING"): url += "?" + os.environ["HD_QUERY_STRING"]
headers = {"Accept": 'application/json'}
headers["Authorization"] = "Bearer " + os.environ["HD_PARTNER_API_KEY"]
# Create the Idempotency-Key once per logical request, store it before the first attempt and send the same value on every retry.
headers["Idempotency-Key"] = os.environ["HD_IDEMPOTENCY_KEY"]
kwargs = {}
kwargs["json"] = json.loads(Path(os.environ["HD_REQUEST_FILE"]).read_text())
response = requests.request('POST', url, headers=headers, timeout=30, allow_redirects=False, **kwargs)
Path(os.environ["HD_RESPONSE_FILE"]).write_bytes(response.content)
Path(os.environ["HD_HEADERS_FILE"]).write_text(json.dumps(dict(response.headers)))
print(response.status_code)
print(response.headers.get("Content-Type", ""))
import { readFileSync, writeFileSync } from "node:fs";
const env = process.env;
let url = env.HD_BASE_URL.replace(/\/$/, "") + "/v1/partner/consultations/";
if (env.HD_QUERY_STRING) url += "?" + env.HD_QUERY_STRING;
const headers = { "Accept": "application/json" };
headers.Authorization = "Bearer " + env.HD_PARTNER_API_KEY;
// Create the Idempotency-Key once per logical request, store it before the first attempt and send the same value on every retry.
headers["Idempotency-Key"] = env.HD_IDEMPOTENCY_KEY;
const options = { method: "POST", headers, redirect: "manual", signal: AbortSignal.timeout(30000) };
headers["Content-Type"] = "application/json";
options.body = readFileSync(env.HD_REQUEST_FILE, "utf8");
const response = await fetch(url, options);
writeFileSync(env.HD_RESPONSE_FILE, Buffer.from(await response.arrayBuffer()), {mode: 0o600});
writeFileSync(env.HD_HEADERS_FILE, JSON.stringify(Object.fromEntries(response.headers)), {mode: 0o600});
console.log(response.status);
console.log(response.headers.get("content-type") ?? "");
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hi-doctor.ai/v1/partner/consultations/",
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([
'product_id' => 'oral_finasteride',
'country' => 'ES',
'plan_key' => 'one_off',
'dosage' => '1 mg',
'locale' => 'es',
'schema_version' => '412',
'schema_hash' => '<HASH>',
'external_reference' => 'order-10045',
'patient' => [
'external_patient_id' => 'cust-8812',
'email' => 'patient@example.com',
'first_name' => 'Sam',
'last_name' => 'Example',
'date_of_birth' => '1988-04-02',
'sex' => 'male',
'phone' => '+34600000000',
'address' => [
'line1' => 'Calle Example 1',
'line2' => '2B',
'city' => 'Madrid',
'postal_code' => '28001',
'country' => 'ES'
],
'national_identifier' => [
'type' => 'dni',
'value' => '12345678Z'
],
'consent' => [
'terms_accepted' => true,
'privacy_accepted' => true,
'clinical_data_processing_accepted' => true,
'accepted_at' => '2026-11-03T10:10:00Z',
'notice_version' => 'pn-2026-11',
'evidence_reference' => 'consent-log-55102',
'ip' => '203.0.113.24'
]
],
'answers' => [
[
'question_key' => 'hair_loss_duration',
'value' => 'over_1_year'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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.hi-doctor.ai/v1/partner/consultations/"
payload := strings.NewReader("{\n \"product_id\": \"oral_finasteride\",\n \"country\": \"ES\",\n \"plan_key\": \"one_off\",\n \"dosage\": \"1 mg\",\n \"locale\": \"es\",\n \"schema_version\": \"412\",\n \"schema_hash\": \"<HASH>\",\n \"external_reference\": \"order-10045\",\n \"patient\": {\n \"external_patient_id\": \"cust-8812\",\n \"email\": \"patient@example.com\",\n \"first_name\": \"Sam\",\n \"last_name\": \"Example\",\n \"date_of_birth\": \"1988-04-02\",\n \"sex\": \"male\",\n \"phone\": \"+34600000000\",\n \"address\": {\n \"line1\": \"Calle Example 1\",\n \"line2\": \"2B\",\n \"city\": \"Madrid\",\n \"postal_code\": \"28001\",\n \"country\": \"ES\"\n },\n \"national_identifier\": {\n \"type\": \"dni\",\n \"value\": \"12345678Z\"\n },\n \"consent\": {\n \"terms_accepted\": true,\n \"privacy_accepted\": true,\n \"clinical_data_processing_accepted\": true,\n \"accepted_at\": \"2026-11-03T10:10:00Z\",\n \"notice_version\": \"pn-2026-11\",\n \"evidence_reference\": \"consent-log-55102\",\n \"ip\": \"203.0.113.24\"\n }\n },\n \"answers\": [\n {\n \"question_key\": \"hair_loss_duration\",\n \"value\": \"over_1_year\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
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.hi-doctor.ai/v1/partner/consultations/")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"product_id\": \"oral_finasteride\",\n \"country\": \"ES\",\n \"plan_key\": \"one_off\",\n \"dosage\": \"1 mg\",\n \"locale\": \"es\",\n \"schema_version\": \"412\",\n \"schema_hash\": \"<HASH>\",\n \"external_reference\": \"order-10045\",\n \"patient\": {\n \"external_patient_id\": \"cust-8812\",\n \"email\": \"patient@example.com\",\n \"first_name\": \"Sam\",\n \"last_name\": \"Example\",\n \"date_of_birth\": \"1988-04-02\",\n \"sex\": \"male\",\n \"phone\": \"+34600000000\",\n \"address\": {\n \"line1\": \"Calle Example 1\",\n \"line2\": \"2B\",\n \"city\": \"Madrid\",\n \"postal_code\": \"28001\",\n \"country\": \"ES\"\n },\n \"national_identifier\": {\n \"type\": \"dni\",\n \"value\": \"12345678Z\"\n },\n \"consent\": {\n \"terms_accepted\": true,\n \"privacy_accepted\": true,\n \"clinical_data_processing_accepted\": true,\n \"accepted_at\": \"2026-11-03T10:10:00Z\",\n \"notice_version\": \"pn-2026-11\",\n \"evidence_reference\": \"consent-log-55102\",\n \"ip\": \"203.0.113.24\"\n }\n },\n \"answers\": [\n {\n \"question_key\": \"hair_loss_duration\",\n \"value\": \"over_1_year\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hi-doctor.ai/v1/partner/consultations/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"product_id\": \"oral_finasteride\",\n \"country\": \"ES\",\n \"plan_key\": \"one_off\",\n \"dosage\": \"1 mg\",\n \"locale\": \"es\",\n \"schema_version\": \"412\",\n \"schema_hash\": \"<HASH>\",\n \"external_reference\": \"order-10045\",\n \"patient\": {\n \"external_patient_id\": \"cust-8812\",\n \"email\": \"patient@example.com\",\n \"first_name\": \"Sam\",\n \"last_name\": \"Example\",\n \"date_of_birth\": \"1988-04-02\",\n \"sex\": \"male\",\n \"phone\": \"+34600000000\",\n \"address\": {\n \"line1\": \"Calle Example 1\",\n \"line2\": \"2B\",\n \"city\": \"Madrid\",\n \"postal_code\": \"28001\",\n \"country\": \"ES\"\n },\n \"national_identifier\": {\n \"type\": \"dni\",\n \"value\": \"12345678Z\"\n },\n \"consent\": {\n \"terms_accepted\": true,\n \"privacy_accepted\": true,\n \"clinical_data_processing_accepted\": true,\n \"accepted_at\": \"2026-11-03T10:10:00Z\",\n \"notice_version\": \"pn-2026-11\",\n \"evidence_reference\": \"consent-log-55102\",\n \"ip\": \"203.0.113.24\"\n }\n },\n \"answers\": [\n {\n \"question_key\": \"hair_loss_duration\",\n \"value\": \"over_1_year\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "7f8b1c2e-4d5a-4e6f-9a0b-1c2d3e4f5a6b",
"object": "consultation",
"mode": "test",
"status": "submitted",
"version": 1,
"status_history": [
{
"status": "submitted",
"version": 1,
"at": "2026-11-03T10:15:00Z"
}
],
"external_reference": "order-10045",
"product": {
"product_id": "oral_finasteride",
"name": "Oral finasteride"
},
"country": "ES",
"plan_key": "one_off",
"dosage": "1 mg",
"patient": {
"id": "0e1d2c3b-4a59-4687-8b9a-0b1c2d3e4f50",
"external_patient_id": "cust-8812"
},
"submitted_at": "2026-11-03T10:15:00Z",
"updated_at": "2026-11-03T10:15:00Z",
"reviewer": null,
"decision": null,
"open_info_request": null,
"prescriptions": [],
"billing": {
"state": "pending",
"price": {
"amount_cents": 2900,
"currency": "EUR"
}
},
"cancellable": true
}Submit a consultation
Submits a patient’s questionnaire answers for clinical review. The patient’s consent flags must all be true and the notice version must be the current one (otherwise 422 consent_notice_outdated with current_notice_version). schema_version and schema_hash must name the published questionnaire (otherwise 409 schema_outdated with the current pair). Retries with the same Idempotency-Key and body return the original response.
Answer only the questions that apply after branching: an answer to a step the other answers hide (conditional display) is refused with 422 unexpected_question_key, one error item per hidden question_key. Errors never repeat a submitted answer value or identifier; they name the question_key instead (an unexpected question_key is echoed as sent). A pharmacy selection that is not valid for the patient’s country is refused with 422 pharmacy_selection_invalid (question_key pharmacy_selection), whatever the directory’s reason.
patient.national_identifier is optional: send it where the product country’s prescribing needs one (otherwise 422 patient_identifier_required, unless the identifier is already stored for the patient). An unknown type or invalid value is refused with 422 invalid_request (field patient.national_identifier, code invalid_identifier); it is never echoed or returned. In live mode it is stored on the patient’s account the first time; a different identifier for the same patient is refused with 409 patient_conflict and never overwrites it. Test mode validates it and stores nothing.
patient.identity_document is optional: send it where electronic prescribing in the patient’s country needs the patient’s identity document before approval (a national id_card or a passport, with the country that issued it). It is validated like the patient’s own profile (5 to 20 letters or digits; for a few issuing countries an id_card number is also checked against its national format); one that breaks those rules is refused with 422 invalid_request (field patient.identity_document, code invalid_identity_document). Structural errors keep their nested field errors (for example field patient.identity_document.type, code invalid_choice, for an unsupported type; patient.identity_document.number, code required, when the number is missing). It is never echoed or returned. In live mode it is stored on the patient’s account the first time; a different document for the same patient is refused with 409 patient_conflict and never overwrites it. Test mode validates it and stores nothing. Without it, the reviewing doctor, if they need it, asks through an information request with reason_code identity_document_required.
patient.address line1 and line2 are stored joined with ”, ” in one street line of at most 200 characters (separator included); a longer address is refused with 422 invalid_request (field patient.address), never truncated. patient.address.country is the patient’s country of residence and must be an EU member state (ISO 3166-1 alpha-2 or alpha-3), in test and live mode alike; any other value is refused with 422 invalid_request (field patient.address.country, code residence_outside_eu). Without it, the product country is the residence. A patient who withdrew consent is refused with 409 consent_withdrawn. Requires the consultations:write scope.
Access, effects and retries
Ownership: The API key’s own partner and mode (test or live).
Prerequisites: A partner API key with the consultations:write scope.
Effects: Creates the consultation (and the patient on first submission) and sends it to clinical review; emits consultation webhook events.
Retries: Required Idempotency-Key: a retry with the same key and body within 24 hours returns the stored response.
set -eu
umask 077
# Path values must be URL-encoded; query string excludes the leading question mark.
url="${HD_BASE_URL:?Set API origin}/v1/partner/consultations/${HD_QUERY_STRING:+?${HD_QUERY_STRING}}"
printf 'Accept: application/json\n' > "${HD_REQUEST_HEADERS_FILE:?Private header file}"
printf 'Authorization: Bearer %s\n' "${HD_PARTNER_API_KEY:?Set partner API key}" >> "$HD_REQUEST_HEADERS_FILE"
# Create the Idempotency-Key once per logical request, store it before the first attempt and send the same value on every retry.
printf 'Idempotency-Key: %s\n' "${HD_IDEMPOTENCY_KEY:?Set the stored Idempotency-Key; reuse it on retry}" >> "$HD_REQUEST_HEADERS_FILE"
curl --silent --show-error --max-time 30 --request POST \
--header "@$HD_REQUEST_HEADERS_FILE" \
--dump-header "${HD_HEADERS_FILE:?Private response header file}" \
--output "${HD_RESPONSE_FILE:?Private response file}" \
--write-out '%{http_code}\n%{content_type}\n' \
--header 'Content-Type: application/json' \
--data-binary "@${HD_REQUEST_FILE:?JSON fixture file}" \
"$url"import os, json
from pathlib import Path
from urllib.parse import quote
import requests
os.umask(0o077)
url = os.environ["HD_BASE_URL"].rstrip("/") + '/v1/partner/consultations/'
if os.environ.get("HD_QUERY_STRING"): url += "?" + os.environ["HD_QUERY_STRING"]
headers = {"Accept": 'application/json'}
headers["Authorization"] = "Bearer " + os.environ["HD_PARTNER_API_KEY"]
# Create the Idempotency-Key once per logical request, store it before the first attempt and send the same value on every retry.
headers["Idempotency-Key"] = os.environ["HD_IDEMPOTENCY_KEY"]
kwargs = {}
kwargs["json"] = json.loads(Path(os.environ["HD_REQUEST_FILE"]).read_text())
response = requests.request('POST', url, headers=headers, timeout=30, allow_redirects=False, **kwargs)
Path(os.environ["HD_RESPONSE_FILE"]).write_bytes(response.content)
Path(os.environ["HD_HEADERS_FILE"]).write_text(json.dumps(dict(response.headers)))
print(response.status_code)
print(response.headers.get("Content-Type", ""))
import { readFileSync, writeFileSync } from "node:fs";
const env = process.env;
let url = env.HD_BASE_URL.replace(/\/$/, "") + "/v1/partner/consultations/";
if (env.HD_QUERY_STRING) url += "?" + env.HD_QUERY_STRING;
const headers = { "Accept": "application/json" };
headers.Authorization = "Bearer " + env.HD_PARTNER_API_KEY;
// Create the Idempotency-Key once per logical request, store it before the first attempt and send the same value on every retry.
headers["Idempotency-Key"] = env.HD_IDEMPOTENCY_KEY;
const options = { method: "POST", headers, redirect: "manual", signal: AbortSignal.timeout(30000) };
headers["Content-Type"] = "application/json";
options.body = readFileSync(env.HD_REQUEST_FILE, "utf8");
const response = await fetch(url, options);
writeFileSync(env.HD_RESPONSE_FILE, Buffer.from(await response.arrayBuffer()), {mode: 0o600});
writeFileSync(env.HD_HEADERS_FILE, JSON.stringify(Object.fromEntries(response.headers)), {mode: 0o600});
console.log(response.status);
console.log(response.headers.get("content-type") ?? "");
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hi-doctor.ai/v1/partner/consultations/",
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([
'product_id' => 'oral_finasteride',
'country' => 'ES',
'plan_key' => 'one_off',
'dosage' => '1 mg',
'locale' => 'es',
'schema_version' => '412',
'schema_hash' => '<HASH>',
'external_reference' => 'order-10045',
'patient' => [
'external_patient_id' => 'cust-8812',
'email' => 'patient@example.com',
'first_name' => 'Sam',
'last_name' => 'Example',
'date_of_birth' => '1988-04-02',
'sex' => 'male',
'phone' => '+34600000000',
'address' => [
'line1' => 'Calle Example 1',
'line2' => '2B',
'city' => 'Madrid',
'postal_code' => '28001',
'country' => 'ES'
],
'national_identifier' => [
'type' => 'dni',
'value' => '12345678Z'
],
'consent' => [
'terms_accepted' => true,
'privacy_accepted' => true,
'clinical_data_processing_accepted' => true,
'accepted_at' => '2026-11-03T10:10:00Z',
'notice_version' => 'pn-2026-11',
'evidence_reference' => 'consent-log-55102',
'ip' => '203.0.113.24'
]
],
'answers' => [
[
'question_key' => 'hair_loss_duration',
'value' => 'over_1_year'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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.hi-doctor.ai/v1/partner/consultations/"
payload := strings.NewReader("{\n \"product_id\": \"oral_finasteride\",\n \"country\": \"ES\",\n \"plan_key\": \"one_off\",\n \"dosage\": \"1 mg\",\n \"locale\": \"es\",\n \"schema_version\": \"412\",\n \"schema_hash\": \"<HASH>\",\n \"external_reference\": \"order-10045\",\n \"patient\": {\n \"external_patient_id\": \"cust-8812\",\n \"email\": \"patient@example.com\",\n \"first_name\": \"Sam\",\n \"last_name\": \"Example\",\n \"date_of_birth\": \"1988-04-02\",\n \"sex\": \"male\",\n \"phone\": \"+34600000000\",\n \"address\": {\n \"line1\": \"Calle Example 1\",\n \"line2\": \"2B\",\n \"city\": \"Madrid\",\n \"postal_code\": \"28001\",\n \"country\": \"ES\"\n },\n \"national_identifier\": {\n \"type\": \"dni\",\n \"value\": \"12345678Z\"\n },\n \"consent\": {\n \"terms_accepted\": true,\n \"privacy_accepted\": true,\n \"clinical_data_processing_accepted\": true,\n \"accepted_at\": \"2026-11-03T10:10:00Z\",\n \"notice_version\": \"pn-2026-11\",\n \"evidence_reference\": \"consent-log-55102\",\n \"ip\": \"203.0.113.24\"\n }\n },\n \"answers\": [\n {\n \"question_key\": \"hair_loss_duration\",\n \"value\": \"over_1_year\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
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.hi-doctor.ai/v1/partner/consultations/")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"product_id\": \"oral_finasteride\",\n \"country\": \"ES\",\n \"plan_key\": \"one_off\",\n \"dosage\": \"1 mg\",\n \"locale\": \"es\",\n \"schema_version\": \"412\",\n \"schema_hash\": \"<HASH>\",\n \"external_reference\": \"order-10045\",\n \"patient\": {\n \"external_patient_id\": \"cust-8812\",\n \"email\": \"patient@example.com\",\n \"first_name\": \"Sam\",\n \"last_name\": \"Example\",\n \"date_of_birth\": \"1988-04-02\",\n \"sex\": \"male\",\n \"phone\": \"+34600000000\",\n \"address\": {\n \"line1\": \"Calle Example 1\",\n \"line2\": \"2B\",\n \"city\": \"Madrid\",\n \"postal_code\": \"28001\",\n \"country\": \"ES\"\n },\n \"national_identifier\": {\n \"type\": \"dni\",\n \"value\": \"12345678Z\"\n },\n \"consent\": {\n \"terms_accepted\": true,\n \"privacy_accepted\": true,\n \"clinical_data_processing_accepted\": true,\n \"accepted_at\": \"2026-11-03T10:10:00Z\",\n \"notice_version\": \"pn-2026-11\",\n \"evidence_reference\": \"consent-log-55102\",\n \"ip\": \"203.0.113.24\"\n }\n },\n \"answers\": [\n {\n \"question_key\": \"hair_loss_duration\",\n \"value\": \"over_1_year\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hi-doctor.ai/v1/partner/consultations/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"product_id\": \"oral_finasteride\",\n \"country\": \"ES\",\n \"plan_key\": \"one_off\",\n \"dosage\": \"1 mg\",\n \"locale\": \"es\",\n \"schema_version\": \"412\",\n \"schema_hash\": \"<HASH>\",\n \"external_reference\": \"order-10045\",\n \"patient\": {\n \"external_patient_id\": \"cust-8812\",\n \"email\": \"patient@example.com\",\n \"first_name\": \"Sam\",\n \"last_name\": \"Example\",\n \"date_of_birth\": \"1988-04-02\",\n \"sex\": \"male\",\n \"phone\": \"+34600000000\",\n \"address\": {\n \"line1\": \"Calle Example 1\",\n \"line2\": \"2B\",\n \"city\": \"Madrid\",\n \"postal_code\": \"28001\",\n \"country\": \"ES\"\n },\n \"national_identifier\": {\n \"type\": \"dni\",\n \"value\": \"12345678Z\"\n },\n \"consent\": {\n \"terms_accepted\": true,\n \"privacy_accepted\": true,\n \"clinical_data_processing_accepted\": true,\n \"accepted_at\": \"2026-11-03T10:10:00Z\",\n \"notice_version\": \"pn-2026-11\",\n \"evidence_reference\": \"consent-log-55102\",\n \"ip\": \"203.0.113.24\"\n }\n },\n \"answers\": [\n {\n \"question_key\": \"hair_loss_duration\",\n \"value\": \"over_1_year\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "7f8b1c2e-4d5a-4e6f-9a0b-1c2d3e4f5a6b",
"object": "consultation",
"mode": "test",
"status": "submitted",
"version": 1,
"status_history": [
{
"status": "submitted",
"version": 1,
"at": "2026-11-03T10:15:00Z"
}
],
"external_reference": "order-10045",
"product": {
"product_id": "oral_finasteride",
"name": "Oral finasteride"
},
"country": "ES",
"plan_key": "one_off",
"dosage": "1 mg",
"patient": {
"id": "0e1d2c3b-4a59-4687-8b9a-0b1c2d3e4f50",
"external_patient_id": "cust-8812"
},
"submitted_at": "2026-11-03T10:15:00Z",
"updated_at": "2026-11-03T10:15:00Z",
"reviewer": null,
"decision": null,
"open_info_request": null,
"prescriptions": [],
"billing": {
"state": "pending",
"price": {
"amount_cents": 2900,
"currency": "EUR"
}
},
"cancellable": true
}Authorizations
Partner API key sent as Authorization: Bearer . Test keys and live keys are separate.
Headers
A unique key per logical request. Retrying with the same key and body returns the stored response for 24 hours instead of creating a second consultation; the same key with a different body is refused.
^[A-Za-z0-9_-]{8,128}$Body
Product id from GET /v1/partner/products.
1 - 64\SISO 3166-1 alpha-2 code of a country your partner catalogue offers the product in.
1 - 3\SOne of the product's plans[].plan_key for the country.
1 - 32\Sschema_version of the questionnaire you rendered.
1 - 64\Sschema_hash of the questionnaire you rendered, with or without a locale.
1 - 64\SPatient identity, consent and optional national identifier.
Show child attributes
Show child attributes
The patient's answers as entries-v1 entries keyed by question_key. Answer only the steps that apply after branching.
1One entries-v1 answer: question_key plus exactly one payload, value, values or skip, as the question kind requires.
- Option 1
- Option 2
Show child attributes
Show child attributes
One of the product's dosages[].dosage, when the product lists dosages.
32Two-letter language code saved as the language of a new patient account; empty uses your partner default.
2Your order or case reference, unique per partner and mode.
128Response
The new consultation.
The consultation id.
Always consultation.
consultation test or live, from the API key.
live, test Current consultation status.
submitted, in_review, info_requested, approved, rejected, cancelled Increases with every change to the consultation's public state, i.e. every field of this object except version, status_history, updated_at and product.name (catalogue copy: a product rename does not advance it). Events carry the same number.
Every status change, oldest first.
Show child attributes
Show child attributes
Your order or case reference; null when none was sent.
The product.
Show child attributes
Show child attributes
ISO 3166-1 alpha-2 country code.
The chosen plan.
The chosen dosage; null when the product has none.
The patient.
Show child attributes
Show child attributes
When the consultation was submitted.
When it last changed.
Present once the reviewing doctor has opened the case.
Show child attributes
Show child attributes
The clinical decision; null until one is recorded.
Show child attributes
Show child attributes
The open information request; null when there is none.
Show child attributes
Show child attributes
Prescriptions issued for the consultation.
Show child attributes
Show child attributes
Billing state and price of the consultation.
Show child attributes
Show child attributes
true exactly when POST /consultations/{consultation_id}/cancel would succeed now: the consultation is submitted, has no prescription, and (live) no doctor has opened it, no decision or electronic prescription signing has started, and no prescription issuance or replacement is in flight.