Report data model

Updated:

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNoUnique identifier for the report
created_atstring (date-time)NoWhen the report record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoWhen the report record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
patient_idstringNoThe patient the report is about
encounter_idstringNoThe encounter the report relates to
practitioner_idsstring[]NoThe practitioners responsible for the report
observation_idsstring[]NoThe individual results included in the report
namestringNoHuman-readable name of the report (e.g. Complete blood count)
codesHealthcareCode[]NoCodings for the report (e.g. LOINC panel)
codes[].systemstringNoThe code system URI (e.g. http://loinc.org, http://snomed.info/sct)
codes[].codestringNoThe code within the system
codes[].displaystringNoHuman-readable display text for the code
statusenumNoStatus of the report Values: REGISTERED, PARTIAL, PRELIMINARY, FINAL, AMENDED, CORRECTED, APPENDED, CANCELLED, ENTERED_IN_ERROR, UNKNOWN, OTHER
typeenumNoCategory of the report Values: LABORATORY, IMAGING, PATHOLOGY, CARDIOLOGY, OTHER
conclusionstringNoClinical conclusion or interpretation of the report
observed_atstring (date-time)NoWhen the specimen was taken or the study was performed (effective time) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
issued_atstring (date-time)NoWhen the report was released (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
metadataHealthcareMetadata[]NoCustom field values
metadata[].idstringNoIdentifier of the custom field
metadata[].valueobjectNoThe custom field value
metadata[].namespacestringNoThe scope or origin of the custom field
metadata[].formatenumNoThe data type of the value Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT
metadata[].extra_dataobjectNoAdditional data about the custom field
metadata[].slugstringNoThe custom field key

TypeScript

TypeScript
export type HealthcareReport = {
	id?: string; // Unique identifier for the report
	created_at?: string-time; // When the report record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // When the report record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	patient_id?: string; // The patient the report is about
	encounter_id?: string; // The encounter the report relates to
	practitioner_ids?: string[]; // The practitioners responsible for the report
	observation_ids?: string[]; // The individual results included in the report
	name?: string; // Human-readable name of the report (e.g. Complete blood count)
	codes?: []; // Codings for the report (e.g. LOINC panel)
	status?: 'REGISTERED' | 'PARTIAL' | 'PRELIMINARY' | 'FINAL' | 'AMENDED' | 'CORRECTED' | 'APPENDED' | 'CANCELLED' | 'ENTERED_IN_ERROR' | 'UNKNOWN' | 'OTHER'; // Status of the report
	type?: 'LABORATORY' | 'IMAGING' | 'PATHOLOGY' | 'CARDIOLOGY' | 'OTHER'; // Category of the report
	conclusion?: string; // Clinical conclusion or interpretation of the report
	observed_at?: string-time; // When the specimen was taken or the study was performed (effective time) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	issued_at?: string-time; // When the report was released (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	metadata?: []; // Custom field values
	raw?: any; // Raw data from integration
} 

Zod

Zod
import { z } from 'zod';

export const ZodHealthcareReport = z.object({
	id: z.string().optional().describe("Unique identifier for the report"),
	created_at: z.string-time().optional().describe("When the report record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("When the report record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	patient_id: z.string().optional().describe("The patient the report is about"),
	encounter_id: z.string().optional().describe("The encounter the report relates to"),
	practitioner_ids: z.array().optional().describe("The practitioners responsible for the report"),
	observation_ids: z.array().optional().describe("The individual results included in the report"),
	name: z.string().optional().describe("Human-readable name of the report (e.g. Complete blood count)"),
	codes: z.array().optional().describe("Codings for the report (e.g. LOINC panel)"),
	status: z.enum("REGISTERED", "PARTIAL", "PRELIMINARY", "FINAL", "AMENDED", "CORRECTED", "APPENDED", "CANCELLED", "ENTERED_IN_ERROR", "UNKNOWN", "OTHER").optional().describe("Status of the report"),
	type: z.enum("LABORATORY", "IMAGING", "PATHOLOGY", "CARDIOLOGY", "OTHER").optional().describe("Category of the report"),
	conclusion: z.string().optional().describe("Clinical conclusion or interpretation of the report"),
	observed_at: z.string-time().optional().describe("When the specimen was taken or the study was performed (effective time) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	issued_at: z.string-time().optional().describe("When the report was released (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	metadata: z.array().optional().describe("Custom field values"),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class HealthcareReportStatus(str, Enum):
	REGISTERED = 'REGISTERED'
	PARTIAL = 'PARTIAL'
	PRELIMINARY = 'PRELIMINARY'
	FINAL = 'FINAL'
	AMENDED = 'AMENDED'
	CORRECTED = 'CORRECTED'
	APPENDED = 'APPENDED'
	CANCELLED = 'CANCELLED'
	ENTERED_IN_ERROR = 'ENTERED_IN_ERROR'
	UNKNOWN = 'UNKNOWN'
	OTHER = 'OTHER'

@dataclasses.dataclass
class HealthcareReportType(str, Enum):
	LABORATORY = 'LABORATORY'
	IMAGING = 'IMAGING'
	PATHOLOGY = 'PATHOLOGY'
	CARDIOLOGY = 'CARDIOLOGY'
	OTHER = 'OTHER'

@dataclasses.dataclass
class HealthcareReport:
	"""Unique identifier for the report"""
	id: Optional[str]
	"""When the report record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""When the report record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""The patient the report is about"""
	patient_id: Optional[str]
	"""The encounter the report relates to"""
	encounter_id: Optional[str]
	"""The practitioners responsible for the report"""
	practitioner_ids: Optional[List[List[str]]]
	"""The individual results included in the report"""
	observation_ids: Optional[List[List[str]]]
	"""Human-readable name of the report (e.g. Complete blood count)"""
	name: Optional[str]
	"""Codings for the report (e.g. LOINC panel)"""
	codes: Optional[PropertyHealthcareReportCodes]
	"""Status of the report"""
	status: Optional[HealthcareReportStatus]
	"""Category of the report"""
	type: Optional[HealthcareReportType]
	"""Clinical conclusion or interpretation of the report"""
	conclusion: Optional[str]
	"""When the specimen was taken or the study was performed (effective time) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	observed_at: Optional[str]
	"""When the report was released (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	issued_at: Optional[str]
	"""Custom field values"""
	metadata: Optional[PropertyHealthcareReportMetadata]
Are we missing anything? Let us know
Was this page helpful?