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.
Project Test
FamilyMemberHistory
Base StructureDefinition for FamilyMemberHistory Resource
- type Profile on FamilyMemberHistory
- FHIR STU3
- status Draft
-
versionnone
Unregistered conflicting canonical
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.
Canonical
| FamilyMemberHistory | I | DomainResource | Element idFamilyMemberHistory Information about patient's relatives, relevant for patient DefinitionSignificant health events and conditions for a person related to the patient relevant in the context of care for the patient.
| |
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idFamilyMemberHistory.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 idFamilyMemberHistory.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 idFamilyMemberHistory.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 idFamilyMemberHistory.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. ?? (extensible) | |
| text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idFamilyMemberHistory.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 idFamilyMemberHistory.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 idFamilyMemberHistory.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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |
| modifierExtension | ?! | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
|
| identifier | Σ | 0..* | Identifier | Element idFamilyMemberHistory.identifier External Id(s) for this record DefinitionThis records identifiers associated with this family member history record that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). Need to allow connection to a wider workflow.
|
| definition | Σ I | 0..* | Reference(PlanDefinition | Questionnaire) | Element idFamilyMemberHistory.definition Instantiates protocol or definition DefinitionA protocol or questionnaire that was adhered to in whole or in part by this event. 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(PlanDefinition | Questionnaire) Constraints
|
| status | Σ ?! | 1..1 | codeBinding | Element idFamilyMemberHistory.status partial | completed | entered-in-error | health-unknown DefinitionA code specifying the status of the record of the family history of a specific family member. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. A code that identifies the status of the family history record. ?? (required)Constraints
|
| notDone | Σ ?! | 0..1 | boolean | Element idFamilyMemberHistory.notDone The taking of a family member's history did not occur DefinitionIf true, indicates the taking of an individual family member's history did not occur. The notDone element should not be used to document negated conditions, such as a family member that did not have a condition. Creating a FamilyMemberHistory where notDone is true is intended for situations where there's a need for a specific statement in the record about something not being done. If the need is merely to indicate that a request wasn't fulfilled, that should be handled using Task. This element is labeled as a modifier because it marks the family member history as a family member history that did not occur. The more attributes are populated, the more constrained the negated statement is. This notDone element is being evaluated and will likely be removed in a subsequent release.
false
|
| notDoneReason | Σ I | 0..1 | CodeableConcept | Element idFamilyMemberHistory.notDoneReason subject-unknown | withheld | unable-to-obtain | deferred DefinitionDescribes why the family member's history is absent. This is a separate element to allow it to have a distinct binding from reasonCode. This notDoneReason element is being evaluated and will likely be replaced in a subsequent release (e.g. dataAbsentReason). Codes describing the reason why a family member history was not done. ?? (example)Constraints
|
| patient | Σ I | 1..1 | Reference(Patient) | Element idFamilyMemberHistory.patient Patient history is about Alternate namesProband DefinitionThe person who this history concerns. 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.
|
| date | Σ | 0..1 | dateTime | Element idFamilyMemberHistory.date When history was captured/updated DefinitionThe date (and possibly time) when the family member history was taken. Allows determination of how current the summary is. This should be captured even if the same as the date on the List aggregating the full family history.
|
| name | Σ | 0..1 | string | Element idFamilyMemberHistory.name The family member described DefinitionThis will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair". Allows greater ease in ensuring the same person is being talked about. Note that FHIR strings may not exceed 1MB in size
|
| relationship | Σ | 1..1 | CodeableConcept | Element idFamilyMemberHistory.relationship Relationship to the subject DefinitionThe type of relationship this person has to the patient (father, mother, brother etc.). Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The nature of the relationship between the patient and the related person being described in the family member history. ?? (example)Constraints
|
| gender | Σ | 0..1 | codeBinding | Element idFamilyMemberHistory.gender male | female | other | unknown DefinitionAdministrative Gender - the gender that the relative is considered to have for administration and record keeping purposes. Not all relationship codes imply gender and the relative's gender can be relevant for risk assessments. The gender of a person used for administrative purposes. ?? (required)Constraints
|
| born[x] | I | 0..1 | Element idFamilyMemberHistory.born[x] (approximate) date of birth DefinitionThe actual or approximate date of birth of the relative. Allows calculation of the relative's age.
| |
| bornPeriod | Period | Data type | ||
| bornDate | date | Data type | ||
| bornString | string | Data type | ||
| age[x] | Σ I | 0..1 | Element idFamilyMemberHistory.age[x] (approximate) age DefinitionThe age of the relative at the time the family member history is recorded. While age can be calculated from date of birth, sometimes recording age directly is more natureal for clinicians. use estimatedAge to indicate whether the age is actual or not.
| |
| ageAge | Age | Data type | ||
| ageRange | Range | Data type | ||
| ageString | string | Data type | ||
| estimatedAge | Σ ?! I | 0..1 | boolean | Element idFamilyMemberHistory.estimatedAge Age is estimated? DefinitionIf true, indicates that the age value specified is an estimated value. Clinicians often prefer to specify an estimaged age rather than an age range. This element is labeled as a modifier because the fact tha age is estimated can/should change the results of any algorithm that calculates based on the specified age. It is unknown whether the age is an estimate or not
|
| deceased[x] | Σ | 0..1 | Element idFamilyMemberHistory.deceased[x] Dead? How old/when? DefinitionDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
| |
| deceasedBoolean | boolean | Data type | ||
| deceasedAge | Age | Data type | ||
| deceasedRange | Range | Data type | ||
| deceasedDate | date | Data type | ||
| deceasedString | string | Data type | ||
| reasonCode | Σ | 0..* | CodeableConcept | Element idFamilyMemberHistory.reasonCode Why was family member history performed? DefinitionDescribes why the family member history occurred in coded or textual form. Textual reasons can be caprued using reasonCode.text. Codes indicating why the family member history was done. ?? (example)Constraints
|
| reasonReference | Σ I | 0..* | Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse) | Element idFamilyMemberHistory.reasonReference Why was family member history performed? DefinitionIndicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event. 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(Condition | Observation | AllergyIntolerance | QuestionnaireResponse) Constraints
|
| note | 0..* | Annotation | Element idFamilyMemberHistory.note General note about related person DefinitionThis property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
| |
| condition | 0..* | BackboneElement | Element idFamilyMemberHistory.condition Condition that the related person had DefinitionThe significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition. If none of the conditions listed have an outcome of "death" specified, that indicates that none of the specified conditions are known to have been the primary cause of death.
| |
| id | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.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 idFamilyMemberHistory.condition.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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |
| modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.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.
|
| code | 1..1 | CodeableConcept | Element idFamilyMemberHistory.condition.code Condition suffered by relation DefinitionThe actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Identification of the Condition or diagnosis. ?? (example)Constraints
| |
| outcome | 0..1 | CodeableConcept | Element idFamilyMemberHistory.condition.outcome deceased | permanent disability | etc. DefinitionIndicates what happened as a result of this condition. If the condition resulted in death, deceased date is captured on the relation. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc. ?? (example)Constraints
| |
| onset[x] | 0..1 | Element idFamilyMemberHistory.condition.onset[x] When condition first manifested DefinitionEither the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence. Age of onset of a condition in relatives is predictive of risk for the patient.
| ||
| onsetAge | Age | Data type | ||
| onsetRange | Range | Data type | ||
| onsetPeriod | Period | Data type | ||
| onsetString | string | Data type | ||
| note | 0..* | Annotation | Element idFamilyMemberHistory.condition.note Extra information about condition DefinitionAn area where general notes can be placed about this specific condition. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
|
Documentation:
https://simplifier.net/test20171116/familymemberhistory
Last updated on