DocumentHeader

COFE-Location-1

COFE-Location-1

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..*
Type Location
Comments
Location.identifier
Definition

Unique code or number identifying the location to its users.

Control 0..*
Type Identifier
Requirements

Organization label locations in registries, need to keep track of those.

Comments
Location.identifier.use
Definition

The purpose of this identifier.

Control 0..1
Binding

Identifies the purpose for this identifier, if known .

The codes SHALL be taken from http://hl7.org/fhir/ValueSet/identifier-use

Type Code
Is Modifier True
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Location.identifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control 0..1
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

The codes SHALL be taken from the following if appropriate, otherwise an alternate coding may be included instead. http://hl7.org/fhir/ValueSet/identifier-type

Type CodeableConcept
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Location.identifier.type.coding
Definition

A reference to a code defined by a terminology system.

Control 0..*
Type Coding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

Location.identifier.type.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control 0..1
Type Uri
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Location.identifier.type.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Control 0..1
Type String
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Location.identifier.type.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control 0..1
Type Code
Requirements

Need to refer to a particular code in the system.

Comments
Location.identifier.type.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control 0..1
Type String
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments
Location.identifier.type.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control 0..1
Type Boolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Location.identifier.type.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control 0..1
Type String
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Location.identifier.system
Definition

Establishes the namespace in which set of possible id values is unique.

Control 0..1
Type Uri
Requirements

There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers.

Comments
Example http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
Location.identifier.value
Definition

The portion of the identifier typically displayed to the user and which is unique within the context of the system.

Control 0..1
Type String
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986.

Example 123456
Location.identifier.period
Definition

Time period during which identifier is/was valid for use.

Control 0..1
Type Period
Comments
Location.identifier.period.start
Definition

The start of the period. The boundary is inclusive.

Control 0..1 ?
Type DateTime
Comments

If the low element is missing, the meaning is that the low boundary is not known.

Location.identifier.period.end
Definition

The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

Control 0..1 ?
Type DateTime
Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.

Location.identifier.assigner
Definition

Organization that issued/manages the identifier.

Control 0..1
Comments

The reference may be just a text description of the assigner.

Location.identifier.assigner.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Control 0..1 ?
Type String
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Location.identifier.assigner.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control 0..1
Type String
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Location.status
Definition

active | suspended | inactive.

Control 0..1
Binding

Indicates whether the location is still in use.

The codes SHALL be taken from http://hl7.org/fhir/ValueSet/location-status

Type Code
Is Modifier True
Comments
Location.name
Definition

Name of the location as used by humans. Does not need to be unique.

Control 0..1
Type String
Comments
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.

Comments
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 http://hl7.org/fhir/ValueSet/location-mode

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
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 the following if appropriate, otherwise an alternate coding may be included instead. http://hl7.org/fhir/ValueSet/v3-ServiceDeliveryLocationRoleType

Type CodeableConcept
Comments
Location.type.coding
Definition

A reference to a code defined by a terminology system.

Control 0..*
Type Coding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

Location.type.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control 0..1
Type Uri
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Location.type.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Control 0..1
Type String
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Location.type.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control 0..1
Type Code
Requirements

Need to refer to a particular code in the system.

Comments
Location.type.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control 0..1
Type String
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments
Location.type.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control 0..1
Type Boolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Location.type.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control 0..1
Type String
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

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
Comments
Location.telecom.system
Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Control 0..1 ?
Binding

Telecommunications form for contact point

The codes SHALL be taken from http://hl7.org/fhir/ValueSet/contact-point-system

Type Code
Comments
Location.telecom.value
Definition

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

Control 0..1
Type String
Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Comments

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

Location.telecom.use
Definition

Identifies the purpose for the contact point.

Control 0..1
Binding

Use of contact point

The codes SHALL be taken from http://hl7.org/fhir/ValueSet/contact-point-use

Type Code
Is Modifier True
Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Location.telecom.rank
Definition

Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values.

Control 0..1
Type PositiveInt
Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Location.telecom.period
Definition

Time period when the contact point was/is in use.

Control 0..1
Type Period
Comments
Location.telecom.period.start
Definition

The start of the period. The boundary is inclusive.

Control 0..1 ?
Type DateTime
Comments

If the low element is missing, the meaning is that the low boundary is not known.

Location.telecom.period.end
Definition

The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

Control 0..1 ?
Type DateTime
Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.

Location.address
Definition

Physical location.

Control 0..1
Type Address
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.use
Definition

The purpose of this address.

Control 0..1
Binding

The use of an address

The codes SHALL be taken from http://hl7.org/fhir/ValueSet/address-use

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 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

The type of an address (physical / postal)

The codes SHALL be taken from http://hl7.org/fhir/ValueSet/address-type

Type Code
Comments
Example 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 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
Requirements

home | work | temp | old - purpose of this address.

Comments
Example 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
Aliases Municpality
Comments
Example Erewhon
Location.address.district
Definition

The name of the administrative area (county).

Control 0..1
Type String
Aliases County
Comments

District is sometimes known as county, but in some regions 'county' in used in place of city (municipality), so county name should be conveyed in city instead.

Example Madison
Location.address.postalCode
Definition

A postal code designating a region defined by the postal service.

Control 0..1
Type String
Aliases Zip
Comments
Example 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.

Comments
Example Hl7.Fhir.Model.Period
Location.address.period.start
Definition

The start of the period. The boundary is inclusive.

Control 0..1 ?
Type DateTime
Comments

If the low element is missing, the meaning is that the low boundary is not known.

Location.address.period.end
Definition

The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

Control 0..1 ?
Type DateTime
Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.

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 http://hl7.org/fhir/ValueSet/location-physical-type

; other codes may be used where these codes are not suitable
Type CodeableConcept
Requirements

For purposes of showing relevant locations in queries, we need to categorize locations.

Comments
Location.physicalType.coding
Definition

A reference to a code defined by a terminology system.

Control 0..*
Type Coding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

Location.physicalType.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control 0..1
Type Uri
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Location.physicalType.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Control 0..1
Type String
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Location.physicalType.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control 0..1
Type Code
Requirements

Need to refer to a particular code in the system.

Comments
Location.physicalType.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control 0..1
Type String
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments
Location.physicalType.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control 0..1
Type Boolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Location.physicalType.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control 0..1
Type String
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

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.

Comments
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
Aliases 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
Comments
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
Comments
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
Comments
Location.managingOrganization
Definition

The organization responsible for the provisioning and upkeep of the location.

Control 0..1
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.managingOrganization.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Control 0..1 ?
Type String
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Location.managingOrganization.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control 0..1
Type String
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Location.partOf
Definition

Another Location which this Location is physically part of.

Control 0..1
Requirements

For purposes of location, display and identification, knowing which locations are located within other locations is important.

Comments
Location.partOf.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Control 0..1 ?
Type String
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Location.partOf.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control 0..1
Type String
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.