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

Medplum FHIR Type Definitions

// SPDX-FileCopyrightText: Copyright Orangebot, Inc. and Medplum contributors
// SPDX-License-Identifier: Apache-2.0
/*
 * This is a generated file
 * Do not edit manually.
 */

import type { Extension } from './Extension.d.ts';
import type { Organization } from './Organization.d.ts';
import type { Patient } from './Patient.d.ts';
import type { Practitioner } from './Practitioner.d.ts';
import type { Reference } from './Reference.d.ts';
import type { RelatedPerson } from './RelatedPerson.d.ts';

/**
 * A  text note which also  contains information about who made the
 * statement and when.
 */
export interface Annotation {

  /**
   * 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 individual responsible for making the annotation.
   */
  authorReference?: Reference<Practitioner | Patient | RelatedPerson | Organization>;

  /**
   * The individual responsible for making the annotation.
   */
  authorString?: string;

  /**
   * Indicates when this particular annotation was made.
   */
  time?: string;

  /**
   * The text of the annotation in markdown format.
   */
  text: string;
}

/**
 * The individual responsible for making the annotation.
 */
export type AnnotationAuthor = Reference<Practitioner | Patient | RelatedPerson | Organization> | string;