// 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 { Annotation } from './Annotation.d.ts';
import type { CodeableConcept } from './CodeableConcept.d.ts';
import type { ContactDetail } from './ContactDetail.d.ts';
import type { Device } from './Device.d.ts';
import type { DeviceMetric } from './DeviceMetric.d.ts';
import type { Evidence } from './Evidence.d.ts';
import type { Expression } from './Expression.d.ts';
import type { Extension } from './Extension.d.ts';
import type { Group } from './Group.d.ts';
import type { Identifier } from './Identifier.d.ts';
import type { Meta } from './Meta.d.ts';
import type { Narrative } from './Narrative.d.ts';
import type { Period } from './Period.d.ts';
import type { Quantity } from './Quantity.d.ts';
import type { Range } from './Range.d.ts';
import type { Reference } from './Reference.d.ts';
import type { RelatedArtifact } from './RelatedArtifact.d.ts';
import type { Resource } from './Resource.d.ts';
import type { UsageContext } from './UsageContext.d.ts';

/**
 * The EvidenceVariable resource describes a "PICO" element that
 * knowledge (evidence, assertion, recommendation) is about.
 */
export interface EvidenceVariable {

  /**
   * This is a EvidenceVariable resource
   */
  readonly resourceType: 'EvidenceVariable';

  /**
   * The logical id of the resource, as used in the URL for the resource.
   * Once assigned, this value never changes.
   */
  id?: string;

  /**
   * The metadata about the resource. This is content that is maintained by
   * the infrastructure. Changes to the content might not always be
   * associated with version changes to the resource.
   */
  meta?: Meta;

  /**
   * A reference to a set of rules that were followed when the resource was
   * constructed, and which must be understood when processing the content.
   * Often, this is a reference to an implementation guide that defines the
   * special rules along with other profiles etc.
   */
  implicitRules?: string;

  /**
   * The base language in which the resource is written.
   */
  language?: string;

  /**
   * A human-readable narrative that contains a summary of the resource and
   * can be used to represent the content of the resource to a human. The
   * narrative need not encode all the structured data, but is required to
   * contain sufficient detail to make it "clinically safe" for a human to
   * just read the narrative. Resource definitions may define what content
   * should be represented in the narrative to ensure clinical safety.
   */
  text?: Narrative;

  /**
   * These resources do not have an independent existence apart from the
   * resource that contains them - they cannot be identified independently,
   * and nor can they have their own independent transaction scope.
   */
  contained?: Resource[];

  /**
   * May be used to represent additional information that is not part of
   * the basic definition of the resource. 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[];

  /**
   * May be used to represent additional information that is not part of
   * the basic definition of the resource and that modifies the
   * understanding of the element that contains it and/or the understanding
   * of the containing element's descendants. Usually modifier elements
   * provide negation or qualification. 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 is allowed to
   * define an extension, there is a set of requirements that SHALL be met
   * as part of the definition of the extension. Applications processing a
   * resource are required to check for modifier extensions.
   *
   * Modifier extensions SHALL NOT change the meaning of any elements on
   * Resource or DomainResource (including cannot change the meaning of
   * modifierExtension itself).
   */
  modifierExtension?: Extension[];

  /**
   * An absolute URI that is used to identify this evidence variable when
   * it is referenced in a specification, model, design or an instance;
   * also called its canonical identifier. This SHOULD be globally unique
   * and SHOULD be a literal address at which at which an authoritative
   * instance of this evidence variable is (or will be) published. This URL
   * can be the target of a canonical reference. It SHALL remain the same
   * when the evidence variable is stored on different servers.
   */
  url?: string;

  /**
   * A formal identifier that is used to identify this evidence variable
   * when it is represented in other formats, or referenced in a
   * specification, model, design or an instance.
   */
  identifier?: Identifier[];

