Review and Updates for FamilyMemberHistory (#1013)

* review and broken links for family member history * removed modifers and extensions * formatting on parameters table * column alignment on plain text table * PRODOC-203264: Style and formatting edits. --------- Co-authored-by: Deitrich, Casey <[email protected]>
cerner · Nov 20, 2023 · bec86f5 · bec86f5
1 parent 4a925a3
commit bec86f5
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 65 deletions.
diff --git a/content/millennium/r4/clinical/summary/family-member-history.md b/content/millennium/r4/clinical/summary/family-member-history.md
@@ -9,15 +9,15 @@ title: FamilyMemberHistory | R4 API
 
 ## Overview
 
-The FamilyMemberHistory resource represents family history for a given patient. It may provide a list of conditions associated to a patient's family member or the absence of a condition on a given individual. In other cases, the resource may indicate that there is no relevant family history, no significant history for a given relative, or that the patient’s family history is unknown or unable to obtain.
+The FamilyMemberHistory resource represents family history for a given patient. The resource may provide a list of conditions associated with a patient's family member or the absence of a condition on a given individual. In other cases, the resource may indicate that no relevant family history exists, no significant history for a given relative exists, or the patient’s family history is unknown or unobtainable.
 
-The resource should be leveraged as a snapshot in time and new data should be consistently retrieved through the API rather than stored within an application. There may be instances where a relative had an associated condition removed from the patient’s chart which would then no longer be exposed on a subsequent transaction. It is crucial that the data be refreshed with every interaction.
+The resource should be used as a snapshot in time and new information should be consistently retrieved through the API rather than stored in an application. In some instances, a relative could have an associated condition removed from the patient’s chart, which would then no longer be exposed on a subsequent transaction. Information must be refreshed with every interaction.
 
-It is recommended that an update to FamilyMemberHistory contain all relevant data that previously existed on the resource to ensure that data remains populated in the patient's chart (e.g., FamilyMemberHistory.sex, FamilyMemberHistory.bornDate, FamilyMemberHistory.condition.onsetDate, etc.). The absence of this optional information may result in the removal of data from the patient's chart.
+Oracle Cerner recommends that an update to FamilyMemberHistory contains all relevant information that previously existed on the resource to ensure that information remains populated in the patient's chart (for example, FamilyMemberHistory.sex, FamilyMemberHistory.bornDate, FamilyMemberHistory.condition.onsetDate, and so on). The absence of this optional information may remove the existing information from the patient's chart.
 
 The following fields are returned if valued:
 
-* [Id](https://hl7.org/fhir/r4/resource-definitions.html#Resource.id){:target="_blank"}
+* [ID](https://hl7.org/fhir/r4/resource-definitions.html#Resource.id){:target="_blank"}
 * [Status](https://hl7.org/fhir/r4/familymemberhistory-definitions.html#FamilyMemberHistory.status){:target="_blank"}
 * [Data Absent Reason](https://hl7.org/fhir/r4/familymemberhistory-definitions.html#FamilyMemberHistory.dataAbsentReason){:target="_blank"}
 * [Patient](https://hl7.org/fhir/r4/familymemberhistory-definitions.html#FamilyMemberHistory.patient){:target="_blank"}
@@ -28,84 +28,69 @@ The following fields are returned if valued:
 * [Born](https://hl7.org/fhir/r4/familymemberhistory-definitions.html#FamilyMemberHistory.born_x_){:target="_blank"}
 * [Age](https://hl7.org/fhir/r4/familymemberhistory-definitions.html#FamilyMemberHistory.age_x_){:target="_blank"}
 * [Deceased](https://hl7.org/fhir/r4/familymemberhistory-definitions.html#FamilyMemberHistory.deceased_x_]){:target="_blank"}
-  * [Precision Extension](#extensions){:target="_blank"}
-* [Extension](#extensions){:target="_blank"}
-  * [Patient Adopted](#extensions){:target="_blank"}
+  * [Precision Extension](https://hl7.org/fhir/extensibility.html#Extension){:target="_blank"}
+* [Extension](https://hl7.org/fhir/extensibility.html#Extension){:target="_blank"}
+  * [Patient Adopted](https://hl7.org/fhir/extensibility.html#Extension){:target="_blank"}
 * [Condition](https://hl7.org/fhir/r4/familymemberhistory-definitions.html#FamilyMemberHistory.condition){:target="_blank"}
-  * [Id](https://hl7.org/fhir/R4/element-definitions.html#Element.id){:target="_blank"}
+  * [ID](https://hl7.org/fhir/R4/element-definitions.html#Element.id){:target="_blank"}
   * [Code](https://hl7.org/fhir/r4/familymemberhistory-definitions.html#FamilyMemberHistory.condition.code){:target="_blank"}
   * [Onset](https://hl7.org/fhir/familymemberhistory-definitions.html#FamilyMemberHistory.condition.onset_x_){:target="_blank"}
-     * [Precision Extension](#extensions){:target="_blank"}
+     * [Precision Extension](https://hl7.org/fhir/extensibility.html#Extension){:target="_blank"}
   * [Note](https://hl7.org/fhir/r4/familymemberhistory-definitions.html#FamilyMemberHistory.condition.note){:target="_blank"}
-  * [Modifier Extension](#modifier-extensions){:target="_blank"}
-     * [Condition Result](#custom-extensions){:target="_blank"}
-     * [Condition Lifecycle Status](#extensions){:target="_blank"}
-  * [Extension](#extensions){:target="_blank"}
-     * [Condition Course](#extensions){:target="_blank"}
-     * [Family Member History Severity](#extensions){:target="_blank"}
+  * [Modifier Extension](https://hl7.org/fhir/r4/domainresource-definitions.html#DomainResource.modifierExtension){:target="_blank"}
+     * [Condition Result](https://hl7.org/fhir/r4/domainresource-definitions.html#DomainResource.modifierExtension){:target="_blank"}
+     * [Condition Lifecycle Status](https://hl7.org/fhir/r4/domainresource-definitions.html#DomainResource.modifierExtension){:target="_blank"}
+  * [Extension](https://hl7.org/fhir/r4/domainresource-definitions.html#DomainResource.extension){:target="_blank"}
+     * [Condition Course](https://hl7.org/fhir/extensibility.html#Extension){:target="_blank"}
+     * [Family Member History Severity](https://terminology.hl7.org/CodeSystem-v3-RoleCode.html){:target="_blank"}
 
 
 ## Terminology Bindings
 
 <%= terminology_table(:family_member_history, :r4) %>
 
-## Modifier Extensions
-
-* [Condition Result]
-* [Condition Lifecycle Status]
-
-## Extensions
-
-* [Patient Adopted]
-* [Precision Extension]
-* [Condition Course]
-* [Family Member History Severity]
-
 ## Custom Modifier Extensions and Extensions
 
-URLs for custom extensions are defined as `https://fhir-ehr.cerner.com/r4/StructureDefinition/{id}`
+URLs for custom extensions are defined as `https://fhir-ehr.cerner.com/r4/StructureDefinition/{ID}`
 
 ### Modifier Extensions
 
-ID              | Value\[x] Type                                                    | Description
+ID                           | Value\[x] Type                                                              | Description
 -----------------------------|-----------------------------------------------------------------------------|-----------------------------------------------
-`condition-result`           | [`CodeableConcpet`](https://hl7.org/fhir/r4/datatypes.html#codeableconcept) | Indication of the presence (positive) or absence (negative) of a given condition.
-`condition-lifecycle-status` | [`CodeableConcpet`](https://hl7.org/fhir/r4/datatypes.html#codeableconcept) | Indication of whether a condition is active, inactive, resolved, etc.
+`condition-result`           | [`CodeableConcept`](https://hl7.org/fhir/r4/datatypes.html#codeableconcept) | Indicates the presence (positive) or absence (negative) of a given condition.
+`condition-lifecycle-status` | [`CodeableConcept`](https://hl7.org/fhir/r4/datatypes.html#codeableconcept) | Indicates whether a condition is active, inactive, resolved, and so on.
 
 
 ### Extensions
 
-ID              | Value\[x] Type                                                    | Description
------------------------------|-----------------------------------------------------------------------------|-----------------------------------------------
-`patient-adopted`            | [`Boolean`](https://hl7.org/fhir/r4/datatypes.html#boolean)                 | Indication of whether a patient is adopted. Only returned when true.
-`precision`                  | [`CodeableConcpet`](https://hl7.org/fhir/r4/datatypes.html#codeableconcept) | Indication of the precision of a given value.
-`condition-course`           | [`CodeableConcpet`](https://hl7.org/fhir/r4/datatypes.html#codeableconcept) | Indication of a condition's progress since diagnosis.
+ID                             | Value\[x] Type                                                              | Description
+-------------------------------|-----------------------------------------------------------------------------|-----------------------------------------------
+`patient-adopted`              | [`Boolean`](https://hl7.org/fhir/r4/datatypes.html#boolean)                 | Indicates whether a patient is adopted. Only returned when true.
+`precision`                    | [`CodeableConcept`](https://hl7.org/fhir/r4/datatypes.html#codeableconcept) | Indicates the precision of a given value.
+`condition-course`             | [`CodeableConcept`](https://hl7.org/fhir/r4/datatypes.html#codeableconcept) | Indicates a condition's progress since diagnosis.
+`familymemberhistory-severity` | [`CodeableConcept`](https://hl7.org/fhir/r4/datatypes.html#codeableconcept) | Indicates the seriousness or health impact of the family member's condition.
 
 ## Search
 
-Search for FamilyMemberHistories that meet supplied query parameters:
+Search for the family member histories that meet the supplied query parameters.
 
     GET /FamilyMemberHistory?:parameters
 
-_Implementation Notes_
+_Notes_
 
-* FamilyMemberHistories with the 'FAMMEMB' relation are sometimes system generated.
+* Family member histories with the 'FAMMEMB' relation are sometimes system generated.
 
 ### Authorization Types
 
 <%= authorization_types(provider: true, patient: true, system: true) %>
 
 ### Parameters
 
-Name      | Required?       | Type          | Description
+Name      | Required        | Type          | Description
 ----------|-----------------|---------------|-------------------------------------------------------
-`_id`     | This or patient | [`token`]     | The logical resource id associated with the resource.
-`patient` | This or _id     | [`reference`] | The identity of a subject to list family member history items for. Example: `12345`
-`status`  | No              | [`token`] | The status of the record of the family history of a specific family member.
-
-_Implementation Notes_
-
-`status` may only be provided when the `patient` search parameter is provided
+`_id`     | Conditionally   | [`token`]     | The logical resource ID associated with the resource. This parameter is required if `patient` is not used. 
+`patient` | Conditionally   | [`reference`] | The identity of a subject to list family member history items for. This parameter is required if `_id_` is not used. Example: `12345`
+`status`  | No              | [`token`]     | The record status for a specific family member. This parameter is only provided when the `patient` search parameter is used.
 
 ### Headers
 
@@ -128,13 +113,13 @@ _Implementation Notes_
 
 The common [errors] and [OperationOutcomes] may be returned.
 
-## Retrieve by id
+## Retrieve by ID
 
-List an individual FamilyMemberHistory by its id:
+List an individual family member history by its ID.
 
-    GET /FamilyMemberHistory/:id
+    GET /FamilyMemberHistory/:ID
 
-_Implementation Notes_
+_Notes_
 
 * FamilyMemberHistories with the 'FAMMEMB' relation are sometimes system generated.
 
@@ -165,14 +150,14 @@ The common [errors] and [OperationOutcomes] may be returned.
 
 ## Create
 
-Create a new FamilyMemberHistory.
+Create a new family member history.
 
     POST /FamilyMemberHistory
 
-_Implementation Notes_
+_Notes_
 
-* Only the body fields mentioned below are supported. Unsupported fields will be ignored.
-* Conditions cannot be added while creating the FamilyMemberHistory.
+* Only the body fields below are supported. Unsupported fields are ignored.
+* Conditions cannot be added while creating the family member history.
 
 ### Authorization Types
 
@@ -218,14 +203,14 @@ The common [errors] and [OperationOutcomes] may be returned.
 
 ## Update
 
-Update a FamilyMemberHistory.
+Update a family member history.
 
-    PUT /FamilyMemberHistory/:id
+    PUT /FamilyMemberHistory/:ID
 
-_Implementation Notes_
+_Notes_
 
-* Conditions can be removed from a FamilyMemberHistory by setting the 'condition-lifecycle-status' modifierExtension to 'entered-in-error' with system 'http://terminology.hl7.org/CodeSystem/condition-ver-status'. Only existing conditions can be removed; condition id must be provided.
-* An update should only be performed directly after a FamilyMemberHistory is retrieved. If a condition.id is returned on the get operation, it MUST be provided on the subsequent update and must match the condition.id returned from the get.
+* Conditions can be removed from a family member history if you set the 'condition-lifecycle-status' modifierExtension to 'entered-in-error' with system 'http://terminology.hl7.org/CodeSystem/condition-ver-status'. Only existing conditions can be removed and condition ID must be provided.
+* An update should only be performed directly after a family member history is retrieved. If a condition ID is returned for the `GET` request, the ID must be provided on the subsequent update and must match the condition ID returned from the `GET`.
 
 ### Authorization Types
 

diff --git a/lib/resources/r4/family_member_history.yaml b/lib/resources/r4/family_member_history.yaml
@@ -20,7 +20,7 @@ fields:
   required: 'Yes'
   type: id
   url: https://www.hl7.org/fhir/r4/resource-definitions.html#Resource.id
-  description: The logical id of the resource to update.
+  description: The logical ID of the resource to update.
   action: update
   example: |
     {
@@ -151,7 +151,7 @@ fields:
     terminology:
       - display: V3 Value SetFamilyMember
         system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
-        info_link: https://hl7.org/fhir/v3/FamilyMember/vs.html
+        info_link: https://terminology.hl7.org/CodeSystem-v3-RoleCode.html
 
 - name: sex
   type: CodeableConcept
@@ -284,7 +284,7 @@ fields:
   type: BackboneElement
   required: 'No'
   description: The significant Conditions (or condition) that the family member had.
-  url: https://hl7.org/fhir/familymemberhistory-definitions.html#FamilyMemberHistory.condition
+  url: https://hl7.org/fhir/R4/familymemberhistory-definitions.html#FamilyMemberHistory.condition
   action:
     - update
   note: Each item in the list must represent a distinct condition.
@@ -429,7 +429,7 @@ fields:
   type: CodeableConcept
   required: 'Yes'
   description: Indication of the presence (positive) or absence (negative) of a given condition. Must be provided. The result may indicate the absence of a condition which may lead to different clinical decisions than if the result were positive.
-  url: https://hl7.org/fhir/backboneelement-definitions.html#BackboneElement.modifierExtension
+  url: https://hl7.org/fhir/R4/backboneelement-definitions.html#BackboneElement.modifierExtension
   action:
     - update
     - terminology
@@ -460,7 +460,7 @@ fields:
   type: CodeableConcept
   required: 'No'
   description: Indication of whether a condition is active, inactive, resolved, etc. The lifecycle status indicates the relevance of a given condition. If a condition is resolved or inactivated, it may no longer be clinically relevant. The lifecycle status may not be returned if it is not applicable to the given condition.
-  url: https://hl7.org/fhir/backboneelement-definitions.html#BackboneElement.modifierExtension
+  url: https://hl7.org/fhir/R4/backboneelement-definitions.html#BackboneElement.modifierExtension
   action:
     - update
     - terminology