RNDS\Endereço - FHIR v4.0.1

RNDS (Guia de Implementação)
0.1.0 - ci-build

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

Data Type Profile: Endereço

Defining URL:

http://www.saude.gov.br/fhir/r4/StructureDefinition/BREndereco-1.0

Version:

0.1.0

Name:

BREndereco

Title:

Endereço

Status:

Active as of 2020-03-11T04:06:40.3767721+00:00

Definition:

Padronização de endereços no Brasil.

Publisher:

Rede Nacional de Dados em Saúde

Source Resource:

XML / JSON / Turtle

The official URL for this profile is:

http://www.saude.gov.br/fhir/r4/StructureDefinition/BREndereco-1.0

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

This structure is derived from Address

Summary

Mandatory: 6 elements
Must-Support: 13 elements
Prohibited: 3 elements

Slices

This structure defines the following Slices:

The element Address.line is sliced based on the value of value:line

This structure is derived from Address

Name	Flags	Card.	Type	Description & Constraints
Address	S	0..*	Address	Dados de Endereçamento
use	S	0..1	code	Uso do Endereço
type	S	0..1	code	Tipo de Endereço
text		0..0
Slices for line	S	3..*	string	Endereço Slice: Unordered, Open by value:line
line:streetType	S	0..1	string	Tipo de Logradouro Binding: Tipo de Logradouro (required): Tipo de Logradouro
line:street	S	1..1	string	Logradouro
line:number	S	1..1	string	Número
line:complement	S	0..1	string	Complemento
line:neighborhood	S	1..1	string	Bairro
city		1..1	string	Município Binding: Município (required): Município
district		0..0
state	S	1..1	string	UF Binding: Unidade Federativa (required): Unidade Federativa
postalCode	S	1..1	string	CEP
country		0..0
period	S	0..1	Period	Período do Endereço
start	S	0..1	dateTime	Data de Inicio do Endereço
end	S	0..1	dateTime	Data de Término do Endereço
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Address	S	0..*	Address	Dados de Endereçamento
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!SΣ	0..1	code	Uso do Endereço Binding: AddressUse (required): The use of an address. Example General: home
type	SΣ	0..1	code	Tipo de Endereço Binding: AddressType (required): The type of an address (physical / postal). Example General: both
Slices for line	SΣ	3..*	string	Endereço Slice: Unordered, Open by value:line This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
line:streetType	SΣ	0..1	string	Tipo de Logradouro Binding: Tipo de Logradouro (required): Tipo de Logradouro This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
line:street	SΣ	1..1	string	Logradouro This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
line:number	SΣ	1..1	string	Número This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
line:complement	SΣ	0..1	string	Complemento This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
line:neighborhood	SΣ	1..1	string	Bairro This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	1..1	string	Município Binding: Município (required): Município Example General: Erewhon
state	SΣ	1..1	string	UF Binding: Unidade Federativa (required): Unidade Federativa
postalCode	SΣ	1..1	string	CEP Example General: 9132
period	SΣ	0..1	Period	Período do Endereço Example General: {"start":"2010-03-23","end":"2010-07-01"}
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	SΣI	0..1	dateTime	Data de Inicio do Endereço
end	SΣI	0..1	dateTime	Data de Término do Endereço
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Address		0..*	Address	Dados de Endereçamento
use	?!Σ	0..1	code	Uso do Endereço Binding: AddressUse (required): The use of an address.
type	Σ	0..1	code	Tipo de Endereço Binding: AddressType (required): The type of an address (physical / postal).
Slices for line	Σ	3..*	string	Endereço Slice: Unordered, Open by value:line This repeating element order: The order in which lines should appear in an address label
line:streetType	Σ	0..1	string	Tipo de Logradouro Binding: Tipo de Logradouro (required): Tipo de Logradouro This repeating element order: The order in which lines should appear in an address label
line:street	Σ	1..1	string	Logradouro This repeating element order: The order in which lines should appear in an address label
line:number	Σ	1..1	string	Número This repeating element order: The order in which lines should appear in an address label
line:complement	Σ	0..1	string	Complemento This repeating element order: The order in which lines should appear in an address label
line:neighborhood	Σ	1..1	string	Bairro This repeating element order: The order in which lines should appear in an address label
state	Σ	1..1	string	UF Binding: Unidade Federativa (required): Unidade Federativa
postalCode	Σ	1..1	string	CEP
period	Σ	0..1	Period	Período do Endereço
start	ΣI	0..1	dateTime	Data de Inicio do Endereço
end	ΣI	0..1	dateTime	Data de Término do Endereço
Documentation for this format

