@medplum/fhirtypes 0.3.0

package/dist/AuditEvent.d.ts

@@ -0,0 +1,532 @@
+/*
+ * Generated by @medplum/generator
+ * Do not edit manually.
+ */
+
+import { CodeableConcept } from './CodeableConcept';
+import { Coding } from './Coding';
+import { Device } from './Device';
+import { Extension } from './Extension';
+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';
+
+/**
+ * A record of an event made for purposes of maintaining a security log.
+ * Typical uses include detection of intrusion attempts and monitoring
+ * for inappropriate usage.
+ */
+export interface AuditEvent {
+
+  /**
+   * This is a AuditEvent resource
+   */
+  readonly resourceType: 'AuditEvent';
+
+  /**
+   * 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[];
+
+  /**
+   * Identifier for a family of the event.  For example, a menu item,
+   * program, rule, policy, function code, application name or URL. It
+   * identifies the performed function.
+   */
+  readonly type?: Coding;
+
+  /**
+   * Identifier for the category of event.
+   */
+  readonly subtype?: Coding[];
+
+  /**
+   * Indicator for type of action performed during the event that generated
+   * the audit.
+   */
+  readonly action?: string;
+
+  /**
+   * The period during which the activity occurred.
+   */
+  readonly period?: Period;
+
+  /**
+   * The time when the event was recorded.
+   */
+  readonly recorded?: string;
+
+  /**
+   * Indicates whether the event succeeded or failed.
+   */
+  readonly outcome?: string;
+
+  /**
+   * A free text description of the outcome of the event.
+   */
+  readonly outcomeDesc?: string;
+
+  /**
+   * The purposeOfUse (reason) that was used during the event being
+   * recorded.
+   */
+  readonly purposeOfEvent?: CodeableConcept[];
+
+  /**
+   * An actor taking an active role in the event or activity that is
+   * logged.
+   */
+  readonly agent?: AuditEventAgent[];
+
+  /**
+   * The system that is reporting the event.
+   */
+  readonly source?: AuditEventSource;
+
+  /**
+   * Specific instances of data or objects that have been accessed.
+   */
+  readonly entity?: AuditEventEntity[];
+}
+
+/**
+ * An actor taking an active role in the event or activity that is
+ * logged.
+ */
+export interface AuditEventAgent {
+
+  /**
+   * 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[];
+
+  /**
+   * Specification of the participation type the user plays when performing
+   * the event.
+   */
+  readonly type?: CodeableConcept;
+
+  /**
+   * The security role that the user was acting under, that come from local
+   * codes defined by the access control security system (e.g. RBAC, ABAC)
+   * used in the local context.
+   */
+  readonly role?: CodeableConcept[];
+
+  /**
+   * Reference to who this agent is that was involved in the event.
+   */
+  readonly who?: Reference<PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson>;
+
+  /**
+   * Alternative agent Identifier. For a human, this should be a user
+   * identifier text string from authentication system. This identifier
+   * would be one known to a common authentication system (e.g. single
+   * sign-on), if available.
+   */
+  readonly altId?: string;
+
+  /**
+   * Human-meaningful name for the agent.
+   */
+  readonly name?: string;
+
+  /**
+   * Indicator that the user is or is not the requestor, or initiator, for
+   * the event being audited.
+   */
+  readonly requestor?: boolean;
+
+  /**
+   * Where the event occurred.
+   */
+  readonly location?: Reference<Location>;
+
+  /**
+   * The policy or plan that authorized the activity being recorded.
+   * Typically, a single activity may have multiple applicable policies,
+   * such as patient consent, guarantor funding, etc. The policy would also
+   * indicate the security token used.
+   */
+  readonly policy?: string[];
+
+  /**
+   * Type of media involved. Used when the event is about
+   * exporting/importing onto media.
+   */
+  readonly media?: Coding;
+
+  /**
+   * Logical network location for application activity, if the activity has
+   * a network location.
+   */
+  readonly network?: AuditEventAgentNetwork;
+
+  /**
+   * The reason (purpose of use), specific to this agent, that was used
+   * during the event being recorded.
+   */
+  readonly purposeOfUse?: CodeableConcept[];
+}
+
+/**
+ * Logical network location for application activity, if the activity has
+ * a network location.
+ */
+export interface AuditEventAgentNetwork {
+
+  /**
+   * 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[];
+
+  /**
+   * An identifier for the network access point of the user device for the
+   * audit event.
+   */
+  readonly address?: string;
+
+  /**
+   * An identifier for the type of network access point that originated the
+   * audit event.
+   */
+  readonly type?: string;
+}
+
+/**
+ * Specific instances of data or objects that have been accessed.
+ */
+export interface AuditEventEntity {
+
+  /**
+   * 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[];
+
+  /**
+   * Identifies a specific instance of the entity. The reference should be
+   * version specific.
+   */
+  readonly what?: Reference<Resource>;
+
+  /**
+   * The type of the object that was involved in this audit event.
+   */
+  readonly type?: Coding;
+
+  /**
+   * Code representing the role the entity played in the event being
+   * audited.
+   */
+  readonly role?: Coding;
+
+  /**
+   * Identifier for the data life-cycle stage for the entity.
+   */
+  readonly lifecycle?: Coding;
+
+  /**
+   * Security labels for the identified entity.
+   */
+  readonly securityLabel?: Coding[];
+
+  /**
+   * A name of the entity in the audit event.
+   */
+  readonly name?: string;
+
+  /**
+   * Text that describes the entity in more detail.
+   */
+  readonly description?: string;
+
+  /**
+   * The query parameters for a query-type entities.
+   */
+  readonly query?: string;
+
+  /**
+   * Tagged value pairs for conveying additional information about the
+   * entity.
+   */
+  readonly detail?: AuditEventEntityDetail[];
+}
+
+/**
+ * Tagged value pairs for conveying additional information about the
+ * entity.
+ */
+export interface AuditEventEntityDetail {
+
+  /**
+   * 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 extra detail provided in the value.
+   */
+  readonly type?: string;
+
+  /**
+   * The  value of the extra detail.
+   */
+  readonly valueString?: string;
+
+  /**
+   * The  value of the extra detail.
+   */
+  readonly valueBase64Binary?: string;
+}
+
+/**
+ * The system that is reporting the event.
+ */
+export interface AuditEventSource {
+
+  /**
+   * 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[];
+
+  /**
+   * Logical source location within the healthcare enterprise network.  For
+   * example, a hospital or other provider location within a multi-entity
+   * provider group.
+   */
+  readonly site?: string;
+
+  /**
+   * Identifier of the source where the event was detected.
+   */
+  readonly observer?: Reference<PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson>;
+
+  /**
+   * Code specifying the type of source where event originated.
+   */
+  readonly type?: Coding[];
+}

