Skip to documentation
ReferencePatient

Patient

Laboratory data

Named panels, individual results, and their recorded units.

Format definition

Model orders, specimens, panels, analytes, and serial results separately.

Portable format · Suite implementation support

Parameters

resources[].diagnostic

{ category: lab | imaging | physiologic, specimen?: string, collectionInstructions?: string, resultIds: Result ID[] }

Required for diagnostic resources

A named request with explicit result references. Laboratory requests require an authored specimen description.

resources[].results[].panelName

string

Optional; omitted means unspecified

Human-readable panel grouping; does not inject assumed analytes.

observations[].referenceInterval

{ low?: number, high?: number, text?: string, unit?: string, context: string }

Optional; omitted means unspecified

At least one bound or text description; numeric bounds require the observation's unit and low must not exceed high. Context describes the authored population/method.

observations[].flag

low | high | critical | none | not-interpreted

Optional; omitted means unspecified

Explicit authored flag, never inferred from a generic source default.

resources[].results[].specimenStatus

adequate | inadequate | not-collected

Required for laboratory results

Allows rejected or unavailable specimens to drive a repeat-collection branch.

Behavior and validation

  • Results are numeric, qualitative text, or boolean observations according to the concept definition. Preserve decimals. Collection and release are distinct events.
  • Laboratory panels are reusable catalog resources, not part of the format specification. Import selected panels as explicit authored observations, preserving values, units, and provenance. Missing results remain unspecified; never inject normal results during playback.
  • Each repeated collection creates a runtime request/result instance; serial authored result templates have distinct IDs. Do not overwrite previous results or use numeric zero for pending results.

Shared format conventions · All format elements · Download specification