MessageDefinition
FoundationDefines 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.
| Path | Card. | Type | Description & Constraints |
|---|---|---|---|
| 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 | Meta | 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 content Bindinglanguages(preferred) |
| .text | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| .contained | 0..* | Resource | Contained, inline Resources |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?! | 0..* | Extension | Extensions that cannot be ignored |
| .urlΣ | 0..1 | uri | Business Identifier for a given MessageDefinition |
| .identifierΣ | 0..* | Identifier | 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 | unknown Bindingpublication-status(required) |
| .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..* | ContactDetail | Contact details for the publisher |
| .descriptionΣ | 0..1 | markdown | Natural language description of the message definition |
| .useContextΣ | 0..* | UsageContext | The context that the content is intended to support |
| .jurisdictionΣ | 0..* | CodeableConcept | Intended jurisdiction for message definition (if applicable) Bindingjurisdiction(extensible) |
| .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 | Coding | uri | Event code or link to the EventDefinition Bindingmessage-events(example) |
| .categoryΣ | 0..1 | code | consequence | currency | notification Bindingmessage-significance-category(required) |
| .focusΣ | 0..* | BackboneElement | Resource(s) that are the subject of the event |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .codeΣ | 1..1 | code | Type of resource Bindingresource-types(required) |
| .profile | 0..1 | canonical | Profile that must be adhered to by focus |
| .minΣ | 1..1 | unsignedInt | Minimum number of focuses of this type |
| .max | 0..1 | string | Maximum number of focuses of this type |
| .responseRequired | 0..1 | code | always | on-error | never | on-success Bindingmessageheader-response-request(required) |
| .allowedResponse | 0..* | BackboneElement | Responses to this message |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .message | 1..1 | canonical | Reference to allowed message definition response |
| .situation | 0..1 | markdown | When should this response be used |
| .graph | 0..* | canonical | Canonical reference to a GraphDefinition |