@medplum/fhirtypes 0.3.0

package/dist/EpisodeOfCare.d.ts

@@ -0,0 +1,286 @@
+/*
+ * Generated by @medplum/generator
+ * Do not edit manually.
+ */
+
+import { Account } from './Account';
+import { CareTeam } from './CareTeam';
+import { CodeableConcept } from './CodeableConcept';
+import { Condition } from './Condition';
+import { Extension } from './Extension';
+import { Identifier } from './Identifier';
+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 { Resource } from './Resource';
+import { ServiceRequest } from './ServiceRequest';
+
+/**
+ * An association between a patient and an organization / healthcare
+ * provider(s) during which time encounters may occur. The managing
+ * organization assumes a level of responsibility for the patient during
+ * this time.
+ */
+export interface EpisodeOfCare {
+
+  /**
+   * This is a EpisodeOfCare resource
+   */
+  readonly resourceType: 'EpisodeOfCare';
+
+  /**
+   * 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 EpisodeOfCare may be known by different identifiers for different
+   * contexts of use, such as when an external agency is tracking the
+   * Episode for funding purposes.
+   */
+  readonly identifier?: Identifier[];
+
+  /**
+   * planned | waitlist | active | onhold | finished | cancelled.
+   */
+  readonly status?: string;
+
+  /**
+   * The history of statuses that the EpisodeOfCare has been through
+   * (without requiring processing the history of the resource).
+   */
+  readonly statusHistory?: EpisodeOfCareStatusHistory[];
+
+  /**
+   * A classification of the type of episode of care; e.g. specialist
+   * referral, disease management, type of funded care.
+   */
+  readonly type?: CodeableConcept[];
+
+  /**
+   * The list of diagnosis relevant to this episode of care.
+   */
+  readonly diagnosis?: EpisodeOfCareDiagnosis[];
+
+  /**
+   * The patient who is the focus of this episode of care.
+   */
+  readonly patient?: Reference<Patient>;
+
+  /**
+   * The organization that has assumed the specific responsibilities for
+   * the specified duration.
+   */
+  readonly managingOrganization?: Reference<Organization>;
+
+  /**
+   * The interval during which the managing organization assumes the
+   * defined responsibility.
+   */
+  readonly period?: Period;
+
+  /**
+   * Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming
+   * referrals.
+   */
+  readonly referralRequest?: Reference<ServiceRequest>[];
+
+  /**
+   * The practitioner that is the care manager/care coordinator for this
+   * patient.
+   */
+  readonly careManager?: Reference<Practitioner | PractitionerRole>;
+
+  /**
+   * The list of practitioners that may be facilitating this episode of
+   * care for specific purposes.
+   */
+  readonly team?: Reference<CareTeam>[];
+
+  /**
+   * The set of accounts that may be used for billing for this
+   * EpisodeOfCare.
+   */
+  readonly account?: Reference<Account>[];
+}
+
+/**
+ * The list of diagnosis relevant to this episode of care.
+ */
+export interface EpisodeOfCareDiagnosis {
+
+  /**
+   * 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 list of conditions/problems/diagnoses that this episode of care is
+   * intended to be providing care for.
+   */
+  readonly condition?: Reference<Condition>;
+
+  /**
+   * Role that this diagnosis has within the episode of care (e.g.
+   * admission, billing, discharge &hellip;).
+   */
+  readonly role?: CodeableConcept;
+
+  /**
+   * Ranking of the diagnosis (for each role type).
+   */
+  readonly rank?: number;
+}
+
+/**
+ * The history of statuses that the EpisodeOfCare has been through
+ * (without requiring processing the history of the resource).
+ */
+export interface EpisodeOfCareStatusHistory {
+
+  /**
+   * 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[];
+
+  /**
+   * planned | waitlist | active | onhold | finished | cancelled.
+   */
+  readonly status?: string;
+
+  /**
+   * The period during this EpisodeOfCare that the specific status applied.
+   */
+  readonly period?: Period;
+}

package/dist/EventDefinition.d.ts

@@ -0,0 +1,297 @@
+/*
+ * Generated by @medplum/generator
+ * Do not edit manually.
+ */
+
+import { CodeableConcept } from './CodeableConcept';
+import { ContactDetail } from './ContactDetail';
+import { Extension } from './Extension';
+import { Group } from './Group';
+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 { TriggerDefinition } from './TriggerDefinition';
+import { UsageContext } from './UsageContext';
+
+/**
+ * The EventDefinition resource provides a reusable description of when a
+ * particular event can occur.
+ */
+export interface EventDefinition {
+
+  /**
+   * This is a EventDefinition resource
+   */
+  readonly resourceType: 'EventDefinition';
+
+  /**
+   * 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 event definition 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 event definition is (or will be) published. This URL
+   * can be the target of a canonical reference. It SHALL remain the same
+   * when the event definition is stored on different servers.
+   */
+  readonly url?: string;
+
+  /**
+   * A formal identifier that is used to identify this event definition
+   * 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 event
+   * definition when it is referenced in a specification, model, design or
+   * instance. This is an arbitrary value managed by the event definition
+   * 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.
+   */
+  readonly version?: string;
+
+  /**
+   * A natural language name identifying the event definition. 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 event definition.
+   */
+  readonly title?: string;
+
+  /**
+   * An explanatory or alternate title for the event definition giving
+   * additional information about its content.
+   */
+  readonly subtitle?: string;
+
+  /**
+   * The status of this event definition. Enables tracking the life-cycle
+   * of the content.
+   */
+  readonly status?: string;
+
+  /**
+   * A Boolean value to indicate that this event definition is authored for
+   * testing purposes (or education/evaluation/marketing) and is not
+   * intended to be used for genuine usage.
+   */
+  readonly experimental?: boolean;
+
+  /**
+   * A code or group definition that describes the intended subject of the
+   * event definition.
+   */
+  readonly subjectCodeableConcept?: CodeableConcept;
+
+  /**
+   * A code or group definition that describes the intended subject of the
+   * event definition.
+   */
+  readonly subjectReference?: Reference<Group>;
+
+  /**
+   * The date  (and optionally time) when the event definition 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 event definition changes.
+   */
+  readonly date?: string;
+
+  /**
+   * The name of the organization or individual that published the event
+   * definition.
+   */
+  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 event definition from
+   * a consumer's perspective.
+   */
+  readonly description?: string;
+
+  /**
+   * 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 event definition instances.
+   */
+  readonly useContext?: UsageContext[];
+
+  /**
+   * A legal or geographic region in which the event definition is intended
+   * to be used.
+   */
+  readonly jurisdiction?: CodeableConcept[];
+
+  /**
+   * Explanation of why this event definition is needed and why it has been
+   * designed as it has.
+   */
+  readonly purpose?: string;
+
+  /**
+   * A detailed description of how the event definition is used from a
+   * clinical perspective.
+   */
+  readonly usage?: string;
+
+  /**
+   * A copyright statement relating to the event definition and/or its
+   * contents. Copyright statements are generally legal restrictions on the
+   * use and publishing of the event definition.
+   */
+  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 event definition content was or is planned
+   * to be in active use.
+   */
+  readonly effectivePeriod?: Period;
+
+  /**
+   * Descriptive topics related to the module. Topics provide a high-level
+   * categorization of the module 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 resources such as additional documentation, justification, or
+   * bibliographic references.
+   */
+  readonly relatedArtifact?: RelatedArtifact[];
+
+  /**
+   * The trigger element defines when the event occurs. If more than one
+   * trigger condition is specified, the event fires whenever any one of
+   * the trigger conditions is met.
+   */
+  readonly trigger?: TriggerDefinition[];
+}