Guia de Implementação da RNDS
1.0.0 - CI Build 076

Guia de Implementação da RNDS - Local Development build (v1.0.0). See the Directory of published versions

Data Type Profile: BREndereco - Descrição detalhada

Página de status do padrão: Informative Nível de maturidade: 1

Definitions for the BREndereco-1.0 data type profile.

1. Address
Definition

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

Control0..* This element is affected by the following invariants: ele-1
Must Supporttrue
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
2. Address.id
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
3. Address.extension
Definition

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.

Control0..*
TypeExtension
Alternate Namesextensionsuser content
Comments

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.

InvariantsDefined on this element
ele-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())
SlicingThis element introduces a set of slices on Address.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. Address.use
Definition

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.

Control0..1
BindingThe codes SHALL be taken from AddressUse The use of an address
Typecode
Is Modifiertrue
Must Supporttrue
Requirements

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

Comments

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

Example
General:home
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. Address.type
Definition

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.

Control0..1
BindingThe codes SHALL be taken from AddressType The type of an address (physical / postal)
Typecode
Must Supporttrue
Comments

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

Example
General:both
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. Address.text
Definition

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.

Control0..0
Typestring
Requirements

A renderable, unencoded form.

Comments

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.

Example
General:137 Nowhere Street, Erewhon 9132
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. Address.line
Definition

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

Control1..*
Typestring
Must Supporttrue
Example
General:137 Nowhere Street
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Address.line. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ line
8. Address.line:streetType
SliceNamestreetType
Definition

Tipo de logradouro do endereço.

Control0..1
BindingThe codes SHALL be taken from Tipo de Logradouro Tipo de Logradour
Typestring
Must Supporttrue
Example
General:137 Nowhere Street
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. Address.line:street
SliceNamestreet
Definition

Logradouro do endereço (ex.: Visconde do Rio Branco, das Laranjeiras, QRSW 8 Bloco A-1) . Quando não for possível utilizar o elemento streetType, incluir textualmente no início do nome do logradouro o tipo de logradouro abreviado (ex.: R. Visconde do Rio Branco, Av. das Laranjeiras, Quadra QRSW 8 Bloco A-1).

Control1..1
Typestring
Must Supporttrue
Example
General:137 Nowhere Street
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
10. Address.line:number
SliceNamenumber
Definition

Número do endereço.

Control1..1
Typestring
Must Supporttrue
Example
General:137 Nowhere Street
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. Address.line:complement
SliceNamecomplement
Definition

Complemento do endereço, como o nome do edifício, bloco, número do apartamento, número da sala etc.

Control0..1
Typestring
Must Supporttrue
Example
General:137 Nowhere Street
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. Address.line:neighborhood
SliceNameneighborhood
Definition

Bairro do endereço.

Control1..1
Typestring
Must Supporttrue
Example
General:137 Nowhere Street
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. Address.city
Definition

Município do endereço.

Control1..1
BindingThe codes SHALL be taken from Município Municípi
Typestring
Alternate NamesMunicpality
Example
General:Erewhon
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. Address.district
Definition

The name of the administrative area (county).

Control0..0
Typestring
Alternate NamesCounty
Comments

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.

Example
General:Madison
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. Address.state
Definition

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

Control1..1
BindingThe codes SHALL be taken from Unidade Federativa Unidade Federativ
Typestring
Must Supporttrue
Alternate NamesProvinceTerritory
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. Address.postalCode
Definition

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

Control1..1
Typestring
Must Supporttrue
Alternate NamesZip
Example
General:9132
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. Address.country
Definition

Country - a nation as commonly understood or generally accepted.

Control0..0
Typestring
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. Address.period
Definition

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

Control0..1
TypePeriod
Must Supporttrue
Requirements

Allows addresses to be placed in historical context.

Example
General:<valuePeriod xmlns="http://hl7.org/fhir">
  <start value="2010-03-23"/>
  <end value="2010-07-01"/>
</valuePeriod>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. Address.period.id
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
20. Address.period.extension
Definition

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.

Control0..*
TypeExtension
Alternate Namesextensionsuser content
Comments

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.

InvariantsDefined on this element
ele-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())
SlicingThis element introduces a set of slices on Address.period.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
21. Address.period.start
Definition

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

Control0..1 This element is affected by the following invariants: per-1
TypedateTime
Must Supporttrue
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. Address.period.end
Definition

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

Control0..1 This element is affected by the following invariants: per-1
TypedateTime
Must Supporttrue
Comments

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.

Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))