The formal definitions for the elements in the issuereport resource. Also available as an XML file.
IssueReport |
Definition | Error, warning or information messages that result from a system action |
Control | 1..1 |
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. |
IssueReport.issue |
Definition | An error, warning or information message that results from a system action |
Control | 1..* |
RIM Mapping | AcknowledgementDetail or Observation[classCode="ALRT" and moodCode="EVN"] |
v2 Mapping | ERR |
IssueReport.issue.severity |
Definition | Indicates whether the issue indicates a variation from successful processing |
Control | 1..1 |
Type | code from IssueSeverity |
Must Understand | true |
Requirements | Indicates how relevant the issue is to the overall success of the action. |
RIM Mapping | ./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"] |
v2 Mapping | ERR-4 |
IssueReport.issue.type |
Definition | A code indicating the type of error, warning or information message. |
Control | 0..1 |
Type | CodeableConcept from IssueType |
Requirements | Expresses the issue in a computer-friendly way, allowing the requesting system to behave differently based on the type of issue. |
Comments | 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. |
RIM Mapping | ./code |
v2 Mapping | ERR-3, ERR-5 |
To Do | Do we want to define an initial set of codes, or should we leave all of this to profiles? |
IssueReport.issue.details |
Definition | Additional description of the issue |
Control | 0..1 |
Type | string |
Comments | typically this field is used to provide details human readable information about the error |
RIM Mapping | ./text[parent::AcknowledgmentDetail] |
v2 Mapping | ERR-8 |
IssueReport.issue.location |
Definition | A simple XPath limited to element names, repetition indicators and the default child access that identifies one of the elements in the request message that caused this issue to be raised. |
Control | 0..* |
Type | string |
Requirements | Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily. |
Comments | The root of the XPath is the Atom feed for documents & messages, the request resource when responding to RESTful commands. Each XPath must resolve to a single node. The XPath syntax is used whether the referenced instance Is expressed in XML or JSON. |
RIM Mapping | ./location[parent::AcknowledgmentDetail] |
v2 Mapping | ERR-2 |
IssueReport.extension |
Definition | See Extensions |
Control | 0..* |
Type | Extension |
IssueReport.text |
Definition | Text summary of resource (for human interpretation) |
Control | 1..1 |
Type | Narrative |