FHIR R4 Current Build
This page is part of FHIR R4 - the current version v4.0.0 - in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions .
Infrastructure And Messaging Work Group Maturity Level : 1   Trial Use Security Category : Anonymous Compartments : Not linked to any defined compartments

Detailed Descriptions for the elements in the MessageDefinition resource.

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

Cardinality 0..*
Type DomainResource
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-0 Warning Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
MessageDefinition.url
Element Id MessageDefinition.url
Definition

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

Cardinality 0..1
Type uri
Requirements

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

Summary true
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 .

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

MessageDefinition.identifier
Element Id MessageDefinition.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.

Note This is a business identifier, not a resource identifier (see discussion )
Cardinality 0..*
Type Identifier
Requirements

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

Summary true
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 Id MessageDefinition.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.

Note This is a business versionId, not a resource version id (see discussion )
Cardinality 0..1
Type string
Summary true
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 Id MessageDefinition.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.

Cardinality 0..1
Type string
Requirements

Support human navigation and code generation.

Summary true
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-0 Warning Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
MessageDefinition.title
Element Id MessageDefinition.title
Definition

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

Cardinality 0..1
Type string
Summary true
Comments

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

MessageDefinition.replaces
Element Id MessageDefinition.replaces
Definition

A MessageDefinition that is superseded by this definition.

Cardinality 0..*
Type canonical ( MessageDefinition )
Summary true
MessageDefinition.status
Element Id MessageDefinition.status
Definition

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

Cardinality 1..1
Terminology Binding PublicationStatus ( Required )
Type code
Is Modifier true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Summary true
Comments

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

MessageDefinition.experimental
Element Id MessageDefinition.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.

Cardinality 0..1
Type boolean
Requirements

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

Summary true
Comments

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

MessageDefinition.date
Element Id MessageDefinition.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.

Cardinality 1..1
Type dateTime
Alternate Names Revision Date
Summary true
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 Id MessageDefinition.publisher
Definition

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

Cardinality 0..1
Type string
Requirements

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

Summary true
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 Id MessageDefinition.contact
Definition

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

Cardinality 0..*
Type ContactDetail
Summary true
Comments

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

MessageDefinition.description
Element Id MessageDefinition.description
Definition

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

Cardinality 0..1
Type markdown
Summary true
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 message definition is presumed to be the predominant language in the place the message definition was created).

MessageDefinition.useContext
Element Id MessageDefinition.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate message definition instances.

Cardinality 0..*
Type UsageContext
Requirements

Assist in searching for appropriate content.

Summary true
Comments

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

MessageDefinition.jurisdiction
Element Id MessageDefinition.jurisdiction
Definition

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

Cardinality 0..*
Terminology Binding Jurisdiction ( Extensible )
Type CodeableConcept
Summary true
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 Id MessageDefinition.purpose
Definition

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

Cardinality 0..1
Type markdown
Summary true
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 Id MessageDefinition.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.

Cardinality 0..1
Type markdown
Requirements

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

Alternate Names License; Restrictions
MessageDefinition.base
Element Id MessageDefinition.base
Definition

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

Cardinality 0..1
Type canonical ( MessageDefinition )
Summary true
MessageDefinition.parent
Element Id MessageDefinition.parent
Definition

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

Cardinality 0..*
Type canonical ( ActivityDefinition | PlanDefinition )
Summary true
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 Id MessageDefinition.event[x]
Definition

Event code or link to the EventDefinition.

Cardinality 1..1
Terminology Binding the Event List in the messaging framework
Type Coding | uri
[x] Note See Choice of Data Types for further information about how to use [x]
Summary true
MessageDefinition.category
Element Id MessageDefinition.category
Definition

The impact of the content of the message.

Cardinality 0..1
Terminology Binding MessageSignificanceCategory ( Required )
Type code
Summary true
MessageDefinition.focus
Element Id MessageDefinition.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.

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

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

Cardinality 1..1
Terminology Binding Any defined Resource Type name
Type code
Summary true
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 Id MessageDefinition.focus.profile
Definition

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

Cardinality 0..1
Type canonical ( 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 Id MessageDefinition.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.

Cardinality 1..1
Type unsignedInt
Summary true
MessageDefinition.focus.max
Element Id MessageDefinition.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.

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

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

Cardinality 0..1
Terminology Binding messageheader-response-request ( Required )
Type code
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 Id MessageDefinition.allowedResponse
Definition

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

Cardinality 0..*
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 Id MessageDefinition.allowedResponse.message
Definition

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

Cardinality 1..1
Type canonical ( MessageDefinition )
MessageDefinition.allowedResponse.situation
Element Id MessageDefinition.allowedResponse.situation
Definition

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

Cardinality 0..1
Type markdown
MessageDefinition.graph
Element Id MessageDefinition.graph
Definition

Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to 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.

Cardinality 0..*
Type canonical ( GraphDefinition )