MessageDefinition - FHIR Resource (stu3)
This MessageDefinition Resource uses the
FHIR API standard for access and structure.
Validate an MessageDefinition FHIR Resource (stu3)
Resource Attributes
Attribute | Field is list | Type | Description |
---|
allowedResponse | true | Data Type | # Responses to this message
|
base | false | Reference | # Definition this one is based on
|
category | false | code | # Consequence | Currency | Notification
|
contact | true | ContactDetail | # Contact details for the publisher
|
copyright | false | markdown | # Use and/or publishing restrictions
|
date | false | dateTime | # Date this was last changed
|
description | false | markdown | # Natural language description of the message definition
|
event | false | Coding | # Event type
|
experimental | false | boolean | # For testing purposes, not real usage
|
focus | true | Data Type | # Resource(s) that are the subject of the event
|
identifier | false | Identifier | # Additional identifier for the message definition
|
jurisdiction | true | CodeableConcept | # Intended jurisdiction for message definition (if applicable)
|
name | false | string | # Name for this message definition (computer friendly)
|
parent | true | Reference | # Protocol/workflow this is part of
|
publisher | false | string | # Name of the publisher (organization or individual)
|
purpose | false | markdown | # Why this message definition is defined
|
replaces | true | Reference | # Takes the place of
|
responseRequired | false | boolean | # Is a response required?
|
status | false | code | # draft | active | retired | unknown
|
title | false | string | # Name for this message definition (human friendly)
|
url | false | uri | # Logical URI to reference this message definition (globally unique)
|
useContext | true | UsageContext | # Context the content is intended to support
|
version | false | string | # Business version of the message definition
|
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 the 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 |