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.
-
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.
-
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.
-
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.
CareConnect-HealthcareService-1
CareConnect HealthCareService Profile
- type Profile on HealthcareService
- FHIR STU3
- status Draft
-
version2.0.0
This resource matches a canonical claim from this project.
Claim: https://fhir.hl7.org.uk/STU3/
Canonical claims are used to verify ownership of your canonical URLs.
CareConnect-HealthcareService-1 (HealthcareService) | I | HealthcareService | There are no (further) constraints on this element Element idHealthcareService The details of a healthcare service available at a location DefinitionThe details of a healthcare service available at a location.
| |
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idHealthcareService.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 idHealthcareService.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idHealthcareService.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. 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idHealthcareService.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. Common Languages (extensible) | |
text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idHealthcareService.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 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. 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 in formation is added later.
|
contained | 0..* | Resource | There are no (further) constraints on this element Element idHealthcareService.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.
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idHealthcareService.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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 | ?! | 0..* | Extension | There are no (further) constraints on this element Element idHealthcareService.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content 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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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.
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idHealthcareService.identifier External identifiers for this item DefinitionExternal identifiers for this item.
|
active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idHealthcareService.active Whether this healthcareservice is in active use DefinitionWhether this healthcareservice record is in active use. This element is labeled as a modifier because it may be used to mark that the resource was created in error. true
|
providedBy | Σ | 0..1 | Reference(CareConnect-Organization-1) | Element idHealthcareService.providedBy Organization that provides this service DefinitionThe organization that provides this healthcare service. This property is recommended to be the same as the Location's managingOrganization, and if not provided should be interpreted as such. If the Location does not have a managing Organization, then this property should be populated. Reference(CareConnect-Organization-1) Mappings
|
category | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idHealthcareService.category Broad category of service being performed or delivered Alternate namesservice category DefinitionIdentifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type. A category of the service(s) that could be provided. ServiceCategory (example)Mappings
|
type | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idHealthcareService.type Type of service that may be delivered or performed Alternate namesservice type DefinitionThe specific type of service that may be delivered or performed. Additional details about where the content was created (e.g. clinical specialty). ServiceType (example)Mappings
|
specialty | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idHealthcareService.specialty Specialties handled by the HealthcareService DefinitionCollection of specialties handled by the service site. This is more of a medical term. A specialty that a healthcare service may provide. Practice Setting Code Value Set (preferred)Mappings
|
location | Σ | 0..* | Reference(CareConnect-Location-1) | Element idHealthcareService.location Location(s) where service may be provided DefinitionThe location(s) where this healthcare service may be provided. Reference(CareConnect-Location-1) Mappings
|
name | Σ | 0..1 | string | There are no (further) constraints on this element Element idHealthcareService.name Description of service as presented to a consumer while searching DefinitionFurther description of the service as it would be presented to a consumer while searching.
|
comment | Σ | 0..1 | string | There are no (further) constraints on this element Element idHealthcareService.comment Additional description and/or any specific issues not covered elsewhere DefinitionAny additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName. Would expect that a user would not see this information on a search results, and it would only be available when viewing the complete details of the service.
|
extraDetails | 0..1 | string | There are no (further) constraints on this element Element idHealthcareService.extraDetails Extra details about the service that can't be placed in the other fields DefinitionExtra details about the service that can't be placed in the other fields.
| |
photo | Σ | 0..1 | Attachment | There are no (further) constraints on this element Element idHealthcareService.photo Facilitates quick identification of the service DefinitionIf there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.
|
telecom | 0..* | ContactPoint | There are no (further) constraints on this element Element idHealthcareService.telecom Contacts related to the healthcare service DefinitionList of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts.
| |
coverageArea | 0..* | Reference(CareConnect-Location-1) | Element idHealthcareService.coverageArea Location(s) service is inteded for/available to DefinitionThe location(s) that this service is available to (not where the service is provided). The locations referenced by the coverage area can include both specific locations, including areas, and also conceptual domains too (mode = kind), such as a physical area (tri-state area) and some other attribute (covered by Example Care Organization). These types of Locations are often not managed by any specific organization. This could also include generic locations such as "in-home". Reference(CareConnect-Location-1) Mappings
| |
serviceProvisionCode | 0..* | CodeableConcept | There are no (further) constraints on this element Element idHealthcareService.serviceProvisionCode Conditions under which service is available/offered DefinitionThe code(s) that detail the conditions under which the healthcare service is available/offered. The provision means being commissioned by, contractually obliged or financially sourced. Types of costings that may apply to this healthcare service, such if the service may be available for free, some discounts available, or fees apply. The code(s) that detail the conditions under which the healthcare service is available/offered. ServiceProvisionConditions (example)Mappings
| |
eligibility | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idHealthcareService.eligibility Specific eligibility requirements required to use the service DefinitionDoes this service have specific eligibility requirements that need to be met in order to use the service? Coded values underwhich a specific service is made available. (unbound) (example)Mappings
| |
eligibilityNote | 0..1 | string | There are no (further) constraints on this element Element idHealthcareService.eligibilityNote Describes the eligibility conditions for the service DefinitionDescribes the eligibility conditions for the service. The description of service eligibility should, in general, not exceed one or two paragraphs. It should be sufficient for a prospective consumer to determine if they are likely to be eligible or not. Where eligibility requirements and conditions are complex, it may simply be noted that an eligibility assessment is required. Where eligibility is determined by an outside source, such as an Act of Parliament, this should be noted, preferably with a reference to a commonly available copy of the source document such as a web page.
| |
programName | 0..* | string | There are no (further) constraints on this element Element idHealthcareService.programName Program Names that categorize the service DefinitionProgram Names that can be used to categorize the service. Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, ….
| |
characteristic | 0..* | CodeableConcept | There are no (further) constraints on this element Element idHealthcareService.characteristic Collection of characteristics (attributes) DefinitionCollection of characteristics (attributes). These could be such things as is wheelchair accessible. A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). (unbound) (example)Mappings
| |
referralMethod | 0..* | CodeableConcept | There are no (further) constraints on this element Element idHealthcareService.referralMethod Ways that the service accepts referrals DefinitionWays that the service accepts referrals, if this is not provided then it is implied that no referral is required. The methods of referral can be used when referring to a specific HealthCareService resource. ReferralMethod (example)Mappings
| |
appointmentRequired | 0..1 | boolean | There are no (further) constraints on this element Element idHealthcareService.appointmentRequired If an appointment is required for access to this service DefinitionIndicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.
| |
availableTime | 0..* | BackboneElement | There are no (further) constraints on this element Element idHealthcareService.availableTime Times the Service Site is available DefinitionA collection of times that the Service Site is available. More detailed availability information may be provided in associated Schedule/Slot resources.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idHealthcareService.availableTime.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idHealthcareService.availableTime.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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 | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idHealthcareService.availableTime.modifierExtension Extensions that cannot be ignored 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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 idHealthcareService.availableTime.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. DaysOfWeek (required)Mappings
| |
allDay | 0..1 | boolean | There are no (further) constraints on this element Element idHealthcareService.availableTime.allDay Always available? e.g. 24 hour service DefinitionIs this always available? (hence times are irrelevant) e.g. 24 hour service.
| |
availableStartTime | 0..1 | time | There are no (further) constraints on this element Element idHealthcareService.availableTime.availableStartTime Opening time of day (ignored if allDay = true) DefinitionThe opening time of day. Note: If the AllDay flag is set, then this time is ignored. The timezone is expected to be for where this HealthcareService is provided at.
| |
availableEndTime | 0..1 | time | There are no (further) constraints on this element Element idHealthcareService.availableTime.availableEndTime Closing time of day (ignored if allDay = true) DefinitionThe closing time of day. Note: If the AllDay flag is set, then this time is ignored. The timezone is expected to be for where this HealthcareService is provided at.
| |
notAvailable | 0..* | BackboneElement | There are no (further) constraints on this element Element idHealthcareService.notAvailable Not available during this time due to provided reason DefinitionThe HealthcareService is not available during this period of time due to the provided reason.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idHealthcareService.notAvailable.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idHealthcareService.notAvailable.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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 | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idHealthcareService.notAvailable.modifierExtension Extensions that cannot be ignored 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. 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.
|
description | 1..1 | string | There are no (further) constraints on this element Element idHealthcareService.notAvailable.description Reason presented to the user explaining why time not available DefinitionThe reason that can be presented to the user as to why this time is not available.
| |
during | 0..1 | Period | There are no (further) constraints on this element Element idHealthcareService.notAvailable.during Service not availablefrom this date DefinitionService is not available (seasonally or for a public holiday) from this date.
| |
availabilityExceptions | 0..1 | string | There are no (further) constraints on this element Element idHealthcareService.availabilityExceptions Description of availability exceptions DefinitionA description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.
| |
endpoint | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element idHealthcareService.endpoint Technical endpoints providing access to services operated for the location DefinitionTechnical endpoints providing access to services operated for the specific healthcare services defined at this resource. Organizations may have different systems covering different services at the different locations and need to be able to define the technical connection details for how to connect to them, and for what purpose.
|