MessageDefinition
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.
- Backends
- PostgreSQLElasticsearch
- Interactions
- CreateReadUpdatePatchDelete
- Search
- 17 of 19 parameters tested
Structure
| Element | Card. | Type | Description |
|---|---|---|---|
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(MessageDefinition) | Takes the place of |
statusRequired?!Σ | 1..1 | code | draft | active | retired | unknownBinding (required): publication-status |
experimentalΣ | 0..1 | boolean | For testing purposes, not real usage |
dateRequiredΣ | 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)Binding (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(MessageDefinition) | Definition this one is based on |
parentΣ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Protocol/workflow this is part of |
event[x]RequiredΣ | 1..1 | Coding | uri | Event code or link to the EventDefinitionBinding (example): message-events |
categoryΣ | 0..1 | code | consequence | currency | notificationBinding (required): message-significance-category |
focusΣ | 0..* | BackboneElement | Resource(s) that are the subject of the event |
codeRequiredΣ | 1..1 | code | Type of resourceBinding (required): resource-types |
profile | 0..1 | canonical(StructureDefinition) | Profile that must be adhered to by focus |
minRequiredΣ | 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-successBinding (required): messageheader-response-request |
allowedResponse | 0..* | BackboneElement | Responses to this message |
messageRequired | 1..1 | canonical(MessageDefinition) | Reference to allowed message definition response |
situation | 0..1 | markdown | When should this response be used |
graph | 0..* | canonical(GraphDefinition) | Canonical reference to a GraphDefinition |
Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey
Search parameters
Query with GET [base]/MessageDefinition?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.
| Parameter | Type | Description | PG | ES |
|---|---|---|---|---|
category | token | The behavior associated with the message MessageDefinition.category | ||
context | token | A use context assigned to the message definition (MessageDefinition.useContext.value.ofType(CodeableConcept)) | ||
context-quantity | quantity | A quantity- or range-valued use context assigned to the message definition (MessageDefinition.useContext.value.ofType(Quantity)) | (MessageDefinition.useContext.value.ofType(Range)) | ||
context-type | token | A type of use context assigned to the message definition MessageDefinition.useContext.code | ||
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the message definition MessageDefinition.useContext | ||
context-type-value | composite | A use context type and value assigned to the message definition MessageDefinition.useContext | ||
date | date | The message definition publication date MessageDefinition.date | ||
description | string | The description of the message definition MessageDefinition.description | ||
event | token | The event that triggers the message or link to the event definition. MessageDefinition.event | ||
focus | token | A resource that is a permitted focus of the message MessageDefinition.focus.code | ||
identifier | token | External identifier for the message definition MessageDefinition.identifier | ||
jurisdiction | token | Intended jurisdiction for the message definition MessageDefinition.jurisdiction | ||
name | string | Computationally friendly name of the message definition MessageDefinition.name | ||
parent | reference | A resource that is the parent of the definition MessageDefinition.parent | ||
publisher | string | Name of the publisher of the message definition MessageDefinition.publisher | ||
status | token | The current status of the message definition MessageDefinition.status | ||
title | string | The human-friendly name of the message definition MessageDefinition.title | ||
url | uri | The uri that identifies the message definition MessageDefinition.url | ||
version | token | The business version of the message definition MessageDefinition.version |
PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet. The author of the resource Logical id of this artifact When the resource version last changed Profiles this resource claims to conform to Security Labels applied to this resource Identifies where the resource comes from Tags applied to this resource Derived from the R4B DefinitionCommon parameters on every resource (8)
_haste-health-authorreference _idtoken _lastUpdateddate _profileuri _securitytoken _sourceuri _tagtoken _typetoken