MessageDefinition - FHIR Resource (r4)
This MessageDefinition Resource uses the
FHIR API standard for access and structure.
Validate an MessageDefinition FHIR Resource (r4)
Resource Attributes
Attribute | Field is list | Type | Description |
---|
allowedResponse | true | Data Type | # Responses to this message |
base | false | canonical(MessageDefinition) | # 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 last changed |
description | false | markdown | # Natural language description of the message definition |
event[x] | false | Coding|uri | #undefined |
experimental | false | boolean | # For testing purposes, not real usage |
focus | true | Data Type | # Resource(s) that are the subject of the event |
graph | true | canonical(GraphDefinition) | # Canonical reference to a GraphDefinition |
identifier | true | Identifier | # Primary key for the message definition on a given server |
jurisdiction | true | CodeableConcept | # Intended jurisdiction for message definition (if applicable) |
name | false | string | # C? Name for this message definition (computer friendly) |
parent | true | canonical(ActivityDefinition | PlanDefinition) | # 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 | canonical(MessageDefinition) | # Takes the place of |
responseRequired | false | code | # always | on-error | never | on-success |
status | false | code | # draft | active | retired | unknown |
title | false | string | # Name for this message definition (human friendly) |
url | false | uri | # Business Identifier for a given MessageDefinition |
useContext | true | UsageContext | # The context that the content is intended to support |
version | false | string | # Business version of the message definition |
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 |