MessageDefinition - FHIR v3.4.0
Current Build
Infrastructure And Messaging Work GroupMaturity Level: 1 Trial Use Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the MessageDefinition resource.

MessageDefinition
Element IdMessageDefinition
Definition

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.

Control1..1
TypeDomainResource
Requirements

Allows messages to be defined once and re-used across systems.

Comments

This would be a MIF-level artifact.

Invariants
Defined on this element
msd-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')
MessageDefinition.url
Element IdMessageDefinition.url
Definition

The business identifier that is used to reference the MessageDefinition and is expected to be consistent from server to server.

Control0..1
Typeuri
Requirements

Allows the message definition to be referenced by a single globally unique identifier.

Summarytrue
Comments

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

MessageDefinition.identifier
Element IdMessageDefinition.identifier
Definition

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 instance.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Summarytrue
Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this message definition outside of FHIR, where it is not possible to use the logical URI.

MessageDefinition.version
Element IdMessageDefinition.version
Definition

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 sequence.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
Comments

There may be different message definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the message definition with the format [url]|[version].

MessageDefinition.name
Element IdMessageDefinition.name
Definition

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 generation.

Control0..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
Comments

The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

Invariants
Affect this element
inv-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')
MessageDefinition.title
Element IdMessageDefinition.title
Definition

A short, descriptive, user-friendly title for the message definition.

Control0..1
Typestring
Summarytrue
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

MessageDefinition.replaces
Element IdMessageDefinition.replaces
Definition

A MessageDefinition that is superseded by this definition.

Control0..*
Typecanonical(MessageDefinition)
Summarytrue
MessageDefinition.status
Element IdMessageDefinition.status
Definition

The status of this message definition. Enables tracking the life-cycle of the content.

Control1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Summarytrue
Comments

Allows filtering of message definitions that are appropriate for use versus not.

MessageDefinition.experimental
Element IdMessageDefinition.experimental
Definition

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.

Control0..1
Typeboolean
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level message definition.

Summarytrue
Comments

Allows filtering of message definitions that are appropriate for use versus not.

MessageDefinition.date
Element IdMessageDefinition.date
Definition

The date (and optionally time) when the message definition was published. The date must change 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 changes.

Control1..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
Comments

Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the message definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

MessageDefinition.publisher
Element IdMessageDefinition.publisher
Definition

The name of the organization or individual that published the message definition.

Control0..1
Typestring
Requirements

Helps establish the "authority/credibility" of the message definition. May also allow for contact.

Summarytrue
Comments

Usually an organization but may be an individual. The publisher (or steward) of the message definition is the organization or individual primarily responsible for the maintenance and upkeep of the message definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the message definition. This item SHOULD be populated unless the information is available from context.

MessageDefinition.contact
Element IdMessageDefinition.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Control0..*
TypeContactDetail
Summarytrue
Comments

May be a web site, an email address, a telephone number, etc.

MessageDefinition.description
Element IdMessageDefinition.description
Definition

A free text natural language description of the message definition from a consumer's perspective.

Control0..1
Typemarkdown
Summarytrue
Comments

This description can be used to capture details such as why the message definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the message definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the profile is presumed to be the predominant language in the place the profile was created).

MessageDefinition.useContext
Element IdMessageDefinition.useContext
Definition

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 instances.

Control0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

MessageDefinition.jurisdiction
Element IdMessageDefinition.jurisdiction
Definition

A legal or geographic region in which the message definition is intended to be used.

Control0..*
Terminology BindingJurisdiction ValueSet (Extensible)
TypeCodeableConcept
Summarytrue
Comments

It may be possible for the message definition to be used in jurisdictions other than those for which it was originally designed or intended.

MessageDefinition.purpose
Element IdMessageDefinition.purpose
Definition

Explanation of why this message definition is needed and why it has been designed as it has.

Control0..1
Typemarkdown
Summarytrue
Comments

This element does not describe the usage of the message definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this message definition.

MessageDefinition.copyright
Element IdMessageDefinition.copyright
Definition

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 definition.

Control0..1
Typemarkdown
Requirements

