Extensions for Using Data Elements from FHIR R4B in FHIR STU3
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R4B in FHIR STU3 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R4B_OperationOutcome_R3 - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-OperationOutcome resource profile.

Guidance on how to interpret the contents of this table can be foundhere

0. OperationOutcome
Definition

A collection of error, warning or information messages that result from a system action.

ShortInformation about the success/failure of an action
Comments

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.

Control0..*
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
2. OperationOutcome.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

ShortA set of rules under which this content was created
Comments

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.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Control0..1
Typeuri
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. OperationOutcome.modifierExtension
Definition

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.

ShortExtensions that cannot be ignored
Comments

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.

Control0..*
TypeExtension
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Alternate Namesextensions, user content
6. OperationOutcome.issue
Definition

An error, warning or information message that results from a system action.

ShortA single issue associated with the action
Control1..*
TypeBackboneElement
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
8. OperationOutcome.issue.modifierExtension
Definition

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.

ShortExtensions that cannot be ignored
Comments

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.

Control0..*
TypeExtension
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Summarytrue
Alternate Namesextensions, user content, modifiers
10. OperationOutcome.issue.severity
Definition

Indicates whether the issue indicates a variation from successful processing.

Shortfatal | error | warning | information
Comments

This is labeled as "Is Modifier" because applications should not confuse hints and warnings with errors.

Control1..1
BindingThe codes SHALL be taken from IssueSeverityhttp://hl7.org/fhir/ValueSet/issue-severity|3.0.2
(required to http://hl7.org/fhir/ValueSet/issue-severity|3.0.2)

How the issue affects the success of the action.

Typecode
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Indicates how relevant the issue is to the overall success of the action.

12. OperationOutcome.issue.code
Definition

Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element.

ShortError or warning code
Control1..1
BindingThe codes SHALL be taken from IssueTypehttp://hl7.org/fhir/ValueSet/issue-type|3.0.2
(required to http://hl7.org/fhir/ValueSet/issue-type|3.0.2)

A code that describes the type of issue.

Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Expresses the issue in a human and computer-friendly way, allowing the requesting system to behave differently based on the type of issue.

14. OperationOutcome.issue.code.extension
Definition

An Extension


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.

ShortExtensionAdditional Content defined by implementations
Comments

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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on OperationOutcome.issue.code.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 16. OperationOutcome.issue.code.extension:code
    Slice Namecode
    Definition

    R4B: OperationOutcome.issue.code additional codes

    ShortR4B: code additional codes
    Comments

    Element OperationOutcome.issue.code is mapped to FHIR STU3 element OperationOutcome.issue.code as RelatedTo. The mappings for OperationOutcome.issue.code do not allow expression of the necessary codes, per the bindings on the source and target.

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R4B: code additional codes) (Extension Type: code)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

    Guidance on how to interpret the contents of this table can be foundhere

    0. OperationOutcome
    2. OperationOutcome.meta
    4. OperationOutcome.meta.extension
    Control0..*
    SlicingThis element introduces a set of slices on OperationOutcome.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 6. OperationOutcome.meta.extension:meta
      Slice Namemeta
      Definition

      R4B: OperationOutcome.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, source, tag, versionId)

      ShortR4B: meta additional types
      Comments

      Element OperationOutcome.meta is mapped to FHIR STU3 element OperationOutcome.meta as SourceIsBroaderThanTarget. The mappings for OperationOutcome.meta do not cover the following types: Meta. The mappings for OperationOutcome.meta do not cover the following types based on type expansion: lastUpdated, profile, security, source, tag, versionId.

      Control0..1
      TypeExtension(R4B: meta additional types) (Extension Type: Meta)
      8. OperationOutcome.text
      10. OperationOutcome.text.extension
      Control0..*
      SlicingThis element introduces a set of slices on OperationOutcome.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 12. OperationOutcome.text.extension:text
        Slice Nametext
        Definition

        R4B: OperationOutcome.text additional types (Narrative) additional types from child elements (div, status)

        ShortR4B: text additional types
        Comments

        Element OperationOutcome.text is mapped to FHIR STU3 element OperationOutcome.text as SourceIsBroaderThanTarget. The mappings for OperationOutcome.text do not cover the following types: Narrative. The mappings for OperationOutcome.text do not cover the following types based on type expansion: div, status. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

        Control0..1
        TypeExtension(R4B: text additional types) (Complex Extension)
        14. OperationOutcome.issue
        16. OperationOutcome.issue.code
        18. OperationOutcome.issue.code.extension
        Control0..*
        SlicingThis element introduces a set of slices on OperationOutcome.issue.code.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 20. OperationOutcome.issue.code.extension:code
          Slice Namecode
          Definition

          R4B: OperationOutcome.issue.code additional codes

          ShortR4B: code additional codes
          Comments

          Element OperationOutcome.issue.code is mapped to FHIR STU3 element OperationOutcome.issue.code as RelatedTo. The mappings for OperationOutcome.issue.code do not allow expression of the necessary codes, per the bindings on the source and target.

          Control0..1
          TypeExtension(R4B: code additional codes) (Extension Type: code)

          Guidance on how to interpret the contents of this table can be foundhere

          0. OperationOutcome
          Definition

          A collection of error, warning or information messages that result from a system action.

          ShortInformation about the success/failure of an action
          Comments

          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.

          Control0..*
          Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
          dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
          dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
          dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
          2. OperationOutcome.id
          Definition

          The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

          ShortLogical id of this artifact
          Comments

          The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

          Control0..1
          Typeid
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          4. OperationOutcome.meta
          Definition

          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.

          ShortMetadata about the resource
          Control0..1
          TypeMeta
          Summarytrue
          6. OperationOutcome.meta.id
          Definition

          unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

          Shortxml:id (or equivalent in JSON)
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          8. OperationOutcome.meta.extension
          Definition

          An Extension

          ShortExtension
          Control0..*
          TypeExtension
          SlicingThis element introduces a set of slices on OperationOutcome.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 10. OperationOutcome.meta.extension:meta
            Slice Namemeta
            Definition

            R4B: OperationOutcome.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, source, tag, versionId)

            ShortR4B: meta additional types
            Comments

            Element OperationOutcome.meta is mapped to FHIR STU3 element OperationOutcome.meta as SourceIsBroaderThanTarget. The mappings for OperationOutcome.meta do not cover the following types: Meta. The mappings for OperationOutcome.meta do not cover the following types based on type expansion: lastUpdated, profile, security, source, tag, versionId.

            Control0..1
            TypeExtension(R4B: meta additional types) (Extension Type: Meta)
            12. OperationOutcome.meta.versionId
            Definition

            The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.

            ShortVersion specific identifier
            Comments

            The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

            Control0..1
            Typeid
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            14. OperationOutcome.meta.lastUpdated
            Definition

            When the resource last changed - e.g. when the version changed.

            ShortWhen the resource version last changed
            Comments

            This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.

            Control0..1
            Typeinstant
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            16. OperationOutcome.meta.profile
            Definition

            A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

            ShortProfiles this resource claims to conform to
            Comments

            It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

            Control0..*
            Typeuri
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            18. OperationOutcome.meta.security
            Definition

            Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

            ShortSecurity Labels applied to this resource
            Comments

            The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

            Control0..*
            BindingUnless not suitable, these codes SHALL be taken from All Security Labels
            (extensible to http://hl7.org/fhir/ValueSet/security-labels|3.0.2)

            Security Labels from the Healthcare Privacy and Security Classification System.

            TypeCoding
            Summarytrue
            20. OperationOutcome.meta.tag
            Definition

            Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

            ShortTags applied to this resource
            Comments

            The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

            Control0..*
            BindingFor example codes, see Common Tags
            (example to http://hl7.org/fhir/ValueSet/common-tags|3.0.2)

            Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"

            TypeCoding
            Summarytrue
            22. OperationOutcome.implicitRules
            Definition

            A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

            ShortA set of rules under which this content was created
            Comments

            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.

            This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

            Control0..1
            Typeuri
            Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            24. OperationOutcome.language
            Definition

            The base language in which the resource is written.

            ShortLanguage of the resource content
            Comments

            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).

            Control0..1
            BindingUnless not suitable, these codes SHALL be taken from Common Languages
            (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)

            A human language.

            Additional BindingsPurpose
            All LanguagesMax Binding
            Typecode
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            26. OperationOutcome.text
            Definition

            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 "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

            ShortText summary of the resource, for human interpretation
            Comments

            Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

            Control0..1
            This element is affected by the following invariants: dom-1
            TypeNarrative
            Alternate Namesnarrative, html, xhtml, display
            28. OperationOutcome.text.id
            Definition

            unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            Shortxml:id (or equivalent in JSON)
            Control0..1
            Typestring
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            30. OperationOutcome.text.extension
            Definition

            An Extension

            ShortExtension
            Control0..*
            TypeExtension
            SlicingThis element introduces a set of slices on OperationOutcome.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 32. OperationOutcome.text.extension:text
              Slice Nametext
              Definition

              R4B: OperationOutcome.text additional types (Narrative) additional types from child elements (div, status)

              ShortR4B: text additional types
              Comments

              Element OperationOutcome.text is mapped to FHIR STU3 element OperationOutcome.text as SourceIsBroaderThanTarget. The mappings for OperationOutcome.text do not cover the following types: Narrative. The mappings for OperationOutcome.text do not cover the following types based on type expansion: div, status. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

              Control0..1
              TypeExtension(R4B: text additional types) (Complex Extension)
              34. OperationOutcome.text.status
              Definition

              The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

              Shortgenerated | extensions | additional | empty
              Control1..1
              BindingThe codes SHALL be taken from NarrativeStatus
              (required to http://hl7.org/fhir/ValueSet/narrative-status|3.0.2)

              The status of a resource narrative

              Typecode
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              36. OperationOutcome.text.div
              Definition

              The actual narrative content, a stripped down version of XHTML.

              ShortLimited xhtml content
              Comments

              The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content may not contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.

              Control1..1
              Typexhtml
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Invariantstxt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes (htmlchecks())
              txt-2: The narrative SHALL have some non-whitespace content (htmlchecks())
              38. OperationOutcome.contained
              Definition

              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.

              ShortContained, inline Resources
              Comments

              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.

              Control0..*
              TypeResource
              Alternate Namesinline resources, anonymous resources, contained resources
              40. OperationOutcome.extension
              Definition

              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.

              ShortAdditional Content defined by implementations
              Comments

              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.

              Control0..*
              TypeExtension
              Alternate Namesextensions, user content
              42. OperationOutcome.modifierExtension
              Definition

              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.

              ShortExtensions that cannot be ignored
              Comments

              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.

              Control0..*
              TypeExtension
              Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
              Alternate Namesextensions, user content
              44. OperationOutcome.issue
              Definition

              An error, warning or information message that results from a system action.

              ShortA single issue associated with the action
              Control1..*
              TypeBackboneElement
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
              46. OperationOutcome.issue.id
              Definition

              unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

              Shortxml:id (or equivalent in JSON)
              Control0..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              48. OperationOutcome.issue.extension
              Definition

              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.

              ShortAdditional Content defined by implementations
              Comments

              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.

              Control0..*
              TypeExtension
              Alternate Namesextensions, user content
              50. OperationOutcome.issue.modifierExtension
              Definition

              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.

              ShortExtensions that cannot be ignored
              Comments

              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.

              Control0..*
              TypeExtension
              Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
              Summarytrue
              Alternate Namesextensions, user content, modifiers
              52. OperationOutcome.issue.severity
              Definition

              Indicates whether the issue indicates a variation from successful processing.

              Shortfatal | error | warning | information
              Comments

              This is labeled as "Is Modifier" because applications should not confuse hints and warnings with errors.

              Control1..1
              BindingThe codes SHALL be taken from IssueSeverity
              (required to http://hl7.org/fhir/ValueSet/issue-severity|3.0.2)

              How the issue affects the success of the action.

              Typecode
              Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Indicates how relevant the issue is to the overall success of the action.

              54. OperationOutcome.issue.code
              Definition

              Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element.

              ShortError or warning code
              Control1..1
              BindingThe codes SHALL be taken from IssueType
              (required to http://hl7.org/fhir/ValueSet/issue-type|3.0.2)

              A code that describes the type of issue.

              Typecode
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Expresses the issue in a human and computer-friendly way, allowing the requesting system to behave differently based on the type of issue.

              56. OperationOutcome.issue.code.id
              Definition

              unique id for the element within a resource (for internal references)

              Shortxml:id (or equivalent in JSON)
              Control0..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              58. OperationOutcome.issue.code.extension
              Definition

              An Extension

              ShortExtension
              Control0..*
              TypeExtension
              SlicingThis element introduces a set of slices on OperationOutcome.issue.code.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 60. OperationOutcome.issue.code.extension:code
                Slice Namecode
                Definition

                R4B: OperationOutcome.issue.code additional codes

                ShortR4B: code additional codes
                Comments

                Element OperationOutcome.issue.code is mapped to FHIR STU3 element OperationOutcome.issue.code as RelatedTo. The mappings for OperationOutcome.issue.code do not allow expression of the necessary codes, per the bindings on the source and target.

                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(R4B: code additional codes) (Extension Type: code)
                Is Modifierfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                62. OperationOutcome.issue.code.value
                Definition

                Primitive value for code

                ShortPrimitive value for code
                Control0..1
                Typecode
                XML FormatIn the XML format, this property is represented as an attribute.
                64. OperationOutcome.issue.details
                Definition

                Additional details about the error. This may be a text description of the error, or a system code that identifies the error.

                ShortAdditional details about the error
                Comments

                A human readable description of the error issue SHOULD be placed in details.text.

                Control0..1
                BindingFor example codes, see Operation Outcome Codes
                (example to http://hl7.org/fhir/ValueSet/operation-outcome|3.0.2)

                A code that provides details as the exact issue.

                TypeCodeableConcept
                Summarytrue
                66. OperationOutcome.issue.diagnostics
                Definition

                Additional diagnostic information about the issue. Typically, this may be a description of how a value is erroneous, or a stack dump to help trace the issue.

                ShortAdditional diagnostic information about the issue
                Comments

                Typically this field is used to provide troubleshooting information about the error.

                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                68. OperationOutcome.issue.location
                Definition

                For resource issues, this will be 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. For HTTP errors, will be "http." + the parameter name.

                ShortPath of element(s) related to issue
                Comments

                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. Note that expression is being trialed as an alternative to XPath.

                Control0..*
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Requirements

                Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.

                70. OperationOutcome.issue.expression
                Definition

                A simple FHIRPath 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.

                ShortFHIRPath of element(s) related to issue
                Comments

                The root of the FHIRPath is the resource or bundle that generated OperationOutcome. Each FHIRPath SHALL resolve to a single node.

                Control0..*
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Requirements

                Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.