Review and Updates to Goal #1027

RicardoCrespo-ora · 2023-12-08T15:18:20Z

Description

In preparation for migrating to Oracle docs, we are reviewing and correcting any inconsistencies, typos, broken links, etc. This PR aims to correct any of the above that needs to be addressed within Communication and any other information directly referenced by it.

Disclaimer and Error section reposition to show one time only in Overview

Before

After

Minor Capitalization

Before

After

Formatting to Parameters and Notes

Before

After

Swapped order of Operations from Revinclude, Patient, ID, Patient and Target Date to ID, Patient, Patient and Target Date, Revinclude

Before

After

PR Checklist

Screenshot(s) of changes attached before changes merged.
Screenshot(s) of changes attached after changes merged and published.

cldeitrich

OHAIUAD-205005: Approved for style.

amcginn · 2023-12-14T19:52:24Z

content/millennium/dstu2/care-provision/goal.md

@@ -9,11 +9,11 @@ title: Goal | DSTU 2 API

 ## Overview

-The Goal resource describes intended objectives for a patient.  A Goal is typically expressed as a desired outcome or health state to be achieved by a patient over a period or at a specific point in time.  A Goal may address preventative health or mitigation of a diagnosis or problem.  Goals can be non-health care related (e.g. dance at a wedding).
+The Goal resource describes intended objectives for a patient. A goal is typically expressed as a desired outcome or health state to be achieved by a patient over a period or at a specific point in time. A goal may address preventative health or mitigation of a diagnosis or problem. Goals can be nonhealthcare related (for example, dance at a wedding).


Suggested change

The Goal resource describes intended objectives for a patient. A goal is typically expressed as a desired outcome or health state to be achieved by a patient over a period or at a specific point in time. A goal may address preventative health or mitigation of a diagnosis or problem. Goals can be nonhealthcare related (for example, dance at a wedding).

The Goal resource describes intended objectives for a patient. A goal is typically expressed as a desired outcome or health state to be achieved by a patient over a period or at a specific point in time. A goal may address preventative health or mitigation of a diagnosis or problem. Goals can be non-healthcare related (for example, dance at a wedding).

amcginn · 2023-12-14T19:54:34Z

content/millennium/dstu2/care-provision/goal.md

+-------------------|------------------|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+ `_id`             | Conditionally    | [`token`]     | The logical resource ID associated with the goal. This parameter is required if `patient` or `subject` are not used. Example: `_id=7891`
+ `patient`         | Conditionally    | [`reference`] | The patient who has the goal. This parameter is required if `_id` or `subject` are not used. Example: `patient=12345`
+ `subject:Patient` | Condtionally     | [`reference`] | The subject who this goal is intended for. Must represent a Patient resource. May use the `:Patient` modifier. This parameter is required if `_id` or `patient` are not used. Example: `subject=Patient/12345` or `subject:Patient=12345`


we should remove the modifier on the field name, since it is not required and is included in the description and examples.

also, pluralize "Example:"

amcginn · 2023-12-14T20:13:41Z

content/millennium/r4/clinical/care-provision/goal.md


-    GET /Goal/:id
+    GET /Goal/:ID


this is fine to be lowercase since it references the field value

amcginn · 2023-12-14T20:14:11Z

content/millennium/r4/clinical/care-provision/goal.md


 #### Request

-    GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?patient=12724069&target-date=gt2021-01-12
+    GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?_id=498290085&_revinclude=Provenance:target


let's be consistent on open vs ehr

amcginn · 2023-12-14T20:15:35Z

content/millennium/r4/clinical/care-provision/goal.md

+  * Alternatively, it may be provided twice with `le`, `lt`, `ge`, or `gt` prefixes to search for goals within a specific range. The date and prefix pairs must create a closed range.
+* The `_revinclude` parameter: 
+  * May be provided once with the `Provenance:target` value. Example: `_revinclude=Provenance:target`
+  * May be provided with the `_id/patient` parameter. Example: `_id=178866310&_revinclude=Provenance:target`


split _id and patient into two coded fields

kckeim

Everything else I'd have caught was something that Aaron saw, or too small of a nit to care about right now.

kckeim · 2023-12-14T19:59:26Z

content/millennium/r4/clinical/care-provision/goal.md

@@ -9,22 +9,22 @@ title: Goal | R4 API

 ## Overview

-The Goal resource describes intended objectives for a patient. A Goal is typically expressed as a desired outcome or health state to be achieved by a patient over a period or at a specific point in time. A Goal may address preventative health or mitigation of a diagnosis or problem. Goals can be non-health care related (e.g. dance at a wedding).
+The Goal resource describes intended objectives for a patient. A goal is typically expressed as a desired outcome or health state to be achieved by a patient over a period or at a specific point in time. A goal may address preventative health or mitigation of a diagnosis or problem. Goals can be nonhealthcare related (for example, dance at a wedding).


Same fix needed on both resources, as Aaron mentioned.
nonhealthcare -> non-healthcare

kckeim · 2023-12-14T21:45:42Z

