FHIR R4 Symptoms Implementation Guide
1.0.0 - STU 1 International flag

FHIR R4 Symptoms Implementation Guide, published by HL7 International / Clinical Interoperability Council. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-symptoms-ig/ and changes regularly. See the Directory of published versions

Logical Model: Symptom Logical Model

Official URL: http://hl7.org/fhir/uv/symptoms/StructureDefinition/SymptomLogicalModel Version: 1.0.0
Standards status: Trial-use Active as of 2026-03-31 Maturity Level: 2 Computable Name: SymptomLogicalModel

The FHIR Symptoms Logical Model defines the conceptual representation of symptom data, independent of any particular FHIR resource. It specifies the key elements needed to describe symptoms, including onset, severity, course, body site, and qualitative descriptors. This logical model captures the semantics of symptoms and provides a consistent structure for implementers and modelers.

Symptomstring identifiercode symptomCodeboolean presentFlagPatient affectedPatientPatientOrRelatedPerson reporterAnnotation 0..* symptomDescriptioncode 0..1 clinicalCoursecode 0..1 trendCondition 0..* associatedConditionsKeyFeaturesLocationcode 1..1 codestring 0..* qualifierFrequencystring 0..1 qualityQuantity 0..1 quantityQualityAnnotation 0..1 notecode 0..1 scaleCodecode valueSeverityAnnotation 0..1 notecode 0..1 scaleCodecode valueImpactAnnotation 0..1 notecode 0..1 scaleCodecode valueSurroundingEventscode 0..* otherEventsTriggersOrExacerbatingFactorscode factorMedication 0..* relatedMedicationAnnotation 0..1 noteAlleviatingFactorscode factorMedication 0..* relatedMedicationAnnotation 0..1 noteTimingcode 0..1 speeddateTimeOrPeriod 0..1 onsetAnnotation 0..1 noteDuration 0..1 durationMetadatadateTime documentationDatedateTime issuedassociatedSymptoms0..*0..*0..*0..10..*0..10..10..10..*0..*0..1

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SymptomLogicalModel 0..* Element Symptom Logical Model

Elements defined in Ancestors:@id, extension
... identifier 1..1 string A unique string that identifies this instance of a symptom
... symptomCode 1..1 code Coded description of symptom
... presentFlag 1..1 boolean Whether the symptom is present or absent
... reporter[x] 1..1 The person who is reporting the symptom information
.... reporterPatient Patient
.... reporterRelatedPerson RelatedPerson
... symptomDescription 0..* Annotation Textual description of symptom as provided by patient or related person
... associatedSymptoms 0..* SymptomLogicalModel Other symptoms associated with this symptom. Used when a patient or caregiver reports multiple symptoms in an encounter and a system wants to link all of them together
... associatedConditions 0..* Condition Condition associated with this symptom. Used when a patient, caregiver, or clinician wants to link a symptom to a new or existing Condition.
... keyFeatures 1..1 BackboneElement Key Features
.... location 0..* BackboneElement Where the patient feels the symptom in the body.
..... code 1..1 code Coded description of the location.
..... qualifier 0..* string Qualifers of the location, eg. radiating down my leg
.... quality 0..* BackboneElement The patient's internal perception of the symptom.
..... note 0..1 Annotation Textual description of the symptom quality
..... scaleCode 0..1 code Code for the specific scale or assessment (if any) used to determine the quality
..... value 1..1 code Code that represents the symptom quality
.... severity 0..1 BackboneElement The intensity with which the patient experiences the symptom.
..... note 0..1 Annotation Textual description of the symptom severity
..... scaleCode 0..1 code Code for the specific scale or assessment if any used to determine the severity
..... value 1..1 code Code that represents the symptom severity
.... impact 0..* BackboneElement How the symptom is affecting the patient, either emotionally, mentally, or physically.
..... note 0..1 Annotation Textual description of the impact
..... scaleCode 0..1 code Code for the specific scale or assessment (if any) used to determine the impact
..... value 1..1 code Code that represents the impact
.... surroundingEvents 0..1 BackboneElement Events or circumstances related to symptom onset or intensity.
..... triggerOrExacerbatingFactors 0..* BackboneElement
...... factor 1..1 code Reference to the factor
...... relatedMedication[x] 0..* Medication that patient suggests/reports triggers or exacerbates the symptom
....... relatedMedicationMedicationStatement MedicationStatement
....... relatedMedicationMedicationAdministration MedicationAdministration
...... note 0..1 Annotation Information given about actions, conditions, events, or other factors
..... alleviatingFactors 0..* BackboneElement
...... factor 1..1 code Reference to the factor
...... note 0..1 Annotation Information given about actions, conditions, events, or other factors
...... relatedMedication[x] 0..* Medication that patient suggests/reports alleviating the symptom
....... relatedMedicationMedicationStatement MedicationStatement
....... relatedMedicationMedicationAdministration MedicationAdministration
..... otherEvents 0..* code Patient-reported actions that were occuring at time of symptom onset
.... frequency 0..1 BackboneElement How often the patient experiences the symptom i.e. expressed as 3x/day or 2x/week.
..... quality 0..1 string A qualitative expression of the frequency, eg. often
..... quantity 0..1 Quantity A quantitative expression of the frequency
... timing 0..1 BackboneElement
.... speedOfOnset 0..1 code Qualitative expression of how the patient perceived the rate of the symptom to become apparent.
.... onset[x] 0..1 Clinically relevant time or period for the symptom since first occurence.
..... onsetDateTime dateTime
..... onsetPeriod Period
.... note 0..1 Annotation Information given by the patient about the overall timing of the symptom.
.... duration 0..1 Duration The length of time the symptom persists in this instance of occurence.
... clinicalCourse 0..1 code Character of symptom onset.
... trend 0..1 code Intensity of symptom over time
... metadata 1..1 BackboneElement Non clinical information about the symptom
.... documentationDate 1..1 dateTime Date when symptom was documented in the system
.... issued 1..1 dateTime Date/time when the current version was made available.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SymptomLogicalModel 0..* Element Symptom Logical Model

