Guia de Implementação do AnHealth
0.2.0 - CI Build

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

Data Type Profile: Address

Official URL: https://ancode.app/fhir/StructureDefinition/Address Version: 0.2.0
Draft as of 2021-11-10 Computable Name: Address

Usage:

Formal Views of Profile Content

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

This structure is derived from Address

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... streetType 0..1stringStreet Type
URL: https://ancode.app/fhir/StructureDefinition/StreetType
... streetName 0..1stringStreet Name
URL: https://ancode.app/fhir/StructureDefinition/StreetName
... neighborhood 0..1stringNeighborhood
URL: https://ancode.app/fhir/StructureDefinition/Neighborhood
... addressComplement 0..1stringAddress Complement
URL: https://ancode.app/fhir/StructureDefinition/AddressComplement
... ibgeCode 0..1stringIBGE Code
URL: https://ancode.app/fhir/StructureDefinition/IBGECode
... use 1..1codehome | work | temp | old | billing - purpose of this address
... city 1..1stringName of city, town etc.
... state 1..1stringSub-unit of country (abbreviations ok)
Binding: BrazilianState (required)
... postalCode 1..1stringPostal code for area
... country 1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... period
.... start 0..1dateTimeData de Inicio do Endereço
.... end 0..1dateTimeData de Término do Endereço

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Address.staterequiredBrazilianState
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... streetType 0..1stringStreet Type
URL: https://ancode.app/fhir/StructureDefinition/StreetType
... streetName 0..1stringStreet Name
URL: https://ancode.app/fhir/StructureDefinition/StreetName
... neighborhood 0..1stringNeighborhood
URL: https://ancode.app/fhir/StructureDefinition/Neighborhood
... addressComplement 0..1stringAddress Complement
URL: https://ancode.app/fhir/StructureDefinition/AddressComplement
... ibgeCode 0..1stringIBGE Code
URL: https://ancode.app/fhir/StructureDefinition/IBGECode
... use ?!Σ1..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


Example General: home
... city Σ1..1stringName of city, town etc.
Example General: Erewhon
... state Σ1..1stringSub-unit of country (abbreviations ok)
Binding: BrazilianState (required)
... postalCode Σ1..1stringPostal code for area
Example General: 9132
... country Σ1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Address.userequiredAddressUse
Address.staterequiredBrazilianState

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children unless an empty Parameters resource
: hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1idUnique id for inter-element referencing
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... streetType 0..1stringStreet Type
URL: https://ancode.app/fhir/StructureDefinition/StreetType
... streetNumber 0..1stringStreet Number
URL: https://ancode.app/fhir/StructureDefinition/StreetNumber
... neighborhood 0..1stringNeighborhood
URL: https://ancode.app/fhir/StructureDefinition/Neighborhood
... addressComplement 0..1stringAddress Complement
URL: https://ancode.app/fhir/StructureDefinition/AddressComplement
... ibgeCode 0..1stringIBGE Code
URL: https://ancode.app/fhir/StructureDefinition/IBGECode
... use ?!Σ1..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


Example General: home
... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line Σ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
... city Σ1..1stringName of city, town etc.
Example General: Erewhon
... district Σ0..1stringDistrict name (aka county)
Example General: Madison
... state Σ1..1stringSub-unit of country (abbreviations ok)
Binding: BrazilianState (required)
... postalCode Σ1..1stringPostal code for area
Example General: 9132
... country Σ1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣC0..1dateTimeData de Inicio do Endereço
.... end ΣC0..1dateTimeData de Término do Endereço

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Address.userequiredAddressUse
Address.typerequiredAddressType
Address.staterequiredBrazilianState

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Address

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... streetType 0..1stringStreet Type
URL: https://ancode.app/fhir/StructureDefinition/StreetType
... streetName 0..1stringStreet Name
URL: https://ancode.app/fhir/StructureDefinition/StreetName
... neighborhood 0..1stringNeighborhood
URL: https://ancode.app/fhir/StructureDefinition/Neighborhood
... addressComplement 0..1stringAddress Complement
URL: https://ancode.app/fhir/StructureDefinition/AddressComplement
... ibgeCode 0..1stringIBGE Code
URL: https://ancode.app/fhir/StructureDefinition/IBGECode
... use 1..1codehome | work | temp | old | billing - purpose of this address
... city 1..1stringName of city, town etc.
... state 1..1stringSub-unit of country (abbreviations ok)
Binding: BrazilianState (required)
... postalCode 1..1stringPostal code for area
... country 1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... period
.... start 0..1dateTimeData de Inicio do Endereço
.... end 0..1dateTimeData de Término do Endereço

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Address.staterequiredBrazilianState

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... streetType 0..1stringStreet Type
URL: https://ancode.app/fhir/StructureDefinition/StreetType
... streetName 0..1stringStreet Name
URL: https://ancode.app/fhir/StructureDefinition/StreetName
... neighborhood 0..1stringNeighborhood
URL: https://ancode.app/fhir/StructureDefinition/Neighborhood
... addressComplement 0..1stringAddress Complement
URL: https://ancode.app/fhir/StructureDefinition/AddressComplement
... ibgeCode 0..1stringIBGE Code
URL: https://ancode.app/fhir/StructureDefinition/IBGECode
... use ?!Σ1..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


Example General: home
... city Σ1..1stringName of city, town etc.
Example General: Erewhon
... state Σ1..1stringSub-unit of country (abbreviations ok)
Binding: BrazilianState (required)
... postalCode Σ1..1stringPostal code for area
Example General: 9132
... country Σ1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Address.userequiredAddressUse
Address.staterequiredBrazilianState

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children unless an empty Parameters resource
: hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1idUnique id for inter-element referencing
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... streetType 0..1stringStreet Type
URL: https://ancode.app/fhir/StructureDefinition/StreetType
... streetNumber 0..1stringStreet Number
URL: https://ancode.app/fhir/StructureDefinition/StreetNumber
... neighborhood 0..1stringNeighborhood
URL: https://ancode.app/fhir/StructureDefinition/Neighborhood
... addressComplement 0..1stringAddress Complement
URL: https://ancode.app/fhir/StructureDefinition/AddressComplement
... ibgeCode 0..1stringIBGE Code
URL: https://ancode.app/fhir/StructureDefinition/IBGECode
... use ?!Σ1..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


Example General: home
... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line Σ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
... city Σ1..1stringName of city, town etc.
Example General: Erewhon
... district Σ0..1stringDistrict name (aka county)
Example General: Madison
... state Σ1..1stringSub-unit of country (abbreviations ok)
Binding: BrazilianState (required)
... postalCode Σ1..1stringPostal code for area
Example General: 9132
... country Σ1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣC0..1dateTimeData de Inicio do Endereço
.... end ΣC0..1dateTimeData de Término do Endereço

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Address.userequiredAddressUse
Address.typerequiredAddressType
Address.staterequiredBrazilianState

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron