Review and updates for Location #1001
Conversation
RicardoCrespo-ora
requested review from
gmodrogan,
amcginn,
krycunn,
kckeim and
vinuthnag
There was a problem hiding this comment.
In the Markdown file:
- For lines 64 and 65, you'll need to escape the vertical pipes inside the examples for
-physicalTypeandidentifier. It gets broken when the page goes to render right now since it's being treated as a "new" column- "|" -> "\ + |"
- We need adjust the list of co-searching parameters on line 82 under the
nameandorganizationnotes, because_idcan't be used to search with those.- Like most other resources, you're either using
_idby itself to search, or you're not including it with whatever else you're searching by.
- Like most other resources, you're either using
Ruby File looks okay with your edits
Thank you good catch on the id parameter slipping in with use alongside name and org, I've removed this. The `` automatically displays texts as-is so I'm not finding a way to escape the pipes, I believe its a limitation of github's preview, you can otherwise see the formatting normally on chrome, firefox, safari, and safari's edge mode which emulates edge on PC |
There's a bit of a contradiction in the current API responses with these parameters, first image is where the first edit came from |
|
@RicardoCrespo-ora, I'm having trouble tagging you on the PRODOC Jira, but just let me know here if you approve the edits -- thanks! |
I have looked at the commit, it looks good :) |
| @@ -9,9 +9,9 @@ title: Location | R4 API | |||
|
|
|||
| ## Overview | |||
|
|
|||
| The Location resource describes physical places where healthcare services are provided. In Millennium, facilities are the top level of the patient location hierarchy. A facility is also an Organization resource at which patient locations are associated. All facilities are organizations, but not all organizations are facilities. A location can also be an ambulatory patient care area like a clinic or an emergency room. The location hierarchy from highest to lowest is facility, building, nursing unit, room, and bed. | |||
| The Location resource describes physical places where healthcare services are provided. In Cerner Millennium, facilities are the top level of the patient location hierarchy. A facility is also an Organization resource that is associated with patient locations. All facilities are organizations, but not all organizations are facilities. A location can also be an ambulatory patient care area such as a clinic or an emergency room. The location hierarchy from highest to lowest is facility, building, nursing unit, room, and bed. | |||
There was a problem hiding this comment.
isn't it no longer "Cerner"? "Oracle Health Millennium Platform" or, colloquially, "Millennium"?
There was a problem hiding this comment.
We do not have the go-ahead from Legal yet to change Cerner to Oracle Health in our documentation. For now we are still following the standard of always using the full name of Cerner Millennium.
This might change when we need to migrate to OHC for consistency's sake, even if we haven't gotten permission to update the rest of our doc? I'll see if I can get any clarification on that.
| - When searching with the `-address-city` parameter: | ||
| - Must include any of the following parameters: `address-state` or `address-postalcode`. | ||
| - When searching with the `name` and `organization` parameters: | ||
| - Must include any of the following parameters: `-physicalType`, `identifier`, `address`, `address-state`, `address-city`, or `address-postalcode`. |
There was a problem hiding this comment.
do we need to mention -physicalType here since we've already stated that it's required?
| @@ -40,15 +40,15 @@ The following fields are returned if valued: | |||
|
|
|||
There was a problem hiding this comment.
can't comment on the line since it wasn't changed, but let's update 'Location id' to 'Location ID'
| @@ -9,9 +9,9 @@ title: Location | R4 API | |||
|
|
|||
| ## Overview | |||
|
|
|||
| The Location resource describes physical places where healthcare services are provided. In Millennium, facilities are the top level of the patient location hierarchy. A facility is also an Organization resource at which patient locations are associated. All facilities are organizations, but not all organizations are facilities. A location can also be an ambulatory patient care area like a clinic or an emergency room. The location hierarchy from highest to lowest is facility, building, nursing unit, room, and bed. | |||
| The Location resource describes physical places where healthcare services are provided. In Cerner Millennium, facilities are the top level of the patient location hierarchy. A facility is also an Organization resource that is associated with patient locations. All facilities are organizations, but not all organizations are facilities. A location can also be an ambulatory patient care area such as a clinic or an emergency room. The location hierarchy from highest to lowest is facility, building, nursing unit, room, and bed. | |||
| `address-state` | No | [`string`] | The state specified in the address. Example: `MO` | ||
| `address-postalcode` | No | [`string`] | The postal code specified in the address. Example: `64111` | ||
| `name` | No | [`string`] | The portion of the location's name or alias. Example: `Main` | ||
| `organization` | No | [`reference`]| The organization that manages the location. Example: `675844` |
There was a problem hiding this comment.
let's capitalize Organization in the description since it's a reference type.
* 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)
|
After Deployment Screenshot: 
|
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 Consent/Contract and any other information directly referenced by it.
Modified formatting to be consistent with other entries in documentation
Before
After
Examples with Pennsylvania address no longer existing, replaced with Kansas address
Before
After
Example with organization no longer existing, replaced with existing one from above examples
Before
After
PR Checklist