Operationoutcome.profile.xml

Profile for operationoutcome

Raw XML

<Profile xmlns="http://hl7.org/fhir">
  <text>
    <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre>
&lt;<a class="dict" href="operationoutcome-definitions.html#OperationOutcome" title="A collection of error, warning or information messages that result from a system action."><b>OperationOutcome</b></a> xmlns=&quot;http://hl7.org/fhir&quot;&gt; <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span>
 &lt;!-- from <a href="resources.html">Resource</a>: <a href="extensibility.html">extension</a>, <a href="extensibility.html#modifierExtension">modifierExtension</a>, language, <a href="narrative.html#Narrative">text</a>, and <a href="references.html#contained">contained</a> --&gt;
 &lt;<a class="dict" href="operationoutcome-definitions.html#OperationOutcome.issue" title="An error, warning or information message that results from a system action."><b>issue</b></a>&gt;  <span style="color: Gray">&lt;!-- <span style="color: brown"><b>1..*</b></span> A single issue associated with the action --&gt;</span>
  &lt;<a class="dict" href="operationoutcome-definitions.html#OperationOutcome.issue.severity" title="Indicates whether the issue indicates a variation from successful processing (this element
         modifies the meaning of other elements)"><span style="text-decoration: underline"><b>severity</b></span></a> value=&quot;[<span style="color: darkgreen"><a href="datatypes.html#code">code</a></span>]&quot;/&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy"><a href="issue-severity.html" style="color: navy">fatal | error | warning | information</a></span><span style="color: Gray"> --&gt;</span>
  &lt;<a class="dict" href="operationoutcome-definitions.html#OperationOutcome.issue.type" title="A code indicating the type of error, warning or information message."><b>type</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#Coding">Coding</a></span> <span style="color: navy"><a href="issue-type.html" style="color: navy">Error or warning code</a></span><span style="color: Gray"> --&gt;</span>&lt;/type&gt;
  &lt;<a class="dict" href="operationoutcome-definitions.html#OperationOutcome.issue.details" title="Additional description of the issue."><b>details</b></a> value=&quot;[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]&quot;/&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Additional description of the issue</span><span style="color: Gray"> --&gt;</span>
  &lt;<a class="dict" href="operationoutcome-definitions.html#OperationOutcome.issue.location" title="A simple XPath limited to element names, repetition indicators and the default child access
         that identifies one of the elements in the resource that caused this issue to be raised."><b>location</b></a> value=&quot;[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]&quot;/&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: navy">XPath of element(s) related to issue</span><span style="color: Gray"> --&gt;</span>
 &lt;/issue&gt;
