@medplum/fhirtypes 0.3.0

package/dist/Evidence.d.ts

@@ -0,0 +1,295 @@
+/*
+ * Generated by @medplum/generator
+ * Do not edit manually.
+ */
+
+import { Annotation } from './Annotation';
+import { CodeableConcept } from './CodeableConcept';
+import { ContactDetail } from './ContactDetail';
+import { EvidenceVariable } from './EvidenceVariable';
+import { Extension } from './Extension';
+import { Identifier } from './Identifier';
+import { Meta } from './Meta';
+import { Narrative } from './Narrative';
+import { Period } from './Period';
+import { Reference } from './Reference';
+import { RelatedArtifact } from './RelatedArtifact';
+import { Resource } from './Resource';
+import { UsageContext } from './UsageContext';
+
+/**
+ * The Evidence resource describes the conditional state (population and
+ * any exposures being compared within the population) and outcome (if
+ * specified) that the knowledge (evidence, assertion, recommendation) is
+ * about.
+ */
+export interface Evidence {
+
+  /**
+   * This is a Evidence resource
+   */
+  readonly resourceType: 'Evidence';
+
+  /**
+   * The logical id of the resource, as used in the URL for the resource.
+   * Once assigned, this value never changes.
+   */
+  readonly 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.
+   */
+  readonly 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.
+   */
+  readonly implicitRules?: string;
+
+  /**
+   * The base language in which the resource is written.
+   */
+  readonly 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.
+   */
+  readonly 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.
+   */
+  readonly 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.
+   */
+  readonly 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).
+   */
+  readonly modifierExtension?: Extension[];
+
+  /**
+   * An absolute URI that is used to identify this evidence 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 is (or will be) published. This URL can be
+   * the target of a canonical reference. It SHALL remain the same when the
+   * evidence is stored on different servers.
+   */
+  readonly url?: string;
+
+  /**
+   * A formal identifier that is used to identify this evidence when it is
+   * represented in other formats, or referenced in a specification, model,
+   * design or an instance.
+   */
+  readonly identifier?: Identifier[];
+
+  /**
+   * The identifier that is used to identify this version of the evidence
+   * when it is referenced in a specification, model, design or instance.
+   * This is an arbitrary value managed by the evidence 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.
+   */
+  readonly version?: string;
+
+  /**
+   * A natural language name identifying the evidence. This name should be
+   * usable as an identifier for the module by machine processing
+   * applications such as code generation.
+   */
+  readonly name?: string;
+
+  /**
+   * A short, descriptive, user-friendly title for the evidence.
+   */
+  readonly title?: string;
+
+  /**
+   * The short title provides an alternate title for use in informal
+   * descriptive contexts where the full, formal title is not necessary.
+   */
+  readonly shortTitle?: string;
+
+  /**
+   * An explanatory or alternate title for the Evidence giving additional
+   * information about its content.
+   */
+  readonly subtitle?: string;
+
+  /**
+   * The status of this evidence. Enables tracking the life-cycle of the
+   * content.
+   */
+  readonly status?: string;
+
+  /**
+   * The date  (and optionally time) when the evidence 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 changes.
+   */
+  readonly date?: string;
+
+  /**
+   * The name of the organization or individual that published the
+   * evidence.
+   */
+  readonly publisher?: string;
+
+  /**
+   * Contact details to assist a user in finding and communicating with the
+   * publisher.
+   */
+  readonly contact?: ContactDetail[];
+
+  /**
+   * A free text natural language description of the evidence from a
+   * consumer's perspective.
+   */
+  readonly description?: string;
+
+  /**
+   * A human-readable string to clarify or explain concepts about the
+   * resource.
+   */
+  readonly 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 instances.
+   */
+  readonly useContext?: UsageContext[];
+
+  /**
+   * A legal or geographic region in which the evidence is intended to be
+   * used.
+   */
+  readonly jurisdiction?: CodeableConcept[];
+
+  /**
+   * A copyright statement relating to the evidence and/or its contents.
+   * Copyright statements are generally legal restrictions on the use and
+   * publishing of the evidence.
+   */
+  readonly 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.
+   */
+  readonly 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.
+   */
+  readonly lastReviewDate?: string;
+
+  /**
+   * The period during which the evidence content was or is planned to be
+   * in active use.
+   */
+  readonly effectivePeriod?: Period;
+
+  /**
+   * Descriptive topics related to the content of the Evidence. Topics
+   * provide a high-level categorization grouping types of Evidences that
+   * can be useful for filtering and searching.
+   */
+  readonly topic?: CodeableConcept[];
+
+  /**
+   * An individiual or organization primarily involved in the creation and
+   * maintenance of the content.
+   */
+  readonly author?: ContactDetail[];
+
+  /**
+   * An individual or organization primarily responsible for internal
+   * coherence of the content.
+   */
+  readonly editor?: ContactDetail[];
+
+  /**
+   * An individual or organization primarily responsible for review of some
+   * aspect of the content.
+   */
+  readonly reviewer?: ContactDetail[];
+
+  /**
+   * An individual or organization responsible for officially endorsing the
+   * content for use in some setting.
+   */
+  readonly endorser?: ContactDetail[];
+
+  /**
+   * Related artifacts such as additional documentation, justification, or
+   * bibliographic references.
+   */
+  readonly relatedArtifact?: RelatedArtifact[];
+
+  /**
+   * A reference to a EvidenceVariable resource that defines the population
+   * for the research.
+   */
+  readonly exposureBackground?: Reference<EvidenceVariable>;
+
+  /**
+   * A reference to a EvidenceVariable resource that defines the exposure
+   * for the research.
+   */
+  readonly exposureVariant?: Reference<EvidenceVariable>[];
+
+  /**
+   * A reference to a EvidenceVariable resomece that defines the outcome
+   * for the research.
+   */
+  readonly outcome?: Reference<EvidenceVariable>[];
+}