Skip to content
This repository has been archived by the owner on May 7, 2024. It is now read-only.

Diagnostic report r4 docs migrate #991

Merged
merged 11 commits into from
Oct 30, 2023
Merged

Conversation

kckeim
Copy link
Contributor

@kckeim kckeim commented Sep 29, 2023

This one needed several updates.
Verified good links throughout document and added some.

Description

  • Reworded and expanded Overview paragraph
  • Moved all shortname links to the end of the file, instead of following the Parameters section
  • Linked to related resources where appropriate (e.g. out to Observation in the Overview)
  • Parameters list corrected/adjusted.
    • Category and Code in particular needed updated to match the resource's behavior (yaml file was up to date on behavior)
    • _Revinclude parameter details adjusted, similar to other resources we've touched recently
  • Several Example-related updates
    • Header changes for clarity on which Example does what
    • Patient search example changed and added the Ccategory parameter in request. Response structure has substantially more detail now
    • Minor updates to other search/retrieve examples (added "display" names on providers)
  • Missing Header details around the Retrieve by ID

PR Checklist

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

Old Overview:
image

New Overview:
image


Old Parameters table:
image

New Parameters table:
image


Old Implementation Notes:
image

New Implementation Notes:
image


Example header changed from generic:
image

To more specfic:
image


Header section for Retrieve by ID old:
image

New:
image

- Reworded and expanded Overview paragraph
- Moved all shortname links to the end of the file, instead of following the Parameters section
- Linked to related resources where appropriate (e.g. out to Observation in the Overview)
- Parameters list corrected/adjusted.
  - Category and Code in particular needed updated to match the resource's behavior (yaml file was up to date on behavior)
  - _Revinclude parameter details adjusted, similar to other resources we've touched recently
- Several Example-related updates
  - Header changes for clarity on which Example does what
  - Patient search example changed and added the Ccategory parameter in request. Response structure has substantially more detail now
  - Minor updates to other search/retrieve examples (added "display" names on providers)
Can't get the relative link behaving without some other foundational work.  Adding it to the list of relative links to build
@kckeim
Copy link
Contributor Author

kckeim commented Sep 29, 2023

Okay, I'm done touching this until someone requests improvements, or points out errors

Flipped the updated example's call to the Open endpoint, for ease of developers' use.
Copy link
Contributor

@vinuthnag vinuthnag left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good

@kckeim kckeim requested a review from napster235 October 20, 2023 15:19
@amcginn amcginn added the R4 Applies to R4 FHIR resources label Oct 26, 2023
@amcginn amcginn merged commit 4081090 into main Oct 30, 2023
1 check passed
@amcginn amcginn deleted the DiagnosticReportR4-docs-migrate branch October 30, 2023 14:18
Someshnsn added a commit that referenced this pull request Nov 10, 2023
 
* R4 Appointment updates (#988)
* Diagnostic report r4 docs migrate (#991)
* Updated DiagnosticReport DSTU2 Resource (#992)
* Update DSTU 2 Appointment documentation (#993)
* R4_UK_BRAM_Update_Slot_include (#994)
* Reorder actions to Search, Read, Create, Patch (#995)
* Review and Corrections for Condition (#996)
* Update action-comment in cancellation workflow and custom encounter search (#997)
* Updated DocumentReference R4 Resource (#999)
* Review and updates for Location (#1001)
* Diagnostic Report Create for Cardiology and Anatomic pathology (#1002)
* Review and Updates for Encounter (#1007)
* Review and Updates for NutritionOrder (#1008)
@Surya-Rnsit
Copy link
Contributor

After Code Deployment:
Screenshot 2023-11-10 at 3 42 23 PM
Screenshot 2023-11-10 at 3 42 05 PM

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
R4 Applies to R4 FHIR resources
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants