Retrieve a clinical reference by external reference ID

ClinicalReference autoScribe().clinicalReferences().retrieveByExternalReferenceId(, )

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

Retrieves a single clinical reference by its integrator-provided external reference identifier.

ParametersExpand Collapse

ClinicalReferenceRetrieveByExternalReferenceIdParams params

Optional<String> externalReferenceId

Integrator-provided external reference identifier

minLength1

ReturnsExpand Collapse

class ClinicalReference:

A canonical clinical reference value for study workflow pickers and normalization

String clinicalReferenceId

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

Optional<LocalDateTime> createdAt

Timestamp when the clinical reference was created

formatdate-time

boolean isActive

Whether this reference is active and available for pickers

String name

Canonical display name for this reference value

minLength1

ClinicalReferenceType type

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

One of the following:

FACILITY("facility")

REFERRING_PROVIDER("referring_provider")

STUDY_DESCRIPTION("study_description")

PROCEDURE("procedure")

Optional<LocalDateTime> updatedAt

Timestamp when the clinical reference was last updated

formatdate-time

Optional<ExpressCustomerReference> expressCustomer

A reference to an Express customer with basic identifying information

String expressCustomerId

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

String expressCustomerName

Name of the Express customer

minLength1

Optional<String> externalReferenceId

Integrator-provided stable identifier for mapping inbound data

Optional<Metadata> metadata

Optional key-value metadata. Maximum 50 pairs

Retrieve a clinical reference by external reference ID

package com.avarasoftware.example;

import com.avarasoftware.client.AvaraClient;
import com.avarasoftware.client.okhttp.AvaraOkHttpClient;
import com.avarasoftware.models.autoscribe.clinicalreferences.ClinicalReference;
import com.avarasoftware.models.autoscribe.clinicalreferences.ClinicalReferenceRetrieveByExternalReferenceIdParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AvaraClient client = AvaraOkHttpClient.fromEnv();

        ClinicalReference clinicalReference = client.autoScribe().clinicalReferences().retrieveByExternalReferenceId("FAC-001");
    }
}

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