@medplum/fhirtypes 0.3.0

package/dist/QuestionnaireResponse.d.ts

@@ -0,0 +1,365 @@
+/*
+ * Generated by @medplum/generator
+ * Do not edit manually.
+ */
+
+import { Attachment } from './Attachment';
+import { CarePlan } from './CarePlan';
+import { Coding } from './Coding';
+import { Device } from './Device';
+import { Encounter } from './Encounter';
+import { Extension } from './Extension';
+import { Identifier } from './Identifier';
+import { Meta } from './Meta';
+import { Narrative } from './Narrative';
+import { Observation } from './Observation';
+import { Organization } from './Organization';
+import { Patient } from './Patient';
+import { Practitioner } from './Practitioner';
+import { PractitionerRole } from './PractitionerRole';
+import { Procedure } from './Procedure';
+import { Quantity } from './Quantity';
+import { Reference } from './Reference';
+import { RelatedPerson } from './RelatedPerson';
+import { Resource } from './Resource';
+import { ServiceRequest } from './ServiceRequest';
+
+/**
+ * A structured set of questions and their answers. The questions are
+ * ordered and grouped into coherent subsets, corresponding to the
+ * structure of the grouping of the questionnaire being responded to.
+ */
+export interface QuestionnaireResponse {
+
+  /**
+   * This is a QuestionnaireResponse resource
+   */
+  readonly resourceType: 'QuestionnaireResponse';
+
+  /**
+   * 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 business identifier assigned to a particular completed (or partially
+   * completed) questionnaire.
+   */
+  readonly identifier?: Identifier;
+
+  /**
+   * The order, proposal or plan that is fulfilled in whole or in part by
+   * this QuestionnaireResponse.  For example, a ServiceRequest seeking an
+   * intake assessment or a decision support recommendation to assess for
+   * post-partum depression.
+   */
+  readonly basedOn?: Reference<CarePlan | ServiceRequest>[];
+
+  /**
+   * A procedure or observation that this questionnaire was performed as
+   * part of the execution of.  For example, the surgery a checklist was
+   * executed as part of.
+   */
+  readonly partOf?: Reference<Observation | Procedure>[];
+
+  /**
+   * The Questionnaire that defines and organizes the questions for which
+   * answers are being provided.
+   */
+  readonly questionnaire?: string;
+
+  /**
+   * The position of the questionnaire response within its overall
+   * lifecycle.
+   */
+  readonly status?: string;
+
+  /**
+   * The subject of the questionnaire response.  This could be a patient,
+   * organization, practitioner, device, etc.  This is who/what the answers
+   * apply to, but is not necessarily the source of information.
+   */
+  readonly subject?: Reference<Resource>;
+
+  /**
+   * The Encounter during which this questionnaire response was created or
+   * to which the creation of this record is tightly associated.
+   */
+  readonly encounter?: Reference<Encounter>;
+
+  /**
+   * The date and/or time that this set of answers were last changed.
+   */
+  readonly authored?: string;
+
+  /**
+   * Person who received the answers to the questions in the
+   * QuestionnaireResponse and recorded them in the system.
+   */
+  readonly author?: Reference<Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization>;
+
+  /**
+   * The person who answered the questions about the subject.
+   */
+  readonly source?: Reference<Patient | Practitioner | PractitionerRole | RelatedPerson>;
+
+  /**
+   * A group or question item from the original questionnaire for which
+   * answers are provided.
+   */
+  readonly item?: QuestionnaireResponseItem[];
+}
+
+/**
+ * A group or question item from the original questionnaire for which
+ * answers are provided.
+ */
+export interface QuestionnaireResponseItem {
+
+  /**
+   * 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 item from the Questionnaire that corresponds to this item in the
+   * QuestionnaireResponse resource.
+   */
+  readonly linkId?: string;
+
+  /**
+   * A reference to an [ElementDefinition](elementdefinition.html) that
+   * provides the details for the item.
+   */
+  readonly definition?: string;
+
+  /**
+   * Text that is displayed above the contents of the group or as the text
+   * of the question being answered.
+   */
+  readonly text?: string;
+
+  /**
+   * The respondent's answer(s) to the question.
+   */
+  readonly answer?: QuestionnaireResponseItemAnswer[];
+
+  /**
+   * Questions or sub-groups nested beneath a question or group.
+   */
+  readonly item?: QuestionnaireResponseItem[];
+}
+
+/**
+ * The respondent's answer(s) to the question.
+ */
+export interface QuestionnaireResponseItemAnswer {
+
+  /**
+   * 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 answer (or one of the answers) provided by the respondent to the
+   * question.
+   */
+  readonly valueBoolean?: boolean;
+
+  /**
+   * The answer (or one of the answers) provided by the respondent to the
+   * question.
+   */
+  readonly valueDecimal?: number;
+
+  /**
+   * The answer (or one of the answers) provided by the respondent to the
+   * question.
+   */
+  readonly valueInteger?: number;
+
+  /**
+   * The answer (or one of the answers) provided by the respondent to the
+   * question.
+   */
+  readonly valueDate?: string;
+
+  /**
+   * The answer (or one of the answers) provided by the respondent to the
+   * question.
+   */
+  readonly valueDateTime?: string;
+
+  /**
+   * The answer (or one of the answers) provided by the respondent to the
+   * question.
+   */
+  readonly valueTime?: string;
+
+  /**
+   * The answer (or one of the answers) provided by the respondent to the
+   * question.
+   */
+  readonly valueString?: string;
+
+  /**
+   * The answer (or one of the answers) provided by the respondent to the
+   * question.
+   */
+  readonly valueUri?: string;
+
+  /**
+   * The answer (or one of the answers) provided by the respondent to the
+   * question.
+   */
+  readonly valueAttachment?: Attachment;
+
+  /**
+   * The answer (or one of the answers) provided by the respondent to the
+   * question.
+   */
+  readonly valueCoding?: Coding;
+
+  /**
+   * The answer (or one of the answers) provided by the respondent to the
+   * question.
+   */
+  readonly valueQuantity?: Quantity;
+
+  /**
+   * The answer (or one of the answers) provided by the respondent to the
+   * question.
+   */
+  readonly valueReference?: Reference<Resource>;
+
+  /**
+   * Nested groups and/or questions found within this particular answer.
+   */
+  readonly item?: QuestionnaireResponseItem[];
+}

package/dist/Range.d.ts

@@ -0,0 +1,40 @@
+/*
+ * Generated by @medplum/generator
+ * Do not edit manually.
+ */
+
+import { Extension } from './Extension';
+import { Quantity } from './Quantity';
+
+/**
+ * Base StructureDefinition for Range Type: A set of ordered Quantities
+ * defined by a low and high limit.
+ */
+export interface Range {
+
+  /**
+   * 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 low limit. The boundary is inclusive.
+   */
+  readonly low?: Quantity;
+
+  /**
+   * The high limit. The boundary is inclusive.
+   */
+  readonly high?: Quantity;
+}

package/dist/Ratio.d.ts

@@ -0,0 +1,40 @@
+/*
+ * Generated by @medplum/generator
+ * Do not edit manually.
+ */
+
+import { Extension } from './Extension';
+import { Quantity } from './Quantity';
+
+/**
+ * Base StructureDefinition for Ratio Type: A relationship of two
+ * Quantity values - expressed as a numerator and a denominator.
+ */
+export interface Ratio {
+
+  /**
+   * 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 value of the numerator.
+   */
+  readonly numerator?: Quantity;
+
+  /**
+   * The value of the denominator.
+   */
+  readonly denominator?: Quantity;
+}

package/dist/Reference.d.ts

@@ -0,0 +1,80 @@
+/*
+ * Generated by @medplum/generator
+ * Do not edit manually.
+ */
+
+import { Extension } from './Extension';
+import { Identifier } from './Identifier';
+import { Resource } from './Resource';
+
+/**
+ * Base StructureDefinition for Reference Type: A reference from one
+ * resource to another.
+ */
+export interface Reference<T extends Resource = Resource> {
+
+  /**
+   * 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[];
+
+  /**
+   * A reference to a location at which the other resource is found. The
+   * reference may be a relative reference, in which case it is relative to
+   * the service base URL, or an absolute URL that resolves to the location
+   * where the resource is found. The reference may be version specific or
+   * not. If the reference is not to a FHIR RESTful server, then it should
+   * be assumed to be version specific. Internal fragment references (start
+   * with '#') refer to contained resources.
+   */
+  readonly reference?: string;
+
+  /**
+   * The expected type of the target of the reference. If both
+   * Reference.type and Reference.reference are populated and
+   * Reference.reference is a FHIR URL, both SHALL be consistent.
+   *
+   * The type is the Canonical URL of Resource Definition that is the type
+   * this reference refers to. References are URLs that are relative to
+   * http://hl7.org/fhir/StructureDefinition/ e.g. &quot;Patient&quot; is a reference
+   * to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are
+   * only allowed for logical models (and can only be used in references in
+   * logical models, not resources).
+   */
+  readonly type?: string;
+
+  /**
+   * An identifier for the target resource. This is used when there is no
+   * way to reference the other resource directly, either because the
+   * entity it represents is not available through a FHIR server, or
+   * because there is no way for the author of the resource to convert a
+   * known identifier to an actual location. There is no requirement that a
+   * Reference.identifier point to something that is actually exposed as a
+   * FHIR instance, but it SHALL point to a business concept that would be
+   * expected to be exposed as a FHIR instance, and that instance would
+   * need to be of a FHIR resource type allowed by the reference.
+   */
+  readonly identifier?: Identifier;
+
+  /**
+   * Plain text narrative that identifies the resource in addition to the
+   * resource reference.
+   */
+  readonly display?: string;
+
+  /**
+   * Optional Resource referred to by this reference.
+   */
+  readonly resource?: T;
+}

package/dist/RelatedArtifact.d.ts

@@ -0,0 +1,72 @@
+/*
+ * Generated by @medplum/generator
+ * Do not edit manually.
+ */
+
+import { Attachment } from './Attachment';
+import { Extension } from './Extension';
+
+/**
+ * Base StructureDefinition for RelatedArtifact Type: Related artifacts
+ * such as additional documentation, justification, or bibliographic
+ * references.
+ */
+export interface RelatedArtifact {
+
+  /**
+   * 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 type of relationship to the related artifact.
+   */
+  readonly type?: string;
+
+  /**
+   * A short label that can be used to reference the citation from
+   * elsewhere in the containing artifact, such as a footnote index.
+   */
+  readonly label?: string;
+
+  /**
+   * A brief description of the document or knowledge resource being
+   * referenced, suitable for display to a consumer.
+   */
+  readonly display?: string;
+
+  /**
+   * A bibliographic citation for the related artifact. This text SHOULD be
+   * formatted according to an accepted citation format.
+   */
+  readonly citation?: string;
+
+  /**
+   * A url for the artifact that can be followed to access the actual
+   * content.
+   */
+  readonly url?: string;
+
+  /**
+   * The document being referenced, represented as an attachment. This is
+   * exclusive with the resource element.
+   */
+  readonly document?: Attachment;
+
+  /**
+   * The related resource, such as a library, value set, profile, or other
+   * knowledge resource.
+   */
+  readonly resource?: string;
+}