Consumers must be able to determine any legal restrictions on the use of the message definition and/or its content.

Alternate NamesLicense; Restrictions
MessageDefinition.base
Element IdMessageDefinition.base
Definition

The MessageDefinition that is the basis for the contents of this resource.

Control0..1
Typecanonical(MessageDefinition)
Summarytrue
MessageDefinition.parent
Element IdMessageDefinition.parent
Definition

Identifies a protocol or workflow that this MessageDefinition represents a step in.

Control0..*
Typecanonical(ActivityDefinition | PlanDefinition)
Summarytrue
Comments

It should be possible to use MessageDefinition to describe a message to be used by certain steps in a particular protocol as part of a PlanDefinition or ActivityDefinition.

MessageDefinition.event[x]
Element IdMessageDefinition.event[x]
Definition

Event code or link to the EventDefinition.

Control1..1
Terminology Bindingthe Event List in the messaging framework
TypeCoding|uri
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
MessageDefinition.category
Element IdMessageDefinition.category
Definition

The impact of the content of the message.

Control0..1
Terminology BindingMessageSignificanceCategory (Required)
Typecode
Summarytrue
MessageDefinition.focus
Element IdMessageDefinition.focus
Definition

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 merge.

Control0..*
Summarytrue
Invariants
Defined on this element
md-1Rule Max must be postive int or *max='*' or (max.toInteger() > 0)
MessageDefinition.focus.code
Element IdMessageDefinition.focus.code
Definition

The kind of resource that must be the focus for this message.

Control1..1
Terminology BindingAny defined Resource Type name
Typecode
Summarytrue
Comments

Multiple focuses addressing different resources may occasionally occur. E.g. to link or unlink a resource from a particular account or encounter, etc.

MessageDefinition.focus.profile
Element IdMessageDefinition.focus.profile
Definition

A profile that reflects constraints for the focal resource (and potentially for related resources).

Control0..1
Typecanonical(StructureDefinition)
Requirements

This profile allows setting boundaries for what content must appear within the message bundle vs. outside based on the declared aggregation constraints on referenced resources on this and related profiles.

Comments

This should be present for most message definitions. However, if the message focus is only a single resource and there is no need to include referenced resources or otherwise enforce the presence of particular elements, it can be omitted.

MessageDefinition.focus.min
Element IdMessageDefinition.focus.min
Definition

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 MessageDefinition.

Control1..1
TypeunsignedInt
Summarytrue
MessageDefinition.focus.max
Element IdMessageDefinition.focus.max
Definition

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 MessageDefinition.

Control0..1
Typestring
Invariants
Affect this element
md-1Rule Max must be postive int or *max='*' or (max.toInteger() > 0)
MessageDefinition.responseRequired
Element IdMessageDefinition.responseRequired
Definition

Declare at a message definition level whether a response is required or only upon error or success, or never.

Control0..1
Terminology Bindingmessageheader-response-request (Required)
Typecode
Comments

This enables the capability currently available through MSH-16 (Application Level acknowledgement) in HL7 Version 2 to declare at a message instance level whether a response is required or only upon error or success, or never.

MessageDefinition.allowedResponse
Element IdMessageDefinition.allowedResponse
Definition

Indicates what types of messages may be sent as an application-level response to this message.

Control0..*
Comments

This indicates an application level response to "close" a transaction implicit in a particular request message. To define a complete workflow scenario, look to the [[PlanDefinition]] resource which allows the definition of complex orchestrations, conditionality, etc.

MessageDefinition.allowedResponse.message
Element IdMessageDefinition.allowedResponse.message
Definition

A reference to the message definition that must be adhered to by this supported response.

Control1..1
Typecanonical(MessageDefinition)
MessageDefinition.allowedResponse.situation
Element IdMessageDefinition.allowedResponse.situation
Definition

Provides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses).

Control0..1
Typemarkdown
MessageDefinition.graph
Element IdMessageDefinition.graph
Definition

Canonical URL for a GraphDefinition. If a URL is provided, it is the canonical URL for a GraphDefinition that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources.

Control0..*
Typecanonical(GraphDefinition)