REDS GO
1.0.0 - draft Brazil flag

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

Data Type Profile: BREndereco - Detailed Descriptions

Active as of 2020-03-11

Definitions for the BREndereco-1.0 data type profile.

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

0. Address
Definição

Dados do(s) endereço(s) onde o sujeito do endereço pode ser localizado.


An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.

CurtoDados de EndereçamentoAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
Comentários

Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).


Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).

Controlo0..*
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. Address.use
Definição

home: endereço residencial atual. work: endereço comercial ou de trabalho atual. temp: endereço temporário, como um hotel, a casa de amigos ou familiares, uma instalação/edificação provisória, etc. old: endereço anterior.


The purpose of this address.

CurtoUso do Endereçohome | work | temp | old | billing - purpose of this address
Comentários

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

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

The use of an address.

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

Allows an appropriate address to be chosen from a list of many.

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

physical: um endereço físico de um edificação ou espaço geográfico real, como de uma casa, prédio, loja, galpão, lote, etc. postal: um endereço virtual, como de uma Caixa Postal ou serviço de logística de mercadorias, p.ex.


Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

CurtoTipo de Endereçopostal | physical | both
Comentários

The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).


The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

Controlo0..1
VínculoOs códigos DEVERÃO ser retirados de AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1
(required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

The type of an address (physical / postal).

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

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

CurtoText representation of the address
Comentários

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

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

A renderable, unencoded form.

ExemploGeneral: 137 Nowhere Street, Erewhon 9132
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Address.line
Definição

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

CurtoEndereçoStreet name, number, direction & P.O. Box etc.
Controlo10..*
Tipostring
É modificadorfalse
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Deve apoiartrue
Resumotrue
ExemploGeneral: 137 Nowhere Street
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Address.city
Definição

Município do endereço.


The name of the city, town, suburb, village or other community or delivery center.

CurtoMunicípioName of city, town etc.
Controlo10..1
VínculoOs códigos DEVERÃO ser retirados de Para códigos, ver Município
(required to http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0)

Município

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

The name of the administrative area (county).

CurtoDistrict name (aka county)
Comentários

District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

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

Unidade Federativa (estados ou Distrito Federal) do endereço.


Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

CurtoUFSub-unit of country (abbreviations ok)
Controlo10..1
VínculoOs códigos DEVERÃO ser retirados de Para códigos, ver Unidade Federativa
(required to http://www.saude.gov.br/fhir/r4/ValueSet/BRUnidadeFederativa-1.0)

Unidade Federativa

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

Código de Endereçamento Postal. Utilizar a máscara XXXXX-XXXX.


A postal code designating a region defined by the postal service.

CurtoCEPPostal code for area
Controlo10..1
Tipostring
É modificadorfalse
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Deve apoiartrue
Resumotrue
Nomes alternativosZip
ExemploGeneral: 9132
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Address.country
Definição

Country - a nation as commonly understood or generally accepted.

CurtoCountry (e.g. can be ISO 3166 2 or 3 letter code)
Comentários

ISO 3166 3 letter codes can be used in place of a human readable country name.

Controlo0..01
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()))
20. Address.period
Definição

Período em que o endereço foi utilizado.


Time period when address was/is in use.

CurtoPeríodo do EndereçoTime period when address was/is in use
Controlo0..1
TipoPeriod
É modificadorfalse
Deve apoiartrue
Resumotrue
Requisitos

Allows addresses to be placed in historical context.

ExemploGeneral: { "start" : "2010-03-23", "end" : "2010-07-01" }
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Address.period.start
Definição

Data em que o endereço foi cadastrado ou começou a ser utilizado.


The start of the period. The boundary is inclusive.

CurtoData de Inicio do EndereçoStarting 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()))
24. Address.period.end
Definição

Data em que o endereço foi desativado ou parou de ser utilizado.


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 Término do EndereçoEnd 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()))

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

0. Address
Definição

Dados do(s) endereço(s) onde o sujeito do endereço pode ser localizado.

CurtoDados de Endereçamento
Deve apoiartrue
2. Address.use
Definição

home: endereço residencial atual. work: endereço comercial ou de trabalho atual. temp: endereço temporário, como um hotel, a casa de amigos ou familiares, uma instalação/edificação provisória, etc. old: endereço anterior.

CurtoUso do Endereço
Deve apoiartrue
4. Address.type
Definição

physical: um endereço físico de um edificação ou espaço geográfico real, como de uma casa, prédio, loja, galpão, lote, etc. postal: um endereço virtual, como de uma Caixa Postal ou serviço de logística de mercadorias, p.ex.

