## List clinical references

`ClinicalReferenceListPageResponse AutoScribe.ClinicalReferences.List(ClinicalReferenceListParams?parameters, CancellationTokencancellationToken = default)`

**get** `/v1/autoScribe/clinicalReferences`

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

### Parameters

- `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)

  - `ClinicalReferenceType type`

    Filter by clinical reference type

### Returns

- `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

    - `required Boolean IsActive`

      Whether this reference is active and available for pickers

    - `required string Name`

      Canonical display name for this reference value

    - `required ClinicalReferenceType Type`

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

      - `"facility"Facility`

      - `"referring_provider"ReferringProvider`

      - `"study_description"StudyDescription`

      - `"procedure"Procedure`

    - `required DateTimeOffset? UpdatedAt`

      Timestamp when the clinical reference was last updated

    - `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

    - `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`

### Example

```csharp
ClinicalReferenceListParams parameters = new();

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

#### Response

```json
{
  "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"
}
```