@medplum/fhirtypes 0.3.0

package/dist/Schedule.d.ts

@@ -0,0 +1,152 @@
+/*
+ * Generated by @medplum/generator
+ * Do not edit manually.
+ */
+
+import { CodeableConcept } from './CodeableConcept';
+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 { 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 container for slots of time that may be available for booking
+ * appointments.
+ */
+export interface Schedule {
+
+  /**
+   * This is a Schedule resource
+   */
+  readonly resourceType: 'Schedule';
+
+  /**
+   * 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[];
+
+  /**
+   * External Ids for this item.
+   */
+  readonly identifier?: Identifier[];
+
+  /**
+   * Whether this schedule record is in active use or should not be used
+   * (such as was entered in error).
+   */
+  readonly active?: boolean;
+
+  /**
+   * A broad categorization of the service that is to be performed during
+   * this appointment.
+   */
+  readonly serviceCategory?: CodeableConcept[];
+
+  /**
+   * The specific service that is to be performed during this appointment.
+   */
+  readonly serviceType?: CodeableConcept[];
+
+  /**
+   * The specialty of a practitioner that would be required to perform the
+   * service requested in this appointment.
+   */
+  readonly specialty?: CodeableConcept[];
+
+  /**
+   * Slots that reference this schedule resource provide the availability
+   * details to these referenced resource(s).
+   */
+  readonly actor?: Reference<Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location>[];
+
+  /**
+   * The period of time that the slots that reference this Schedule
+   * resource cover (even if none exist). These  cover the amount of time
+   * that an organization's planning horizon; the interval for which they
+   * are currently accepting appointments. This does not define a
+   * &quot;template&quot; for planning outside these dates.
+   */
+  readonly planningHorizon?: Period;
+
+  /**
+   * Comments on the availability to describe any extended information.
+   * Such as custom constraints on the slots that may be associated.
+   */
+  readonly comment?: string;
+}

package/dist/SearchParameter.d.ts

@@ -0,0 +1,324 @@
+/*
+ * Generated by @medplum/generator
+ * Do not edit manually.
+ */
+
+import { CodeableConcept } from './CodeableConcept';
+import { ContactDetail } from './ContactDetail';
+import { Extension } from './Extension';
+import { Meta } from './Meta';
+import { Narrative } from './Narrative';
+import { Resource } from './Resource';
+import { UsageContext } from './UsageContext';
+
+/**
+ * A search parameter that defines a named search item that can be used
+ * to search/filter on a resource.
+ */
+export interface SearchParameter {
+
+  /**
+   * This is a SearchParameter resource
+   */
+  readonly resourceType: 'SearchParameter';
+
+  /**
+   * 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[];
+
+  /**
+   * An absolute URI that is used to identify this search parameter when it
+   * is referenced in a specification, model, design or an instance; also
+   * called its canonical identifier. This SHOULD be globally unique and
+   * SHOULD be a literal address at which at which an authoritative
+   * instance of this search parameter is (or will be) published. This URL
+   * can be the target of a canonical reference. It SHALL remain the same
+   * when the search parameter is stored on different servers.
+   */
+  readonly url?: string;
+
+  /**
+   * The identifier that is used to identify this version of the search
+   * parameter when it is referenced in a specification, model, design or
+   * instance. This is an arbitrary value managed by the search parameter
+   * author and is not expected to be globally unique. For example, it
+   * might be a timestamp (e.g. yyyymmdd) if a managed version is not
+   * available. There is also no expectation that versions can be placed in
+   * a lexicographical sequence.
+   */
+  readonly version?: string;
+
+  /**
+   * A natural language name identifying the search parameter. This name
+   * should be usable as an identifier for the module by machine processing
+   * applications such as code generation.
+   */
+  readonly name?: string;
+
+  /**
+   * Where this search parameter is originally defined. If a derivedFrom is
+   * provided, then the details in the search parameter must be consistent
+   * with the definition from which it is defined. i.e. the parameter
+   * should have the same meaning, and (usually) the functionality should
+   * be a proper subset of the underlying search parameter.
+   */
+  readonly derivedFrom?: string;
+
+  /**
+   * The status of this search parameter. Enables tracking the life-cycle
+   * of the content.
+   */
+  readonly status?: string;
+
+  /**
+   * A Boolean value to indicate that this search parameter is authored for
+   * testing purposes (or education/evaluation/marketing) and is not
+   * intended to be used for genuine usage.
+   */
+  readonly experimental?: boolean;
+
+  /**
+   * The date  (and optionally time) when the search parameter was
+   * published. The date must change when the business version changes and
+   * it must change if the status code changes. In addition, it should
+   * change when the substantive content of the search parameter changes.
+   */
+  readonly date?: string;
+
+  /**
+   * The name of the organization or individual that published the search
+   * parameter.
+   */
+  readonly publisher?: string;
+
+  /**
+   * Contact details to assist a user in finding and communicating with the
+   * publisher.
+   */
+  readonly contact?: ContactDetail[];
+
+  /**
+   * And how it used.
+   */
+  readonly description?: string;
+
+  /**
+   * The content was developed with a focus and intent of supporting the
+   * contexts that are listed. These contexts may be general categories
+   * (gender, age, ...) or may be references to specific programs
+   * (insurance plans, studies, ...) and may be used to assist with
+   * indexing and searching for appropriate search parameter instances.
+   */
+  readonly useContext?: UsageContext[];
+
+  /**
+   * A legal or geographic region in which the search parameter is intended
+   * to be used.
+   */
+  readonly jurisdiction?: CodeableConcept[];
+
+  /**
+   * Explanation of why this search parameter is needed and why it has been
+   * designed as it has.
+   */
+  readonly purpose?: string;
+
+  /**
+   * The code used in the URL or the parameter name in a parameters
+   * resource for this search parameter.
+   */
+  readonly code?: string;
+
+  /**
+   * The base resource type(s) that this search parameter can be used
+   * against.
+   */
+  readonly base?: string[];
+
+  /**
+   * The type of value that a search parameter may contain, and how the
+   * content is interpreted.
+   */
+  readonly type?: string;
+
+  /**
+   * A FHIRPath expression that returns a set of elements for the search
+   * parameter.
+   */
+  readonly expression?: string;
+
+  /**
+   * An XPath expression that returns a set of elements for the search
+   * parameter.
+   */
+  readonly xpath?: string;
+
+  /**
+   * How the search parameter relates to the set of elements returned by
+   * evaluating the xpath query.
+   */
+  readonly xpathUsage?: string;
+
+  /**
+   * Types of resource (if a resource is referenced).
+   */
+  readonly target?: string[];
+
+  /**
+   * Whether multiple values are allowed for each time the parameter
+   * exists. Values are separated by commas, and the parameter matches if
+   * any of the values match.
+   */
+  readonly multipleOr?: boolean;
+
+  /**
+   * Whether multiple parameters are allowed - e.g. more than one parameter
+   * with the same name. The search matches if all the parameters match.
+   */
+  readonly multipleAnd?: boolean;
+
+  /**
+   * Comparators supported for the search parameter.
+   */
+  readonly comparator?: string[];
+
+  /**
+   * A modifier supported for the search parameter.
+   */
+  readonly modifier?: string[];
+
+  /**
+   * Contains the names of any search parameters which may be chained to
+   * the containing search parameter. Chained parameters may be added to
+   * search parameters of type reference and specify that resources will
+   * only be returned if they contain a reference to a resource which
+   * matches the chained parameter value. Values for this field should be
+   * drawn from SearchParameter.code for a parameter on the target resource
+   * type.
+   */
+  readonly chain?: string[];
+
+  /**
+   * Used to define the parts of a composite search parameter.
+   */
+  readonly component?: SearchParameterComponent[];
+}
+
+/**
+ * Used to define the parts of a composite search parameter.
+ */
+export interface SearchParameterComponent {
+
+  /**
+   * 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 definition of the search parameter that describes this part.
+   */
+  readonly definition?: string;
+
+  /**
+   * A sub-expression that defines how to extract values for this component
+   * from the output of the main SearchParameter.expression.
+   */
+  readonly expression?: string;
+}