Elements defined in Ancestors:@id, extension
... @id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... identifier 1..1 string A unique string that identifies this instance of a symptom
... presentFlag 1..1 boolean Whether the symptom is present or absent
... affectedPatient 1..1 Patient The patient who is experiencing the symptom
... reporter[x] 1..1 The person who is reporting the symptom information
.... reporterPatient Patient
.... reporterRelatedPerson RelatedPerson
... symptomDescription 0..* Annotation Textual description of symptom as provided by patient or related person
... associatedSymptoms 0..* SymptomLogicalModel Other symptoms associated with this symptom. Used when a patient or caregiver reports multiple symptoms in an encounter and a system wants to link all of them together
... associatedConditions 0..* Condition Condition associated with this symptom. Used when a patient, caregiver, or clinician wants to link a symptom to a new or existing Condition.
... keyFeatures 1..1 BackboneElement Key Features
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location 0..* BackboneElement Where the patient feels the symptom in the body.
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 code Coded description of the location.
..... qualifier 0..* string Qualifers of the location, eg. radiating down my leg
.... quality 0..* BackboneElement The patient's internal perception of the symptom.
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... note 0..1 Annotation Textual description of the symptom quality
..... scaleCode 0..1 code Code for the specific scale or assessment (if any) used to determine the quality
..... value 1..1 code Code that represents the symptom quality
.... severity 0..1 BackboneElement The intensity with which the patient experiences the symptom.
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... note 0..1 Annotation Textual description of the symptom severity
..... scaleCode 0..1 code Code for the specific scale or assessment if any used to determine the severity
..... value 1..1 code Code that represents the symptom severity
.... impact 0..* BackboneElement How the symptom is affecting the patient, either emotionally, mentally, or physically.
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... note 0..1 Annotation Textual description of the impact
..... scaleCode 0..1 code Code for the specific scale or assessment (if any) used to determine the impact
..... value 1..1 code Code that represents the impact
.... surroundingEvents 0..1 BackboneElement Events or circumstances related to symptom onset or intensity.
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... triggerOrExacerbatingFactors 0..* BackboneElement
...... @id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... factor 1..1 code Reference to the factor
...... relatedMedication[x] 0..* Medication that patient suggests/reports triggers or exacerbates the symptom
....... relatedMedicationMedicationStatement MedicationStatement
....... relatedMedicationMedicationAdministration MedicationAdministration
...... note 0..1 Annotation Information given about actions, conditions, events, or other factors
..... alleviatingFactors 0..* BackboneElement
...... @id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... factor 1..1 code Reference to the factor
...... note 0..1 Annotation Information given about actions, conditions, events, or other factors
...... relatedMedication[x] 0..* Medication that patient suggests/reports alleviating the symptom
....... relatedMedicationMedicationStatement MedicationStatement
....... relatedMedicationMedicationAdministration MedicationAdministration
..... otherEvents 0..* code Patient-reported actions that were occuring at time of symptom onset
.... frequency 0..1 BackboneElement How often the patient experiences the symptom i.e. expressed as 3x/day or 2x/week.
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... quality 0..1 string A qualitative expression of the frequency, eg. often
..... quantity 0..1 Quantity A quantitative expression of the frequency
... timing 0..1 BackboneElement
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... speedOfOnset 0..1 code Qualitative expression of how the patient perceived the rate of the symptom to become apparent.
.... onset[x] 0..1 Clinically relevant time or period for the symptom since first occurence.
..... onsetDateTime dateTime
..... onsetPeriod Period
.... note 0..1 Annotation Information given by the patient about the overall timing of the symptom.
.... duration 0..1 Duration The length of time the symptom persists in this instance of occurence.
... clinicalCourse 0..1 code Character of symptom onset.
... trend 0..1 code Intensity of symptom over time
... metadata 1..1 BackboneElement Non clinical information about the symptom
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... documentationDate 1..1 dateTime Date when symptom was documented in the system
.... issued 1..1 dateTime Date/time when the current version was made available.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This view is not supported for this profile because it is of an unsupported type

