HL7 PT FHIR Implementation Guide: Visita do Utente
1.0.0 - STU1 Portugal flag

HL7 PT FHIR Implementation Guide: Visita do Utente, published by HL7 Portugal. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-pt/workflow-ep-ig/tree/master and changes regularly. See the Directory of published versions

Resource Profile: PT_Location

Official URL: https://hl7.pt/fhir/patient-visit/StructureDefinition/PTLocation Version: 1.0.0
Active as of 2021-12-20 Computable Name: PT_Location

Define uma localização genérica para a organização em causa. Representa qualquer local relevante no contexto de saúde, que pode ir desde a cama do utente até ao edifício onde o mesmo se encontra. O objetivo deste recurso é identificar e descrever locais de forma única e interoperável, garantindo que todas as referências a localizações dentro do sistema sejam consistentes e fáceis de rastrear.

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
... meta Σ 0..1 Meta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
.... lastUpdated Σ 0..1 instant When the resource version last changed
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
... description Σ 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
ele-1: All FHIR elements must have a @value or children
... type Σ 0..* CodeableConcept Type of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.


ele-1: All FHIR elements must have a @value or children
... partOf 0..1 Reference(PT_Location) Another Location this one is physically a part of
ele-1: All FHIR elements must have a @value or children
.... display Σ 0..1 string Text alternative for the resource
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
Location.typeextensibleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType

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
... meta 0..1 Meta Metadata about the resource
.... id 0..0
.... versionId 0..0
.... lastUpdated 0..1 instant When the resource version last changed
.... source 0..0
.... profile 0..0
.... security 0..0
.... tag 0..0
... implicitRules 0..0
... language 0..0
... contained 0..0
... identifier
.... id 0..0
.... use 0..1 code usual | official | temp | secondary | old (If known)
.... type
..... id 0..0
..... coding
...... id 0..0
...... system 0..1 uri Identity of the terminology system
...... version 0..0
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
...... userSelected 0..0
..... text 0..0
.... system 0..0
.... value 0..1 string The value that is unique
.... period
..... id 0..0
..... start 0..1 dateTime Starting time with inclusive boundary
..... end 0..1 dateTime End time with inclusive boundary, if not ongoing
.... assigner
..... id 0..0
..... reference 0..0
..... type 0..0
..... identifier 0..0
..... display 0..1 string Text alternative for the resource
... status 0..1 code active | suspended | inactive
... operationalStatus 0..0
... name 0..1 string Name of the location as used by humans
... alias 0..0
... 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..0
... type 0..* CodeableConcept Type of function performed
.... id 0..0
... telecom
.... id 0..0
.... system 0..1 code phone | fax | email | pager | url | sms | other
.... value 0..1 string The actual contact point details
.... use 0..1 code home | work | temp | old | mobile - purpose of this contact point
.... period 0..0
... address
.... id 0..0
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... Parish 0..1 CodeableConcept Extension
URL: https://hl7.pt/fhir/patient-visit/StructureDefinition/Address
.... type 0..0
.... text 0..0
.... line 0..* string Street name, number, direction & P.O. Box etc.
.... city 0..1 string Name of city, town etc.
.... district 0..1 string District name (aka county)
.... state 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode 0..1 string Postal code for area
.... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period
..... id 0..0
..... start 0..1 dateTime Starting time with inclusive boundary
..... end 0..1 dateTime End time with inclusive boundary, if not ongoing
... physicalType
.... id 0..0
.... coding
..... id 0..0
..... version 0..0
..... code 0..1 code Symbol in syntax defined by the system
..... userSelected 0..0
.... text 0..0
... position
.... id 0..0
.... altitude 0..0
... managingOrganization
.... id 0..0
.... reference 0..0
.... type 0..0
.... identifier 0..0
.... display 0..1 string Text alternative for the resource
... partOf 0..1 Reference(PT_Location) Another Location this one is physically a part of
.... id 0..0
.... reference 0..0
.... type 0..0
.... identifier 0..0
.... display 0..1 string Text alternative for the resource
... hoursOfOperation
.... id 0..0
.... daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
.... openingTime 0..1 time Time that the Location opens
.... closingTime 0..1 time Time that the Location closes
... availabilityExceptions 0..0
... endpoint 0..0

doco Documentation for this format
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
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... lastUpdated Σ 0..1 instant When the resource version last changed
... extension 0..* Extension Additional content defined by implementations
... identifier Σ 0..* Identifier Unique code or number identifying the location to its users
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... display Σ 0..1 string Text alternative for the resource
... status ?!Σ 0..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

... name Σ 0..1 string Name of the location as used by humans
... description Σ 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
... type Σ 0..* CodeableConcept Type of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.


.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... telecom 0..* ContactPoint Contact details of the location
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ 0..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)
... address 0..1 Address Physical location
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... Parish 0..1 CodeableConcept Extension
URL: https://hl7.pt/fhir/patient-visit/StructureDefinition/Address
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line Σ 0..* 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
.... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... 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)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... physicalType Σ 0..1 CodeableConcept Physical form of the location
Binding: LocationType (example): Physical form of the location.

