@medplum/fhirtypes 0.3.0

package/dist/Media.d.ts

@@ -0,0 +1,243 @@
+/*
+ * Generated by @medplum/generator
+ * Do not edit manually.
+ */
+
+import { Annotation } from './Annotation';
+import { Attachment } from './Attachment';
+import { CarePlan } from './CarePlan';
+import { CareTeam } from './CareTeam';
+import { CodeableConcept } from './CodeableConcept';
+import { Device } from './Device';
+import { DeviceMetric } from './DeviceMetric';
+import { Encounter } from './Encounter';
+import { Extension } from './Extension';
+import { Group } from './Group';
+import { Identifier } from './Identifier';
+import { Location } from './Location';
+import { Meta } from './Meta';
+import { Narrative } from './Narrative';
+import { Organization } from './Organization';
+import { Patient } from './Patient';
+import { Period } from './Period';
+import { Practitioner } from './Practitioner';
+import { PractitionerRole } from './PractitionerRole';
+import { Reference } from './Reference';
+import { RelatedPerson } from './RelatedPerson';
+import { Resource } from './Resource';
+import { ServiceRequest } from './ServiceRequest';
+import { Specimen } from './Specimen';
+
+/**
+ * A photo, video, or audio recording acquired or used in healthcare. The
+ * actual content may be inline or provided by direct reference.
+ */
+export interface Media {
+
+  /**
+   * This is a Media resource
+   */
+  readonly resourceType: 'Media';
+
+  /**
+   * 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[];
+
+  /**
+   * Identifiers associated with the image - these may include identifiers
+   * for the image itself, identifiers for the context of its collection
+   * (e.g. series ids) and context ids such as accession numbers or other
+   * workflow identifiers.
+   */
+  readonly identifier?: Identifier[];
+
+  /**
+   * A procedure that is fulfilled in whole or in part by the creation of
+   * this media.
+   */
+  readonly basedOn?: Reference<ServiceRequest | CarePlan>[];
+
+  /**
+   * A larger event of which this particular event is a component or step.
+   */
+  readonly partOf?: Reference<Resource>[];
+
+  /**
+   * The current state of the {{title}}.
+   */
+  readonly status?: string;
+
+  /**
+   * A code that classifies whether the media is an image, video or audio
+   * recording or some other media category.
+   */
+  readonly type?: CodeableConcept;
+
+  /**
+   * Details of the type of the media - usually, how it was acquired (what
+   * type of device). If images sourced from a DICOM system, are wrapped in
+   * a Media resource, then this is the modality.
+   */
+  readonly modality?: CodeableConcept;
+
+  /**
+   * The name of the imaging view e.g. Lateral or Antero-posterior (AP).
+   */
+  readonly view?: CodeableConcept;
+
+  /**
+   * Who/What this Media is a record of.
+   */
+  readonly subject?: Reference<Patient | Practitioner | PractitionerRole | Group | Device | Specimen | Location>;
+
+  /**
+   * The encounter that establishes the context for this media.
+   */
+  readonly encounter?: Reference<Encounter>;
+
+  /**
+   * The date and time(s) at which the media was collected.
+   */
+  readonly createdDateTime?: string;
+
+  /**
+   * The date and time(s) at which the media was collected.
+   */
+  readonly createdPeriod?: Period;
+
+  /**
+   * The date and time this version of the media was made available to
+   * providers, typically after having been reviewed.
+   */
+  readonly issued?: string;
+
+  /**
+   * The person who administered the collection of the image.
+   */
+  readonly operator?: Reference<Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson>;
+
+  /**
+   * Describes why the event occurred in coded or textual form.
+   */
+  readonly reasonCode?: CodeableConcept[];
+
+  /**
+   * Indicates the site on the subject's body where the observation was
+   * made (i.e. the target site).
+   */
+  readonly bodySite?: CodeableConcept;
+
+  /**
+   * The name of the device / manufacturer of the device  that was used to
+   * make the recording.
+   */
+  readonly deviceName?: string;
+
+  /**
+   * The device used to collect the media.
+   */
+  readonly device?: Reference<Device | DeviceMetric | Device>;
+
+  /**
+   * Height of the image in pixels (photo/video).
+   */
+  readonly height?: number;
+
+  /**
+   * Width of the image in pixels (photo/video).
+   */
+  readonly width?: number;
+
+  /**
+   * The number of frames in a photo. This is used with a multi-page fax,
+   * or an imaging acquisition context that takes multiple slices in a
+   * single image, or an animated gif. If there is more than one frame,
+   * this SHALL have a value in order to alert interface software that a
+   * multi-frame capable rendering widget is required.
+   */
+  readonly frames?: number;
+
+  /**
+   * The duration of the recording in seconds - for audio and video.
+   */
+  readonly duration?: number;
+
+  /**
+   * The actual content of the media - inline or by direct reference to the
+   * media source file.
+   */
+  readonly content?: Attachment;
+
+  /**
+   * Comments made about the media by the performer, subject or other
+   * participants.
+   */
+  readonly note?: Annotation[];
+}

