Guia de Implementação da SES GO - CORE
1.1.0 - draft Brazil flag

Guia de Implementação da SES GO - CORE - Downloaded Version 1.1.0 See the Directory of published versions

Data Type Profile: NomeCidadao - Detailed Descriptions

Active as of 2025-11-26

Definitions for the nome-cidadao data type profile.

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

0. HumanName
Definição

A human's name with the ability to identify parts and usage.

CurtoName of a human - parts and usage
Comentários

Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.

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()))
RN04: O text deve possuir pelo menos dois nomes separados por espaço. (text.split(' ').count() > 1)
2. HumanName.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 HumanName.extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
  • value @ url
  • 4. HumanName.use
    Definição

    Identifies the purpose for this name.

    Curtousual | officialusual | official | temp | nickname | anonymous | old | maiden
    Comentários

    Applications can assume that a name is current unless it explicitly says that it is temporary or old.

    Controlo10..1
    VínculoOs códigos DEVERÃO ser retirados de Tipo de uso do nome do cidadãohttp://hl7.org/fhir/ValueSet/name-use|4.0.1
    (required to https://fhir.saude.go.gov.br/r4/core/ValueSet/uso-nome-cidadao)
    Tipocode
    É modificadortrue porque This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
    Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
    Resumotrue
    Requisitos

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

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

    Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

    CurtoText representation of the full name
    Comentários

    Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

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

    A renderable, unencoded form.

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

    The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

    CurtoFamily name (often called 'Surname')
    Comentários

    Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

    Controlo0..01
    Tipostring
    É modificadorfalse
    Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
    Resumotrue
    Nomes alternativossurname
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. HumanName.given
    Definição

    Given name.

    CurtoGiven names (not always 'first'). Includes middle names
    Comentários

    If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

    Controlo0..0*
    Tipostring
    É modificadorfalse
    Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
    Resumotrue
    Nomes alternativosfirst name, middle name
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. HumanName.prefix
    Definição

    Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

    CurtoParts that come before the name
    Controlo0..0*
    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()))
    14. HumanName.suffix
    Definição

    Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

    CurtoParts that come after the name
    Controlo0..0*
    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()))
    16. HumanName.period
    Definição

    Indicates the period of time when this name was valid for the named person.

    CurtoTime period when name was/is in use
    Controlo0..01
    TipoPeriod
    É modificadorfalse
    Resumotrue
    Requisitos

    Allows names to be placed in historical context.

    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. HumanName
    InvariantesRN04: O text deve possuir pelo menos dois nomes separados por espaço. (text.split(' ').count() > 1)
    2. HumanName.extension
    Controlo0..0
    4. HumanName.use
    Curtousual | official
    Controlo1..?
    VínculoOs códigos DEVERÃO ser retirados de Tipo de uso do nome do cidadão
    (required to https://fhir.saude.go.gov.br/r4/core/ValueSet/uso-nome-cidadao)
    6. HumanName.text
    Controlo1..?
    8. HumanName.family
    Controlo0..0
    10. HumanName.given
    Controlo0..0
    12. HumanName.prefix
    Controlo0..0
    14. HumanName.suffix
    Controlo0..0
    16. HumanName.period
    Controlo0..0

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

    0. HumanName
    Definição

    A human's name with the ability to identify parts and usage.

    CurtoName of a human - parts and usage
    Comentários

    Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.

    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()))
    RN04: O text deve possuir pelo menos dois nomes separados por espaço. (text.split(' ').count() > 1)
    2. HumanName.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. HumanName.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 HumanName.extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
    • value @ url
    • 6. HumanName.use
      Definição

      Identifies the purpose for this name.

      Curtousual | official
      Comentários

      Applications can assume that a name is current unless it explicitly says that it is temporary or old.

      Controlo1..1
      VínculoOs códigos DEVERÃO ser retirados de Tipo de uso do nome do cidadão
      (required to https://fhir.saude.go.gov.br/r4/core/ValueSet/uso-nome-cidadao)
      Tipocode
      É modificadortrue porque This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Resumotrue
      Requisitos

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

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

      Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

      CurtoText representation of the full name
      Comentários

      Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

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

      A renderable, unencoded form.

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

      The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

      CurtoFamily name (often called 'Surname')
      Comentários

      Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

      Controlo0..0
      Tipostring
      É modificadorfalse
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Resumotrue
      Nomes alternativossurname
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      12. HumanName.given
      Definição

      Given name.

      CurtoGiven names (not always 'first'). Includes middle names
      Comentários

      If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

      Controlo0..0
      Tipostring
      É modificadorfalse
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Resumotrue
      Nomes alternativosfirst name, middle name
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      14. HumanName.prefix
      Definição

      Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

      CurtoParts that come before the name
      Controlo0..0
      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()))
      16. HumanName.suffix
      Definição

      Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

      CurtoParts that come after the name
      Controlo0..0
      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()))
      18. HumanName.period
      Definição

      Indicates the period of time when this name was valid for the named person.

      CurtoTime period when name was/is in use
      Controlo0..0
      TipoPeriod
      É modificadorfalse
      Resumotrue
      Requisitos

      Allows names to be placed in historical context.

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