API Reference

Auto Scribe

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Clinical References

Create a clinical reference

POST/v1/autoScribe/clinicalReferences

List clinical references

GET/v1/autoScribe/clinicalReferences

Retrieve a clinical reference by ID

GET/v1/autoScribe/clinicalReferences/{clinicalReferenceId}

Retrieve a clinical reference by external reference ID

GET/v1/autoScribe/clinicalReferences/byExternalReferenceId/{externalReferenceId}

Update a clinical reference

PATCH/v1/autoScribe/clinicalReferences/{clinicalReferenceId}

Delete a clinical reference

POST/v1/autoScribe/clinicalReferences/{clinicalReferenceId}/delete

ModelsExpand Collapse

ClinicalReference object { 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

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