ProfilesPTTransversais/OperationOutcomePTTRV.StructureDefinition.json
OperationOutcomePTTRV (OperationOutcome) | I | OperationOutcomePTCore | 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.
| |
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 | MetaPTCore | 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 might 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
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). IETF language tag
| |
text | 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 can 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 information is added later.
| |
contained | I | 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
|
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. 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 can 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of 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 DefinitionUm conjunto de mensagens de erro, de aviso ou de informação que resultam de uma ação do sistema.
|
id | 0..1 | id | There are no (further) constraints on this element Element idOperationOutcome.issue.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
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. 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 can 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 even if unrecognized 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of 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 | Element idOperationOutcome.issue.severity fatal | error | warning | information DefinitionObrigatório usar um dos seguintes elementos: “fatal” - O problema fez com que a ação falhasse e nenhuma verificação adicional foi executada. “error” - O erro é suficientemente importante para fazer com que a ação falhe. “warning” - O problema não é importante o suficiente para fazer com que a ação falhe, mas pode fazer com que seja executada de uma maneira que não seja com a qualidade desejada. “information” - a ação foi executada com sucesso. 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.
|
code | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idOperationOutcome.issue.code Error or warning code DefinitionCódigo de problema. Expresses the issue in a human and computer-friendly way, allowing the requesting system to behave differently based on the type of issue. The required element provides a base level of computable interoperability across all systems for processing an outcome, allowing systems to respond appropriately regardless of the internal system error codes returned. Note that FHIR strings SHALL NOT exceed 1MB in size A code that describes the type of issue.
|
details | Σ | 0..1 | CodeableConceptPTCore | Element idOperationOutcome.issue.details Concept - reference to a terminology or just text DefinitionInformação codificada adicional de acordo com o valor no elemento issue.severity Usar o system específico para o negócio, caso exista, ou o system do FHIR: http://terminology.hl7.org/CodeSystem/operation-outcome Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Unordered, Open, by id(Value) BindingA code that provides details as the exact issue.
|
outcomeBroker | Σ | 0..1 | CodeableConceptPTCoreBinding | There are no (further) constraints on this element Element idOperationOutcome.issue.details:outcomeBroker Concept - reference to a terminology or just text DefinitionIdentifica a lista de erros devolvida pelo broker nacional. Value Set: <a href="https://simplifier.net/portuguese-fhir-r4b-profiles-dev/errorbroker">ErrorBroker</a> A code that provides details as the exact issue.
|
id | 0..1 | idFixed Value | There are no (further) constraints on this element Element idOperationOutcome.issue.details:outcomeBroker.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. outcomeBroker
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idOperationOutcome.issue.details:outcomeBroker.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. 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 can 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..* | CodingPTCore | There are no (further) constraints on this element Element idOperationOutcome.issue.details:outcomeBroker.coding A reference to a code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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.
|
text | Σ | 1..1 | string | There are no (further) constraints on this element Element idOperationOutcome.issue.details:outcomeBroker.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.
|
outcomeBusinessIOP | Σ | 0..1 | CodeableConceptPTCoreBinding | There are no (further) constraints on this element Element idOperationOutcome.issue.details:outcomeBusinessIOP Concept - reference to a terminology or just text DefinitionIdentifica listas de erros específicas do negócio. Value Set: <a href="https://simplifier.net/portuguese-fhir-r4b-profiles-dev/errorbusiness">ErrorBusiness</a> A code that provides details as the exact issue.
|
id | 0..1 | idFixed Value | There are no (further) constraints on this element Element idOperationOutcome.issue.details:outcomeBusinessIOP.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. outcomeBusinessIOP
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idOperationOutcome.issue.details:outcomeBusinessIOP.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. 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 can 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..* | CodingPTCore | There are no (further) constraints on this element Element idOperationOutcome.issue.details:outcomeBusinessIOP.coding A reference to a code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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.
|
text | Σ | 1..1 | string | There are no (further) constraints on this element Element idOperationOutcome.issue.details:outcomeBusinessIOP.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 DefinitionInformação adicional sobre o problema This may be a description of how a value is erroneous, a stack dump to help trace the issue or other troubleshooting information.
|
location | Σ | 0..0 | string | There are no (further) constraints on this element Element idOperationOutcome.issue.location Deprecated: Path of element(s) related to issue DefinitionThis element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse. For resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor 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. This element is deprecated, and is being replaced by expression.
|
expression | Σ | 0..* | string | There are no (further) constraints on this element Element idOperationOutcome.issue.expression FHIRPath of element(s) related to issue DefinitionInformação auxiliar que permite que os sistemas orientem os usuários para os recursos ou elementos que causaram os problemas, auxiliando assim a correção dos mesmos. O texto deve respeitar as regras do subconjunto restrito do FHIRPath. 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.
|
Binding
Path | Strength | ValueSet | Comment |
---|---|---|---|
OperationOutcome.issue.details outcomeBroker | preferred | Value Set: ErrorBroker | |
OperationOutcome.issue.details outcomeBusinessIOP | preferred | Value Set: ErrorBusiness |
Binding do FHIR Required
Path | Strength | ValueSet |
---|---|---|
OperationOutcome.issue.severity |
required |
IssueSeverity |
OperationOutcome.issue.code |
required |
IssueType |
Identifiers Type
Estes Identificadores devem ser utilizados no elemento
identifier.type.coding[*]
Regras de implementação
Para além das constraints identificadas pelo FHIR para este recurso devem ser consideradas as constraints que identificamos na tabela infra.