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

Retrieve a clinical reference by ID

ClinicalReference AutoScribe.ClinicalReferences.Retrieve(ClinicalReferenceRetrieveParamsparameters, CancellationTokencancellationToken = default)
GET/v1/autoScribe/clinicalReferences/{clinicalReferenceId}

Retrieves a single clinical reference by its unique identifier.

ParametersExpand Collapse
ClinicalReferenceRetrieveParams parameters
required string clinicalReferenceID

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

ReturnsExpand 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

Retrieve a clinical reference by ID

ClinicalReferenceRetrieveParams parameters = new()
{
    ClinicalReferenceID = "ref_1234567890abcdef1234567890abcdef"
};

var clinicalReference = await client.AutoScribe.ClinicalReferences.Retrieve(parameters);

Console.WriteLine(clinicalReference);
{
  "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"
  }
}