ACK Management Framework
0.1.9 - ci-build

ACK Management Framework, published by FO. This guide is not an authorized publication; it is the continuous build for version 0.1.9 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/frankoemig/ack-ig/ and changes regularly. See the Directory of published versions

: ACK Codes - XML Representation

Active as of 2025-02-20

Raw xml | Download


<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="AckCodes"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CodeSystem AckCodes</b></p><a name="AckCodes"> </a><a name="hcAckCodes"> </a><p><b>Properties</b></p><p><b>This code system defines the following properties for its concepts</b></p><table class="grid"><tr><td><b>Name</b></td><td><b>Code</b></td><td><b>URI</b></td><td><b>Type</b></td><td><b>Description</b></td><td><b>Value Set</b></td></tr><tr><td>type</td><td>type</td><td>http://ackig.oemig.de/fhir/CodeSystem/Property#type</td><td>code</td><td>What is the type of acknowledgement?</td><td><a href="ValueSet-AckType.html">Ack Type</a></td></tr><tr><td>response</td><td>response</td><td>http://ackig.oemig.de/fhir/CodeSystem/Property#response</td><td>code</td><td>What is the response it conveys?</td><td><a href="ValueSet-ResponseType.html">Response Type</a></td></tr><tr><td>Option 1</td><td>option1</td><td>http://ackig.oemig.de/fhir/CodeSystem/Property#option1</td><td>string</td><td>How to behave with option 1?</td><td/></tr><tr><td>Option 2</td><td>option2</td><td>http://ackig.oemig.de/fhir/CodeSystem/Property#option2</td><td>string</td><td>How to behave with option 2?</td><td/></tr><tr><td>status</td><td>status</td><td>http://hl7.org/fhir/concept-properties#status</td><td>code</td><td>Status</td><td/></tr></table><p><b>Concepts</b></p><p>This case-insensitive code system <code>http://ackig.oemig.de/fhir/CodeSystem/AckCodes</code> defines the following codes in a Is-A hierarchy:</p><table class="codes"><tr><td><b>Lvl</b></td><td style="white-space:nowrap"><b>Code</b></td><td><b>Display</b></td><td><b>type</b></td><td><b>response</b></td><td><b>Option 1</b></td><td><b>Option 2</b></td><td><b>status</b></td></tr><tr style="background-color: #ffeeee"><td>1</td><td style="white-space:nowrap">application<a name="AckCodes-application"> </a></td><td>application ACK</td><td/><td/><td/><td/><td>inactive</td></tr><tr><td>2</td><td style="white-space:nowrap">  AA<a name="AckCodes-AA"> </a></td><td>application accept</td><td>application</td><td>positive</td><td>All information was accepted - no further activity needed</td><td>All information was accepted - no further activity needed</td><td/></tr><tr><td>2</td><td style="white-space:nowrap">  AE<a name="AckCodes-AE"> </a></td><td>application error</td><td>application</td><td>neutral</td><td>Some information was accepted - update recommended</td><td>Fixes are requested but nor required to be resubmitted</td><td/></tr><tr><td>2</td><td style="white-space:nowrap">  AR<a name="AckCodes-AR"> </a></td><td>application reject</td><td>application</td><td>negative</td><td>No information was accepted - update necessary</td><td>Fixes are required and resubmission is necessary or critical</td><td/></tr><tr style="background-color: #ffeeee"><td>1</td><td style="white-space:nowrap">transport<a name="AckCodes-transport"> </a></td><td>transport ACK</td><td/><td/><td/><td/><td>inactive</td></tr><tr><td>2</td><td style="white-space:nowrap">  CA<a name="AckCodes-CA"> </a></td><td>commit accept</td><td>transport</td><td>positive</td><td/><td/><td/></tr><tr><td>2</td><td style="white-space:nowrap">  CE<a name="AckCodes-CE"> </a></td><td>commit error</td><td>transport</td><td>neutral</td><td/><td/><td/></tr><tr><td>2</td><td style="white-space:nowrap">  CR<a name="AckCodes-CR"> </a></td><td>commit reject</td><td>transport</td><td>negative</td><td/><td/><td/></tr></table></div>
  </text>
  <url value="http://ackig.oemig.de/fhir/CodeSystem/AckCodes"/>
  <version value="0.1.9"/>
  <name value="AckCodesCS"/>
  <title value="ACK Codes"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2025-02-20"/>
  <publisher value="FO"/>
  <contact>
    <name value="FO"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.oemig.de"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="hl7@oemig.de"/>
    </telecom>
  </contact>
  <description
               value="**ACK Codes** (for temporary use only; to be replaced later on)"/>
  <copyright value="FO"/>
  <caseSensitive value="false"/>
  <valueSet value="http://ackig.oemig.de/fhir/ValueSet/AckCodes"/>
  <hierarchyMeaning value="is-a"/>
  <compositional value="false"/>
  <versionNeeded value="false"/>
  <content value="complete"/>
  <count value="8"/>
  <property>
    <extension
               url="http://hl7.org/fhir/StructureDefinition/codesystem-property-valueset">
      <valueCanonical value="http://ackig.oemig.de/fhir/ValueSet/AckType"/>
    </extension>
    <code value="type"/>
    <uri value="http://ackig.oemig.de/fhir/CodeSystem/Property#type"/>
    <description value="What is the type of acknowledgement?"/>
    <type value="code"/>
  </property>
  <property>
    <extension
               url="http://hl7.org/fhir/StructureDefinition/codesystem-property-valueset">
      <valueCanonical
                      value="http://ackig.oemig.de/fhir/ValueSet/ResponseType"/>
    </extension>
    <code value="response"/>
    <uri value="http://ackig.oemig.de/fhir/CodeSystem/Property#response"/>
    <description value="What is the response it conveys?"/>
    <type value="code"/>
  </property>
  <property>
    <code value="option1"/>
    <uri value="http://ackig.oemig.de/fhir/CodeSystem/Property#option1"/>
    <description value="How to behave with option 1?"/>
    <type value="string"/>
  </property>
  <property>
    <code value="option2"/>
    <uri value="http://ackig.oemig.de/fhir/CodeSystem/Property#option2"/>
    <description value="How to behave with option 2?"/>
    <type value="string"/>
  </property>
  <property>
    <code value="status"/>
    <uri value="http://hl7.org/fhir/concept-properties#status"/>
    <description value="Status"/>
    <type value="code"/>
  </property>
  <concept>
    <code value="application"/>
    <display value="application ACK"/>
    <property>
      <code value="status"/>
      <valueCode value="inactive"/>
    </property>
    <concept>
      <code value="AA"/>
      <display value="application accept"/>
      <property>
        <code value="type"/>
        <valueCode value="application"/>
      </property>
      <property>
        <code value="response"/>
        <valueCode value="positive"/>
      </property>
      <property>
        <code value="option1"/>
        <valueString
                     value="All information was accepted - no further activity needed"/>
      </property>
      <property>
        <code value="option2"/>
        <valueString
                     value="All information was accepted - no further activity needed"/>
      </property>
    </concept>
    <concept>
      <code value="AE"/>
      <display value="application error"/>
      <property>
        <code value="type"/>
        <valueCode value="application"/>
      </property>
      <property>
        <code value="response"/>
        <valueCode value="neutral"/>
      </property>
      <property>
        <code value="option1"/>
        <valueString
                     value="Some information was accepted - update recommended"/>
      </property>
      <property>
        <code value="option2"/>
        <valueString
                     value="Fixes are requested but nor required to be resubmitted"/>
      </property>
    </concept>
    <concept>
      <code value="AR"/>
      <display value="application reject"/>
      <property>
        <code value="type"/>
        <valueCode value="application"/>
      </property>
      <property>
        <code value="response"/>
        <valueCode value="negative"/>
      </property>
      <property>
        <code value="option1"/>
        <valueString value="No information was accepted - update necessary"/>
      </property>
      <property>
        <code value="option2"/>
        <valueString
                     value="Fixes are required and resubmission is necessary or critical"/>
      </property>
    </concept>
  </concept>
  <concept>
    <code value="transport"/>
    <display value="transport ACK"/>
    <property>
      <code value="status"/>
      <valueCode value="inactive"/>
    </property>
    <concept>
      <code value="CA"/>
      <display value="commit accept"/>
      <property>
        <code value="type"/>
        <valueCode value="transport"/>
      </property>
      <property>
        <code value="response"/>
        <valueCode value="positive"/>
      </property>
    </concept>
    <concept>
      <code value="CE"/>
      <display value="commit error"/>
      <property>
        <code value="type"/>
        <valueCode value="transport"/>
      </property>
      <property>
        <code value="response"/>
        <valueCode value="neutral"/>
      </property>
    </concept>
    <concept>
      <code value="CR"/>
      <display value="commit reject"/>
      <property>
        <code value="type"/>
        <valueCode value="transport"/>
      </property>
      <property>
        <code value="response"/>
        <valueCode value="negative"/>
      </property>
    </concept>
  </concept>
</CodeSystem>