REDS GO
1.0.0 - draft Brazil flag

REDS GO - Downloaded Version 1.0.0 See the Directory of published versions

Data Type Profile: BRDocumentoIndividuo - Detailed Descriptions

Active as of 2020-03-11

Definitions for the BRDocumentoIndividuo-1.0 data type profile.

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

0. Identifier
Definição

Documento(s) do indivíduo.


An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

CurtoDocumentoAn identifier intended for computation
Controlo10..*
Este elemento é afetado pelas seguintes invariantes: ele-1
É modificadorfalse
Deve apoiartrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Identifier.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..*
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 Identifier.extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
  • value @ url
  • 4. Identifier.extension:assignerJurisdiction
    Nome da fatiaassignerJurisdiction
    Definição

    Unidade Federativa, identificada por Code System (sigla da UF), ou o número da região do Órgão Expedidor de um documento.

    CurtoJurisdição do Órgão Expedidor
    Controlo0..1
    TipoExtension(Jurisdição do Órgão Expedidor) (Tipo de extensão: Escolha de: positiveInt, CodeableConcept)
    É modificadorfalse
    Deve apoiartrue
    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())
    6. Identifier.use
    Definição

    official: Documentos oficiais ou o CNS Definitivo secondary: CNS Provisório


    The purpose of this identifier.

    CurtoUso do Documentousual | official | temp | secondary | old (If known)
    Comentários

    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

    Controlo10..1
    VínculoOs códigos DEVERÃO ser retirados de IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

    Identifies the purpose for this identifier, if known .

    Tipocode
    É modificadortrue porque This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
    Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
    Deve apoiartrue
    Resumotrue
    Requisitos

    Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    8. Identifier.type
    Definição

    Tipo de documento utilizado para identificar o indivíduo.


    A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

    CurtoTipo de DocumentoDescription of identifier
    Comentários

    This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

    Controlo10..1
    VínculoOs códigos DEVERÃO ser retirados de A menos que não sejam adequados, estes códigos DEVERÃO ser retirados de Tipo de Documento do Indivíduohttp://hl7.org/fhir/ValueSet/identifier-type
    (required to http://www.saude.gov.br/fhir/r4/ValueSet/BRTipoDocumentoIndividuo-1.0)

    Tipo do Identificador


    A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

    TipoCodeableConcept
    É modificadorfalse
    Deve apoiartrue
    Resumotrue
    Requisitos

    Allows users to make use of identifiers when the identifier system is not known.

    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. Identifier.type.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..1*
    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()))
    12. Identifier.type.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.

    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.

    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. Identifier.type.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
    Controlo10..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()))
    16. Identifier.type.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..01
    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()))
    18. Identifier.type.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..01
    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()))
    20. Identifier.type.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..01
    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()))
    22. Identifier.system
    Definição

    Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

    CurtoThe namespace for the identifier value
    Comentários

    Identifier.system is always case sensitive.

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

    There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

    ExemploGeneral: http://www.acme.com/identifiers/patient
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    24. Identifier.value
    Definição

    Número do documento, incluindo letras e outros caracteres utilizados.


    The portion of the identifier typically relevant to the user and which is unique within the context of the system.

    CurtoNúmero do DocumentoThe value that is unique
    Comentários

    If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

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

    Datas de emissão e validade do documento.


    Time period during which identifier is/was valid for use.

    CurtoPeríodo do DocumentoTime period when id is/was valid for use
    Controlo0..1
    TipoPeriod
    É modificadorfalse
    Deve apoiartrue
    Resumotrue
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    28. Identifier.period.start
    Definição

    Data em que o documento foi gerado.


    The start of the period. The boundary is inclusive.

    CurtoData de Expedição/Inscrição/CadastroStarting time with inclusive boundary
    Comentários

    If the low element is missing, the meaning is that the low boundary is not known.

    Controlo0..1
    Este elemento é afetado pelas seguintes invariantes: per-1
    TipodateTime
    É 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()))
    30. Identifier.period.end
    Definição

    Até quando (data) o documento é ou foi válido.


    The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

    CurtoData de Suspensão/Cancelamento/ValidadeEnd time with inclusive boundary, if not ongoing
    Comentários

    The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

    Controlo0..1
    Este elemento é afetado pelas seguintes invariantes: per-1
    TipodateTime
    É modificadorfalse
    Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
    Deve apoiartrue
    Resumotrue
    Significado em caso de faltaIf the end of the period is missing, it means that the period is ongoing
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    32. Identifier.assigner
    Definição

    Organization that issued/manages the identifier.

    CurtoÓrgão ExpedidorOrganization that issued id (may be just text)
    Comentários

    The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

    Controlo0..1
    TipoReference(Organization)
    É modificadorfalse
    Deve apoiartrue
    Resumotrue
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    34. Identifier.assigner.reference
    Definição

    A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

    CurtoLiteral reference, Relative, internal or absolute URL
    Comentários

    Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

    Controlo0..01
    Este elemento é afetado pelas seguintes invariantes: ref-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()))
    36. Identifier.assigner.type
    Definição

    The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

    The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

    CurtoType the reference refers to (e.g. "Patient")
    Comentários

    This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

    Controlo0..01
    VínculoA menos que não sejam adequados, estes códigos DEVERÃO ser retirados de ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types
    (extensible to http://hl7.org/fhir/ValueSet/resource-types)

    Aa resource (or, for logical models, the URI of the logical model).

    Tipouri
    É 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()))
    38. Identifier.assigner.identifier
    Definição

    An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

    CurtoLogical reference, when literal reference is not known
    Comentários

    When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

    When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

    Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

    Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

    NotaTrata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
    Controlo0..01
    TipoIdentifier
    É modificadorfalse
    Resumotrue
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. Identifier.assigner.display
    Definição

    Plain text narrative that identifies the resource in addition to the resource reference.

    CurtoÓrgão ExpedidorText alternative for the resource
    Comentários

    This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

    Controlo10..1
    VínculoOs códigos DEVERÃO ser retirados de Para códigos, ver Órgão Expedidor
    (required to http://www.saude.gov.br/fhir/r4/ValueSet/BROrgaoExpedidor-1.0)

    Órgão Expedidor

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

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

    0. Identifier
    Definição

    Documento(s) do indivíduo.

    CurtoDocumento
    Controlo1..?
    Deve apoiartrue
    2. Identifier.extension
    SlicingEste elemento introduz um conjunto de fatias em Identifier.extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
    • value @ url
    • 4. Identifier.extension:assignerJurisdiction
      Nome da fatiaassignerJurisdiction
      Definição

      Unidade Federativa, identificada por Code System (sigla da UF), ou o número da região do Órgão Expedidor de um documento.

      TipoExtension(Jurisdição do Órgão Expedidor) (Tipo de extensão: Escolha de: positiveInt, CodeableConcept)
      Deve apoiartrue
      6. Identifier.use
      Definição

      official: Documentos oficiais ou o CNS Definitivo secondary: CNS Provisório

      CurtoUso do Documento
      Controlo1..?
      Deve apoiartrue
      8. Identifier.type
      Definição

      Tipo de documento utilizado para identificar o indivíduo.

      CurtoTipo de Documento
      Controlo1..?
      VínculoOs códigos DEVERÃO ser retirados de Tipo de Documento do Indivíduo
      (required to http://www.saude.gov.br/fhir/r4/ValueSet/BRTipoDocumentoIndividuo-1.0)

      Tipo do Identificador

      Deve apoiartrue
      10. Identifier.type.coding
      Controlo1..1
      12. Identifier.type.coding.system
      Controlo1..?
      14. Identifier.type.coding.code
      Controlo1..?
      16. Identifier.type.coding.display
      Controlo0..0
      18. Identifier.type.coding.userSelected
      Controlo0..0
      20. Identifier.type.text
      Controlo0..0
      22. Identifier.system
      Controlo0..0
      24. Identifier.value
      Definição

      Número do documento, incluindo letras e outros caracteres utilizados.

      CurtoNúmero do Documento
      Controlo1..?
      Deve apoiartrue
      26. Identifier.period
      Definição

      Datas de emissão e validade do documento.

      CurtoPeríodo do Documento
      Deve apoiartrue
      28. Identifier.period.start
      Definição

      Data em que o documento foi gerado.

      CurtoData de Expedição/Inscrição/Cadastro
      Deve apoiartrue
      30. Identifier.period.end
      Definição

      Até quando (data) o documento é ou foi válido.

      CurtoData de Suspensão/Cancelamento/Validade
      Deve apoiartrue
      32. Identifier.assigner
      CurtoÓrgão Expedidor
      Deve apoiartrue
      34. Identifier.assigner.reference
      Controlo0..0
      36. Identifier.assigner.type
      Controlo0..0
      38. Identifier.assigner.identifier
      NotaTrata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
      Controlo0..0
      40. Identifier.assigner.display
      CurtoÓrgão Expedidor
      Controlo1..?
      VínculoOs códigos DEVERÃO ser retirados de Órgão Expedidor
      (required to http://www.saude.gov.br/fhir/r4/ValueSet/BROrgaoExpedidor-1.0)

      Órgão Expedidor

      Deve apoiartrue

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

      0. Identifier
      Definição

      Documento(s) do indivíduo.

      CurtoDocumento
      Controlo1..*
      Este elemento é afetado pelas seguintes invariantes: ele-1
      É modificadorfalse
      Deve apoiartrue
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      2. Identifier.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. Identifier.extension
      Definição

      An Extension

      CurtoExtension
      Controlo0..*
      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 Identifier.extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
      • value @ url
      • 6. Identifier.extension:assignerJurisdiction
        Nome da fatiaassignerJurisdiction
        Definição

        Unidade Federativa, identificada por Code System (sigla da UF), ou o número da região do Órgão Expedidor de um documento.

        CurtoJurisdição do Órgão Expedidor
        Controlo0..1
        TipoExtension(Jurisdição do Órgão Expedidor) (Tipo de extensão: Escolha de: positiveInt, CodeableConcept)
        É modificadorfalse
        Deve apoiartrue
        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())
        8. Identifier.use
        Definição

        official: Documentos oficiais ou o CNS Definitivo secondary: CNS Provisório

        CurtoUso do Documento
        Comentários

        Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

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

        Identifies the purpose for this identifier, if known .

        Tipocode
        É modificadortrue porque This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
        Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
        Deve apoiartrue
        Resumotrue
        Requisitos

        Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        10. Identifier.type
        Definição

        Tipo de documento utilizado para identificar o indivíduo.

        CurtoTipo de Documento
        Comentários

        This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

        Controlo1..1
        VínculoOs códigos DEVERÃO ser retirados de Tipo de Documento do Indivíduo
        (required to http://www.saude.gov.br/fhir/r4/ValueSet/BRTipoDocumentoIndividuo-1.0)

        Tipo do Identificador

        TipoCodeableConcept
        É modificadorfalse
        Deve apoiartrue
        Resumotrue
        Requisitos

        Allows users to make use of identifiers when the identifier system is not known.

        Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        12. Identifier.type.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
        14. Identifier.type.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 Identifier.type.extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
        • value @ url
        • 16. Identifier.type.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..1
          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()))
          18. Identifier.type.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
          20. Identifier.type.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 Identifier.type.coding.extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
          • value @ url
          • 22. Identifier.type.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.

            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.

            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            24. Identifier.type.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()))
            26. Identifier.type.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
            Controlo1..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()))
            28. Identifier.type.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..0
            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()))
            30. Identifier.type.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..0
            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()))
            32. Identifier.type.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..0
            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()))
            34. Identifier.system
            Definição

            Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

            CurtoThe namespace for the identifier value
            Comentários

            Identifier.system is always case sensitive.

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

            There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

            ExemploGeneral: http://www.acme.com/identifiers/patient
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            36. Identifier.value
            Definição

            Número do documento, incluindo letras e outros caracteres utilizados.

            CurtoNúmero do Documento
            Comentários

            If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

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

            Datas de emissão e validade do documento.

            CurtoPeríodo do Documento
            Controlo0..1
            TipoPeriod
            É modificadorfalse
            Deve apoiartrue
            Resumotrue
            Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            40. Identifier.period.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. Identifier.period.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 Identifier.period.extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
            • value @ url
            • 44. Identifier.period.start
              Definição

              Data em que o documento foi gerado.

              CurtoData de Expedição/Inscrição/Cadastro
              Comentários

              If the low element is missing, the meaning is that the low boundary is not known.

              Controlo0..1
              Este elemento é afetado pelas seguintes invariantes: per-1
              TipodateTime
              É 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()))
              46. Identifier.period.end
              Definição

              Até quando (data) o documento é ou foi válido.

              CurtoData de Suspensão/Cancelamento/Validade
              Comentários

              The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

              Controlo0..1
              Este elemento é afetado pelas seguintes invariantes: per-1
              TipodateTime
              É modificadorfalse
              Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
              Deve apoiartrue
              Resumotrue
              Significado em caso de faltaIf the end of the period is missing, it means that the period is ongoing
              Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              48. Identifier.assigner
              Definição

              Organization that issued/manages the identifier.

              CurtoÓrgão Expedidor
              Comentários

              The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

              Controlo0..1
              TipoReference(Organization)
              É modificadorfalse
              Deve apoiartrue
              Resumotrue
              Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              50. Identifier.assigner.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
              52. Identifier.assigner.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 Identifier.assigner.extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
              • value @ url
              • 54. Identifier.assigner.reference
                Definição

                A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                CurtoLiteral reference, Relative, internal or absolute URL
                Comentários

                Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                Controlo0..0
                Este elemento é afetado pelas seguintes invariantes: ref-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()))
                56. Identifier.assigner.type
                Definição

                The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                CurtoType the reference refers to (e.g. "Patient")
                Comentários

                This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                Controlo0..0
                VínculoA menos que não sejam adequados, estes códigos DEVERÃO ser retirados de ResourceType
                (extensible to http://hl7.org/fhir/ValueSet/resource-types)

                Aa resource (or, for logical models, the URI of the logical model).

                Tipouri
                É 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()))
                58. Identifier.assigner.identifier
                Definição

                An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                CurtoLogical reference, when literal reference is not known
                Comentários

                When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                NotaTrata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
                Controlo0..0
                TipoIdentifier
                É modificadorfalse
                Resumotrue
                Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                60. Identifier.assigner.display
                Definição

                Plain text narrative that identifies the resource in addition to the resource reference.

                CurtoÓrgão Expedidor
                Comentários

                This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                Controlo1..1
                VínculoOs códigos DEVERÃO ser retirados de Órgão Expedidor
                (required to http://www.saude.gov.br/fhir/r4/ValueSet/BROrgaoExpedidor-1.0)

                Órgão Expedidor

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