From 50e66035ede2c05bbde9722b4a1f0d1f6ae56764 Mon Sep 17 00:00:00 2001 From: Vamsi Date: Mon, 27 Sep 2021 06:18:17 -0400 Subject: [PATCH 01/11] FHIR R4 Allergy resource initial commit --- content/soarian/r4/clinical.md | 11 + content/soarian/r4/clinical/summary.md | 9 + .../clinical/summary/allergy-intolerance.md | 121 +++++++ layouts/soarian/r4/clinical.html | 3 + layouts/soarian/r4/clinical/summary.html | 3 + layouts/soarian/r4/sidebar.html | 9 +- layouts/soarian/r4/summary.html | 5 + ...soarian_r4_examples_allergy_intolerance.rb | 295 ++++++++++++++++++ .../r4/soarian_allergy_intolerance.yaml | 83 +++++ 9 files changed, 538 insertions(+), 1 deletion(-) create mode 100644 content/soarian/r4/clinical.md create mode 100644 content/soarian/r4/clinical/summary.md create mode 100644 content/soarian/r4/clinical/summary/allergy-intolerance.md create mode 100644 layouts/soarian/r4/clinical.html create mode 100644 layouts/soarian/r4/clinical/summary.html create mode 100644 layouts/soarian/r4/summary.html create mode 100644 lib/resources/example_json/soarian_r4_examples_allergy_intolerance.rb create mode 100644 lib/resources/r4/soarian_allergy_intolerance.yaml diff --git a/content/soarian/r4/clinical.md b/content/soarian/r4/clinical.md new file mode 100644 index 000000000..920b8c09d --- /dev/null +++ b/content/soarian/r4/clinical.md @@ -0,0 +1,11 @@ +--- +title: Clinical | R4 API +layout: api +--- + +<%= render '/soarian/r4/clinical.*' %> + +## Summary +<%= render '/soarian/r4/clinical/summary.*' %> + +* [AllergyIntolerance](/soarian/r4/clinical/summary/allergy-intolerance) diff --git a/content/soarian/r4/clinical/summary.md b/content/soarian/r4/clinical/summary.md new file mode 100644 index 000000000..58487cc7f --- /dev/null +++ b/content/soarian/r4/clinical/summary.md @@ -0,0 +1,9 @@ +--- +title: Summary | R4 API +layout: api +--- + +<%= render '/soarian/r4/clinical/summary.*' %> + +* [AllergyIntolerance](../summary/allergy-intolerance) + diff --git a/content/soarian/r4/clinical/summary/allergy-intolerance.md b/content/soarian/r4/clinical/summary/allergy-intolerance.md new file mode 100644 index 000000000..96f3a787b --- /dev/null +++ b/content/soarian/r4/clinical/summary/allergy-intolerance.md @@ -0,0 +1,121 @@ +--- +title: AllergyIntolerance | R4 API +--- + +# AllergyIntolerance + +* TOC +{:toc} + +## Overview + + +The AllergyIntolerance resource provides the clinical assessment of a patient’s allergy when exposed to a specific substance or class of substance, including information about the adverse reaction. _Soarian Clinicals_® does not differentiate between an allergy and an intolerance. The term __allergy__ is used generically and may overlap with an __intolerance__. Substances include medications, foods, and environmental allergens (such as plants and animals). + +Allergy negation statements for No Known Allergies (NKA), No Known Drug Allergies (NKDA), and No Known Food Allergies (NKFA) are reported using the code element. If a patient has not been asked about their allergies, these statements are conveyed by the absence of information (empty query response). Allergy negation statements for latex and contrast are not coded and are conveyed in the response with the AllergyIntolerance.code.text element as __No known latex allergy (situation)__ or __No known contrast allergy (situation)__. + +_Soarian Clinicals_® supports a read-only Application Programming Interface (API). This API accepts `GET` and `POST` based [search] interactions. The response represents the most current information about the patient that is charted in _Soarian Clinicals_® at the time of the query. + +The search results include the following fields if they contain values: + +* [Allergy Id](https://hl7.org/fhir/R4/resource-definitions.html#Resource.id) +* [Clinical Status](https://hl7.org/fhir/R4/allergyintolerance-definitions.html#AllergyIntolerance.clinicalStatus) +* [Verification Status](https://hl7.org/fhir/R4/allergyintolerance-definitions.html#AllergyIntolerance.verificationStatus) +* [Category (medication, food, environment)](https://hl7.org/fhir/R4/allergyintolerance-definitions.html#AllergyIntolerance.category) +* [Allergy Code](https://hl7.org/fhir/R4/allergyintolerance-definitions.html#AllergyIntolerance.code) +* [Patient](https://hl7.org/fhir/R4/allergyintolerance-definitions.html#AllergyIntolerance.patient) +* [Adverse reaction](http://hl7.org/fhir/R4/allergyintolerance-definitions.html#AllergyIntolerance.reaction) + * [Manifestation](https://hl7.org/fhir/R4/allergyintolerance-definitions.html#AllergyIntolerance.reaction.manifestation) + * [Severity](https://hl7.org/fhir/R4/allergyintolerance-definitions.html#AllergyIntolerance.reaction.severity) + +## Terminology Bindings + +<%= terminology_table(:soarian_allergy_intolerance, :r4) %> + +## Search + +Search for AllergyIntolerance resources that meet the specified query parameters: + + GET /AllergyIntolerance?:parameters + +### Authorization Types + +<%= authorization_types(provider: true, patient: true)%> + +### Parameters + + Name | Required? | Type | Description +----------------|--------------------|-----------------|------------------------------------------------------------------------ + `_id` | This, or `patient` | [`token`] | The logical resource ID associated with the resource. + `patient` | This, or `_id` | [`reference`] | The patient who has the allergy. + `_revinclude` | No | [`_revinclude`] | A request to include any Provenance resource in the bundle that refers to an AllergyIntolerance resource in the search results. Only supported with Provenance. + +### Headers + +<%= headers fhir_json: true %> + +### Example Search by Patient + +#### Request + + GET https://fhir-myrecord-sc.cerner.com/r4/0e885770-571b-4c0c-b30f-21df9a058d0d/AllergyIntolerance?patient=A879904FD2FE4B2D90C89FDA84E1285F + +#### Response + +<%= headers status: 200 %> +<%= json(:SOARIAN_R4_ALLERGY_INTOLERANCE_SEARCH_BY_PT_ENTRY) %> + +Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site. + +### Example Search by ID + +#### Request + + GET https://fhir-myrecord-sc.cerner.com/r4/0e885770-571b-4c0c-b30f-21df9a058d0d/AllergyIntolerance?_id=A879904FD2FE4B2D90C89FDA84E1285F.ALG.17073 + +#### Response + +<%= headers status: 200 %> +<%= json(:SOARIAN_R4_ALLERGY_INTOLERANCE_SEARCH_BY_ID_ENTRY) %> + +Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site. + +### Errors + +The common [errors] and [OperationOutcomes] may be returned. + +## Retrieve by ID + +List an individual AllergyIntolerance resource by its ID: + + GET /AllergyIntolerance/:id + + +## Authorization Types + +<%= authorization_types(provider: true, patient: true)%> + +### Headers + +<%= headers fhir_json: true %> + +### Example + +#### Request + + GET https://fhir-myrecord-sc.cerner.com/r4/0e885770-571b-4c0c-b30f-21df9a058d0d/AllergyIntolerance/A879904FD2FE4B2D90C89FDA84E1285F.ALG.17073 + +#### Response + +<%= headers status: 200 %> +<%= json(:SOARIAN_R4_ALLERGY_INTOLERANCE_READ_BY_ID) %> + +Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site. + + +[`reference`]: https://hl7.org/fhir/r4/search.html#reference +[`token`]: https://hl7.org/fhir/R4/search.html#token +[`_revinclude`]: http://hl7.org/fhir/search.html#revinclude +[errors]: ../../#client-errors +[OperationOutcomes]: https://hl7.org/fhir/R4/operationoutcome.html +[search]: https://www.hl7.org/fhir/http.html#search diff --git a/layouts/soarian/r4/clinical.html b/layouts/soarian/r4/clinical.html new file mode 100644 index 000000000..4121833d6 --- /dev/null +++ b/layouts/soarian/r4/clinical.html @@ -0,0 +1,3 @@ +

Clinical

+ +

The Clinical category of HL7® FHIR® resources includes Summary, Diagnostics, Medications, Care Provision and Request & Response.

diff --git a/layouts/soarian/r4/clinical/summary.html b/layouts/soarian/r4/clinical/summary.html new file mode 100644 index 000000000..73b5e5b0e --- /dev/null +++ b/layouts/soarian/r4/clinical/summary.html @@ -0,0 +1,3 @@ +

Clinical resources are used throughout the patient record to record summaries of status and health history. This includes recording information around family history, allergies, conditions, and procedures, among others.

+ +

Implemented Resources

diff --git a/layouts/soarian/r4/sidebar.html b/layouts/soarian/r4/sidebar.html index fa276e50e..b18a9e87d 100644 --- a/layouts/soarian/r4/sidebar.html +++ b/layouts/soarian/r4/sidebar.html @@ -16,7 +16,14 @@

  • Individuals
  • Patient
  • - + +
  • +

    Clinical

    + +