This repository has been archived by the owner on May 7, 2024. It is now read-only.
Review and Updates to Procedure #1016
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
RicardoCrespo-ora
added
R4
RicardoCrespo-ora
requested review from
napster235,
amcginn,
krycunn,
kckeim,
cldeitrich and
gmodrogan
|
Added some of the wording suggested in #1006 |
napster235
approved these changes
Nov 13, 2023
kckeim
suggested changes
Nov 17, 2023
There was a problem hiding this comment.
Tagged a few items directly for lines you touched.
For non-edited lines that need attention...
DSTU2 markdown:
- Need to consolidate the disclaimer and common errors+outcomes section to follow the fields list at the top
- "Retrieve by id" section needs to have the id uppercased in the header and description.
R4 markdown:
- Need to consolidate the disclaimer and common errors+outcomes section to follow the fields list at the top
- "Retrieve by id" section needs to have the id uppercased in the header and description.
- Under the "Create" section, you can drop that second implementation note; it's already handled by the first line.
- Remove "Modifier fields should not be provided, and will cause the transaction to fail."
DSTU2 Procedure.yaml
- Could we please https-ify the URLs and Info Links? R4's yaml appears okay after my glance through.
| * [Notes](http://hl7.org/fhir/DSTU2/procedure-definitions.html#Procedure.notes){:target="_blank"} | ||
| * [ID](https://hl7.org/fhir/dstu2/resource-definitions.html#Resource.id){:target="_blank"} | ||
| * [Patient](https://hl7.org/fhir/DSTU2/procedure-definitions.html#Procedure.subject){:target="_blank"} | ||
| * [Status (completed, entered-in-error)](https://hl7.org/fhir/DSTU2/procedure-definitions.html#Procedure.status){:target="_blank"} |
There was a problem hiding this comment.
You can drop the parentheses on Status here. Just saying the field can return is enough.
Comment on lines
19
to
25
| * [ID](https://hl7.org/fhir/R4/resource-definitions.html#Resource.id){:target="_blank"} | ||
| * [Status (completed, entered-in-error)](https://hl7.org/fhir/R4/procedure-definitions.html#Procedure.status){:target="_blank"} | ||
| * [Code](https://hl7.org/fhir/R4/procedure-definitions.html#Procedure.code){:target="_blank"} | ||
| * [Subject](https://hl7.org/fhir/R4/procedure-definitions.html#Procedure.subject){:target="_blank"} | ||
| * [Reference](http://hl7.org/fhir/r4/references.html#Reference){:target="_blank"} ([Patient](http://hl7.org/fhir/r4/patient.html){:target="_blank"}) | ||
| * [Encounter](https://hl7.org/fhir/R4/procedure-definitions.html#Procedure.encounter){:target="_blank"} | ||
| * [Date performed](https://hl7.org/fhir/R4/procedure-definitions.html#Procedure.performed_x_){:target="_blank"} | ||
| * [Performed Period](https://hl7.org/fhir/R4/procedure-definitions.html#Procedure.performed_x_){:target="_blank"} |
There was a problem hiding this comment.
Same as on DSTU2 - drop the Status field's parenthetical values, please
Comment on lines
57
to
59
| `_id` | Conditionally | [`token`] | The logical resource id associated with the resource. This parameter is required if `patient` or `subject` are not used. | ||
| `patient` | Conditionally | [`reference`] | Who the Procedure is for. This parameter is required if `_id` or `subject` are not used. Example: `12345` | ||
| `subject` | Conditionally | [`reference`] | Who the Procedure is for. This parameter is required if `_id` or `patient` are not used. Example: `Patient/12345` |
There was a problem hiding this comment.
Wording on the parameters here should be used in DSTU2 resource's table as well.
| - The `_id` parameter may not be provided at the same time as the `patient`, `subject`, or `date` parameters. | ||
|
|
||
| - The `date` parameter must have a time, may be provided up to two times, and must use the `ge` or `le` prefixes. When provided twice, the lower value must have the `ge` prefix and the higher value must have the `le` prefix. | ||
| * The `_id` parameter may not be provided at the same time as the `patient`, `subject`, or `date` parameters. |
There was a problem hiding this comment.
Drop the conditional requirement line here, and use the descriptions in the R4 resource's table over on this DSTU2 resource, please. Your fixes in the R4 file match what the technical writers are looking for.
| `patient` | Conditionally | [`reference`] | Who the Procedure is for. This parameter is required if `_id` or `subject` are not used. Example: `12345` | ||
| `subject` | Conditionally | [`reference`] | Who the Procedure is for. This parameter is required if `_id` or `patient` are not used. Example: `Patient/12345` | ||
| `date` | No | [`dateTime`] | Date range in which the Procedure's `performedPeriod` or `performedDateTime` falls within. Example: `date=gt2015-09-24T12:00:00.000Z&date=le2020-07-15T16:00:00.000Z` | ||
| `_revinclude` | No | [`token`] | Provenance resource entries to be returned as part of the bundle. Example:_revinclude=Provenance:target | ||
|
|
||
| Notes: | ||
|
|
||
| * If `_id` is provided, `patient` or `subject` can no longer be provided. |
There was a problem hiding this comment.
Can you still use date if _id is used?
I thought it flipped over to basically:
If searching with the _id parameter, you cannot use any other parameters (except for _revinclude as detailed)
There was a problem hiding this comment.
Removed the id note to avoid confusion
cldeitrich
approved these changes
Nov 27, 2023
kckeim
approved these changes
Nov 28, 2023
Surya-Rnsit
pushed a commit
that referenced
this pull request
Dec 14, 2023
* Updated DocumentReference DSTU2 Resource (#998) * Updated InsurancePlan R4 Resource (#1000) * Updated Immunization DSTU2 Resource (#1003) * Updated Immunization R4 Resource (#1004) * Review and Updates for FamilyMemberHistory (#1013) * Review and Updates to Procedure (#1016) * Patient Arrival Time (#1017) * Update FHIR documentation for RevInclude supported resources (#1024) * CapabilityStatement R4 Response Examples Update (#1025) * [Millennium-R4]: Reschedule Appointment Workflow Update (#1026)
|
After code deployment : 
|
2 tasks
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 FamilyMemberHistory and any other information directly referenced by it.
Capitalization and corrections to returned fields
Before
After
Parameter table formatting and corrections
Before
After
Notes corrections and formatting
Before
After
PR Checklist