Guia de Implementação da OMNISAUDE - CORE
0.0.1 - draft Brazil flag

Guia de Implementação da OMNISAUDE - CORE - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Location (OMNI)

Official URL: https://fhir.omnisaude.co/r4/core/StructureDefinition/location Version: 0.0.1
Draft as of 2025-04-10 Computable Name: Local

Location Profile da Omnisaude baseado no IPS.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* Location Details and position information for a physical place
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... status ?!Σ 0..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.


ele-1: All FHIR elements must have a @value or children
... managingOrganization Σ 0..1 Reference(Organization (OMNI)) Organization responsible for provisioning and upkeep
ele-1: All FHIR elements must have a @value or children
... partOf 0..1 Reference(Location (OMNI)) Another Location this one is physically a part of
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLocationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorLocationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLocationA resource should have narrative for robust management
: text.`div`.exists()
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()

This structure is derived from Location

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location Location
... name 1..1 string Name of the location as used by humans
... telecom
.... system 1..1 code phone | fax | email | pager | url | sms | other
.... value 1..1 string The actual contact point details
... address
.... Slices for line 0..* string Street name, number, direction & P.O. Box etc.
Slice: Unordered, Open by value:$this.id
..... line:bairro 0..1 string Street name, number, direction & P.O. Box etc.
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: bairro
..... line:logradouro 0..1 string Street name, number, direction & P.O. Box etc.
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: logradouro
..... line:tipoLogradouro 0..1 string Street name, number, direction & P.O. Box etc.
Binding: Tipo de Logradouro (extensible)
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: tipoLogradouro
..... line:numero 0..1 string Street name, number, direction & P.O. Box etc.
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: numero
..... line:complemento 0..1 string Street name, number, direction & P.O. Box etc.
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: complemento
.... city 0..1 string Name of city, town etc.
Binding: Município (extensible)
.... state 0..1 string Sub-unit of country (abbreviations ok)
Binding: Unidade Federativa (extensible)
.... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-3 (required)
... partOf 0..1 Reference(Location (OMNI)) Another Location this one is physically a part of

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Location.address.line:tipoLogradouroextensibleTipoLogradouro (a valid code from Tipo de Logradouro)
https://fhir.omnisaude.co/r4/core/ValueSet/tipo-logradouro
from this IG
Location.address.cityextensibleMunicípio
http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0
Location.address.stateextensibleUnidade Federativa
http://www.saude.gov.br/fhir/r4/ValueSet/BRUnidadeFederativa-1.0
Location.address.countryrequiredIso3166-1-3
http://hl7.org/fhir/ValueSet/iso3166-1-3
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* Location Details and position information for a physical place
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Unique code or number identifying the location to its users
... status ?!Σ 0..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

... operationalStatus Σ 0..1 Coding The operational status of the location (typically only for a bed/room)
Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).

... name Σ 1..1 string Name of the location as used by humans
... alias 0..* string A list of alternate names that the location is known as, or was known as, in the past
... description Σ 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
... mode Σ 0..1 code instance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

... type Σ 0..* CodeableConcept Type of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.


... telecom 0..* ContactPoint Contact details of the location
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ 1..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... address 0..1 Address Physical location
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... Slices for line Σ 0..* string Street name, number, direction & P.O. Box etc.
Slice: Unordered, Open by value:$this.id
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... line:bairro Σ 0..1 string Street 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
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: bairro
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
..... line:logradouro Σ 0..1 string Street 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
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: logradouro
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
..... line:tipoLogradouro Σ 0..1 string Street name, number, direction & P.O. Box etc.
Binding: Tipo de Logradouro (extensible)
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: tipoLogradouro
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
..... line:numero Σ 0..1 string Street 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
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: numero
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
..... line:complemento Σ 0..1 string Street 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
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: complemento
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
.... city Σ 0..1 string Name of city, town etc.
Binding: Município (extensible)
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
Binding: Unidade Federativa (extensible)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-3 (required)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... physicalType Σ 0..1 CodeableConcept Physical form of the location
Binding: LocationType (example): Physical form of the location.

... position 0..1 BackboneElement The absolute geographic location
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... longitude 1..1 decimal Longitude with WGS84 datum
.... latitude 1..1 decimal Latitude with WGS84 datum
.... altitude 0..1 decimal Altitude with WGS84 datum
... managingOrganization Σ 0..1 Reference(Organization (OMNI)) Organization responsible for provisioning and upkeep
... partOf 0..1 Reference(Location (OMNI)) Another Location this one is physically a part of
... hoursOfOperation 0..* BackboneElement What days/times during a week is this location usually open
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1 boolean The Location is open all day
.... openingTime 0..1 time Time that the Location opens
.... closingTime 0..1 time Time that the Location closes
... availabilityExceptions 0..1 string Description of availability exceptions
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.operationalStatuspreferredHl7VSBedStatus
http://terminology.hl7.org/ValueSet/v2-0116
Location.moderequiredLocationMode
http://hl7.org/fhir/ValueSet/location-mode|4.0.1
from the FHIR Standard
Location.typeextensibleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Location.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Location.address.line:tipoLogradouroextensibleTipoLogradouro (a valid code from Tipo de Logradouro)
https://fhir.omnisaude.co/r4/core/ValueSet/tipo-logradouro
from this IG
Location.address.cityextensibleMunicípio
http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0
Location.address.stateextensibleUnidade Federativa
http://www.saude.gov.br/fhir/r4/ValueSet/BRUnidadeFederativa-1.0
Location.address.countryrequiredIso3166-1-3
http://hl7.org/fhir/ValueSet/iso3166-1-3
from the FHIR Standard
Location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLocationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorLocationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLocationA resource should have narrative for robust management
: text.`div`.exists()
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()

