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

Medplum FHIR Type Definitions

// SPDX-FileCopyrightText: Copyright Orangebot, Inc. and Medplum contributors
// SPDX-License-Identifier: Apache-2.0
/*
 * This is a generated file
 * Do not edit manually.
 */

import type { Attachment } from './Attachment.d.ts';
import type { Extension } from './Extension.d.ts';
import type { Group } from './Group.d.ts';
import type { Meta } from './Meta.d.ts';
import type { Narrative } from './Narrative.d.ts';
import type { Patient } from './Patient.d.ts';
import type { Reference } from './Reference.d.ts';
import type { Resource } from './Resource.d.ts';

/**
 * A SMART Health Link generated by Medplum.
 */
export interface SmartHealthLink {

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

  /**
   * 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 and use of extensions.
   */
  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 status of the SMART Health Link.
   */
  status: 'active' | 'revoked';

  /**
   * The SMART Health Link delivery mode.
   */
  mode: 'manifest' | 'direct';

  /**
   * The subject whose records are shared by the SMART Health Link.
   */
  subject: Reference<Patient | Group>;

  /**
   * The public SMART Health Link manifest or payload URL.
   */
  url: string;

  /**
   * Optional human-readable label for the SMART Health Link.
   */
  label?: string;

  /**
   * Optional SMART Health Link flags.
   */
  flag?: string;

  /**
   * Optional time when the SMART Health Link expires.
   */
  expiresAt?: string;

  /**
   * Optional hash of the SMART Health Link passcode.
   */
  passcodeHash?: string;

  /**
   * Encrypted file available from the SMART Health Link.
   */
  file: SmartHealthLinkFile[];
}

/**
 * Encrypted file available from the SMART Health Link.
 */
export interface SmartHealthLinkFile {

  /**
   * The MIME type of the plaintext file content.
   */
  contentType: string;

  /**
   * Attachment containing or referencing the encrypted SMART Health Link
   * file.
   */
  attachment: Attachment;
}