Summary

Mandatory: 0 element(15 nested mandatory elements)

Maturity: 2

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SymptomLogicalModel 0..* Element Symptom Logical Model

Elements defined in Ancestors:@id, extension
... identifier 1..1 string A unique string that identifies this instance of a symptom
... symptomCode 1..1 code Coded description of symptom
... presentFlag 1..1 boolean Whether the symptom is present or absent
... reporter[x] 1..1 The person who is reporting the symptom information
.... reporterPatient Patient
.... reporterRelatedPerson RelatedPerson
... symptomDescription 0..* Annotation Textual description of symptom as provided by patient or related person
... associatedSymptoms 0..* SymptomLogicalModel Other symptoms associated with this symptom. Used when a patient or caregiver reports multiple symptoms in an encounter and a system wants to link all of them together
... associatedConditions 0..* Condition Condition associated with this symptom. Used when a patient, caregiver, or clinician wants to link a symptom to a new or existing Condition.
... keyFeatures 1..1 BackboneElement Key Features
.... location 0..* BackboneElement Where the patient feels the symptom in the body.
..... code 1..1 code Coded description of the location.
..... qualifier 0..* string Qualifers of the location, eg. radiating down my leg
.... quality 0..* BackboneElement The patient's internal perception of the symptom.
..... note 0..1 Annotation Textual description of the symptom quality
..... scaleCode 0..1 code Code for the specific scale or assessment (if any) used to determine the quality
..... value 1..1 code Code that represents the symptom quality
.... severity 0..1 BackboneElement The intensity with which the patient experiences the symptom.
..... note 0..1 Annotation Textual description of the symptom severity
..... scaleCode 0..1 code Code for the specific scale or assessment if any used to determine the severity
..... value 1..1 code Code that represents the symptom severity
.... impact 0..* BackboneElement How the symptom is affecting the patient, either emotionally, mentally, or physically.
..... note 0..1 Annotation Textual description of the impact
..... scaleCode 0..1 code Code for the specific scale or assessment (if any) used to determine the impact
..... value 1..1 code Code that represents the impact
.... surroundingEvents 0..1 BackboneElement Events or circumstances related to symptom onset or intensity.
..... triggerOrExacerbatingFactors 0..* BackboneElement
...... factor 1..1 code Reference to the factor
...... relatedMedication[x] 0..* Medication that patient suggests/reports triggers or exacerbates the symptom
....... relatedMedicationMedicationStatement MedicationStatement
....... relatedMedicationMedicationAdministration MedicationAdministration
...... note 0..1 Annotation Information given about actions, conditions, events, or other factors
..... alleviatingFactors 0..* BackboneElement
...... factor 1..1 code Reference to the factor
...... note 0..1 Annotation Information given about actions, conditions, events, or other factors
...... relatedMedication[x] 0..* Medication that patient suggests/reports alleviating the symptom
....... relatedMedicationMedicationStatement MedicationStatement
....... relatedMedicationMedicationAdministration MedicationAdministration
..... otherEvents 0..* code Patient-reported actions that were occuring at time of symptom onset
.... frequency 0..1 BackboneElement How often the patient experiences the symptom i.e. expressed as 3x/day or 2x/week.
..... quality 0..1 string A qualitative expression of the frequency, eg. often
..... quantity 0..1 Quantity A quantitative expression of the frequency
... timing 0..1 BackboneElement
.... speedOfOnset 0..1 code Qualitative expression of how the patient perceived the rate of the symptom to become apparent.
.... onset[x] 0..1 Clinically relevant time or period for the symptom since first occurence.
..... onsetDateTime dateTime
..... onsetPeriod Period
.... note 0..1 Annotation Information given by the patient about the overall timing of the symptom.
.... duration 0..1 Duration The length of time the symptom persists in this instance of occurence.
... clinicalCourse 0..1 code Character of symptom onset.
... trend 0..1 code Intensity of symptom over time
... metadata 1..1 BackboneElement Non clinical information about the symptom
.... documentationDate 1..1 dateTime Date when symptom was documented in the system
.... issued 1..1 dateTime Date/time when the current version was made available.

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SymptomLogicalModel 0..* Element Symptom Logical Model

