@medplum/fhirtypes 0.3.0

package/dist/Subscription.d.ts

@@ -0,0 +1,202 @@
+/*
+ * Generated by @medplum/generator
+ * Do not edit manually.
+ */
+
+import { ContactPoint } from './ContactPoint';
+import { Extension } from './Extension';
+import { Meta } from './Meta';
+import { Narrative } from './Narrative';
+import { Resource } from './Resource';
+
+/**
+ * The subscription resource is used to define a push-based subscription
+ * from a server to another system. Once a subscription is registered
+ * with the server, the server checks every resource that is created or
+ * updated, and if the resource matches the given criteria, it sends a
+ * message on the defined "channel" so that another system can take an
+ * appropriate action.
+ */
+export interface Subscription {
+
+  /**
+   * This is a Subscription resource
+   */
+  readonly resourceType: 'Subscription';
+
+  /**
+   * 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[];
+
+  /**
+   * The status of the subscription, which marks the server state for
+   * managing the subscription.
+   */
+  readonly status?: string;
+
+  /**
+   * Contact details for a human to contact about the subscription. The
+   * primary use of this for system administrator troubleshooting.
+   */
+  readonly contact?: ContactPoint[];
+
+  /**
+   * The time for the server to turn the subscription off.
+   */
+  readonly end?: string;
+
+  /**
+   * A description of why this subscription is defined.
+   */
+  readonly reason?: string;
+
+  /**
+   * The rules that the server should use to determine when to generate
+   * notifications for this subscription.
+   */
+  readonly criteria?: string;
+
+  /**
+   * A record of the last error that occurred when the server processed a
+   * notification.
+   */
+  readonly error?: string;
+
+  /**
+   * Details where to send notifications when resources are received that
+   * meet the criteria.
+   */
+  readonly channel?: SubscriptionChannel;
+}
+
+/**
+ * Details where to send notifications when resources are received that
+ * meet the criteria.
+ */
+export interface SubscriptionChannel {
+
+  /**
+   * 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[];
+
+  /**
+   * The type of channel to send notifications on.
+   */
+  readonly type?: string;
+
+  /**
+   * The url that describes the actual end-point to send messages to.
+   */
+  readonly endpoint?: string;
+
+  /**
+   * The mime type to send the payload in - either application/fhir+xml, or
+   * application/fhir+json. If the payload is not present, then there is no
+   * payload in the notification, just a notification. The mime type
+   * "text/plain" may also be used for Email and SMS subscriptions.
+   */
+  readonly payload?: string;
+
+  /**
+   * Additional headers / information to send as part of the notification.
+   */
+  readonly header?: string[];
+}

package/dist/Substance.d.ts

@@ -0,0 +1,249 @@
+/*
+ * Generated by @medplum/generator
+ * Do not edit manually.
+ */
+
+import { CodeableConcept } from './CodeableConcept';
+import { Extension } from './Extension';
+import { Identifier } from './Identifier';
+import { Meta } from './Meta';
+import { Narrative } from './Narrative';
+import { Quantity } from './Quantity';
+import { Ratio } from './Ratio';
+import { Reference } from './Reference';
+import { Resource } from './Resource';
+
+/**
+ * A homogeneous material with a definite composition.
+ */
+export interface Substance {
+
+  /**
+   * This is a Substance resource
+   */
+  readonly resourceType: 'Substance';
+
+  /**
+   * 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[];
+
+  /**
+   * Unique identifier for the substance.
+   */
+  readonly identifier?: Identifier[];
+
+  /**
+   * A code to indicate if the substance is actively used.
+   */
+  readonly status?: string;
+
+  /**
+   * A code that classifies the general type of substance.  This is used
+   * for searching, sorting and display purposes.
+   */
+  readonly category?: CodeableConcept[];
+
+  /**
+   * A code (or set of codes) that identify this substance.
+   */
+  readonly code?: CodeableConcept;
+
+  /**
+   * A description of the substance - its appearance, handling
+   * requirements, and other usage notes.
+   */
+  readonly description?: string;
+
+  /**
+   * Substance may be used to describe a kind of substance, or a specific
+   * package/container of the substance: an instance.
+   */
+  readonly instance?: SubstanceInstance[];
+
+  /**
+   * A substance can be composed of other substances.
+   */
+  readonly ingredient?: SubstanceIngredient[];
+}
+
+/**
+ * A substance can be composed of other substances.
+ */
+export interface SubstanceIngredient {
+
+  /**
+   * 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[];
+
+  /**
+   * The amount of the ingredient in the substance - a concentration ratio.
+   */
+  readonly quantity?: Ratio;
+
+  /**
+   * Another substance that is a component of this substance.
+   */
+  readonly substanceCodeableConcept?: CodeableConcept;
+
+  /**
+   * Another substance that is a component of this substance.
+   */
+  readonly substanceReference?: Reference<Substance>;
+}
+
+/**
+ * Substance may be used to describe a kind of substance, or a specific
+ * package/container of the substance: an instance.
+ */
+export interface SubstanceInstance {
+
+  /**
+   * 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[];
+
+  /**
+   * Identifier associated with the package/container (usually a label
+   * affixed directly).
+   */
+  readonly identifier?: Identifier;
+
+  /**
+   * When the substance is no longer valid to use. For some substances, a
+   * single arbitrary date is used for expiry.
+   */
+  readonly expiry?: string;
+
+  /**
+   * The amount of the substance.
+   */
+  readonly quantity?: Quantity;
+}

package/dist/SubstanceAmount.d.ts

@@ -0,0 +1,135 @@
+/*
+ * Generated by @medplum/generator
+ * Do not edit manually.
+ */
+
+import { CodeableConcept } from './CodeableConcept';
+import { Extension } from './Extension';
+import { Quantity } from './Quantity';
+import { Range } from './Range';
+
+/**
+ * Base StructureDefinition for SubstanceAmount Type: Chemical substances
+ * are a single substance type whose primary defining element is the
+ * molecular structure. Chemical substances shall be defined on the basis
+ * of their complete covalent molecular structure; the presence of a salt
+ * (counter-ion) and/or solvates (water, alcohols) is also captured.
+ * Purity, grade, physical form or particle size are not taken into
+ * account in the definition of a chemical substance or in the assignment
+ * of a Substance ID.
+ */
+export interface SubstanceAmount {
+
+  /**
+   * 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[];
+
+  /**
+   * Used to capture quantitative values for a variety of elements. If only
+   * limits are given, the arithmetic mean would be the average. If only a
+   * single definite value for a given element is given, it would be
+   * captured in this field.
+   */
+  readonly amountQuantity?: Quantity;
+
+  /**
+   * Used to capture quantitative values for a variety of elements. If only
+   * limits are given, the arithmetic mean would be the average. If only a
+   * single definite value for a given element is given, it would be
+   * captured in this field.
+   */
+  readonly amountRange?: Range;
+
+  /**
+   * Used to capture quantitative values for a variety of elements. If only
+   * limits are given, the arithmetic mean would be the average. If only a
+   * single definite value for a given element is given, it would be
+   * captured in this field.
+   */
+  readonly amountString?: string;
+
+  /**
+   * Most elements that require a quantitative value will also have a field
+   * called amount type. Amount type should always be specified because the
+   * actual value of the amount is often dependent on it. EXAMPLE: In
+   * capturing the actual relative amounts of substances or molecular
+   * fragments it is essential to indicate whether the amount refers to a
+   * mole ratio or weight ratio. For any given element an effort should be
+   * made to use same the amount type for all related definitional
+   * elements.
+   */
+  readonly amountType?: CodeableConcept;
+
+  /**
+   * A textual comment on a numeric value.
+   */
+  readonly amountText?: string;
+
+  /**
+   * Reference range of possible or expected values.
+   */
+  readonly referenceRange?: SubstanceAmountReferenceRange;
+}
+
+/**
+ * Reference range of possible or expected values.
+ */
+export interface SubstanceAmountReferenceRange {
+
+  /**
+   * 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[];
+
+  /**
+   * Lower limit possible or expected.
+   */
+  readonly lowLimit?: Quantity;
+
+  /**
+   * Upper limit possible or expected.
+   */
+  readonly highLimit?: Quantity;
+}