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.
Person
Demographics and administrative information about a person independent of a specific health-related context.
- type Profile on Person
- FHIR R4
- status Draft
-
version4.0.1
The canonical from this resource does not match any claim in this context and conflicts with a claim from another scope.
http://hl7.org/fhir
Canonical claims are used to verify ownership of your canonical URLs.
Person | I | DomainResource | Element idPerson A generic person record DefinitionDemographics and administrative information about a person independent of a specific health-related context. The Person resource does justice to person registries that keep track of persons regardless of their role. The Person resource is also a primary resource to point to for people acting in a particular role such as SubjectofCare, Practitioner, and Agent. Very few attributes are specific to any role and so Person is kept lean. Most attributes are expected to be tied to the role the Person plays rather than the Person himself. Examples of that are Guardian (SubjectofCare), ContactParty (SubjectOfCare, Practitioner), and multipleBirthInd (SubjectofCare).
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idPerson.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 idPerson.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 idPerson.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 idPerson.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 idPerson.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 idPerson.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 idPerson.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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPerson.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 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | 0..* | Identifier | Element idPerson.identifier A human identifier for this person DefinitionIdentifier for a person within a particular scope. People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the person. Examples are national person identifier and local identifier.
| |
name | Σ | 0..* | HumanName | Element idPerson.name A name associated with the person DefinitionA name associated with the person. Need to be able to track the person by multiple names. Examples are your official name and a partner name. Person may have multiple names with different uses or applicable periods.
|
telecom | Σ I | 0..* | ContactPoint | Element idPerson.telecom A contact detail for the person DefinitionA contact detail for the person, e.g. a telephone number or an email address. People have (primary) ways to contact them in some way such as phone, email. Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification.
|
gender | Σ | 0..1 | codeBinding | Element idPerson.gender male | female | other | unknown DefinitionAdministrative Gender. Needed for identification of the person, in combination with (at least) name and birth date. Gender of person drives many clinical processes. 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 M and F, though a clear majority of systems and contexts only support M and F. The gender of a person used for administrative purposes.
|
birthDate | Σ | 0..1 | date | Element idPerson.birthDate The date on which the person was born DefinitionThe birth date for the person. Age of person drives many clinical processes, and is often used in performing identification of the person. Times are not included so as to not confuse things with potential timezone issues. At least an estimated year should be provided as a guess if the real DOB is unknown.
|
address | 0..* | Address | Element idPerson.address One or more addresses for the person DefinitionOne or more addresses for the person. May need to keep track of person's addresses for contacting, billing or reporting requirements and also to help with identification. Person may have multiple addresses with different uses or applicable periods.
| |
photo | I | 0..1 | Attachment | Element idPerson.photo Image of the person DefinitionAn image that can be displayed as a thumbnail of the person to enhance the identification of the individual. When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".
|
managingOrganization | Σ I | 0..1 | Reference(Organization) | Element idPerson.managingOrganization The organization that is the custodian of the person record DefinitionThe organization that is the custodian of the person record. Need to know who recognizes this person record, manages and updates it. 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.
|
active | Σ ?! | 0..1 | boolean | Element idPerson.active This person's record is in active use DefinitionWhether this person's record is in active use. Need to be able to mark a person record as not to be used because it was created in error.
|
link | 0..* | BackboneElement | Element idPerson.link Link to a resource that concerns the same actual person DefinitionLink to a resource that concerns the same actual person.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idPerson.link.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 idPerson.link.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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPerson.link.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.
|
target | I | 1..1 | Reference(Patient | Practitioner | RelatedPerson | Person) | Element idPerson.link.target The resource to which this actual person is associated DefinitionThe resource to which this actual person is associated. 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(Patient | Practitioner | RelatedPerson | Person) Constraints
|
assurance | 0..1 | codeBinding | Element idPerson.link.assurance level1 | level2 | level3 | level4 DefinitionLevel of assurance that this link is associated with the target resource. The level of confidence that this link represents the same actual person, based on NIST Authentication Levels.
|