http://hl7.org/fhir/StructureDefinition/MessageDefinition|5.0.0

Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.
Structure JSON Dependencies FHIRSchema Other Versions Dependant (0)Elements Summary
description: Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.
derivation: specialization
name: MessageDefinition
type: MessageDefinition
elements:
  description: {isModifier: false, short: Natural language description of the message definition, mustSupport: false, isSummary: true, index: 13}
  category:
    isModifier: false
    short: consequence | currency | notification
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/message-significance-category|5.0.0'}
    isSummary: true
    index: 23
  date: {isModifier: false, short: Date last changed, mustSupport: false, isSummary: true, index: 10}
  publisher: {isModifier: false, short: Name of the publisher/steward (organization or individual), mustSupport: false, isSummary: true, index: 11}
  parent: {isModifier: false, short: Protocol/workflow this is part of, mustSupport: false, array: true, isSummary: true, index: 20}
  jurisdiction:
    isModifier: false
    short: Intended jurisdiction for message definition (if applicable)
    mustSupport: false
    array: true
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/jurisdiction'}
    isSummary: true
    index: 15
  purpose: {isModifier: false, short: Why this message definition is defined, mustSupport: false, isSummary: true, index: 16}
  name: {isModifier: false, short: Name for this message definition (computer friendly), mustSupport: false, isSummary: true, index: 5}
  copyrightLabel: {isModifier: false, short: Copyright holder and year(s), mustSupport: false, isSummary: false, index: 18}
  useContext: {isModifier: false, short: The context that the content is intended to support, mustSupport: false, array: true, isSummary: true, index: 14}
  copyright: {isModifier: false, short: Use and/or publishing restrictions, mustSupport: false, isSummary: false, index: 17}
  versionAlgorithm:
    isModifier: false
    short: How to compare versions
    mustSupport: false
    choices: []
    isSummary: true
    index: 4
  experimental: {isModifier: false, short: 'For testing purposes, not real usage', mustSupport: false, meaningWhenMissing: 'If absent, this resource is treated as though it is not experimental.', isSummary: true, index: 9}
  title: {isModifier: false, short: Name for this message definition (human friendly), mustSupport: false, isSummary: true, index: 6}
  event:
    isModifier: false
    short: Event code  or link to the EventDefinition
    mustSupport: false
    choices: []
    isSummary: true
    index: 22
  status:
    isModifier: true
    short: draft | active | retired | unknown
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/publication-status|5.0.0'}
    isModifierReason: This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration
    isSummary: true
    index: 8
  allowedResponse:
    isModifier: false
    short: Responses to this message
    mustSupport: false
    array: true
    isSummary: false
    index: 30
    elements:
      message: {isModifier: false, short: Reference to allowed message definition response, mustSupport: false, isSummary: false, index: 31}
      situation: {isModifier: false, short: When should this response be used, mustSupport: false, isSummary: false, index: 32}
    required: [message]
  graph: {isModifier: false, short: Canonical reference to a GraphDefinition, mustSupport: false, isSummary: false, index: 33}
  url:
    constraint:
      cnl-1: {human: 'URL should not contain | or # - these characters make processing canonical references problematic', source: 'http://hl7.org/fhir/StructureDefinition/MessageDefinition', severity: warning, expression: 'exists() implies matches(''^[^|# ]+$'')'}
    isModifier: false
    short: The cannonical URL for a given MessageDefinition
    mustSupport: false
    isSummary: true
    index: 0
  identifier: {isModifier: false, short: Business Identifier for a given MessageDefinition, mustSupport: false, array: true, isSummary: true, index: 1}
  focus:
    constraint:
      md-1: {human: Max must be postive int or *, source: 'http://hl7.org/fhir/StructureDefinition/MessageDefinition', severity: error, expression: max='*' or (max.toInteger() > 0)}
    isModifier: false
    short: Resource(s) that are the subject of the event
    index: 24
    mustSupport: false
    array: true
    elements:
      code:
        isModifier: false
        short: Type of resource
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/resource-types|5.0.0'}
        isSummary: true
        index: 25
      profile: {isModifier: false, short: Profile that must be adhered to by focus, mustSupport: false, isSummary: false, index: 26}
      min: {isModifier: false, short: Minimum number of focuses of this type, mustSupport: false, isSummary: true, index: 27}
      max: {isModifier: false, short: Maximum number of focuses of this type, mustSupport: false, isSummary: false, index: 28}
    required: [min, code]
    isSummary: true
  replaces: {isModifier: false, short: Takes the place of, mustSupport: false, array: true, isSummary: true, index: 7}
  responseRequired:
    isModifier: false
    short: always | on-error | never | on-success
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/messageheader-response-request|5.0.0'}
    isSummary: false
    index: 29
  base: {isModifier: false, short: Definition this one is based on, mustSupport: false, isSummary: true, index: 19}
  version: {isModifier: false, short: Business version of the message definition, mustSupport: false, isSummary: true, index: 2}
  contact: {isModifier: false, short: Contact details for the publisher, mustSupport: false, array: true, isSummary: true, index: 12}
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/MessageDefinition
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 5.0.0
required: [event, status, date]