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

Updated Provenance R4 Resource #1018

Merged
merged 9 commits into from
Dec 18, 2023
Merged

Updated Provenance R4 Resource #1018

merged 9 commits into from
Dec 18, 2023

Conversation

kckeim
Copy link
Contributor

@kckeim kckeim commented Nov 13, 2023

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

Description

  • Validated/updated all links out to HL7 websites.
    • yaml file had a lot of examples of double forward-slashes
  • Validated API behavior matches stated specifications.
  • Updated Overview Paragraph.
  • Uppercase'd returned fields list.
  • Parameter Table and Implementation Notes updates to match current guidelines.
  • Implementation Notes under the Create section modified to match current guidelines.
  • Anonymized opc-request-id and X-Request-Id values added for response to Create section.
  • Added backticks to quite a few elements that should be code

PR Checklist

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

Old Overview and Fields:
image

New Overview and Fields:
image


Old Parameters:
image

New Parameters:
image


Old Create Notes:
image

New Create Notes:
image


Old Create response:
image

New Create response:
image


- Validated/updated all links out to HL7 websites.
  - yaml file had a lot of examples of double forward-slashes
- Validated API behavior matches stated specifications.
- Updated Overview Paragraph.
- Uppercase'd returned fields list.
- Parameter Table and Implementation Notes updates to match current guidelines.
- Implementation Notes under the Create section modified to match current guidelines.
- Anonymized opc-request-id and X-Request-Id values added for response to Create section.
- Added backticks to quite a few elements that should be code
@kckeim kckeim self-assigned this Nov 13, 2023
@kckeim kckeim added the R4 Applies to R4 FHIR resources label Nov 13, 2023
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-203512: Approved for style and formatting.


The following [HL7® FHIR® US Core Implementation Guide STU 4.0.0](https://hl7.org/fhir/us/core/STU4/){:target="_blank"} Profiles are supported by this resource:
This resource supports the following [HL7 FHIR US Core Implementation Guide STU 4.0.0](https://hl7.org/fhir/us/core/STU4/){:target="_blank"} profiles:
Copy link
Member

Choose a reason for hiding this comment

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

this change violates the HL7 trademark usage policy. we need to add back the trademark registration mark.

https://www.hl7.org/legal/trademarks.cfm

Copy link
Contributor

Choose a reason for hiding this comment

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

According to our style guide, we do not use any trademark symbols in our product labeling documentation. This has always been the case when referencing HL7 or FHIR.

Per Oracle guidelines, we do need to include the supplier name before the trademarked term for every reference, but omitting the symbols still applies.

https://wiki.cerner.com/display/public/CSG/Trademarks#Trademarks-OtherTrademarksThird-PartyTrademarks

@kckeim
Copy link
Contributor Author

kckeim commented Dec 1, 2023

Updated section examples for you @amcginn


image


image


image

@amcginn
Copy link
Member

amcginn commented Dec 14, 2023

the last screenshot is... weird that it links only two of them. since we do want those links referenced elsewhere, should we add links to the others?

@kckeim
Copy link
Contributor Author

kckeim commented Dec 14, 2023

the last screenshot is... weird that it links only two of them. since we do want those links referenced elsewhere, should we add links to the others?

I'm going to adjust the list so it doesn't trip up the table generator like it did.

@kckeim
Copy link
Contributor Author

kckeim commented Dec 18, 2023

Fixed scopes list:
image

@kckeim kckeim merged commit 823f04f into main Dec 18, 2023
1 check passed
@kckeim kckeim deleted the ProvenanceR4-docs-migrate branch December 18, 2023 20:43
SukeshKonjeti added a commit that referenced this pull request Feb 2, 2024
* Updated MedicationAdminstration R4 Resource (#1010)
* Updated MedicationAdministration DSTU2 Resource (#1011)
* Review and Updates to Goal (#1027)
* Review and Updates to Communication (#1022)
* dstu2 Practitioner updates (#1014)
* R4 Practitioner updates (#1015)
* Person updates for DSTU2 and R4 (#1009)
* StructureDefinition updates (#1012)
* Updated Medication Order DSTU2 Resource (#1020)
* Updated MedicationStatement DSTU2 Resource (#1021)
* Updated MedicationRequest R4 Resource (#1019)
* Updated Provenance R4 Resource (#1018)
* DSTU 2 Patient updates (#1023)
* R4 Patient formatting and standard updates (#1028)
* R4 Observation,DocumentReference Documentation Updates (#1031)
* R4 Encounter Period StartDateTime Sort Update (#1033)
* updated Location type search parameter and examples for physicalType (#1034)
* [R4][DiagnosticReport][DocumentReference] support search by _lastUpdated (#1032)
* [R4][Immunization] Support search by _lastUpdated (#1029)
* R4 Binary Autogen CCD add encounter parameter (#1035)
* [R4][Immunization] Documentation Update (#1036)
@shushruth-s
Copy link
Contributor

After Deployment:
Screenshot 2024-02-02 at 3 01 27 PM
Screenshot 2024-02-02 at 3 02 30 PM
Screenshot 2024-02-02 at 3 03 22 PM
Screenshot 2024-02-02 at 3 03 58 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