@medplum/fhirtypes 0.3.0

package/dist/ExampleScenario.d.ts

@@ -0,0 +1,728 @@
+/*
+ * Generated by @medplum/generator
+ * Do not edit manually.
+ */
+
+import { CodeableConcept } from './CodeableConcept';
+import { ContactDetail } from './ContactDetail';
+import { Extension } from './Extension';
+import { Identifier } from './Identifier';
+import { Meta } from './Meta';
+import { Narrative } from './Narrative';
+import { Resource } from './Resource';
+import { UsageContext } from './UsageContext';
+
+/**
+ * Example of workflow instance.
+ */
+export interface ExampleScenario {
+
+  /**
+   * This is a ExampleScenario resource
+   */
+  readonly resourceType: 'ExampleScenario';
+
+  /**
+   * 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 example scenario 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 example scenario is (or will be) published. This URL
+   * can be the target of a canonical reference. It SHALL remain the same
+   * when the example scenario is stored on different servers.
+   */
+  readonly url?: string;
+
+  /**
+   * A formal identifier that is used to identify this example scenario
+   * 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 example
+   * scenario when it is referenced in a specification, model, design or
+   * instance. This is an arbitrary value managed by the example scenario
+   * 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 example scenario. This name
+   * should be usable as an identifier for the module by machine processing
+   * applications such as code generation.
+   */
+  readonly name?: string;
+
+  /**
+   * The status of this example scenario. Enables tracking the life-cycle
+   * of the content.
+   */
+  readonly status?: string;
+
+  /**
+   * A Boolean value to indicate that this example scenario is authored for
+   * testing purposes (or education/evaluation/marketing) and is not
+   * intended to be used for genuine usage.
+   */
+  readonly experimental?: boolean;
+
+  /**
+   * The date  (and optionally time) when the example scenario 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 example scenario changes.
+   * (e.g. the 'content logical definition').
+   */
+  readonly date?: string;
+
+  /**
+   * The name of the organization or individual that published the example
+   * scenario.
+   */
+  readonly publisher?: string;
+
+  /**
+   * Contact details to assist a user in finding and communicating with the
+   * publisher.
+   */
+  readonly contact?: ContactDetail[];
+
+  /**
+   * 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 example scenario instances.
+   */
+  readonly useContext?: UsageContext[];
+
+  /**
+   * A legal or geographic region in which the example scenario is intended
+   * to be used.
+   */
+  readonly jurisdiction?: CodeableConcept[];
+
+  /**
+   * A copyright statement relating to the example scenario and/or its
+   * contents. Copyright statements are generally legal restrictions on the
+   * use and publishing of the example scenario.
+   */
+  readonly copyright?: string;
+
+  /**
+   * What the example scenario resource is created for. This should not be
+   * used to show the business purpose of the scenario itself, but the
+   * purpose of documenting a scenario.
+   */
+  readonly purpose?: string;
+
+  /**
+   * Actor participating in the resource.
+   */
+  readonly actor?: ExampleScenarioActor[];
+
+  /**
+   * Each resource and each version that is present in the workflow.
+   */
+  readonly instance?: ExampleScenarioInstance[];
+
+  /**
+   * Each major process - a group of operations.
+   */
+  readonly process?: ExampleScenarioProcess[];
+
+  /**
+   * Another nested workflow.
+   */
+  readonly workflow?: string[];
+}
+
+/**
+ * Actor participating in the resource.
+ */
+export interface ExampleScenarioActor {
+
+  /**
+   * 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[];
+
+  /**
+   * ID or acronym of actor.
+   */
+  readonly actorId?: string;
+
+  /**
+   * The type of actor - person or system.
+   */
+  readonly type?: string;
+
+  /**
+   * The name of the actor as shown in the page.
+   */
+  readonly name?: string;
+
+  /**
+   * The description of the actor.
+   */
+  readonly description?: string;
+}
+
+/**
+ * Each resource and each version that is present in the workflow.
+ */
+export interface ExampleScenarioInstance {
+
+  /**
+   * 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 id of the resource for referencing.
+   */
+  readonly resourceId?: string;
+
+  /**
+   * The type of the resource.
+   */
+  readonly resourceType?: string;
+
+  /**
+   * A short name for the resource instance.
+   */
+  readonly name?: string;
+
+  /**
+   * Human-friendly description of the resource instance.
+   */
+  readonly description?: string;
+
+  /**
+   * A specific version of the resource.
+   */
+  readonly version?: ExampleScenarioInstanceVersion[];
+
+  /**
+   * Resources contained in the instance (e.g. the observations contained
+   * in a bundle).
+   */
+  readonly containedInstance?: ExampleScenarioInstanceContainedInstance[];
+}
+
+/**
+ * Resources contained in the instance (e.g. the observations contained
+ * in a bundle).
+ */
+export interface ExampleScenarioInstanceContainedInstance {
+
+  /**
+   * 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[];
+
+  /**
+   * Each resource contained in the instance.
+   */
+  readonly resourceId?: string;
+
+  /**
+   * A specific version of a resource contained in the instance.
+   */
+  readonly versionId?: string;
+}
+
+/**
+ * A specific version of the resource.
+ */
+export interface ExampleScenarioInstanceVersion {
+
+  /**
+   * 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 identifier of a specific version of a resource.
+   */
+  readonly versionId?: string;
+
+  /**
+   * The description of the resource version.
+   */
+  readonly description?: string;
+}
+
+/**
+ * Each major process - a group of operations.
+ */
+export interface ExampleScenarioProcess {
+
+  /**
+   * 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 diagram title of the group of operations.
+   */
+  readonly title?: string;
+
+  /**
+   * A longer description of the group of operations.
+   */
+  readonly description?: string;
+
+  /**
+   * Description of initial status before the process starts.
+   */
+  readonly preConditions?: string;
+
+  /**
+   * Description of final status after the process ends.
+   */
+  readonly postConditions?: string;
+
+  /**
+   * Each step of the process.
+   */
+  readonly step?: ExampleScenarioProcessStep[];
+}
+
+/**
+ * Each step of the process.
+ */
+export interface ExampleScenarioProcessStep {
+
+  /**
+   * 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[];
+
+  /**
+   * Nested process.
+   */
+  readonly process?: ExampleScenarioProcess[];
+
+  /**
+   * If there is a pause in the flow.
+   */
+  readonly pause?: boolean;
+
+  /**
+   * Each interaction or action.
+   */
+  readonly operation?: ExampleScenarioProcessStepOperation;
+
+  /**
+   * Indicates an alternative step that can be taken instead of the
+   * operations on the base step in exceptional/atypical circumstances.
+   */
+  readonly alternative?: ExampleScenarioProcessStepAlternative[];
+}
+
+/**
+ * Indicates an alternative step that can be taken instead of the
+ * operations on the base step in exceptional/atypical circumstances.
+ */
+export interface ExampleScenarioProcessStepAlternative {
+
+  /**
+   * 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 label to display for the alternative that gives a sense of the
+   * circumstance in which the alternative should be invoked.
+   */
+  readonly title?: string;
+
+  /**
+   * A human-readable description of the alternative explaining when the
+   * alternative should occur rather than the base step.
+   */
+  readonly description?: string;
+
+  /**
+   * What happens in each alternative option.
+   */
+  readonly step?: ExampleScenarioProcessStep[];
+}
+
+/**
+ * Each interaction or action.
+ */
+export interface ExampleScenarioProcessStepOperation {
+
+  /**
+   * 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 sequential number of the interaction, e.g. 1.2.5.
+   */
+  readonly number?: string;
+
+  /**
+   * The type of operation - CRUD.
+   */
+  readonly type?: string;
+
+  /**
+   * The human-friendly name of the interaction.
+   */
+  readonly name?: string;
+
+  /**
+   * Who starts the transaction.
+   */
+  readonly initiator?: string;
+
+  /**
+   * Who receives the transaction.
+   */
+  readonly receiver?: string;
+
+  /**
+   * A comment to be inserted in the diagram.
+   */
+  readonly description?: string;
+
+  /**
+   * Whether the initiator is deactivated right after the transaction.
+   */
+  readonly initiatorActive?: boolean;
+
+  /**
+   * Whether the receiver is deactivated right after the transaction.
+   */
+  readonly receiverActive?: boolean;
+
+  /**
+   * Each resource instance used by the initiator.
+   */
+  readonly request?: ExampleScenarioInstanceContainedInstance;
+
+  /**
+   * Each resource instance used by the responder.
+   */
+  readonly response?: ExampleScenarioInstanceContainedInstance;
+}