This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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
Detailed Descriptions for the elements in the MessageDefinition resource.
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. |
Control | 1..1 |
Requirements | Allows messages to be defined once and re-used across systems. |
MessageDefinition.url | |
Definition | An absolute URL 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. |
Control | 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. |
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 are orderable. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Summary | true |
Comments | There may be multiple different instances of a message definition that have the same identifier but different versions. |
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. |
Control | 0..1 |
Type | string |
Requirements | Support human navigation & code generation. |
Summary | true |
Comments | The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure it is computable friendly. |
MessageDefinition.title | |
Definition | A short, descriptive, user-friendly title for the message definition. |
Control | 0..1 |
Type | string |
Summary | true |
MessageDefinition.status | |
Definition | The status of this message definition. Enables tracking the life-cycle of the content. |
Control | 1..1 |
Terminology Binding | PublicationStatus (Required) |
Type | code |
Is Modifier | true |
Summary | true |
Comments | Allows filtering of message definition that are appropriate for use vs. not. |
MessageDefinition.experimental | |
Definition | A flag 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. |
Control | 0..1 |
Type | boolean |
Is Modifier | true |
Requirements | Enables experimental content to be developed following the same life-cycle as a production-level message definition would. |
Summary | true |
Comments | Allows filtering of message definition that are appropriate for use vs. not. |
MessageDefinition.date | |
Definition | The date (and optionally time) when the message definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the message definition changes. |
Control | 1..1 |
Type | dateTime |
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. |
MessageDefinition.publisher | |
Definition | The name of the individual or organization that published the message definition. |
Control | 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 | |
Definition | Contact details to assist a user in finding and communicating with the publisher. |
Control | 0..* |
Type | ContactDetail |
Summary | true |
Comments | May be a web site, an email address, a telephone number, etc. |
MessageDefinition.description | |
Definition | A free text natural language description of the message definition from the consumer's perspective. |
Control | 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 module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context. |
MessageDefinition.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 of code system definitions. |
Control | 0..* |
Type | UsageContext |
Requirements | Assist in searching for appropriate content. |
Summary | true |
Comments | When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply. |
MessageDefinition.jurisdiction | |
Definition | A jurisdiction in which the message definition is intended to be used. |
Control | 0..* |
Terminology Binding | Jurisdiction ValueSet (Extensible) |
Type | CodeableConcept |
Summary | true |
MessageDefinition.purpose | |
Definition | Explains why this message definition is needed and why it has been designed as it has. |
Control | 0..1 |
Type | markdown |
Summary | true |
Comments | This element does not describe the usage of the message definition (See, e.g, the comments element, or relatedArtifacts), rather it's for 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 | |
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. |
Control | 0..1 |
Type | markdown |
Requirements | Consumers of the library 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 | |
Definition | The MessageDefinition this new definition is a profile of. |
Control | 0..1 |
Type | Reference(MessageDefinition) |
Summary | true |
MessageDefinition.parent | |
Definition | Identifies a protocol or workflow that this MessageDefinition represents a step in. |
Control | 0..* |
Type | Reference(ActivityDefinition | PlanDefinition) |
Summary | true |
MessageDefinition.replaces | |
Definition | A MessageDefinition that is superseded by this definition. |
Control | 0..* |
Type | Reference(MessageDefinition) |
Summary | true |
MessageDefinition.event | |
Definition | A coded identifier of a supported messaging event. |
Control | 1..1 |
Terminology Binding | the Event List in the messaging framework |
Type | Coding |
Summary | true |
To Do | May need a profile id as well if profiles can define message events. |
MessageDefinition.category | |
Definition | The impact of the content of the message. |
Control | 0..1 |
Terminology Binding | MessageSignificanceCategory (Required) |
Type | code |
Summary | true |
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. |
Control | 0..* |
Summary | true |
Invariants | Defined on this element md-1: Max must be postive int or * (expression : max='*' or (max.toInteger() > 0), xpath: f:/max@value='*' or f:max/@value > 0) |
MessageDefinition.focus.code | |
Definition | The kind of resource that must be the focus for this message. |
Control | 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 | |
Definition | A profile that reflects constraints for the focal resource (and potentially for related resources). |
Control | 0..1 |
Type | Reference(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 | |
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. |
Control | 0..1 |
Type | unsignedInt |
Default Value | 0 |
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. |
Control | 0..1 |
Type | string |
Invariants | Affect this element md-1: Max must be postive int or * (expression : max='*' or (max.toInteger() > 0), xpath: f:/max@value='*' or f:max/@value > 0) |
MessageDefinition.responseRequired | |
Definition | Indicates whether a response is required for this message. |
Control | 0..1 |
Type | boolean |
Default Value | false |
MessageDefinition.allowedResponse | |
Definition | Indicates what types of messages may be sent as an application-level response to this message. |
Control | 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 | |
Definition | A reference to the message definition that must be adhered to by this supported response. |
Control | 1..1 |
Type | Reference(MessageDefinition) |
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). |
Control | 0..1 |
Type | markdown |