FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

2.16 Resource MessageDefinition - Content

Infrastructure And Messaging icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Anonymous Compartments: No 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.16.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.

2.16.2 References to this Resource

2.16.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageDefinition TU DomainResource A resource that defines a type of message that can be exchanged between systems
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: CanonicalResource
... url ΣC 0..1 uri The cannonical URL for a given MessageDefinition
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ 0..* Identifier Business Identifier for a given MessageDefinition

... version Σ 0..1 string Business version of the message definition
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 0..1 string Name for this message definition (computer friendly)
... title ΣT 0..1 string Name for this message definition (human friendly)
... replaces Σ 0..* canonical(MessageDefinition) Takes the place of

... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (Required)
... experimental Σ 0..1 boolean For testing only - never for real usage
... date Σ 1..1 dateTime Date last changed
... publisher ΣT 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher

... description ΣT 0..1 markdown Natural language description of the message definition
... useContext Σ 0..* UsageContext The context that the content is intended to support

... jurisdiction ΣXD 0..* CodeableConcept Intended jurisdiction for message definition (if applicable)
Binding: Jurisdiction ValueSet (Extensible)

... purpose ΣT 0..1 markdown Why this message definition is defined
... copyright T 0..1 markdown Use and/or publishing restrictions
... copyrightLabel T 0..1 string Copyright holder and year(s)
... base Σ 0..1 canonical(MessageDefinition) Definition this one is based on
... parent Σ 0..* canonical(ActivityDefinition | PlanDefinition) Protocol/workflow this is part of

... event[x] Σ 1..1 Event code or link to the EventDefinition
Binding: MessageEvent (Example)
.... eventCoding Coding
.... eventUri uri
... category Σ 0..1 code consequence | currency | notification
Binding: Message Significance Category (Required)
... focus ΣC 0..* BackboneElement Resource(s) that are the subject of the event
+ Rule: Max must be postive int or *

.... code Σ 1..1 code Type of resource
Binding: Resource Types (Required)
.... profile 0..1 canonical(StructureDefinition) Profile that must be adhered to by focus
.... min Σ 1..1 unsignedInt Minimum number of focuses of this type
.... max C 0..1 string Maximum number of focuses of this type
... responseRequired 0..1 code always | on-error | never | on-success
Binding: messageheader-response-request (Required)
... allowedResponse 0..* BackboneElement Responses to this message

.... message 1..1 canonical(MessageDefinition) Reference to allowed message definition response
.... situation 0..1 markdown When should this response be used
... graph 0..1 canonical(GraphDefinition) Canonical reference to a GraphDefinition

doco Documentation for this format icon

See the Extensions for this resource

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis

2.16.3.1 Terminology Bindings

Path ValueSet Type Documentation
MessageDefinition.versionAlgorithm[x] VersionAlgorithm Extensible

Indicates the mechanism used to compare versions to determine which is more current.
MessageDefinition.status PublicationStatus Required

The lifecycle status of an artifact.
MessageDefinition.jurisdiction JurisdictionValueSet Extensible

This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used.

Note: The codes for countries and country subdivisions are taken from ISO 3166 icon while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) icon.
MessageDefinition.event[x] MessageEvent Example

One of the message events defined as part of this version of FHIR.
MessageDefinition.category MessageSignificanceCategory Required

The impact of the content of a message.
MessageDefinition.focus.code ResourceType Required

Concrete FHIR Resource Types
MessageDefinition.responseRequired MessageheaderResponseRequest (a valid code from messageheader-response-request) Required

HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message.

2.16.3.2 Constraints

UniqueKeyLevelLocationDescriptionExpression
img cnl-0Warning (base)Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
img cnl-1Warning MessageDefinition.urlURL should not contain | or # - these characters make processing canonical references problematicexists() implies matches('^[^|# ]+$')
img md-1Rule MessageDefinition.focusMax must be postive int or *max='*' or (max.toInteger() > 0)



2.16.4 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
category token The behavior associated with the message MessageDefinition.category
context token A use context assigned to the message definition (MessageDefinition.useContext.value.ofType(CodeableConcept)) 30 Resources
context-quantity quantity A quantity- or range-valued use context assigned to the message definition (MessageDefinition.useContext.value.ofType(Quantity)) | (MessageDefinition.useContext.value.ofType(Range)) 30 Resources
context-type token A type of use context assigned to the message definition MessageDefinition.useContext.code 30 Resources
context-type-quantity composite A use context type and quantity- or range-based value assigned to the message definition On MessageDefinition.useContext:
  context-type: code
  context-quantity: value.ofType(Quantity) | value.ofType(Range)		 30 Resources
context-type-value composite A use context type and value assigned to the message definition On MessageDefinition.useContext:
  context-type: code
  context: value.ofType(CodeableConcept)		 30 Resources
date date The message definition publication date MessageDefinition.date 31 Resources
description string The description of the message definition MessageDefinition.description 29 Resources
event token The event that triggers the message or link to the event definition. MessageDefinition.event.ofType(Coding)
focus token A resource that is a permitted focus of the message MessageDefinition.focus.code
identifier token External identifier for the message definition MessageDefinition.identifier 35 Resources
jurisdiction token Intended jurisdiction for the message definition MessageDefinition.jurisdiction 27 Resources
name string Computationally friendly name of the message definition MessageDefinition.name 28 Resources
publisher string Name of the publisher of the message definition MessageDefinition.publisher 31 Resources
status token The current status of the message definition MessageDefinition.status 35 Resources
title string The human-friendly name of the message definition MessageDefinition.title 28 Resources
url uri The uri that identifies the message definition MessageDefinition.url 34 Resources
version token The business version of the message definition MessageDefinition.version 32 Resources