@medplum/fhirtypes 0.3.0

package/README.md

@@ -0,0 +1,61 @@
+# Medplum FHIR Type Definitions
+
+This library contains [TypeScript](https://www.typescriptlang.org/) type definitions for all [R4 types](https://www.hl7.org/fhir/valueset-resource-types.html).
+
+## Installation
+
+```bash
+npm install --save-dev @medplum/fhirtypes
+```
+
+## Basic Usage
+
+Consider the following untyped code:
+
+```typescript
+const myPatient = {
+  resourceType: 'Patient',
+  name: 'George Washington',
+};
+```
+
+Keen observers will note that `Patient.name` should not be a string. Instead, it should be an array of `HumanName` objects.
+
+Let's add the type definition and see what happens:
+
+```typescript
+import { Patient } from '@medplum/fhirtypes';
+
+const myPatient: Patient = {
+  resourceType: 'Patient',
+  name: 'George Wasington',
+};
+```
+
+Now "name" is a compile error. Developer tools with TypeScript support should provide feedback. For example, VS Code adds red squigglies and a helpful error message:
+
+![Medplum fhirtypes screenshot](https://user-images.githubusercontent.com/749094/146444130-ac3a2c5d-3a9a-429d-8db3-5581986c05dc.png)
+
+And now you will receive typeahead support:
+
+![Medplum fhirtypes typeahead](https://user-images.githubusercontent.com/749094/146444465-974f6a3e-f655-4212-893b-fad14b1c4386.png)
+
+So we can build a well-formed example:
+
+```typescript
+import { Patient } from '@medplum/fhirtypes';
+
+const myPatient: Patient = {
+  resourceType: 'Patient',
+  name: [
+    {
+      given: ['George'],
+      family: 'Washington',
+    },
+  ],
+};
+```
+
+## License
+
+Apache 2.0. Copyright © Medplum 2021

package/dist/AccessPolicy.d.ts

@@ -0,0 +1,95 @@
+/*
+ * Generated by @medplum/generator
+ * Do not edit manually.
+ */
+
+import { Meta } from './Meta';
+import { Reference } from './Reference';
+
+/**
+ * Access Policy for user or user group that defines how entities can or
+ * cannot access resources.
+ */
+export interface AccessPolicy {
+
+  /**
+   * This is a AccessPolicy resource
+   */
+  readonly resourceType: 'AccessPolicy';
+
+  /**
+   * 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 name associated with the AccessPolicy.
+   */
+  readonly name?: string;
+
+  /**
+   * Optional compartment for newly created resources.  If this field is
+   * set, any resources created by a user with this access policy will
+   * automatically be included in the specified compartment.
+   */
+  readonly compartment?: Reference;
+
+  /**
+   * Access details for a resource type.
+   */
+  readonly resource?: AccessPolicyResource[];
+}
+
+/**
+ * Access details for a resource type.
+ */
+export interface AccessPolicyResource {
+
+  /**
+   * The resource type.
+   */
+  readonly resourceType?: string;
+
+  /**
+   * Optional compartment restriction for the resource type.
+   */
+  readonly compartment?: Reference;
+
+  /**
+   * Optional flag to indicate that the resource type is read-only.
+   */
+  readonly readonly?: boolean;
+
+  /**
+   * Optional list of hidden fields.  Hidden fields are not readable or
+   * writeable.
+   */
+  readonly hiddenFields?: string[];
+
+  /**
+   * Optional list of read-only fields.  Read-only fields are readable but
+   * not writeable.
+   */
+  readonly readonlyFields?: string[];
+}

package/dist/Account.d.ts

@@ -0,0 +1,286 @@
+/*
+ * Generated by @medplum/generator
+ * Do not edit manually.
+ */
+
+import { CodeableConcept } from './CodeableConcept';
+import { Coverage } from './Coverage';
+import { Device } from './Device';
+import { Extension } from './Extension';
+import { HealthcareService } from './HealthcareService';
+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';
+
+/**
+ * A financial tool for tracking value accrued for a particular purpose.
+ * In the healthcare field, used to track charges for a patient, cost
+ * centers, etc.
+ */
+export interface Account {
+
+  /**
+   * This is a Account resource
+   */
+  readonly resourceType: 'Account';
+
+  /**
+   * 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[];
+
+  /**
+   * Unique identifier used to reference the account.  Might or might not
+   * be intended for human use (e.g. credit card number).
+   */
+  readonly identifier?: Identifier[];
+
+  /**
+   * Indicates whether the account is presently used/usable or not.
+   */
+  readonly status?: string;
+
+  /**
+   * Categorizes the account for reporting and searching purposes.
+   */
+  readonly type?: CodeableConcept;
+
+  /**
+   * Name used for the account when displaying it to humans in reports,
+   * etc.
+   */
+  readonly name?: string;
+
+  /**
+   * Identifies the entity which incurs the expenses. While the immediate
+   * recipients of services or goods might be entities related to the
+   * subject, the expenses were ultimately incurred by the subject of the
+   * Account.
+   */
+  readonly subject?: Reference<Patient | Device | Practitioner | PractitionerRole | Location | HealthcareService | Organization>[];
+
+  /**
+   * The date range of services associated with this account.
+   */
+  readonly servicePeriod?: Period;
+
+  /**
+   * The party(s) that are responsible for covering the payment of this
+   * account, and what order should they be applied to the account.
+   */
+  readonly coverage?: AccountCoverage[];
+
+  /**
+   * Indicates the service area, hospital, department, etc. with
+   * responsibility for managing the Account.
+   */
+  readonly owner?: Reference<Organization>;
+
+  /**
+   * Provides additional information about what the account tracks and how
+   * it is used.
+   */
+  readonly description?: string;
+
+  /**
+   * The parties responsible for balancing the account if other payment
+   * options fall short.
+   */
+  readonly guarantor?: AccountGuarantor[];
+
+  /**
+   * Reference to a parent Account.
+   */
+  readonly partOf?: Reference<Account>;
+}
+
+/**
+ * The party(s) that are responsible for covering the payment of this
+ * account, and what order should they be applied to the account.
+ */
+export interface AccountCoverage {
+
+  /**
+   * 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 party(s) that contribute to payment (or part of) of the charges
+   * applied to this account (including self-pay).
+   *
+   * A coverage may only be responsible for specific types of charges, and
+   * the sequence of the coverages in the account could be important when
+   * processing billing.
+   */
+  readonly coverage?: Reference<Coverage>;
+
+  /**
+   * The priority of the coverage in the context of this account.
+   */
+  readonly priority?: number;
+}
+
+/**
+ * The parties responsible for balancing the account if other payment
+ * options fall short.
+ */
+export interface AccountGuarantor {
+
+  /**
+   * 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 entity who is responsible.
+   */
+  readonly party?: Reference<Patient | RelatedPerson | Organization>;
+
+  /**
+   * A guarantor may be placed on credit hold or otherwise have their role
+   * temporarily suspended.
+   */
+  readonly onHold?: boolean;
+
+  /**
+   * The timeframe during which the guarantor accepts responsibility for
+   * the account.
+   */
+  readonly period?: Period;
+}