MessageDefinition
MessageDefinition
draftResource45 elementsv4.0.1
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.
Metadata
hl7.org/fhir- Canonical URL
- http://hl7.org/fhir/StructureDefinition/MessageDefinition
- ID
- MessageDefinition
- Type
- Base Definition
- Derivation
- specialization
- Publisher
- Health Level Seven International (Infrastructure And Messaging)
- Version
- 4.0.1
- Purpose
- Allows messages to be defined once and re-used across systems.
| Path | Card. | Type | Description |
|---|---|---|---|
MessageDefinition | 0..* | A resource that defines a type of message that can be exchanged between systems | |
id | 0..1 | string | Logical id of this artifact |
meta | 0..1 | Metadata about the resource | |
implicitRules | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource contentpreferred: languages |
text | 0..1 | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources |
extension | 0..* | Additional content defined by implementations | |
modifierExtension | 0..* | Extensions that cannot be ignored | |
url | 0..1 | uri | Business Identifier for a given MessageDefinition |
identifier | 0..* | Primary key for the message definition on a given server | |
version | 0..1 | string | Business version of the message definition |
name | 0..1 | string | Name for this message definition (computer friendly) |
title | 0..1 | string | Name for this message definition (human friendly) |
replaces | 0..* | canonical | Takes the place of |
status | 1..1 | code | draft | active | retired | unknownrequired: publication-status |
experimental | 0..1 | boolean | For testing purposes, not real usage |
date | 1..1 | dateTime | Date last changed |
publisher | 0..1 | string | Name of the publisher (organization or individual) |
contact | 0..* | Contact details for the publisher | |
description | 0..1 | markdown | Natural language description of the message definition |
useContext | 0..* | The context that the content is intended to support | |
jurisdiction | 0..* | Intended jurisdiction for message definition (if applicable)extensible: jurisdiction | |
purpose | 0..1 | markdown | Why this message definition is defined |
copyright | 0..1 | markdown | Use and/or publishing restrictions |
base | 0..1 | canonical | Definition this one is based on |
parent | 0..* | canonical | Protocol/workflow this is part of |
event[x] | 1..1 | Codinguri | Event code or link to the EventDefinitionexample: message-events |
category | 0..1 | code | consequence | currency | notificationrequired: message-significance-category |
focus | 0..* | BackboneElement | Resource(s) that are the subject of the event |
responseRequired | 0..1 | code | always | on-error | never | on-successrequired: messageheader-response-request |
allowedResponse | 0..* | BackboneElement | Responses to this message |
graph | 0..* | canonical | Canonical reference to a GraphDefinition |