Clinical References

Create a clinical reference

auto_scribe.clinical_references.create() -> ClinicalReference

POST/v1/autoScribe/clinicalReferences

List clinical references

auto_scribe.clinical_references.list() -> SyncCursorClinicalReferences[ClinicalReference]

GET/v1/autoScribe/clinicalReferences

Retrieve a clinical reference by ID

auto_scribe.clinical_references.retrieve() -> ClinicalReference

GET/v1/autoScribe/clinicalReferences/{clinicalReferenceId}

Retrieve a clinical reference by external reference ID

auto_scribe.clinical_references.retrieve_by_external_reference_id() -> ClinicalReference

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

Update a clinical reference

auto_scribe.clinical_references.update(, ) -> ClinicalReference

PATCH/v1/autoScribe/clinicalReferences/{clinicalReferenceId}

Delete a clinical reference

auto_scribe.clinical_references.delete() -> ClinicalReference

POST/v1/autoScribe/clinicalReferences/{clinicalReferenceId}/delete

ModelsExpand Collapse

class ClinicalReference: …

A canonical clinical reference value for study workflow pickers and normalization

clinical_reference_id: str

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

created_at: Optional[datetime]

Timestamp when the clinical reference was created

formatdate-time

is_active: bool

Whether this reference is active and available for pickers

name: str

Canonical display name for this reference value

minLength1

type: ClinicalReferenceType

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

One of the following:

"facility"

"referring_provider"

"study_description"

"procedure"

updated_at: Optional[datetime]

Timestamp when the clinical reference was last updated

formatdate-time

express_customer: Optional[ExpressCustomerReference]

A reference to an Express customer with basic identifying information

express_customer_id: str

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

express_customer_name: str

Name of the Express customer

minLength1

external_reference_id: Optional[str]

Integrator-provided stable identifier for mapping inbound data

metadata: Optional[Dict[str, str]]

Optional key-value metadata. Maximum 50 pairs