This structure is derived from Location

Summary

Mandatory: 1 element(2 nested mandatory elements)

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Location.address.line

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* Location Details and position information for a physical place
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... status ?!Σ 0..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.


ele-1: All FHIR elements must have a @value or children
... managingOrganization Σ 0..1 Reference(Organization (OMNI)) Organization responsible for provisioning and upkeep
ele-1: All FHIR elements must have a @value or children
... partOf 0..1 Reference(Location (OMNI)) Another Location this one is physically a part of
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLocationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorLocationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLocationA resource should have narrative for robust management
: text.`div`.exists()
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 Location

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location Location
... name 1..1 string Name of the location as used by humans
... telecom
.... system 1..1 code phone | fax | email | pager | url | sms | other
.... value 1..1 string The actual contact point details
... address
.... Slices for line 0..* string Street name, number, direction & P.O. Box etc.
Slice: Unordered, Open by value:$this.id
..... line:bairro 0..1 string Street name, number, direction & P.O. Box etc.
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: bairro
..... line:logradouro 0..1 string Street name, number, direction & P.O. Box etc.
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: logradouro
..... line:tipoLogradouro 0..1 string Street name, number, direction & P.O. Box etc.
Binding: Tipo de Logradouro (extensible)
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: tipoLogradouro
..... line:numero 0..1 string Street name, number, direction & P.O. Box etc.
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: numero
..... line:complemento 0..1 string Street name, number, direction & P.O. Box etc.
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: complemento
.... city 0..1 string Name of city, town etc.
Binding: Município (extensible)
.... state 0..1 string Sub-unit of country (abbreviations ok)
Binding: Unidade Federativa (extensible)
.... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-3 (required)
... partOf 0..1 Reference(Location (OMNI)) Another Location this one is physically a part of

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Location.address.line:tipoLogradouroextensibleTipoLogradouro (a valid code from Tipo de Logradouro)
https://fhir.omnisaude.co/r4/core/ValueSet/tipo-logradouro
from this IG
Location.address.cityextensibleMunicípio
http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0
Location.address.stateextensibleUnidade Federativa
http://www.saude.gov.br/fhir/r4/ValueSet/BRUnidadeFederativa-1.0
Location.address.countryrequiredIso3166-1-3
http://hl7.org/fhir/ValueSet/iso3166-1-3
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* Location Details and position information for a physical place
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Unique code or number identifying the location to its users
... status ?!Σ 0..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

... operationalStatus Σ 0..1 Coding The operational status of the location (typically only for a bed/room)
Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).

... name Σ 1..1 string Name of the location as used by humans
... alias 0..* string A list of alternate names that the location is known as, or was known as, in the past
... description Σ 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
... mode Σ 0..1 code instance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

... type Σ 0..* CodeableConcept Type of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.


... telecom 0..* ContactPoint Contact details of the location
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ 1..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... address 0..1 Address Physical location
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... Slices for line Σ 0..* string Street name, number, direction & P.O. Box etc.
Slice: Unordered, Open by value:$this.id
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... line:bairro Σ 0..1 string Street 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
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: bairro
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
..... line:logradouro Σ 0..1 string Street 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
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: logradouro
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
..... line:tipoLogradouro Σ 0..1 string Street name, number, direction & P.O. Box etc.
Binding: Tipo de Logradouro (extensible)
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: tipoLogradouro
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
..... line:numero Σ 0..1 string Street 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
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: numero
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
..... line:complemento Σ 0..1 string Street 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
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: complemento
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
.... city Σ 0..1 string Name of city, town etc.
Binding: Município (extensible)
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
Binding: Unidade Federativa (extensible)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-3 (required)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... physicalType Σ 0..1 CodeableConcept Physical form of the location
Binding: LocationType (example): Physical form of the location.

... position 0..1 BackboneElement The absolute geographic location
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... longitude 1..1 decimal Longitude with WGS84 datum
.... latitude 1..1 decimal Latitude with WGS84 datum
.... altitude 0..1 decimal Altitude with WGS84 datum
... managingOrganization Σ 0..1 Reference(Organization (OMNI)) Organization responsible for provisioning and upkeep
... partOf 0..1 Reference(Location (OMNI)) Another Location this one is physically a part of
... hoursOfOperation 0..* BackboneElement What days/times during a week is this location usually open
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1 boolean The Location is open all day
.... openingTime 0..1 time Time that the Location opens
.... closingTime 0..1 time Time that the Location closes
... availabilityExceptions 0..1 string Description of availability exceptions
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.operationalStatuspreferredHl7VSBedStatus
http://terminology.hl7.org/ValueSet/v2-0116
Location.moderequiredLocationMode
http://hl7.org/fhir/ValueSet/location-mode|4.0.1
from the FHIR Standard
Location.typeextensibleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Location.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Location.address.line:tipoLogradouroextensibleTipoLogradouro (a valid code from Tipo de Logradouro)
https://fhir.omnisaude.co/r4/core/ValueSet/tipo-logradouro
from this IG
Location.address.cityextensibleMunicípio
http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0
Location.address.stateextensibleUnidade Federativa
http://www.saude.gov.br/fhir/r4/ValueSet/BRUnidadeFederativa-1.0
Location.address.countryrequiredIso3166-1-3
http://hl7.org/fhir/ValueSet/iso3166-1-3
from the FHIR Standard
Location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLocationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorLocationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLocationA resource should have narrative for robust management
: text.`div`.exists()
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()

This structure is derived from Location

Summary

Mandatory: 1 element(2 nested mandatory elements)

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Location.address.line

 

Other representations of profile: CSV, Excel, Schematron