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

Retrieve a clinical reference by external reference ID

client.autoScribe.clinicalReferences.retrieveByExternalReferenceID(stringexternalReferenceID, RequestOptionsoptions?): ClinicalReference { clinicalReferenceId, createdAt, isActive, 6 more }
GET/v1/autoScribe/clinicalReferences/byExternalReferenceId/{externalReferenceId}

Retrieves a single clinical reference by its integrator-provided external reference identifier.

ParametersExpand Collapse
externalReferenceID: string

Integrator-provided external reference identifier

minLength1
ReturnsExpand Collapse
ClinicalReference { clinicalReferenceId, createdAt, isActive, 6 more }

A canonical clinical reference value for study workflow pickers and normalization

clinicalReferenceId: string

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

createdAt: string | null

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 | null

Timestamp when the clinical reference was last updated

formatdate-time
expressCustomer?: ExpressCustomerReference { expressCustomerId, expressCustomerName } | null

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?: string | null

Integrator-provided stable identifier for mapping inbound data

metadata?: Record<string, string>

Optional key-value metadata. Maximum 50 pairs

Retrieve a clinical reference by external reference ID

import Avara from 'avara-software';

const client = new Avara({
  apiKey: process.env['AVARA_API_KEY'], // This is the default and can be omitted
});

const clinicalReference = await client.autoScribe.clinicalReferences.retrieveByExternalReferenceID(
  'FAC-001',
);

console.log(clinicalReference.clinicalReferenceId);
{
  "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"
  }
}
Returns Examples
{
  "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"
  }
}