> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anivahealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Esikatsele ajanvaraus

> Esikatsele ajanvarauksen näyteputket ja lasku

Palauttaa tiedot siitä, mitä ajanvaraus tarvitsee siihen liitetyille paneeleille ja biomarkkereille. Mitään ei tilata.

* `containers`: putket, kortit tai kupit, jotka ammattilainen valmistelee.
* `pricing`: lasku hinnastosi mukaan. [Laske ostoskorin hinta](https://docs.anivahealth.com/fi/api/pricing/quote-cart.md) palauttaa saman
  laskun ilman ajanvarausta.
* `routing`: aina `null`.

Vaatii jonkin käyttöoikeuksista `appointments_view`, `appointments_schedule`, `appointments_operate` tai `appointments_manage`.

## Pyyntö

### Polkuparametrit

**id** `string` *required*

Sen ajanvarauksen yksilöllinen tunniste (UUID), jonka näyteastiavaatimukset esikatsellaan.

## Vastaus

Onnistuessaan API palauttaa tilakoodin `200 OK` sekä näyteastiavaatimukset ja tulevaa käyttöä varten varatut kentät.

**containers** `object[]` *required*

Taulukko tarvittavista näytteenottoastioista. Tyhjä, kun ajanvaraukseen ei ole lisätty paneeleita tai biomarkkereita. Tyhjä myös silloin, kun ajanvarauksen toimipistettä ja päivää ei voida vielä määrittää, esimerkiksi kun sillä ei ole sovittua ajankohtaa.

**näyteastia**

**type** `string`

Näyteastian tyypin tunniste. Yksi arvoista `serum`, `serum_capillary`, `serum_capillary_plain`, `edta`, `edta_capillary`, `citrate`, `lihep`, `lihep_capillary`, `glucoexact`, `fluoride`, `fluoride_capillary`, `homocysteine`, `urine`, `dried_blood_spot`, `swab`, `stool`, `saliva`, `hair` tai `trace_metal`.

**name** `string`

Näyteastian luettava nimi (esim. "Serum", "EDTA", "Li-Heparin").

**cap\_color** `string`

Näyteastian korkin heksavärikoodi näyttämistä varten (esim. `"#A0784B"`). `null`, kun
astiassa ei ole korkkia.

**volume** `string`

Näyteastian tilavuus (esim. `"7.5 ml"`). `null`, kun tilavuus ei ole sovellettavissa.

**article\_number** `string`

Valmistajan tuotenumero (REF), jos tiedossa (esim. `"01.1602.001"`). Jätetään pois näyteastioilta, joille ei ole määritetty tuotenumeroa.

**count** `integer`

Tarvittavien tämän tyypin näyteastioiden määrä.

**routing** `null`

Laboratorion reititystiedot — tarkoituksella piilotettu, aina `null`.

**pricing** `object | null`

Koko ostoskorin lasku ajanvaraukselle hinnastosi mukaan. `null`, kun ajanvaraukseen ei ole liitetty
testejä tai kun avaimeltasi puuttuu `prices_view`-käyttöoikeus. [Hinnoittelu](https://docs.anivahealth.com/fi/concepts/pricing.md) selittää
mallin; yksittäiset summat noudattavat [hintaobjektien](https://docs.anivahealth.com/fi/api/biomarkers/list-biomarkers.md#hintaobjektit)
kuvausta.

**Laskun kentät**

**total\_cents** `integer`

Ostoskorin hinta hinnastosi mukaan: hinnoitellut erät plus hinnoitellut paneelit plus hinnoitellut
biomarkkeririvit. Rivi, jonka arvo on `price_cents: null`, ei lisää mitään, joten sen sisältävän ostoskorin summa on pienempi
kuin sen lopullinen hinta.

**retail\_total\_cents** `integer`

Sama kokonaissumma suositellun vähittäishinnaston mukaan.

**fees** `object`

Maksut, jotka yksi verinäytteenotto lisää hinnastosi mukaan, sentteinä. Ne laskutetaan kuukausilaskulla. Katso [Hae hinnasto](https://docs.anivahealth.com/fi/api/pricing/get-rate-card.md).

**maksut**

**phlebotomy\_fee\_cents** `integer`

Verinäytteenottomaksu suoritettua ajanvarausta kohden.

**snack\_fee\_cents** `integer`

Välipala potilaalle. Laskutetaan vain, kun potilas saa välipalan. Jätetään pois, kun
potilaasi eivät saa välipalaa; ota yhteyttä Anivaan, jos haluat tarjota välipaloja.

**logistics\_fee\_cents** `integer`

Kuriirimaksu noudosta. Saman päivän ajanvarauksesi samassa toimipisteessä jakavat yhden
maksun.

**material\_fee\_cents** `integer`

Kulutustarvikkeet: putket, tarrat, pussi.

**total\_with\_fees\_cents** `integer`

`total_cents` sekä kaikki kentän `fees` maksut täydellä logistiikkamaksulla. Summa on
pienempi, kun toinen ajanvarauksistasi jakaa noudon.

**positions** `object[]`

Jokainen tässä korissa aktivoitunut positio — laskutetaan kerran kokonaisuudessaan, ja se
toimittaa koko jäsenjoukkonsa. Sisältää kentät `id`, `name`, `price_cents`, `retail_cents` ja
`tier`. Positio, joka ei näy kumppaneille, aktivoituu ja laskutetaan silti, ja sen `id` ja
`name` ilmoitetaan arvolla `null`.

**panels** `object[]`

Jokainen liitetty paneeli kenttinä `id`, `name`, `price_cents` ja `retail_cents`.

**biomarkers** `object[]`

Yksi rivi jokaista **toimitettua** biomarkkeria kohden — pyytämäsi biomarkkerit sekä niiden
suhdelukujen mukaan tuomat komponentit ja positioiden toimittamat jäsenet.

**id** `number`

Biomarkkerin tunniste.

**name** `string`

Biomarkkerin näyttönimi.

**price\_cents** `integer | null`

Tämän rivin hinta hinnastossasi, rinnallaan `retail_cents`. `0`, kun positio maksaa sen;
`null`, kun Aniva ei voi hinnoitella sitä.

**required\_by** `number[]`

Suhdeluvut, jotka toivat tämän komponentin koriin. Jätetään pois, jos yksikään ei tuonut sitä.
Komponentti maksetaan kerran koria kohden riippumatta siitä, kuinka moni suhdeluku käyttää sitä.

**requires** `number[]`

Mukana, kun tämä rivi ON suhdeluku: komponentit, joina se laskutetaan.

**via\_position** `string`

Positio, joka maksaa tämän markkerin, minkä vuoksi rivi maksaa `0`. Jätetään pois, jos mikään
ei kata sitä. `null`, kun kattava positio ei näy kumppaneille.

## Virhevastaukset

| Tila | Kuvaus |
| - | - |
| `400` | Virheellinen tunnistemuoto – annettu arvo ei ole kelvollinen UUID. |
| `403` | Pääsy estetty – API-avaimellasi ei ole oikeutta tähän toimintoon. |
| `404` | Ajanvarausta ei löytynyt. |
| `500` | Sisäinen palvelinvirhe. |

```bash cURL theme={null}
curl --request GET \
  --url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a/preview \
  --header 'x-api-key: YOUR_API_KEY'
```

```json 200 theme={null}
{
  "containers": [
    {
      "type": "serum",
      "name": "Serum",
      "cap_color": "#A0784B",
      "volume": "7.5 ml",
      "article_number": "01.1602.001",
      "count": 3
    },
    {
      "type": "edta",
      "name": "EDTA",
      "cap_color": "#D13438",
      "volume": "3.4 ml",
      "article_number": "04.1914.001",
      "count": 2
    },
    {
      "type": "glucoexact",
      "name": "GlucoEXACT",
      "cap_color": "#9E9E9E",
      "volume": "3.1 ml",
      "article_number": "05.1074.001",
      "count": 1
    }
  ],
  "routing": null,
  "pricing": {
    "total_cents": 13751,
    "retail_total_cents": 17029,
    "fees": {
      "phlebotomy_fee_cents": 2500,
      "snack_fee_cents": 500,
      "logistics_fee_cents": 2000,
      "material_fee_cents": 250
    },
    "total_with_fees_cents": 19001,
    "positions": [
      {
        "id": "b7d4c2e1-9a3f-4c8b-91d2-5e6f7a8b9c0d",
        "name": "Aniva Blood Count",
        "price_cents": 452,
        "retail_cents": 520,
        "tier": "routine"
      }
    ],
    "panels": [
      {
        "id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
        "name": "Hormones (Female)",
        "price_cents": 11900,
        "retail_cents": 14900
      }
    ],
    "biomarkers": [
      { "id": 42, "name": "HDL Cholesterol", "price_cents": 233, "retail_cents": 268, "required_by": [279] },
      {
        "id": 71,
        "name": "Hemoglobin",
        "price_cents": 0,
        "retail_cents": 0,
        "via_position": "b7d4c2e1-9a3f-4c8b-91d2-5e6f7a8b9c0d"
      },
      { "id": 84, "name": "High-Sensitivity C-Reactive Protein (hs-CRP)", "price_cents": 1166, "retail_cents": 1341, "required_by": [279] },
      { "id": 279, "name": "hs-CRP / HDL Ratio", "price_cents": 0, "retail_cents": 0, "requires": [42, 84] }
    ]
  }
}
```

```json 200 (no panels) theme={null}
{
  "containers": [],
  "routing": null,
  "pricing": null
}
```

```json 200 (one item without a price) theme={null}
{
  "containers": [],
  "routing": null,
  "pricing": {
    "total_cents": 11900,
    "retail_total_cents": 14900,
    "fees": {
      "phlebotomy_fee_cents": 2500,
      "snack_fee_cents": 500,
      "logistics_fee_cents": 2000,
      "material_fee_cents": 250
    },
    "total_with_fees_cents": 17150,
    "positions": [],
    "panels": [
      {
        "id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
        "name": "Hormones (Female)",
        "price_cents": 11900,
        "retail_cents": 14900
      }
    ],
    "biomarkers": [{ "id": 555, "name": "Poppy Seeds (Pap s)", "price_cents": null, "retail_cents": null }]
  }
}
```

```json 404 theme={null}
{
  "error": "Appointment not found"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.