@medplum/fhirtypes 0.5.2 → 0.9.2

package/README.md

@@ -4,6 +4,8 @@ This library contains [TypeScript](https://www.typescriptlang.org/) type definit
 
 ## Installation
 
+Add as a dependency:
+
 ```bash
 npm install --save-dev @medplum/fhirtypes
 ```
@@ -12,7 +14,7 @@ npm install --save-dev @medplum/fhirtypes
 
 Consider the following untyped code:
 
-```typescript
+```ts
 const myPatient = {
   resourceType: 'Patient',
   name: 'George Washington',
@@ -23,7 +25,7 @@ Keen observers will note that `Patient.name` should not be a string. Instead, it
 
 Let's add the type definition and see what happens:
 
-```typescript
+```ts
 import { Patient } from '@medplum/fhirtypes';
 
 const myPatient: Patient = {
@@ -42,7 +44,7 @@ And now you will receive typeahead support:
 
 So we can build a well-formed example:
 
-```typescript
+```ts
 import { Patient } from '@medplum/fhirtypes';
 
 const myPatient: Patient = {
@@ -56,6 +58,10 @@ const myPatient: Patient = {
 };
 ```
 
+## About Medplum
+
+Medplum is a healthcare platform that helps you quickly develop high-quality compliant applications. Medplum includes a FHIR server, React component library, and developer app.
+
 ## License
 
 Apache 2.0. Copyright © Medplum 2022

package/dist/AccessPolicy.d.ts

@@ -21,14 +21,14 @@ export interface AccessPolicy {
    * The logical id of the resource, as used in the URL for the resource.
    * Once assigned, this value never changes.
    */
-  readonly id?: string;
+  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;
+  meta?: Meta;
 
   /**
    * A reference to a set of rules that were followed when the resource was
@@ -36,29 +36,29 @@ export interface AccessPolicy {
    * Often, this is a reference to an implementation guide that defines the
    * special rules along with other profiles etc.
    */
-  readonly implicitRules?: string;
+  implicitRules?: string;
 
   /**
    * The base language in which the resource is written.
    */
-  readonly language?: string;
+  language?: string;
 
   /**
    * A name associated with the AccessPolicy.
    */
-  readonly name?: string;
+  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;
+  compartment?: Reference;
 
   /**
    * Access details for a resource type.
    */
-  readonly resource?: AccessPolicyResource[];
+  resource?: AccessPolicyResource[];
 }
 
 /**
@@ -69,27 +69,33 @@ export interface AccessPolicyResource {
   /**
    * The resource type.
    */
-  readonly resourceType?: string;
+  resourceType?: string;
 
   /**
-   * Optional compartment restriction for the resource type.
+   * DEPRECATED Optional compartment restriction for the resource type.
    */
-  readonly compartment?: Reference;
+  compartment?: Reference;
+
+  /**
+   * The rules that the server should use to determine which resources to
+   * allow.
+   */
+  criteria?: string;
 
   /**
    * Optional flag to indicate that the resource type is read-only.
    */
-  readonly readonly?: boolean;
+  readonly?: boolean;
 
   /**
    * Optional list of hidden fields.  Hidden fields are not readable or
    * writeable.
    */
-  readonly hiddenFields?: string[];
+  hiddenFields?: string[];
 
   /**
    * Optional list of read-only fields.  Read-only fields are readable but
    * not writeable.
    */
-  readonly readonlyFields?: string[];
+  readonlyFields?: string[];
 }

package/dist/Account.d.ts

@@ -37,14 +37,14 @@ export interface Account {
    * The logical id of the resource, as used in the URL for the resource.
    * Once assigned, this value never changes.
    */
-  readonly id?: string;
+  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;
+  meta?: Meta;
 
   /**
    * A reference to a set of rules that were followed when the resource was
@@ -52,12 +52,12 @@ export interface Account {
    * Often, this is a reference to an implementation guide that defines the
    * special rules along with other profiles etc.
    */
-  readonly implicitRules?: string;
+  implicitRules?: string;
 
   /**
    * The base language in which the resource is written.
    */
-  readonly language?: string;
+  language?: string;
 
   /**
    * A human-readable narrative that contains a summary of the resource and
@@ -67,14 +67,14 @@ export interface Account {
    * just read the narrative. Resource definitions may define what content
    * should be represented in the narrative to ensure clinical safety.
    */
-  readonly text?: Narrative;
+  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[];
+  contained?: Resource[];
 
   /**
    * May be used to represent additional information that is not part of
@@ -84,7 +84,7 @@ export interface Account {
    * define an extension, there is a set of requirements that SHALL be met
    * as part of the definition of the extension.
    */
-  readonly extension?: Extension[];
+  extension?: Extension[];
 
   /**
    * May be used to represent additional information that is not part of
@@ -102,29 +102,29 @@ export interface Account {
    * Resource or DomainResource (including cannot change the meaning of
    * modifierExtension itself).
    */
-  readonly modifierExtension?: Extension[];
+  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[];
+  identifier?: Identifier[];
 
   /**
    * Indicates whether the account is presently used/usable or not.
    */
-  readonly status?: string;
+  status?: string;
 
   /**
    * Categorizes the account for reporting and searching purposes.
    */
-  readonly type?: CodeableConcept;
+  type?: CodeableConcept;
 
   /**
    * Name used for the account when displaying it to humans in reports,
    * etc.
    */
-  readonly name?: string;
+  name?: string;
 
   /**
    * Identifies the entity which incurs the expenses. While the immediate
@@ -132,41 +132,41 @@ export interface Account {
    * subject, the expenses were ultimately incurred by the subject of the
    * Account.
    */
-  readonly subject?: Reference<Patient | Device | Practitioner | PractitionerRole | Location | HealthcareService | Organization>[];
+  subject?: Reference<Patient | Device | Practitioner | PractitionerRole | Location | HealthcareService | Organization>[];
 
   /**
    * The date range of services associated with this account.
    */
-  readonly servicePeriod?: Period;
+  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[];
+  coverage?: AccountCoverage[];
 
   /**
    * Indicates the service area, hospital, department, etc. with
    * responsibility for managing the Account.
    */
-  readonly owner?: Reference<Organization>;
+  owner?: Reference<Organization>;
 
   /**
    * Provides additional information about what the account tracks and how
    * it is used.
    */
-  readonly description?: string;
+  description?: string;
 
   /**
    * The parties responsible for balancing the account if other payment
    * options fall short.
    */
-  readonly guarantor?: AccountGuarantor[];
+  guarantor?: AccountGuarantor[];
 
   /**
    * Reference to a parent Account.
    */
-  readonly partOf?: Reference<Account>;
+  partOf?: Reference<Account>;
 }
 
 /**
@@ -179,7 +179,7 @@ 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;
+  id?: string;
 
   /**
    * May be used to represent additional information that is not part of
@@ -189,7 +189,7 @@ export interface AccountCoverage {
    * define an extension, there is a set of requirements that SHALL be met
    * as part of the definition of the extension.
    */
-  readonly extension?: Extension[];
+  extension?: Extension[];
 
   /**
    * May be used to represent additional information that is not part of
@@ -208,7 +208,7 @@ export interface AccountCoverage {
    * Resource or DomainResource (including cannot change the meaning of
    * modifierExtension itself).
    */
-  readonly modifierExtension?: Extension[];
+  modifierExtension?: Extension[];
 
   /**
    * The party(s) that contribute to payment (or part of) of the charges
@@ -218,12 +218,12 @@ export interface AccountCoverage {
    * the sequence of the coverages in the account could be important when
    * processing billing.
    */
-  readonly coverage?: Reference<Coverage>;
+  coverage?: Reference<Coverage>;
 
   /**
    * The priority of the coverage in the context of this account.
    */
-  readonly priority?: number;
+  priority?: number;
 }
 
 /**
@@ -236,7 +236,7 @@ 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;
+  id?: string;
 
   /**
    * May be used to represent additional information that is not part of
@@ -246,7 +246,7 @@ export interface AccountGuarantor {
    * define an extension, there is a set of requirements that SHALL be met
    * as part of the definition of the extension.
    */
-  readonly extension?: Extension[];
+  extension?: Extension[];
 
   /**
    * May be used to represent additional information that is not part of
@@ -265,22 +265,22 @@ export interface AccountGuarantor {
    * Resource or DomainResource (including cannot change the meaning of
    * modifierExtension itself).
    */
-  readonly modifierExtension?: Extension[];
+  modifierExtension?: Extension[];
 
   /**
    * The entity who is responsible.
    */
-  readonly party?: Reference<Patient | RelatedPerson | Organization>;
+  party?: Reference<Patient | RelatedPerson | Organization>;
 
   /**
    * A guarantor may be placed on credit hold or otherwise have their role
    * temporarily suspended.
    */
-  readonly onHold?: boolean;
+  onHold?: boolean;
 
   /**
    * The timeframe during which the guarantor accepts responsibility for
    * the account.
    */
-  readonly period?: Period;
+  period?: Period;
 }