@medplum/fhirtypes 0.3.0

package/dist/MessageHeader.d.ts

@@ -0,0 +1,374 @@
+/*
+ * Generated by @medplum/generator
+ * Do not edit manually.
+ */
+
+import { CodeableConcept } from './CodeableConcept';
+import { Coding } from './Coding';
+import { ContactPoint } from './ContactPoint';
+import { Device } from './Device';
+import { Extension } from './Extension';
+import { Meta } from './Meta';
+import { Narrative } from './Narrative';
+import { OperationOutcome } from './OperationOutcome';
+import { Organization } from './Organization';
+import { Practitioner } from './Practitioner';
+import { PractitionerRole } from './PractitionerRole';
+import { Reference } from './Reference';
+import { Resource } from './Resource';
+
+/**
+ * The header for a message exchange that is either requesting or
+ * responding to an action.  The reference(s) that are the subject of the
+ * action as well as other information related to the action are
+ * typically transmitted in a bundle in which the MessageHeader resource
+ * instance is the first resource in the bundle.
+ */
+export interface MessageHeader {
+
+  /**
+   * This is a MessageHeader resource
+   */
+  readonly resourceType: 'MessageHeader';
+
+  /**
+   * 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[];
+
+  /**
+   * Code that identifies the event this message represents and connects it
+   * with its definition. Events defined as part of the FHIR specification
+   * have the system value
+   * "http://terminology.hl7.org/CodeSystem/message-events".  Alternatively
+   * uri to the EventDefinition.
+   */
+  readonly eventCoding?: Coding;
+
+  /**
+   * Code that identifies the event this message represents and connects it
+   * with its definition. Events defined as part of the FHIR specification
+   * have the system value
+   * "http://terminology.hl7.org/CodeSystem/message-events".  Alternatively
+   * uri to the EventDefinition.
+   */
+  readonly eventUri?: string;
+
+  /**
+   * The destination application which the message is intended for.
+   */
+  readonly destination?: MessageHeaderDestination[];
+
+  /**
+   * Identifies the sending system to allow the use of a trust
+   * relationship.
+   */
+  readonly sender?: Reference<Practitioner | PractitionerRole | Organization>;
+
+  /**
+   * The person or device that performed the data entry leading to this
+   * message. When there is more than one candidate, pick the most proximal
+   * to the message. Can provide other enterers in extensions.
+   */
+  readonly enterer?: Reference<Practitioner | PractitionerRole>;
+
+  /**
+   * The logical author of the message - the person or device that decided
+   * the described event should happen. When there is more than one
+   * candidate, pick the most proximal to the MessageHeader. Can provide
+   * other authors in extensions.
+   */
+  readonly author?: Reference<Practitioner | PractitionerRole>;
+
+  /**
+   * The source application from which this message originated.
+   */
+  readonly source?: MessageHeaderSource;
+
+  /**
+   * The person or organization that accepts overall responsibility for the
+   * contents of the message. The implication is that the message event
+   * happened under the policies of the responsible party.
+   */
+  readonly responsible?: Reference<Practitioner | PractitionerRole | Organization>;
+
+  /**
+   * Coded indication of the cause for the event - indicates  a reason for
+   * the occurrence of the event that is a focus of this message.
+   */
+  readonly reason?: CodeableConcept;
+
+  /**
+   * Information about the message that this message is a response to.
+   * Only present if this message is a response.
+   */
+  readonly response?: MessageHeaderResponse;
+
+  /**
+   * The actual data of the message - a reference to the root/focus class
+   * of the event.
+   */
+  readonly focus?: Reference<Resource>[];
+
+  /**
+   * Permanent link to the MessageDefinition for this message.
+   */
+  readonly definition?: string;
+}
+
+/**
+ * The destination application which the message is intended for.
+ */
+export interface MessageHeaderDestination {
+
+  /**
+   * 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[];
+
+  /**
+   * Human-readable name for the target system.
+   */
+  readonly name?: string;
+
+  /**
+   * Identifies the target end system in situations where the initial
+   * message transmission is to an intermediary system.
+   */
+  readonly target?: Reference<Device>;
+
+  /**
+   * Indicates where the message should be routed to.
+   */
+  readonly endpoint?: string;
+
+  /**
+   * Allows data conveyed by a message to be addressed to a particular
+   * person or department when routing to a specific application isn't
+   * sufficient.
+   */
+  readonly receiver?: Reference<Practitioner | PractitionerRole | Organization>;
+}
+
+/**
+ * Information about the message that this message is a response to.
+ * Only present if this message is a response.
+ */
+export interface MessageHeaderResponse {
+
+  /**
+   * 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 MessageHeader.id of the message to which this message is a
+   * response.
+   */
+  readonly identifier?: string;
+
+  /**
+   * Code that identifies the type of response to the message - whether it
+   * was successful or not, and whether it should be resent or not.
+   */
+  readonly code?: string;
+
+  /**
+   * Full details of any issues found in the message.
+   */
+  readonly details?: Reference<OperationOutcome>;
+}
+
+/**
+ * The source application from which this message originated.
+ */
+export interface MessageHeaderSource {
+
+  /**
+   * 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[];
+
+  /**
+   * Human-readable name for the source system.
+   */
+  readonly name?: string;
+
+  /**
+   * May include configuration or other information useful in debugging.
+   */
+  readonly software?: string;
+
+  /**
+   * Can convey versions of multiple systems in situations where a message
+   * passes through multiple hands.
+   */
+  readonly version?: string;
+
+  /**
+   * An e-mail, phone, website or other contact point to use to resolve
+   * issues with message communications.
+   */
+  readonly contact?: ContactPoint;
+
+  /**
+   * Identifies the routing target to send acknowledgements to.
+   */
+  readonly endpoint?: string;
+}

