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

Updated DocumentReference DSTU2 Resource #998

Merged
merged 8 commits into from
Nov 16, 2023

Conversation

kckeim
Copy link
Contributor

@kckeim kckeim commented Oct 9, 2023

Lots 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
  • Swapped position of the value field lists (CCD-specific section after the primary list)
  • Move to single disclaimer + error + outcomes callout towards the top
    • Adjusted the Create section to account for the "additional" HTTP 422 outcome that can occur
  • Implementation notes moved under parameters tables
  • Parameter table + Implementation notes adjustments
    • Mostly the "search" area that needed attention
  • Anonymized the x-ref ID for the Create response

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 under "Search":
image

New Implementation Notes under "Search":
image


Old Implementation Notes under "Retrieve":
image

New Implementation Notes under "Retrieve":
image


Old Implementation Notes under "Create":
image

New Implementation Notes under "Create":
image


Old "Errors" section under "Create":
image

New "Errors" section under "Create":
image


Old $docref header + notes:
image

New $docref header + notes:
image


Old $docref parameters + notes:
image
image

New $docref parameters + notes:
image

kckeim added 2 commits October 9, 2023 09:06
- Backtick'd a lot of elements throughout the entire page, including some linked elements
- Overview paragraph updated
- Swapped position of the value field lists (CCD-specific section after the primary list)
- Move to single disclaimer + error + outcomes callout towards the top
  - Adjusted the Create section to account for the "additional" HTTP 422 outcome that can occur
- Implementation notes moved under parameters tables
- Parameter table + Implementation notes adjustments
  - Mostly the "search" area that needed attention
- Anonymized the x-ref ID for the Create response
Missed a movement for the notes under the $docref on first commit.  List of notes is now consolidated under the Parameters table.
- Made a bunch of changes at Aaron McGinn's request, as follows
  - Removed parenthetical suggestions around what data comes back in each field towards the top; it's out of character compared to all other resources we have pages for.
  - Removed Default/Maximum wording that was added for `_count` parameter. It could get changed in the APIs later without a corresponding documentation update.
  - Removed out-of-character link under $docref out to an Argonaut profile related to LOINC codes coming back for the `type`; we don't really need this here, since the bindings don't change between search and retrieve functions
  - Improved external links, and made them more visible as far as them being external tools for the XHTML validation services
  - added `opc-request-id` to the response for the CREATE action.  Adjusted x-request-id string to match a UUID format
  - reworded implementation notes to be more clear

- Identified a to-do around re-wording how our 422's / 500's fire with relation to unsupported fields
  - will discuss and fix morning of 10/25
Removed all call-out language specific to implicitRules, modifierExtension, and relatesTo.

These fields are not listed under the CREATE section, because they're not supported, and we already have language which indicates only the listed fields are supported anyways - like all other documentation we have out there.
@amcginn amcginn added the DSTU2 Applies to DSTU2 FHIR resources label Oct 26, 2023
@amcginn amcginn merged commit 953f909 into main Nov 16, 2023
1 check passed
@amcginn amcginn deleted the DocumentReferenceDSTU2-docs-migrate branch November 16, 2023 18:01
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 Code Deployment:
Screenshot 2023-12-14 at 6 08 48 PM

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

Successfully merging this pull request may close these issues.

5 participants