Skip to content
Avara
Get started
API Reference
Auto Scribe

Clinical References

Create a clinical reference
ClinicalReference AutoScribe.ClinicalReferences.Create(ClinicalReferenceCreateParamsparameters, CancellationTokencancellationToken = default)
POST/v1/autoScribe/clinicalReferences
List clinical references
ClinicalReferenceListPageResponse AutoScribe.ClinicalReferences.List(ClinicalReferenceListParams?parameters, CancellationTokencancellationToken = default)
GET/v1/autoScribe/clinicalReferences
Retrieve a clinical reference by ID
ClinicalReference AutoScribe.ClinicalReferences.Retrieve(ClinicalReferenceRetrieveParamsparameters, CancellationTokencancellationToken = default)
GET/v1/autoScribe/clinicalReferences/{clinicalReferenceId}
Retrieve a clinical reference by external reference ID
ClinicalReference AutoScribe.ClinicalReferences.RetrieveByExternalReferenceID(ClinicalReferenceRetrieveByExternalReferenceIDParamsparameters, CancellationTokencancellationToken = default)
GET/v1/autoScribe/clinicalReferences/byExternalReferenceId/{externalReferenceId}
Update a clinical reference
ClinicalReference AutoScribe.ClinicalReferences.Update(ClinicalReferenceUpdateParamsparameters, CancellationTokencancellationToken = default)
PATCH/v1/autoScribe/clinicalReferences/{clinicalReferenceId}
Delete a clinical reference
ClinicalReference AutoScribe.ClinicalReferences.Delete(ClinicalReferenceDeleteParamsparameters, CancellationTokencancellationToken = default)
POST/v1/autoScribe/clinicalReferences/{clinicalReferenceId}/delete
ModelsExpand Collapse
class ClinicalReference:

A canonical clinical reference value for study workflow pickers and normalization

required string ClinicalReferenceID

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

required DateTimeOffset? CreatedAt

Timestamp when the clinical reference was created

formatdate-time
required Boolean IsActive

Whether this reference is active and available for pickers

required string Name

Canonical display name for this reference value

minLength1
required ClinicalReferenceType Type

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

One of the following:
"facility"Facility
"referring_provider"ReferringProvider
"study_description"StudyDescription
"procedure"Procedure
required DateTimeOffset? UpdatedAt

Timestamp when the clinical reference was last updated

formatdate-time
ExpressCustomerReference? ExpressCustomer

A reference to an Express customer with basic identifying information

required string ExpressCustomerID

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

required string ExpressCustomerName

Name of the Express customer

minLength1
string? ExternalReferenceID

Integrator-provided stable identifier for mapping inbound data

IReadOnlyDictionary<string, string> Metadata

Optional key-value metadata. Maximum 50 pairs