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.
TELUS Patient
Patient
- type Profile on Patient
- FHIR R4
- status Draft
-
version...
The canonical from this resource does not match any claims.
Canonical claims are used to verify ownership of your canonical URLs.
You're probably missing a package or made a typo in your canonical.
- Could not resolve: http://hl7.org/fhir/StructureDefinition/Patient
Patient | S | http://hl7.org/fhir/StructureDefinition/Patient | There are no (further) constraints on this element Element idPatient http://hl7.org/fhir/StructureDefinition/Patient | |
id | S | There are no (further) constraints on this element Element idPatient.id Usage Note: This will usually be a GUID assigned by the sending application. | ||
meta | S | There are no (further) constraints on this element Element idPatient.meta | ||
lastUpdated | S | There are no (further) constraints on this element Element idPatient.meta.lastUpdated | ||
source | S | There are no (further) constraints on this element Element idPatient.meta.source | ||
profile | S | There are no (further) constraints on this element Element idPatient.meta.profile | ||
text | S | There are no (further) constraints on this element Element idPatient.text | ||
extension | 0.. | There are no (further) constraints on this element Element idPatient.extension Unordered, Open, by url(Value) | ||
genderIdentity | S | 0.. | Extension | There are no (further) constraints on this element Element idPatient.extension:genderIdentity Extension Extension URLhttp://hl7.org/fhir/StructureDefinition/patient-genderIdentity |
value[x] | S | There are no (further) constraints on this element Element idPatient.extension:genderIdentity.value[x] Unordered, Open, by $this(Type) | ||
valueCodeableConcept | S | There are no (further) constraints on this element Element idPatient.extension:genderIdentity.value[x]:valueCodeableConcept | ||
Pronouns | S | 0..1 | Extension(Complex) | There are no (further) constraints on this element Element idPatient.extension:Pronouns The pronouns to use when referring to an individual in verbal or written communication Usage Note: This is a pre-adoption of an HL7 extension, http://hl7.org/fhir/StructureDefinition/individual-pronouns in R5 Extension(Complex) Extension URLhttp://telus.com/fhir/patientChart/StructureDefinition/ext-individual-pronouns |
identifier | S | There are no (further) constraints on this element Element idPatient.identifier ******** ADD JHN EXTENSION FOR VERSION HERE Usage Note: For all known profiles, this will be mandatory, with the exception of anonomyized data feeds such as RAPIDs. Unordered, Open, by type(Pattern) | ||
(All Slices) | There are no (further) constraints on this element | |||
type | S | There are no (further) constraints on this element Element idPatient.identifier.type | ||
system | S | 1.. | There are no (further) constraints on this element Element idPatient.identifier.system | |
value | S | 1.. | There are no (further) constraints on this element Element idPatient.identifier.value | |
MRN | S | ..1 | There are no (further) constraints on this element Element idPatient.identifier:MRN Conformance Rule: Sender local patient identifier MAY be stored by the receiving application and used for linking. | |
type | S | 1.. | Pattern | There are no (further) constraints on this element Element idPatient.identifier:MRN.type { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "MR" } ] } |
coding | S | Pattern | There are no (further) constraints on this element Element idPatient.identifier:MRN.type.coding { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "MR" } | |
system | S | 1.. | Pattern | There are no (further) constraints on this element Element idPatient.identifier:MRN.type.coding.system http://terminology.hl7.org/CodeSystem/v2-0203 |
code | S | 1.. | Fixed ValuePattern | There are no (further) constraints on this element Element idPatient.identifier:MRN.type.coding.code MR |
system | S | 1.. | There are no (further) constraints on this element Element idPatient.identifier:MRN.system Conformance Rule: This will generally be an OID of the form [Vendor OID].[Application Instance node].1.Suggested format: A branch “.1” is appended to create a unique namespace for the Patient ID. | |
value | S | 1.. | There are no (further) constraints on this element Element idPatient.identifier:MRN.value | |
JHN | S | There are no (further) constraints on this element Element idPatient.identifier:JHN Conformance: The TELUS Patient Jurisdictional Health Number Identifier . This must be supplied when known. Usage Note: There may be multiple active HN's; example, a baby will use the mother's JHN for a period of time before the baby obtains their own PHN. There could also be two if a person is moving from one province to another | ||
type | S | 1.. | Pattern | There are no (further) constraints on this element Element idPatient.identifier:JHN.type { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "JHN" } ] } |
coding | S | 1..1 | Pattern | There are no (further) constraints on this element Element idPatient.identifier:JHN.type.coding { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "JHN" } |
system | S | 1.. | Pattern | There are no (further) constraints on this element Element idPatient.identifier:JHN.type.coding.system http://terminology.hl7.org/CodeSystem/v2-0203 |
code | S | 1.. | Fixed ValuePattern | There are no (further) constraints on this element Element idPatient.identifier:JHN.type.coding.code JHN |
system | S | 1.. | Binding | There are no (further) constraints on this element Element idPatient.identifier:JHN.system Conformance Rule: This is the OID representing the jurisdictional identifier. If identifier.system is urn:ietf:rfc:3986, then the identifier.value must be a full URI (e.g. start with a scheme). http://telus.com/fhir/ValueSet/telus-identifier-system-patient-jhn (extensible) |
value | S | 1.. | There are no (further) constraints on this element Element idPatient.identifier:JHN.value Conformance Rule: This is the patient's jurisdictional health number If the value is a full URI, then the system must be urn:ietf:rfc:3986. | |
name | S | 1..1 | There are no (further) constraints on this element Element idPatient.name Usage: EMRs typically record the name from the healthcard in which case this should be the "official" name and should always be sent. Additionally, there is often a preferred name or "usual"name in the EMR that should also be sent. Old and/or maiden names can also be helpful for receiving applications who may have existing records with these names. A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. Unordered, Open, by use(Value) | |
(All Slices) | There are no (further) constraints on this element | |||
use | S | There are no (further) constraints on this element Element idPatient.name.use Usage Note: This may be referred to as the Preferred name in some EMRs - this would map to "usual". Usage Note: "Official" use should always be present. "Usual" should be used for preferred when this name is populated as a separate field in the EMR. Applications can assume that a name is current unless it explicitly says that it is temporary or old. | ||
family | S | There are no (further) constraints on this element Element idPatient.name.family | ||
given | S | There are no (further) constraints on this element Element idPatient.name.given | ||
prefix | S | There are no (further) constraints on this element Element idPatient.name.prefix | ||
suffix | S | There are no (further) constraints on this element Element idPatient.name.suffix | ||
gender | S | There are no (further) constraints on this element Element idPatient.gender Usage Note: This data is most often captured as a single data element in the EMR. This can also be considered as the Recorded Sex or Gender, that is introduced as an extension in R5. (http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender) which will map into this data element. This extension is not used at this point in time. The gender field in the EMRs tend to represent sex at birth, or admin sex or chromosomal sex. Typically this comes from a birth certificate, OHIP/JHN passport, etc - known government identification Usage Note: When gender has a value of "other" or unknown", systems may be capable of specifying the "Sex for Clinical Use" which an HL7 extension introduced for R5 (http://hl7.org/fhir/StructureDefinition/patient-sexForClinicalUse). This field may be recorded as part of the lab, observation or any other resource where this context is appropriate. The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex. | ||
birthDate | S | There are no (further) constraints on this element Element idPatient.birthDate Usage Note: At least an estimated year should be provided as a guess if the real DOB is unknown. Usage Note: There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems). | ||
deceased[x] | S | There are no (further) constraints on this element Element idPatient.deceased[x] | ||
contact | S | There are no (further) constraints on this element Element idPatient.contact Usage Rule: Privacy reviews are imperative prior to sharing contact infromation Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact. | ||
relationship | S | There are no (further) constraints on this element Element idPatient.contact.relationship | ||
coding | S | There are no (further) constraints on this element Element idPatient.contact.relationship.coding | ||
system | S | There are no (further) constraints on this element Element idPatient.contact.relationship.coding.system | ||
code | S | There are no (further) constraints on this element Element idPatient.contact.relationship.coding.code | ||
display | S | There are no (further) constraints on this element Element idPatient.contact.relationship.coding.display | ||
name | S | There are no (further) constraints on this element Element idPatient.contact.name | ||
use | S | There are no (further) constraints on this element Element idPatient.contact.name.use | ||
family | S | 1.. | There are no (further) constraints on this element Element idPatient.contact.name.family | |
given | S | There are no (further) constraints on this element Element idPatient.contact.name.given | ||
telecom | S | There are no (further) constraints on this element Element idPatient.contact.telecom | ||
system | S | 1.. | There are no (further) constraints on this element Element idPatient.contact.telecom.system | |
value | S | 1.. | There are no (further) constraints on this element Element idPatient.contact.telecom.value | |
use | S | There are no (further) constraints on this element Element idPatient.contact.telecom.use | ||
address | S | There are no (further) constraints on this element Element idPatient.contact.address | ||
use | S | There are no (further) constraints on this element Element idPatient.contact.address.use | ||
line | S | There are no (further) constraints on this element Element idPatient.contact.address.line | ||
city | S | There are no (further) constraints on this element Element idPatient.contact.address.city | ||
state | S | There are no (further) constraints on this element Element idPatient.contact.address.state | ||
postalCode | S | There are no (further) constraints on this element Element idPatient.contact.address.postalCode | ||
country | S | There are no (further) constraints on this element Element idPatient.contact.address.country | ||
organization | S | There are no (further) constraints on this element Element idPatient.contact.organization Usage: Example may be family and child services References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
reference | S | There are no (further) constraints on this element Element idPatient.contact.organization.reference | ||
display | S | There are no (further) constraints on this element Element idPatient.contact.organization.display | ||
communication | S | There are no (further) constraints on this element Element idPatient.communication | ||
language | S | There are no (further) constraints on this element Element idPatient.communication.language | ||
coding | S | There are no (further) constraints on this element Element idPatient.communication.language.coding | ||
system | S | There are no (further) constraints on this element Element idPatient.communication.language.coding.system | ||
code | S | There are no (further) constraints on this element Element idPatient.communication.language.coding.code | ||
text | S | There are no (further) constraints on this element Element idPatient.communication.language.text | ||
generalPractitioner | S | There are no (further) constraints on this element Element idPatient.generalPractitioner Usage note: Provider reference to the organization and the practitioner resource If a patient has not been assigned a doctor at the clinic only provide reference to the organization (parent organization) When a Primary MD/NP for that provider at that clinic is assigned provide reference to the organization or in some cases, the sub-organization (eg conceptual location in EMRs where two orgs exist under the same application instance) and the practitioner Usage Note: Primary and secondary providers in PSS are determined by the appointment system. ***Further discussion is required to determine how this would be conveyed in FHIR. This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues. Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type. | ||
reference | S | There are no (further) constraints on this element Element idPatient.generalPractitioner.reference | ||
display | S | There are no (further) constraints on this element Element idPatient.generalPractitioner.display | ||
managingOrganization | S | There are no (further) constraints on this element Element idPatient.managingOrganization Usage note: This should be populated with a particular Org (parent organization with the EMR instance) that is associated with the patient. There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association). | ||
reference | S | 1.. | There are no (further) constraints on this element Element idPatient.managingOrganization.reference Usage Note: Either the identifier or reference may be used. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | |
display | S | There are no (further) constraints on this element Element idPatient.managingOrganization.display |