@medplum/fhirtypes 0.3.0

package/dist/PaymentReconciliation.d.ts

@@ -0,0 +1,330 @@
+/*
+ * 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 { Money } from './Money';
+import { Narrative } from './Narrative';
+import { Organization } from './Organization';
+import { Period } from './Period';
+import { Practitioner } from './Practitioner';
+import { PractitionerRole } from './PractitionerRole';
+import { Reference } from './Reference';
+import { Resource } from './Resource';
+import { Task } from './Task';
+
+/**
+ * This resource provides the details including amount of a payment and
+ * allocates the payment items being paid.
+ */
+export interface PaymentReconciliation {
+
+  /**
+   * This is a PaymentReconciliation resource
+   */
+  readonly resourceType: 'PaymentReconciliation';
+
+  /**
+   * 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[];
+
+  /**
+   * A unique identifier assigned to this payment reconciliation.
+   */
+  readonly identifier?: Identifier[];
+
+  /**
+   * The status of the resource instance.
+   */
+  readonly status?: string;
+
+  /**
+   * The period of time for which payments have been gathered into this
+   * bulk payment for settlement.
+   */
+  readonly period?: Period;
+
+  /**
+   * The date when the resource was created.
+   */
+  readonly created?: string;
+
+  /**
+   * The party who generated the payment.
+   */
+  readonly paymentIssuer?: Reference<Organization>;
+
+  /**
+   * Original request resource reference.
+   */
+  readonly request?: Reference<Task>;
+
+  /**
+   * The practitioner who is responsible for the services rendered to the
+   * patient.
+   */
+  readonly requestor?: Reference<Practitioner | PractitionerRole | Organization>;
+
+  /**
+   * The outcome of a request for a reconciliation.
+   */
+  readonly outcome?: string;
+
+  /**
+   * A human readable description of the status of the request for the
+   * reconciliation.
+   */
+  readonly disposition?: string;
+
+  /**
+   * The date of payment as indicated on the financial instrument.
+   */
+  readonly paymentDate?: string;
+
+  /**
+   * Total payment amount as indicated on the financial instrument.
+   */
+  readonly paymentAmount?: Money;
+
+  /**
+   * Issuer's unique identifier for the payment instrument.
+   */
+  readonly paymentIdentifier?: Identifier;
+
+  /**
+   * Distribution of the payment amount for a previously acknowledged
+   * payable.
+   */
+  readonly detail?: PaymentReconciliationDetail[];
+
+  /**
+   * A code for the form to be used for printing the content.
+   */
+  readonly formCode?: CodeableConcept;
+
+  /**
+   * A note that describes or explains the processing in a human readable
+   * form.
+   */
+  readonly processNote?: PaymentReconciliationProcessNote[];
+}
+
+/**
+ * Distribution of the payment amount for a previously acknowledged
+ * payable.
+ */
+export interface PaymentReconciliationDetail {
+
+  /**
+   * 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[];
+
+  /**
+   * Unique identifier for the current payment item for the referenced
+   * payable.
+   */
+  readonly identifier?: Identifier;
+
+  /**
+   * Unique identifier for the prior payment item for the referenced
+   * payable.
+   */
+  readonly predecessor?: Identifier;
+
+  /**
+   * Code to indicate the nature of the payment.
+   */
+  readonly type?: CodeableConcept;
+
+  /**
+   * A resource, such as a Claim, the evaluation of which could lead to
+   * payment.
+   */
+  readonly request?: Reference<Resource>;
+
+  /**
+   * The party which submitted the claim or financial transaction.
+   */
+  readonly submitter?: Reference<Practitioner | PractitionerRole | Organization>;
+
+  /**
+   * A resource, such as a ClaimResponse, which contains a commitment to
+   * payment.
+   */
+  readonly response?: Reference<Resource>;
+
+  /**
+   * The date from the response resource containing a commitment to pay.
+   */
+  readonly date?: string;
+
+  /**
+   * A reference to the individual who is responsible for inquiries
+   * regarding the response and its payment.
+   */
+  readonly responsible?: Reference<PractitionerRole>;
+
+  /**
+   * The party which is receiving the payment.
+   */
+  readonly payee?: Reference<Practitioner | PractitionerRole | Organization>;
+
+  /**
+   * The monetary amount allocated from the total payment to the payable.
+   */
+  readonly amount?: Money;
+}
+
+/**
+ * A note that describes or explains the processing in a human readable
+ * form.
+ */
+export interface PaymentReconciliationProcessNote {
+
+  /**
+   * 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 business purpose of the note text.
+   */
+  readonly type?: string;
+
+  /**
+   * The explanation or description associated with the processing.
+   */
+  readonly text?: string;
+}

package/dist/Period.d.ts

@@ -0,0 +1,42 @@
+/*
+ * Generated by @medplum/generator
+ * Do not edit manually.
+ */
+
+import { Extension } from './Extension';
+
+/**
+ * Base StructureDefinition for Period Type: A time period defined by a
+ * start and end date and optionally time.
+ */
+export interface Period {
+
+  /**
+   * 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 start of the period. The boundary is inclusive.
+   */
+  readonly start?: string;
+
+  /**
+   * The end of the period. If the end of the period is missing, it means
+   * no end was known or planned at the time the instance was created. The
+   * start may be in the past, and the end date in the future, which means
+   * that period is expected/planned to end at that time.
+   */
+  readonly end?: string;
+}

package/dist/Person.d.ts

@@ -0,0 +1,206 @@
+/*
+ * Generated by @medplum/generator
+ * Do not edit manually.
+ */
+
+import { Address } from './Address';
+import { Attachment } from './Attachment';
+import { ContactPoint } from './ContactPoint';
+import { Extension } from './Extension';
+import { HumanName } from './HumanName';
+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 { Reference } from './Reference';
+import { RelatedPerson } from './RelatedPerson';
+import { Resource } from './Resource';
+
+/**
+ * Demographics and administrative information about a person independent
+ * of a specific health-related context.
+ */
+export interface Person {
+
+  /**
+   * This is a Person resource
+   */
+  readonly resourceType: 'Person';
+
+  /**
+   * 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 person within a particular scope.
+   */
+  readonly identifier?: Identifier[];
+
+  /**
+   * A name associated with the person.
+   */
+  readonly name?: HumanName[];
+
+  /**
+   * A contact detail for the person, e.g. a telephone number or an email
+   * address.
+   */
+  readonly telecom?: ContactPoint[];
+
+  /**
+   * Administrative Gender.
+   */
+  readonly gender?: string;
+
+  /**
+   * The birth date for the person.
+   */
+  readonly birthDate?: string;
+
+  /**
+   * One or more addresses for the person.
+   */
+  readonly address?: Address[];
+
+  /**
+   * An image that can be displayed as a thumbnail of the person to enhance
+   * the identification of the individual.
+   */
+  readonly photo?: Attachment;
+
+  /**
+   * The organization that is the custodian of the person record.
+   */
+  readonly managingOrganization?: Reference<Organization>;
+
+  /**
+   * Whether this person's record is in active use.
+   */
+  readonly active?: boolean;
+
+  /**
+   * Link to a resource that concerns the same actual person.
+   */
+  readonly link?: PersonLink[];
+}
+
+/**
+ * Link to a resource that concerns the same actual person.
+ */
+export interface PersonLink {
+
+  /**
+   * 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 resource to which this actual person is associated.
+   */
+  readonly target?: Reference<Patient | Practitioner | RelatedPerson | Person>;
+
+  /**
+   * Level of assurance that this link is associated with the target
+   * resource.
+   */
+  readonly assurance?: string;
+}