List clinical references

GET/v1/autoScribe/clinicalReferences

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

Query ParametersExpand Collapse

cursor: optional string

Base64 encoded cursor from previous response

expressCustomerId: optional string

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

isActive: optional boolean

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

limit: optional number

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

clinicalReferences: array of ClinicalReference { clinicalReferenceId, createdAt, isActive, 6 more }

clinicalReferenceId: string

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

createdAt: string

Timestamp when the clinical reference was created

formatdate-time

isActive: boolean

Whether this reference is active and available for pickers

name: string

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"

updatedAt: string

Timestamp when the clinical reference was last updated

formatdate-time

expressCustomer: optional ExpressCustomerReference { expressCustomerId, expressCustomerName }

A reference to an Express customer with basic identifying information

expressCustomerId: string

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

expressCustomerName: string

Name of the Express customer

minLength1

externalReferenceId: optional string

Integrator-provided stable identifier for mapping inbound data

metadata: optional map[string]

Optional key-value metadata. Maximum 50 pairs

hasMore: boolean

cursor: optional string

List clinical references

curl https://api.avarasoftware.com/v1/autoScribe/clinicalReferences \
    -H "Authorization: Bearer $AVARA_API_KEY"

{
  "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"
}