This structure is derived from Address

Summary

Mandatory: 6 elements
Must-Support: 13 elements
Prohibited: 3 elements

Slices

This structure defines the following Slices:

The element Address.line is sliced based on the value of value:line

Differential View

This structure is derived from Address

Name	Flags	Card.	Type	Description & Constraints
Address	S	0..*	Address	Dados de Endereçamento
use	S	0..1	code	Uso do Endereço
type	S	0..1	code	Tipo de Endereço
text		0..0
Slices for line	S	3..*	string	Endereço Slice: Unordered, Open by value:line
line:streetType	S	0..1	string	Tipo de Logradouro Binding: Tipo de Logradouro (required): Tipo de Logradouro
line:street	S	1..1	string	Logradouro
line:number	S	1..1	string	Número
line:complement	S	0..1	string	Complemento
line:neighborhood	S	1..1	string	Bairro
city		1..1	string	Município Binding: Município (required): Município
district		0..0
state	S	1..1	string	UF Binding: Unidade Federativa (required): Unidade Federativa
postalCode	S	1..1	string	CEP
country		0..0
period	S	0..1	Period	Período do Endereço
start	S	0..1	dateTime	Data de Inicio do Endereço
end	S	0..1	dateTime	Data de Término do Endereço
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Address	S	0..*	Address	Dados de Endereçamento
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!SΣ	0..1	code	Uso do Endereço Binding: AddressUse (required): The use of an address. Example General: home
type	SΣ	0..1	code	Tipo de Endereço Binding: AddressType (required): The type of an address (physical / postal). Example General: both
Slices for line	SΣ	3..*	string	Endereço Slice: Unordered, Open by value:line This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
line:streetType	SΣ	0..1	string	Tipo de Logradouro Binding: Tipo de Logradouro (required): Tipo de Logradouro This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
line:street	SΣ	1..1	string	Logradouro This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
line:number	SΣ	1..1	string	Número This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
line:complement	SΣ	0..1	string	Complemento This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
line:neighborhood	SΣ	1..1	string	Bairro This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	1..1	string	Município Binding: Município (required): Município Example General: Erewhon
state	SΣ	1..1	string	UF Binding: Unidade Federativa (required): Unidade Federativa
postalCode	SΣ	1..1	string	CEP Example General: 9132
period	SΣ	0..1	Period	Período do Endereço Example General: {"start":"2010-03-23","end":"2010-07-01"}
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	SΣI	0..1	dateTime	Data de Inicio do Endereço
end	SΣI	0..1	dateTime	Data de Término do Endereço
Documentation for this format

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path	Conformance	ValueSet
Address.use	required	AddressUse
Address.type	required	AddressType
Address.line:streetType	required	BRTipoLogradouro
Address.city	required	BRMunicipio
Address.state	required	BRUnidadeFederativa

Constraints

Id	Path	Details	Requirements
ele-1	Address	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Address.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Address.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.line	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.line:streetType	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.line:street	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.line:number	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.line:complement	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.line:neighborhood	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.city	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.state	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.postalCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.period.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Address.period.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Address.period.start	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Address.period.end	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

IG © 2021+ Rede Nacional de Dados em Saúde. Package rnds#0.1.0 based on FHIR 4.0.1. Generated 2021-11-16
Links: Table of Contents | QA Report