package/dist/Meta.d.ts

@@ -0,0 +1,92 @@
+/*
+ * Generated by @medplum/generator
+ * Do not edit manually.
+ */
+
+import { Coding } from './Coding';
+import { Extension } from './Extension';
+import { Reference } from './Reference';
+
+/**
+ * Base StructureDefinition for Meta Type: The metadata about a resource.
+ * This is content in the resource that is maintained by the
+ * infrastructure. Changes to the content might not always be associated
+ * with version changes to the resource.
+ */
+export interface Meta {
+
+  /**
+   * 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 version specific identifier, as it appears in the version portion
+   * of the URL. This value changes when the resource is created, updated,
+   * or deleted.
+   */
+  readonly versionId?: string;
+
+  /**
+   * When the resource last changed - e.g. when the version changed.
+   */
+  readonly lastUpdated?: string;
+
+  /**
+   * A uri that identifies the source system of the resource. This provides
+   * a minimal amount of [Provenance](provenance.html#) information that
+   * can be used to track or differentiate the source of information in the
+   * resource. The source may identify another FHIR server, document,
+   * message, database, etc.
+   */
+  readonly source?: string;
+
+  /**
+   * A list of profiles (references to
+   * [StructureDefinition](structuredefinition.html#) resources) that this
+   * resource claims to conform to. The URL is a reference to
+   * [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url).
+   */
+  readonly profile?: string[];
+
+  /**
+   * Security labels applied to this resource. These tags connect specific
+   * resources to the overall security policy and infrastructure.
+   */
+  readonly security?: Coding[];
+
+  /**
+   * Tags applied to this resource. Tags are intended to be used to
+   * identify and relate resources to process and workflow, and
+   * applications are not required to consider the tags when interpreting
+   * the meaning of a resource.
+   */
+  readonly tag?: Coding[];
+
+  /**
+   * The project that contains this resource.
+   */
+  readonly project?: string;
+
+  /**
+   * The individual, device or organization who initiated the last change.
+   */
+  readonly author?: Reference;
+
+  /**
+   * Optional account reference that can be used for sub-project
+   * compartments.
+   */
+  readonly account?: Reference;
+}