# `RouteOfAdministration`

How a medicine is taken: `oral`, `intravenous` and so on.

Use it as part of a [`DosageInstruction`](/docs/types/type-dosage-instruction.md), or to filter medicines by route.

## Shape

One of these 14 values:

`RouteOfAdministration.auricular`, `RouteOfAdministration.buccal`, `RouteOfAdministration.cutaneous`, `RouteOfAdministration.inhalation`, `RouteOfAdministration.intramuscular`, `RouteOfAdministration.intravenous`, `RouteOfAdministration.nasal`, `RouteOfAdministration.ocular`, `RouteOfAdministration.oral`, `RouteOfAdministration.rectal`, `RouteOfAdministration.subcutaneous`, `RouteOfAdministration.sublingual`, `RouteOfAdministration.transdermal`, `RouteOfAdministration.vaginal`.

## Example

```jadpo
RouteOfAdministration.oral
```

`text.parse(raw, as: RouteOfAdministration)` reads one from text that comes from outside. Text that isn't one at all fails `malformed`, such as `by mouth`, `IV` or `Oral use`.

## Good to know

- `text.format` shows the standard wording, such as "Oral use".
- `==` tells you whether two are the same. `<` and `list.sort_by` don't take it.

## In JSON

A string, in a request, a response or `json.write`:

```json
"oral"
"intravenous"
"subcutaneous"
```

## Details

<details>
<summary>Text form, storage, how it is shown, and operations</summary>

`RouteOfAdministration` is in the group Health, and has been in Jadpo since 0.1.0.

### Text form

`text.from` writes one standard text form, the same form `text.parse` reads back: `oral`, `intravenous` and `subcutaneous`.

### How it is stored

It is stored in one column named for the field, of type `text`. `intravenous` is stored as `'intravenous'`.

### How it is shown to people

`text.format(value, locale:)` shows it to people in their locale.

With `locale: Locale.en_gb`:

| Value | Shown |
|---|---|
| `oral` | `Oral use` |
| `intravenous` | `Intravenous use` |
| `subcutaneous` | `Subcutaneous use` |

### Operations

It also takes `text.parse`, `text.from`, `text.format`, `json.read`, `json.write` and `==`. [How every standard type behaves](/docs/every-standard-type-meets-one-contract.md) says how they work.

</details>