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

Updated DocumentReference R4 Resource #999

Merged
merged 11 commits into from
Oct 30, 2023
Merged

Conversation

kckeim
Copy link
Contributor

@kckeim kckeim commented Oct 9, 2023

Tons of formatting updates in this one, and substantial re-wording of sections to be more descriptive and in a similar style to other resources that were recently updated.
Verified good links through document.
Validated that API calls behave as expected with both the expected and unexpected parameters.

Description

  • Backtick'd a lot of elements throughout the entire page, including some linked elements
  • Overview paragraph updated
  • Links to FHIR-controlled fields updated
  • Added links out to the R4 Binary resource in various places, since that resource gets referred to by this one.
  • Search's Parameter table updated, and elements were re-orderd to put date and period next to each other
  • Search's Implementation notes greatly expanded, based on API behavior during testing
    • date and period specifically needed adjustments on behavior, as they were substantially lacking in detail
    • Per PR#959, the notes about period specifically were not consistent with the API's behavior
    • Added detail about the _id, and encounter behaviors
    • Adjusted the _revinclude details to mimic more recently documentation updates
  • Implementation Notes for Retrieve, Create, Update, updated also, though less extensively
  • $docref operation parameters and Implementation Notes were updated
  • Anonymized the x-ref IDs for the Create and Updated responses
  • Fixed Typo in the R4_DOCUMENT_REFERENCE example in the RUBY file - had a bonus double quote in there.
  • YAML file corrections
    • consistency around MIME vs. mime
    • needed to escape the hyphens in the YAML file - they were breaking the code blocking from the backticks, so we got to use HTML tags instead
    • fixed some "angled" doublequotes
    • ensured we were aiming to R4-specific resources for many links that weren't already

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 Search Implementation Notes:
image

New Search Implementation Notes:
image
image


Old Retrieve Implementation Notes:
image

New Retrieve Implementation Notes:
image


Old Create Implementation Notes:
image

New Create Implementation Notes:
image


Old Update Implementation Notes:
image

New Update Implementation Notes:
image


$docref old parameters and notes:
image

$docref new parameters and notes:
image

kckeim added 4 commits October 9, 2023 12:35
- Backtick'd a lot of elements throughout the entire page, including some linked elements
- Overview paragraph updated
- Links to FHIR-controlled fields updated
  - Custodian link wasn't pointing to r4 specifically - adjusted
  - Per PR#349, the Document description/title link is no longer supported and needed removed
    - #349
- Added links out to the R4 Binary resource in various places, since that resource gets referred to by this one.
- Search's Parameter table updated, and elements were re-orderd to put `date` and `period` next to each other
- Search's Implementation notes greatly expanded, based on API behavior during testing
  - encounter previously
  - `date` and `period` specifically needed adjustments on behavior, as they were substantially lacking in detail
  - Per PR#959, the notes about `period` specifically were not consistent with the API's behavior
    - #959
  - Added detail about the _id, and encounter behaviors
  - Adjusted the _revinclude details to mimic more recently documentation updates
- Anonymized the x-ref IDs for the Create and Updated responses
- Fixed Typo in the `R4_DOCUMENT_REFERENCE` example in the RUBY file - had a bonus double quote in there.
- YAML file corrections
  - consistency around MIME vs. mime
  - needed to escape the hyphens in the YAML file - they were breaking the code blocking from the backticks, so we got to use HTML tags instead
  - fixed some "angled" doublequotes
  - ensured we were aiming to R4-specific resources for many links that weren't already
code element wasn't liking the parentheses around it
@kckeim kckeim requested a review from napster235 October 20, 2023 15:19
@@ -295,18 +294,12 @@ Date: Fri, 04 Nov 2022 11:54:04 GMT
Etag: W/"2"
Last-Modified: Fri, 04 Nov 2022 11:54:04 GMT
Vary: Origin
X-Request-Id: d2a211a4-ccd4-4ba8-b4f4-d3da9200543c+6313_U7Z3
X-Request-Id: 1111111111111111111111111111111111111111111111
Copy link
Member

Choose a reason for hiding this comment

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

UUID

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@amcginn amcginn added the R4 Applies to R4 FHIR resources label Oct 26, 2023
- Added anonymized opc-request-id's into the responses
- flipped to uuid format for anonymized x-request-id's
@amcginn amcginn merged commit 1f04177 into main Oct 30, 2023
1 check passed
@amcginn amcginn deleted the DocumentReferenceR4-docs-migrate branch October 30, 2023 14:15
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)
@Someshnsn
Copy link
Contributor

After Deployment Screenshot:
Screenshot 2023-11-11 at 10 19 12 PM
Screenshot 2023-11-11 at 10 19 55 PM
Screenshot 2023-11-11 at 10 20 45 PM
Screenshot 2023-11-11 at 10 22 23 PM
Screenshot 2023-11-11 at 10 22 58 PM
Screenshot 2023-11-11 at 10 23 29 PM
Screenshot 2023-11-11 at 10 24 38 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