.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
... position 0..1 BackboneElement The absolute geographic location
.... 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
... managingOrganization Σ 0..1 Reference(Organization) Organization responsible for provisioning and upkeep
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... display Σ 0..1 string Text alternative for the resource
... partOf 0..1 Reference(PT_Location) Another Location this one is physically a part of
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... display Σ 0..1 string Text alternative for the resource
... hoursOfOperation 0..* BackboneElement What days/times during a week is this location usually open
.... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|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.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

Prohibited: 50 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

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
... meta Σ 0..1 Meta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
.... lastUpdated Σ 0..1 instant When the resource version last changed
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
... description Σ 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
ele-1: All FHIR elements must have a @value or children
... type Σ 0..* CodeableConcept Type of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.


ele-1: All FHIR elements must have a @value or children
... partOf 0..1 Reference(PT_Location) Another Location this one is physically a part of
ele-1: All FHIR elements must have a @value or children
.... display Σ 0..1 string Text alternative for the resource
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
Location.typeextensibleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType

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
... meta 0..1 Meta Metadata about the resource
.... id 0..0
.... versionId 0..0
.... lastUpdated 0..1 instant When the resource version last changed
.... source 0..0
.... profile 0..0
.... security 0..0
.... tag 0..0
... implicitRules 0..0
... language 0..0
... contained 0..0
... identifier
.... id 0..0
.... use 0..1 code usual | official | temp | secondary | old (If known)
.... type
..... id 0..0
..... coding
...... id 0..0
...... system 0..1 uri Identity of the terminology system
...... version 0..0
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
...... userSelected 0..0
..... text 0..0
.... system 0..0
.... value 0..1 string The value that is unique
.... period
..... id 0..0
..... start 0..1 dateTime Starting time with inclusive boundary
..... end 0..1 dateTime End time with inclusive boundary, if not ongoing
.... assigner
..... id 0..0
..... reference 0..0
..... type 0..0
..... identifier 0..0
..... display 0..1 string Text alternative for the resource
... status 0..1 code active | suspended | inactive
... operationalStatus 0..0
... name 0..1 string Name of the location as used by humans
... alias 0..0
... 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..0
... type 0..* CodeableConcept Type of function performed
.... id 0..0
... telecom
.... id 0..0
.... system 0..1 code phone | fax | email | pager | url | sms | other
.... value 0..1 string The actual contact point details
.... use 0..1 code home | work | temp | old | mobile - purpose of this contact point
.... period 0..0
... address
.... id 0..0
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... Parish 0..1 CodeableConcept Extension
URL: https://hl7.pt/fhir/patient-visit/StructureDefinition/Address
.... type 0..0
.... text 0..0
.... line 0..* string Street name, number, direction & P.O. Box etc.
.... city 0..1 string Name of city, town etc.
.... district 0..1 string District name (aka county)
.... state 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode 0..1 string Postal code for area
.... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period
..... id 0..0
..... start 0..1 dateTime Starting time with inclusive boundary
..... end 0..1 dateTime End time with inclusive boundary, if not ongoing
... physicalType
.... id 0..0
.... coding
..... id 0..0
..... version 0..0
..... code 0..1 code Symbol in syntax defined by the system
..... userSelected 0..0
.... text 0..0
... position
.... id 0..0
.... altitude 0..0
... managingOrganization
.... id 0..0
.... reference 0..0
.... type 0..0
.... identifier 0..0
.... display 0..1 string Text alternative for the resource
... partOf 0..1 Reference(PT_Location) Another Location this one is physically a part of
.... id 0..0
.... reference 0..0
.... type 0..0
.... identifier 0..0
.... display 0..1 string Text alternative for the resource
... hoursOfOperation
.... id 0..0
.... daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
.... openingTime 0..1 time Time that the Location opens
.... closingTime 0..1 time Time that the Location closes
... availabilityExceptions 0..0
... endpoint 0..0

doco Documentation for this format

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
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... lastUpdated Σ 0..1 instant When the resource version last changed
... extension 0..* Extension Additional content defined by implementations
... identifier Σ 0..* Identifier Unique code or number identifying the location to its users
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... display Σ 0..1 string Text alternative for the resource
... status ?!Σ 0..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

... name Σ 0..1 string Name of the location as used by humans
... description Σ 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
... type Σ 0..* CodeableConcept Type of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.


.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... telecom 0..* ContactPoint Contact details of the location
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ 0..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)
... address 0..1 Address Physical location
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... Parish 0..1 CodeableConcept Extension
URL: https://hl7.pt/fhir/patient-visit/StructureDefinition/Address
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line Σ 0..* 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
.... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... 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)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... physicalType Σ 0..1 CodeableConcept Physical form of the location
Binding: LocationType (example): Physical form of the location.

.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
... position 0..1 BackboneElement The absolute geographic location
.... 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
... managingOrganization Σ 0..1 Reference(Organization) Organization responsible for provisioning and upkeep
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... display Σ 0..1 string Text alternative for the resource
... partOf 0..1 Reference(PT_Location) Another Location this one is physically a part of
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... display Σ 0..1 string Text alternative for the resource
... hoursOfOperation 0..* BackboneElement What days/times during a week is this location usually open
.... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|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.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

Prohibited: 50 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron