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

Medplum FHIR Type Definitions

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

import { CodeableConcept } from './CodeableConcept';
import { Coding } from './Coding';
import { ContactPoint } from './ContactPoint';
import { Device } from './Device';
import { Extension } from './Extension';
import { Meta } from './Meta';
import { Narrative } from './Narrative';
import { OperationOutcome } from './OperationOutcome';
import { Organization } from './Organization';
import { Practitioner } from './Practitioner';
import { PractitionerRole } from './PractitionerRole';
import { Reference } from './Reference';
import { Resource } from './Resource';

/**
 * The header for a message exchange that is either requesting or
 * responding to an action.  The reference(s) that are the subject of the
 * action as well as other information related to the action are
 * typically transmitted in a bundle in which the MessageHeader resource
 * instance is the first resource in the bundle.
 */
export interface MessageHeader {

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

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

  /**
   * Code that identifies the event this message represents and connects it
   * with its definition. Events defined as part of the FHIR specification
   * have the system value
   * "http://terminology.hl7.org/CodeSystem/message-events".  Alternatively
   * uri to the EventDefinition.
   */
  eventCoding?: Coding;

  /**
   * Code that identifies the event this message represents and connects it
   * with its definition. Events defined as part of the FHIR specification
   * have the system value
   * "http://terminology.hl7.org/CodeSystem/message-events".  Alternatively
   * uri to the EventDefinition.
   */
  eventUri?: string;

  /**
   * The destination application which the message is intended for.
   */
  destination?: MessageHeaderDestination[];

  /**
   * Identifies the sending system to allow the use of a trust
   * relationship.
   */
  sender?: Reference<Practitioner | PractitionerRole | Organization>;

  /**
   * The person or device that performed the data entry leading to this
   * message. When there is more than one candidate, pick the most proximal
   * to the message. Can provide other enterers in extensions.
   */
  enterer?: Reference<Practitioner | PractitionerRole>;

  /**
   * The logical author of the message - the person or device that decided
   * the described event should happen. When there is more than one
   * candidate, pick the most proximal to the MessageHeader. Can provide
   * other authors in extensions.
   */
  author?: Reference<Practitioner | PractitionerRole>;

  /**
   * The source application from which this message originated.
   */
  source: MessageHeaderSource;

  /**
   * The person or organization that accepts overall responsibility for the
   * contents of the message. The implication is that the message event
   * happened under the policies of the responsible party.
   */
  responsible?: Reference<Practitioner | PractitionerRole | Organization>;

  /**
   * Coded indication of the cause for the event - indicates  a reason for
   * the occurrence of the event that is a focus of this message.
   */
  reason?: CodeableConcept;

  /**
   * Information about the message that this message is a response to.
   * Only present if this message is a response.
   */
  response?: MessageHeaderResponse;

  /**
   * The actual data of the message - a reference to the root/focus class
   * of the event.
   */
  focus?: Reference<Resource>[];

  /**
   * Permanent link to the MessageDefinition for this message.
   */
  definition?: string;
}

/**
 * Code that identifies the event this message represents and connects it
 * with its definition. Events defined as part of the FHIR specification
 * have the system value
 * &quot;http://terminology.hl7.org/CodeSystem/message-events&quot;.  Alternatively
 * uri to the EventDefinition.
 */
export type MessageHeaderEvent = Coding | string;

/**
 * The destination application which the message is intended for.
 */
export interface MessageHeaderDestination {

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

  /**
   * Human-readable name for the target system.
   */
  name?: string;

  /**
   * Identifies the target end system in situations where the initial
   * message transmission is to an intermediary system.
   */
  target?: Reference<Device>;

  /**
   * Indicates where the message should be routed to.
   */
  endpoint: string;

  /**
   * Allows data conveyed by a message to be addressed to a particular
   * person or department when routing to a specific application isn't
   * sufficient.
   */
  receiver?: Reference<Practitioner | PractitionerRole | Organization>;
}

/**
 * Information about the message that this message is a response to.
 * Only present if this message is a response.
 */
export interface MessageHeaderResponse {

  /**
   * 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 MessageHeader.id of the message to which this message is a
   * response.
   */
  identifier: string;

  /**
   * Code that identifies the type of response to the message - whether it
   * was successful or not, and whether it should be resent or not.
   */
  code: 'ok' | 'transient-error' | 'fatal-error';

  /**
   * Full details of any issues found in the message.
   */
  details?: Reference<OperationOutcome>;
}

/**
 * The source application from which this message originated.
 */
export interface MessageHeaderSource {

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

  /**
   * Human-readable name for the source system.
   */
  name?: string;

  /**
   * May include configuration or other information useful in debugging.
   */
  software?: string;

  /**
   * Can convey versions of multiple systems in situations where a message
   * passes through multiple hands.
   */
  version?: string;

  /**
   * An e-mail, phone, website or other contact point to use to resolve
   * issues with message communications.
   */
  contact?: ContactPoint;

  /**
   * Identifies the routing target to send acknowledgements to.
   */
  endpoint: string;
}