From 905650800e3051c05faf916f7a5d8f56e07ee0a7 Mon Sep 17 00:00:00 2001 From: RicardoCrespo-ora Date: Fri, 17 Nov 2023 15:24:12 -0600 Subject: [PATCH 1/6] updates and revisions to Communication --- .../request-and-response/communication.md | 47 ++++++++++--------- 1 file changed, 24 insertions(+), 23 deletions(-) diff --git a/content/millennium/r4/clinical/request-and-response/communication.md b/content/millennium/r4/clinical/request-and-response/communication.md index 1b3a2678a..98420ae5b 100644 --- a/content/millennium/r4/clinical/request-and-response/communication.md +++ b/content/millennium/r4/clinical/request-and-response/communication.md @@ -9,13 +9,13 @@ title: Communication | R4 API ## Overview -The Communication resource is a conveyance of information from one entity, a sender, to another entity, a receiver. The information includes encoded data and optionally a related Patient and a related Encounter. +The Communication resource is a conveyance of information from one entity, a sender, to another entity, a receiver. The information includes encoded data and optionally a related [`Patient`] and a related [`Encounter`]. The following fields are returned if valued: -* [Communication Id](https://hl7.org/FHIR/r4/communication-definitions.html#Communication.identifier) +* [ID](https://hl7.org/FHIR/r4/communication-definitions.html#Communication.identifier) * [In Response To](https://hl7.org/FHIR/r4/communication-definitions.html#Communication.inResponseTo) -* [Status (Completed)](https://hl7.org/FHIR/r4/communication-definitions.html#Communication.status) +* [Status](https://hl7.org/FHIR/r4/communication-definitions.html#Communication.status) * [Category](https://hl7.org/FHIR/r4/communication-definitions.html#Communication.category) * [Priority](https://hl7.org/FHIR/r4/communication-definitions.html#Communication.priority) * [Subject](https://hl7.org/FHIR/r4/communication-definitions.html#Communication.subject) @@ -39,8 +39,8 @@ All URLs for custom extensions are defined as `https://fhir-ehr.cerner.com/r4/St ID | Value\[x] Type | Description ---------------|---------------------|---------------------------------------------------------------------------------- -`reply-to` | [`Reference`] | Used to direct where replies to the communication should be sent. Must be a Group. -`email-status` | [`CodeableConcept`] | Status of the electronic communication (in-progress, completed, received). +`reply-to` | [`Reference`] | Used to direct where replies to the Communication should be sent. Must be a Group. +`email-status` | [`CodeableConcept`] | Status of the electronic Communication (in-progress, completed, received). ## Search @@ -48,9 +48,9 @@ Search for communications that meet supplied query parameters: GET /Communication?:parameters -_Implementation Notes_ +_Notes_ -* The Content of a communication will be returned through the binary resource. A reference to the payload will be provided in the Payload section. +* The Content of a Communication will be returned through the binary resource. A reference to the payload will be provided in the Payload section. * Only 1000 elements max will be returned based on the date range. ### Authorization Types @@ -59,21 +59,20 @@ _Implementation Notes_ ### Parameters - Name | Required? | Type | Description --------------------|--------------------------------------------------------------------|---------------|----------------------------------------------------------------------------------------------------------------------------------------------- - `_id` | This or (`category`, `-email-status`, `recipient` and `received`) | [`token`] | The logical resource id associated with the resource. Example: `489580643.0.-4.prsnl` - `category` | (This, `recipient`, `received` and `-email-status`) or `_id` | [`token`] | A token for a [`CodeableConcept`] that points to the CodeableConcept used for Communication.category. Example: `http://terminology.hl7.org/CodeSystem/communication-category|notification` - `recipient` | (This, `category`, `received` and `-email-status`) or `_id` | [`reference`] | The recipient of the communication. Example: `Practitioner/3456783` - `received` | (This, `category`, `recipient` and `-email-status`) or `_id` | [`date`] | Date range into which the communication falls. Example: `le2017-02-01T10:30:00Z` - `-email-status` | (This, `category`, `recipient` and `received`) or `_id` | [`token`] | The status of the email. Example: `http://hl7.org/fhir/task-status|in-progress` + Name | Required? | Type | Description +-----------------------------------------------------|---------------|---------------|----------------------------------------------------------------------------------------------------------------------------------------------- + `_id` | Conditionally | [`token`] | The logical resource ID associated with the resource. This parameter is required if `category`, `-email-status`, `recipient` and `received` are not used. Example: `489580643.0.-4.prsnl` + `category` | Conditionally | [`token`] | A token for a [`CodeableConcept`] that points to the CodeableConcept used for `Communication.category`. This parameter is required along with `recipient`, `received` and `-email-status` if `_id` is not used. Example: `http://terminology.hl7.org/CodeSystem/communication-category|notification` + `recipient:Group` or `recipient:Practitioner` | Conditionally | [`reference`] | The recipient of the Communication. This parameter is required along with `category`, `received` and `-email-status` if `_id` is not used. Example: `3456783` + `received` | Conditionally | [`date`] | Date range into which the Communication falls. This parameter is required along with `category`, `recipient` and `-email-status` if `_id` is not used. Example: `ge2017-02-01T10:30:00Z` + `-email-status` | Conditionally | [`token`] | The status of the email. This parameter is required along with `category`, `recipient` and `received` if `_id` is not used. Example: `http://hl7.org/fhir/task-status|in-progress` Notes: - * The `recipient` parameter must represent a Practitioner or a Group. * The `received` parameter may be provided: - * once with the `ge` prefix. - * twice with the lower value prefixed by `ge` and the higher value prefixed by `le`. + * Once with the `ge` prefix. + * Twice with the lower value prefixed by `ge` and the higher value prefixed by `le`. ### Headers @@ -95,9 +94,9 @@ _Implementation Notes_ The common [errors] and [OperationOutcomes] may be returned. -## Retrieve by id +## Retrieve by ID -List an individual communication by its id: +List an individual Communication by its ID: GET /Communication/:id @@ -123,11 +122,11 @@ List an individual communication by its id: ## Create -Create a new communication. +Create a new Communication. POST /Communication -_Implementation Notes_ +_Notes_ * Only the body fields mentioned below are supported. Unsupported fields will be ignored. * Modifier fields should not be provided, and will cause the transaction to fail. @@ -183,11 +182,11 @@ The common [errors] and [OperationOutcomes] may be returned. ## Patch -Patch an existing communication. +Patch an existing Communication. PATCH /Communication/:id -_Implementation Notes_ +_Notes_ * This implementation follows the [JSON PATCH](https://tools.ietf.org/html/rfc6902) spec. * Only operations on the paths listed below are supported. @@ -244,5 +243,7 @@ The common [errors] and [OperationOutcomes] may be returned. [`token`]: https://hl7.org/fhir/R4/search.html#token [`date`]: https://hl7.org/fhir/R4/search.html#date [`CodeableConcept`]: https://hl7.org/fhir/R4/datatypes.html#codeableconcept +[`Patient`]: /millennium/r4/base/individuals/patient/ +[`Encounter`]: /millennium/r4/base/management/encounter/ [errors]: ../../../#client-errors [OperationOutcomes]: ../../../#operation-outcomes From a34d6bda8fd9cafba751e3f947e6f807b1d2ef79 Mon Sep 17 00:00:00 2001 From: RicardoCrespo-ora Date: Fri, 17 Nov 2023 16:45:42 -0600 Subject: [PATCH 2/6] changed position of disclaimer and errors --- .../request-and-response/communication.md | 24 +++++-------------- 1 file changed, 6 insertions(+), 18 deletions(-) diff --git a/content/millennium/r4/clinical/request-and-response/communication.md b/content/millennium/r4/clinical/request-and-response/communication.md index 98420ae5b..8712ed18c 100644 --- a/content/millennium/r4/clinical/request-and-response/communication.md +++ b/content/millennium/r4/clinical/request-and-response/communication.md @@ -27,6 +27,12 @@ The following fields are returned if valued: * [Sender](https://hl7.org/FHIR/r4/communication-definitions.html#Communication.sender) * [Payload](https://hl7.org/FHIR/r4/communication-definitions.html#Communication.payload) +<%= disclaimer %> + +### Errors + +The common [errors] and [OperationOutcomes] may be returned. + ## Terminology Bindings <%= terminology_table(:communication, :r4) %> @@ -88,11 +94,6 @@ _Notes_ <%= headers status: 200 %> <%= json(:r4_communication_bundle) %> -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. ## Retrieve by ID @@ -118,7 +119,6 @@ List an individual Communication by its ID: <%= headers status: 200 %> <%= json(:r4_communication_entry) %> -<%= disclaimer %> ## Create @@ -174,12 +174,6 @@ X-Runtime: 0.022706 The `ETag` response header indicates the current `If-Match` version to use on subsequent updates. -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - ## Patch Patch an existing Communication. @@ -233,12 +227,6 @@ X-Runtime: 0.826616 The `ETag` response header indicates the current `If-Match` version to use on subsequent updates. -<%= disclaimer %> - -### Errors - -The common [errors] and [OperationOutcomes] may be returned. - [`reference`]: https://hl7.org/fhir/R4/search.html#reference [`token`]: https://hl7.org/fhir/R4/search.html#token [`date`]: https://hl7.org/fhir/R4/search.html#date From 60d896e13ff761a29f7ecd7119f37be8309d1a0c Mon Sep 17 00:00:00 2001 From: "Deitrich, Casey" Date: Wed, 22 Nov 2023 10:21:08 -0600 Subject: [PATCH 3/6] PRODOC-203712: Style edits. --- .../request-and-response/communication.md | 32 +++++++++---------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/content/millennium/r4/clinical/request-and-response/communication.md b/content/millennium/r4/clinical/request-and-response/communication.md index 8712ed18c..c536db916 100644 --- a/content/millennium/r4/clinical/request-and-response/communication.md +++ b/content/millennium/r4/clinical/request-and-response/communication.md @@ -45,19 +45,19 @@ All URLs for custom extensions are defined as `https://fhir-ehr.cerner.com/r4/St ID | Value\[x] Type | Description ---------------|---------------------|---------------------------------------------------------------------------------- -`reply-to` | [`Reference`] | Used to direct where replies to the Communication should be sent. Must be a Group. -`email-status` | [`CodeableConcept`] | Status of the electronic Communication (in-progress, completed, received). +`reply-to` | [`Reference`] | Directs where replies to the communication are sent. Must be a group. +`email-status` | [`CodeableConcept`] | The status of the electronic communication (in-progress, completed, or received). ## Search -Search for communications that meet supplied query parameters: +Search for communications that meet supplied query parameters. GET /Communication?:parameters _Notes_ -* The Content of a Communication will be returned through the binary resource. A reference to the payload will be provided in the Payload section. -* Only 1000 elements max will be returned based on the date range. +* The content of a communication is returned through the Binary resource. A reference to the payload is provided in the Payload section. +* Only a maximum of 1000 elements are returned based on the date range. ### Authorization Types @@ -67,11 +67,11 @@ _Notes_ Name | Required? | Type | Description -----------------------------------------------------|---------------|---------------|----------------------------------------------------------------------------------------------------------------------------------------------- - `_id` | Conditionally | [`token`] | The logical resource ID associated with the resource. This parameter is required if `category`, `-email-status`, `recipient` and `received` are not used. Example: `489580643.0.-4.prsnl` - `category` | Conditionally | [`token`] | A token for a [`CodeableConcept`] that points to the CodeableConcept used for `Communication.category`. This parameter is required along with `recipient`, `received` and `-email-status` if `_id` is not used. Example: `http://terminology.hl7.org/CodeSystem/communication-category|notification` - `recipient:Group` or `recipient:Practitioner` | Conditionally | [`reference`] | The recipient of the Communication. This parameter is required along with `category`, `received` and `-email-status` if `_id` is not used. Example: `3456783` - `received` | Conditionally | [`date`] | Date range into which the Communication falls. This parameter is required along with `category`, `recipient` and `-email-status` if `_id` is not used. Example: `ge2017-02-01T10:30:00Z` - `-email-status` | Conditionally | [`token`] | The status of the email. This parameter is required along with `category`, `recipient` and `received` if `_id` is not used. Example: `http://hl7.org/fhir/task-status|in-progress` + `_id` | Conditionally | [`token`] | The logical resource ID associated with the resource. This parameter is required if `category`, `-email-status`, `recipient`, and `received` are not used. Example: `489580643.0.-4.prsnl` + `category` | Conditionally | [`token`] | A token for a [`CodeableConcept`] that points to the CodeableConcept used for `Communication.category`. This parameter is required with `recipient`, `received`, and `-email-status` if `_id` is not used. Example: `http://terminology.hl7.org/CodeSystem/communication-category|notification` + `recipient:Group` or `recipient:Practitioner` | Conditionally | [`reference`] | The recipient of the communication. This parameter is required with `category`, `received`, and `-email-status` if `_id` is not used. Example: `3456783` + `received` | Conditionally | [`date`] | The date range that the communication falls within. This parameter is required with `category`, `recipient`, and `-email-status` if `_id` is not used. Example: `ge2017-02-01T10:30:00Z` + `-email-status` | Conditionally | [`token`] | The status of the email. This parameter is required with `category`, `recipient`, and `received` if `_id` is not used. Example: `http://hl7.org/fhir/task-status|in-progress` Notes: @@ -97,7 +97,7 @@ _Notes_ ## Retrieve by ID -List an individual Communication by its ID: +List an individual communication by its ID. GET /Communication/:id @@ -122,14 +122,14 @@ List an individual Communication by its ID: ## Create -Create a new Communication. +Create a new communication. POST /Communication _Notes_ -* Only the body fields mentioned below are supported. Unsupported fields will be ignored. -* Modifier fields should not be provided, and will cause the transaction to fail. +* Only the body fields mentioned below are supported. Unsupported fields are ignored. +* Do not provide modifier fields because they cause the transaction to fail. ### Authorization Types @@ -176,13 +176,13 @@ The `ETag` response header indicates the current `If-Match` version to use on su ## Patch -Patch an existing Communication. +Patch an existing communication. PATCH /Communication/:id _Notes_ -* This implementation follows the [JSON PATCH](https://tools.ietf.org/html/rfc6902) spec. +* This implementation follows the [JSON PATCH](https://tools.ietf.org/html/rfc6902) specification. * Only operations on the paths listed below are supported. ### Authorization Types From 7ac8b611cceb2a34b97ca088ec2611bbff361ca2 Mon Sep 17 00:00:00 2001 From: RicardoCrespo-ora Date: Mon, 4 Dec 2023 08:55:40 -0600 Subject: [PATCH 4/6] addressing comments --- .../r4/clinical/request-and-response/communication.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/millennium/r4/clinical/request-and-response/communication.md b/content/millennium/r4/clinical/request-and-response/communication.md index c536db916..03c2265b8 100644 --- a/content/millennium/r4/clinical/request-and-response/communication.md +++ b/content/millennium/r4/clinical/request-and-response/communication.md @@ -79,6 +79,7 @@ _Notes_ * The `received` parameter may be provided: * Once with the `ge` prefix. * Twice with the lower value prefixed by `ge` and the higher value prefixed by `le`. + * Must be provided with a time component. ### Headers @@ -128,8 +129,7 @@ Create a new communication. _Notes_ -* Only the body fields mentioned below are supported. Unsupported fields are ignored. -* Do not provide modifier fields because they cause the transaction to fail. +* Only the body fields mentioned below are supported. Unsupported fields are ignored, or can cause errors. ### Authorization Types From 4ea7713b5bacbfeb77effc6492d31f0a1c4368c5 Mon Sep 17 00:00:00 2001 From: Ricard Crespo <143555600+RicardoCrespo-ora@users.noreply.github.com> Date: Fri, 15 Dec 2023 09:17:59 -0600 Subject: [PATCH 5/6] Update content/millennium/r4/clinical/request-and-response/communication.md Co-authored-by: Aaron McGinn --- .../r4/clinical/request-and-response/communication.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/millennium/r4/clinical/request-and-response/communication.md b/content/millennium/r4/clinical/request-and-response/communication.md index 03c2265b8..b7e0eeede 100644 --- a/content/millennium/r4/clinical/request-and-response/communication.md +++ b/content/millennium/r4/clinical/request-and-response/communication.md @@ -56,7 +56,7 @@ Search for communications that meet supplied query parameters. _Notes_ -* The content of a communication is returned through the Binary resource. A reference to the payload is provided in the Payload section. +* The content of a communication is returned through the Binary resource. A reference to the payload is provided in `Communication.payload.contentReference`. * Only a maximum of 1000 elements are returned based on the date range. ### Authorization Types From 1c41d66d1764d9e8f8dd79ca7ecc38edcb6668ff Mon Sep 17 00:00:00 2001 From: Ricard Crespo <143555600+RicardoCrespo-ora@users.noreply.github.com> Date: Fri, 15 Dec 2023 09:18:46 -0600 Subject: [PATCH 6/6] Update content/millennium/r4/clinical/request-and-response/communication.md Co-authored-by: Aaron McGinn --- .../r4/clinical/request-and-response/communication.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/millennium/r4/clinical/request-and-response/communication.md b/content/millennium/r4/clinical/request-and-response/communication.md index b7e0eeede..ebd4823d2 100644 --- a/content/millennium/r4/clinical/request-and-response/communication.md +++ b/content/millennium/r4/clinical/request-and-response/communication.md @@ -182,7 +182,7 @@ Patch an existing communication. _Notes_ -* This implementation follows the [JSON PATCH](https://tools.ietf.org/html/rfc6902) specification. +* This implementation follows RFC 6902, [JSON Patch](https://tools.ietf.org/html/rfc6902). * Only operations on the paths listed below are supported. ### Authorization Types