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.
IDMS - Consent to Terms of Use
Consent
- type Profile on Consent
- FHIR R5
- status Draft
-
version...
This resource matches a canonical claim from this project.
Claim: https://health.gov.on.ca/idms/
Canonical claims are used to verify ownership of your canonical URLs.
TOUConsent (Consent) | I | Consent | There are no (further) constraints on this element Element idConsent A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time DefinitionA record of a healthcare consumer’s choices or choices made on their behalf by a third party, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time. Broadly, there are 3 key areas of consent for patients: Consent around sharing information (aka Privacy Consent Directive - Authorization to Collect, Use, or Disclose information), consent for specific treatment, or kinds of treatment and consent for research participation and data sharing.
| |
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idConsent.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. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idConsent.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..1 | uri | There are no (further) constraints on this element Element idConsent.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 its narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idConsent.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). IETF language tag for a human language
| |
text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idConsent.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 a 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 | I | 0..* | Resource | There are no (further) constraints on this element Element idConsent.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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. 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 idConsent.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 managable, 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 idConsent.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 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 managable, 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). 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.
|
identifier | Σ | 0..0 | Identifier | There are no (further) constraints on this element Element idConsent.identifier Identifier for this record (external references) DefinitionUnique identifier for this copy of the Consent Statement. This identifier identifies this copy of the consent. Where this identifier is also used elsewhere as the identifier for a consent record (e.g. a CDA consent document) then the consent details are expected to be the same.
|
status | Σ ?! | 1..1 | codeBinding | Element idConsent.status draft | active | inactive | not-done | entered-in-error | unknown Definition
|
category | Σ | 0..0 | CodeableConcept | Element idConsent.category Classification of the consent statement - for indexing/retrieval Definition
|
subject | Σ | 0..0 | Reference(Patient | Practitioner | Group) | There are no (further) constraints on this element Element idConsent.subject Who the consent applies to DefinitionThe patient/healthcare practitioner or group of persons to whom this consent applies. Reference(Patient | Practitioner | Group) Constraints
|
date | Σ | 1..1 | date | Element idConsent.date Fully executed date of the consent Definition
|
period | Σ | 0..0 | Period | There are no (further) constraints on this element Element idConsent.period Effective period for this Consent Alternate namesperiod DefinitionEffective period for this Consent Resource and all provisions unless specified in that provision.
|
grantor | Σ | 0..0 | Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | There are no (further) constraints on this element Element idConsent.grantor Who is granting rights according to the policy and rules Alternate namesgrantor DefinitionThe entity responsible for granting the rights listed in a Consent Directive. Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Constraints
|
grantee | Σ | 1..1 | Reference(PractitionerRole) | Element idConsent.grantee Who is agreeing to the policy and rules Alternate namesgrantee Definition
|
manager | 0..0 | Reference(HealthcareService | Organization | Patient | Practitioner) | There are no (further) constraints on this element Element idConsent.manager Consent workflow management Alternate namesmanager DefinitionThe actor that manages the consent through its lifecycle. Reference(HealthcareService | Organization | Patient | Practitioner) Constraints
| |
controller | 0..0 | Reference(HealthcareService | Organization | Patient | Practitioner) | There are no (further) constraints on this element Element idConsent.controller Consent Enforcer Alternate namescontroller DefinitionThe actor that controls/enforces the access according to the consent. Reference(HealthcareService | Organization | Patient | Practitioner) Constraints
| |
sourceAttachment | 0..0 | Attachment | There are no (further) constraints on this element Element idConsent.sourceAttachment Source from which this consent is taken DefinitionThe source on which this consent statement is based. The source might be a scanned original paper form. The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.
| |
sourceReference | 0..* | Reference(DocumentReference) | Element idConsent.sourceReference Source from which this consent is taken Definition
| |
id | 0..1 | id | There are no (further) constraints on this element Element idConsent.sourceReference.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 idConsent.sourceReference.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 managable, 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
reference | Σ I | 1..1 | string | Element idConsent.sourceReference.reference Literal reference, Relative, internal or absolute URL Definition
|
type | Σ | 1..1 | uriBinding | Element idConsent.sourceReference.type Type the reference refers to (e.g. "Patient") - must be a resource in resources Definition
|
identifier | Σ I | 0..0 | Identifier | There are no (further) constraints on this element Element idConsent.sourceReference.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.
|
display | Σ I | 0..0 | string | There are no (further) constraints on this element Element idConsent.sourceReference.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
|
regulatoryBasis | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idConsent.regulatoryBasis Regulations establishing base Consent DefinitionA set of codes that indicate the regulatory basis (if any) that this consent supports. Regulatory policy examples
| |
policyBasis | 0..0 | BackboneElement | There are no (further) constraints on this element Element idConsent.policyBasis Computable version of the backing policy DefinitionA Reference or URL used to uniquely identify the policy the organization will enforce for this Consent. This Reference or URL should be specific to the version of the policy and should be dereferencable to a computable policy of some form.
| |
policyText | 0..0 | Reference(DocumentReference) | There are no (further) constraints on this element Element idConsent.policyText Human Readable Policy DefinitionA Reference to the human readable policy explaining the basis for the Consent.
| |
verification | Σ | 0..0 | BackboneElement | There are no (further) constraints on this element Element idConsent.verification Consent Verified by patient or family DefinitionWhether a treatment instruction (e.g. artificial respiration: yes or no) was verified with the patient, his/her family or another authorized person.
|
decision | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idConsent.decision deny | permit DefinitionAction to take - permit or deny - as default. Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level.
|
provision | Σ | 0..0 | BackboneElement | There are no (further) constraints on this element Element idConsent.provision Constraints to the base Consent.policyRule/Consent.policy DefinitionAn exception to the base policy of this consent. An exception can be an addition or removal of access permissions.
|