FQL is a query language that allows you to retrieve, filter and project data from any data source containing FHIR Resources. It brings the power of three existing languages together: SQL, JSON and FhirPath. It allows you to create tables and is useful for gaining insight and perform quality control.
Query
-
Default
What is FQL?
-
FQL Query resources
FQL Playground
Try Firely Query Language in our playground by using this scope as data source.
- FQL Documentation
-
FQL Language
Syntax specification
To learn more about FQL syntax choose this menu item.
-
YamlGen Generate resources
YamlGen Playground
Try YamlGen in our playground by using this scope as data source.
-
YamlGen Language
YamlGen Syntax specification
To learn more about YamlGen syntax choose this.
-
FHIRPath Inspect resource
FHIRPath Playground
Try out the FHIRPath playground and navigate inside this resource.
-
FHIRPath Documentation
FHIRPath Documentation
Find out what FHIRPath is or learn how to write FHIRPath scripts.
API
-
Project FHIR API
This is the location where you can find your resource using a FHIR client.
-
Simplifier FHIR API
The global endpoint is where users can search for all resources in Simplifier. Resources have a globally unique guid Id here.
Tools
-
Custom Example generation
Custom Example generation beta
Experiment with resource instance generation using YamlGen and based on this profile.
This feature is in beta. You can help us improve it by giving feedback with the feedback button at the top of the screen.
Organization Canadian FHIR Registry /
Project Pan-Canadian Care Services Directory (CA:CSD)
Location
A Location is a physical place where care can be delivered. Examples of Locations include buildings, wards, rooms, and vehicles. A Location can also represent a jurisdiction such as a health region or zones. A Location will have attributes such as a unique identifier, and may have attributes such as hours of operation, geographic information (address, geocode), hours operation. A Location may be associated with an Organization. A Location may also be in a hierarchy with other Locations.
- type Profile on Location
- FHIR R4
- status Draft
-
version...
Valid canonical
This resource matches a canonical claim from this project.
Claim: http://fhir.infoway-inforoute.ca/io/CA-CSD/
Canonical claims are used to verify ownership of your canonical URLs.
Canonical
| Location | I | There are no (further) constraints on this element Element idLocation Details and position information for a physical place DefinitionDetails and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
| ||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idLocation.meta Metadata about the resource 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.
|
| implicitRules | Σ ?! | 0..0 | uri | There are no (further) constraints on this element Element idLocation.implicitRules A set of rules under which this content was created 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. 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.
|
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idLocation.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idLocation.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display 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. 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.
| |
| contained | 0..* | Resource | There are no (further) constraints on this element Element idLocation.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources 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. 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.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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.
|
| modifierExtension | ?! I | 0..0 | Extension | There are no (further) constraints on this element Element idLocation.modifierExtension Extension DefinitionAn Extension
|
| identifier | S Σ | 0..* | Identifier | Element idLocation.identifier Unique code or number identifying the location to its users DefinitionUnique code or number identifying the location to its users. Organization label locations in registries, need to keep track of those. Identified as a query requirement through mCSD CapabilityStatement, and mustSupport element in the CA Baseline.
|
| status | S Σ ?! | 1..1 | codeBinding | Element idLocation.status The status code of the Location. DefinitionThe status code of the Location: Identified as a query requirement through mCSD CapabilityStatement. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated. Indicates whether the location is still in use.
|
| operationalStatus | Σ | 0..1 | CodingBinding | There are no (further) constraints on this element Element idLocation.operationalStatus The operational status of the location (typically only for a bed/room) 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. The operational status if the location (where typically a bed/room).
|
| name | S Σ | 1..1 | string | Element idLocation.name The name of the Location. DefinitionThe name of the Location. Identified as a query requirement through mCSD CapabilityStatement. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated.
|
| alias | 0..* | string | There are no (further) constraints on this element Element idLocation.alias A list of alternate names that the location is known as, or was known as, in the past DefinitionA list of alternate names that the location is known as, or was known as, in the past. 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. 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.
| |
| description | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.description Additional details about the location that could be displayed as further information to identify the location beyond its name DefinitionDescription of the Location, which helps in finding or referencing the place. Humans need additional information to verify a correct location has been identified.
|
| mode | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idLocation.mode instance | kind DefinitionIndicates whether a resource instance represents a specific location or a class of locations. 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. 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. Indicates whether a resource instance represents a specific location or a class of locations.
|
| type | S Σ | 1..* | CodeableConceptBinding | Element idLocation.type A code that describes the type of Location. DefinitionA code that describes the type of Location. Identified as a query requirement through mCSD CapabilityStatement. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated. Indicates the type of function performed at the location.
|
| telecom | S | 0..* | ContactPoint | Element idLocation.telecom Contact details of the location DefinitionThe contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites. Identified as a requirement and mustSupport element from the CA baseline.
|
| address | 0..1 | Address | There are no (further) constraints on this element Element idLocation.address Physical location DefinitionPhysical location. If locations can be visited, we need to keep track of their address. Additional addresses should be recorded using another instance of the Location resource, or via the Organization.
| |
| physicalType | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idLocation.physicalType A code that describes the physical form of the Location. DefinitionA code that describes the physical form of the Location. For purposes of showing relevant locations in queries, we need to categorize locations. Physical form of the location.
|
| position | 0..1 | BackboneElement | There are no (further) constraints on this element Element idLocation.position The absolute geographic location DefinitionThe absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML). For mobile applications and automated route-finding knowing the exact location of the Location is required.
| |
| id | 0..1 | string | There are no (further) constraints on this element Element idLocation.position.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.position.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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.
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.position.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers 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). 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. 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.
|
| longitude | 1..1 | decimal | There are no (further) constraints on this element Element idLocation.position.longitude Longitude with WGS84 datum DefinitionLongitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).
| |
| latitude | 1..1 | decimal | There are no (further) constraints on this element Element idLocation.position.latitude Latitude with WGS84 datum DefinitionLatitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).
| |
| altitude | 0..1 | decimal | There are no (further) constraints on this element Element idLocation.position.altitude Altitude with WGS84 datum DefinitionAltitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).
| |
| managingOrganization | S Σ | 0..1 | Reference(Organization) | Element idLocation.managingOrganization Organization responsible for provisioning and upkeep DefinitionThe organization responsible for the provisioning and upkeep of the location. Need to know who manages the location. Identified as a query requirement through mCSD CapabilityStatement.
|
| partOf | S | 0..1 | Reference(Location) | Element idLocation.partOf Another Location this one is physically a part of DefinitionAnother Location of which this Location is physically a part of. For purposes of location, display and identification, knowing which locations are located within other locations is important. Identified as a query requirement through mCSD CapabilityStatement. Allows the search to return the location without having to go through the practitionerRole resource.
|
| hoursOfOperation | 0..* | BackboneElement | There are no (further) constraints on this element Element idLocation.hoursOfOperation What days/times during a week is this location usually open DefinitionWhat days/times during a week is this location usually open. 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.
| |
| id | 0..1 | string | There are no (further) constraints on this element Element idLocation.hoursOfOperation.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.hoursOfOperation.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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.
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.hoursOfOperation.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers 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). 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. 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.
|
| daysOfWeek | 0..* | codeBinding | There are no (further) constraints on this element Element idLocation.hoursOfOperation.daysOfWeek mon | tue | wed | thu | fri | sat | sun DefinitionIndicates which days of the week are available between the start and end Times. The days of the week.
| |
| allDay | 0..1 | boolean | There are no (further) constraints on this element Element idLocation.hoursOfOperation.allDay The Location is open all day DefinitionThe Location is open all day.
| |
| openingTime | 0..1 | time | There are no (further) constraints on this element Element idLocation.hoursOfOperation.openingTime Time that the Location opens DefinitionTime that the Location opens.
| |
| closingTime | 0..1 | time | There are no (further) constraints on this element Element idLocation.hoursOfOperation.closingTime Time that the Location closes DefinitionTime that the Location closes.
| |
| availabilityExceptions | 0..1 | string | There are no (further) constraints on this element Element idLocation.availabilityExceptions Description of availability exceptions 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.
| |
| endpoint | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element idLocation.endpoint Technical endpoints providing access to services operated for the location DefinitionTechnical endpoints providing access to services operated for the location. 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.
|
Documentation:
https://simplifier.net/ca-csd/location
Last updated on