FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

2.48 Resource MessageDefinition - Content

Infrastructure And Messaging Work GroupMaturity Level: 0 DraftCompartments: Not linked to any defined compartments

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.

2.48.1 Scope and Usage

Implementers should be familiar with the messaging concepts and descriptions found in Messaging using FHIR Resources before working with this resource.

This resource is referenced by capabilitystatement

2.48.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageDefinition DomainResourceA resource that defines a type of message that can be exchanged between systems
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ0..1uriLogical URI to reference this message definition (globally unique)
... identifier Σ0..1IdentifierAdditional identifier for the message definition
... version Σ0..1stringBusiness version of the message definition
... name Σ0..1stringName for this message definition (computer friendly)
... title Σ0..1stringName for this message definition (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... date Σ1..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the message definition
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for message definition (if applicable)
Jurisdiction ValueSet (Extensible)
... purpose Σ0..1markdownWhy this message definition is defined
... copyright 0..1markdownUse and/or publishing restrictions
... base Σ0..1Reference(MessageDefinition)Definition this one is based on
... parent Σ0..*Reference(ActivityDefinition | PlanDefinition)Protocol/workflow this is part of
... replaces Σ0..*Reference(MessageDefinition)Takes the place of
... event Σ1..1CodingEvent type
MessageEvent (Example)
... category Σ0..1codeConsequence | Currency | Notification
MessageSignificanceCategory (Required)
... focus ΣI0..*BackboneElementResource(s) that are the subject of the event
+ Max must be postive int or *
.... code Σ1..1codeType of resource
ResourceType (Required)
.... profile 0..1Reference(StructureDefinition)Profile that must be adhered to by focus
.... min 0..1unsignedIntMinimum number of focuses of this type
.... max I0..1stringMaximum number of focuses of this type
... responseRequired 0..1booleanIs a response required?
... allowedResponse 0..*BackboneElementResponses to this message
.... message 1..1Reference(MessageDefinition)Reference to allowed message definition response
.... situation 0..1markdownWhen should this response be used

doco Documentation for this format

UML Diagram (Legend)

MessageDefinition (DomainResource)An absolute URI that is used to identify this message definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this message definition is (or will be) published. The URL SHOULD include the major version of the message definition. For more information see [Technical and Business Versions](resource.html#versions)url : uri [0..1]A formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..1]The identifier that is used to identify this version of the message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequenceversion : string [0..1]A natural language name identifying the message definition. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [0..1]A short, descriptive, user-friendly title for the message definitiontitle : string [0..1]The status of this message definition. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] The lifecycle status of a Value Set or Concept Map. (Strength=Required)PublicationStatus! A boolean value to indicate that this message definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage (this element modifies the meaning of other elements)experimental : boolean [0..1]The date (and optionally time) when the message definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the message definition changesdate : dateTime [1..1]The name of the individual or organization that published the message definitionpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the message definition from a consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate message definition instancesuseContext : UsageContext [0..*]A legal or geographic region in which the message definition is intended to be usedjurisdiction : CodeableConcept [0..*] Countries and regions within which this artifact is targeted for use (Strength=Extensible)Jurisdiction ValueSet+ Explaination of why this message definition is needed and why it has been designed as it haspurpose : markdown [0..1]A copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definitioncopyright : markdown [0..1]The MessageDefinition that is the basis for the contents of this resourcebase : Reference [0..1] MessageDefinition Identifies a protocol or workflow that this MessageDefinition represents a step inparent : Reference [0..*] ActivityDefinition|PlanDefinition A MessageDefinition that is superseded by this definitionreplaces : Reference [0..*] MessageDefinition A coded identifier of a supported messaging eventevent : Coding [1..1] One of the message events defined as part of FHIR. (Strength=Example)MessageEvent?? The impact of the content of the messagecategory : code [0..1] The impact of the content of a message. (Strength=Required)MessageSignificanceCategory! Indicates whether a response is required for this messageresponseRequired : boolean [0..1]FocusThe kind of resource that must be the focus for this messagecode : code [1..1] One of the resource types defined as part of FHIR. (Strength=Required)ResourceType! A profile that reflects constraints for the focal resource (and potentially for related resources)profile : Reference [0..1] StructureDefinition Identifies the minimum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinitionmin : unsignedInt [0..1]Identifies the maximum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinitionmax : string [0..1]AllowedResponseA reference to the message definition that must be adhered to by this supported responsemessage : Reference [1..1] MessageDefinition Provides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses)situation : markdown [0..1]Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a mergefocus[0..*]Indicates what types of messages may be sent as an application-level response to this messageallowedResponse[0..*]

XML Template

<MessageDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Logical URI to reference this message definition (globally unique) -->
 <identifier><!-- 0..1 Identifier Additional identifier for the message definition --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the message definition -->
 <name value="[string]"/><!-- 0..1 Name for this message definition (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this message definition (human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 1..1 Date this was last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the message definition -->
 <useContext><!-- 0..* UsageContext Context the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for message definition (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this message definition is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <base><!-- 0..1 Reference(MessageDefinition) Definition this one is based on --></base>
 <parent><!-- 0..* Reference(ActivityDefinition|PlanDefinition) Protocol/workflow this is part of --></parent>
 <replaces><!-- 0..* Reference(MessageDefinition) Takes the place of --></replaces>
 <event><!-- 1..1 Coding Event type --></event>
 <category value="[code]"/><!-- 0..1 Consequence | Currency | Notification -->
 <focus>  <!-- 0..* Resource(s) that are the subject of the event -->
  <code value="[code]"/><!-- 1..1 Type of resource -->
  <profile><!-- 0..1 Reference(StructureDefinition) Profile that must be adhered to by focus --></profile>
  <min value="[unsignedInt]"/><!-- 0..1 Minimum number of focuses of this type -->
  <max value="[string]"/><!-- ?? 0..1 Maximum number of focuses of this type -->
 </focus>
 <responseRequired value="[boolean]"/><!-- 0..1 Is a response required? -->
 <allowedResponse>  <!-- 0..* Responses to this message -->
  <message><!-- 1..1 Reference(MessageDefinition) Reference to allowed message definition response --></message>
  <situation value="[markdown]"/><!-- 0..1 When should this response be used -->
 </allowedResponse>
</MessageDefinition>

JSON Template

{doco
  "resourceType" : "MessageDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Logical URI to reference this message definition (globally unique)
  "identifier" : { Identifier }, // Additional identifier for the message definition
  "version" : "<string>", // Business version of the message definition
  "name" : "<string>", // Name for this message definition (computer friendly)
  "title" : "<string>", // Name for this message definition (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // R!  Date this was last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the message definition
  "useContext" : [{ UsageContext }], // Context the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for message definition (if applicable)
  "purpose" : "<markdown>", // Why this message definition is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "base" : { Reference(MessageDefinition) }, // Definition this one is based on
  "parent" : [{ Reference(ActivityDefinition|PlanDefinition) }], // Protocol/workflow this is part of
  "replaces" : [{ Reference(MessageDefinition) }], // Takes the place of
  "event" : { Coding }, // R!  Event type
  "category" : "<code>", // Consequence | Currency | Notification
  "focus" : [{ // Resource(s) that are the subject of the event
    "code" : "<code>", // R!  Type of resource
    "profile" : { Reference(StructureDefinition) }, // Profile that must be adhered to by focus
    "min" : "<unsignedInt>", // Minimum number of focuses of this type
    "max" : "<string>" // C? Maximum number of focuses of this type
  }],
  "responseRequired" : <boolean>, // Is a response required?
  "allowedResponse" : [{ // Responses to this message
    "message" : { Reference(MessageDefinition) }, // R!  Reference to allowed message definition response
    "situation" : "<markdown>" // When should this response be used
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:MessageDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:MessageDefinition.url [ uri ]; # 0..1 Logical URI to reference this message definition (globally unique)
  fhir:MessageDefinition.identifier [ Identifier ]; # 0..1 Additional identifier for the message definition
  fhir:MessageDefinition.version [ string ]; # 0..1 Business version of the message definition
  fhir:MessageDefinition.name [ string ]; # 0..1 Name for this message definition (computer friendly)
  fhir:MessageDefinition.title [ string ]; # 0..1 Name for this message definition (human friendly)
  fhir:MessageDefinition.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:MessageDefinition.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:MessageDefinition.date [ dateTime ]; # 1..1 Date this was last changed
  fhir:MessageDefinition.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:MessageDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:MessageDefinition.description [ markdown ]; # 0..1 Natural language description of the message definition
  fhir:MessageDefinition.useContext [ UsageContext ], ... ; # 0..* Context the content is intended to support
  fhir:MessageDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for message definition (if applicable)
  fhir:MessageDefinition.purpose [ markdown ]; # 0..1 Why this message definition is defined
  fhir:MessageDefinition.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:MessageDefinition.base [ Reference(MessageDefinition) ]; # 0..1 Definition this one is based on
  fhir:MessageDefinition.parent [ Reference(ActivityDefinition|PlanDefinition) ], ... ; # 0..* Protocol/workflow this is part of
  fhir:MessageDefinition.replaces [ Reference(MessageDefinition) ], ... ; # 0..* Takes the place of
  fhir:MessageDefinition.event [ Coding ]; # 1..1 Event type
  fhir:MessageDefinition.category [ code ]; # 0..1 Consequence | Currency | Notification
  fhir:MessageDefinition.focus [ # 0..* Resource(s) that are the subject of the event
    fhir:MessageDefinition.focus.code [ code ]; # 1..1 Type of resource
    fhir:MessageDefinition.focus.profile [ Reference(StructureDefinition) ]; # 0..1 Profile that must be adhered to by focus
    fhir:MessageDefinition.focus.min [ unsignedInt ]; # 0..1 Minimum number of focuses of this type
    fhir:MessageDefinition.focus.max [ string ]; # 0..1 Maximum number of focuses of this type
  ], ...;
  fhir:MessageDefinition.responseRequired [ boolean ]; # 0..1 Is a response required?
  fhir:MessageDefinition.allowedResponse [ # 0..* Responses to this message
    fhir:MessageDefinition.allowedResponse.message [ Reference(MessageDefinition) ]; # 1..1 Reference to allowed message definition response
    fhir:MessageDefinition.allowedResponse.situation [ markdown ]; # 0..1 When should this response be used
  ], ...;
]

Changes since DSTU2

This resource did not exist in Release 2

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageDefinition DomainResourceA resource that defines a type of message that can be exchanged between systems
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ0..1uriLogical URI to reference this message definition (globally unique)
... identifier Σ0..1IdentifierAdditional identifier for the message definition
... version Σ0..1stringBusiness version of the message definition
... name Σ0..1stringName for this message definition (computer friendly)
... title Σ0..1stringName for this message definition (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... date Σ1..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the message definition
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for message definition (if applicable)
Jurisdiction ValueSet (Extensible)
... purpose Σ0..1markdownWhy this message definition is defined
... copyright 0..1markdownUse and/or publishing restrictions
... base Σ0..1Reference(MessageDefinition)Definition this one is based on
... parent Σ0..*Reference(ActivityDefinition | PlanDefinition)Protocol/workflow this is part of
... replaces Σ0..*Reference(MessageDefinition)Takes the place of
... event Σ1..1CodingEvent type
MessageEvent (Example)
... category Σ0..1codeConsequence | Currency | Notification
MessageSignificanceCategory (Required)
... focus ΣI0..*BackboneElementResource(s) that are the subject of the event
+ Max must be postive int or *
.... code Σ1..1codeType of resource
ResourceType (Required)
.... profile 0..1Reference(StructureDefinition)Profile that must be adhered to by focus
.... min 0..1unsignedIntMinimum number of focuses of this type
.... max I0..1stringMaximum number of focuses of this type
... responseRequired 0..1booleanIs a response required?
... allowedResponse 0..*BackboneElementResponses to this message
.... message 1..1Reference(MessageDefinition)Reference to allowed message definition response
.... situation 0..1markdownWhen should this response be used

doco Documentation for this format

UML Diagram (Legend)

MessageDefinition (DomainResource)An absolute URI that is used to identify this message definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this message definition is (or will be) published. The URL SHOULD include the major version of the message definition. For more information see [Technical and Business Versions](resource.html#versions)url : uri [0..1]A formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..1]The identifier that is used to identify this version of the message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequenceversion : string [0..1]A natural language name identifying the message definition. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [0..1]A short, descriptive, user-friendly title for the message definitiontitle : string [0..1]The status of this message definition. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] The lifecycle status of a Value Set or Concept Map. (Strength=Required)PublicationStatus! A boolean value to indicate that this message definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage (this element modifies the meaning of other elements)experimental : boolean [0..1]The date (and optionally time) when the message definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the message definition changesdate : dateTime [1..1]The name of the individual or organization that published the message definitionpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the message definition from a consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate message definition instancesuseContext : UsageContext [0..*]A legal or geographic region in which the message definition is intended to be usedjurisdiction : CodeableConcept [0..*] Countries and regions within which this artifact is targeted for use (Strength=Extensible)Jurisdiction ValueSet+ Explaination of why this message definition is needed and why it has been designed as it haspurpose : markdown [0..1]A copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definitioncopyright : markdown [0..1]The MessageDefinition that is the basis for the contents of this resourcebase : Reference [0..1] MessageDefinition Identifies a protocol or workflow that this MessageDefinition represents a step inparent : Reference [0..*] ActivityDefinition|PlanDefinition A MessageDefinition that is superseded by this definitionreplaces : Reference [0..*] MessageDefinition A coded identifier of a supported messaging eventevent : Coding [1..1] One of the message events defined as part of FHIR. (Strength=Example)MessageEvent?? The impact of the content of the messagecategory : code [0..1] The impact of the content of a message. (Strength=Required)MessageSignificanceCategory! Indicates whether a response is required for this messageresponseRequired : boolean [0..1]FocusThe kind of resource that must be the focus for this messagecode : code [1..1] One of the resource types defined as part of FHIR. (Strength=Required)ResourceType! A profile that reflects constraints for the focal resource (and potentially for related resources)profile : Reference [0..1] StructureDefinition Identifies the minimum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinitionmin : unsignedInt [0..1]Identifies the maximum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinitionmax : string [0..1]AllowedResponseA reference to the message definition that must be adhered to by this supported responsemessage : Reference [1..1] MessageDefinition Provides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses)situation : markdown [0..1]Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a mergefocus[0..*]Indicates what types of messages may be sent as an application-level response to this messageallowedResponse[0..*]

XML Template

<MessageDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Logical URI to reference this message definition (globally unique) -->
 <identifier><!-- 0..1 Identifier Additional identifier for the message definition --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the message definition -->
 <name value="[string]"/><!-- 0..1 Name for this message definition (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this message definition (human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 1..1 Date this was last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the message definition -->
 <useContext><!-- 0..* UsageContext Context the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for message definition (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this message definition is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <base><!-- 0..1 Reference(MessageDefinition) Definition this one is based on --></base>
 <parent><!-- 0..* Reference(ActivityDefinition|PlanDefinition) Protocol/workflow this is part of --></parent>
 <replaces><!-- 0..* Reference(MessageDefinition) Takes the place of --></replaces>
 <event><!-- 1..1 Coding Event type --></event>
 <category value="[code]"/><!-- 0..1 Consequence | Currency | Notification -->
 <focus>  <!-- 0..* Resource(s) that are the subject of the event -->
  <code value="[code]"/><!-- 1..1 Type of resource -->
  <profile><!-- 0..1 Reference(StructureDefinition) Profile that must be adhered to by focus --></profile>
  <min value="[unsignedInt]"/><!-- 0..1 Minimum number of focuses of this type -->
  <max value="[string]"/><!-- ?? 0..1 Maximum number of focuses of this type -->
 </focus>
 <responseRequired value="[boolean]"/><!-- 0..1 Is a response required? -->
 <allowedResponse>  <!-- 0..* Responses to this message -->
  <message><!-- 1..1 Reference(MessageDefinition) Reference to allowed message definition response --></message>
  <situation value="[markdown]"/><!-- 0..1 When should this response be used -->
 </allowedResponse>
</MessageDefinition>

JSON Template

{doco
  "resourceType" : "MessageDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Logical URI to reference this message definition (globally unique)
  "identifier" : { Identifier }, // Additional identifier for the message definition
  "version" : "<string>", // Business version of the message definition
  "name" : "<string>", // Name for this message definition (computer friendly)
  "title" : "<string>", // Name for this message definition (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // R!  Date this was last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the message definition
  "useContext" : [{ UsageContext }], // Context the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for message definition (if applicable)
  "purpose" : "<markdown>", // Why this message definition is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "base" : { Reference(MessageDefinition) }, // Definition this one is based on
  "parent" : [{ Reference(ActivityDefinition|PlanDefinition) }], // Protocol/workflow this is part of
  "replaces" : [{ Reference(MessageDefinition) }], // Takes the place of
  "event" : { Coding }, // R!  Event type
  "category" : "<code>", // Consequence | Currency | Notification
  "focus" : [{ // Resource(s) that are the subject of the event
    "code" : "<code>", // R!  Type of resource
    "profile" : { Reference(StructureDefinition) }, // Profile that must be adhered to by focus
    "min" : "<unsignedInt>", // Minimum number of focuses of this type
    "max" : "<string>" // C? Maximum number of focuses of this type
  }],
  "responseRequired" : <boolean>, // Is a response required?
  "allowedResponse" : [{ // Responses to this message
    "message" : { Reference(MessageDefinition) }, // R!  Reference to allowed message definition response
    "situation" : "<markdown>" // When should this response be used
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:MessageDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:MessageDefinition.url [ uri ]; # 0..1 Logical URI to reference this message definition (globally unique)
  fhir:MessageDefinition.identifier [ Identifier ]; # 0..1 Additional identifier for the message definition
  fhir:MessageDefinition.version [ string ]; # 0..1 Business version of the message definition
  fhir:MessageDefinition.name [ string ]; # 0..1 Name for this message definition (computer friendly)
  fhir:MessageDefinition.title [ string ]; # 0..1 Name for this message definition (human friendly)
  fhir:MessageDefinition.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:MessageDefinition.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:MessageDefinition.date [ dateTime ]; # 1..1 Date this was last changed
  fhir:MessageDefinition.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:MessageDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:MessageDefinition.description [ markdown ]; # 0..1 Natural language description of the message definition
  fhir:MessageDefinition.useContext [ UsageContext ], ... ; # 0..* Context the content is intended to support
  fhir:MessageDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for message definition (if applicable)
  fhir:MessageDefinition.purpose [ markdown ]; # 0..1 Why this message definition is defined
  fhir:MessageDefinition.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:MessageDefinition.base [ Reference(MessageDefinition) ]; # 0..1 Definition this one is based on
  fhir:MessageDefinition.parent [ Reference(ActivityDefinition|PlanDefinition) ], ... ; # 0..* Protocol/workflow this is part of
  fhir:MessageDefinition.replaces [ Reference(MessageDefinition) ], ... ; # 0..* Takes the place of
  fhir:MessageDefinition.event [ Coding ]; # 1..1 Event type
  fhir:MessageDefinition.category [ code ]; # 0..1 Consequence | Currency | Notification
  fhir:MessageDefinition.focus [ # 0..* Resource(s) that are the subject of the event
    fhir:MessageDefinition.focus.code [ code ]; # 1..1 Type of resource
    fhir:MessageDefinition.focus.profile [ Reference(StructureDefinition) ]; # 0..1 Profile that must be adhered to by focus
    fhir:MessageDefinition.focus.min [ unsignedInt ]; # 0..1 Minimum number of focuses of this type
    fhir:MessageDefinition.focus.max [ string ]; # 0..1 Maximum number of focuses of this type
  ], ...;
  fhir:MessageDefinition.responseRequired [ boolean ]; # 0..1 Is a response required?
  fhir:MessageDefinition.allowedResponse [ # 0..* Responses to this message
    fhir:MessageDefinition.allowedResponse.message [ Reference(MessageDefinition) ]; # 1..1 Reference to allowed message definition response
    fhir:MessageDefinition.allowedResponse.situation [ markdown ]; # 0..1 When should this response be used
  ], ...;
]

Changes since DSTU2

This resource did not exist in Release 2

This analysis is available as XML or JSON.

 

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle)

2.48.2.1 Terminology Bindings

PathDefinitionTypeReference
MessageDefinition.status The lifecycle status of a Value Set or Concept Map.RequiredPublicationStatus
MessageDefinition.jurisdiction Countries and regions within which this artifact is targeted for useExtensibleJurisdiction ValueSet
MessageDefinition.event One of the message events defined as part of FHIR.ExampleMessage Events
MessageDefinition.category The impact of the content of a message.RequiredMessageSignificanceCategory
MessageDefinition.focus.code One of the resource types defined as part of FHIR.RequiredResource Types

2.48.2.2 Constraints

  • md-1: On MessageDefinition.focus: Max must be postive int or * (expression on MessageDefinition.focus: max='*' or (max.toInteger() > 0))

2.48.3 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
categorytokenThe behavior associated with the messageMessageDefinition.category
datedateThe message definition publication dateMessageDefinition.date
descriptionstringThe description of the message definitionMessageDefinition.description
eventtokenThe event that triggers the messageMessageDefinition.event
focustokenA resource that is a permitted focus of the messageMessageDefinition.focus.code
identifiertokenExternal identifier for the message definitionMessageDefinition.identifier
jurisdictiontokenIntended jurisdiction for the message definitionMessageDefinition.jurisdiction
namestringComputationally friendly name of the message definitionMessageDefinition.name
publisherstringName of the publisher of the message definitionMessageDefinition.publisher
statustokenThe current status of the message definitionMessageDefinition.status
titlestringThe human-friendly name of the message definitionMessageDefinition.title
urluriThe uri that identifies the message definitionMessageDefinition.url
versiontokenThe business version of the message definitionMessageDefinition.version