MessageDefinition - FHIR Resource (stu3)

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

Validate an MessageDefinition FHIR Resource (stu3)

MessageDefinition Attributes

AttributeField is listTypeDescription

Description: Responses to this message

FHIR Version: stu3

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: Intended jurisdiction for message definition (if applicable)

FHIR Version: stu3

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: Resource(s) that are the subject of the event

FHIR Version: stu3

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: Event type

FHIR Version: stu3

Attribute Type : Coding

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"event": {
  "code": "communication-request",
  "system": "http://hl7.org/fhir/message-events"
}

Learn more about the (MessageDefinition) event FHIR attribute

Description: Consequence | Currency | Notification

FHIR Version: stu3

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: Use and/or publishing restrictions

FHIR Version: stu3

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: Name for this message definition (human friendly)

FHIR Version: stu3

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: Business version of the message definition

FHIR Version: stu3

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: draft | active | retired | unknown

FHIR Version: stu3

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: Natural language description of the message definition

FHIR Version: stu3

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: Protocol/workflow this is part of

FHIR Version: stu3

Attribute Type : Reference

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: Definition this one is based on

FHIR Version: stu3

Attribute Type : Reference

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: Context the content is intended to support

FHIR Version: stu3

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: Why this message definition is defined

FHIR Version: stu3

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 MessageDefintion instances."

Learn more about the (MessageDefinition) purpose FHIR attribute

Description: Date this was last changed

FHIR Version: stu3

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: stu3

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: Takes the place of

FHIR Version: stu3

Attribute Type : Reference

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: Name for this message definition (computer friendly)

FHIR Version: stu3

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: Logical URI to reference this message definition (globally unique)

FHIR Version: stu3

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: Contact details for the publisher

FHIR Version: stu3

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: For testing purposes, not real usage

FHIR Version: stu3

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: Additional identifier for the message definition

FHIR Version: stu3

Attribute Type : Identifier

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier":

Learn more about the (MessageDefinition) identifier FHIR attribute

Description: Is a response required?

FHIR Version: stu3

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"responseRequired": false

Learn more about the (MessageDefinition) responseRequired FHIR attribute

MessageDefinition Example

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

MessageDefinition Structure


  
{
  "resourceType" : "MessageDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Logical URI to reference this message definition (globally unique)
  "identifier" : { Identifier }, // Additional identifier for the message definition
  "version" : "<string>", // Business version of the message definition
  "name" : "<string>", // Name for this message definition (computer friendly)
  "title" : "<string>", // Name for this message definition (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // R!  Date this was 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 }], // Context 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" : { Reference(MessageDefinition) }, // Definition this one is based on
  "parent" : [{ Reference(ActivityDefinition|PlanDefinition) }], // Protocol/workflow this is part of
  "replaces" : [{ Reference(MessageDefinition) }], // Takes the place of
  "event" : { Coding }, // R!  Event type
  "category" : "<code>", // Consequence | Currency | Notification
  "focus" : [{ // Resource(s) that are the subject of the event
    "code" : "<code>", // R!  Type of resource
    "profile" : { Reference(StructureDefinition) }, // Profile that must be adhered to by focus
    "min" : "<unsignedInt>", // Minimum number of focuses of this type
    "max" : "<string>" // C? Maximum number of focuses of this type
  }],
  "responseRequired" : <boolean>, // Is a response required?
  "allowedResponse" : [{ // Responses to this message
    "message" : { Reference(MessageDefinition) }, // R!  Reference to allowed message definition response
    "situation" : "<markdown>" // When should this response be used
  }]
}

MessageDefinition Search Parameters

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

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

Search Parameter	Field Type	Resource Fields Searched
`category`	`text`	`category`
`date`	`date`	`date`
`description`	`text`	`description`
`event`	`text`	`event`
`focus`	`text`	`focus.code`
`identifier`	`text`	`identifier`
`jurisdiction`	`text`	`jurisdiction`
`name`	`text`	`name`
`publisher`	`text`	`publisher`
`status`	`text`	`status`
`title`	`text`	`title`
`url`	`uri`	`url`
`version`	`text`	`version`