Release 5 Preview #3

This page is part of the FHIR Specification (v4.5.0: R5 Preview #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.51 Resource MessageDefinition - Content

Infrastructure And Messaging Work GroupMaturity Level: 1 Trial UseSecurity Category: Anonymous Compartments: 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.51.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.51.2 References

This resource is referenced by CapabilityStatement, itself and MessageHeader.

This resource does not implement any patterns.

2.51.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageDefinition TUCanonicalResourceA 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, url, identifier, version, name, title, status, experimental, date, publisher, contact, description, useContext, jurisdiction, purpose, copyright
... url Σ0..1uriBusiness Identifier for a given MessageDefinition
... identifier Σ0..*IdentifierPrimary key for the message definition on a given server
... version Σ0..1stringBusiness version of the message definition
... title Σ0..1stringName for this message definition (human friendly)
... replaces Σ0..*canonical(MessageDefinition)Takes the place of
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ1..1dateTimeDate 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..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for message definition (if applicable)
Jurisdiction (Extensible)
... purpose Σ0..1markdownWhy this message definition is defined
... copyright 0..1markdownUse and/or publishing restrictions
... base Σ0..1canonical(MessageDefinition)Definition this one is based on
... parent Σ0..*canonical(ActivityDefinition | PlanDefinition)Protocol/workflow this is part of
... event[x] Σ1..1Event code or link to the EventDefinition
MessageEvent (Example)
.... eventCodingCoding
.... eventUriuri
... category Σ0..1codeconsequence | currency | notification
MessageSignificanceCategory (Required)
... focus ΣI0..*BackboneElementResource(s) that are the subject of the event
+ Rule: Max must be postive int or *
.... code Σ1..1codeType of resource
ResourceType (Required)
.... profile 0..1canonical(StructureDefinition)Profile that must be adhered to by focus
.... min Σ1..1unsignedIntMinimum number of focuses of this type
.... max I0..1stringMaximum number of focuses of this type
... responseRequired 0..1codealways | on-error | never | on-success
messageheader-response-request (Required)
... allowedResponse 0..*BackboneElementResponses to this message
.... message 1..1canonical(MessageDefinition)Reference to allowed message definition response
.... situation 0..1markdownWhen should this response be used
... graph 0..*canonical(GraphDefinition)Canonical reference to a GraphDefinition

doco Documentation for this format

UML Diagram (Legend)

MessageDefinition (CanonicalResource)The business identifier that is used to reference the MessageDefinition and *is* expected to be consistent from server to serverurl : 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..*]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]A MessageDefinition that is superseded by this definitionreplaces : canonical [0..*] « MessageDefinition »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 an artifact. (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 usageexperimental : boolean [0..1]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 changesdate : dateTime [1..1]The name of the organization or individual 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 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 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+ »Explanation 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 : canonical [0..1] « MessageDefinition »Identifies a protocol or workflow that this MessageDefinition represents a step inparent : canonical [0..*] « ActivityDefinition|PlanDefinition »Event code or link to the EventDefinitionevent[x] : DataType [1..1] « Coding|uri; One of the message events defined as part of this version 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! »Declare at a message definition level whether a response is required or only upon error or success, or neverresponseRequired : code [0..1] « HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message. (Strength=Required)messageheader-response-request! »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 resourcesgraph : canonical [0..*] « GraphDefinition »FocusThe kind of resource that must be the focus for this messagecode : code [1..1] « One of the resource types defined as part of this version of FHIR. (Strength=Required)ResourceType! »A profile that reflects constraints for the focal resource (and potentially for related resources)profile : canonical [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 [1..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 : canonical [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 -->
 <url value="[uri]"/><!-- 0..1 Business Identifier for a given MessageDefinition -->
 <identifier><!-- 0..* Identifier Primary key for the message definition on a given server --></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) -->
 <replaces><!-- 0..* canonical(MessageDefinition) Takes the place of --></replaces>
 <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 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 The context that 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 canonical(MessageDefinition) Definition this one is based on --></base>
 <parent><!-- 0..* canonical(ActivityDefinition|PlanDefinition) Protocol/workflow this is part of --></parent>
 <event[x]><!-- 1..1 Coding|uri Event code  or link to the EventDefinition --></event[x]>
 <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 canonical(StructureDefinition) Profile that must be adhered to by focus --></profile>
  <min value="[unsignedInt]"/><!-- 1..1 Minimum number of focuses of this type -->
  <max value="[string]"/><!-- ?? 0..1 Maximum number of focuses of this type -->
 </focus>
 <responseRequired value="[code]"/><!-- 0..1 always | on-error | never | on-success -->
 <allowedResponse>  <!-- 0..* Responses to this message -->
  <message><!-- 1..1 canonical(MessageDefinition) Reference to allowed message definition response --></message>
  <situation value="[markdown]"/><!-- 0..1 When should this response be used -->
 </allowedResponse>
 <graph><!-- 0..* canonical(GraphDefinition) Canonical reference to a GraphDefinition --></graph>
</MessageDefinition>

JSON Template

{doco
  "resourceType" : "MessageDefinition",
  // from Resource: id, meta, implicitRules, and language
  "url" : "<uri>", // Business Identifier for a given MessageDefinition
  "identifier" : [{ Identifier }], // Primary key for the message definition on a given server
  "version" : "<string>", // Business version of the message definition
  "name" : "<string>", // C? Name for this message definition (computer friendly)
  "title" : "<string>", // Name for this message definition (human friendly)
  "replaces" : [{ canonical(MessageDefinition) }], // Takes the place of
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // R!  Date 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 }], // The context that 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" : { canonical(MessageDefinition) }, // Definition this one is based on
  "parent" : [{ canonical(ActivityDefinition|PlanDefinition) }], // Protocol/workflow this is part of
  // event[x]: Event code  or link to the EventDefinition. One of these 2:
  "eventCoding" : { Coding },
  "eventUri" : "<uri>",
  "category" : "<code>", // consequence | currency | notification
  "focus" : [{ // Resource(s) that are the subject of the event
    "code" : "<code>", // R!  Type of resource
    "profile" : { canonical(StructureDefinition) }, // Profile that must be adhered to by focus
    "min" : "<unsignedInt>", // R!  Minimum number of focuses of this type
    "max" : "<string>" // C? Maximum number of focuses of this type
  }],
  "responseRequired" : "<code>", // always | on-error | never | on-success
  "allowedResponse" : [{ // Responses to this message
    "message" : { canonical(MessageDefinition) }, // R!  Reference to allowed message definition response
    "situation" : "<markdown>" // When should this response be used
  }],
  "graph" : [{ canonical(GraphDefinition) }] // Canonical reference to a GraphDefinition
}

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
  fhir:MessageDefinition.url [ uri ]; # 0..1 Business Identifier for a given MessageDefinition
  fhir:MessageDefinition.identifier [ Identifier ], ... ; # 0..* Primary key for the message definition on a given server
  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.replaces [ canonical(MessageDefinition) ], ... ; # 0..* Takes the place of
  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 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..* The context that 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 [ canonical(MessageDefinition) ]; # 0..1 Definition this one is based on
  fhir:MessageDefinition.parent [ canonical(ActivityDefinition|PlanDefinition) ], ... ; # 0..* Protocol/workflow this is part of
  # MessageDefinition.event[x] : 1..1 Event code  or link to the EventDefinition. One of these 2
    fhir:MessageDefinition.eventCoding [ Coding ]
    fhir:MessageDefinition.eventUri [ uri ]
  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 [ canonical(StructureDefinition) ]; # 0..1 Profile that must be adhered to by focus
    fhir:MessageDefinition.focus.min [ unsignedInt ]; # 1..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 [ code ]; # 0..1 always | on-error | never | on-success
  fhir:MessageDefinition.allowedResponse [ # 0..* Responses to this message
    fhir:MessageDefinition.allowedResponse.message [ canonical(MessageDefinition) ]; # 1..1 Reference to allowed message definition response
    fhir:MessageDefinition.allowedResponse.situation [ markdown ]; # 0..1 When should this response be used
  ], ...;
  fhir:MessageDefinition.graph [ canonical(GraphDefinition) ], ... ; # 0..* Canonical reference to a GraphDefinition
]

Changes since R3

MessageDefinition
MessageDefinition.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/publication-status|4.5.0
MessageDefinition.category
  • Change value set from http://hl7.org/fhir/ValueSet/message-significance-category|4.0.0 to http://hl7.org/fhir/ValueSet/message-significance-category|4.5.0
MessageDefinition.focus.code
  • Change value set from http://hl7.org/fhir/ValueSet/resource-types|4.0.0 to http://hl7.org/fhir/ValueSet/resource-types|4.5.0
MessageDefinition.responseRequired
  • Change value set from http://hl7.org/fhir/ValueSet/messageheader-response-request|4.0.0 to http://hl7.org/fhir/ValueSet/messageheader-response-request|4.5.0

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 3 tests that all execute ok. All tests pass round-trip testing and 2 r3 resources are invalid (0 errors).)

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageDefinition TUCanonicalResourceA 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, url, identifier, version, name, title, status, experimental, date, publisher, contact, description, useContext, jurisdiction, purpose, copyright
... url Σ0..1uriBusiness Identifier for a given MessageDefinition
... identifier Σ0..*IdentifierPrimary key for the message definition on a given server
... version Σ0..1stringBusiness version of the message definition
... title Σ0..1stringName for this message definition (human friendly)
... replaces Σ0..*canonical(MessageDefinition)Takes the place of
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ1..1dateTimeDate 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..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for message definition (if applicable)
Jurisdiction (Extensible)
... purpose Σ0..1markdownWhy this message definition is defined
... copyright 0..1markdownUse and/or publishing restrictions
... base Σ0..1canonical(MessageDefinition)Definition this one is based on
... parent Σ0..*canonical(ActivityDefinition | PlanDefinition)Protocol/workflow this is part of
... event[x] Σ1..1Event code or link to the EventDefinition
MessageEvent (Example)
.... eventCodingCoding
.... eventUriuri
... category Σ0..1codeconsequence | currency | notification
MessageSignificanceCategory (Required)
... focus ΣI0..*BackboneElementResource(s) that are the subject of the event
+ Rule: Max must be postive int or *
.... code Σ1..1codeType of resource
ResourceType (Required)
.... profile 0..1canonical(StructureDefinition)Profile that must be adhered to by focus
.... min Σ1..1unsignedIntMinimum number of focuses of this type
.... max I0..1stringMaximum number of focuses of this type
... responseRequired 0..1codealways | on-error | never | on-success
messageheader-response-request (Required)
... allowedResponse 0..*BackboneElementResponses to this message
.... message 1..1canonical(MessageDefinition)Reference to allowed message definition response
.... situation 0..1markdownWhen should this response be used
... graph 0..*canonical(GraphDefinition)Canonical reference to a GraphDefinition

doco Documentation for this format

UML Diagram (Legend)

MessageDefinition (CanonicalResource)The business identifier that is used to reference the MessageDefinition and *is* expected to be consistent from server to serverurl : 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..*]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]A MessageDefinition that is superseded by this definitionreplaces : canonical [0..*] « MessageDefinition »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 an artifact. (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 usageexperimental : boolean [0..1]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 changesdate : dateTime [1..1]The name of the organization or individual 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 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 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+ »Explanation 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 : canonical [0..1] « MessageDefinition »Identifies a protocol or workflow that this MessageDefinition represents a step inparent : canonical [0..*] « ActivityDefinition|PlanDefinition »Event code or link to the EventDefinitionevent[x] : DataType [1..1] « Coding|uri; One of the message events defined as part of this version 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! »Declare at a message definition level whether a response is required or only upon error or success, or neverresponseRequired : code [0..1] « HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message. (Strength=Required)messageheader-response-request! »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 resourcesgraph : canonical [0..*] « GraphDefinition »FocusThe kind of resource that must be the focus for this messagecode : code [1..1] « One of the resource types defined as part of this version of FHIR. (Strength=Required)ResourceType! »A profile that reflects constraints for the focal resource (and potentially for related resources)profile : canonical [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 [1..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 : canonical [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 -->
 <url value="[uri]"/><!-- 0..1 Business Identifier for a given MessageDefinition -->
 <identifier><!-- 0..* Identifier Primary key for the message definition on a given server --></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) -->
 <replaces><!-- 0..* canonical(MessageDefinition) Takes the place of --></replaces>
 <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 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 The context that 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 canonical(MessageDefinition) Definition this one is based on --></base>
 <parent><!-- 0..* canonical(ActivityDefinition|PlanDefinition) Protocol/workflow this is part of --></parent>
 <event[x]><!-- 1..1 Coding|uri Event code  or link to the EventDefinition --></event[x]>
 <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 canonical(StructureDefinition) Profile that must be adhered to by focus --></profile>
  <min value="[unsignedInt]"/><!-- 1..1 Minimum number of focuses of this type -->
  <max value="[string]"/><!-- ?? 0..1 Maximum number of focuses of this type -->
 </focus>
 <responseRequired value="[code]"/><!-- 0..1 always | on-error | never | on-success -->
 <allowedResponse>  <!-- 0..* Responses to this message -->
  <message><!-- 1..1 canonical(MessageDefinition) Reference to allowed message definition response --></message>
  <situation value="[markdown]"/><!-- 0..1 When should this response be used -->
 </allowedResponse>
 <graph><!-- 0..* canonical(GraphDefinition) Canonical reference to a GraphDefinition --></graph>
</MessageDefinition>

JSON Template

{doco
  "resourceType" : "MessageDefinition",
  // from Resource: id, meta, implicitRules, and language
  "url" : "<uri>", // Business Identifier for a given MessageDefinition
  "identifier" : [{ Identifier }], // Primary key for the message definition on a given server
  "version" : "<string>", // Business version of the message definition
  "name" : "<string>", // C? Name for this message definition (computer friendly)
  "title" : "<string>", // Name for this message definition (human friendly)
  "replaces" : [{ canonical(MessageDefinition) }], // Takes the place of
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // R!  Date 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 }], // The context that 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" : { canonical(MessageDefinition) }, // Definition this one is based on
  "parent" : [{ canonical(ActivityDefinition|PlanDefinition) }], // Protocol/workflow this is part of
  // event[x]: Event code  or link to the EventDefinition. One of these 2:
  "eventCoding" : { Coding },
  "eventUri" : "<uri>",
  "category" : "<code>", // consequence | currency | notification
  "focus" : [{ // Resource(s) that are the subject of the event
    "code" : "<code>", // R!  Type of resource
    "profile" : { canonical(StructureDefinition) }, // Profile that must be adhered to by focus
    "min" : "<unsignedInt>", // R!  Minimum number of focuses of this type
    "max" : "<string>" // C? Maximum number of focuses of this type
  }],
  "responseRequired" : "<code>", // always | on-error | never | on-success
  "allowedResponse" : [{ // Responses to this message
    "message" : { canonical(MessageDefinition) }, // R!  Reference to allowed message definition response
    "situation" : "<markdown>" // When should this response be used
  }],
  "graph" : [{ canonical(GraphDefinition) }] // Canonical reference to a GraphDefinition
}

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
  fhir:MessageDefinition.url [ uri ]; # 0..1 Business Identifier for a given MessageDefinition
  fhir:MessageDefinition.identifier [ Identifier ], ... ; # 0..* Primary key for the message definition on a given server
  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.replaces [ canonical(MessageDefinition) ], ... ; # 0..* Takes the place of
  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 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..* The context that 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 [ canonical(MessageDefinition) ]; # 0..1 Definition this one is based on
  fhir:MessageDefinition.parent [ canonical(ActivityDefinition|PlanDefinition) ], ... ; # 0..* Protocol/workflow this is part of
  # MessageDefinition.event[x] : 1..1 Event code  or link to the EventDefinition. One of these 2
    fhir:MessageDefinition.eventCoding [ Coding ]
    fhir:MessageDefinition.eventUri [ uri ]
  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 [ canonical(StructureDefinition) ]; # 0..1 Profile that must be adhered to by focus
    fhir:MessageDefinition.focus.min [ unsignedInt ]; # 1..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 [ code ]; # 0..1 always | on-error | never | on-success
  fhir:MessageDefinition.allowedResponse [ # 0..* Responses to this message
    fhir:MessageDefinition.allowedResponse.message [ canonical(MessageDefinition) ]; # 1..1 Reference to allowed message definition response
    fhir:MessageDefinition.allowedResponse.situation [ markdown ]; # 0..1 When should this response be used
  ], ...;
  fhir:MessageDefinition.graph [ canonical(GraphDefinition) ], ... ; # 0..* Canonical reference to a GraphDefinition
]

Changes since Release 3

MessageDefinition
MessageDefinition.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/publication-status|4.5.0
MessageDefinition.category
  • Change value set from http://hl7.org/fhir/ValueSet/message-significance-category|4.0.0 to http://hl7.org/fhir/ValueSet/message-significance-category|4.5.0
MessageDefinition.focus.code
  • Change value set from http://hl7.org/fhir/ValueSet/resource-types|4.0.0 to http://hl7.org/fhir/ValueSet/resource-types|4.5.0
MessageDefinition.responseRequired
  • Change value set from http://hl7.org/fhir/ValueSet/messageheader-response-request|4.0.0 to http://hl7.org/fhir/ValueSet/messageheader-response-request|4.5.0

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 3 tests that all execute ok. All tests pass round-trip testing and 2 r3 resources are invalid (0 errors).)

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis a

2.51.3.1 Terminology Bindings

PathDefinitionTypeReference
MessageDefinition.status The lifecycle status of an artifact.RequiredPublicationStatus
MessageDefinition.jurisdiction Countries and regions within which this artifact is targeted for use.ExtensibleJurisdiction ValueSet
MessageDefinition.event[x] One of the message events defined as part of this version 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 this version of FHIR.RequiredResource Types
MessageDefinition.responseRequired HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message.Requiredmessageheader-response-request

2.51.3.2 Constraints

idLevelLocationDescriptionExpression
cnl-0Warning (base)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}')
md-1Rule MessageDefinition.focusMax must be postive int or *max='*' or (max.toInteger() > 0)

