@medplum/fhirtypes/dist/Quantity.d.ts

Medplum FHIR Type Definitions

/*
 * This is a generated file
 * Do not edit manually.
 */

import { Extension } from './Extension';

/**
 * A measured amount (or an amount that can potentially be measured).
 * Note that measured amounts include amounts that are not precisely
 * quantified, including amounts involving arbitrary units and floating
 * currencies.
 */
export interface Quantity {

  /**
   * Unique id for the element within a resource (for internal references).
   * This may be any string value that does not contain spaces.
   */
  id?: string;

  /**
   * May be used to represent additional information that is not part of
   * the basic definition of the element. To make the use of extensions
   * safe and manageable, there is a strict set of governance  applied to
   * the definition and use of extensions. Though any implementer can
   * define an extension, there is a set of requirements that SHALL be met
   * as part of the definition of the extension.
   */
  extension?: Extension[];

  /**
   * The value of the measured amount. The value includes an implicit
   * precision in the presentation of the value.
   */
  value?: number;

  /**
   * How the value should be understood and represented - whether the
   * actual value is greater or less than the stated value due to
   * measurement issues; e.g. if the comparator is "<" , then the real
   * value is < stated value.
   */
  comparator?: '<' | '<=' | '>=' | '>';

  /**
   * A human-readable form of the unit.
   */
  unit?: string;

  /**
   * The identification of the system that provides the coded form of the
   * unit.
   */
  system?: string;

  /**
   * A computer processable form of the unit in some unit representation
   * system.
   */
  code?: string;
}