Elements defined in Ancestors:@id, extension
... @id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... identifier 1..1 string A unique string that identifies this instance of a symptom
... presentFlag 1..1 boolean Whether the symptom is present or absent
... affectedPatient 1..1 Patient The patient who is experiencing the symptom
... reporter[x] 1..1 The person who is reporting the symptom information
.... reporterPatient Patient
.... reporterRelatedPerson RelatedPerson
... symptomDescription 0..* Annotation Textual description of symptom as provided by patient or related person
... associatedSymptoms 0..* SymptomLogicalModel Other symptoms associated with this symptom. Used when a patient or caregiver reports multiple symptoms in an encounter and a system wants to link all of them together
... associatedConditions 0..* Condition Condition associated with this symptom. Used when a patient, caregiver, or clinician wants to link a symptom to a new or existing Condition.
... keyFeatures 1..1 BackboneElement Key Features
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location 0..* BackboneElement Where the patient feels the symptom in the body.
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 code Coded description of the location.
..... qualifier 0..* string Qualifers of the location, eg. radiating down my leg
.... quality 0..* BackboneElement The patient's internal perception of the symptom.
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... note 0..1 Annotation Textual description of the symptom quality
..... scaleCode 0..1 code Code for the specific scale or assessment (if any) used to determine the quality
..... value 1..1 code Code that represents the symptom quality
.... severity 0..1 BackboneElement The intensity with which the patient experiences the symptom.
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... note 0..1 Annotation Textual description of the symptom severity
..... scaleCode 0..1 code Code for the specific scale or assessment if any used to determine the severity
..... value 1..1 code Code that represents the symptom severity
.... impact 0..* BackboneElement How the symptom is affecting the patient, either emotionally, mentally, or physically.
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... note 0..1 Annotation Textual description of the impact
..... scaleCode 0..1 code Code for the specific scale or assessment (if any) used to determine the impact
..... value 1..1 code Code that represents the impact
.... surroundingEvents 0..1 BackboneElement Events or circumstances related to symptom onset or intensity.
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... triggerOrExacerbatingFactors 0..* BackboneElement
...... @id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... factor 1..1 code Reference to the factor
...... relatedMedication[x] 0..* Medication that patient suggests/reports triggers or exacerbates the symptom
....... relatedMedicationMedicationStatement MedicationStatement
....... relatedMedicationMedicationAdministration MedicationAdministration
...... note 0..1 Annotation Information given about actions, conditions, events, or other factors
..... alleviatingFactors 0..* BackboneElement
...... @id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... factor 1..1 code Reference to the factor
...... note 0..1 Annotation Information given about actions, conditions, events, or other factors
...... relatedMedication[x] 0..* Medication that patient suggests/reports alleviating the symptom
....... relatedMedicationMedicationStatement MedicationStatement
....... relatedMedicationMedicationAdministration MedicationAdministration
..... otherEvents 0..* code Patient-reported actions that were occuring at time of symptom onset
.... frequency 0..1 BackboneElement How often the patient experiences the symptom i.e. expressed as 3x/day or 2x/week.
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... quality 0..1 string A qualitative expression of the frequency, eg. often
..... quantity 0..1 Quantity A quantitative expression of the frequency
... timing 0..1 BackboneElement
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... speedOfOnset 0..1 code Qualitative expression of how the patient perceived the rate of the symptom to become apparent.
.... onset[x] 0..1 Clinically relevant time or period for the symptom since first occurence.
..... onsetDateTime dateTime
..... onsetPeriod Period
.... note 0..1 Annotation Information given by the patient about the overall timing of the symptom.
.... duration 0..1 Duration The length of time the symptom persists in this instance of occurence.
... clinicalCourse 0..1 code Character of symptom onset.
... trend 0..1 code Intensity of symptom over time
... metadata 1..1 BackboneElement Non clinical information about the symptom
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... documentationDate 1..1 dateTime Date when symptom was documented in the system
.... issued 1..1 dateTime Date/time when the current version was made available.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

openEHR View

This view is not supported for this profile because it is of an unsupported type

Summary

Mandatory: 0 element(15 nested mandatory elements)

Maturity: 2

 

Other representations of profile: CSV, Excel