This page is part of the Symptoms Data Standards (v1.0.0: STU 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Exchange Patterns

Overview

This guide presumes that systems that are exchanging symptom data shall do so using the FHIR RESTful API. If you are using the RESTful API, then the conformance statements in this section are mandatory.

Symptoms Sending

Symptoms and Absent Symptoms SHALL be sent using the CREATE and UPDATE interactions.

If a Symptom was sent with a pre-coordinated concept or text, the original concept SHALL be sent as an additional Coding with the userSelected element set to 'true' or as CodeableConcept.text. This would be in addition to the post-coordinated set of terms that are sent in the Symptoms profile.

Symptoms Reading

Symptoms and Absent Symptoms SHALL be retrieved using the READ interaction.

Symptoms Searching

Systems SHOULD allow for Symptoms and Absent Symptoms to be searched for using the SEARCH interaction.

If a system supports Searching, then it SHALL support the following search parameters:

• category - searching for observations that are of category symptoms, i.e. all symptoms and absent symptoms
• patient - searching for a specific patient
• code - searching for observations that are either a symptom (LOINC code 75325-1) or an absent symptom (LOINC code 111551-8)
• code-value-concept - searching for whether a patient has or does not have a specific symptom
• date - searching for a symptom that was recorded as occurring in a period that includes the given date