This page is part of the FHIR Specification (v0.01: Historical Archive Draft). The current version which supercedes this version is 4.0.1. For a full list of available versions, see the Directory of published versions

# MessageConformance

A conformance statement about how an application uses FHIR messaging.

The relative url is /messageconformances

## Content

    <MessageConformance xmlns="http://www.hl7.org/fhir">
      <id> mand id ConformanceStatement Id (UUID)</id>
      <date> mand dateTime Publication Date</date>
      <publisher> mand
       <name> mand string Publishing Organization</name>
       <address> opt Zero+ Address Address of Organization</address>
       <contact> opt Zero+ Contact Contacts for Organization</contact>
      </publisher>
      <software> mand
       <name> mand string Name software is known by</name>
       <version> mand string Version covered by this statement</version>
       <releaseDate> opt dateTime Date this version released</releaseDate>
      </software>
      <profile> opt Zero+ uri other profiles that apply (i.e. code binding rules)</profile>
      <event> mand  <!-- One+ -->
       <code> mand code Declare support for this event</code>
       <resource> cond code Which resource if event has multiple</resource>
       <mode> mand code Sender | Receiver</mode>
       <request> opt
        <resource> mand One+ Constraint Constraint on a resource used in request</resource>
       </request>
       <response> opt
        <resource> mand One+ Constraint Constraint on a resource used in response</resource>
       </response>
      </event>
      <extensions> opt See Extensions   See Extensions </extensions>
      <text> mand Narrative Text summary of conformance statement for human interpretation</text>
    </MessageConformance>

Schema for MessageConformance and an example (or formatted for browser)

Terminology Bindings

- MessageConformance.event.code is bound to the concept domain MessageEvent which has the allowed values defined for Event List in the messaging framework
- MessageConformance.event.resource is bound to the concept domain ResourceType which has the allowed values of any defined Resource Type name
- MessageConformance.event.mode is bound to the concept domain MessageConformanceEventMode: "The mode of a message conformance statement". Possible values:

  sender | The application sends requests and receives responses
  receiver | The application receives requests and sends responses

Notes:

- The MessageConformance resource is a special case; it is only defined for the conformance framework, and is not encountered in other contexts
- The interpretation of request and resource depends on the mode. If the mode is sender, then request specifies what the application sends, and response specifies what it accepts. If the mode is "listener", then this is reversed
- If a request or response is not specified for an event, then no rules are made for it
- Events that are not listed are not supported

## Formal Definitions

The formal definitions for the elements above. Also available as an XML file

MessageConformance
Definition | A conformance statement about how an application uses FHIR messaging
Control | Mandatory, 1..1
MessageConformance.id
Definition | Globally unique Conformance Statement Id (Must be a UUID)
Control | Mandatory, 1..1
Type | id
MessageConformance.date
Definition | Date that the conformance statement is published
Control | Mandatory, 1..1
Type | dateTime
MessageConformance.publisher
Definition | The organization that publishes this conformance statement
Control | Mandatory, 1..1
MessageConformance.publisher.name
Definition | Name of Organization
Control | Mandatory, 1..1
Type | string
MessageConformance.publisher.address
Definition | Address of Organization
Control | Optional, 0..*
Type | Address
MessageConformance.publisher.contact
Definition | Contacts for Organization
Control | Optional, 0..*
Type | Contact
MessageConformance.software
Definition | The software that is covered by this conformance statement
Control | Mandatory, 1..1
MessageConformance.software.name
Definition | Name software is known by
Control | Mandatory, 1..1
Type | string
MessageConformance.software.version
Definition | Version covered by this statement
Control | Mandatory, 1..1
Type | string
MessageConformance.software.releaseDate
Definition | Date this version released
Control | Optional, 0..1
Type | dateTime
MessageConformance.profile
Definition | Additional other profiles that apply to this conformance statement.
Control | Optional, 0..*
Type | uri
Comments | Generally these profiles make constraints on the bindings of concept domains / value sets
MessageConformance.event
Definition | An event supported by the application
Control | Mandatory, 1..*
MessageConformance.event.code
Definition | The code for the event
Control | Mandatory, 1..1
Type | code from MessageEvent
MessageConformance.event.resource
Definition | The focal resource for the event
Control | Conditional, 0..1: A resource type is required if the event declaration has multiple focal resources
Type | code from ResourceType
MessageConformance.event.mode
Definition | The mode of this event declaration - whether application is sender or receiver
Control | Mandatory, 1..1
Type | code from MessageConformanceEventMode
MessageConformance.event.request
Definition | Information about the request for this event
Control | Optional, 0..1
MessageConformance.event.request.resource
Definition | Constraint on a resource used in the event request
Control | Mandatory, 1..*
Type | Constraint
MessageConformance.event.response
Definition | Information about the response for this event
Control | Optional, 0..1
MessageConformance.event.response.resource
Definition | Constraint on a resource used in the event response
Control | Mandatory, 1..*
Type | Constraint
MessageConformance.extensions
Definition | See Extensions
Control | Optional, 0..1
MessageConformance.text
Definition |
Control | Mandatory, 1..1
Type | Narrative

This is an old version of FHIR retained for archive purposes. Do not use for anything else
Implementers are welcome to experiment with the content defined here, but should note that the contents are subject to change without prior notice.
© HL7.org 2011 - 2012. FHIR v0.01 generated on Mon, May 14, 2012 09:48+1000.