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

Review and Updates for Encounter #1007

Merged
merged 8 commits into from
Nov 3, 2023
Merged

Conversation

RicardoCrespo-ora
Copy link
Contributor

@RicardoCrespo-ora RicardoCrespo-ora commented Oct 23, 2023

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 Encounter and any other information directly referenced by it.

Reformatting for Parameters table

Before
image

After
image


Re-formatting Revinclude parameter details

Before
image

After
image


Revinclude example response header fix

Before
image

After
image


Anonymization of x-request for create and patch responses

Before
image

image

After
image

image

Fixed broken links for Encounter Priority

Before
image

On clicking Encounter Priority details link

image

After

image

PR Checklist

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

Edits per PRODOC-202540
Edits per PRODOC-202540
Copy link
Contributor

@summerlcollins summerlcollins left a comment

Choose a reason for hiding this comment

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

Approved per PRODOC-202540

* `_revinclude` is provided in a request to the closed endpoint, the OAuth2 token must include the `user/Provenance.read` scope. Currently, `patient/Provenance.read` is not supported and hence `_revinclude` cannot be utilized for patient persona.
* When using the `_revinclude` parameter:
* It may be provided once with the value `Provenance:target`. Example: `_revinclude=Provenance:target`
* It may be provided with the `_id/patient/subject/account` parameter. Example: `_id=74771957,4732066&_revinclude=Provenance:target`
Copy link
Member

Choose a reason for hiding this comment

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

let's split these fields to be more clear that they are separate parameters

Copy link
Contributor Author

@RicardoCrespo-ora RicardoCrespo-ora Oct 26, 2023

Choose a reason for hiding this comment

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

Do you mean split like this?

  • When using the _revinclude parameter:
    • It may be provided once with the value Provenance:target. Example: _revinclude=Provenance:target
    • It may be provided with the _id parameter. Example: _id=74771957,4732066&_revinclude=Provenance:target`
    • It may be provided with the patient parameter. Example: example here
    • It may be provided with the subject parameter. Example: example here
    • It may be provided with the account parameter. Example: example here

@amcginn amcginn added R4 Applies to R4 FHIR resources DSTU2 Applies to DSTU2 FHIR resources labels Oct 26, 2023
Copy link
Contributor

@kckeim kckeim left a comment

Choose a reason for hiding this comment

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

Additional / non-changed lines that need attention:

R4 Markdown:

  • Line 20 - should have "Encounter id" changed to "Encounter ID"
  • Line 51 - I want to have us change that to just on-page link to the Extensions section instead of naming all the elements and then linking to the below section. Can also drop the target input there
    • e.g. change to [Extensions](#extensions) instead of [Extensions including...](#extensions){:target="_blank"}

content/millennium/r4/base/management/encounter.md Outdated Show resolved Hide resolved
content/millennium/dstu2/encounters/encounter.md Outdated Show resolved Hide resolved
content/millennium/r4/base/management/encounter.md Outdated Show resolved Hide resolved
@RicardoCrespo-ora RicardoCrespo-ora merged commit d5df796 into main Nov 3, 2023
1 check passed
@RicardoCrespo-ora RicardoCrespo-ora deleted the encounter-docs-migrate branch November 3, 2023 15:11
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)
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
DSTU2 Applies to DSTU2 FHIR resources R4 Applies to R4 FHIR resources
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants