. Page versions: R5 R4B R4 R3 R2This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Profile for location
{
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.\" class=\"dict\" href=\"location-definitions.html#Location\"><b>Location</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Unique code or number identifying the location to its users.\" class=\"dict\" href=\"location-definitions.html#Location.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">\r\n Unique code or number identifying the location to its users</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Name of the location as used by humans. Does not need to be unique.\" class=\"dict\" href=\"location-definitions.html#Location.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name of the location as used by humans</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Description of the Location, which helps in finding or referencing the place.\" class=\"dict\" href=\"location-definitions.html#Location.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Description of the Location, which helps in finding or referencing the place</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates the type of function performed at the location.\" class=\"dict\" href=\"location-definitions.html#Location.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/ServiceDeliveryLocationRoleType/index.html\">Indicates the type of function performed at the location</a><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.\" class=\"dict\" href=\"location-definitions.html#Location.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">Contact details of the location</span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"Physical location.\" class=\"dict\" href=\"location-definitions.html#Location.address\"><b>address</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Address\">Address</a></span> <span style=\"color: navy\">Physical location</span><span style=\"color: Gray\"> --></span></address>\r\n <<a title=\"Physical form of the location, e.g. building, room, vehicle, road.\" class=\"dict\" href=\"location-definitions.html#Location.physicalType\"><b>physicalType</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-location-physical-type.html\">Physical form of the location</a></span><span style=\"color: Gray\"> --></span></physicalType>\r\n <<a title=\"The absolute geographic location of the Location, expressed in a KML compatible manner (see notes below for KML).\" class=\"dict\" href=\"location-definitions.html#Location.position\"><b>position</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> The absolute geographic location --></span>\r\n <<a title=\"Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).\" class=\"dict\" href=\"location-definitions.html#Location.position.longitude\"><b>longitude</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#decimal\">decimal</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Longitude as expressed in KML</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).\" class=\"dict\" href=\"location-definitions.html#Location.position.latitude\"><b>latitude</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#decimal\">decimal</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Latitude as expressed in KML</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).\" class=\"dict\" href=\"location-definitions.html#Location.position.altitude\"><b>altitude</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#decimal\">decimal</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Altitude as expressed in KML</span><span style=\"color: Gray\"> --></span>\r\n </position>\r\n <<a title=\"The organization that is responsible for the provisioning and upkeep of the location.\" class=\"dict\" href=\"location-definitions.html#Location.managingOrganization\"><b>managingOrganization</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">\r\n The organization that is responsible for the provisioning and upkeep of the location</span><span style=\"color: Gray\"> --></span></managingOrganization>\r\n <<a title=\"active | suspended | inactive (this element modifies the meaning of other elements)\" class=\"dict\" href=\"location-definitions.html#Location.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"location-status.html\">active | suspended | inactive</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Another Location which this Location is physically part of.\" class=\"dict\" href=\"location-definitions.html#Location.partOf\"><b>partOf</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">\r\n Another Location which this Location is physically part of</span><span style=\"color: Gray\"> --></span></partOf>\r\n <<a title=\"Indicates whether a resource instance represents a specific location or a class of locations (this element modifies the meaning of other elements)\" class=\"dict\" href=\"location-definitions.html#Location.mode\"><span style=\"text-decoration: underline\"><b>mode</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"location-mode.html\">instance | kind</a></span><span style=\"color: Gray\"> --></span>\r\n</Location>\r\n</pre></div>"
},
"name": "location",
"publisher": "FHIR Project",
"description": "Basic Profile. Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage A Location includes both incidental locations (a place which is used for healthcare without prior designation or authorization) 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. \r\n\r\nExamples of Locations are:\r\n\r\n* Building, ward, corridor or room\r\n* Freezer, incubator\r\n* Vehicle or lift\r\n* Home, shed, or a garage\r\n* Road, parking place, a park",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"structure": [
{
"type": "Location",
"publish": true,
"element": [
{
"path": "Location",
"definition": {
"short": "Details and position information for a physical place",
"formal": "Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Role[classCode=SDLC]."
}
]
}
},
{
"path": "Location.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Location.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Location.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Location.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"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.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Location.identifier",
"definition": {
"short": "Unique code or number identifying the location to its users",
"formal": "Unique code or number identifying the location to its users.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "id"
}
]
}
},
{
"path": "Location.name",
"definition": {
"short": "Name of the location as used by humans",
"formal": "Name of the location as used by humans. Does not need to be unique.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "name"
}
]
}
},
{
"path": "Location.description",
"definition": {
"short": "Description of the Location, which helps in finding or referencing the place",
"formal": "Description of the Location, which helps in finding or referencing the place.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "playingEntity[classCode=PLC determinerCode=INSTANCE].desc"
}
]
}
},
{
"path": "Location.type",
"definition": {
"short": "Indicates the type of function performed at the location",
"formal": "Indicates the type of function performed at the location.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "LocationType",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/v3/vs/ServiceDeliveryLocationRoleType"
}
},
"mapping": [
{
"identity": "rim",
"map": "code"
}
]
}
},
{
"path": "Location.telecom",
"definition": {
"short": "Contact details of the location",
"formal": "The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contact"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "telecom"
}
]
}
},
{
"path": "Location.address",
"definition": {
"short": "Physical location",
"formal": "Physical location.",
"comments": "This was kept as 0..1 as there is no use property on the address, so wouldn't be able to identify different address types.",
"min": 0,
"max": "1",
"type": [
{
"code": "Address"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "addr"
}
]
}
},
{
"path": "Location.physicalType",
"definition": {
"short": "Physical form of the location",
"formal": "Physical form of the location, e.g. building, room, vehicle, road.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "PhysicalType",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/location-physical-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "playingEntity [classCode=PLC].code"
}
]
}
},
{
"path": "Location.position",
"definition": {
"short": "The absolute geographic location",
"formal": "The absolute geographic location of the Location, expressed in a KML compatible manner (see notes below for KML).",
"min": 0,
"max": "1",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "playingEntity [classCode=PLC determinerCode=INSTANCE].positionText"
}
]
}
},
{
"path": "Location.position.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Location.position.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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.",
"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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Location.position.longitude",
"definition": {
"short": "Longitude as expressed in KML",
"formal": "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"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "?? RIM Opted not to map the sub-elements of GPS location) is now an OBS"
}
]
}
},
{
"path": "Location.position.latitude",
"definition": {
"short": "Latitude as expressed in KML",
"formal": "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"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "?? RIM Opted not to map the sub-elements of GPS location) is now an OBS"
}
]
}
},
{
"path": "Location.position.altitude",
"definition": {
"short": "Altitude as expressed in KML",
"formal": "Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "?? RIM Opted not to map the sub-elements of GPS location) is now an OBS"
}
]
}
},
{
"path": "Location.managingOrganization",
"definition": {
"short": "The organization that is responsible for the provisioning and upkeep of the location",
"formal": "The organization that is responsible for the provisioning and upkeep of the location.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "scopingEntity[classCode=ORG determinerKind=INSTANCE]"
}
]
}
},
{
"path": "Location.status",
"definition": {
"short": "active | suspended | inactive",
"formal": "active | suspended | inactive.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "LocationStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/location-status"
}
},
"mapping": [
{
"identity": "rim",
"map": "statusCode"
}
]
}
},
{
"path": "Location.partOf",
"definition": {
"short": "Another Location which this Location is physically part of",
"formal": "Another Location which this Location is physically part of.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Location"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "inboundLink[typeCode=PART].source[classCode=SDLC]"
}
]
}
},
{
"path": "Location.mode",
"definition": {
"short": "instance | kind",
"formal": "Indicates whether a resource instance represents a specific location or a class of locations.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "LocationMode",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/location-mode"
}
},
"mapping": [
{
"identity": "rim",
"map": "playingEntity[classCode=PLC].determinerCode"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "address",
"type": "string",
"documentation": "A (part of the) address of the location",
"xpath": "f:Location/f:address"
},
{
"name": "identifier",
"type": "token",
"documentation": "Unique code or number identifying the location to its users",
"xpath": "f:Location/f:identifier"
},
{
"name": "name",
"type": "string",
"documentation": "A (portion of the) name of the location",
"xpath": "f:Location/f:name"
},
{
"name": "near",
"type": "token",
"documentation": "The coordinates expressed as [lat],[long] (using KML, see notes) to find locations near to (servers may search using a square rather than a circle for efficiency)"
},
{
"name": "near-distance",
"type": "token",
"documentation": "A distance quantity to limit the near search to locations within a specific distance"
},
{
"name": "partof",
"type": "reference",
"documentation": "The location of which this location is a part",
"xpath": "f:Location/f:partOf"
},
{
"name": "status",
"type": "token",
"documentation": "Searches for locations with a specific kind of status",
"xpath": "f:Location/f:status"
},
{
"name": "type",
"type": "token",
"documentation": "A code for the type of location",
"xpath": "f:Location/f:type"
}
]
}
]
}
© HL7.org 2011+. FHIR DSTU (v0.0.82.2943) generated on Tue, Sep 30, 2014 18:09+1000.
Links:
What's a DSTU? |
Version History |
|
Propose a change