Skip to content
Avara
Get started
API Reference
Auto Scribe
Clinical References

List clinical references

auto_scribe.clinical_references.list(ClinicalReferenceListParams**kwargs) -> SyncCursorClinicalReferences[ClinicalReference]
GET/v1/autoScribe/clinicalReferences

Lists clinical references with cursor-based pagination and optional filters.

ParametersExpand Collapse
cursor: Optional[str]

Base64 encoded cursor from previous response

express_customer_id: Optional[str]

Filter by Express customer ID. Omit for no filter; pass null for clinic-wide references

is_active: Optional[bool]

Filter by active status. Defaults to true (active references only). Pass false to list inactive references.

limit: Optional[float]

Number of results to return (1-100)

minimum1
maximum100
type: Optional[ClinicalReferenceType]

Filter by clinical reference type

One of the following:
"facility"
"referring_provider"
"study_description"
"procedure"
ReturnsExpand Collapse
class ClinicalReference: …

A canonical clinical reference value for study workflow pickers and normalization

clinical_reference_id: str

Unique clinical reference identifier. Format: ref_{32-hex-chars}

created_at: Optional[datetime]

Timestamp when the clinical reference was created

formatdate-time
is_active: bool

Whether this reference is active and available for pickers

name: str

Canonical display name for this reference value

minLength1
type: ClinicalReferenceType

Category of canonical clinical reference value used for study workflow pickers and normalization.

One of the following:
"facility"
"referring_provider"
"study_description"
"procedure"
updated_at: Optional[datetime]

Timestamp when the clinical reference was last updated

formatdate-time
express_customer: Optional[ExpressCustomerReference]

A reference to an Express customer with basic identifying information

express_customer_id: str

Unique Express customer identifier. Format: cus_{32-hex-chars}

express_customer_name: str

Name of the Express customer

minLength1
external_reference_id: Optional[str]

Integrator-provided stable identifier for mapping inbound data

metadata: Optional[Dict[str, str]]

Optional key-value metadata. Maximum 50 pairs

List clinical references

import os
from avara import Avara

client = Avara(
    api_key=os.environ.get("AVARA_API_KEY"),  # This is the default and can be omitted
)
page = client.auto_scribe.clinical_references.list()
page = page.clinical_references[0]
print(page.clinical_reference_id)
{
  "clinicalReferences": [
    {
      "clinicalReferenceId": "ref_1234567890abcdef1234567890abcdef",
      "createdAt": "2024-01-15T09:00:00Z",
      "isActive": true,
      "name": "City Medical Center",
      "type": "facility",
      "updatedAt": "2024-03-15T14:20:00Z",
      "expressCustomer": {
        "expressCustomerId": "cus_1234567890abcdef1234567890abcdef",
        "expressCustomerName": "City Medical Center"
      },
      "externalReferenceId": "FAC-001",
      "metadata": {
        "region": "northeast"
      }
    }
  ],
  "hasMore": true,
  "cursor": "cursor"
}
Returns Examples
{
  "clinicalReferences": [
    {
      "clinicalReferenceId": "ref_1234567890abcdef1234567890abcdef",
      "createdAt": "2024-01-15T09:00:00Z",
      "isActive": true,
      "name": "City Medical Center",
      "type": "facility",
      "updatedAt": "2024-03-15T14:20:00Z",
      "expressCustomer": {
        "expressCustomerId": "cus_1234567890abcdef1234567890abcdef",
        "expressCustomerName": "City Medical Center"
      },
      "externalReferenceId": "FAC-001",
      "metadata": {
        "region": "northeast"
      }
    }
  ],
  "hasMore": true,
  "cursor": "cursor"
}