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

Updated Immunization R4 Resource #1004

Merged
merged 8 commits into from
Nov 16, 2023
Merged

Updated Immunization R4 Resource #1004

merged 8 commits into from
Nov 16, 2023

Conversation

kckeim
Copy link
Contributor

@kckeim kckeim commented Oct 18, 2023

Had several changes on this one, including some re-wording of Overview and Implementation Notes sections to be more descriptive / 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

  • Re-did Overview paragraph.
    • Matches what HL7.org has, and is in-line with the recent proposed DSTU2 formatting.
    • Now includes direct links out to the AllergyIntolerance and MedicationAdministration resources.
  • Switched links from http -> https for HL7.org in markdown and yaml files
  • Modified link structure around the Note field, and referenced over to the Annotation formatting for R4.
  • Switched to single disclaimer + errors/outcomes notice
  • Many updates to Parameter table and Implementation Notes, to match the performance of the API, and explain requirements and expected behavior of each search parameter.
  • Anonymized the X-Request ID's for the Create / Update sections

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


Adjustments on the "note" formatting.
Old:
image

New:
image


Old Parameters + Notes:
image
image

New Parameters + Notes:
image
image
image


- Re-did Overview paragraph.
  - Matches what HL7.org has, and is in-line with the recent proposed DSTU2 formatting.
  - Now includes direct links out to the `AllergyIntolerance` and `MedicationAdministration` resources.
- Switched links from http -> https for HL7.org in markdown and yaml files
- Modified link structure around the `Note` field, and referenced over to the `Annotation` formatting for R4.
- Switched to single dislaimer + errors/outcomes notice
- Many updates to Parameter table and Implementation Notes, to match the performance of the API, and explain requirements and expected behavior of each search parameter.
- Anonymized the X-Request ID's for the Create / Update sections
@kckeim kckeim requested a review from napster235 October 20, 2023 15:18
Copy link
Contributor

@cldeitrich cldeitrich left a comment

Choose a reason for hiding this comment

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

PRODOC-202502: Approved for style and formatting.

@amcginn amcginn added the R4 Applies to R4 FHIR resources label Oct 26, 2023
- flipped "Encounter" back to "encounter" for matching the parameter/field (yaml file)
- UUID formatted the x-request-id
- added opc-request-id
@amcginn amcginn merged commit 7d131da into main Nov 16, 2023
1 check passed
@amcginn amcginn deleted the ImmunizationR4-docs-migrate branch November 16, 2023 18:56
Someshnsn pushed a commit that referenced this pull request Nov 20, 2023
Someshnsn pushed a commit that referenced this pull request Nov 20, 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)
@Surya-Rnsit
Copy link
Contributor

After Publishing

Screenshot 2023-12-14 at 6 16 53 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.

6 participants