HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1
1.0.0 - STU1 Portugal flag

HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1, publicado por HL7 Portugal. Este guia não é uma publicação autorizada; é a compilação contínua para a versão 1.0.0 construída pela FHIR (HL7® FHIR® Standard) CI Build. Esta versão é baseada no conteúdo atual de https://github.com/hl7-pt/patient-admin-ig/ e muda regularmente. Veja o Diretório de versões publicadas

Extension: PTCoverageReason - Detailed Descriptions

Active as of 2025-12-18

Definitions for the coverage-reason-pt extension.

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

0. Extension
Definição

An Extension


Optional Extension Element - found in all resources.

Curtomotivo de isençãoOptional Extensions Element
Controlo0..*
Este elemento é afetado pelas seguintes invariantes: ele-1
É modificadorfalse
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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.extension
Definição

An Extension


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.

CurtoExtensionAdditional 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..0*
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 Extension.extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
  • value @ url
  • 4. Extension.url
    Definição

    Source of the definition for the extension code - a logical name or a URL.

    Curtoidentifies the meaning of the extension
    Comentários

    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

    Controlo1..1
    Tipouri
    É modificadorfalse
    Formato XMLNo formato XML, esta propriedade é representada como um atributo.
    Resumofalse
    Valor fixohttp://example.com/fhir/hl7pt/StructureDefinition/coverage-reason-pt
    6. Extension.value[x]
    Definição

    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    CurtoValue of extension
    Controlo10..1
    TipoCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NotaVerEscolha de tipos de dadospara mais informações sobre como utilizar [x]
    É modificadorfalse
    Resumofalse
    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. Extension
    Curtomotivo de isenção
    2. Extension.extension
    Controlo0..0
    4. Extension.url
    Valor fixohttp://example.com/fhir/hl7pt/StructureDefinition/coverage-reason-pt
    6. Extension.value[x]
    Controlo1..?
    TipoCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NotaVerEscolha de tipos de dadospara mais informações sobre como utilizar [x]
    8. Extension.value[x].coding
    10. Extension.value[x].coding.system
    Valor do padrãohttp://example.org/SONHO

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

    0. Extension
    Definição

    An Extension

    Curtomotivo de isenção
    Controlo0..*
    Este elemento é afetado pelas seguintes invariantes: ele-1
    É modificadorfalse
    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())
    2. Extension.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
    4. Extension.extension
    Definição

    An Extension

    CurtoExtension
    Controlo0..0
    TipoExtension
    É modificadorfalse
    Resumofalse
    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 Extension.extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
    • value @ url
    • 6. Extension.url
      Definição

      Source of the definition for the extension code - a logical name or a URL.

      Curtoidentifies the meaning of the extension
      Comentários

      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

      Controlo1..1
      Tipouri
      É modificadorfalse
      Formato XMLNo formato XML, esta propriedade é representada como um atributo.
      Resumofalse
      Valor fixohttp://example.com/fhir/hl7pt/StructureDefinition/coverage-reason-pt
      8. Extension.value[x]
      Definição

      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      CurtoValue of extension
      Controlo1..1
      TipoCodeableConcept
      [x] NotaVerEscolha de tipos de dadospara mais informações sobre como utilizar [x]
      É modificadorfalse
      Resumofalse
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      10. Extension.value[x].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
      12. Extension.value[x].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 Extension.value[x].extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
      • value @ url
      • 14. Extension.value[x].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.

        Controlo0..*
        TipoCoding
        É modificadorfalse
        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()))
        16. Extension.value[x].coding.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
        18. Extension.value[x].coding.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 Extension.value[x].coding.extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
        • value @ url
        • 20. Extension.value[x].coding.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.

          Controlo0..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 do padrãohttp://example.org/SONHO
          Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          22. Extension.value[x].coding.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()))
          24. Extension.value[x].coding.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
          Controlo0..1
          Tipocode
          É modificadorfalse
          Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
          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()))
          26. Extension.value[x].coding.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()))
          28. Extension.value[x].coding.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()))
          30. Extension.value[x].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.

          Controlo0..1
          Tipostring
          É modificadorfalse
          Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
          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()))