MessageDefinition

Trial Use 1 Conformance

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.

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/MessageDefinition

Interaction	Method	Path
Read	GET	/fhir/R5/MessageDefinition/[id]
Vread	GET	/fhir/R5/MessageDefinition/[id]/_history/[vid]
Update	PUT	/fhir/R5/MessageDefinition/[id]
Patch	PATCH	/fhir/R5/MessageDefinition/[id]
Delete	DELETE	/fhir/R5/MessageDefinition/[id]
Create	POST	/fhir/R5/MessageDefinition
Search	GET	/fhir/R5/MessageDefinition?...
History	GET	/fhir/R5/MessageDefinition/[id]/_history
Type-history	GET	/fhir/R5/MessageDefinition/_history

Top-level elements

Element	Type(s)	Cardinality	Description
url	uri	0..1	The cannonical URL for a given MessageDefinition
identifier	Identifier	0..*	Business Identifier for a given MessageDefinition
version	string	0..1	Business version of the message definition
versionAlgorithm[x]	string / Coding	0..1	How to compare versions
name	string	0..1	Name for this message definition (computer friendly)
title	string	0..1	Name for this message definition (human friendly)
replaces	canonical	0..*	Takes the place of
status	code	1..1	draft
experimental	boolean	0..1	For testing purposes, not real usage
date	dateTime	1..1	Date last changed
publisher	string	0..1	Name of the publisher/steward (organization or individual)
contact	ContactDetail	0..*	Contact details for the publisher
description	markdown	0..1	Natural language description of the message definition
useContext	UsageContext	0..*	The context that the content is intended to support
jurisdiction	CodeableConcept	0..*	Intended jurisdiction for message definition (if applicable)
purpose	markdown	0..1	Why this message definition is defined
copyright	markdown	0..1	Use and/or publishing restrictions
copyrightLabel	string	0..1	Copyright holder and year(s)
base	canonical	0..1	Definition this one is based on
parent	canonical	0..*	Protocol/workflow this is part of
event[x]	Coding / uri	1..1	Event code or link to the EventDefinition
category	code	0..1	consequence
focus	BackboneElement	0..*	Resource(s) that are the subject of the event
responseRequired	code	0..1	always
allowedResponse	BackboneElement	0..*	Responses to this message
graph	canonical	0..1	Canonical reference to a GraphDefinition

Resource-specific search parameters

Parameter	Type	Description
category	token	The behavior associated with the message
context	token	A use context assigned to the activity definition
context-quantity	quantity	A quantity- or range-valued use context assigned to the activity definition
context-type	token	A type of use context assigned to the activity definition
context-type-quantity	composite	A use context type and quantity- or range-based value assigned to the activity definition
context-type-value	composite	A use context type and value assigned to the activity definition
date	date	The activity definition publication date
description	string	The description of the activity definition
event	token	The event that triggers the message or link to the event definition.
focus	token	A resource that is a permitted focus of the message
identifier	token	External identifier for the activity definition
jurisdiction	token	Intended jurisdiction for the activity definition
name	string	Computationally friendly name of the activity definition
parent	reference	A resource that is the parent of the definition
publisher	string	Name of the publisher of the activity definition
status	token	The current status of the activity definition
title	string	The human-friendly name of the activity definition
url	uri	The uri that identifies the activity definition
version	token	The business version of the activity definition

Reference

• Official FHIR R5 spec: MessageDefinition
• Maturity: Trial Use 1 (FMM 1).