@medplum/fhirtypes 0.3.0

package/dist/DataRequirement.d.ts

@@ -0,0 +1,276 @@
+/*
+ * Generated by @medplum/generator
+ * Do not edit manually.
+ */
+
+import { CodeableConcept } from './CodeableConcept';
+import { Coding } from './Coding';
+import { Duration } from './Duration';
+import { Extension } from './Extension';
+import { Group } from './Group';
+import { Period } from './Period';
+import { Reference } from './Reference';
+
+/**
+ * Base StructureDefinition for DataRequirement Type: Describes a
+ * required data item for evaluation in terms of the type of data, and
+ * optional code or date-based filters of the data.
+ */
+export interface DataRequirement {
+
+  /**
+   * Unique id for the element within a resource (for internal references).
+   * This may be any string value that does not contain spaces.
+   */
+  readonly 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.
+   */
+  readonly extension?: Extension[];
+
+  /**
+   * The type of the required data, specified as the type name of a
+   * resource. For profiles, this value is set to the type of the base
+   * resource of the profile.
+   */
+  readonly type?: string;
+
+  /**
+   * The profile of the required data, specified as the uri of the profile
+   * definition.
+   */
+  readonly profile?: string[];
+
+  /**
+   * The intended subjects of the data requirement. If this element is not
+   * provided, a Patient subject is assumed.
+   */
+  readonly subjectCodeableConcept?: CodeableConcept;
+
+  /**
+   * The intended subjects of the data requirement. If this element is not
+   * provided, a Patient subject is assumed.
+   */
+  readonly subjectReference?: Reference<Group>;
+
+  /**
+   * Indicates that specific elements of the type are referenced by the
+   * knowledge module and must be supported by the consumer in order to
+   * obtain an effective evaluation. This does not mean that a value is
+   * required for this element, only that the consuming system must
+   * understand the element and be able to provide values for it if they
+   * are available.
+   *
+   * The value of mustSupport SHALL be a FHIRPath resolveable on the type
+   * of the DataRequirement. The path SHALL consist only of identifiers,
+   * constant indexers, and .resolve() (see the [Simple FHIRPath
+   * Profile](fhirpath.html#simple) for full details).
+   */
+  readonly mustSupport?: string[];
+
+  /**
+   * Code filters specify additional constraints on the data, specifying
+   * the value set of interest for a particular element of the data. Each
+   * code filter defines an additional constraint on the data, i.e. code
+   * filters are AND'ed, not OR'ed.
+   */
+  readonly codeFilter?: DataRequirementCodeFilter[];
+
+  /**
+   * Date filters specify additional constraints on the data in terms of
+   * the applicable date range for specific elements. Each date filter
+   * specifies an additional constraint on the data, i.e. date filters are
+   * AND'ed, not OR'ed.
+   */
+  readonly dateFilter?: DataRequirementDateFilter[];
+
+  /**
+   * Specifies a maximum number of results that are required (uses the
+   * _count search parameter).
+   */
+  readonly limit?: number;
+
+  /**
+   * Specifies the order of the results to be returned.
+   */
+  readonly sort?: DataRequirementSort[];
+}
+
+/**
+ * Code filters specify additional constraints on the data, specifying
+ * the value set of interest for a particular element of the data. Each
+ * code filter defines an additional constraint on the data, i.e. code
+ * filters are AND'ed, not OR'ed.
+ */
+export interface DataRequirementCodeFilter {
+
+  /**
+   * Unique id for the element within a resource (for internal references).
+   * This may be any string value that does not contain spaces.
+   */
+  readonly 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.
+   */
+  readonly extension?: Extension[];
+
+  /**
+   * The code-valued attribute of the filter. The specified path SHALL be a
+   * FHIRPath resolveable on the specified type of the DataRequirement, and
+   * SHALL consist only of identifiers, constant indexers, and .resolve().
+   * The path is allowed to contain qualifiers (.) to traverse
+   * sub-elements, as well as indexers ([x]) to traverse
+   * multiple-cardinality sub-elements (see the [Simple FHIRPath
+   * Profile](fhirpath.html#simple) for full details). Note that the index
+   * must be an integer constant. The path must resolve to an element of
+   * type code, Coding, or CodeableConcept.
+   */
+  readonly path?: string;
+
+  /**
+   * A token parameter that refers to a search parameter defined on the
+   * specified type of the DataRequirement, and which searches on elements
+   * of type code, Coding, or CodeableConcept.
+   */
+  readonly searchParam?: string;
+
+  /**
+   * The valueset for the code filter. The valueSet and code elements are
+   * additive. If valueSet is specified, the filter will return only those
+   * data items for which the value of the code-valued element specified in
+   * the path is a member of the specified valueset.
+   */
+  readonly valueSet?: string;
+
+  /**
+   * The codes for the code filter. If values are given, the filter will
+   * return only those data items for which the code-valued attribute
+   * specified by the path has a value that is one of the specified codes.
+   * If codes are specified in addition to a value set, the filter returns
+   * items matching a code in the value set or one of the specified codes.
+   */
+  readonly code?: Coding[];
+}
+
+/**
+ * Date filters specify additional constraints on the data in terms of
+ * the applicable date range for specific elements. Each date filter
+ * specifies an additional constraint on the data, i.e. date filters are
+ * AND'ed, not OR'ed.
+ */
+export interface DataRequirementDateFilter {
+
+  /**
+   * Unique id for the element within a resource (for internal references).
+   * This may be any string value that does not contain spaces.
+   */
+  readonly 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.
+   */
+  readonly extension?: Extension[];
+
+  /**
+   * The date-valued attribute of the filter. The specified path SHALL be a
+   * FHIRPath resolveable on the specified type of the DataRequirement, and
+   * SHALL consist only of identifiers, constant indexers, and .resolve().
+   * The path is allowed to contain qualifiers (.) to traverse
+   * sub-elements, as well as indexers ([x]) to traverse
+   * multiple-cardinality sub-elements (see the [Simple FHIRPath
+   * Profile](fhirpath.html#simple) for full details). Note that the index
+   * must be an integer constant. The path must resolve to an element of
+   * type date, dateTime, Period, Schedule, or Timing.
+   */
+  readonly path?: string;
+
+  /**
+   * A date parameter that refers to a search parameter defined on the
+   * specified type of the DataRequirement, and which searches on elements
+   * of type date, dateTime, Period, Schedule, or Timing.
+   */
+  readonly searchParam?: string;
+
+  /**
+   * The value of the filter. If period is specified, the filter will
+   * return only those data items that fall within the bounds determined by
+   * the Period, inclusive of the period boundaries. If dateTime is
+   * specified, the filter will return only those data items that are equal
+   * to the specified dateTime. If a Duration is specified, the filter will
+   * return only those data items that fall within Duration before now.
+   */
+  readonly valueDateTime?: string;
+
+  /**
+   * The value of the filter. If period is specified, the filter will
+   * return only those data items that fall within the bounds determined by
+   * the Period, inclusive of the period boundaries. If dateTime is
+   * specified, the filter will return only those data items that are equal
+   * to the specified dateTime. If a Duration is specified, the filter will
+   * return only those data items that fall within Duration before now.
+   */
+  readonly valuePeriod?: Period;
+
+  /**
+   * The value of the filter. If period is specified, the filter will
+   * return only those data items that fall within the bounds determined by
+   * the Period, inclusive of the period boundaries. If dateTime is
+   * specified, the filter will return only those data items that are equal
+   * to the specified dateTime. If a Duration is specified, the filter will
+   * return only those data items that fall within Duration before now.
+   */
+  readonly valueDuration?: Duration;
+}
+
+/**
+ * Specifies the order of the results to be returned.
+ */
+export interface DataRequirementSort {
+
+  /**
+   * Unique id for the element within a resource (for internal references).
+   * This may be any string value that does not contain spaces.
+   */
+  readonly 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.
+   */
+  readonly extension?: Extension[];
+
+  /**
+   * The attribute of the sort. The specified path must be resolvable from
+   * the type of the required data. The path is allowed to contain
+   * qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to
+   * traverse multiple-cardinality sub-elements. Note that the index must
+   * be an integer constant.
+   */
+  readonly path?: string;
+
+  /**
+   * The direction of the sort, ascending or descending.
+   */
+  readonly direction?: string;
+}

package/dist/DetectedIssue.d.ts

@@ -0,0 +1,293 @@
+/*
+ * Generated by @medplum/generator
+ * Do not edit manually.
+ */
+
+import { CodeableConcept } from './CodeableConcept';
+import { Device } from './Device';
+import { Extension } from './Extension';
+import { Identifier } from './Identifier';
+import { Meta } from './Meta';
+import { Narrative } from './Narrative';
+import { Patient } from './Patient';
+import { Period } from './Period';
+import { Practitioner } from './Practitioner';
+import { PractitionerRole } from './PractitionerRole';
+import { Reference } from './Reference';
+import { Resource } from './Resource';
+
+/**
+ * Indicates an actual or potential clinical issue with or between one or
+ * more active or proposed clinical actions for a patient; e.g. Drug-drug
+ * interaction, Ineffective treatment frequency, Procedure-condition
+ * conflict, etc.
+ */
+export interface DetectedIssue {
+
+  /**
+   * This is a DetectedIssue resource
+   */
+  readonly resourceType: 'DetectedIssue';
+
+  /**
+   * 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[];
+
+  /**
+   * Business identifier associated with the detected issue record.
+   */
+  readonly identifier?: Identifier[];
+
+  /**
+   * Indicates the status of the detected issue.
+   */
+  readonly status?: string;
+
+  /**
+   * Identifies the general type of issue identified.
+   */
+  readonly code?: CodeableConcept;
+
+  /**
+   * Indicates the degree of importance associated with the identified
+   * issue based on the potential impact on the patient.
+   */
+  readonly severity?: string;
+
+  /**
+   * Indicates the patient whose record the detected issue is associated
+   * with.
+   */
+  readonly patient?: Reference<Patient>;
+
+  /**
+   * The date or period when the detected issue was initially identified.
+   */
+  readonly identifiedDateTime?: string;
+
+  /**
+   * The date or period when the detected issue was initially identified.
+   */
+  readonly identifiedPeriod?: Period;
+
+  /**
+   * Individual or device responsible for the issue being raised.  For
+   * example, a decision support application or a pharmacist conducting a
+   * medication review.
+   */
+  readonly author?: Reference<Practitioner | PractitionerRole | Device>;
+
+  /**
+   * Indicates the resource representing the current activity or proposed
+   * activity that is potentially problematic.
+   */
+  readonly implicated?: Reference<Resource>[];
+
+  /**
+   * Supporting evidence or manifestations that provide the basis for
+   * identifying the detected issue such as a GuidanceResponse or
+   * MeasureReport.
+   */
+  readonly evidence?: DetectedIssueEvidence[];
+
+  /**
+   * A textual explanation of the detected issue.
+   */
+  readonly detail?: string;
+
+  /**
+   * The literature, knowledge-base or similar reference that describes the
+   * propensity for the detected issue identified.
+   */
+  readonly reference?: string;
+
+  /**
+   * Indicates an action that has been taken or is committed to reduce or
+   * eliminate the likelihood of the risk identified by the detected issue
+   * from manifesting.  Can also reflect an observation of known mitigating
+   * factors that may reduce/eliminate the need for any action.
+   */
+  readonly mitigation?: DetectedIssueMitigation[];
+}
+
+/**
+ * Supporting evidence or manifestations that provide the basis for
+ * identifying the detected issue such as a GuidanceResponse or
+ * MeasureReport.
+ */
+export interface DetectedIssueEvidence {
+
+  /**
+   * Unique id for the element within a resource (for internal references).
+   * This may be any string value that does not contain spaces.
+   */
+  readonly 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.
+   */
+  readonly 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 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.
+   * 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[];
+
+  /**
+   * A manifestation that led to the recording of this detected issue.
+   */
+  readonly code?: CodeableConcept[];
+
+  /**
+   * Links to resources that constitute evidence for the detected issue
+   * such as a GuidanceResponse or MeasureReport.
+   */
+  readonly detail?: Reference<Resource>[];
+}
+
+/**
+ * Indicates an action that has been taken or is committed to reduce or
+ * eliminate the likelihood of the risk identified by the detected issue
+ * from manifesting.  Can also reflect an observation of known mitigating
+ * factors that may reduce/eliminate the need for any action.
+ */
+export interface DetectedIssueMitigation {
+
+  /**
+   * Unique id for the element within a resource (for internal references).
+   * This may be any string value that does not contain spaces.
+   */
+  readonly 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.
+   */
+  readonly 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 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.
+   * 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[];
+
+  /**
+   * Describes the action that was taken or the observation that was made
+   * that reduces/eliminates the risk associated with the identified issue.
+   */
+  readonly action?: CodeableConcept;
+
+  /**
+   * Indicates when the mitigating action was documented.
+   */
+  readonly date?: string;
+
+  /**
+   * Identifies the practitioner who determined the mitigation and takes
+   * responsibility for the mitigation step occurring.
+   */
+  readonly author?: Reference<Practitioner | PractitionerRole>;
+}