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.
Endpoints
alpha
https://api.dev.ovok.com/fhir/R4/MessageDefinition| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/MessageDefinition/[id] |
| Vread | GET | /fhir/R4/MessageDefinition/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/MessageDefinition/[id] |
| Patch | PATCH | /fhir/R4/MessageDefinition/[id] |
| Delete | DELETE | /fhir/R4/MessageDefinition/[id] |
| Create | POST | /fhir/R4/MessageDefinition |
| Search | GET | /fhir/R4/MessageDefinition |
| History | GET | /fhir/R4/MessageDefinition/[id]/_history |
Top-level elements
| Element | Type(s) | Cardinality | Description |
|---|---|---|---|
url | uri | 0..1 | Business Identifier for a given MessageDefinition |
identifier | Identifier | 0..* | Primary key for the message definition on a given server |
version | string | 0..1 | Business version of the message definition |
name | string | 0..1 | Name for this message definition (computer friendly) |
title | string | 0..1 | Name for this message definition (human friendly) |
replaces | canonical | 0..* | Takes the place of |
status | code | 1..1 | draft | active | retired | unknown modifier |
experimental | boolean | 0..1 | For testing purposes, not real usage |
date | dateTime | 1..1 | Date last changed |
publisher | string | 0..1 | Name of the publisher (organization or individual) |
contact | ContactDetail | 0..* | Contact details for the publisher |
description | markdown | 0..1 | Natural language description of the message definition |
useContext | UsageContext | 0..* | The context that the content is intended to support |
jurisdiction | CodeableConcept | 0..* | Intended jurisdiction for message definition (if applicable) |
purpose | markdown | 0..1 | Why this message definition is defined |
copyright | markdown | 0..1 | Use and/or publishing restrictions |
base | canonical | 0..1 | Definition this one is based on |
parent | canonical | 0..* | Protocol/workflow this is part of |
event[x] | Coding / uri | 1..1 | Event code or link to the EventDefinition |
category | code | 0..1 | consequence | currency | notification |
focus | BackboneElement | 0..* | Resource(s) that are the subject of the event |
responseRequired | code | 0..1 | always | on-error | never | on-success |
allowedResponse | BackboneElement | 0..* | Responses to this message |
graph | canonical | 0..* | Canonical reference to a GraphDefinition |
Resource-specific search parameters
Reference
- Official FHIR R4 spec:
MessageDefinition - Maturity: Trial Use 1 (FMM 1).