package/dist/Basic.d.ts

@@ -0,0 +1,130 @@
+/*
+ * 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 { Patient } from './Patient';
+import { Practitioner } from './Practitioner';
+import { PractitionerRole } from './PractitionerRole';
+import { Reference } from './Reference';
+import { RelatedPerson } from './RelatedPerson';
+import { Resource } from './Resource';
+
+/**
+ * Basic is used for handling concepts not yet defined in FHIR,
+ * narrative-only resources that don't map to an existing resource, and
+ * custom resources not appropriate for inclusion in the FHIR
+ * specification.
+ */
+export interface Basic {
+
+  /**
+   * This is a Basic resource
+   */
+  readonly resourceType: 'Basic';
+
+  /**
+   * 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[];
+
+  /**
+   * Identifier assigned to the resource for business purposes, outside the
+   * context of FHIR.
+   */
+  readonly identifier?: Identifier[];
+
+  /**
+   * Identifies the 'type' of resource - equivalent to the resource name
+   * for other resources.
+   */
+  readonly code?: CodeableConcept;
+
+  /**
+   * Identifies the patient, practitioner, device or any other resource
+   * that is the "focus" of this resource.
+   */
+  readonly subject?: Reference<Resource>;
+
+  /**
+   * Identifies when the resource was first created.
+   */
+  readonly created?: string;
+
+  /**
+   * Indicates who was responsible for creating the resource instance.
+   */
+  readonly author?: Reference<Practitioner | PractitionerRole | Patient | RelatedPerson | Organization>;
+}