MessageDefinition - FHIR Resource (stu3)


Resource Attributes

AttributeField is listTypeDescription
allowedResponsetrueData Type Responses to this message
basefalseReference Definition this one is based on
categoryfalsecode Consequence | Currency | Notification
contacttrueContactDetail Contact details for the publisher
copyrightfalsemarkdown Use and/or publishing restrictions
datefalsedateTime Date this was last changed
descriptionfalsemarkdown Natural language description of the message definition
eventfalseCoding Event type
experimentalfalseboolean For testing purposes, not real usage
focustrueData Type Resource(s) that are the subject of the event
identifierfalseIdentifier Additional identifier for the message definition
jurisdictiontrueCodeableConcept Intended jurisdiction for message definition (if applicable)
namefalsestring Name for this message definition (computer friendly)
parenttrueReference Protocol/workflow this is part of
publisherfalsestring Name of the publisher (organization or individual)
purposefalsemarkdown Why this message definition is defined
replacestrueReference Takes the place of
responseRequiredfalseboolean Is a response required?
statusfalsecode draft | active | retired | unknown
titlefalsestring Name for this message definition (human friendly)
urlfalseuri Logical URI to reference this message definition (globally unique)
useContexttrueUsageContext Context the content is intended to support
versionfalsestring Business version of the message definition

MessageDefinition Example

{
  "status": "draft",
  "publisher": "Health Level Seven, Int'l",
  "name": "EXAMPLE",
  "title": "Message definition base example",
  "resourceType": "MessageDefinition",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Message definition base example</div>"
  },
  "event": {
    "code": "communication-request",
    "system": "http://hl7.org/fhir/message-events"
  },
  "url": "http://hl7.org/fhir/MessageDefinition/example",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org"
        }
      ]
    }
  ],
  "purpose": "Defines a base example for other MessageDefintion instances.",
  "responseRequired": false,
  "date": "2016-11-09",
  "category": "Notification",
  "id": "example",
  "experimental": true
}

MessageDefinition Structure


  
{
  "resourceType" : "MessageDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Logical URI to reference this message definition (globally unique)
  "identifier" : { Identifier }, // Additional identifier for the message definition
  "version" : "<string>", // Business version of the message definition
  "name" : "<string>", // Name for this message definition (computer friendly)
  "title" : "<string>", // Name for this message definition (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // R!  Date this was 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 }], // Context 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" : { Reference(MessageDefinition) }, // Definition this one is based on
  "parent" : [{ Reference(ActivityDefinition|PlanDefinition) }], // Protocol/workflow this is part of
  "replaces" : [{ Reference(MessageDefinition) }], // Takes the place of
  "event" : { Coding }, // R!  Event type
  "category" : "<code>", // Consequence | Currency | Notification
  "focus" : [{ // Resource(s) that are the subject of the event
    "code" : "<code>", // R!  Type of resource
    "profile" : { Reference(StructureDefinition) }, // Profile that must be adhered to by focus
    "min" : "<unsignedInt>", // Minimum number of focuses of this type
    "max" : "<string>" // C? Maximum number of focuses of this type
  }],
  "responseRequired" : <boolean>, // Is a response required?
  "allowedResponse" : [{ // Responses to this message
    "message" : { Reference(MessageDefinition) }, // R!  Reference to allowed message definition response
    "situation" : "<markdown>" // When should this response be used
  }]
}


 

MessageDefinition Search Parameters

The following search parameters can be used to query MessageDefinition resources. Just submit the like so:

https://api.1up.health/fhir/stu3/MessageDefinition?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
categorytextcategory
datedatedate
descriptiontextdescription
eventtextevent
focustextfocus.code
identifiertextidentifier
jurisdictiontextjurisdiction
nametextname
publishertextpublisher
statustextstatus
titletexttitle
urluriurl
versiontextversion