List clinical references

ClinicalReferenceListPageResponse AutoScribe.ClinicalReferences.List(, )

GET/v1/autoScribe/clinicalReferences

Lists clinical references with cursor-based pagination and optional filters.

ParametersExpand Collapse

ClinicalReferenceListParams parameters

string cursor

Base64 encoded cursor from previous response

string expressCustomerID

Filter by Express customer ID. Omit for no filter; pass null for clinic-wide references

Boolean? isActive

Filter by active status. Defaults to true (active references only). Pass false to list inactive references.

Double limit

Number of results to return (1-100)

minimum1

maximum100

ClinicalReferenceType type

Filter by clinical reference type

ReturnsExpand Collapse

class ClinicalReferenceListPageResponse:

Paginated list of clinical references

required IReadOnlyList<ClinicalReference> ClinicalReferences

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:

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

required Boolean HasMore

string Cursor

List clinical references

ClinicalReferenceListParams parameters = new();

var page = await client.AutoScribe.ClinicalReferences.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

{
  "clinicalReferences": [
    {
      "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"
      }
    }
  ],
  "hasMore": true,
  "cursor": "cursor"
}

Returns Examples

{
  "clinicalReferences": [
    {
      "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"
      }
    }
  ],
  "hasMore": true,
  "cursor": "cursor"
}