Guia de Implementação da SES GO - Segurança
0.1.0 - draft Brazil flag

Guia de Implementação da SES GO - Segurança - Downloaded Version 0.1.0 See the Directory of published versions

Perfil: OperationOutcomeAssinatura - Descrição detalhada

Active as of 2025-01-01

Definições para operation-outcome-assinatura perfil.

Instruções sobre como interpretar o conteúdo desta tabela podem ser encontradashere

0. OperationOutcome
2. OperationOutcome.issue
Deve apoiartrue
4. OperationOutcome.issue.severity
Definição

A severidade deve ser mapeada automaticamente com base na propriedade 'severity' definida no CodeSystem SituacaoExcepcionalAssinatura

CurtoSeveridade determinada pelo código da situação excepcional
Deve apoiartrue
6. OperationOutcome.issue.code
Deve apoiartrue
8. OperationOutcome.issue.details
Controlo1..?
Deve apoiartrue
10. OperationOutcome.issue.details.coding
Controlo1..?
Deve apoiartrue
SlicingEste elemento introduz um conjunto de fatias em OperationOutcome.issue.details.coding. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
  • value @ system
  • 12. OperationOutcome.issue.details.coding:situacaoExcepcional
    Nome da fatiasituacaoExcepcional
    Controlo1..1
    VínculoOs códigos DEVERÃO ser retirados de ValueSet de Situações Excepcionais de Assinatura Digital
    (required to https://fhir.saude.go.gov.br/r4/seguranca/ValueSet/situacao-excepcional-assinatura-vs)
    Deve apoiartrue
    14. OperationOutcome.issue.details.coding:situacaoExcepcional.system
    Controlo1..?
    Valor fixohttps://fhir.saude.go.gov.br/r4/seguranca/CodeSystem/situacao-excepcional-assinatura
    16. OperationOutcome.issue.details.coding:situacaoExcepcional.code
    Controlo1..?
    Deve apoiartrue
    18. OperationOutcome.issue.details.text
    Controlo1..?
    Deve apoiartrue
    20. OperationOutcome.issue.diagnostics
    Deve apoiartrue
    22. OperationOutcome.issue.location
    Deve apoiartrue

    Instruções sobre como interpretar o conteúdo desta tabela podem ser encontradashere

    0. OperationOutcome
    Definição

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

    CurtoInformation about the success/failure of an action
    Comentários

    Can result from the failure of a REST call or be part of the response message returned from a request message.

    Controlo0..*
    É modificadorfalse
    Resumofalse
    Invariantesdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
    dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
    dom-6: A resource should have narrative for robust management (text.`div`.exists())
    2. OperationOutcome.implicitRules
    Definição

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

    CurtoA set of rules under which this content was created
    Comentários

    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.

    Controlo0..1
    Tipouri
    É modificadortrue porque This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
    Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
    Resumotrue
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    4. OperationOutcome.modifierExtension
    Definição

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

    CurtoExtensions that cannot be ignored
    Comentários

    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.

    Controlo0..*
    TipoExtension
    É modificadortrue porque Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Resumofalse
    Requisitos

    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.

    Nomes alternativosextensions, user content
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    6. OperationOutcome.issue
    Definição

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

    CurtoA single issue associated with the action
    Controlo1..*
    TipoBackboneElement
    É modificadorfalse
    Deve apoiartrue
    Resumotrue
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    8. OperationOutcome.issue.modifierExtension
    Definição

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

    CurtoExtensions that cannot be ignored even if unrecognized
    Comentários

    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.

    Controlo0..*
    TipoExtension
    É modificadortrue porque Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Resumotrue
    Requisitos

    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.

    Nomes alternativosextensions, user content, modifiers
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. OperationOutcome.issue.severity
    Definição

    A severidade deve ser mapeada automaticamente com base na propriedade 'severity' definida no CodeSystem SituacaoExcepcionalAssinatura


    Indicates whether the issue indicates a variation from successful processing.

    CurtoSeveridade determinada pelo código da situação excepcionalfatal | error | warning | information
    Comentários

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

    Controlo1..1
    VínculoOs códigos DEVERÃO ser retirados de IssueSeverityhttp://hl7.org/fhir/ValueSet/issue-severity|4.0.1
    (required to http://hl7.org/fhir/ValueSet/issue-severity|4.0.1)

    How the issue affects the success of the action.

    Tipocode
    É modificadorfalse
    Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
    Deve apoiartrue
    Resumotrue
    Requisitos

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

    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. OperationOutcome.issue.code
    Definição

    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.

    CurtoError or warning code
    Controlo1..1
    VínculoOs códigos DEVERÃO ser retirados de IssueTypehttp://hl7.org/fhir/ValueSet/issue-type|4.0.1
    (required to http://hl7.org/fhir/ValueSet/issue-type|4.0.1)

    A code that describes the type of issue.

    Tipocode
    É modificadorfalse
    Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
    Deve apoiartrue
    Resumotrue
    Requisitos

    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.

    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. OperationOutcome.issue.details
    Definição

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

    CurtoAdditional details about the error
    Comentários

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

    Controlo10..1
    VínculoPara exemplos de códigos, ver OperationOutcomeCodeshttp://hl7.org/fhir/ValueSet/operation-outcome
    (example to http://hl7.org/fhir/ValueSet/operation-outcome)

    A code that provides details as the exact issue.

    TipoCodeableConcept
    É modificadorfalse
    Deve apoiartrue
    Resumotrue
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. OperationOutcome.issue.details.coding
    Definição

    A reference to a code defined by a terminology system.

    CurtoCode defined by a terminology system
    Comentários

    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.

    Controlo10..*
    TipoCoding
    É modificadorfalse
    Deve apoiartrue
    Resumotrue
    Requisitos

    Allows for alternative encodings within a code system, and translations to other code systems.

    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingEste elemento introduz um conjunto de fatias em OperationOutcome.issue.details.coding. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
    • value @ system
    • 18. OperationOutcome.issue.details.coding:situacaoExcepcional
      Nome da fatiasituacaoExcepcional
      Definição

      A reference to a code defined by a terminology system.

      CurtoCode defined by a terminology system
      Comentários

      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.

      Controlo10..1*
      VínculoOs códigos DEVERÃO ser retirados de Para códigos, ver ValueSet de Situações Excepcionais de Assinatura Digital
      (required to https://fhir.saude.go.gov.br/r4/seguranca/ValueSet/situacao-excepcional-assinatura-vs)
      TipoCoding
      É modificadorfalse
      Deve apoiartrue
      Resumotrue
      Requisitos

      Allows for alternative encodings within a code system, and translations to other code systems.

      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      20. OperationOutcome.issue.details.coding:situacaoExcepcional.system
      Definição

      The identification of the code system that defines the meaning of the symbol in the code.

      CurtoIdentity of the terminology system
      Comentários

      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 reference to some definition that establishes the system clearly and unambiguously.

      Controlo10..1
      Tipouri
      É modificadorfalse
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Resumotrue
      Requisitos

      Need to be unambiguous about the source of the definition of the symbol.

      Valor fixohttps://fhir.saude.go.gov.br/r4/seguranca/CodeSystem/situacao-excepcional-assinatura
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      22. OperationOutcome.issue.details.coding:situacaoExcepcional.code
      Definição

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

      CurtoSymbol in syntax defined by the system
      Controlo10..1
      Tipocode
      É modificadorfalse
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Deve apoiartrue
      Resumotrue
      Requisitos

      Need to refer to a particular code in the system.

      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      24. OperationOutcome.issue.details.text
      Definição

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

      CurtoPlain text representation of the concept
      Comentários

      Very often the text is the same as a displayName of one of the codings.

      Controlo10..1
      Tipostring
      É modificadorfalse
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Deve apoiartrue
      Resumotrue
      Requisitos

      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.

      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      26. OperationOutcome.issue.diagnostics
      Definição

      Additional diagnostic information about the issue.

      CurtoAdditional diagnostic information about the issue
      Comentários

      This may be a description of how a value is erroneous, a stack dump to help trace the issue or other troubleshooting information.

      Controlo0..1
      Tipostring
      É modificadorfalse
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Deve apoiartrue
      Resumotrue
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      28. OperationOutcome.issue.location
      Definição

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

      CurtoDeprecated: Path of element(s) related to issue
      Comentários

      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.

      Controlo0..*
      Tipostring
      É modificadorfalse
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Deve apoiartrue
      Resumotrue
      Requisitos

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

      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

      Instruções sobre como interpretar o conteúdo desta tabela podem ser encontradashere

      0. OperationOutcome
      Definição

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

      CurtoInformation about the success/failure of an action
      Comentários

      Can result from the failure of a REST call or be part of the response message returned from a request message.

      Controlo0..*
      É modificadorfalse
      Resumofalse
      Invariantesdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
      dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
      dom-6: A resource should have narrative for robust management (text.`div`.exists())
      2. OperationOutcome.id
      Definição

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

      CurtoLogical id of this artifact
      Comentários

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

      Controlo0..1
      Tipoid
      É modificadorfalse
      Resumotrue
      4. OperationOutcome.meta
      Definição

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

      CurtoMetadata about the resource
      Controlo0..1
      TipoMeta
      É modificadorfalse
      Resumotrue
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      6. OperationOutcome.implicitRules
      Definição

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

      CurtoA set of rules under which this content was created
      Comentários

      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.

      Controlo0..1
      Tipouri
      É modificadortrue porque This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Resumotrue
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      8. OperationOutcome.language
      Definição

      The base language in which the resource is written.

      CurtoLanguage of the resource content
      Comentários

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

      Controlo0..1
      VínculoOs códigos DEVERÃO ser retirados de CommonLanguages
      (preferred to http://hl7.org/fhir/ValueSet/languages)

      A human language.

      Vínculos adicionaisObjetivo
      AllLanguagesVínculo máximo
      Tipocode
      É modificadorfalse
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Resumofalse
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      10. OperationOutcome.text
      Definição

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

      CurtoText summary of the resource, for human interpretation
      Comentários

      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.

      Controlo0..1
      TipoNarrative
      É modificadorfalse
      Resumofalse
      Nomes alternativosnarrative, html, xhtml, display
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      12. OperationOutcome.contained
      Definição

      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.

      CurtoContained, inline Resources
      Comentários

      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.

      Controlo0..*
      TipoResource
      É modificadorfalse
      Resumofalse
      Nomes alternativosinline resources, anonymous resources, contained resources
      14. OperationOutcome.extension
      Definição

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

      CurtoAdditional content defined by implementations
      Comentários

      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.

      Controlo0..*
      TipoExtension
      É modificadorfalse
      Resumofalse
      Nomes alternativosextensions, user content
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      16. OperationOutcome.modifierExtension
      Definição

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

      CurtoExtensions that cannot be ignored
      Comentários

      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.

      Controlo0..*
      TipoExtension
      É modificadortrue porque Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
      Resumofalse
      Requisitos

      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.

      Nomes alternativosextensions, user content
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      18. OperationOutcome.issue
      Definição

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

      CurtoA single issue associated with the action
      Controlo1..*
      TipoBackboneElement
      É modificadorfalse
      Deve apoiartrue
      Resumotrue
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      20. OperationOutcome.issue.id
      Definição

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

      CurtoUnique id for inter-element referencing
      Controlo0..1
      Tipostring
      É modificadorfalse
      Formato XMLNo formato XML, esta propriedade é representada como um atributo.
      Resumofalse
      22. OperationOutcome.issue.extension
      Definição

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

      CurtoAdditional content defined by implementations
      Comentários

      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.

      Controlo0..*
      TipoExtension
      É modificadorfalse
      Resumofalse
      Nomes alternativosextensions, user content
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      24. OperationOutcome.issue.modifierExtension
      Definição

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

      CurtoExtensions that cannot be ignored even if unrecognized
      Comentários

      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.

      Controlo0..*
      TipoExtension
      É modificadortrue porque Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Resumotrue
      Requisitos

      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.

      Nomes alternativosextensions, user content, modifiers
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      26. OperationOutcome.issue.severity
      Definição

      A severidade deve ser mapeada automaticamente com base na propriedade 'severity' definida no CodeSystem SituacaoExcepcionalAssinatura

      CurtoSeveridade determinada pelo código da situação excepcional
      Comentários

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

      Controlo1..1
      VínculoOs códigos DEVERÃO ser retirados de IssueSeverity
      (required to http://hl7.org/fhir/ValueSet/issue-severity|4.0.1)

      How the issue affects the success of the action.

      Tipocode
      É modificadorfalse
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Deve apoiartrue
      Resumotrue
      Requisitos

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

      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      28. OperationOutcome.issue.code
      Definição

      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.

      CurtoError or warning code
      Controlo1..1
      VínculoOs códigos DEVERÃO ser retirados de IssueType
      (required to http://hl7.org/fhir/ValueSet/issue-type|4.0.1)

      A code that describes the type of issue.

      Tipocode
      É modificadorfalse
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Deve apoiartrue
      Resumotrue
      Requisitos

      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.

      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      30. OperationOutcome.issue.details
      Definição

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

      CurtoAdditional details about the error
      Comentários

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

      Controlo1..1
      VínculoPara exemplos de códigos, ver OperationOutcomeCodes
      (example to http://hl7.org/fhir/ValueSet/operation-outcome)

      A code that provides details as the exact issue.

      TipoCodeableConcept
      É modificadorfalse
      Deve apoiartrue
      Resumotrue
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      32. OperationOutcome.issue.details.id
      Definição

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

      CurtoUnique id for inter-element referencing
      Controlo0..1
      Tipostring
      É modificadorfalse
      Formato XMLNo formato XML, esta propriedade é representada como um atributo.
      Resumofalse
      34. OperationOutcome.issue.details.extension
      Definição

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

      CurtoAdditional content defined by implementations
      Comentários

      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.

      Controlo0..*
      TipoExtension
      É modificadorfalse
      Resumofalse
      Nomes alternativosextensions, user content
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingEste elemento introduz um conjunto de fatias em OperationOutcome.issue.details.extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
      • value @ url
      • 36. OperationOutcome.issue.details.coding
        Definição

        A reference to a code defined by a terminology system.

        CurtoCode defined by a terminology system
        Comentários

        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.

        Controlo1..*
        TipoCoding
        É modificadorfalse
        Deve apoiartrue
        Resumotrue
        Requisitos

        Allows for alternative encodings within a code system, and translations to other code systems.

        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        SlicingEste elemento introduz um conjunto de fatias em OperationOutcome.issue.details.coding. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
        • value @ system
        • 38. OperationOutcome.issue.details.coding:situacaoExcepcional
          Nome da fatiasituacaoExcepcional
          Definição

          A reference to a code defined by a terminology system.

          CurtoCode defined by a terminology system
          Comentários

          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.

          Controlo1..1
          VínculoOs códigos DEVERÃO ser retirados de ValueSet de Situações Excepcionais de Assinatura Digital
          (required to https://fhir.saude.go.gov.br/r4/seguranca/ValueSet/situacao-excepcional-assinatura-vs)
          TipoCoding
          É modificadorfalse
          Deve apoiartrue
          Resumotrue
          Requisitos

          Allows for alternative encodings within a code system, and translations to other code systems.

          Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          40. OperationOutcome.issue.details.coding:situacaoExcepcional.id
          Definição

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

          CurtoUnique id for inter-element referencing
          Controlo0..1
          Tipostring
          É modificadorfalse
          Formato XMLNo formato XML, esta propriedade é representada como um atributo.
          Resumofalse
          42. OperationOutcome.issue.details.coding:situacaoExcepcional.extension
          Definição

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

          CurtoAdditional content defined by implementations
          Comentários

          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.

          Controlo0..*
          TipoExtension
          É modificadorfalse
          Resumofalse
          Nomes alternativosextensions, user content
          Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          SlicingEste elemento introduz um conjunto de fatias em OperationOutcome.issue.details.coding.extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
          • value @ url
          • 44. OperationOutcome.issue.details.coding:situacaoExcepcional.system
            Definição

            The identification of the code system that defines the meaning of the symbol in the code.

            CurtoIdentity of the terminology system
            Comentários

            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 reference to some definition that establishes the system clearly and unambiguously.

            Controlo1..1
            Tipouri
            É modificadorfalse
            Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
            Resumotrue
            Requisitos

            Need to be unambiguous about the source of the definition of the symbol.

            Valor fixohttps://fhir.saude.go.gov.br/r4/seguranca/CodeSystem/situacao-excepcional-assinatura
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            46. OperationOutcome.issue.details.coding:situacaoExcepcional.version
            Definição

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

            CurtoVersion of the system - if relevant
            Comentários

            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.

            NotaEste é um ID de versão comercial, não um ID de versão de recurso (ver discussão)
            Controlo0..1
            Tipostring
            É modificadorfalse
            Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
            Resumotrue
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            48. OperationOutcome.issue.details.coding:situacaoExcepcional.code
            Definição

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

            CurtoSymbol in syntax defined by the system
            Controlo1..1
            Tipocode
            É modificadorfalse
            Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
            Deve apoiartrue
            Resumotrue
            Requisitos

            Need to refer to a particular code in the system.

            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            50. OperationOutcome.issue.details.coding:situacaoExcepcional.display
            Definição

            A representation of the meaning of the code in the system, following the rules of the system.

            CurtoRepresentation defined by the system
            Controlo0..1
            Tipostring
            É modificadorfalse
            Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
            Resumotrue
            Requisitos

            Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            52. OperationOutcome.issue.details.coding:situacaoExcepcional.userSelected
            Definição

            Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

            CurtoIf this coding was chosen directly by the user
            Comentários

            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.

            Controlo0..1
            Tipoboolean
            É modificadorfalse
            Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
            Resumotrue
            Requisitos

            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.

            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            54. OperationOutcome.issue.details.text
            Definição

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

            CurtoPlain text representation of the concept
            Comentários

            Very often the text is the same as a displayName of one of the codings.

            Controlo1..1
            Tipostring
            É modificadorfalse
            Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
            Deve apoiartrue
            Resumotrue
            Requisitos

            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.

            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            56. OperationOutcome.issue.diagnostics
            Definição

            Additional diagnostic information about the issue.

            CurtoAdditional diagnostic information about the issue
            Comentários

            This may be a description of how a value is erroneous, a stack dump to help trace the issue or other troubleshooting information.

            Controlo0..1
            Tipostring
            É modificadorfalse
            Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
            Deve apoiartrue
            Resumotrue
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            58. OperationOutcome.issue.location
            Definição

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

            CurtoDeprecated: Path of element(s) related to issue
            Comentários

            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.

            Controlo0..*
            Tipostring
            É modificadorfalse
            Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
            Deve apoiartrue
            Resumotrue
            Requisitos

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

            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            60. OperationOutcome.issue.expression
            Definição

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

            CurtoFHIRPath of element(s) related to issue
            Comentários

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

            Controlo0..*
            Tipostring
            É modificadorfalse
            Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
            Resumotrue
            Requisitos

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

            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))