package/dist/Medication.d.ts

@@ -0,0 +1,267 @@
+/*
+ * 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 { Organization } from './Organization';
+import { Ratio } from './Ratio';
+import { Reference } from './Reference';
+import { Resource } from './Resource';
+import { Substance } from './Substance';
+
+/**
+ * This resource is primarily used for the identification and definition
+ * of a medication for the purposes of prescribing, dispensing, and
+ * administering a medication as well as for making statements about
+ * medication use.
+ */
+export interface Medication {
+
+  /**
+   * This is a Medication resource
+   */
+  readonly resourceType: 'Medication';
+
+  /**
+   * 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 for this medication.
+   */
+  readonly identifier?: Identifier[];
+
+  /**
+   * A code (or set of codes) that specify this medication, or a textual
+   * description if no code is available. Usage note: This could be a
+   * standard medication code such as a code from RxNorm, SNOMED CT, IDMP
+   * etc. It could also be a national or local formulary code, optionally
+   * with translations to other code systems.
+   */
+  readonly code?: CodeableConcept;
+
+  /**
+   * A code to indicate if the medication is in active use.
+   */
+  readonly status?: string;
+
+  /**
+   * Describes the details of the manufacturer of the medication product.
+   * This is not intended to represent the distributor of a medication
+   * product.
+   */
+  readonly manufacturer?: Reference<Organization>;
+
+  /**
+   * Describes the form of the item.  Powder; tablets; capsule.
+   */
+  readonly form?: CodeableConcept;
+
+  /**
+   * Specific amount of the drug in the packaged product.  For example,
+   * when specifying a product that has the same strength (For example,
+   * Insulin glargine 100 unit per mL solution for injection), this
+   * attribute provides additional clarification of the package amount (For
+   * example, 3 mL, 10mL, etc.).
+   */
+  readonly amount?: Ratio;
+
+  /**
+   * Identifies a particular constituent of interest in the product.
+   */
+  readonly ingredient?: MedicationIngredient[];
+
+  /**
+   * Information that only applies to packages (not products).
+   */
+  readonly batch?: MedicationBatch;
+}
+
+/**
+ * Information that only applies to packages (not products).
+ */
+export interface MedicationBatch {
+
+  /**
+   * 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 assigned lot number of a batch of the specified product.
+   */
+  readonly lotNumber?: string;
+
+  /**
+   * When this specific batch of product will expire.
+   */
+  readonly expirationDate?: string;
+}
+
+/**
+ * Identifies a particular constituent of interest in the product.
+ */
+export interface MedicationIngredient {
+
+  /**
+   * 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 actual ingredient - either a substance (simple ingredient) or
+   * another medication of a medication.
+   */
+  readonly itemCodeableConcept?: CodeableConcept;
+
+  /**
+   * The actual ingredient - either a substance (simple ingredient) or
+   * another medication of a medication.
+   */
+  readonly itemReference?: Reference<Substance | Medication>;
+
+  /**
+   * Indication of whether this ingredient affects the therapeutic action
+   * of the drug.
+   */
+  readonly isActive?: boolean;
+
+  /**
+   * Specifies how many (or how much) of the items there are in this
+   * Medication.  For example, 250 mg per tablet.  This is expressed as a
+   * ratio where the numerator is 250mg and the denominator is 1 tablet.
+   */
+  readonly strength?: Ratio;
+}