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

Updated MedicationStatement DSTU2 Resource #1021

Merged
merged 4 commits into from
Dec 18, 2023

Conversation

kckeim
Copy link
Contributor

@kckeim kckeim commented Nov 16, 2023

Had a lot of formatting changes on this one to get it into a similar style to other resources that were recently updated.
Verified/updated links throughout document.
Validated that API calls behave as expected with both the expected and unexpected parameters.

Description

  • Updated Overview. Reworded and re-spaced.
  • Uppercasing and punctuation added in a lot of places. Some spacing changes too (e.g. leading spaces)
  • Validated and/or fixed all existing links. There were quite a few in this one.
  • Added "info_link" to many lines in the yaml files
  • Added link over to MedicationOrder in the relevant section
  • Consolidated disclaimer + errors & outcomes notice
  • Updated Custom Extensions for clarity
  • Updated Parameter Table + Implementation Notes to match current standards
  • Modified Implementation Notes related to Create and Update sections
    • Removed unnecessary details
    • Took field-specific details and moved them to the yaml file(s) so they would appear alongside the relevant field-specific data
    • Added the standard disclaimer for "only mentioned fields are supported"
  • Added anonymized opc-request-id and x-request-id to the Create and Update response headers

PR Checklist

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

Old Overview + trailer Notes:
image
image

New Overview + trailer Notes:
image
image


Example Terminology link fixes - before:
image
image

Example Terminology link fixes - after:
image
image


Extensions before:
image

Extensions after:
image


Parameter Table + notes before:
image
image

Parameter Table + notes after:
image


Uppercasing Retrieve function before:
image

Uppercasing Retrieve function after:
image


Create Header before:
image

Create Header after:
image


Example status field changes - before:
image

Example status field changes - after:
image


Response changes - before:
image

After:
image


Update Details change - before:
image
image

Update Details change - after:
image

- Updated Overview.  Reworded and re-spaced.
- Uppercasing and punctuation added in a lot of places. Some spacing changes too (e.g. leading spaces)
- Validated and/or fixed all existing links.  There were quite a few in this one.
- Added "info_link" to many lines in the yaml files
- Added link over to MedicationOrder in the relevant section
- Consolidated disclaimer + errors & outcomes notice
- Updated Custom Extensions for clarity
- Updated Parameter Table + Implementation Notes to match current standards
- Modified Implementation Notes related to Create and Update sections
  - Removed unnecessary details
  - Took field-specific details and moved them to the yaml file(s) so they would appear alongside the relevant field-specific data
  - Added the standard disclaimer for "only mentioned fields are supported"
- Added anonymized opc-request-id and x-request-id to the Create and Update response headers
@kckeim kckeim added the DSTU2 Applies to DSTU2 FHIR resources label Nov 16, 2023
@kckeim kckeim self-assigned this Nov 16, 2023


Notes:
_Implementation Notes_
Copy link
Contributor

Choose a reason for hiding this comment

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

The recommendation between Notes/Implementation Notes from tech writers is to use Notes

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-203652: Approved for style.

* [Was or Was Not Taken](https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.wasNotTaken){:target="_blank"}
* [Date/Time started and ended](https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.effective_x_){:target="_blank"}
* [Medication](https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.medication_x_){:target="_blank"}
* [Reference to source MedicationOrder, if applicable](https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.supportingInformation){:target="_blank"}
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* [Reference to source MedicationOrder, if applicable](https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.supportingInformation){:target="_blank"}
* [Source MedicationOrder reference](https://hl7.org/fhir/DSTU2/medicationstatement-definitions.html#MedicationStatement.supportingInformation){:target="_blank"}

@@ -65,21 +71,16 @@ All URLs for custom extensions are defined as `https://fhir-ehr.cerner.com/dstu2

ID | Value\[x] Type | Description
---------------------------------|---------------------|-------------------------------------------------------------------------------------------
`patient-friendly-display` | [`string`] | The display that can be used for this field when producing a view suitable for a patient.
`medication-statement-category` | [`CodeableConcept`] | The [category] of the order, for example: patientspecified, outpatient, etc.
`patient-friendly-display` | [`string`] | Extension to MedicationRequest.dosageInstruction. The display name that can be used for this field when producing a view suitable for a patient.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
`patient-friendly-display` | [`string`] | Extension to MedicationRequest.dosageInstruction. The display name that can be used for this field when producing a view suitable for a patient.
`patient-friendly-display` | [`string`] | Extension to `MedicationRequest.dosageInstruction`. The display name that can be used for this field when producing a view suitable for a patient.

`patient-friendly-display` | [`string`] | The display that can be used for this field when producing a view suitable for a patient.
`medication-statement-category` | [`CodeableConcept`] | The [category] of the order, for example: patientspecified, outpatient, etc.
`patient-friendly-display` | [`string`] | Extension to MedicationRequest.dosageInstruction. The display name that can be used for this field when producing a view suitable for a patient.
`medication-statement-category` | [`CodeableConcept`] | The [category] of the order, for example: patientspecified, outpatient, and so on.
Copy link
Member

Choose a reason for hiding this comment

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

having "and so on" here is redundant since it already says they are examples of values, not the complete set

@kckeim kckeim merged commit 194f01f into main Dec 18, 2023
1 check passed
@kckeim kckeim deleted the MedicationStatementDSTU2-docs-migrate branch December 18, 2023 19:56
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 19 49 PM
Screenshot 2024-02-02 at 3 20 22 PM
Screenshot 2024-02-02 at 3 20 51 PM
Screenshot 2024-02-02 at 3 21 25 PM
Screenshot 2024-02-02 at 3 21 53 PM
Screenshot 2024-02-02 at 3 22 46 PM
Screenshot 2024-02-02 at 3 23 32 PM
Screenshot 2024-02-02 at 3 23 58 PM
Screenshot 2024-02-02 at 3 24 20 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