Canonical Resource Management Infrastructure Implementation Guide
2.0.0 - STU 2 International flag

Canonical Resource Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/crmi-ig/ and changes regularly. See the Directory of published versions

: Publishable MessageDefinition Example

Page standards status: Informative

Raw xml | Download


<MessageDefinition xmlns="http://hl7.org/fhir">
  <id value="publishable-example"/>
  <meta>
    <profile
             value="http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablemessagedefinition"/>
  </meta>
  <language value="en"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: MessageDefinition publishable-example</b></p><a name="publishable-example"> </a><a name="hcpublishable-example"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-crmi-publishablemessagedefinition.html">CRMI Publishable MessageDefinition</a></p></div><p><b>Artifact Release Label</b>: Release 1</p><p><b>Artifact Release Description</b>: </p><div><p>Example release of a message definition</p>
</div><p><b>Artifact Version Policy</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/artifact-version-policy-codes strict}">Strict</span></p><p><b>Artifact Usage</b>: </p><div><p>See the <a href="https://hl7.org/fhir/R4/messaging.html">FHIR Messaging</a> topic for more information on how messaging is implemented in FHIR</p>
</div><p><b>Artifact Copyright Label</b>: Copyright 2026+, Health Level 7 International</p><p><b>Artifact Approval Date</b>: 2026-04-24</p><p><b>Artifact Last Review Date</b>: 2026-04-24</p><p><b>Artifact Effective Period</b>: 2026-07-01 --&gt; (ongoing)</p><p><b>Artifact Topic</b>: <span title="Codes:">Antenatal Care</span></p><p><b>Artifact Author</b>: HL7 Infrastructure and Messaging Work Group: </p><p><b>Artifact Editor</b>: Canonical Resource Management Infrastructure Project: </p><p><b>Artifact Reviewer</b>: HL7 Clinical Decision Support Work Group: </p><p><b>url</b>: <a href="MessageDefinition-publishable-example.html">MessageDefinition Publishable Message Definition Example</a></p><p><b>identifier</b>: <a href="http://terminology.hl7.org/7.1.0/NamingSystem-uri.html" title="As defined by RFC 3986 (http://www.ietf.org/rfc/rfc3986.txt)(with many schemes defined in many RFCs). For OIDs and UUIDs, use the URN form (urn:oid:(note: lowercase) and urn:uuid:). See http://www.ietf.org/rfc/rfc3001.txt and http://www.ietf.org/rfc/rfc4122.txt 

This oid is used as an identifier II.root to indicate the the extension is an absolute URI (technically, an IRI). Typically, this is used for OIDs and GUIDs. Note that when this OID is used with OIDs and GUIDs, the II.extension should start with urn:oid or urn:uuid: 

Note that this OID is created to aid with interconversion between CDA and FHIR - FHIR uses urn:ietf:rfc:3986 as equivalent to this OID. URIs as identifiers appear more commonly in FHIR.

This OID may also be used in CD.codeSystem.">Uniform Resource Identifier (URI)</a>/urn:oid:2.16.840.1.113883.4.642.40.38.30.1</p><p><b>version</b>: 0.1.0</p><p><b>name</b>: PublishableExample</p><p><b>title</b>: Publishable Message Definition Example</p><p><b>status</b>: Draft</p><p><b>experimental</b>: true</p><p><b>date</b>: 2026-04-24</p><p><b>publisher</b>: Health Level Seven, Int'l</p><p><b>contact</b>: <a href="http://hl7.org">http://hl7.org</a></p><p><b>jurisdiction</b>: <span title="Codes:{http://unstats.un.org/unsd/methods/m49/m49.htm 001}">World</span></p><p><b>purpose</b>: </p><div><p>Provides an example of a publishable message definition</p>
</div><p><b>event</b>: message-events: admin-notify (admin-notify)</p><p><b>category</b>: Notification</p></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/artifact-releaseLabel">
    <valueString value="Release 1"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/artifact-releaseDescription">
    <valueMarkdown value="Example release of a message definition"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy">
    <valueCodeableConcept>
      <coding>
        <system
                value="http://terminology.hl7.org/CodeSystem/artifact-version-policy-codes"/>
        <code value="strict"/>
      </coding>
    </valueCodeableConcept>
  </extension>
  <extension url="http://hl7.org/fhir/StructureDefinition/artifact-usage">
    <valueMarkdown
                   value="See the [FHIR Messaging](https://hl7.org/fhir/R4/messaging.html) topic for more information on how messaging is implemented in FHIR"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel">
    <valueString value="Copyright 2026+, Health Level 7 International"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/artifact-approvalDate">
    <valueDate value="2026-04-24"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate">
    <valueDate value="2026-04-24"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod">
    <valuePeriod>
      <start value="2026-07-01"/>
    </valuePeriod>
  </extension>
  <extension url="http://hl7.org/fhir/StructureDefinition/artifact-topic">
    <valueCodeableConcept>
      <text value="Antenatal Care"/>
    </valueCodeableConcept>
  </extension>
  <extension url="http://hl7.org/fhir/StructureDefinition/artifact-author">
    <valueContactDetail>
      <name value="HL7 Infrastructure and Messaging Work Group"/>
    </valueContactDetail>
  </extension>
  <extension url="http://hl7.org/fhir/StructureDefinition/artifact-editor">
    <valueContactDetail>
      <name value="Canonical Resource Management Infrastructure Project"/>
    </valueContactDetail>
  </extension>
  <extension url="http://hl7.org/fhir/StructureDefinition/artifact-reviewer">
    <valueContactDetail>
      <name value="HL7 Clinical Decision Support Work Group"/>
    </valueContactDetail>
  </extension>
  <url
       value="http://hl7.org/fhir/uv/crmi/MessageDefinition/publishable-example"/>
  <identifier>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:2.16.840.1.113883.4.642.40.38.30.1"/>
  </identifier>
  <version value="0.1.0"/>
  <name value="PublishableExample"/>
  <title value="Publishable Message Definition Example"/>
  <status value="draft"/>
  <experimental value="true"/>
  <date value="2026-04-24"/>
  <publisher value="Health Level Seven, Int'l"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org"/>
    </telecom>
  </contact>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
      <display value="World"/>
    </coding>
  </jurisdiction>
  <purpose value="Provides an example of a publishable message definition"/>
  <eventCoding>
    <system value="http://example.org/fhir/message-events"/>
    <code value="admin-notify"/>
  </eventCoding>
  <category value="notification"/>
</MessageDefinition>