CVX API
Look up CVX vaccine codes from the CDC.
Overview
CVX (Vaccine Administered) codes are maintained by the CDC and identify vaccines administered to patients. FHIRfly provides fast lookups against the CDC's CVX code set.
Endpoints
| Method | Path | Description |
|---|---|---|
| GET | /v1/cvx/:code | Single CVX lookup |
| POST | /v1/cvx/_batch | Batch lookup (up to 100) |
| GET | /v1/cvx/shapes | List available response shapes |
Single Lookup
Look up COVID-19 Moderna vaccine
Request
curl -X GET "https://api.fhirfly.io/v1/cvx/207" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"Response
Common CVX Codes
| Code | Vaccine |
|---|---|
| 208 | Pfizer-BioNTech COVID-19 |
| 207 | Moderna COVID-19 |
| 140 | Influenza, seasonal |
| 03 | MMR |
| 21 | Varicella |
Batch Lookup
Look up multiple CVX codes in a single request (up to 100):
Look up multiple vaccines
Request
curl -X POST "https://api.fhirfly.io/v1/cvx/_batch" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"codes": [
"207",
"208",
"140"
]
}'Response
Response Shapes
Control the level of detail in responses with the shape query parameter:
| Shape | Description |
|---|---|
compact | Code, display, status |
standard | + full_vaccine_name, notes, vaccine_type, fhir_coding |
full | + short_description, ingest metadata |
# Minimal data
GET /v1/cvx/207?shape=compact
# Standard data (default)
GET /v1/cvx/207?shape=standard
# Full data with provenance
GET /v1/cvx/207?shape=full
See Response Shapes for field details.
Required Scopes
cvx:read- Single lookupscvx:batch- Batch lookups