&lt;/OperationOutcome&gt;
</pre></div>
  </text>
  <name value="operationoutcome"/>
  <publisher value="FHIR Project"/>
  <description value="Basic Profile. A collection of error, warning or information messages that result from
   a system action."/>
  <status value="draft"/>
  <date value="2014-09-30"/>
  <requirements value="Scope and Usage Operation Outcomes are sets of error, warning and information messages
   that provide detailed information about the outcome of some attempted system operation.
   They are provided as a direct system response, or component of one, where they provide
   information about the outcome of the operation.   Specifically, OperationOutcomes are
   used in the following circumstances:   * When an RESTful operation fails * As the response
   on a validation operation, to provide information about the outcomes * As part of a message
   response, usually when the message has not been processed correctly"/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM"/>
  </mapping>
  <mapping>
    <identity value="v2"/>
    <uri value="http://hl7.org/v2"/>
    <name value="HL7 v2"/>
  </mapping>
  <structure>
    <type value="OperationOutcome"/>
    <publish value="true"/>
    <element>
      <path value="OperationOutcome"/>
      <definition>
        <short value="Information about the success/failure of an action"/>
        <formal value="A collection of error, warning or information messages that result from a system action."/>
        <comments value="Can result from the failure of a REST call or be part of the response message returned
         from a request message.  If sent with extensions overriding particular issues, might even
         appear as part of a request message."/>
        <min value="1"/>
        <max value="1"/>
        <type>
          <code value="Resource"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value="Grouping is handled through multiple repetitions from whatever context references the
           outcomes (no specific grouper required)"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="OperationOutcome.extension"/>
      <definition>
        <short value="Additional Content defined by implementations"/>
        <formal value="May be used to represent additional information that is not part of the basic definition
         of the resource. In order to make the use of extensions safe and manageable, there is
         a strict governance applied to the definition and use of extensions. Though any implementer
         is allowed to define an extension, there is a set of requirements that SHALL be met as
         part of the definition of the extension."/>
        <comments value="there can be no stigma associated with the use of extensions by any application, project,
         or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
          The use of extensions is what allows the FHIR specification to retain a core simplicity
         for everyone."/>
        <synonym value="extensions"/>
        <synonym value="user content"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Extension"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="OperationOutcome.modifierExtension"/>
      <definition>
        <short value="Extensions that cannot be ignored"/>
        <formal value="May be used to represent additional information that is not part of the basic definition
         of the resource, and that modifies the understanding of the element that contains it.
         Usually modifier elements provide negation or qualification. In order to make the use
         of extensions safe and manageable, there is a strict governance applied to the definition
         and use of extensions. Though any implementer is allowed to define an extension, there
         is a set of requirements that SHALL be met as part of the definition of the extension.
         Applications processing a resource are required to check for modifier extensions."/>
        <comments value="there can be no stigma associated with the use of extensions by any application, project,
         or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
          The use of extensions is what allows the FHIR specification to retain a core simplicity
         for everyone."/>
        <synonym value="extensions"/>
        <synonym value="user content"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Extension"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="OperationOutcome.text"/>
      <definition>
        <short value="Text summary of the resource, for human interpretation"/>
        <formal value="A human-readable narrative that contains a summary of the resource, and may be used to
         represent the content of the resource to a human. The narrative need not encode all the
         structured data, but is required to contain sufficient detail to make it &quot;clinically
         safe&quot; for a human to just read the narrative. Resource definitions may define what
         content should be represented in the narrative to ensure clinical safety."/>
        <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have
         a narrative."/>
        <synonym value="narrative"/>
        <synonym value="html"/>
        <synonym value="xhtml"/>
        <synonym value="display"/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="Narrative"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="OperationOutcome.contained"/>
      <definition>
        <short value="Contained, inline Resources"/>
        <formal value="These resources do not have an independent existence apart from the resource that contains
         them - they cannot be identified independently, and nor can they have their own independent
         transaction scope."/>
        <comments value="This should never be done when the content can be identified properly, as once identification
         is lost, it is extremely difficult (and context dependent) to restore it again."/>
        <synonym value="inline resources"/>
        <synonym value="anonymous resources"/>
        <synonym value="contained resources"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Resource"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="OperationOutcome.issue"/>
      <definition>
        <short value="A single issue associated with the action"/>
        <formal value="An error, warning or information message that results from a system action."/>
        <min value="1"/>
        <max value="*"/>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value="AcknowledgementDetail or Observation[classCode=&quot;ALRT&quot; and moodCode=&quot;EVN&quot;]"/>
        </mapping>
        <mapping>
          <identity value="v2"/>
          <map value="ERR"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="OperationOutcome.issue.extension"/>
      <definition>
        <short value="Additional Content defined by implementations"/>
        <formal value="May be used to represent additional information that is not part of the basic definition
         of the resource. In order to make the use of extensions safe and manageable, there is
         a strict governance applied to the definition and use of extensions. Though any implementer
         is allowed to define an extension, there is a set of requirements that SHALL be met as
         part of the definition of the extension."/>
        <comments value="there can be no stigma associated with the use of extensions by any application, project,
         or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
          The use of extensions is what allows the FHIR specification to retain a core simplicity
         for everyone."/>
        <synonym value="extensions"/>
        <synonym value="user content"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Extension"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="OperationOutcome.issue.modifierExtension"/>
      <definition>
        <short value="Extensions that cannot be ignored"/>
        <formal value="May be used to represent additional information that is not part of the basic definition
         of the resource, and that modifies the understanding of the element that contains it.
         Usually modifier elements provide negation or qualification. In order to make the use
         of extensions safe and manageable, there is a strict governance applied to the definition
         and use of extensions. Though any implementer is allowed to define an extension, there
         is a set of requirements that SHALL be met as part of the definition of the extension.
         Applications processing a resource are required to check for modifier extensions."/>
        <comments value="there can be no stigma associated with the use of extensions by any application, project,
         or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
          The use of extensions is what allows the FHIR specification to retain a core simplicity
         for everyone."/>
        <synonym value="extensions"/>
        <synonym value="user content"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Extension"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="OperationOutcome.issue.severity"/>
      <definition>
        <short value="fatal | error | warning | information"/>
        <formal value="Indicates whether the issue indicates a variation from successful processing."/>
        <comments value="This is labeled as &quot;Is Modifier&quot; because applications should not confuse hints
         and warnings with errors."/>
        <min value="1"/>
        <max value="1"/>
        <type>
          <code value="code"/>
        </type>
        <isModifier value="true"/>
        <binding>
          <name value="IssueSeverity"/>
          <isExtensible value="false"/>
          <conformance value="required"/>
          <referenceResource>
            <reference value="http://hl7.org/fhir/vs/issue-severity"/>
          </referenceResource>
        </binding>
        <mapping>
          <identity value="rim"/>
          <map value="./typeCode[parent::AcknowledgmentDetail] or unique(./inboundRelationship[parent::Observation
           and typeCode='SUBJ' and isNormalActRelationship()]/source[classCode=&quot;OBS&quot; and
           moodCode=&quot;EVN&quot; and implies(code, ActCode#SEV and isNormalAct())/value[xsi:type=&quot;CD&qu
          ot;]"/>
        </mapping>
        <mapping>
          <identity value="v2"/>
          <map value="ERR-4"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="OperationOutcome.issue.type"/>
      <definition>
        <short value="Error or warning code"/>
        <formal value="A code indicating the type of error, warning or information message."/>
        <comments value="Codes should only be defined at a level of granularity that reasonably allows distinct
         actions to be taken by the receiving system.  If the response behavior of all systems
         is the same for two codes, the codes might as well be merged.  The human-meaningful content
         of the issue is conveyed in .text."/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="Coding"/>
        </type>
        <isModifier value="false"/>
        <binding>
          <name value="IssueType"/>
          <isExtensible value="true"/>
          <conformance value="preferred"/>
          <referenceResource>
            <reference value="http://hl7.org/fhir/vs/issue-type"/>
          </referenceResource>
        </binding>
        <mapping>
          <identity value="rim"/>
          <map value="./code"/>
        </mapping>
        <mapping>
          <identity value="v2"/>
          <map value="ERR-3, ERR-5"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="OperationOutcome.issue.details"/>
      <definition>
        <short value="Additional description of the issue"/>
        <formal value="Additional description of the issue."/>
        <comments value="typically this field is used to provide details human-readable information about the error."/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="string"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value="./text[parent::AcknowledgmentDetail]"/>
        </mapping>
        <mapping>
          <identity value="v2"/>
          <map value="ERR-8"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="OperationOutcome.issue.location"/>
      <definition>
        <short value="XPath of element(s) related to issue"/>
        <formal value="A simple XPath limited to element names, repetition indicators and the default child access
         that identifies one of the elements in the resource that caused this issue to be raised."/>
        <comments value="The root of the XPath is the resource or bundle that generated OperationOutcome.  Each
         XPath SHALL resolve to a single node.  The XPath syntax is used whether the referenced
         instance is expressed in XML or JSON."/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="string"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value="./location[parent::AcknowledgmentDetail]"/>
        </mapping>
        <mapping>
          <identity value="v2"/>
          <map value="ERR-2"/>
        </mapping>
      </definition>
    </element>
    <searchParam>
      <name value="_id"/>
      <type value="token"/>
      <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/>
    </searchParam>
    <searchParam>
      <name value="_language"/>
      <type value="token"/>
      <documentation value="The language of the resource"/>
    </searchParam>
  </structure>
</Profile>