Operationoutcome.profile.xml

StructureDefinition for operationoutcome

Raw XML

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="OperationOutcome"/>
  <meta>
    <lastUpdated value="2015-04-03T14:24:32.000+11:00"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <url value="http://hl7.org/fhir/StructureDefinition/OperationOutcome"/>
  <name value="OperationOutcome"/>
  <publisher value="HL7 FHIR Project (FHIR Management Group)"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
  </contact>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/fhirmg/index.cfm"/>
    </telecom>
  </contact>
  <description value="Base StructureDefinition for OperationOutcome Resource"/>
  <status value="draft"/>
  <date value="2015-04-03T14:24:32+11:00"/>
  <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>
  <type value="resource"/>
  <abstract value="true"/>
  <snapshot>
    <element>
      <path value="OperationOutcome"/>
      <short value="Information about the success/failure of an action"/>
      <definition 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="DomainResource"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="Grouping is handled through multiple repetitions from whatever context references the
         outcomes (no specific grouper required)"/>
      </mapping>
    </element>
    <element>
      <path value="OperationOutcome.id"/>
      <short value="Logical id of this artefact"/>
      <definition value="The logical id of the resource, as used in the url for the resoure. Once assigned, this
       value never changes."/>
      <comments value="The only time that a resource does not have an id is when it is being submitted to the
       server using a create operation. Bundles always have an id, though it is usually a generated
       UUID."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
    </element>
    <element>
      <path value="OperationOutcome.meta"/>
      <short value="Metadata about the resource"/>
      <definition value="The metadata about the resource. This is content that is maintained by the infrastructure.
       Changes to the content may not always be associated with version changes to the resource."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Meta"/>
      </type>
    </element>
    <element>
      <path value="OperationOutcome.implicitRules"/>
      <short value="A set of rules under which this content was created"/>
      <definition value="A reference to a set of rules that were followed when the resource was constructed, and
       which must be understood when processing the content."/>
      <comments value="Asserting this rule set restricts the content to be only understood by a limited set of
       trading partners. This inherently limits the usefulness of the data in the long term.
       However the existing health eco-system is highly fractured, and not yet ready to define,
       collect, and exchange data in a generally computable sense. Wherever possible, implementers
       and/or specification writers should avoid using this element as much as possible."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
      <isModifier value="true"/>
    </element>
    <element>
      <path value="OperationOutcome.language"/>
      <short value="Language of the resource content"/>
      <definition value="The base language in which the resource is written."/>
      <comments value="Language is provided to support indexing and accessibility (typically, services such as
       text to speech use the language tag). The html language tag in the narrative applies 
       to the narrative. The language tag on the resource may be used to specify the language
       of other presentations generated from the data in the resource  Not all the content has
       to be in the base language. The Resource.language should not be assumed to apply to the
       narrative automatically. If a language is specified, it should it also be specified on
       the div element in the html (see rules in HTML5 for information about the relationship
       between xml:lang and the html lang attribute)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="Language"/>
        <strength value="required"/>
        <description value="A human language"/>
        <valueSetUri value="http://tools.ietf.org/html/bcp47"/>
      </binding>
    </element>
    <element>
      <path value="OperationOutcome.text"/>
      <short value="Text summary of the resource, for human interpretation"/>
      <definition 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."/>
      <alias value="narrative"/>
      <alias value="html"/>
      <alias value="xhtml"/>
      <alias value="display"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Narrative"/>
      </type>
      <condition value="dom-1"/>
      <mapping>
        <identity value="rim"/>
        <map value="Act.text?"/>
      </mapping>
    </element>
    <element>
      <path value="OperationOutcome.contained"/>
      <short value="Contained, inline Resources"/>
      <definition 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."/>
      <alias value="inline resources"/>
      <alias value="anonymous resources"/>
      <alias value="contained resources"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Resource"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="OperationOutcome.extension"/>
      <short value="Additional Content defined by implementations"/>
      <definition 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 set of 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 level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="OperationOutcome.modifierExtension"/>
      <short value="Extensions that cannot be ignored"/>
      <definition 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 set of 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 level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <isModifier value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="OperationOutcome.issue"/>
      <short value="A single issue associated with the action"/>
      <definition value="An error, warning or information message that results from a system action."/>
      <min value="1"/>
      <max value="*"/>
      <mapping>
        <identity value="v2"/>
        <map value="ERR"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="AcknowledgementDetail or Observation[classCode=&quot;ALRT&quot; and moodCode=&quot;EVN&quot;]"/>
      </mapping>
    </element>
    <element>
      <path value="OperationOutcome.issue.id"/>
      <representation value="xmlAttr"/>
      <short value="xml:id (or equivalent in JSON)"/>
      <definition value="unique id for the element within a resource (for internal references)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="OperationOutcome.issue.extension"/>
      <short value="Additional Content defined by implementations"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the element. In order to make the use of extensions safe and manageable, there is a
       strict set of 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 level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="OperationOutcome.issue.modifierExtension"/>
      <short value="Extensions that cannot be ignored"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the element, 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 set of 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 level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <alias value="modifiers"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <isModifier value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="OperationOutcome.issue.severity"/>
      <short value="fatal | error | warning | information"/>
      <definition 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."/>
      <requirements value="Indicates how relevant the issue is to the overall success of the action."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <isModifier value="true"/>
      <binding>
        <name value="IssueSeverity"/>
        <strength value="required"/>
        <description value="How the issue affects the success of the action"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/issue-severity"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="v2"/>
        <map value="ERR-4"/>
      </mapping>
      <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>
    </element>
    <element>
      <path value="OperationOutcome.issue.code"/>
      <short value="Error or warning code"/>
      <definition value="Describes the type of the issue."/>
      <requirements value="Expresses the issue in a human and computer-friendly way, allowing the requesting system
       to behave differently based on the type of issue. The system that creates an OperationOutcome
       SHALL choose the most applicable code from the IssueType value set, and may additional
       provide it's own codes in other coding elements in the type. A human readable description
       of the type of the issue SHOULD be placed in code.text."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <binding>
        <name value="IssueType"/>
        <strength value="required"/>
        <description value="A coded expression of the type of issue"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/issue-type"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="v2"/>
        <map value="ERR-3, ERR-5"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="./code"/>
      </mapping>
    </element>
    <element>
      <path value="OperationOutcome.issue.details"/>
      <short value="Additional diagnostic information about the issue"/>
      <definition value="Additional diagnostic information about the issue.  Typically, this may be a description
       of how a value is erroneous, or a stck dump to help trace the issue."/>
      <comments value="typically this field is used to provide troubleshooting information about the error."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
      <mapping>
        <identity value="v2"/>
        <map value="ERR-8"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="./text[parent::AcknowledgmentDetail]"/>
      </mapping>
    </element>
    <element>
      <path value="OperationOutcome.issue.location"/>
      <short value="XPath of element(s) related to issue"/>
      <definition 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."/>
      <requirements value="Allows systems to highlight or otherwise guide users to elements implicated in issues
       to allow them to be fixed more easily."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="string"/>
      </type>
      <mapping>
        <identity value="v2"/>
        <map value="ERR-2"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="./location[parent::AcknowledgmentDetail]"/>
      </mapping>
    </element>
  </snapshot>
  <differential>
    <element>
      <path value="OperationOutcome"/>
      <short value="Information about the success/failure of an action"/>
      <definition 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="DomainResource"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="Grouping is handled through multiple repetitions from whatever context references the
         outcomes (no specific grouper required)"/>
      </mapping>
    </element>
    <element>
      <path value="OperationOutcome.issue"/>
      <short value="A single issue associated with the action"/>
      <definition value="An error, warning or information message that results from a system action."/>
      <min value="1"/>
      <max value="*"/>
      <mapping>
        <identity value="v2"/>
        <map value="ERR"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="AcknowledgementDetail or Observation[classCode=&quot;ALRT&quot; and moodCode=&quot;EVN&quot;]"/>
      </mapping>
    </element>
    <element>
      <path value="OperationOutcome.issue.severity"/>
      <short value="fatal | error | warning | information"/>
      <definition 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."/>
      <requirements value="Indicates how relevant the issue is to the overall success of the action."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <isModifier value="true"/>
      <binding>
        <name value="IssueSeverity"/>
        <strength value="required"/>
        <description value="How the issue affects the success of the action"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/issue-severity"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="v2"/>
        <map value="ERR-4"/>
      </mapping>
      <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>
    </element>
    <element>
      <path value="OperationOutcome.issue.code"/>
      <short value="Error or warning code"/>
      <definition value="Describes the type of the issue."/>
      <requirements value="Expresses the issue in a human and computer-friendly way, allowing the requesting system
       to behave differently based on the type of issue. The system that creates an OperationOutcome
       SHALL choose the most applicable code from the IssueType value set, and may additional
       provide it's own codes in other coding elements in the type. A human readable description
       of the type of the issue SHOULD be placed in code.text."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <binding>
        <name value="IssueType"/>
        <strength value="required"/>
        <description value="A coded expression of the type of issue"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/issue-type"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="v2"/>
        <map value="ERR-3, ERR-5"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="./code"/>
      </mapping>
    </element>
    <element>
      <path value="OperationOutcome.issue.details"/>
      <short value="Additional diagnostic information about the issue"/>
      <definition value="Additional diagnostic information about the issue.  Typically, this may be a description
       of how a value is erroneous, or a stck dump to help trace the issue."/>
      <comments value="typically this field is used to provide troubleshooting information about the error."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
      <mapping>
        <identity value="v2"/>
        <map value="ERR-8"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="./text[parent::AcknowledgmentDetail]"/>
      </mapping>
    </element>
    <element>
      <path value="OperationOutcome.issue.location"/>
      <short value="XPath of element(s) related to issue"/>
      <definition 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."/>
      <requirements value="Allows systems to highlight or otherwise guide users to elements implicated in issues
       to allow them to be fixed more easily."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="string"/>
      </type>
      <mapping>
        <identity value="v2"/>
        <map value="ERR-2"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="./location[parent::AcknowledgmentDetail]"/>
      </mapping>
    </element>
  </differential>
</StructureDefinition>