Skip to content
Avara
Get started
API Reference
Auto Scribe

Clinical References

Create a clinical reference
client.autoScribe.clinicalReferences.create(ClinicalReferenceCreateParams { name, type, expressCustomerId, 2 more } body, RequestOptionsoptions?): ClinicalReference { clinicalReferenceId, createdAt, isActive, 6 more }
POST/v1/autoScribe/clinicalReferences
List clinical references
client.autoScribe.clinicalReferences.list(ClinicalReferenceListParams { cursor, expressCustomerId, isActive, 2 more } query?, RequestOptionsoptions?): CursorClinicalReferences<ClinicalReference { clinicalReferenceId, createdAt, isActive, 6 more } >
GET/v1/autoScribe/clinicalReferences
Retrieve a clinical reference by ID
client.autoScribe.clinicalReferences.retrieve(stringclinicalReferenceID, RequestOptionsoptions?): ClinicalReference { clinicalReferenceId, createdAt, isActive, 6 more }
GET/v1/autoScribe/clinicalReferences/{clinicalReferenceId}
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}
Update a clinical reference
client.autoScribe.clinicalReferences.update(stringclinicalReferenceID, ClinicalReferenceUpdateParams { expressCustomerId, metadata, name } body?, RequestOptionsoptions?): ClinicalReference { clinicalReferenceId, createdAt, isActive, 6 more }
PATCH/v1/autoScribe/clinicalReferences/{clinicalReferenceId}
Delete a clinical reference
client.autoScribe.clinicalReferences.delete(stringclinicalReferenceID, RequestOptionsoptions?): ClinicalReference { clinicalReferenceId, createdAt, isActive, 6 more }
POST/v1/autoScribe/clinicalReferences/{clinicalReferenceId}/delete
ModelsExpand 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