2.51.4 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
category NtokenThe behavior associated with the messageMessageDefinition.category
contexttokenA use context assigned to the message definition(MessageDefinition.useContext.value as CodeableConcept)
context-quantityquantityA quantity- or range-valued use context assigned to the message definition(MessageDefinition.useContext.value as Quantity) | (MessageDefinition.useContext.value as Range)
context-typetokenA type of use context assigned to the message definitionMessageDefinition.useContext.code
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the message definitionOn MessageDefinition.useContext:
  context-type: code
  context-quantity: value.as(Quantity) | value.as(Range)
context-type-valuecompositeA use context type and value assigned to the message definitionOn MessageDefinition.useContext:
  context-type: code
  context: value.as(CodeableConcept)
date NdateThe message definition publication dateMessageDefinition.date
description NstringThe description of the message definitionMessageDefinition.description
eventtokenThe event that triggers the message or link to the event definition.MessageDefinition.event
focus NtokenA 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
name NstringComputationally friendly name of the message definitionMessageDefinition.name
parent NreferenceA resource that is the parent of the definitionMessageDefinition.parent
(PlanDefinition, ActivityDefinition)
publisher NstringName of the publisher of the message definitionMessageDefinition.publisher
status NtokenThe current status of the message definitionMessageDefinition.status
title NstringThe human-friendly name of the message definitionMessageDefinition.title
url NuriThe uri that identifies the message definitionMessageDefinition.url
version NtokenThe business version of the message definitionMessageDefinition.version