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

Medplum FHIR Type Definitions

/*
 * This is a generated file
 * Do not edit manually.
 */

import { CodeableConcept } from './CodeableConcept';
import { Device } from './Device';
import { Extension } from './Extension';
import { Location } from './Location';
import { Meta } from './Meta';
import { Narrative } from './Narrative';
import { Organization } from './Organization';
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';
import { Signature } from './Signature';

/**
 * Provenance of a resource is a record that describes entities and
 * processes involved in producing and delivering or otherwise
 * influencing that resource. Provenance provides a critical foundation
 * for assessing authenticity, enabling trust, and allowing
 * reproducibility. Provenance assertions are a form of contextual
 * metadata and can themselves become important records with their own
 * provenance. Provenance statement indicates clinical significance in
 * terms of confidence in authenticity, reliability, and trustworthiness,
 * integrity, and stage in lifecycle (e.g. Document Completion - has the
 * artifact been legally authenticated), all of which may impact
 * security, privacy, and trust policies.
 */
export interface Provenance {

  /**
   * This is a Provenance resource
   */
  readonly resourceType: 'Provenance';

  /**
   * 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[];

  /**
   * The Reference(s) that were generated or updated by  the activity
   * described in this resource. A provenance can point to more than one
   * target if multiple resources were created/updated by the same
   * activity.
   */
  target: Reference<Resource>[];

  /**
   * The period during which the activity occurred.
   */
  occurredPeriod?: Period;

  /**
   * The period during which the activity occurred.
   */
  occurredDateTime?: string;

  /**
   * The instant of time at which the activity was recorded.
   */
  recorded: string;

  /**
   * Policy or plan the activity was defined by. Typically, a single
   * activity may have multiple applicable policy documents, such as
   * patient consent, guarantor funding, etc.
   */
  policy?: string[];

  /**
   * Where the activity occurred, if relevant.
   */
  location?: Reference<Location>;

  /**
   * The reason that the activity was taking place.
   */
  reason?: CodeableConcept[];

  /**
   * An activity is something that occurs over a period of time and acts
   * upon or with entities; it may include consuming, processing,
   * transforming, modifying, relocating, using, or generating entities.
   */
  activity?: CodeableConcept;

  /**
   * An actor taking a role in an activity  for which it can be assigned
   * some degree of responsibility for the activity taking place.
   */
  agent: ProvenanceAgent[];

  /**
   * An entity used in this activity.
   */
  entity?: ProvenanceEntity[];

  /**
   * A digital signature on the target Reference(s). The signer should
   * match a Provenance.agent. The purpose of the signature is indicated.
   */
  signature?: Signature[];
}

/**
 * The period during which the activity occurred.
 */
export type ProvenanceOccurred = Period | string;

/**
 * An actor taking a role in an activity  for which it can be assigned
 * some degree of responsibility for the activity taking place.
 */
export interface ProvenanceAgent {

  /**
   * 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 participation the agent had with respect to the activity.
   */
  type?: CodeableConcept;

  /**
   * The function of the agent with respect to the activity. The security
   * role enabling the agent with respect to the activity.
   */
  role?: CodeableConcept[];

  /**
   * The individual, device or organization that participated in the event.
   */
  who: Reference<Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization>;

  /**
   * The individual, device, or organization for whom the change was made.
   */
  onBehalfOf?: Reference<Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization>;
}

/**
 * An entity used in this activity.
 */
export interface ProvenanceEntity {

  /**
   * 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[];

  /**
   * How the entity was used during the activity.
   */
  role: 'derivation' | 'revision' | 'quotation' | 'source' | 'removal';

  /**
   * Identity of the  Entity used. May be a logical or physical uri and
   * maybe absolute or relative.
   */
  what: Reference<Resource>;

  /**
   * The entity is attributed to an agent to express the agent's
   * responsibility for that entity, possibly along with other agents. This
   * description can be understood as shorthand for saying that the agent
   * was responsible for the activity which generated the entity.
   */
  agent?: ProvenanceAgent[];
}