CurtoTipo de Endereço
Deve apoiartrue
6. Address.text
Controlo0..0
8. Address.line
CurtoEndereço
Controlo1..?
Deve apoiartrue
10. Address.city
Definição

Município do endereço.

CurtoMunicípio
Controlo1..?
VínculoOs códigos DEVERÃO ser retirados de Município
(required to http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0)

Município

12. Address.district
Controlo0..0
14. Address.state
Definição

Unidade Federativa (estados ou Distrito Federal) do endereço.

CurtoUF
Controlo1..?
VínculoOs códigos DEVERÃO ser retirados de Unidade Federativa
(required to http://www.saude.gov.br/fhir/r4/ValueSet/BRUnidadeFederativa-1.0)

Unidade Federativa

Deve apoiartrue
16. Address.postalCode
Definição

Código de Endereçamento Postal. Utilizar a máscara XXXXX-XXXX.

CurtoCEP
Controlo1..?
Deve apoiartrue
18. Address.country
Controlo0..0
20. Address.period
Definição

Período em que o endereço foi utilizado.

CurtoPeríodo do Endereço
Deve apoiartrue
22. Address.period.start
Definição

Data em que o endereço foi cadastrado ou começou a ser utilizado.

CurtoData de Inicio do Endereço
Deve apoiartrue
24. Address.period.end
Definição

Data em que o endereço foi desativado ou parou de ser utilizado.

CurtoData de Término do Endereço
Deve apoiartrue

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

0. Address
Definição

Dados do(s) endereço(s) onde o sujeito do endereço pode ser localizado.

CurtoDados de Endereçamento
Comentários

Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).

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

    home: endereço residencial atual. work: endereço comercial ou de trabalho atual. temp: endereço temporário, como um hotel, a casa de amigos ou familiares, uma instalação/edificação provisória, etc. old: endereço anterior.

    CurtoUso do Endereço
    Comentários

    Applications can assume that an address is current unless it explicitly says that it is temporary or old.

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

    The use of an address.

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

    Allows an appropriate address to be chosen from a list of many.

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

    physical: um endereço físico de um edificação ou espaço geográfico real, como de uma casa, prédio, loja, galpão, lote, etc. postal: um endereço virtual, como de uma Caixa Postal ou serviço de logística de mercadorias, p.ex.

    CurtoTipo de Endereço
    Comentários

    The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

    Controlo0..1
    VínculoOs códigos DEVERÃO ser retirados de AddressType
    (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

    The type of an address (physical / postal).

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

    Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

    CurtoText representation of the address
    Comentários

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

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

    A renderable, unencoded form.

    ExemploGeneral: 137 Nowhere Street, Erewhon 9132
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. Address.line
    Definição

    This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

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

    Município do endereço.

    CurtoMunicípio
    Controlo1..1
    VínculoOs códigos DEVERÃO ser retirados de Município
    (required to http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0)

    Município

    Tipostring
    É modificadorfalse
    Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
    Resumotrue
    Nomes alternativosMunicpality
    ExemploGeneral: Erewhon
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. Address.district
    Definição

    The name of the administrative area (county).

    CurtoDistrict name (aka county)
    Comentários

    District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

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

    Unidade Federativa (estados ou Distrito Federal) do endereço.

    CurtoUF
    Controlo1..1
    VínculoOs códigos DEVERÃO ser retirados de Unidade Federativa
    (required to http://www.saude.gov.br/fhir/r4/ValueSet/BRUnidadeFederativa-1.0)

    Unidade Federativa

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

    Código de Endereçamento Postal. Utilizar a máscara XXXXX-XXXX.

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

    Country - a nation as commonly understood or generally accepted.

    CurtoCountry (e.g. can be ISO 3166 2 or 3 letter code)
    Comentários

    ISO 3166 3 letter codes can be used in place of a human readable country 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()))
    24. Address.period
    Definição

    Período em que o endereço foi utilizado.

    CurtoPeríodo do Endereço
    Controlo0..1
    TipoPeriod
    É modificadorfalse
    Deve apoiartrue
    Resumotrue
    Requisitos

    Allows addresses to be placed in historical context.

    ExemploGeneral: { "start" : "2010-03-23", "end" : "2010-07-01" }
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    26. Address.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
    28. Address.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 Address.period.extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
    • value @ url
    • 30. Address.period.start
      Definição

      Data em que o endereço foi cadastrado ou começou a ser utilizado.

      CurtoData de Inicio do Endereço
      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()))
      32. Address.period.end
      Definição

      Data em que o endereço foi desativado ou parou de ser utilizado.

      CurtoData de Término do Endereço
      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()))