@medplum/fhirtypes/dist/QuestionnaireResponse.d.ts

Medplum FHIR Type Definitions

/*
 * This is a generated file
 * 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.
   */
  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.
   */
  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.
   */
  implicitRules?: string;

  /**
   * The base language in which the resource is written.
   */
  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.
   */
  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.
   */
  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.
   */
  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).
   */
  modifierExtension?: Extension[];

  /**
   * A business identifier assigned to a particular completed (or partially
   * completed) questionnaire.
   */
  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.
   */
  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.
   */
  partOf?: Reference<Observation | Procedure>[];

  /**
   * The Questionnaire that defines and organizes the questions for which
   * answers are being provided.
   */
  questionnaire?: string;

  /**
   * The position of the questionnaire response within its overall
   * lifecycle.
   */
  status: 'in-progress' | 'completed' | 'amended' | 'entered-in-error' | 'stopped';

  /**
   * 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.
   */
  subject?: Reference<Resource>;

  /**
   * The Encounter during which this questionnaire response was created or
   * to which the creation of this record is tightly associated.
   */
  encounter?: Reference<Encounter>;

  /**
   * The date and/or time that this set of answers were last changed.
   */
  authored?: string;

  /**
   * Person who received the answers to the questions in the
   * QuestionnaireResponse and recorded them in the system.
   */
  author?: Reference<Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization>;

  /**
   * The person who answered the questions about the subject.
   */
  source?: Reference<Patient | Practitioner | PractitionerRole | RelatedPerson>;

  /**
   * A group or question item from the original questionnaire for which
   * answers are provided.
   */
  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.
   */
  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.
   */
  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).
   */
  modifierExtension?: Extension[];

  /**
   * The item from the Questionnaire that corresponds to this item in the
   * QuestionnaireResponse resource.
   */
  linkId: string;

  /**
   * A reference to an [ElementDefinition](elementdefinition.html) that
   * provides the details for the item.
   */
  definition?: string;

  /**
   * Text that is displayed above the contents of the group or as the text
   * of the question being answered.
   */
  text?: string;

  /**
   * The respondent's answer(s) to the question.
   */
  answer?: QuestionnaireResponseItemAnswer[];

  /**
   * Questions or sub-groups nested beneath a question or group.
   */
  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.
   */
  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.
   */
  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).
   */
  modifierExtension?: Extension[];

  /**
   * The answer (or one of the answers) provided by the respondent to the
   * question.
   */
  valueBoolean?: boolean;

  /**
   * The answer (or one of the answers) provided by the respondent to the
   * question.
   */
  valueDecimal?: number;

  /**
   * The answer (or one of the answers) provided by the respondent to the
   * question.
   */
  valueInteger?: number;

  /**
   * The answer (or one of the answers) provided by the respondent to the
   * question.
   */
  valueDate?: string;

  /**
   * The answer (or one of the answers) provided by the respondent to the
   * question.
   */
  valueDateTime?: string;

  /**
   * The answer (or one of the answers) provided by the respondent to the
   * question.
   */
  valueTime?: string;

  /**
   * The answer (or one of the answers) provided by the respondent to the
   * question.
   */
  valueString?: string;

  /**
   * The answer (or one of the answers) provided by the respondent to the
   * question.
   */
  valueUri?: string;

  /**
   * The answer (or one of the answers) provided by the respondent to the
   * question.
   */
  valueAttachment?: Attachment;

  /**
   * The answer (or one of the answers) provided by the respondent to the
   * question.
   */
  valueCoding?: Coding;

  /**
   * The answer (or one of the answers) provided by the respondent to the
   * question.
   */
  valueQuantity?: Quantity;

  /**
   * The answer (or one of the answers) provided by the respondent to the
   * question.
   */
  valueReference?: Reference<Resource>;

  /**
   * Nested groups and/or questions found within this particular answer.
   */
  item?: QuestionnaireResponseItem[];
}

/**
 * The answer (or one of the answers) provided by the respondent to the
 * question.
 */
export type QuestionnaireResponseItemAnswerValue = Attachment | boolean | Coding | number | Quantity | Reference<Resource> | string;