Location

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

Usage

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.

URL

Type URL
Canonical https://fhir.kemkes.go.id/r4/StructureDefinition/Location

Structure

Snapshot

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
serviceClassI0..1Extension(CodeableConcept)
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
statusΣ ?!0..1codeBinding
operationalStatusΣ0..1CodingBinding
nameΣ0..1string
alias0..*string
descriptionΣ0..1string
modeΣ0..1codeBinding
typeΣ0..*CodeableConceptBinding
telecomI0..*ContactPoint
address0..1Address
physicalTypeΣ0..1CodeableConcept
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
longitude1..1decimal
latitude1..1decimal
altitude0..1decimal
managingOrganizationΣ I0..1Reference(Organization)
partOfI0..1Reference(Location)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
daysOfWeek0..*codeBinding
allDay0..1boolean
openingTime0..1time
closingTime0..1time
availabilityExceptions0..1string
endpointI0..*Reference(https://fhir.kemkes.go.id/r4/StructureDefinition/Endpoint)

Examples

{
    "resourceType": "StructureDefinition",
    "id": "Location",
    "meta": {
        "versionId": "4",
        "lastUpdated": "2023-05-30T10:10:45.9858707+00:00"
    },
    "extension":  [
        {
            "url": "https://fhir.kemkes.go.id/r4/StructureDefinition/structuredefinition-category",
            "valueString": "Base.Entities"
        },
        {
            "url": "https://fhir.kemkes.go.id/r4/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "trial-use"
        },
        {
            "url": "https://fhir.kemkes.go.id/r4/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 3
        },
        {
            "url": "https://fhir.kemkes.go.id/r4/StructureDefinition/structuredefinition-security-category",
            "valueCode": "business"
        },
        {
            "url": "https://fhir.kemkes.go.id/r4/StructureDefinition/structuredefinition-wg",
            "valueCode": "pa"
        }
    ],
    "url": "https://fhir.kemkes.go.id/r4/StructureDefinition/Location",
    "version": "4.0.1",
    "name": "Location",
    "status": "active",
    "date": "2023-05-30T10:14:25.520085+00:00",
    "publisher": "Health Level Seven International (Patient Administration)",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://hl7.org/fhir"
                }
            ]
        },
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://www.hl7.org/Special/committees/pafm/index.cfm"
                }
            ]
        }
    ],
    "description": "Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.",
    "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": "https://fhir.kemkes.go.id/r4/StructureDefinition/DomainResource",
    "derivation": "specialization",
    "differential": {
        "element":  [
            {
                "id": "Location",
                "path": "Location",
                "short": "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.",
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": ".Role[classCode=SDLC]"
                    }
                ]
            },
            {
                "id": "Location.extension",
                "path": "Location.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "Location.extension:serviceClass",
                "path": "Location.extension",
                "sliceName": "serviceClass",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.kemkes.go.id/r4/StructureDefinition/LocationServiceClass"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "Location.identifier",
                "path": "Location.identifier",
                "short": "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.",
                "type":  [
                    {
                        "code": "Identifier"
                    }
                ],
                "isSummary": true,
                "mapping":  [
                    {
                        "identity": "w5",
                        "map": "FiveWs.identifier"
                    },
                    {
                        "identity": "rim",
                        "map": ".id"
                    }
                ]
            },
            {
                "id": "Location.status",
                "path": "Location.status",
                "short": "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.",
                "max": "1",
                "type":  [
                    {
                        "code": "code"
                    }
                ],
                "isModifier": true,
                "isModifierReason": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid",
                "isSummary": true,
                "binding": {
                    "extension":  [
                        {
                            "url": "https://fhir.kemkes.go.id/r4/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "LocationStatus"
                        }
                    ],
                    "strength": "required",
                    "description": "Indicates whether the location is still in use.",
                    "valueSet": "http://hl7.org/fhir/ValueSet/location-status|4.0.1"
                },
                "mapping":  [
                    {
                        "identity": "w5",
                        "map": "FiveWs.status"
                    },
                    {
                        "identity": "rim",
                        "map": ".statusCode"
                    }
                ]
            },
            {
                "id": "Location.operationalStatus",
                "path": "Location.operationalStatus",
                "short": "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.",
                "max": "1",
                "type":  [
                    {
                        "code": "Coding"
                    }
                ],
                "isSummary": true,
                "binding": {
                    "extension":  [
                        {
                            "url": "https://fhir.kemkes.go.id/r4/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "OperationalStatus"
                        }
                    ],
                    "strength": "preferred",
                    "description": "The operational status if the location (where typically a bed/room).",
                    "valueSet": "http://terminology.hl7.org/ValueSet/v2-0116"
                },
                "mapping":  [
                    {
                        "identity": "w5",
                        "map": "FiveWs.status"
                    }
                ]
            },
            {
                "id": "Location.name",
                "path": "Location.name",
                "short": "Name of the location as used by humans",
                "definition": "Name of the location as used by humans. Does not need to be unique.",
                "comment": "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.",
                "max": "1",
                "type":  [
                    {
                        "code": "string"
                    }
                ],
                "isSummary": true,
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": ".name"
                    }
                ]
            },
            {
                "id": "Location.alias",
                "path": "Location.alias",
                "short": "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.",
                "comment": "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.",
                "requirements": "Over time locations and organizations go through many changes and can be known by different names.\n\nFor searching knowing previous names that the location was known by can be very useful.",
                "type":  [
                    {
                        "code": "string"
                    }
                ],
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": ".name"
                    }
                ]
            },
            {
                "id": "Location.description",
                "path": "Location.description",
                "short": "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.",
                "max": "1",
                "type":  [
                    {
                        "code": "string"
                    }
                ],
                "isSummary": true,
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": ".playingEntity[classCode=PLC determinerCode=INSTANCE].desc"
                    }
                ]
            },
            {
                "id": "Location.mode",
                "path": "Location.mode",
                "short": "instance | kind",
                "definition": "Indicates whether a resource instance represents a specific location or a class of locations.",
                "comment": "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.",
                "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.",
                "max": "1",
                "type":  [
                    {
                        "code": "code"
                    }
                ],
                "isSummary": true,
                "binding": {
                    "extension":  [
                        {
                            "url": "https://fhir.kemkes.go.id/r4/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "LocationMode"
                        }
                    ],
                    "strength": "required",
                    "description": "Indicates whether a resource instance represents a specific location or a class of locations.",
                    "valueSet": "http://hl7.org/fhir/ValueSet/location-mode|4.0.1"
                },
                "mapping":  [
                    {
                        "identity": "w5",
                        "map": "FiveWs.class"
                    },
                    {
                        "identity": "rim",
                        "map": ".playingEntity[classCode=PLC].determinerCode"
                    }
                ]
            },
            {
                "id": "Location.type",
                "path": "Location.type",
                "short": "Type of function performed",
                "definition": "Indicates the type of function performed at the location.",
                "type":  [
                    {
                        "code": "CodeableConcept"
                    }
                ],
                "isSummary": true,
                "binding": {
                    "extension":  [
                        {
                            "url": "https://fhir.kemkes.go.id/r4/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "LocationType"
                        }
                    ],
                    "strength": "extensible",
                    "description": "Indicates the type of function performed at the location.",
                    "valueSet": "http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType"
                },
                "mapping":  [
                    {
                        "identity": "w5",
                        "map": "FiveWs.class"
                    },
                    {
                        "identity": "rim",
                        "map": ".code"
                    }
                ]
            },
            {
                "id": "Location.telecom",
                "path": "Location.telecom",
                "short": "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.",
                "type":  [
                    {
                        "code": "ContactPoint"
                    }
                ],
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": ".telecom"
                    }
                ]
            },
            {
                "id": "Location.address",
                "path": "Location.address",
                "short": "Physical location",
                "definition": "Physical location.",
                "comment": "Additional addresses should be recorded using another instance of the Location resource, or via the Organization.",
                "requirements": "If locations can be visited, we need to keep track of their address.",
                "max": "1",
                "type":  [
                    {
                        "code": "Address",
                        "profile":  [
                            "https://fhir.kemkes.go.id/r4/StructureDefinition/Address"
                        ]
                    }
                ],
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": ".addr"
                    }
                ]
            },
            {
                "id": "Location.physicalType",
                "path": "Location.physicalType",
                "short": "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.",
                "max": "1",
                "type":  [
                    {
                        "code": "CodeableConcept"
                    }
                ],
                "isSummary": true,
                "binding": {
                    "extension":  [
                        {
                            "url": "https://fhir.kemkes.go.id/r4/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "PhysicalType"
                        }
                    ],
                    "strength": "example",
                    "description": "Physical form of the location.",
                    "valueSet": "http://hl7.org/fhir/ValueSet/location-physical-type"
                },
                "mapping":  [
                    {
                        "identity": "w5",
                        "map": "FiveWs.class"
                    },
                    {
                        "identity": "rim",
                        "map": ".playingEntity [classCode=PLC].code"
                    }
                ]
            },
            {
                "id": "Location.position",
                "path": "Location.position",
                "short": "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.",
                "max": "1",
                "type":  [
                    {
                        "code": "BackboneElement"
                    }
                ],
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": ".playingEntity [classCode=PLC determinerCode=INSTANCE].positionText"
                    }
                ]
            },
            {
                "id": "Location.position.longitude",
                "path": "Location.position.longitude",
                "short": "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).",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "decimal"
                    }
                ],
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "(RIM Opted not to map the sub-elements of GPS location, is now an OBS)"
                    }
                ]
            },
            {
                "id": "Location.position.latitude",
                "path": "Location.position.latitude",
                "short": "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).",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "decimal"
                    }
                ],
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "(RIM Opted not to map the sub-elements of GPS location, is now an OBS)"
                    }
                ]
            },
            {
                "id": "Location.position.altitude",
                "path": "Location.position.altitude",
                "short": "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).",
                "max": "1",
                "type":  [
                    {
                        "code": "decimal"
                    }
                ],
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": "(RIM Opted not to map the sub-elements of GPS location, is now an OBS)"
                    }
                ]
            },
            {
                "id": "Location.managingOrganization",
                "path": "Location.managingOrganization",
                "short": "Organization responsible for provisioning and upkeep",
                "definition": "The organization responsible for the provisioning and upkeep of the location.",
                "comment": "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.",
                "requirements": "Need to know who manages the location.",
                "max": "1",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.kemkes.go.id/r4/StructureDefinition/Organization"
                        ]
                    }
                ],
                "isSummary": true,
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": ".scopingEntity[classCode=ORG determinerKind=INSTANCE]"
                    }
                ]
            },
            {
                "id": "Location.partOf",
                "path": "Location.partOf",
                "short": "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.",
                "max": "1",
                "type":  [
                    {
                        "extension":  [
                            {
                                "url": "https://fhir.kemkes.go.id/r4/StructureDefinition/structuredefinition-hierarchy",
                                "valueBoolean": true
                            }
                        ],
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.kemkes.go.id/r4/StructureDefinition/Location"
                        ]
                    }
                ],
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": ".inboundLink[typeCode=PART].source[classCode=SDLC]"
                    }
                ]
            },
            {
                "id": "Location.hoursOfOperation",
                "path": "Location.hoursOfOperation",
                "short": "What days/times during a week is this location usually open",
                "definition": "What days/times during a week is this location usually open.",
                "comment": "This type of information is commonly found published in directories and on websites informing customers when the facility is available.\n\nSpecific services within the location may have their own hours which could be shorter (or longer) than the locations hours.",
                "type":  [
                    {
                        "code": "BackboneElement"
                    }
                ],
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": ".effectiveTime"
                    }
                ]
            },
            {
                "id": "Location.hoursOfOperation.daysOfWeek",
                "path": "Location.hoursOfOperation.daysOfWeek",
                "short": "mon | tue | wed | thu | fri | sat | sun",
                "definition": "Indicates which days of the week are available between the start and end Times.",
                "type":  [
                    {
                        "code": "code"
                    }
                ],
                "binding": {
                    "extension":  [
                        {
                            "url": "https://fhir.kemkes.go.id/r4/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "DaysOfWeek"
                        }
                    ],
                    "strength": "required",
                    "description": "The days of the week.",
                    "valueSet": "http://hl7.org/fhir/ValueSet/days-of-week|4.0.1"
                },
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": ".effectiveTime"
                    }
                ]
            },
            {
                "id": "Location.hoursOfOperation.allDay",
                "path": "Location.hoursOfOperation.allDay",
                "short": "The Location is open all day",
                "definition": "The Location is open all day.",
                "max": "1",
                "type":  [
                    {
                        "code": "boolean"
                    }
                ],
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": ".effectiveTime"
                    }
                ]
            },
            {
                "id": "Location.hoursOfOperation.openingTime",
                "path": "Location.hoursOfOperation.openingTime",
                "short": "Time that the Location opens",
                "definition": "Time that the Location opens.",
                "max": "1",
                "type":  [
                    {
                        "code": "time"
                    }
                ],
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": ".effectiveTime"
                    }
                ]
            },
            {
                "id": "Location.hoursOfOperation.closingTime",
                "path": "Location.hoursOfOperation.closingTime",
                "short": "Time that the Location closes",
                "definition": "Time that the Location closes.",
                "max": "1",
                "type":  [
                    {
                        "code": "time"
                    }
                ],
                "mapping":  [
                    {
                        "identity": "rim",
                        "map": ".effectiveTime"
                    }
                ]
            },
            {
                "id": "Location.availabilityExceptions",
                "path": "Location.availabilityExceptions",
                "short": "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.",
                "max": "1",
                "type":  [
                    {
                        "code": "string"
                    }
                ]
            },
            {
                "id": "Location.endpoint",
                "path": "Location.endpoint",
                "short": "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.",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.kemkes.go.id/r4/StructureDefinition/Endpoint"
                        ]
                    }
                ]
            }
        ]
    }
}

Dictionary

Location
DefinitionDetails and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
Cardinality0...*
Invariants
  • 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]
Location.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typestring
SummaryTrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Location.meta
DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality0...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Location.implicitRules
DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Location.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

A human language.

CommonLanguages (preferred)
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Location.text
DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality0...1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
Location.contained
DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality0...*
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
Location.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Location.extension:serviceClass
DefinitionOptional Extension Element - found in all resources.
Cardinality0...1
TypeExtension(CodeableConcept)
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Location.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, user content
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Location.identifier
DefinitionUnique code or number identifying the location to its users.
Cardinality0...*
TypeIdentifier
SummaryTrue
Requirements

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

Invariants
  • 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
Location.status
DefinitionThe 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.
Cardinality0...1
Typecode
Binding

Indicates whether the location is still in use.

LocationStatus (required)
ModifierTrue
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • 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
Location.operationalStatus
DefinitionThe 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.
Cardinality0...1
TypeCoding
Binding

The operational status if the location (where typically a bed/room).

v2.0116 (preferred)
SummaryTrue
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.

Invariants
  • 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
Location.name
DefinitionName of the location as used by humans. Does not need to be unique.
Cardinality0...1
Typestring
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .name
Location.alias
DefinitionA list of alternate names that the location is known as, or was known as, in the past.
Cardinality0...*
Typestring
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .name
Location.description
DefinitionDescription of the Location, which helps in finding or referencing the place.
Cardinality0...1
Typestring
SummaryTrue
Requirements

Humans need additional information to verify a correct location has been identified.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • 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
Location.mode
DefinitionIndicates whether a resource instance represents a specific location or a class of locations.
Cardinality0...1
Typecode
Binding

Indicates whether a resource instance represents a specific location or a class of locations.

LocationMode (required)
SummaryTrue
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.

Invariants
  • 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
Location.type
DefinitionIndicates the type of function performed at the location.
Cardinality0...*
TypeCodeableConcept
Binding

Indicates the type of function performed at the location.

v3.ServiceDeliveryLocationRoleType (extensible)
SummaryTrue
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.

Invariants
  • 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
Location.telecom
DefinitionThe contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
Cardinality0...*
TypeContactPoint
Invariants
  • 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
Location.address
DefinitionPhysical location.
Cardinality0...1
TypeAddress
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.

Invariants
  • 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
Location.physicalType
DefinitionPhysical form of the location, e.g. building, room, vehicle, road.
Cardinality0...1
TypeCodeableConcept
Binding

Physical form of the location.

LocationType (example)
SummaryTrue
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.

Invariants
  • 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
Location.position
DefinitionThe absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
Cardinality0...1
TypeBackboneElement
Requirements

For mobile applications and automated route-finding knowing the exact location of the Location is required.

Invariants
  • 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
Location.position.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Location.position.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Location.position.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Location.position.longitude
DefinitionLongitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).
Cardinality1...1
Typedecimal
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)

Invariants
  • 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)
Location.position.latitude
DefinitionLatitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).
Cardinality1...1
Typedecimal
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)

Invariants
  • 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)
Location.position.altitude
DefinitionAltitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).
Cardinality0...1
Typedecimal
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)

Invariants
  • 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)
Location.managingOrganization
DefinitionThe organization responsible for the provisioning and upkeep of the location.
Cardinality0...1
TypeReference(Organization)
SummaryTrue
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.

Invariants
  • 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]
Location.partOf
DefinitionAnother Location of which this Location is physically a part of.
Cardinality0...1
TypeReference(Location)
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.

Invariants
  • 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]
Location.hoursOfOperation
DefinitionWhat days/times during a week is this location usually open.
Cardinality0...*
TypeBackboneElement
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .effectiveTime
Location.hoursOfOperation.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Location.hoursOfOperation.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Location.hoursOfOperation.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Location.hoursOfOperation.daysOfWeek
DefinitionIndicates which days of the week are available between the start and end Times.
Cardinality0...*
Typecode
Binding

The days of the week.

DaysOfWeek (required)
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .effectiveTime
Location.hoursOfOperation.allDay
DefinitionThe Location is open all day.
Cardinality0...1
Typeboolean
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .effectiveTime
Location.hoursOfOperation.openingTime
DefinitionTime that the Location opens.
Cardinality0...1
Typetime
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .effectiveTime
Location.hoursOfOperation.closingTime
DefinitionTime that the Location closes.
Cardinality0...1
Typetime
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .effectiveTime
Location.availabilityExceptions
DefinitionA 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.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Location.endpoint
DefinitionTechnical endpoints providing access to services operated for the location.
Cardinality0...*
TypeReference(https://fhir.kemkes.go.id/r4/StructureDefinition/Endpoint)
Requirements

Organizations may have different systems at different locations that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.

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.

Invariants
  • 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)