MessageDefinition - FHIR Resource (r4)

This MessageDefinition Resource uses the FHIR API standard for access and structure.

Validate an MessageDefinition FHIR Resource (r4)

MessageDefinition Attributes

AttributeField is listTypeDescription

Description: Business Identifier for a given MessageDefinition

FHIR Version: r4

Attribute Type : uri

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"url": "http://hl7.org/fhir/MessageDefinition/example"

Learn more about the (MessageDefinition) url FHIR attribute

Description: Primary key for the message definition on a given server

FHIR Version: r4

Attribute Type : Identifier

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier":

Learn more about the (MessageDefinition) identifier FHIR attribute

Description: Business version of the message definition

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"version":

Learn more about the (MessageDefinition) version FHIR attribute

Description: C? Name for this message definition (computer friendly)

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"name": "EXAMPLE"

Learn more about the (MessageDefinition) name FHIR attribute

Description: Name for this message definition (human friendly)

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"title": "Message definition base example"

Learn more about the (MessageDefinition) title FHIR attribute

Description: Takes the place of

FHIR Version: r4

Attribute Type : canonical(MessageDefinition)

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"replaces":

Learn more about the (MessageDefinition) replaces FHIR attribute

Description: draft | active | retired | unknown

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"status": "draft"

Learn more about the (MessageDefinition) status FHIR attribute

Description: For testing purposes, not real usage

FHIR Version: r4

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"experimental": true

Learn more about the (MessageDefinition) experimental FHIR attribute

Description: Date last changed

FHIR Version: r4

Attribute Type : dateTime

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"date": "2016-11-09"

Learn more about the (MessageDefinition) date FHIR attribute

Description: Name of the publisher (organization or individual)

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"publisher": "Health Level Seven, Int'l"

Learn more about the (MessageDefinition) publisher FHIR attribute

Description: Contact details for the publisher

FHIR Version: r4

Attribute Type : ContactDetail

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"contact": [
  {
    "telecom": [
      {
        "system": "url",
        "value": "http://hl7.org"
      }
    ]
  }
]

Learn more about the (MessageDefinition) contact FHIR attribute

Description: Natural language description of the message definition

FHIR Version: r4

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"description":

Learn more about the (MessageDefinition) description FHIR attribute

Description: The context that the content is intended to support

FHIR Version: r4

Attribute Type : UsageContext

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"useContext":

Learn more about the (MessageDefinition) useContext FHIR attribute

Description: Intended jurisdiction for message definition (if applicable)

FHIR Version: r4

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"jurisdiction":

Learn more about the (MessageDefinition) jurisdiction FHIR attribute

Description: Why this message definition is defined

FHIR Version: r4

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"purpose": "Defines a base example for other MessageDefinition instances."

Learn more about the (MessageDefinition) purpose FHIR attribute

Description: Use and/or publishing restrictions

FHIR Version: r4

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"copyright":

Learn more about the (MessageDefinition) copyright FHIR attribute

Description: Definition this one is based on

FHIR Version: r4

Attribute Type : canonical(MessageDefinition)

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"base":

Learn more about the (MessageDefinition) base FHIR attribute

Description: Protocol/workflow this is part of

FHIR Version: r4

Attribute Type : canonical(ActivityDefinition | PlanDefinition)

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"parent":

Learn more about the (MessageDefinition) parent FHIR attribute

Description:

FHIR Version: r4

Attribute Type : Coding|uri

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"event[x]":

Learn more about the (MessageDefinition) event[x] FHIR attribute

Description: consequence | currency | notification

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"category": "notification"

Learn more about the (MessageDefinition) category FHIR attribute

Description: Resource(s) that are the subject of the event

FHIR Version: r4

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"focus":

Learn more about the (MessageDefinition) focus FHIR attribute

Description: always | on-error | never | on-success

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"responseRequired":

Learn more about the (MessageDefinition) responseRequired FHIR attribute

Description: Responses to this message

FHIR Version: r4

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"allowedResponse":

Learn more about the (MessageDefinition) allowedResponse FHIR attribute

Description: Canonical reference to a GraphDefinition

FHIR Version: r4

Attribute Type : canonical(GraphDefinition)

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"graph":

Learn more about the (MessageDefinition) graph FHIR attribute

MessageDefinition Example

{
  "resourceType": "MessageDefinition",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Message definition base example</div>"
  },
  "url": "http://hl7.org/fhir/MessageDefinition/example",
  "name": "EXAMPLE",
  "title": "Message definition base example",
  "status": "draft",
  "experimental": true,
  "date": "2016-11-09",
  "publisher": "Health Level Seven, Int'l",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org"
        }
      ]
    }
  ],
  "purpose": "Defines a base example for other MessageDefinition instances.",
  "eventCoding": {
    "system": "http://example.org/fhir/message-events",
    "code": "admin-notify"
  },
  "category": "notification"
}

MessageDefinition Structure

{
  "resourceType" : "MessageDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "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
}

MessageDefinition Search Parameters

The following search parameters can be used to query MessageDefinition resources. Just submit them like so:

https://api.1up.health/fhir/r4/MessageDefinition?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`category`	`text`	`category`
`context`	`text`	`useContext.value`
`context-quantity`	`quantity`	`useContext.value`
`context-type`	`text`	`useContext.code`
`context-type-quantity`	`composite`	`useContext`
`context-type-value`	`composite`	`useContext`
`date`	`date`	`date`
`description`	`text`	`description`
`event`	`text`	`event`
`focus`	`text`	`focus.code`
`identifier`	`text`	`identifier`
`jurisdiction`	`text`	`jurisdiction`
`name`	`text`	`name`
`parent`	`reference`	`parent`
`publisher`	`text`	`publisher`
`status`	`text`	`status`
`title`	`text`	`title`
`url`	`uri`	`url`
`version`	`text`	`version`