FHIR R4 Symptoms Implementation Guide
1.0.0-ballot - STU 1 Ballot 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-ballot 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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Global Profiles

There are no Global profiles defined

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

Symptom System Capabilities

Capabilities required for a system exchanging symptoms data.

Structures: Logical Models

These define data models that represent the domain covered by this implementation guide in more business-friendly terms than the underlying FHIR resources.

ExclusionSymptomSignV0

Use to record a positive statement to explicitly record that a symptom or sign was reported as not present. Use to record exlicitly that a symptom or sign was absolutely not present. If this is not absolutely required, consider use of the 'Nil significant' data element within the CLUSTER.symptom_sign archetype. This archetype has been specifically designed to be used in the 'Structured detail' SLOT within the OBSERVATION.story archetype, but can also be used within other OBSERVATION or CLUSTER archetypes, where clinically appropriate.

Symptom Logical Model

A logical model showing the elements of a Symptom that have been deemed important and relevant for capture and exchange.

SymptomSignV2

Use to record details about a single episode of a symptom or reported sign in an individual, as reported by the individual, parent, care-giver or other party. It may be recorded by a clinician as part of a clinical history record as reported to them, observed by the clinician or self-recorded as part of a clinical questionnaire or personal health record. A complete clinical history or patient story may include varying level of details about multiple episodes of an identified symptom or reported sign, as well as multiple symptoms/signs.

This archetype has been designed to record the positive presence of the symptom or sign as part of history taking using OBSERVATION.story, or in conjunction with a positive response to OBSERVATION.symptom_sign_screening.

In the purest sense, symptoms are subjective observations of a physical or mental disturbance and signs are objective observations of the same, as experienced by an individual and reported to the history taker by the same individual or another party. From this logic it follows that we will need two archetypes to record clinical history - one for reported symptoms and another for reported signs. In reality this is impractical as it will require clinical data entry into either one of these models which adds signficant overheads to modellers and those entering data. In addition, there is often overlap in clinical concepts - for example, is previous vomiting or bleeding to be categorised as a symptom or reported sign? In response, this archetype has been specifically designed to provide a single information model that allows for recording of the entire continuum between clearly identifiable symptoms and reported signs.

This archetype has been intended to be used as a generic pattern for all symptoms and reported signs. The 'Specific details' SLOT can be used to extend the archetype to include additional, specific data elements for more complex symptoms or signs.

This archetype has been specifically designed to be used in the 'Structured detail' SLOT within the OBSERVATION.story archetype, but can also be used within other OBSERVATION or CLUSTER archetypes and in the 'Associated symptom/sign' or 'Previous episode' SLOT within other instances of this CLUSTER.symptom_sign archetype.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

Assessment Scale Collection Observation

A point in time collection of observations for a patient. This profile is used for exchanging a set of observation data collected through the use of a structured resource (e.g., assessment tool, instrument, or screen) with multiple questions. NOTE: This profile is a universal flavour of the PACIO PFE Personal Functioning and Engagement Collection Observation profile.

Assessment Scale Single Observation

An exchange of post-acute care observation for a patient. This profile is used for exchanging an observation for a single question generally included in a structured resource (e.g., assessment tool, instrument, or screen). NOTE: This profile is a universal flavour of the PACIO PFE Personal Functioning and Engagement Single Observation profile.

Functional Assessment Collection

A collection of observations related to a functional assessment of a patient. This profile is used for exchanging a set of functional data.

Functional Assessment Single Observation

A single observation related to a functional assessment of a patient. This profile is used for exchanging an observatoin for a single question.

Symptom Absent Observation

Used to record the absence of a Symptom as reported by a patient or their caregiver.

Symptom Observation

Used to record the presence of a Symptom as reported by the patient or a patient's caregiver. The Symptom observation contains all information given about a patient's symptoms.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

Assessment Scale Information

Information about the specific scale or assessment used to determine the value. This can be either just a code that represents the assessment scale or can be a reference to an Assessment Scale Collection.

Functional Assessment

Reference to a complete functional assessment collection.

Surrounding Event Medication

Medication that when taken affecting the factor

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Affective Grade

