StructureDefinition-UKCore-Location

Defines the UK Core constraints and extensions on the Location resource for the minimal set of data to query and retrieve location information.

Profile Purpose

This profile can be used to exchange details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. The location includes both incidental locations (a place which is used for healthcare without prior designation or authorisation) and dedicated, formally appointed locations. Locations may be private, public, mobile or fixed and scale from small freezers to full hospital buildings or parking garages.

Snapshot View

Location	I		Location	There are no (further) constraints on this element Element Id Location Short description Details and position information for a physical place Definition Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. Data Type Location Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.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()` 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 `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-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` Mappings rim:Entity. Role, or Act rim:.Role[classCode=SDLC]
identifier	Σ	0..*	Identifier	Element Id Location.identifier Short description Unique code or number identifying the location to its users Definition Unique code or number identifying the location to its users. Requirements Organization label locations in registries, need to keep track of those. Data Type Identifier Sliced: Unordered, Open, by system(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier w5:FiveWs.identifier rim:.id
odsSiteCode	Σ	0..1	Identifier	Element Id Location.identifier:odsSiteCode Short description ODS Site code to identify the organisation at site level Definition ODS Site code to identify the organisation at site level. Requirements Organization label locations in registries, need to keep track of those. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier w5:FiveWs.identifier rim:.id
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Location.identifier:odsSiteCode.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Location.identifier:odsSiteCode.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. 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. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	Σ	1..1	uriFixed Value	Element Id Location.identifier:odsSiteCode.system Short description ODS Code Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed Value https://fhir.nhs.uk/Id/ods-site-code Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	Σ	1..1	string	There are no (further) constraints on this element Element Id Location.identifier:odsSiteCode.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Location.identifier:odsSiteCode.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(UK Core Organization)	Element Id Location.identifier:odsSiteCode.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(UK Core Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
status	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Location.status Short description active \| suspended \| inactive 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. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding Indicates whether the location is still in use. LocationStatus (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.status rim:.statusCode
operationalStatus	Σ	0..1	CodingBinding	There are no (further) constraints on this element Element Id Location.operationalStatus Short description The operational status of the location (typically only for a bed/room) Definition The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance. 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. Data Type Coding Binding The operational status if the location (where typically a bed/room). v2.0116 (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim:CV orim:fhir:Coding rdfs:subClassOf dt:CDCoding w5:FiveWs.status
name	Σ	0..1	string	There are no (further) constraints on this element Element Id Location.name Short description Name of the location as used by humans Definition Name of the location as used by humans. Does not need to be unique. Comments If the name of a location changes, consider putting the old name in the alias column so that it can still be located through searches. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.name
alias		0..*	string	There are no (further) constraints on this element Element Id Location.alias Short description A list of alternate names that the location is known as, or was known as, in the past Definition A list of alternate names that the location is known as, or was known as, in the past. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.name
description	Σ	0..1	string	There are no (further) constraints on this element Element Id Location.description Short description Additional details about the location that could be displayed as further information to identify the location beyond its name Definition Description of the Location, which helps in finding or referencing the place. Requirements Humans need additional information to verify a correct location has been identified. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.playingEntity[classCode=PLC determinerCode=INSTANCE].desc
mode	Σ	0..1	codeBinding	There are no (further) constraints on this element Element Id Location.mode Short description instance \| kind Definition Indicates whether a resource instance represents a specific location or a class of locations. 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 modifier because whether or not the location is a class of locations changes how it can be used and understood. Data Type code Binding Indicates whether a resource instance represents a specific location or a class of locations. LocationMode (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.class rim:.playingEntity[classCode=PLC].determinerCode
type	Σ	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element Id Location.type Short description Type of function performed Definition Indicates the type of function performed at the location. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding Indicates the type of function performed at the location. v3.ServiceDeliveryLocationRoleType (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class rim:.code
telecom	I	0..*	ContactPoint	There are no (further) constraints on this element Element Id Location.telecom Short description Contact details of the location 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. Data Type ContactPoint Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint rim:.telecom
address		0..1	Address	There are no (further) constraints on this element Element Id Location.address Short description Physical location Definition Physical location. Requirements If locations can be visited, we need to keep track of their address. Comments Additional addresses should be recorded using another instance of the Location resource, or via the Organization. Data Type Address Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XAD rim:AD servd:Address rim:.addr
physicalType	Σ	0..1	CodeableConcept	There are no (further) constraints on this element Element Id Location.physicalType Short description Physical form of the location Definition Physical form of the location, e.g. building, room, vehicle, road. Requirements For purposes of showing relevant locations in queries, we need to categorize locations. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding Physical form of the location. LocationType (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class rim:.playingEntity [classCode=PLC].code
position		0..1	BackboneElement	There are no (further) constraints on this element Element Id Location.position Short description The absolute geographic location Definition The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML). Requirements For mobile applications and automated route-finding knowing the exact location of the Location is required. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.playingEntity [classCode=PLC determinerCode=INSTANCE].positionText
longitude		1..1	decimal	There are no (further) constraints on this element Element Id Location.position.longitude Short description Longitude with WGS84 datum Definition Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below). Comments Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) Data Type decimal Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:(RIM Opted not to map the sub-elements of GPS location, is now an OBS)
latitude		1..1	decimal	There are no (further) constraints on this element Element Id Location.position.latitude Short description Latitude with WGS84 datum Definition Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below). Comments Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) Data Type decimal Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:(RIM Opted not to map the sub-elements of GPS location, is now an OBS)
altitude		0..1	decimal	There are no (further) constraints on this element Element Id Location.position.altitude Short description Altitude with WGS84 datum Definition Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below). Comments Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) Data Type decimal Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:(RIM Opted not to map the sub-elements of GPS location, is now an OBS)
managingOrganization	Σ I	0..1	Reference(UK Core Organization)	Element Id Location.managingOrganization Short description Organization responsible for provisioning and upkeep Definition The organization responsible for the provisioning and upkeep of the location. 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. Data Type Reference(UK Core Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim:.scopingEntity[classCode=ORG determinerKind=INSTANCE]
reference	Σ I	0..1	string	There are no (further) constraints on this element Element Id Location.managingOrganization.reference Short description Literal reference, Relative, internal or absolute URL 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. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
type	Σ	0..1	uriBinding	There are no (further) constraints on this element Element Id Location.managingOrganization.type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Data Type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
identifier	Σ	0..1	Identifier	There are no (further) constraints on this element Element Id Location.managingOrganization.identifier Short description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation\|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier rim:.identifier
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Location.managingOrganization.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Location.managingOrganization.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. 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. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	Σ	0..1	uri	There are no (further) constraints on this element Element Id Location.managingOrganization.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	Σ	0..1	string	There are no (further) constraints on this element Element Id Location.managingOrganization.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Location.managingOrganization.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(UK Core Organization)	Element Id Location.managingOrganization.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(UK Core Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
display	Σ	0..1	string	There are no (further) constraints on this element Element Id Location.managingOrganization.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
partOf	I	0..1	Reference(UK Core Location)	Element Id Location.partOf Short description Another Location this one is physically a part of Definition Another Location of which this Location is physically a part of. Requirements For purposes of location, display and identification, knowing which locations are located within other locations is important. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data Type Reference(UK Core Location) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim:.inboundLink[typeCode=PART].source[classCode=SDLC]
reference	Σ I	0..1	string	There are no (further) constraints on this element Element Id Location.partOf.reference Short description Literal reference, Relative, internal or absolute URL 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. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
type	Σ	0..1	uriBinding	There are no (further) constraints on this element Element Id Location.partOf.type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Data Type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
identifier	Σ	0..1	Identifier	There are no (further) constraints on this element Element Id Location.partOf.identifier Short description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation\|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier rim:.identifier
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Location.partOf.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Location.partOf.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. 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. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	Σ	0..1	uri	There are no (further) constraints on this element Element Id Location.partOf.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	Σ	0..1	string	There are no (further) constraints on this element Element Id Location.partOf.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Location.partOf.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(UK Core Organization)	Element Id Location.partOf.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(UK Core Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
display	Σ	0..1	string	There are no (further) constraints on this element Element Id Location.partOf.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
hoursOfOperation		0..*	BackboneElement	There are no (further) constraints on this element Element Id Location.hoursOfOperation Short description What days/times during a week is this location usually open Definition What days/times during a week is this location usually open. Comments This type of information is commonly found published in directories and on websites informing customers when the facility is available. Specific services within the location may have their own hours which could be shorter (or longer) than the locations hours. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.effectiveTime
daysOfWeek		0..*	codeBinding	There are no (further) constraints on this element Element Id Location.hoursOfOperation.daysOfWeek Short description mon \| tue \| wed \| thu \| fri \| sat \| sun Definition Indicates which days of the week are available between the start and end Times. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The days of the week. DaysOfWeek (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.effectiveTime
allDay		0..1	boolean	There are no (further) constraints on this element Element Id Location.hoursOfOperation.allDay Short description The Location is open all day Definition The Location is open all day. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.effectiveTime
openingTime		0..1	time	There are no (further) constraints on this element Element Id Location.hoursOfOperation.openingTime Short description Time that the Location opens Definition Time that the Location opens. Data Type time Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.effectiveTime
closingTime		0..1	time	There are no (further) constraints on this element Element Id Location.hoursOfOperation.closingTime Short description Time that the Location closes Definition Time that the Location closes. Data Type time Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.effectiveTime
availabilityExceptions		0..1	string	There are no (further) constraints on this element Element Id Location.availabilityExceptions Short description Description of availability exceptions Definition A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
endpoint	I	0..*	Reference(Endpoint)	There are no (further) constraints on this element Element Id Location.endpoint Short description Technical endpoints providing access to services operated for the location Definition Technical endpoints providing access to services operated for the location. 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. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data Type Reference(Endpoint) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
reference	Σ I	0..1	string	There are no (further) constraints on this element Element Id Location.endpoint.reference Short description Literal reference, Relative, internal or absolute URL 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. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
type	Σ	0..1	uriBinding	There are no (further) constraints on this element Element Id Location.endpoint.type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Data Type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
identifier	Σ	0..1	Identifier	There are no (further) constraints on this element Element Id Location.endpoint.identifier Short description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation\|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier rim:.identifier
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Location.endpoint.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Location.endpoint.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. 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. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	Σ	0..1	uri	There are no (further) constraints on this element Element Id Location.endpoint.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	Σ	0..1	string	There are no (further) constraints on this element Element Id Location.endpoint.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Location.endpoint.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(UK Core Organization)	Element Id Location.endpoint.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(UK Core Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
display	Σ	0..1	string	There are no (further) constraints on this element Element Id Location.endpoint.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A

Differential View

Location	I		Location	There are no (further) constraints on this element Element Id Location Short description Details and position information for a physical place Definition Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. Data Type Location Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.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()` 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 `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-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` Mappings rim:Entity. Role, or Act rim:.Role[classCode=SDLC]
identifier	Σ	0..*	Identifier	Element Id Location.identifier Short description Unique code or number identifying the location to its users Definition Unique code or number identifying the location to its users. Requirements Organization label locations in registries, need to keep track of those. Data Type Identifier Sliced: Unordered, Open, by system(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier w5:FiveWs.identifier rim:.id
odsSiteCode	Σ	0..1	Identifier	Element Id Location.identifier:odsSiteCode Short description ODS Site code to identify the organisation at site level Definition ODS Site code to identify the organisation at site level. Requirements Organization label locations in registries, need to keep track of those. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier w5:FiveWs.identifier rim:.id
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Location.identifier:odsSiteCode.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Location.identifier:odsSiteCode.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. 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. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	Σ	1..1	uriFixed Value	Element Id Location.identifier:odsSiteCode.system Short description ODS Code Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed Value https://fhir.nhs.uk/Id/ods-site-code Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	Σ	1..1	string	There are no (further) constraints on this element Element Id Location.identifier:odsSiteCode.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Location.identifier:odsSiteCode.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(UK Core Organization)	Element Id Location.identifier:odsSiteCode.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(UK Core Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
status	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Location.status Short description active \| suspended \| inactive 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. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding Indicates whether the location is still in use. LocationStatus (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.status rim:.statusCode
operationalStatus	Σ	0..1	CodingBinding	There are no (further) constraints on this element Element Id Location.operationalStatus Short description The operational status of the location (typically only for a bed/room) Definition The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance. 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. Data Type Coding Binding The operational status if the location (where typically a bed/room). v2.0116 (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim:CV orim:fhir:Coding rdfs:subClassOf dt:CDCoding w5:FiveWs.status
name	Σ	0..1	string	There are no (further) constraints on this element Element Id Location.name Short description Name of the location as used by humans Definition Name of the location as used by humans. Does not need to be unique. Comments If the name of a location changes, consider putting the old name in the alias column so that it can still be located through searches. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.name
alias		0..*	string	There are no (further) constraints on this element Element Id Location.alias Short description A list of alternate names that the location is known as, or was known as, in the past Definition A list of alternate names that the location is known as, or was known as, in the past. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.name
description	Σ	0..1	string	There are no (further) constraints on this element Element Id Location.description Short description Additional details about the location that could be displayed as further information to identify the location beyond its name Definition Description of the Location, which helps in finding or referencing the place. Requirements Humans need additional information to verify a correct location has been identified. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.playingEntity[classCode=PLC determinerCode=INSTANCE].desc
mode	Σ	0..1	codeBinding	There are no (further) constraints on this element Element Id Location.mode Short description instance \| kind Definition Indicates whether a resource instance represents a specific location or a class of locations. 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 modifier because whether or not the location is a class of locations changes how it can be used and understood. Data Type code Binding Indicates whether a resource instance represents a specific location or a class of locations. LocationMode (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.class rim:.playingEntity[classCode=PLC].determinerCode
type	Σ	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element Id Location.type Short description Type of function performed Definition Indicates the type of function performed at the location. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding Indicates the type of function performed at the location. v3.ServiceDeliveryLocationRoleType (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class rim:.code
telecom	I	0..*	ContactPoint	There are no (further) constraints on this element Element Id Location.telecom Short description Contact details of the location 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. Data Type ContactPoint Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint rim:.telecom
address		0..1	Address	There are no (further) constraints on this element Element Id Location.address Short description Physical location Definition Physical location. Requirements If locations can be visited, we need to keep track of their address. Comments Additional addresses should be recorded using another instance of the Location resource, or via the Organization. Data Type Address Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XAD rim:AD servd:Address rim:.addr
physicalType	Σ	0..1	CodeableConcept	There are no (further) constraints on this element Element Id Location.physicalType Short description Physical form of the location Definition Physical form of the location, e.g. building, room, vehicle, road. Requirements For purposes of showing relevant locations in queries, we need to categorize locations. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding Physical form of the location. LocationType (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class rim:.playingEntity [classCode=PLC].code
position		0..1	BackboneElement	There are no (further) constraints on this element Element Id Location.position Short description The absolute geographic location Definition The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML). Requirements For mobile applications and automated route-finding knowing the exact location of the Location is required. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.playingEntity [classCode=PLC determinerCode=INSTANCE].positionText
longitude		1..1	decimal	There are no (further) constraints on this element Element Id Location.position.longitude Short description Longitude with WGS84 datum Definition Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below). Comments Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) Data Type decimal Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:(RIM Opted not to map the sub-elements of GPS location, is now an OBS)
latitude		1..1	decimal	There are no (further) constraints on this element Element Id Location.position.latitude Short description Latitude with WGS84 datum Definition Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below). Comments Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) Data Type decimal Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:(RIM Opted not to map the sub-elements of GPS location, is now an OBS)
altitude		0..1	decimal	There are no (further) constraints on this element Element Id Location.position.altitude Short description Altitude with WGS84 datum Definition Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below). Comments Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) Data Type decimal Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:(RIM Opted not to map the sub-elements of GPS location, is now an OBS)
managingOrganization	Σ I	0..1	Reference(UK Core Organization)	Element Id Location.managingOrganization Short description Organization responsible for provisioning and upkeep Definition The organization responsible for the provisioning and upkeep of the location. 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. Data Type Reference(UK Core Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim:.scopingEntity[classCode=ORG determinerKind=INSTANCE]
reference	Σ I	0..1	string	There are no (further) constraints on this element Element Id Location.managingOrganization.reference Short description Literal reference, Relative, internal or absolute URL 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. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
type	Σ	0..1	uriBinding	There are no (further) constraints on this element Element Id Location.managingOrganization.type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Data Type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
identifier	Σ	0..1	Identifier	There are no (further) constraints on this element Element Id Location.managingOrganization.identifier Short description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation\|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier rim:.identifier
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Location.managingOrganization.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Location.managingOrganization.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. 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. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	Σ	0..1	uri	There are no (further) constraints on this element Element Id Location.managingOrganization.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	Σ	0..1	string	There are no (further) constraints on this element Element Id Location.managingOrganization.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Location.managingOrganization.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(UK Core Organization)	Element Id Location.managingOrganization.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(UK Core Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
display	Σ	0..1	string	There are no (further) constraints on this element Element Id Location.managingOrganization.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
partOf	I	0..1	Reference(UK Core Location)	Element Id Location.partOf Short description Another Location this one is physically a part of Definition Another Location of which this Location is physically a part of. Requirements For purposes of location, display and identification, knowing which locations are located within other locations is important. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data Type Reference(UK Core Location) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim:.inboundLink[typeCode=PART].source[classCode=SDLC]
reference	Σ I	0..1	string	There are no (further) constraints on this element Element Id Location.partOf.reference Short description Literal reference, Relative, internal or absolute URL 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. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
type	Σ	0..1	uriBinding	There are no (further) constraints on this element Element Id Location.partOf.type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Data Type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
identifier	Σ	0..1	Identifier	There are no (further) constraints on this element Element Id Location.partOf.identifier Short description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation\|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier rim:.identifier
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Location.partOf.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Location.partOf.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. 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. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	Σ	0..1	uri	There are no (further) constraints on this element Element Id Location.partOf.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	Σ	0..1	string	There are no (further) constraints on this element Element Id Location.partOf.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Location.partOf.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(UK Core Organization)	Element Id Location.partOf.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(UK Core Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
display	Σ	0..1	string	There are no (further) constraints on this element Element Id Location.partOf.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
hoursOfOperation		0..*	BackboneElement	There are no (further) constraints on this element Element Id Location.hoursOfOperation Short description What days/times during a week is this location usually open Definition What days/times during a week is this location usually open. Comments This type of information is commonly found published in directories and on websites informing customers when the facility is available. Specific services within the location may have their own hours which could be shorter (or longer) than the locations hours. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.effectiveTime
daysOfWeek		0..*	codeBinding	There are no (further) constraints on this element Element Id Location.hoursOfOperation.daysOfWeek Short description mon \| tue \| wed \| thu \| fri \| sat \| sun Definition Indicates which days of the week are available between the start and end Times. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The days of the week. DaysOfWeek (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.effectiveTime
allDay		0..1	boolean	There are no (further) constraints on this element Element Id Location.hoursOfOperation.allDay Short description The Location is open all day Definition The Location is open all day. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.effectiveTime
openingTime		0..1	time	There are no (further) constraints on this element Element Id Location.hoursOfOperation.openingTime Short description Time that the Location opens Definition Time that the Location opens. Data Type time Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.effectiveTime
closingTime		0..1	time	There are no (further) constraints on this element Element Id Location.hoursOfOperation.closingTime Short description Time that the Location closes Definition Time that the Location closes. Data Type time Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.effectiveTime
availabilityExceptions		0..1	string	There are no (further) constraints on this element Element Id Location.availabilityExceptions Short description Description of availability exceptions Definition A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
endpoint	I	0..*	Reference(Endpoint)	There are no (further) constraints on this element Element Id Location.endpoint Short description Technical endpoints providing access to services operated for the location Definition Technical endpoints providing access to services operated for the location. 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. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data Type Reference(Endpoint) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
reference	Σ I	0..1	string	There are no (further) constraints on this element Element Id Location.endpoint.reference Short description Literal reference, Relative, internal or absolute URL 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. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
type	Σ	0..1	uriBinding	There are no (further) constraints on this element Element Id Location.endpoint.type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Data Type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
identifier	Σ	0..1	Identifier	There are no (further) constraints on this element Element Id Location.endpoint.identifier Short description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation\|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier rim:.identifier
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Location.endpoint.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Location.endpoint.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. 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. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	Σ	0..1	uri	There are no (further) constraints on this element Element Id Location.endpoint.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	Σ	0..1	string	There are no (further) constraints on this element Element Id Location.endpoint.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Location.endpoint.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(UK Core Organization)	Element Id Location.endpoint.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(UK Core Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
display	Σ	0..1	string	There are no (further) constraints on this element Element Id Location.endpoint.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A

Hybrid View

Location	I		Location	There are no (further) constraints on this element Element Id Location Short description Details and position information for a physical place Definition Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. Data Type Location Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.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()` 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 `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-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` Mappings rim:Entity. Role, or Act rim:.Role[classCode=SDLC]
identifier	Σ	0..*	Identifier	Element Id Location.identifier Short description Unique code or number identifying the location to its users Definition Unique code or number identifying the location to its users. Requirements Organization label locations in registries, need to keep track of those. Data Type Identifier Sliced: Unordered, Open, by system(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier w5:FiveWs.identifier rim:.id
odsSiteCode	Σ	0..1	Identifier	Element Id Location.identifier:odsSiteCode Short description ODS Site code to identify the organisation at site level Definition ODS Site code to identify the organisation at site level. Requirements Organization label locations in registries, need to keep track of those. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier w5:FiveWs.identifier rim:.id
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Location.identifier:odsSiteCode.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Location.identifier:odsSiteCode.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. 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. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	Σ	1..1	uriFixed Value	Element Id Location.identifier:odsSiteCode.system Short description ODS Code Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed Value https://fhir.nhs.uk/Id/ods-site-code Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	Σ	1..1	string	There are no (further) constraints on this element Element Id Location.identifier:odsSiteCode.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Location.identifier:odsSiteCode.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(UK Core Organization)	Element Id Location.identifier:odsSiteCode.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(UK Core Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
status	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Location.status Short description active \| suspended \| inactive 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. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding Indicates whether the location is still in use. LocationStatus (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.status rim:.statusCode
operationalStatus	Σ	0..1	CodingBinding	There are no (further) constraints on this element Element Id Location.operationalStatus Short description The operational status of the location (typically only for a bed/room) Definition The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance. 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. Data Type Coding Binding The operational status if the location (where typically a bed/room). v2.0116 (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim:CV orim:fhir:Coding rdfs:subClassOf dt:CDCoding w5:FiveWs.status
name	Σ	0..1	string	There are no (further) constraints on this element Element Id Location.name Short description Name of the location as used by humans Definition Name of the location as used by humans. Does not need to be unique. Comments If the name of a location changes, consider putting the old name in the alias column so that it can still be located through searches. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.name
alias		0..*	string	There are no (further) constraints on this element Element Id Location.alias Short description A list of alternate names that the location is known as, or was known as, in the past Definition A list of alternate names that the location is known as, or was known as, in the past. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.name
description	Σ	0..1	string	There are no (further) constraints on this element Element Id Location.description Short description Additional details about the location that could be displayed as further information to identify the location beyond its name Definition Description of the Location, which helps in finding or referencing the place. Requirements Humans need additional information to verify a correct location has been identified. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.playingEntity[classCode=PLC determinerCode=INSTANCE].desc
mode	Σ	0..1	codeBinding	There are no (further) constraints on this element Element Id Location.mode Short description instance \| kind Definition Indicates whether a resource instance represents a specific location or a class of locations. 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 modifier because whether or not the location is a class of locations changes how it can be used and understood. Data Type code Binding Indicates whether a resource instance represents a specific location or a class of locations. LocationMode (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.class rim:.playingEntity[classCode=PLC].determinerCode
type	Σ	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element Id Location.type Short description Type of function performed Definition Indicates the type of function performed at the location. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding Indicates the type of function performed at the location. v3.ServiceDeliveryLocationRoleType (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class rim:.code
telecom	I	0..*	ContactPoint	There are no (further) constraints on this element Element Id Location.telecom Short description Contact details of the location 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. Data Type ContactPoint Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint rim:.telecom
address		0..1	Address	There are no (further) constraints on this element Element Id Location.address Short description Physical location Definition Physical location. Requirements If locations can be visited, we need to keep track of their address. Comments Additional addresses should be recorded using another instance of the Location resource, or via the Organization. Data Type Address Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XAD rim:AD servd:Address rim:.addr
physicalType	Σ	0..1	CodeableConcept	There are no (further) constraints on this element Element Id Location.physicalType Short description Physical form of the location Definition Physical form of the location, e.g. building, room, vehicle, road. Requirements For purposes of showing relevant locations in queries, we need to categorize locations. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding Physical form of the location. LocationType (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class rim:.playingEntity [classCode=PLC].code
position		0..1	BackboneElement	There are no (further) constraints on this element Element Id Location.position Short description The absolute geographic location Definition The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML). Requirements For mobile applications and automated route-finding knowing the exact location of the Location is required. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.playingEntity [classCode=PLC determinerCode=INSTANCE].positionText
longitude		1..1	decimal	There are no (further) constraints on this element Element Id Location.position.longitude Short description Longitude with WGS84 datum Definition Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below). Comments Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) Data Type decimal Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:(RIM Opted not to map the sub-elements of GPS location, is now an OBS)
latitude		1..1	decimal	There are no (further) constraints on this element Element Id Location.position.latitude Short description Latitude with WGS84 datum Definition Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below). Comments Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) Data Type decimal Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:(RIM Opted not to map the sub-elements of GPS location, is now an OBS)
altitude		0..1	decimal	There are no (further) constraints on this element Element Id Location.position.altitude Short description Altitude with WGS84 datum Definition Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below). Comments Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) Data Type decimal Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:(RIM Opted not to map the sub-elements of GPS location, is now an OBS)
managingOrganization	Σ I	0..1	Reference(UK Core Organization)	Element Id Location.managingOrganization Short description Organization responsible for provisioning and upkeep Definition The organization responsible for the provisioning and upkeep of the location. 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. Data Type Reference(UK Core Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim:.scopingEntity[classCode=ORG determinerKind=INSTANCE]
reference	Σ I	0..1	string	There are no (further) constraints on this element Element Id Location.managingOrganization.reference Short description Literal reference, Relative, internal or absolute URL 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. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
type	Σ	0..1	uriBinding	There are no (further) constraints on this element Element Id Location.managingOrganization.type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Data Type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
identifier	Σ	0..1	Identifier	There are no (further) constraints on this element Element Id Location.managingOrganization.identifier Short description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation\|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier rim:.identifier
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Location.managingOrganization.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Location.managingOrganization.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. 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. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	Σ	0..1	uri	There are no (further) constraints on this element Element Id Location.managingOrganization.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	Σ	0..1	string	There are no (further) constraints on this element Element Id Location.managingOrganization.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Location.managingOrganization.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(UK Core Organization)	Element Id Location.managingOrganization.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(UK Core Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
display	Σ	0..1	string	There are no (further) constraints on this element Element Id Location.managingOrganization.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
partOf	I	0..1	Reference(UK Core Location)	Element Id Location.partOf Short description Another Location this one is physically a part of Definition Another Location of which this Location is physically a part of. Requirements For purposes of location, display and identification, knowing which locations are located within other locations is important. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data Type Reference(UK Core Location) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim:.inboundLink[typeCode=PART].source[classCode=SDLC]
reference	Σ I	0..1	string	There are no (further) constraints on this element Element Id Location.partOf.reference Short description Literal reference, Relative, internal or absolute URL 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. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
type	Σ	0..1	uriBinding	There are no (further) constraints on this element Element Id Location.partOf.type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Data Type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
identifier	Σ	0..1	Identifier	There are no (further) constraints on this element Element Id Location.partOf.identifier Short description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation\|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier rim:.identifier
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Location.partOf.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Location.partOf.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. 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. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	Σ	0..1	uri	There are no (further) constraints on this element Element Id Location.partOf.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	Σ	0..1	string	There are no (further) constraints on this element Element Id Location.partOf.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Location.partOf.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(UK Core Organization)	Element Id Location.partOf.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(UK Core Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
display	Σ	0..1	string	There are no (further) constraints on this element Element Id Location.partOf.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
hoursOfOperation		0..*	BackboneElement	There are no (further) constraints on this element Element Id Location.hoursOfOperation Short description What days/times during a week is this location usually open Definition What days/times during a week is this location usually open. Comments This type of information is commonly found published in directories and on websites informing customers when the facility is available. Specific services within the location may have their own hours which could be shorter (or longer) than the locations hours. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.effectiveTime
daysOfWeek		0..*	codeBinding	There are no (further) constraints on this element Element Id Location.hoursOfOperation.daysOfWeek Short description mon \| tue \| wed \| thu \| fri \| sat \| sun Definition Indicates which days of the week are available between the start and end Times. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The days of the week. DaysOfWeek (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.effectiveTime
allDay		0..1	boolean	There are no (further) constraints on this element Element Id Location.hoursOfOperation.allDay Short description The Location is open all day Definition The Location is open all day. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.effectiveTime
openingTime		0..1	time	There are no (further) constraints on this element Element Id Location.hoursOfOperation.openingTime Short description Time that the Location opens Definition Time that the Location opens. Data Type time Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.effectiveTime
closingTime		0..1	time	There are no (further) constraints on this element Element Id Location.hoursOfOperation.closingTime Short description Time that the Location closes Definition Time that the Location closes. Data Type time Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.effectiveTime
availabilityExceptions		0..1	string	There are no (further) constraints on this element Element Id Location.availabilityExceptions Short description Description of availability exceptions Definition A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
endpoint	I	0..*	Reference(Endpoint)	There are no (further) constraints on this element Element Id Location.endpoint Short description Technical endpoints providing access to services operated for the location Definition Technical endpoints providing access to services operated for the location. 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. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data Type Reference(Endpoint) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
reference	Σ I	0..1	string	There are no (further) constraints on this element Element Id Location.endpoint.reference Short description Literal reference, Relative, internal or absolute URL 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. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
type	Σ	0..1	uriBinding	There are no (further) constraints on this element Element Id Location.endpoint.type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Data Type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
identifier	Σ	0..1	Identifier	There are no (further) constraints on this element Element Id Location.endpoint.identifier Short description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation\|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier rim:.identifier
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Location.endpoint.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Location.endpoint.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. 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. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	Σ	0..1	uri	There are no (further) constraints on this element Element Id Location.endpoint.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	Σ	0..1	string	There are no (further) constraints on this element Element Id Location.endpoint.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Location.endpoint.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(UK Core Organization)	Element Id Location.endpoint.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(UK Core Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
display	Σ	0..1	string	There are no (further) constraints on this element Element Id Location.endpoint.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A

Table View

Location		..
Location.identifier		..
Location.identifier		..1
Location.identifier.system		1..
Location.identifier.value		1..
Location.identifier.assigner	Reference(UK Core Organization)	..
Location.managingOrganization	Reference(UK Core Organization)	..
Location.managingOrganization.identifier		..
Location.managingOrganization.identifier.assigner	Reference(UK Core Organization)	..
Location.partOf	Reference(UK Core Location)	..
Location.partOf.identifier		..
Location.partOf.identifier.assigner	Reference(UK Core Organization)	..
Location.endpoint		..
Location.endpoint.identifier		..
Location.endpoint.identifier.assigner	Reference(UK Core Organization)	..

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Location" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location" />
    <version value="2.1.0" />
    <name value="UKCoreLocation" />
    <title value="UK Core Location" />
    <status value="active" />
    <date value="2021-09-10" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="secretariat@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <contact>
        <name value="NHS Digital" />
        <telecom>
            <system value="email" />
            <value value="interoperabilityteam@nhs.net" />
            <use value="work" />
            <rank value="2" />
        </telecom>
    </contact>
    <description value="Defines the UK Core constraints and extensions on the Location resource for the minimal set of data to query and retrieve location information." />
    <purpose value="This profile can be used to exchange details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.\nA location includes both incidental locations (a place which is used for healthcare without prior designation or authorisation) and dedicated, formally appointed locations. Locations may be private, public, mobile or fixed and scale from small freezers to full hospital buildings or parking garages." />
    <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <mapping>
        <identity value="w5" />
        <uri value="http://hl7.org/fhir/fivews" />
        <name value="FiveWs Pattern Mapping" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="Location" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Location" />
    <derivation value="constraint" />
    <differential>
        <element id="Location.identifier">
            <path value="Location.identifier" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="system" />
                </discriminator>
                <rules value="open" />
            </slicing>
        </element>
        <element id="Location.identifier:odsSiteCode">
            <path value="Location.identifier" />
            <sliceName value="odsSiteCode" />
            <short value="ODS Site code to identify the organisation at site level" />
            <definition value="ODS Site code to identify the organisation at site level." />
            <max value="1" />
        </element>
        <element id="Location.identifier:odsSiteCode.system">
            <path value="Location.identifier.system" />
            <short value="ODS Code" />
            <min value="1" />
            <fixedUri value="https://fhir.nhs.uk/Id/ods-site-code" />
        </element>
        <element id="Location.identifier:odsSiteCode.value">
            <path value="Location.identifier.value" />
            <min value="1" />
        </element>
        <element id="Location.identifier:odsSiteCode.assigner">
            <path value="Location.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Location.managingOrganization">
            <path value="Location.managingOrganization" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Location.managingOrganization.identifier.assigner">
            <path value="Location.managingOrganization.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Location.partOf">
            <path value="Location.partOf" />
            <type>
                <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy">
                    <valueBoolean value="true" />
                </extension>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location" />
            </type>
        </element>
        <element id="Location.partOf.identifier.assigner">
            <path value="Location.partOf.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Location.endpoint.identifier.assigner">
            <path value="Location.endpoint.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-Location",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location",
    "version": "2.1.0",
    "name": "UKCoreLocation",
    "title": "UK Core Location",
    "status": "active",
    "date": "2021-09-10",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "secretariat@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        },
        {
            "name": "NHS Digital",
            "telecom":  [
                {
                    "system": "email",
                    "value": "interoperabilityteam@nhs.net",
                    "use": "work",
                    "rank": 2
                }
            ]
        }
    ],
    "description": "Defines the UK Core constraints and extensions on the Location resource for the minimal set of data to query and retrieve location information.",
    "purpose": "This profile can be used to exchange details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.\nA location includes both incidental locations (a place which is used for healthcare without prior designation or authorisation) and dedicated, formally appointed locations. Locations may be private, public, mobile or fixed and scale from small freezers to full hospital buildings or parking garages.",
    "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html.",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        },
        {
            "identity": "w5",
            "uri": "http://hl7.org/fhir/fivews",
            "name": "FiveWs Pattern Mapping"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "Location",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Location",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Location.identifier",
                "path": "Location.identifier",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "system"
                        }
                    ],
                    "rules": "open"
                }
            },
            {
                "id": "Location.identifier:odsSiteCode",
                "path": "Location.identifier",
                "sliceName": "odsSiteCode",
                "short": "ODS Site code to identify the organisation at site level",
                "definition": "ODS Site code to identify the organisation at site level.",
                "max": "1"
            },
            {
                "id": "Location.identifier:odsSiteCode.system",
                "path": "Location.identifier.system",
                "short": "ODS Code",
                "min": 1,
                "fixedUri": "https://fhir.nhs.uk/Id/ods-site-code"
            },
            {
                "id": "Location.identifier:odsSiteCode.value",
                "path": "Location.identifier.value",
                "min": 1
            },
            {
                "id": "Location.identifier:odsSiteCode.assigner",
                "path": "Location.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Location.managingOrganization",
                "path": "Location.managingOrganization",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Location.managingOrganization.identifier.assigner",
                "path": "Location.managingOrganization.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Location.partOf",
                "path": "Location.partOf",
                "type":  [
                    {
                        "extension":  [
                            {
                                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
                                "valueBoolean": true
                            }
                        ],
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location"
                        ]
                    }
                ]
            },
            {
                "id": "Location.partOf.identifier.assigner",
                "path": "Location.partOf.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Location.endpoint.identifier.assigner",
                "path": "Location.endpoint.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            }
        ]
    }
}

Examples

SJUH Location - An example to illustrate a Cardiology department in a hospital
Example UKCore-Location-SJUH
General Practice Nurse Clinic location - An example to illustrate a General Practice Nurse Clinic
Example UKCore-Location-GeneralPracticeNurseClinic

Example Usage Scenarios

The following are example usage scenarios for the UK Core Location profile:

To describe care locations such as hospital wards
To describe locations where patient care has or may take place, including scenes of accidents like by the side of a road.

Profile specific implementation guidance:

Minimal Viable Content

As a minimum either a Location.identifier or Location.name should be provided.

All other elements are optional.

`identifier`

The identifier is the most important element of a FHIR resource for interoperability. It acts as the externally facing unique business identifier for the resource. A key phrase from the FHIR R4 standard is;

[for identifier] ...All resources that have an identifier element support searching by the identifier, so that records can be located by that method.

Provider Systems

It is recommended that the identifier value is odsSiteCode, but another identifier can be used.

Consumer Systems

Consumer systems MUST consume this data.

`status`

The general availability of the location.

This element is optional but if used must use a value from the codeSystem below:

HTML View

This code system http://hl7.org/fhir/location-status defines the following codes:

Code	Display	Definition
active	Active	The location is operational.
suspended	Suspended	The location is temporarily closed.
inactive	Inactive	The location is no longer used.

Table View

CodeSystem.id[0]	location-status
CodeSystem.meta[0].lastUpdated[0]	2019-11-01T09:29:23.356+11:00
CodeSystem.extension[0].url[0]	http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
CodeSystem.extension[0].valueCode[0]	pa
CodeSystem.extension[1].url[0]	http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
CodeSystem.extension[1].valueCode[0]	trial-use
CodeSystem.extension[2].url[0]	http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[2].valueInteger[0]	3
CodeSystem.url[0]	http://hl7.org/fhir/location-status
CodeSystem.identifier[0].system[0]	urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]	urn:oid:2.16.840.1.113883.4.642.4.333
CodeSystem.version[0]	4.0.1
CodeSystem.name[0]	LocationStatus
CodeSystem.title[0]	LocationStatus
CodeSystem.status[0]	draft
CodeSystem.experimental[0]	False
CodeSystem.date[0]	2019-11-01T09:29:23+11:00
CodeSystem.publisher[0]	HL7 (FHIR Project)
CodeSystem.contact[0].telecom[0].system[0]	url
CodeSystem.contact[0].telecom[0].value[0]	http://hl7.org/fhir
CodeSystem.contact[0].telecom[1].system[0]	email
CodeSystem.contact[0].telecom[1].value[0]	fhir@lists.hl7.org
CodeSystem.description[0]	Indicates whether the location is still in use.
CodeSystem.caseSensitive[0]	True
CodeSystem.valueSet[0]	http://hl7.org/fhir/ValueSet/location-status
CodeSystem.content[0]	complete
CodeSystem.concept[0].code[0]	active
CodeSystem.concept[0].display[0]	Active
CodeSystem.concept[0].definition[0]	The location is operational.
CodeSystem.concept[1].code[0]	suspended
CodeSystem.concept[1].display[0]	Suspended
CodeSystem.concept[1].definition[0]	The location is temporarily closed.
CodeSystem.concept[2].code[0]	inactive
CodeSystem.concept[2].display[0]	Inactive
CodeSystem.concept[2].definition[0]	The location is no longer used.

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="location-status" />
    <meta>
        <lastUpdated value="2019-11-01T09:29:23.356+11:00" />
    </meta>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="pa" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="trial-use" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="3" />
    </extension>
    <url value="http://hl7.org/fhir/location-status" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.333" />
    </identifier>
    <version value="4.0.1" />
    <name value="LocationStatus" />
    <title value="LocationStatus" />
    <status value="draft" />
    <experimental value="false" />
    <date value="2019-11-01T09:29:23+11:00" />
    <publisher value="HL7 (FHIR Project)" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://hl7.org/fhir" />
        </telecom>
        <telecom>
            <system value="email" />
            <value value="fhir@lists.hl7.org" />
        </telecom>
    </contact>
    <description value="Indicates whether the location is still in use." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/location-status" />
    <content value="complete" />
    <concept>
        <code value="active" />
        <display value="Active" />
        <definition value="The location is operational." />
    </concept>
    <concept>
        <code value="suspended" />
        <display value="Suspended" />
        <definition value="The location is temporarily closed." />
    </concept>
    <concept>
        <code value="inactive" />
        <display value="Inactive" />
        <definition value="The location is no longer used." />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "location-status",
    "meta": {
        "lastUpdated": "2019-11-01T09:29:23.356+11:00"
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "pa"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "trial-use"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 3
        }
    ],
    "url": "http://hl7.org/fhir/location-status",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.333"
        }
    ],
    "version": "4.0.1",
    "name": "LocationStatus",
    "title": "LocationStatus",
    "status": "draft",
    "experimental": false,
    "date": "2019-11-01T09:29:23+11:00",
    "publisher": "HL7 (FHIR Project)",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://hl7.org/fhir"
                },
                {
                    "system": "email",
                    "value": "fhir@lists.hl7.org"
                }
            ]
        }
    ],
    "description": "Indicates whether the location is still in use.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/location-status",
    "content": "complete",
    "concept":  [
        {
            "code": "active",
            "display": "Active",
            "definition": "The location is operational."
        },
        {
            "code": "suspended",
            "display": "Suspended",
            "definition": "The location is temporarily closed."
        },
        {
            "code": "inactive",
            "display": "Inactive",
            "definition": "The location is no longer used."
        }
    ]
}

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.

`operationalStatus`

The current operational status of the location (typically only for a bed/room).

This refers to the current operational status of a location not it's general availabity which is represented by Location.status.

The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.

This ValueSet has a preferred binding in the FHIR standard and no UK Core alternative is currently used. Implementers may chaose to use an alternative CodeSystem if required by their use case.

HTML View

This code system http://terminology.hl7.org/CodeSystem/v2-0116 defines the following codes:

Code	Display
C	Closed
H	Housekeeping
I	Isolated
K	Contaminated
O	Occupied
U	Unoccupied

Additional Language Displays

Code	Deutsch (German, de)	Nederlands (Dutch, nl)
C	Nicht verfügbar	Gesloten
H	Reinigung	Onderhoud
I	Isoliert	In isolatie
K	Kontaminiert	Besmet
O	belegt	Bezet
U	Frei	Niet-bezet

Table View

CodeSystem.id[0]	v2-0116
CodeSystem.meta[0].profile[0]	http://hl7.org/fhir/StructureDefinition/shareablecodesystem
CodeSystem.language[0]	en
CodeSystem.extension[0].url[0]	http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
CodeSystem.extension[0].valueCode[0]	external
CodeSystem.extension[1].url[0]	http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[1].valueInteger[0]	0
CodeSystem.extension[2].url[0]	http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
CodeSystem.extension[2].valueCode[0]	pa
CodeSystem.url[0]	http://terminology.hl7.org/CodeSystem/v2-0116
CodeSystem.identifier[0].system[0]	urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]	urn:oid:2.16.840.1.113883.18.47
CodeSystem.version[0]	2.9
CodeSystem.name[0]	v2.0116
CodeSystem.title[0]	v2 BED STATUS
CodeSystem.status[0]	active
CodeSystem.experimental[0]	False
CodeSystem.publisher[0]	HL7, Inc
CodeSystem.contact[0].telecom[0].system[0]	url
CodeSystem.contact[0].telecom[0].value[0]	http://hl7.org
CodeSystem.description[0]	FHIR Value set/code system definition for HL7 v2 table 0116 ( BED STATUS)
CodeSystem.content[0]	complete
CodeSystem.concept[0].code[0]	C
CodeSystem.concept[0].display[0]	Closed
CodeSystem.concept[0].designation[0].language[0]	de
CodeSystem.concept[0].designation[0].use[0].system[0]	http://terminology.hl7.org/CodeSystem/designation-usage
CodeSystem.concept[0].designation[0].use[0].code[0]	display
CodeSystem.concept[0].designation[0].value[0]	Nicht verfügbar
CodeSystem.concept[0].designation[1].language[0]	nl
CodeSystem.concept[0].designation[1].use[0].system[0]	http://terminology.hl7.org/CodeSystem/designation-usage
CodeSystem.concept[0].designation[1].use[0].code[0]	display
CodeSystem.concept[0].designation[1].value[0]	Gesloten
CodeSystem.concept[1].code[0]	H
CodeSystem.concept[1].display[0]	Housekeeping
CodeSystem.concept[1].designation[0].language[0]	de
CodeSystem.concept[1].designation[0].use[0].system[0]	http://terminology.hl7.org/CodeSystem/designation-usage
CodeSystem.concept[1].designation[0].use[0].code[0]	display
CodeSystem.concept[1].designation[0].value[0]	Reinigung
CodeSystem.concept[1].designation[1].language[0]	nl
CodeSystem.concept[1].designation[1].use[0].system[0]	http://terminology.hl7.org/CodeSystem/designation-usage
CodeSystem.concept[1].designation[1].use[0].code[0]	display
CodeSystem.concept[1].designation[1].value[0]	Onderhoud
CodeSystem.concept[2].code[0]	I
CodeSystem.concept[2].display[0]	Isolated
CodeSystem.concept[2].designation[0].language[0]	de
CodeSystem.concept[2].designation[0].use[0].system[0]	http://terminology.hl7.org/CodeSystem/designation-usage
CodeSystem.concept[2].designation[0].use[0].code[0]	display
CodeSystem.concept[2].designation[0].value[0]	Isoliert
CodeSystem.concept[2].designation[1].language[0]	nl
CodeSystem.concept[2].designation[1].use[0].system[0]	http://terminology.hl7.org/CodeSystem/designation-usage
CodeSystem.concept[2].designation[1].use[0].code[0]	display
CodeSystem.concept[2].designation[1].value[0]	In isolatie
CodeSystem.concept[3].code[0]	K
CodeSystem.concept[3].display[0]	Contaminated
CodeSystem.concept[3].designation[0].language[0]	de
CodeSystem.concept[3].designation[0].use[0].system[0]	http://terminology.hl7.org/CodeSystem/designation-usage
CodeSystem.concept[3].designation[0].use[0].code[0]	display
CodeSystem.concept[3].designation[0].value[0]	Kontaminiert
CodeSystem.concept[3].designation[1].language[0]	nl
CodeSystem.concept[3].designation[1].use[0].system[0]	http://terminology.hl7.org/CodeSystem/designation-usage
CodeSystem.concept[3].designation[1].use[0].code[0]	display
CodeSystem.concept[3].designation[1].value[0]	Besmet
CodeSystem.concept[4].code[0]	O
CodeSystem.concept[4].display[0]	Occupied
CodeSystem.concept[4].designation[0].language[0]	de
CodeSystem.concept[4].designation[0].use[0].system[0]	http://terminology.hl7.org/CodeSystem/designation-usage
CodeSystem.concept[4].designation[0].use[0].code[0]	display
CodeSystem.concept[4].designation[0].value[0]	belegt
CodeSystem.concept[4].designation[1].language[0]	nl
CodeSystem.concept[4].designation[1].use[0].system[0]	http://terminology.hl7.org/CodeSystem/designation-usage
CodeSystem.concept[4].designation[1].use[0].code[0]	display
CodeSystem.concept[4].designation[1].value[0]	Bezet
CodeSystem.concept[5].code[0]	U
CodeSystem.concept[5].display[0]	Unoccupied
CodeSystem.concept[5].designation[0].language[0]	de
CodeSystem.concept[5].designation[0].use[0].system[0]	http://terminology.hl7.org/CodeSystem/designation-usage
CodeSystem.concept[5].designation[0].use[0].code[0]	display
CodeSystem.concept[5].designation[0].value[0]	Frei
CodeSystem.concept[5].designation[1].language[0]	nl
CodeSystem.concept[5].designation[1].use[0].system[0]	http://terminology.hl7.org/CodeSystem/designation-usage
CodeSystem.concept[5].designation[1].use[0].code[0]	display
CodeSystem.concept[5].designation[1].value[0]	Niet-bezet

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="v2-0116" />
    <meta>
        <profile value="http://hl7.org/fhir/StructureDefinition/shareablecodesystem" />
    </meta>
    <language value="en" />
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="external" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="0" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="pa" />
    </extension>
    <url value="http://terminology.hl7.org/CodeSystem/v2-0116" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.18.47" />
    </identifier>
    <version value="2.9" />
    <name value="v2.0116" />
    <title value="v2 BED STATUS" />
    <status value="active" />
    <experimental value="false" />
    <publisher value="HL7, Inc" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://hl7.org" />
        </telecom>
    </contact>
    <description value="FHIR Value set/code system definition for HL7 v2 table 0116 ( BED STATUS)" />
    <content value="complete" />
    <concept>
        <code value="C" />
        <display value="Closed" />
        <designation>
            <language value="de" />
            <use>
                <system value="http://terminology.hl7.org/CodeSystem/designation-usage" />
                <code value="display" />
            </use>
            <value value="Nicht verf&#252;gbar" />
        </designation>
        <designation>
            <language value="nl" />
            <use>
                <system value="http://terminology.hl7.org/CodeSystem/designation-usage" />
                <code value="display" />
            </use>
            <value value="Gesloten" />
        </designation>
    </concept>
    <concept>
        <code value="H" />
        <display value="Housekeeping" />
        <designation>
            <language value="de" />
            <use>
                <system value="http://terminology.hl7.org/CodeSystem/designation-usage" />
                <code value="display" />
            </use>
            <value value="Reinigung" />
        </designation>
        <designation>
            <language value="nl" />
            <use>
                <system value="http://terminology.hl7.org/CodeSystem/designation-usage" />
                <code value="display" />
            </use>
            <value value="Onderhoud" />
        </designation>
    </concept>
    <concept>
        <code value="I" />
        <display value="Isolated" />
        <designation>
            <language value="de" />
            <use>
                <system value="http://terminology.hl7.org/CodeSystem/designation-usage" />
                <code value="display" />
            </use>
            <value value="Isoliert" />
        </designation>
        <designation>
            <language value="nl" />
            <use>
                <system value="http://terminology.hl7.org/CodeSystem/designation-usage" />
                <code value="display" />
            </use>
            <value value="In isolatie" />
        </designation>
    </concept>
    <concept>
        <code value="K" />
        <display value="Contaminated" />
        <designation>
            <language value="de" />
            <use>
                <system value="http://terminology.hl7.org/CodeSystem/designation-usage" />
                <code value="display" />
            </use>
            <value value="Kontaminiert" />
        </designation>
        <designation>
            <language value="nl" />
            <use>
                <system value="http://terminology.hl7.org/CodeSystem/designation-usage" />
                <code value="display" />
            </use>
            <value value="Besmet" />
        </designation>
    </concept>
    <concept>
        <code value="O" />
        <display value="Occupied" />
        <designation>
            <language value="de" />
            <use>
                <system value="http://terminology.hl7.org/CodeSystem/designation-usage" />
                <code value="display" />
            </use>
            <value value="belegt" />
        </designation>
        <designation>
            <language value="nl" />
            <use>
                <system value="http://terminology.hl7.org/CodeSystem/designation-usage" />
                <code value="display" />
            </use>
            <value value="Bezet" />
        </designation>
    </concept>
    <concept>
        <code value="U" />
        <display value="Unoccupied" />
        <designation>
            <language value="de" />
            <use>
                <system value="http://terminology.hl7.org/CodeSystem/designation-usage" />
                <code value="display" />
            </use>
            <value value="Frei" />
        </designation>
        <designation>
            <language value="nl" />
            <use>
                <system value="http://terminology.hl7.org/CodeSystem/designation-usage" />
                <code value="display" />
            </use>
            <value value="Niet-bezet" />
        </designation>
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "v2-0116",
    "meta": {
        "profile":  [
            "http://hl7.org/fhir/StructureDefinition/shareablecodesystem"
        ]
    },
    "language": "en",
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "external"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 0
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "pa"
        }
    ],
    "url": "http://terminology.hl7.org/CodeSystem/v2-0116",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.18.47"
        }
    ],
    "version": "2.9",
    "name": "v2.0116",
    "title": "v2 BED STATUS",
    "status": "active",
    "experimental": false,
    "publisher": "HL7, Inc",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://hl7.org"
                }
            ]
        }
    ],
    "description": "FHIR Value set/code system definition for HL7 v2 table 0116 ( BED STATUS)",
    "content": "complete",
    "concept":  [
        {
            "code": "C",
            "display": "Closed",
            "designation":  [
                {
                    "language": "de",
                    "use": {
                        "system": "http://terminology.hl7.org/CodeSystem/designation-usage",
                        "code": "display"
                    },
                    "value": "Nicht verfügbar"
                },
                {
                    "language": "nl",
                    "use": {
                        "system": "http://terminology.hl7.org/CodeSystem/designation-usage",
                        "code": "display"
                    },
                    "value": "Gesloten"
                }
            ]
        },
        {
            "code": "H",
            "display": "Housekeeping",
            "designation":  [
                {
                    "language": "de",
                    "use": {
                        "system": "http://terminology.hl7.org/CodeSystem/designation-usage",
                        "code": "display"
                    },
                    "value": "Reinigung"
                },
                {
                    "language": "nl",
                    "use": {
                        "system": "http://terminology.hl7.org/CodeSystem/designation-usage",
                        "code": "display"
                    },
                    "value": "Onderhoud"
                }
            ]
        },
        {
            "code": "I",
            "display": "Isolated",
            "designation":  [
                {
                    "language": "de",
                    "use": {
                        "system": "http://terminology.hl7.org/CodeSystem/designation-usage",
                        "code": "display"
                    },
                    "value": "Isoliert"
                },
                {
                    "language": "nl",
                    "use": {
                        "system": "http://terminology.hl7.org/CodeSystem/designation-usage",
                        "code": "display"
                    },
                    "value": "In isolatie"
                }
            ]
        },
        {
            "code": "K",
            "display": "Contaminated",
            "designation":  [
                {
                    "language": "de",
                    "use": {
                        "system": "http://terminology.hl7.org/CodeSystem/designation-usage",
                        "code": "display"
                    },
                    "value": "Kontaminiert"
                },
                {
                    "language": "nl",
                    "use": {
                        "system": "http://terminology.hl7.org/CodeSystem/designation-usage",
                        "code": "display"
                    },
                    "value": "Besmet"
                }
            ]
        },
        {
            "code": "O",
            "display": "Occupied",
            "designation":  [
                {
                    "language": "de",
                    "use": {
                        "system": "http://terminology.hl7.org/CodeSystem/designation-usage",
                        "code": "display"
                    },
                    "value": "belegt"
                },
                {
                    "language": "nl",
                    "use": {
                        "system": "http://terminology.hl7.org/CodeSystem/designation-usage",
                        "code": "display"
                    },
                    "value": "Bezet"
                }
            ]
        },
        {
            "code": "U",
            "display": "Unoccupied",
            "designation":  [
                {
                    "language": "de",
                    "use": {
                        "system": "http://terminology.hl7.org/CodeSystem/designation-usage",
                        "code": "display"
                    },
                    "value": "Frei"
                },
                {
                    "language": "nl",
                    "use": {
                        "system": "http://terminology.hl7.org/CodeSystem/designation-usage",
                        "code": "display"
                    },
                    "value": "Niet-bezet"
                }
            ]
        }
    ]
}

`description`

Additional details about the location that could be displayed as further information to identify the location beyond its name.

`mode`

The Location.mode element can be used to indicate whether a Location resource represents a specific (potentially identifiable) Location (instance), or a class of Locations (kind). Especially Resources capturing orders, resource scheduling, plans and definitions may refer to Locations in kind mode. For these domains, it is often not necessary to refer to a specific Location, but rather to a class of Locations. An example of this is found in planning, where we need to allocate an "isolation room" for a patient, or need to dispatch "an ambulance" at a certain time. In these cases it is not important exactly which isolation room or ambulance is allocated, and it is sufficient to just indicate a kind of Location.

Note that kind should not be used to represent Locations where an actual instance of a Location was involved, but identifying information is missing. E.g. when a patient arrived 'by ambulance', but it is not known by which ambulance, this should be represented using a Location in instance mode with a missing identifier, not a Location of kind ambulance.

Some of Location's data elements are only relevant when mode is instance and should not be used when mode is kind: (however this information could still be included if was relevant, such as when it is a generic item, but not globally generic, e.g. a Burgers MU ambulance).

`type`

The type of function peformed at the location.

`telecom`

A contact detail (e.g. a telephone number or an email address) by which the location may be contacted.

telecom uses the ContactPoint datatype.

`address`

The address of the location using the Address datatype.

`physicalType`

The physical type of the location. e.g. Bed, ward, building from this set of codes.

This element has an example binding to a HL7 ValueSet. No UKCore ValueSet is currently defined and therefore implementers are free to use either HL7 ValueSet or an alternative if they wish to do so. If deemed a requirement future releases will address this by defining an appropriate UK Core ValueSet.

HTML View

This code system http://terminology.hl7.org/CodeSystem/location-physical-type defines the following codes:

Code	Display	Definition
si	Site	A collection of buildings or other locations such as a site or a campus.
bu	Building	Any Building or structure. This may contain rooms, corridors, wings, etc. It might not have walls, or a roof, but is considered a defined/allocated space.
wi	Wing	A Wing within a Building, this often contains levels, rooms and corridors.
wa	Ward	A Ward is a section of a medical facility that may contain rooms and other types of location.
lvl	Level	A Level in a multi-level Building/Structure.
co	Corridor	Any corridor within a Building, that may connect rooms.
ro	Room	A space that is allocated as a room, it may have walls/roof etc., but does not require these.
bd	Bed	A space that is allocated for sleeping/laying on. This is not the physical bed/trolley that may be moved about, but the space it may occupy.
ve	Vehicle	A means of transportation.
ho	House	A residential dwelling. Usually used to reference a location that a person/patient may reside.
ca	Cabinet	A container that can store goods, equipment, medications or other items.
rd	Road	A defined path to travel between 2 points that has a known name.
area	Area	A defined physical boundary of something, such as a flood risk zone, region, postcode
jdn	Jurisdiction	A wide scope that covers a conceptual domain, such as a Nation (Country wide community or Federal Government - e.g. Ministry of Health), Province or State (community or Government), Business (throughout the enterprise), Nation with a business scope of an agency (e.g. CDC, FDA etc.) or a Business segment (UK Pharmacy), not just an physical boundary

Table View

CodeSystem.id[0]	location-physical-type
CodeSystem.meta[0].lastUpdated[0]	2019-11-01T09:29:23.356+11:00
CodeSystem.meta[0].profile[0]	http://hl7.org/fhir/StructureDefinition/shareablecodesystem
CodeSystem.extension[0].url[0]	http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
CodeSystem.extension[0].valueCode[0]	pa
CodeSystem.extension[1].url[0]	http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
CodeSystem.extension[1].valueCode[0]	draft
CodeSystem.extension[2].url[0]	http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[2].valueInteger[0]	1
CodeSystem.url[0]	http://terminology.hl7.org/CodeSystem/location-physical-type
CodeSystem.identifier[0].system[0]	urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]	urn:oid:2.16.840.1.113883.4.642.4.1108
CodeSystem.version[0]	4.0.1
CodeSystem.name[0]	LocationType
CodeSystem.title[0]	Location type
CodeSystem.status[0]	draft
CodeSystem.experimental[0]	False
CodeSystem.publisher[0]	FHIR Project team
CodeSystem.contact[0].telecom[0].system[0]	url
CodeSystem.contact[0].telecom[0].value[0]	http://hl7.org/fhir
CodeSystem.description[0]	This example value set defines a set of codes that can be used to indicate the physical form of the Location.
CodeSystem.caseSensitive[0]	True
CodeSystem.valueSet[0]	http://hl7.org/fhir/ValueSet/location-physical-type
CodeSystem.content[0]	complete
CodeSystem.concept[0].code[0]	si
CodeSystem.concept[0].display[0]	Site
CodeSystem.concept[0].definition[0]	A collection of buildings or other locations such as a site or a campus.
CodeSystem.concept[1].code[0]	bu
CodeSystem.concept[1].display[0]	Building
CodeSystem.concept[1].definition[0]	Any Building or structure. This may contain rooms, corridors, wings, etc. It might not have walls, or a roof, but is considered a defined/allocated space.
CodeSystem.concept[2].code[0]	wi
CodeSystem.concept[2].display[0]	Wing
CodeSystem.concept[2].definition[0]	A Wing within a Building, this often contains levels, rooms and corridors.
CodeSystem.concept[3].code[0]	wa
CodeSystem.concept[3].display[0]	Ward
CodeSystem.concept[3].definition[0]	A Ward is a section of a medical facility that may contain rooms and other types of location.
CodeSystem.concept[4].code[0]	lvl
CodeSystem.concept[4].display[0]	Level
CodeSystem.concept[4].definition[0]	A Level in a multi-level Building/Structure.
CodeSystem.concept[5].code[0]	co
CodeSystem.concept[5].display[0]	Corridor
CodeSystem.concept[5].definition[0]	Any corridor within a Building, that may connect rooms.
CodeSystem.concept[6].code[0]	ro
CodeSystem.concept[6].display[0]	Room
CodeSystem.concept[6].definition[0]	A space that is allocated as a room, it may have walls/roof etc., but does not require these.
CodeSystem.concept[7].code[0]	bd
CodeSystem.concept[7].display[0]	Bed
CodeSystem.concept[7].definition[0]	A space that is allocated for sleeping/laying on. This is not the physical bed/trolley that may be moved about, but the space it may occupy.
CodeSystem.concept[8].code[0]	ve
CodeSystem.concept[8].display[0]	Vehicle
CodeSystem.concept[8].definition[0]	A means of transportation.
CodeSystem.concept[9].code[0]	ho
CodeSystem.concept[9].display[0]	House
CodeSystem.concept[9].definition[0]	A residential dwelling. Usually used to reference a location that a person/patient may reside.
CodeSystem.concept[10].code[0]	ca
CodeSystem.concept[10].display[0]	Cabinet
CodeSystem.concept[10].definition[0]	A container that can store goods, equipment, medications or other items.
CodeSystem.concept[11].code[0]	rd
CodeSystem.concept[11].display[0]	Road
CodeSystem.concept[11].definition[0]	A defined path to travel between 2 points that has a known name.
CodeSystem.concept[12].code[0]	area
CodeSystem.concept[12].display[0]	Area
CodeSystem.concept[12].definition[0]	A defined physical boundary of something, such as a flood risk zone, region, postcode
CodeSystem.concept[13].code[0]	jdn
CodeSystem.concept[13].display[0]	Jurisdiction
CodeSystem.concept[13].definition[0]	A wide scope that covers a conceptual domain, such as a Nation (Country wide community or Federal Government - e.g. Ministry of Health), Province or State (community or Government), Business (throughout the enterprise), Nation with a business scope of an agency (e.g. CDC, FDA etc.) or a Business segment (UK Pharmacy), not just an physical boundary

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="location-physical-type" />
    <meta>
        <lastUpdated value="2019-11-01T09:29:23.356+11:00" />
        <profile value="http://hl7.org/fhir/StructureDefinition/shareablecodesystem" />
    </meta>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="pa" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="draft" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="1" />
    </extension>
    <url value="http://terminology.hl7.org/CodeSystem/location-physical-type" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.1108" />
    </identifier>
    <version value="4.0.1" />
    <name value="LocationType" />
    <title value="Location type" />
    <status value="draft" />
    <experimental value="false" />
    <publisher value="FHIR Project team" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://hl7.org/fhir" />
        </telecom>
    </contact>
    <description value="This example value set defines a set of codes that can be used to indicate the physical form of the Location." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/location-physical-type" />
    <content value="complete" />
    <concept>
        <code value="si" />
        <display value="Site" />
        <definition value="A collection of buildings or other locations such as a site or a campus." />
    </concept>
    <concept>
        <code value="bu" />
        <display value="Building" />
        <definition value="Any Building or structure. This may contain rooms, corridors, wings, etc. It might not have walls, or a roof, but is considered a defined/allocated space." />
    </concept>
    <concept>
        <code value="wi" />
        <display value="Wing" />
        <definition value="A Wing within a Building, this often contains levels, rooms and corridors." />
    </concept>
    <concept>
        <code value="wa" />
        <display value="Ward" />
        <definition value="A Ward is a section of a medical facility that may contain rooms and other types of location." />
    </concept>
    <concept>
        <code value="lvl" />
        <display value="Level" />
        <definition value="A Level in a multi-level Building/Structure." />
    </concept>
    <concept>
        <code value="co" />
        <display value="Corridor" />
        <definition value="Any corridor within a Building, that may connect rooms." />
    </concept>
    <concept>
        <code value="ro" />
        <display value="Room" />
        <definition value="A space that is allocated as a room, it may have walls/roof etc., but does not require these." />
    </concept>
    <concept>
        <code value="bd" />
        <display value="Bed" />
        <definition value="A space that is allocated for sleeping/laying on. This is not the physical bed/trolley that may be moved about, but the space it may occupy." />
    </concept>
    <concept>
        <code value="ve" />
        <display value="Vehicle" />
        <definition value="A means of transportation." />
    </concept>
    <concept>
        <code value="ho" />
        <display value="House" />
        <definition value="A residential dwelling. Usually used to reference a location that a person/patient may reside." />
    </concept>
    <concept>
        <code value="ca" />
        <display value="Cabinet" />
        <definition value="A container that can store goods, equipment, medications or other items." />
    </concept>
    <concept>
        <code value="rd" />
        <display value="Road" />
        <definition value="A defined path to travel between 2 points that has a known name." />
    </concept>
    <concept>
        <code value="area" />
        <display value="Area" />
        <definition value="A defined physical boundary of something, such as a flood risk zone, region, postcode" />
    </concept>
    <concept>
        <code value="jdn" />
        <display value="Jurisdiction" />
        <definition value="A wide scope that covers a conceptual domain, such as a Nation (Country wide community or Federal Government - e.g. Ministry of Health),  Province or State (community or Government), Business (throughout the enterprise), Nation with a business scope of an agency (e.g. CDC, FDA etc.) or a Business segment (UK Pharmacy), not just an physical boundary" />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "location-physical-type",
    "meta": {
        "lastUpdated": "2019-11-01T09:29:23.356+11:00",
        "profile":  [
            "http://hl7.org/fhir/StructureDefinition/shareablecodesystem"
        ]
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "pa"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "draft"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 1
        }
    ],
    "url": "http://terminology.hl7.org/CodeSystem/location-physical-type",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.1108"
        }
    ],
    "version": "4.0.1",
    "name": "LocationType",
    "title": "Location type",
    "status": "draft",
    "experimental": false,
    "publisher": "FHIR Project team",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://hl7.org/fhir"
                }
            ]
        }
    ],
    "description": "This example value set defines a set of codes that can be used to indicate the physical form of the Location.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/location-physical-type",
    "content": "complete",
    "concept":  [
        {
            "code": "si",
            "display": "Site",
            "definition": "A collection of buildings or other locations such as a site or a campus."
        },
        {
            "code": "bu",
            "display": "Building",
            "definition": "Any Building or structure. This may contain rooms, corridors, wings, etc. It might not have walls, or a roof, but is considered a defined/allocated space."
        },
        {
            "code": "wi",
            "display": "Wing",
            "definition": "A Wing within a Building, this often contains levels, rooms and corridors."
        },
        {
            "code": "wa",
            "display": "Ward",
            "definition": "A Ward is a section of a medical facility that may contain rooms and other types of location."
        },
        {
            "code": "lvl",
            "display": "Level",
            "definition": "A Level in a multi-level Building/Structure."
        },
        {
            "code": "co",
            "display": "Corridor",
            "definition": "Any corridor within a Building, that may connect rooms."
        },
        {
            "code": "ro",
            "display": "Room",
            "definition": "A space that is allocated as a room, it may have walls/roof etc., but does not require these."
        },
        {
            "code": "bd",
            "display": "Bed",
            "definition": "A space that is allocated for sleeping/laying on. This is not the physical bed/trolley that may be moved about, but the space it may occupy."
        },
        {
            "code": "ve",
            "display": "Vehicle",
            "definition": "A means of transportation."
        },
        {
            "code": "ho",
            "display": "House",
            "definition": "A residential dwelling. Usually used to reference a location that a person/patient may reside."
        },
        {
            "code": "ca",
            "display": "Cabinet",
            "definition": "A container that can store goods, equipment, medications or other items."
        },
        {
            "code": "rd",
            "display": "Road",
            "definition": "A defined path to travel between 2 points that has a known name."
        },
        {
            "code": "area",
            "display": "Area",
            "definition": "A defined physical boundary of something, such as a flood risk zone, region, postcode"
        },
        {
            "code": "jdn",
            "display": "Jurisdiction",
            "definition": "A wide scope that covers a conceptual domain, such as a Nation (Country wide community or Federal Government - e.g. Ministry of Health),  Province or State (community or Government), Business (throughout the enterprise), Nation with a business scope of an agency (e.g. CDC, FDA etc.) or a Business segment (UK Pharmacy), not just an physical boundary"
        }
    ]
}

`position`

The absolute geographic location of the Location, expressed using the WGS84 datum

e.g.

Location.position.longitude -1.530941
Location.position.latitude 53.798135
Location.position.altitude 55 (metres above mean sea level - optional).

`managingOrganization`

The organization responsible for the provisioning and upkeep of the location as a reference to Profile UKCore-Organization.

`partOf`

Another Location of which this Location is physically a part of, as a reference to UKCore-Location.

`hoursOfOperation`

What days/times during a week is this location usually open.

Opening times can be specified as the opening and closing times for each day of the week. Where a location is open 24 hours opening and closing times should not be specified and Location.hoursOfOperation.allDay should be set to true.

`availabilityExceptions`

A description, as a text string, of when the locations opening hours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in hoursOfOperation.

e.g. "closed bank holidays".

`endpoint`

Technical endpoints providing access to services operated for the organization.

Can be used to define multiple technical endpoints.