  /**
   * The identifier that is used to identify this version of the evidence
   * variable when it is referenced in a specification, model, design or
   * instance. This is an arbitrary value managed by the evidence variable
   * author and is not expected to be globally unique. For example, it
   * might be a timestamp (e.g. yyyymmdd) if a managed version is not
   * available. There is also no expectation that versions can be placed in
   * a lexicographical sequence. To provide a version consistent with the
   * Decision Support Service specification, use the format
   * Major.Minor.Revision (e.g. 1.0.0). For more information on versioning
   * knowledge assets, refer to the Decision Support Service specification.
   * Note that a version is required for non-experimental active artifacts.
   */
  version?: string;

  /**
   * A natural language name identifying the evidence variable. This name
   * should be usable as an identifier for the module by machine processing
   * applications such as code generation.
   */
  name?: string;

  /**
   * A short, descriptive, user-friendly title for the evidence variable.
   */
  title?: string;

  /**
   * The short title provides an alternate title for use in informal
   * descriptive contexts where the full, formal title is not necessary.
   */
  shortTitle?: string;

  /**
   * An explanatory or alternate title for the EvidenceVariable giving
   * additional information about its content.
   */
  subtitle?: string;

  /**
   * The status of this evidence variable. Enables tracking the life-cycle
   * of the content.
   */
  status: 'draft' | 'active' | 'retired' | 'unknown';

  /**
   * The date  (and optionally time) when the evidence variable was
   * published. The date must change when the business version changes and
   * it must change if the status code changes. In addition, it should
   * change when the substantive content of the evidence variable changes.
   */
  date?: string;

  /**
   * The name of the organization or individual that published the evidence
   * variable.
   */
  publisher?: string;

  /**
   * Contact details to assist a user in finding and communicating with the
   * publisher.
   */
  contact?: ContactDetail[];

  /**
   * A free text natural language description of the evidence variable from
   * a consumer's perspective.
   */
  description?: string;

  /**
   * A human-readable string to clarify or explain concepts about the
   * resource.
   */
  note?: Annotation[];

  /**
   * The content was developed with a focus and intent of supporting the
   * contexts that are listed. These contexts may be general categories
   * (gender, age, ...) or may be references to specific programs
   * (insurance plans, studies, ...) and may be used to assist with
   * indexing and searching for appropriate evidence variable instances.
   */
  useContext?: UsageContext[];

  /**
   * A legal or geographic region in which the evidence variable is
   * intended to be used.
   */
  jurisdiction?: CodeableConcept[];

  /**
   * A copyright statement relating to the evidence variable and/or its
   * contents. Copyright statements are generally legal restrictions on the
   * use and publishing of the evidence variable.
   */
  copyright?: string;

  /**
   * The date on which the resource content was approved by the publisher.
   * Approval happens once when the content is officially approved for
   * usage.
   */
  approvalDate?: string;

  /**
   * The date on which the resource content was last reviewed. Review
   * happens periodically after approval but does not change the original
   * approval date.
   */
  lastReviewDate?: string;

  /**
   * The period during which the evidence variable content was or is
   * planned to be in active use.
   */
  effectivePeriod?: Period;

  /**
   * Descriptive topics related to the content of the EvidenceVariable.
   * Topics provide a high-level categorization grouping types of
   * EvidenceVariables that can be useful for filtering and searching.
   */
  topic?: CodeableConcept[];

  /**
   * An individiual or organization primarily involved in the creation and
   * maintenance of the content.
   */
  author?: ContactDetail[];

  /**
   * An individual or organization primarily responsible for internal
   * coherence of the content.
   */
  editor?: ContactDetail[];

  /**
   * An individual or organization primarily responsible for review of some
   * aspect of the content.
   */
  reviewer?: ContactDetail[];

  /**
   * An individual or organization responsible for officially endorsing the
   * content for use in some setting.
   */
  endorser?: ContactDetail[];

  /**
   * Related artifacts such as additional documentation, justification, or
   * bibliographic references.
   */
  relatedArtifact?: RelatedArtifact[];

  /**
   * The type of evidence element, a population, an exposure, or an
   * outcome.
   */
  type?: 'dichotomous' | 'continuous' | 'descriptive';

  /**
   * A defining factor of the EvidenceVariable. Multiple characteristics
   * are applied with "and" semantics.
   */
  characteristic?: EvidenceVariableCharacteristic[];
}

/**
 * A defining factor of the EvidenceVariable. Multiple characteristics
 * are applied with "and" semantics.
 */
export interface EvidenceVariableCharacteristic {

  /**
   * 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 managable, 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[];

  /**
   * May be used to represent additional information that is not part of
   * the basic definition of the element and that modifies the
   * understanding of the element in which it is contained and/or the
   * understanding of the containing element's descendants. Usually
   * modifier elements provide negation or qualification. To make the use
   * of extensions safe and managable, 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.
   * Applications processing a resource are required to check for modifier
   * extensions.
   *
   * Modifier extensions SHALL NOT change the meaning of any elements on
   * Resource or DomainResource (including cannot change the meaning of
   * modifierExtension itself).
   */
  modifierExtension?: Extension[];

  /**
   * Label used for when a characteristic refers to another characteristic.
   */
  linkId?: string;

  /**
   * A short, natural language description of the characteristic that could
   * be used to communicate the criteria to an end-user.
   */
  description?: string;

  /**
   * A human-readable string to clarify or explain concepts about the
   * characteristic.
   */
  note?: Annotation[];

  /**
   * When true, this characteristic is an exclusion criterion. In other
   * words, not matching this characteristic definition is equivalent to
   * meeting this criterion.
   */
  exclude?: boolean;

  /**
   * Defines the characteristic using a Reference.
   */
  definitionReference?: Reference<EvidenceVariable | Group | Evidence>;

  /**
   * Defines the characteristic using Canonical.
   */
  definitionCanonical?: string;

  /**
   * Defines the characteristic using CodeableConcept.
   */
  definitionCodeableConcept?: CodeableConcept;

  /**
   * Defines the characteristic using Expression.
   */
  definitionExpression?: Expression;

  /**
   * Defines the characteristic using id.
   */
  definitionId?: string;

  /**
   * Defines the characteristic using both a type and value[x] elements.
   */
  definitionByTypeAndValue?: EvidenceVariableCharacteristicDefinitionByTypeAndValue;

  /**
   * Defines the characteristic as a combination of two or more
   * characteristics.
   */
  definitionByCombination?: EvidenceVariableCharacteristicDefinitionByCombination;

  /**
   * Number of occurrences meeting the characteristic.
   */
  instancesQuantity?: Quantity;

  /**
   * Number of occurrences meeting the characteristic.
   */
  instancesRange?: Range;

  /**
   * Length of time in which the characteristic is met.
   */
  durationQuantity?: Quantity;

  /**
   * Length of time in which the characteristic is met.
   */
  durationRange?: Range;

  /**
   * Timing in which the characteristic is determined.
   */
  timeFromEvent?: EvidenceVariableCharacteristicTimeFromEvent[];
}

/**
 * Number of occurrences meeting the characteristic.
 */
export type EvidenceVariableCharacteristicInstances = Quantity | Range;

/**
 * Length of time in which the characteristic is met.
 */
export type EvidenceVariableCharacteristicDuration = Quantity | Range;

/**
 * Defines the characteristic as a combination of two or more
 * characteristics.
 */
export interface EvidenceVariableCharacteristicDefinitionByCombination {

  /**
   * 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 managable, 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[];

  /**
   * May be used to represent additional information that is not part of
   * the basic definition of the element and that modifies the
   * understanding of the element in which it is contained and/or the
   * understanding of the containing element's descendants. Usually
   * modifier elements provide negation or qualification. To make the use
   * of extensions safe and managable, 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.
   * Applications processing a resource are required to check for modifier
   * extensions.
   *
   * Modifier extensions SHALL NOT change the meaning of any elements on
   * Resource or DomainResource (including cannot change the meaning of
   * modifierExtension itself).
   */
  modifierExtension?: Extension[];

  /**
   * Used to specify if two or more characteristics are combined with OR or
   * AND.
   */
  code: string;

  /**
   * Provides the value of &quot;n&quot; when &quot;at-least&quot; or &quot;at-most&quot; codes are used.
   */
  threshold?: number;

  /**
   * A defining factor of the characteristic.
   */
  characteristic: EvidenceVariableCharacteristic[];
}

/**
 * Defines the characteristic using both a type and value[x] elements.
 */
export interface EvidenceVariableCharacteristicDefinitionByTypeAndValue {

  /**
   * 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 managable, 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[];

  /**
   * May be used to represent additional information that is not part of
   * the basic definition of the element and that modifies the
   * understanding of the element in which it is contained and/or the
   * understanding of the containing element's descendants. Usually
   * modifier elements provide negation or qualification. To make the use
   * of extensions safe and managable, 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.
   * Applications processing a resource are required to check for modifier
   * extensions.
   *
   * Modifier extensions SHALL NOT change the meaning of any elements on
   * Resource or DomainResource (including cannot change the meaning of
   * modifierExtension itself).
   */
  modifierExtension?: Extension[];

  /**
   * Used to express the type of characteristic.
   */
  type: CodeableConcept;

  /**
   * Method for how the characteristic value was determined.
   */
  method?: CodeableConcept[];

  /**
   * Device used for determining characteristic.
   */
  device?: Reference<Device | DeviceMetric>;

  /**
   * Defines the characteristic when paired with characteristic.type.
   */
  valueCodeableConcept?: CodeableConcept;

  /**
   * Defines the characteristic when paired with characteristic.type.
   */
  valueBoolean?: boolean;

  /**
   * Defines the characteristic when paired with characteristic.type.
   */
  valueQuantity?: Quantity;

  /**
   * Defines the characteristic when paired with characteristic.type.
   */
  valueRange?: Range;

  /**
   * Defines the characteristic when paired with characteristic.type.
   */
  valueReference?: Reference;

  /**
   * Defines the characteristic when paired with characteristic.type.
   */
  valueId?: string;

  /**
   * Defines the reference point for comparison when valueQuantity or
   * valueRange is not compared to zero.
   */
  offset?: CodeableConcept;
}

/**
 * Defines the characteristic when paired with characteristic.type.
 */
export type EvidenceVariableCharacteristicDefinitionByTypeAndValueValue = boolean | CodeableConcept | Quantity | Range | Reference | string;

/**
 * Timing in which the characteristic is determined.
 */
export interface EvidenceVariableCharacteristicTimeFromEvent {

  /**
   * 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 managable, 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[];

  /**
   * May be used to represent additional information that is not part of
   * the basic definition of the element and that modifies the
   * understanding of the element in which it is contained and/or the
   * understanding of the containing element's descendants. Usually
   * modifier elements provide negation or qualification. To make the use
   * of extensions safe and managable, 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.
   * Applications processing a resource are required to check for modifier
   * extensions.
   *
   * Modifier extensions SHALL NOT change the meaning of any elements on
   * Resource or DomainResource (including cannot change the meaning of
   * modifierExtension itself).
   */
  modifierExtension?: Extension[];

  /**
   * Human readable description.
   */
  description?: string;

  /**
   * A human-readable string to clarify or explain concepts about the
   * timeFromEvent.
   */
  note?: Annotation[];

  /**
   * The event used as a base point (reference point) in time.
   */
  eventCodeableConcept?: CodeableConcept;

  /**
   * The event used as a base point (reference point) in time.
   */
  eventReference?: Reference;

  /**
   * The event used as a base point (reference point) in time.
   */
  eventDateTime?: string;

  /**
   * The event used as a base point (reference point) in time.
   */
  eventId?: string;

  /**
   * Used to express the observation at a defined amount of time before or
   * after the event.
   */
  quantity?: Quantity;

  /**
   * Used to express the observation within a period before and/or after
   * the event.
   */
  range?: Range;
}

/**
 * The event used as a base point (reference point) in time.
 */
export type EvidenceVariableCharacteristicTimeFromEventEvent = CodeableConcept | Reference | string;