Skip to main content

MessageDefinition

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.

Properties

NameCardTypeDescription
id0..1stringLogical id of this artifact
meta0..1MetaMetadata about the resource
implicitRules0..1uriA set of rules under which this content was created
language0..1codeLanguage of the resource content
text0..1NarrativeText summary of the resource, for human interpretation
contained0..*ResourceContained, inline Resources
extension0..*ExtensionAdditional content defined by implementations
modifierExtension0..*ExtensionExtensions that cannot be ignored
url0..1uriBusiness Identifier for a given MessageDefinition
identifier0..*IdentifierPrimary key for the message definition on a given server
version0..1stringBusiness version of the message definition
name0..1stringName for this message definition (computer friendly)
title0..1stringName for this message definition (human friendly)
replaces0..*canonicalTakes the place of
status1..1codedraft | active | retired | unknown
experimental0..1booleanFor testing purposes, not real usage
date1..1dateTimeDate last changed
publisher0..1stringName of the publisher (organization or individual)
contact0..*ContactDetailContact details for the publisher
description0..1markdownNatural language description of the message definition
useContext0..*UsageContextThe context that the content is intended to support
jurisdiction0..*CodeableConceptIntended jurisdiction for message definition (if applicable)
purpose0..1markdownWhy this message definition is defined
copyright0..1markdownUse and/or publishing restrictions
base0..1canonicalDefinition this one is based on
parent0..*canonicalProtocol/workflow this is part of
event[x]1..1CodingEvent code or link to the EventDefinition
category0..1codeconsequence | currency | notification
focus0..*BackboneElementResource(s) that are the subject of the event
responseRequired0..1codealways | on-error | never | on-success
allowedResponse0..*BackboneElementResponses to this message
graph0..*canonicalCanonical reference to a GraphDefinition

Search Parameters

NameTypeDescriptionExpression
contexttokenA use context assigned to the message definitionMessageDefinition.useContext.value
context-quantityquantityA quantity- or range-valued use context assigned to the message definitionMessageDefinition.useContext.value
context-typetokenA type of use context assigned to the message definitionMessageDefinition.useContext.code
datedateThe message definition publication dateMessageDefinition.date
descriptionstringThe description of the message definitionMessageDefinition.description
jurisdictiontokenIntended jurisdiction for the message definitionMessageDefinition.jurisdiction
namestringComputationally friendly name of the message definitionMessageDefinition.name
publisherstringName of the publisher of the message definitionMessageDefinition.publisher
statustokenThe current status of the message definitionMessageDefinition.status
titlestringThe human-friendly name of the message definitionMessageDefinition.title
urluriThe uri that identifies the message definitionMessageDefinition.url
versiontokenThe business version of the message definitionMessageDefinition.version
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the message definitionMessageDefinition.useContext
context-type-valuecompositeA use context type and value assigned to the message definitionMessageDefinition.useContext
identifiertokenExternal identifier for the message definitionMessageDefinition.identifier
categorytokenThe behavior associated with the messageMessageDefinition.category
eventtokenThe event that triggers the message or link to the event definition.MessageDefinition.event
focustokenA resource that is a permitted focus of the messageMessageDefinition.focus.code
parentreferenceA resource that is the parent of the definitionMessageDefinition.parent