MyOutcome-SGES (OperationOutcome) | I | OperationOutcome | There are no (further) constraints on this element Element idOperationOutcome Information about the success/failure of an action DefinitionA collection of error, warning or information messages that result from a system action. 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.
| |
id | Σ | 1..1 | id | There are no (further) constraints on this element Element idOperationOutcome.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
|
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idOperationOutcome.meta Metadata about the resource DefinitionThe 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.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idOperationOutcome.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. 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.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idOperationOutcome.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language. Common Languages (extensible)Constraints
| |
text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idOperationOutcome.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
|
contained | 0..* | Resource | There are no (further) constraints on this element Element idOperationOutcome.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idOperationOutcome.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idOperationOutcome.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
issue | Σ | 1..* | BackboneElement | There are no (further) constraints on this element Element idOperationOutcome.issue A single issue associated with the action DefinitionAn error, warning or information message that results from a system action.
|
id | 0..1 | string | There are no (further) constraints on this element Element idOperationOutcome.issue.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idOperationOutcome.issue.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idOperationOutcome.issue.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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. 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.
|
severity | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idOperationOutcome.issue.severity fatal | error | warning | information DefinitionIndicates whether the issue indicates a variation from successful processing. Indicates how relevant the issue is to the overall success of the action. This is labeled as "Is Modifier" because applications should not confuse hints and warnings with errors. How the issue affects the success of the action. IssueSeverity (required)Constraints
|
code | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idOperationOutcome.issue.code Error or warning code DefinitionDescribes 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. Expresses the issue in a human and computer-friendly way, allowing the requesting system to behave differently based on the type of issue. Note that FHIR strings may not exceed 1MB in size A code that describes the type of issue. IssueType (required)Constraints
|
details | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idOperationOutcome.issue.details Additional details about the error DefinitionAdditional details about the error. This may be a text description of the error, or a system code that identifies the error. A human readable description of the error issue SHOULD be placed in details.text. A code that provides details as the exact issue. Operation Outcome Codes (example)Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idOperationOutcome.issue.details.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idOperationOutcome.issue.details.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idOperationOutcome.issue.details.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
id | 0..1 | string | There are no (further) constraints on this element Element idOperationOutcome.issue.details.coding.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idOperationOutcome.issue.details.coding.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idOperationOutcome.issue.details.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idOperationOutcome.issue.details.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element idOperationOutcome.issue.details.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size
|
display | Σ | 1..1 | string | There are no (further) constraints on this element Element idOperationOutcome.issue.details.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idOperationOutcome.issue.details.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idOperationOutcome.issue.details.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
diagnostics | Σ | 0..1 | string | There are no (further) constraints on this element Element idOperationOutcome.issue.diagnostics Additional diagnostic information about the issue DefinitionAdditional 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. Typically this field is used to provide troubleshooting information about the error.
|
location | Σ | 0..* | string | There are no (further) constraints on this element Element idOperationOutcome.issue.location Path of element(s) related to issue DefinitionFor 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. Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily. 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.
|
expression | Σ | 0..* | string | There are no (further) constraints on this element Element idOperationOutcome.issue.expression FHIRPath of element(s) related to issue DefinitionA 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. Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily. The root of the FHIRPath is the resource or bundle that generated OperationOutcome. Each FHIRPath SHALL resolve to a single node.
|
OperationOutcome | 0..* | |
OperationOutcome.id | id | 1..1 |
OperationOutcome.meta | Meta | 0..1 |
OperationOutcome.implicitRules | uri | 0..1 |
OperationOutcome.language | code | 0..1 |
OperationOutcome.text | Narrative | 0..1 |
OperationOutcome.contained | Resource | 0..* |
OperationOutcome.extension | Extension | 0..* |
OperationOutcome.modifierExtension | Extension | 0..* |
OperationOutcome.issue | BackboneElement | 1..* |
OperationOutcome.issue.id | string | 0..1 |
OperationOutcome.issue.extension | Extension | 0..* |
OperationOutcome.issue.modifierExtension | Extension | 0..* |
OperationOutcome.issue.severity | code | 1..1 |
OperationOutcome.issue.code | code | 1..1 |
OperationOutcome.issue.details | CodeableConcept | 1..1 |
OperationOutcome.issue.details.id | string | 0..1 |
OperationOutcome.issue.details.extension | Extension | 0..* |
OperationOutcome.issue.details.coding | Coding | 0..* |
OperationOutcome.issue.details.coding.id | string | 0..1 |
OperationOutcome.issue.details.coding.extension | Extension | 0..* |
OperationOutcome.issue.details.coding.system | uri | 1..1 |
OperationOutcome.issue.details.coding.version | string | 0..1 |
OperationOutcome.issue.details.coding.code | code | 1..1 |
OperationOutcome.issue.details.coding.display | string | 1..1 |
OperationOutcome.issue.details.coding.userSelected | boolean | 0..1 |
OperationOutcome.issue.details.text | string | 0..1 |
OperationOutcome.issue.diagnostics | string | 0..1 |
OperationOutcome.issue.location | string | 0..* |
OperationOutcome.issue.expression | string | 0..* |