This page is part of a downloaded copy of this specification. This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR v3.5.0. . For a full list of available versions, see the Directory of published versions

## StructureDefinition: CRD Location - Detailed Descriptions

Definitions for the profile-location-stu3 Profile.

Location
Definition | Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.
Control | 0..*
Invariants | Defined on this element dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty()) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (: contained.where(('#'+id in %resource.descendants().reference).not()).empty()) dom-4: If 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())
Location.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Control | 0..1
Type | id
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Location.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
Control | 0..1
Type | Meta
Location.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Control | 0..1
Type | uri
Is Modifier | true
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
Location.language
Definition | The base language in which the resource is written.
Control | 0..1
Binding | A human language. The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable
Type | code
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Location.text
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Control | 0..1 This element is affected by the following invariants: dom-1
Type | Narrative
Alternate Names | narrative, html, xhtml, display
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
Location.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Control | 0..*
Type | Resource
Alternate Names | inline resources, anonymous resources, contained resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.
Location.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Location.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Control | 0..*
Type | Extension
Is Modifier | true
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Location.identifier
Definition | Unique code or number identifying the location to its users.
Note | This is a business identifer, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Requirements | Organization label locations in registries, need to keep track of those.
Location.status
Definition | The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
Control | 0..1
Binding | Indicates whether the location is still in use. The codes SHALL be taken from LocationStatus
Type | code
Is Modifier | true
Must Support | true
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Location.operationalStatus
Definition | The Operational status covers operation values most relevant to beds (but can also apply to rooms/units/chair/etc such as an isolation unit/dialisys chair). This typically covers concepts such as contamination, housekeeping and other activities like maintenance.
Control | 0..1
Binding | The operational status if the location (where typically a bed/room) The codes SHOULD be taken from v2 Bed Status
Type | Coding
Location.name
Definition | Name of the location as used by humans. Does not need to be unique.
Control | 1..1
Type | string
Must Support | true
Comments | If the name of an location changes, consider putting the old name in the alias column so that it can still be located through searches.
Location.alias
Definition | A list of alternate names that the location is known as, or was known as in the past.
Control | 0..*
Type | string
Requirements | Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the location was known by can be very useful.
Comments | There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the location.
Location.description
Definition | Description of the Location, which helps in finding or referencing the place.
Control | 0..1
Type | string
Requirements | Humans need additional information to verify a correct location has been identified.
Location.mode
Definition | Indicates whether a resource instance represents a specific location or a class of locations.
Control | 0..1
Binding | Indicates whether a resource instance represents a specific location or a class of locations. The codes SHALL be taken from LocationMode
Type | code
Is Modifier | true
Requirements | When using a Location resource for scheduling or orders, we need to be able to refer to a class of Locations instead of a specific Location.
Comments | This is labeled as a modifer because whether or not the location is a class of locations changes how it can be used and understood.
Location.type
Definition | Indicates the type of function performed at the location.
Control | 0..1
Binding | Indicates the type of function performed at the location. The codes SHALL be taken from ServiceDeliveryLocationRoleType; other codes may be used where these codes are not suitable
Type | CodeableConcept
Location.telecom
Definition | The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
Control | 0..*
Type | ContactPoint
Must Support | true
Location.address
Definition | Physical location.
Control | 1..1
Type | Address
Must Support | true
Requirements | If locations can be visited, we need to keep track of their address.
Comments | This was kept as 0..1 as there is no use property on the address, so wouldn't be able to identify different address types.
Location.address.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
Location.address.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Location.address.use
Definition | The purpose of this address.
Control | 0..1
Binding | The use of an address The codes SHALL be taken from AddressUse
Type | code
Is Modifier | true
Requirements | Allows an appropriate address to be chosen from a list of many.
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old.
Example | General:home
Location.address.type
Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
Control | 0..1
Binding | Address Type for CRD The codes SHALL be taken from CRD Location Address Types
Type | code
Must Support | true
Example | General:both
Location.address.text
Definition | A full text representation of the address.
Control | 0..1
Type | string
Requirements | A renderable, unencoded form.
Comments | Can provide both a text representation and parts.
Example | General:137 Nowhere Street, Erewhon 9132
Location.address.line
Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
Control | 0..*
Type | string
Must Support | true
Requirements | home | work | temp | old - purpose of this address.
Example | General:137 Nowhere Street
Location.address.city
Definition | The name of the city, town, village or other community or delivery center.
Control | 0..1
Type | string
Must Support | true
Alternate Names | Municpality
Example | General:Erewhon
Location.address.district
Definition | The name of the administrative area (county).
Control | 0..1
Type | string
Alternate Names | County
Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
Example | General:Madison
Location.address.state
Definition | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes).
Control | 0..1
Binding | Two letter USPS alphabetic codes. The codes SHALL be taken from USPS Two Letter Alphabetic Codes; other codes may be used where these codes are not suitable
Type | string
Must Support | true
Alternate Names | Province, Territory
Location.address.postalCode
Definition | A postal code designating a region defined by the postal service.
Control | 0..1
Type | string
Must Support | true
Alternate Names | Zip
Example | General:9132
Location.address.country
Definition | Country - a nation as commonly understood or generally accepted.
Control | 0..1
Type | string
Comments | ISO 3166 3 letter codes can be used in place of a full country name.
Location.address.period
Definition | Time period when address was/is in use.
Control | 0..1
Type | Period
Requirements | Allows addresses to be placed in historical context.
Example | General:<valuePeriod xmlns="http://hl7.org/fhir"> <start value="2010-03-23T10:00:00+10:00"/> <end value="2010-07-01T10:00:00+10:00"/> </valuePeriod>
Location.physicalType
Definition | Physical form of the location, e.g. building, room, vehicle, road.
Control | 0..1
Binding | Physical form of the location For example codes, see LocationType
Type | CodeableConcept
Requirements | For purposes of showing relevant locations in queries, we need to categorize locations.
Location.position
Definition | The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
Control | 0..1
Type | BackboneElement
Requirements | For mobile applications and automated route-finding knowing the exact location of the Location is required.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
Location.position.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
Location.position.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Location.position.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Control | 0..*
Type | Extension
Is Modifier | true
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Location.position.longitude
Definition | Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).
Control | 1..1
Type | decimal
Location.position.latitude
Definition | Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).
Control | 1..1
Type | decimal
Location.position.altitude
Definition | Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).
Control | 0..1
Type | decimal
Location.managingOrganization
Definition | The organization responsible for the provisioning and upkeep of the location.
Control | 1..1
Type | Reference(CRD Organization)
Must Support | true
Requirements | Need to know who manages the location.
Comments | This can also be used as the part of the organization hierarchy where this location provides services. These services can be defined through the HealthcareService resource.
Location.partOf
Definition | Another Location which this Location is physically part of.
Control | 0..1
Type | Reference(CRD Location)
Requirements | For purposes of location, display and identification, knowing which locations are located within other locations is important.
Location.endpoint
Definition | Technical endpoints providing access to services operated for the location.
Control | 0..*
Type | Reference(Endpoint)
Requirements | Organizations may have different systems at different locations that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.