Operationoutcome.profile.json

StructureDefinition for operationoutcome

{
  "resourceType": "StructureDefinition",
  "id": "OperationOutcome",
  "meta": {
    "lastUpdated": "2015-04-03T14:24:32.000+11:00"
  },
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/StructureDefinition/OperationOutcome",
  "name": "OperationOutcome",
  "publisher": "HL7 FHIR Project (FHIR Management Group)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    },
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fhirmg/index.cfm"
        }
      ]
    }
  ],
  "description": "Base StructureDefinition for OperationOutcome Resource",
  "status": "draft",
  "date": "2015-04-03T14:24:32+11:00",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM"
    },
    {
      "identity": "v2",
      "uri": "http://hl7.org/v2",
      "name": "HL7 v2"
    }
  ],
  "type": "resource",
  "abstract": true,
  "snapshot": {
    "element": [
      {
        "path": "OperationOutcome",
        "short": "Information about the success/failure of an action",
        "definition": "A collection of error, warning or information messages that result from a system 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.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "DomainResource"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "Grouping is handled through multiple repetitions from whatever context references the outcomes (no specific grouper required)"
          }
        ]
      },
      {
        "path": "OperationOutcome.id",
        "short": "Logical id of this artefact",
        "definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
        "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. Bundles always have an id, though it is usually a generated UUID.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "id"
          }
        ]
      },
      {
        "path": "OperationOutcome.meta",
        "short": "Metadata about the resource",
        "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.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Meta"
          }
        ]
      },
      {
        "path": "OperationOutcome.implicitRules",
        "short": "A set of rules under which this content was created",
        "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.",
        "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 as much as possible.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "uri"
          }
        ],
        "isModifier": true
      },
      {
        "path": "OperationOutcome.language",
        "short": "Language of the resource content",
        "definition": "The base language in which the resource is written.",
        "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\n\nNot 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": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "name": "Language",
          "strength": "required",
          "description": "A human language",
          "valueSetUri": "http://tools.ietf.org/html/bcp47"
        }
      },
      {
        "path": "OperationOutcome.text",
        "short": "Text summary of the resource, for human interpretation",
        "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.",
        "comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
        "alias": [
          "narrative",
          "html",
          "xhtml",
          "display"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Narrative"
          }
        ],
        "condition": [
          "dom-1"
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "Act.text?"
          }
        ]
      },
      {
        "path": "OperationOutcome.contained",
        "short": "Contained, inline Resources",
        "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.",
        "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.",
        "alias": [
          "inline resources",
          "anonymous resources",
          "contained resources"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Resource"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "OperationOutcome.extension",
        "short": "Additional Content defined by implementations",
        "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.",
        "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.",
        "alias": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "OperationOutcome.modifierExtension",
        "short": "Extensions that cannot be ignored",
        "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.",
        "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.",
        "alias": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "isModifier": true,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "OperationOutcome.issue",
        "short": "A single issue associated with the action",
        "definition": "An error, warning or information message that results from a system action.",
        "min": 1,
        "max": "*",
        "mapping": [
          {
            "identity": "v2",
            "map": "ERR"
          },
          {
            "identity": "rim",
            "map": "AcknowledgementDetail or Observation[classCode=\"ALRT\" and moodCode=\"EVN\"]"
          }
        ]
      },
      {
        "path": "OperationOutcome.issue.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "xml:id (or equivalent in JSON)",
        "definition": "unique id for the element within a resource (for internal references).",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "id"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "path": "OperationOutcome.issue.extension",
        "short": "Additional Content defined by implementations",
        "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.",
        "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.",
        "alias": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "path": "OperationOutcome.issue.modifierExtension",
        "short": "Extensions that cannot be ignored",
        "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.",
        "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.",
        "alias": [
          "extensions",
          "user content",
          "modifiers"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "isModifier": true,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "OperationOutcome.issue.severity",
        "short": "fatal | error | warning | information",
        "definition": "Indicates whether the issue indicates a variation from successful processing.",
        "comments": "This is labeled as \"Is Modifier\" because applications should not confuse hints and warnings with errors.",
        "requirements": "Indicates how relevant the issue is to the overall success of the action.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "isModifier": true,
        "binding": {
          "name": "IssueSeverity",
          "strength": "required",
          "description": "How the issue affects the success of the action",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/issue-severity"
          }
        },
        "mapping": [
          {
            "identity": "v2",
            "map": "ERR-4"
          },
          {
            "identity": "rim",
            "map": "./typeCode[parent::AcknowledgmentDetail] or unique(./inboundRelationship[parent::Observation and typeCode='SUBJ' and isNormalActRelationship()]/source[classCode=\"OBS\" and moodCode=\"EVN\" and implies(code, ActCode#SEV and isNormalAct())/value[xsi:type=\"CD\"]"
          }
        ]
      },
      {
        "path": "OperationOutcome.issue.code",
        "short": "Error or warning code",
        "definition": "Describes the type of the issue.",
        "requirements": "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": 1,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "name": "IssueType",
          "strength": "required",
          "description": "A coded expression of the type of issue",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/issue-type"
          }
        },
        "mapping": [
          {
            "identity": "v2",
            "map": "ERR-3, ERR-5"
          },
          {
            "identity": "rim",
            "map": "./code"
          }
        ]
      },
      {
        "path": "OperationOutcome.issue.details",
        "short": "Additional diagnostic information about the issue",
        "definition": "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": "typically this field is used to provide troubleshooting information about the error.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "mapping": [
          {
            "identity": "v2",
            "map": "ERR-8"
          },
          {
            "identity": "rim",
            "map": "./text[parent::AcknowledgmentDetail]"
          }
        ]
      },
      {
        "path": "OperationOutcome.issue.location",
        "short": "XPath of element(s) related to issue",
        "definition": "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": "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": "Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "string"
          }
        ],
        "mapping": [
          {
            "identity": "v2",
            "map": "ERR-2"
          },
          {
            "identity": "rim",
            "map": "./location[parent::AcknowledgmentDetail]"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "path": "OperationOutcome",
        "short": "Information about the success/failure of an action",
        "definition": "A collection of error, warning or information messages that result from a system 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.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "DomainResource"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "Grouping is handled through multiple repetitions from whatever context references the outcomes (no specific grouper required)"
          }
        ]
      },
      {
        "path": "OperationOutcome.issue",
        "short": "A single issue associated with the action",
        "definition": "An error, warning or information message that results from a system action.",
        "min": 1,
        "max": "*",
        "mapping": [
          {
            "identity": "v2",
            "map": "ERR"
          },
          {
            "identity": "rim",
            "map": "AcknowledgementDetail or Observation[classCode=\"ALRT\" and moodCode=\"EVN\"]"
          }
        ]
      },
      {
        "path": "OperationOutcome.issue.severity",
        "short": "fatal | error | warning | information",
        "definition": "Indicates whether the issue indicates a variation from successful processing.",
        "comments": "This is labeled as \"Is Modifier\" because applications should not confuse hints and warnings with errors.",
        "requirements": "Indicates how relevant the issue is to the overall success of the action.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "isModifier": true,
        "binding": {
          "name": "IssueSeverity",
          "strength": "required",
          "description": "How the issue affects the success of the action",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/issue-severity"
          }
        },
        "mapping": [
          {
            "identity": "v2",
            "map": "ERR-4"
          },
          {
            "identity": "rim",
            "map": "./typeCode[parent::AcknowledgmentDetail] or unique(./inboundRelationship[parent::Observation and typeCode='SUBJ' and isNormalActRelationship()]/source[classCode=\"OBS\" and moodCode=\"EVN\" and implies(code, ActCode#SEV and isNormalAct())/value[xsi:type=\"CD\"]"
          }
        ]
      },
      {
        "path": "OperationOutcome.issue.code",
        "short": "Error or warning code",
        "definition": "Describes the type of the issue.",
        "requirements": "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": 1,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "name": "IssueType",
          "strength": "required",
          "description": "A coded expression of the type of issue",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/issue-type"
          }
        },
        "mapping": [
          {
            "identity": "v2",
            "map": "ERR-3, ERR-5"
          },
          {
            "identity": "rim",
            "map": "./code"
          }
        ]
      },
      {
        "path": "OperationOutcome.issue.details",
        "short": "Additional diagnostic information about the issue",
        "definition": "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": "typically this field is used to provide troubleshooting information about the error.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "mapping": [
          {
            "identity": "v2",
            "map": "ERR-8"
          },
          {
            "identity": "rim",
            "map": "./text[parent::AcknowledgmentDetail]"
          }
        ]
      },
      {
        "path": "OperationOutcome.issue.location",
        "short": "XPath of element(s) related to issue",
        "definition": "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": "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": "Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "string"
          }
        ],
        "mapping": [
          {
            "identity": "v2",
            "map": "ERR-2"
          },
          {
            "identity": "rim",
            "map": "./location[parent::AcknowledgmentDetail]"
          }
        ]
      }
    ]
  }
}