content/millennium/dstu2/care-provision/goal.md

+* [Goal ID](http://hl7.org/fhir/dstu2/resource-definitions.html#Resource.id){:target="_blank"}
 * [Subject (patient)](http://hl7.org/fhir/DSTU2/goal-definitions.html#Goal.subject){:target="_blank"}
 * [Start date](http://hl7.org/fhir/DSTU2/goal-definitions.html#Goal.start_x_){:target="_blank"}
 * [Target date](http://hl7.org/fhir/DSTU2/goal-definitions.html#Goal.target_x_){:target="_blank"}


https-ify, please - check field links + trailing file links in both files.

* Updated MedicationAdminstration R4 Resource (#1010) * Updated MedicationAdministration DSTU2 Resource (#1011) * Review and Updates to Goal (#1027) * Review and Updates to Communication (#1022) * dstu2 Practitioner updates (#1014) * R4 Practitioner updates (#1015) * Person updates for DSTU2 and R4 (#1009) * StructureDefinition updates (#1012) * Updated Medication Order DSTU2 Resource (#1020) * Updated MedicationStatement DSTU2 Resource (#1021) * Updated MedicationRequest R4 Resource (#1019) * Updated Provenance R4 Resource (#1018) * DSTU 2 Patient updates (#1023) * R4 Patient formatting and standard updates (#1028) * R4 Observation,DocumentReference Documentation Updates (#1031) * R4 Encounter Period StartDateTime Sort Update (#1033) * updated Location type search parameter and examples for physicalType (#1034) * [R4][DiagnosticReport][DocumentReference] support search by _lastUpdated (#1032) * [R4][Immunization] Support search by _lastUpdated (#1029) * R4 Binary Autogen CCD add encounter parameter (#1035) * [R4][Immunization] Documentation Update (#1036)

SukeshKonjeti · 2024-02-02T11:51:22Z

after changes published

Updates and revisions to Goal

d20968e

RicardoCrespo-ora requested review from gmodrogan, AlexandruBasarab, napster235, amcginn, krycunn, kckeim and cldeitrich December 8, 2023 15:26

RicardoCrespo-ora added R4 Applies to R4 FHIR resources DSTU2 Applies to DSTU2 FHIR resources labels Dec 8, 2023

OHAIUAD-205005: Style edits.

1b71c31

cldeitrich approved these changes Dec 13, 2023

View reviewed changes

amcginn reviewed Dec 14, 2023

View reviewed changes

amcginn approved these changes Dec 14, 2023

View reviewed changes

kckeim approved these changes Dec 14, 2023

View reviewed changes

suggestions and fixes

d85d0db

RicardoCrespo-ora merged commit c706b3b into main Dec 15, 2023
1 check passed

RicardoCrespo-ora deleted the goal-docs-migrate branch December 15, 2023 15:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Review and Updates to Goal #1027

Review and Updates to Goal #1027

RicardoCrespo-ora commented Dec 8, 2023 •

edited

Loading

cldeitrich left a comment

amcginn Dec 14, 2023

amcginn Dec 14, 2023

amcginn Dec 14, 2023

amcginn Dec 14, 2023

amcginn Dec 14, 2023

kckeim left a comment

kckeim Dec 14, 2023

kckeim Dec 14, 2023

SukeshKonjeti commented Feb 2, 2024

	The Goal resource describes intended objectives for a patient. A goal is typically expressed as a desired outcome or health state to be achieved by a patient over a period or at a specific point in time. A goal may address preventative health or mitigation of a diagnosis or problem. Goals can be nonhealthcare related (for example, dance at a wedding).
	The Goal resource describes intended objectives for a patient. A goal is typically expressed as a desired outcome or health state to be achieved by a patient over a period or at a specific point in time. A goal may address preventative health or mitigation of a diagnosis or problem. Goals can be non-healthcare related (for example, dance at a wedding).

Review and Updates to Goal #1027

Review and Updates to Goal #1027

Conversation

RicardoCrespo-ora commented Dec 8, 2023 • edited Loading

Description

Disclaimer and Error section reposition to show one time only in Overview

Minor Capitalization

Formatting to Parameters and Notes

Swapped order of Operations from Revinclude, Patient, ID, Patient and Target Date to ID, Patient, Patient and Target Date, Revinclude

PR Checklist

cldeitrich left a comment

Choose a reason for hiding this comment

amcginn Dec 14, 2023

Choose a reason for hiding this comment

amcginn Dec 14, 2023

Choose a reason for hiding this comment

amcginn Dec 14, 2023

Choose a reason for hiding this comment

amcginn Dec 14, 2023

Choose a reason for hiding this comment

amcginn Dec 14, 2023

Choose a reason for hiding this comment

kckeim left a comment

Choose a reason for hiding this comment

kckeim Dec 14, 2023

Choose a reason for hiding this comment

kckeim Dec 14, 2023

Choose a reason for hiding this comment

SukeshKonjeti commented Feb 2, 2024

RicardoCrespo-ora commented Dec 8, 2023 •

edited

Loading