Set of codes from LOINC that describe a patient's affective grade

Alleviating Factor Codes

Set of SNOMED codes to describe factors which alleviate the symptom.

Clinical Course Codes

Set of SNOMED codes to describe the clinical course of the symptom.

Common Set of Symptom Codes

An initial set of Symptom Codes representing the most common symptoms.

EffectVS

ValueSet for Perceived effect of the modifying factor on the symptom or sign.

EpisodicityVS

ValueSet for Category of this episode for the identified symptom or sign.

ExcludedSymptomVS

ValueSet for Identification of the specific symptom to which the Exclusion Statement applies.

Frequency Codes

Set of SNOMED codes to describe the frequency of experiencing the symptom.

Functional Classification Codes

The set of codes from WHO's International Classification of Functioning, Disability, and Health code system.

OccurrenceVS

ValueSet for Type of occurrence for this symptom or sign?

Other Event Codes

Set of SNOMED codes to describe other events which were occurring at the same time as the symptom.

ProgressionVS

ValueSet for Description progression of the symptom or sign at the time of reporting.

Quality Codes

Set of SNOMED codes to describe the symptom quality.

Severity Codes

Set of SNOMED codes to describe the symptom severity.

SeverityCategoryVS

ValueSet for Category representing the overall severity of the symptom or sign.

Speed of Onset

Set of codes from SNOMED that describe the speed of onset of a patient's symptom

Trend Codes

Set of SNOMED codes to describe the trend of the symptom.

Triggers or Exacerbating Factor Codes

Set of SNOMED codes to describe triggers or factors which exacerbate the symptom.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

EffectCS

CodeSystem for Perceived effect of the modifying factor on the symptom or sign.

EpisodicityCS

CodeSystem for Category of this episode for the identified symptom or sign.

OccurrenceCS

CodeSystem for Type of occurrence for this symptom or sign?

ProgressionCS

CodeSystem for Description progression of the symptom or sign at the time of reporting.

SeverityCategoryCS

CodeSystem for Category representing the overall severity of the symptom or sign.

Temporary Symptom Codes

A code system that has codes for use in the IG that will eventually be migrated to other code systems such as LOINC or THO.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

AbdominalDiscomfortSymptom

Abdominal Discomfort

AbdominalPainSymptom

Abdominal pain

AdmissionsPerson

Admission to Hospital

AppetiteFunctionalAssessmentCollection

Collection of appetite assessment

AppetiteFunctionalAssessmentScale

Rating of appetite loss

ChestPainSymptom

Chest pain

ChillSymptomAbsence

Absence of chills

ConstipationSymptom

Constipation

CoughSymptom

Cough

DizzinessSymptom

Dizziness

FaintingSymptomAbsence

No fainting

FatigueSymptom

Fatigue

FeverSymptom

Fever

FeverSymptomAbsence

Absence of fever

HearingLossSymptom

Hearing Loss

IVMorphineDoseage

Dose of IV morphine

InitialPainAssessmentCollection

Collection of rating of abdominal cramping pain

InitialPainAssessmentScale

Rating of abdominal cramping pain

JaneDoe

Jane Doe - shortness of breath

JohnDoe

John Doe - dizziness

MedicatedAbdominalPainSymptom

Abdominal pain

MedicatedPainAssessmentCollection

Collection of rating of abdominal cramping pain

MedicatedPainAssessmentScale

Rating of abdominal cramping pain

MrDoe

Mr. Doe - Oncology

NauseaSymptomAbsence

Absense of nausea

RectalBleedingSymptomAbsence

Absence of rectal bleeding

ShortnessOfBreathPHSymptom

Shortness of breath

ShortnessOfBreathSymptom

Shortness of breath

TrishDoe

Trish Doe - Public Health

Type2DiabetesMellitus

Type 2 Diabetes

UnconsciousnessSymptomAbsence

No loss of consciousness

UnmedicatedAbdominalPainSymptom

Abdominal pain

UnmedicatedPainAssessmentCollection

Collection of rating of abdominal cramping pain

UnmedicatedPainAssessmentScale

Rating of abdominal cramping pain

WeightLossSymptom

Constipation