From b24272f9e71a2951071259f0d43420ade4113388 Mon Sep 17 00:00:00 2001 From: Kennan Keim Date: Fri, 29 Sep 2023 12:15:26 -0500 Subject: [PATCH 01/11] Updated DiagnosticReportR4 Resource - Reworded and expanded Overview paragraph - Moved all shortname links to the end of the file, instead of following the Parameters section - Linked to related resources where appropriate (e.g. out to Observation in the Overview) - Parameters list corrected/adjusted. - Category and Code in particular needed updated to match the resource's behavior (yaml file was up to date on behavior) - _Revinclude parameter details adjusted, similar to other resources we've touched recently - Several Example-related updates - Header changes for clarity on which Example does what - Patient search example changed and added the Ccategory parameter in request. Response structure has substantially more detail now - Minor updates to other search/retrieve examples (added "display" names on providers) --- .../clinical/diagnostics/diagnostic-report.md | 51 ++++++----- .../r4_examples_diagnostic_report.rb | 91 ++++++++++++------- 2 files changed, 89 insertions(+), 53 deletions(-) diff --git a/content/millennium/r4/clinical/diagnostics/diagnostic-report.md b/content/millennium/r4/clinical/diagnostics/diagnostic-report.md index b4058a9e5..ed7779b01 100644 --- a/content/millennium/r4/clinical/diagnostics/diagnostic-report.md +++ b/content/millennium/r4/clinical/diagnostics/diagnostic-report.md @@ -8,7 +8,12 @@ title: DiagnosticReport | R4 API {:toc} ## Overview -The DiagnosticReport resource typically provides a textual set of information and interpretation after performing a diagnostic service or procedure such as a Radiology or Pathology or Cardiology report. A diagnostic report is the set of information that is typically provided by a diagnostic service when investigations are complete. The information includes a mix of atomic results, text reports, images, and codes. The DiagnosticReport resource has information about the diagnostic report itself, and about the subject and, in the case of laboratory tests, the specimen of the report. Report conclusions can be expressed as a simple text blob, structured coded data or as an attached fully formatted report such as a PDF. +The DiagnosticReport resource provides a set of information and interpretation following a diagnostic service or procedure such as a Radiology, Pathology, or Cardiology report. The DiagnosticReport resource will produce information about the diagnostic report itself, about the subject, and about the specimen of the report in the case of Laboratory tests. The information produced can include a mix of atomic results, textual reports, images, and codes, depending on the type(s) of diagnostic services being retrieved. + +Report conclusions can be expressed as a simple text blob, structured coded data, or as an attached fully formatted report (such as a PDF). +This resource can retrieve reports of various `Status` types which may need to be considered for filtering purposes if only `Final` or `Corrected` results are desired for retrieval, or to exclude any results that were `Entered-in-Error`. See the `Status` field below for more detail. + +In cases where results without textual reports are desired, such as General Laboratory or Vital Signs results, the [`Observation`] resource should be used instead. * 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: @@ -61,12 +66,12 @@ The following fields are returned if valued: ------------------|-------------------|---------------|----------------------------------------------------------------------------------------------------------------------------------------- `_id` | This or `patient` | [`token`] | The logical resource id associated with the resource. Example: `12345` `patient` | This or `_id` | [`reference`] | The subject of the report if a patient. Example: `12345` - `encounter` | N | [`reference`] | The Encounter when the order was made. Must represent an Encounter resource. May include a single or comma separated list of references. Example: `encounter=1621910` - `date` | N | [`date`] | Date range into which the diagnostic report falls (effectiveDateTime). Either 1 or 2 date/time can be given. Example: `date=lt2017-01-5` - `_count` | N | [`number`] | The maximum number of results to return. Defaults to `10` and maximum `100` documents can be returned. - `category` | N | [`token`] | The diagnostic discipline/department created the report. Example: `{{*[http://loinc.org\\\|P7839-6* or +*LAB*(For micro/Gen lab reports)+}}\\|http://loinc.org/]` - `code` | N | [`token`] | The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result. Example: `*[http://loinc.org\\\|630-4*\\|http://loinc.org/]` - `_revinclude` | No | [`token`] | Provenance resource entries to be returned as part of the bundle. Example: `_revinclude=Provenance:target` + `encounter` | N | [`reference`] | The Encounter when the order was made. Must represent an Encounter resource. Example: `encounter=1621910` + `date` | N | [`date`] | Date range into which the diagnostic report falls (effectiveDateTime). Either 1 or 2 date/times can be given. Example: `date=lt2017-01-5` + `_count` | N | [`number`] | The maximum number of results to return. Defaults to `10` and a maximum of `100` documents can be returned. + `category` | N | [`token`] | The diagnostic discipline/department which created the report. Example: `http://terminology.hl7.org/CodeSystem/v2-0074|LAB` or `http://loinc.org|LP29684-5` + `code` | N | [`token`] | The specific code for describing the report. Example: `http://loinc.org|24323-8` + `_revinclude` | N | [`token`] | Provenance resource entries to be returned as part of the bundle. Example: `_revinclude=Provenance:target` _Implementation Notes_ @@ -76,32 +81,25 @@ _Implementation Notes_ * When searching with the `encounter` parameter: * Patient level documents are filtered out from responses when the encounter id is zero/blank. + * May include a single value or comma separated list of references. Example `encounter=12345,67890` -* The `_revinclude` parameter may be provided once with the value `Provenance:target`. Example: `_revinclude=Provenance:target` - -* The `_revinclude` parameter may be provided with the `_id/patient` parameter. Example: `_id=214938095&_revinclude=Provenance:target` +* When searching with the `_revinclude` parameter + * It may be provided once with the value `Provenance:target`. Example: `_revinclude=Provenance:target` + * It may be provided with the `_id` or `patient` parameters. Example: `_id=214938095&_revinclude=Provenance:target` * When `_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 utilised for patient persona. The common [errors] and [OperationOutcomes] may be returned. -[`token`]: https://hl7.org/fhir/R4/search.html#token -[`reference`]: https://hl7.org/fhir/R4/search.html#reference -[`date`]: https://hl7.org/fhir/R4/search.html#date -[`number`]: https://hl7.org/fhir/R4/search.html#number -[errors]: ../../#client-errors -[OperationOutcomes]: ../../#operation-outcomes -[Update documentation]: https://www.hl7.org/fhir/r4/http.html#update - ### Headers <%= headers %> -### Example +### Example Search by Patient with Category #### Request - GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport?patient=12724066 + GET https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport?patient=12724066&category=http://terminology.hl7.org/CodeSystem/v2-0074|RAD #### Response @@ -111,7 +109,7 @@ The common [errors] and [OperationOutcomes] may be returned. <%= disclaimer %> -### Example with RevInclude +### Example Search by _ID with RevInclude ### Authorization Types @@ -148,7 +146,7 @@ The common [errors] and [OperationOutcomes] may be returned. <%= headers %> -### Example +### Example Single Retrieve by _ID #### Request @@ -164,3 +162,12 @@ The common [errors] and [OperationOutcomes] may be returned. ### Errors The common [errors] and [OperationOutcomes] may be returned. + +[`token`]: https://hl7.org/fhir/R4/search.html#token +[`reference`]: https://hl7.org/fhir/R4/search.html#reference +[`date`]: https://hl7.org/fhir/R4/search.html#date +[`number`]: https://hl7.org/fhir/R4/search.html#number +[errors]: ../../#client-errors +[OperationOutcomes]: ../../#operation-outcomes +[Update documentation]: https://www.hl7.org/fhir/r4/http.html#update +[`Observation`]: ../Observation diff --git a/lib/resources/example_json/r4_examples_diagnostic_report.rb b/lib/resources/example_json/r4_examples_diagnostic_report.rb index e5d545ae0..a2629de32 100644 --- a/lib/resources/example_json/r4_examples_diagnostic_report.rb +++ b/lib/resources/example_json/r4_examples_diagnostic_report.rb @@ -4,38 +4,44 @@ module Cerner module Resources R4_DIAGNOSTIC_REPORT_SEARCH_BY_ID ||= { "resourceType": 'Bundle', - "id": '2bae404f-007d-4abf-8552-6e540f0226b6', + "id": '4e95721b-490b-4c57-84f5-7d055a8a5dec', "type": 'searchset', "link": [ + { + "relation": 'self', + "url": 'https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport?patient=12724066&category=http%3A%2F%2Fterminology.hl7.org%2FCodeSystem%2Fv2-0074%7CRAD' + }, { - "relation": 'self', - "url": 'https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport?patient=12724066' + "relation": 'next', + "url": 'https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport?patient=12724066&category=http%3A%2F%2Fterminology.hl7.org%2FCodeSystem%2Fv2-0074%7CRAD&-pageContext=eJwdyk0KwjAURtG9fOME8jTNT8GJbqBQcVpCmtaCJJImKJTu3eLwHu4Gn2osaEkwjGFy9XXEBl_zmjJa3Lqclofsr59lpq7eSy8vYHi6dYjhe7wl18DwdnMYfIrlb2hO9mxISG61aLgkIbihMHIySupJKU3WYd9_FHYmXg%3D%3D&-pageDirection=NEXT' } ], "entry": [ { - "fullUrl": 'https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport/197480987', + "fullUrl": 'https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport/197369077', "resource": { "resourceType": 'DiagnosticReport', - "id": '197480987', + "id": '197369077', "meta": { "versionId": '1', - "lastUpdated": '2021-05-11T18:17:17.000Z' + "lastUpdated": '2020-08-13T19:36:06.000Z' }, "text": { "status": 'generated', - "div": '

Diagnostic Report

'\ - '

Patient: Smart, Nancyu Nha Eeeeee

Status: Partial

'\ - '

Code: Abdominal Ultrasound

'\ - 'Effective End Date: May 11, 2021 6:16 P.M. UTC

' + "div": '

Diagnostic Report

'\ + '

Patient: Smart II, Nancy

'\ + '

Document Title: Some Title 4x

'\ + '

Status: Final

'\ + '

Code: Radiology Reports

'\ + '

Effective End Date: Aug 13, 2020 7:36 P.M. UTC

Verifying Provider: Portal, Portal

' }, "identifier": [ { "system": 'https://fhir.cerner.com/ceuuid', - "value": 'CE87caf4b7-9397-4667-9897-702218017c9e-197480987-2021051118171700' + "value": 'CE87caf4b7-9397-4667-9897-702218017c9e-197369077-2020081319360600' } ], - "status": 'partial', + "status": 'final', "category": [ { "coding": [ @@ -52,40 +58,59 @@ module Resources "coding": [ { "system": 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72', - "code": '2820643', - "display": 'Abdominal Ultrasound', + "code": '63293819', + "display": 'Radiology Reports', "userSelected": true }, { "system": 'http://loinc.org', - "code": '24558-9', + "code": '75490-3', "userSelected": false } ], - "text": 'Abdominal Ultrasound' + "text": 'Radiology Reports' }, "subject": { "reference": 'Patient/12724066', - "display": 'Smart, Nancyu Nha Eeeeee' + "display": 'Smart II, Nancy' + }, + "encounter": { + "reference": 'Encounter/97953477' }, "effectivePeriod": { - "end": '2021-05-11T18:16:00.000Z' + "end": '2020-08-13T19:36:00.000Z' }, - "issued": '2021-05-11T18:17:17Z', + "issued": '2020-08-13T19:36:06Z', "performer": [ { - "reference": 'Practitioner/1', - "display": 'SYSTEM, SYSTEM Cerner' + "reference": 'Practitioner/12742069', + "display": "Portal, Portal" + } + ], + "resultsInterpreter": [ + { + "reference": 'Practitioner/12742069', + "display": 'Portal, Portal' } ], "presentedForm": [ { - "extension": [ - { - "valueCode": 'unsupported', - "url": 'http://hl7.org/fhir/StructureDefinition/data-absent-reason' - } - ] + "contentType": 'application/pdf', + "url": 'https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/XR-197369077', + "title": 'Some Title 4x', + "creation": '2020-08-13T19:36:00.000Z' + }, + { + "contentType": 'application/xml', + "url": 'https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/XML-197369077', + "title": 'Some Title 4x', + "creation": '2020-08-13T19:36:00.000Z' + }, + { + "contentType": 'text/html', + "url": 'https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/TR-197369077', + "title": 'Some Title 4x', + "creation": '2020-08-13T19:36:00.000Z' } ] }, @@ -165,12 +190,14 @@ module Resources "issued": '2017-01-06T20:09:17Z', "performer": [ { - "reference": 'Practitioner/11648064' + "reference": 'Practitioner/11648064', + "display": 'Model, User 437 Cerner' } ], "resultsInterpreter": [ { - "reference": 'Practitioner/11648064' + "reference": 'Practitioner/11648064', + "display": 'Model, User 437 Cerner' } ], "presentedForm": [ @@ -271,12 +298,14 @@ module Resources "issued": '2017-01-06T20:09:17Z', "performer": [ { - "reference": 'Practitioner/11648064' + "reference": 'Practitioner/11648064', + "display": 'Model, User 437 Cerner' } ], "resultsInterpreter": [ { - "reference": 'Practitioner/11648064' + "reference": 'Practitioner/11648064', + "display": 'Model, User 437 Cerner' } ], "presentedForm": [ From c868bf0044522dddad5de74e10e3b59aebce3c50 Mon Sep 17 00:00:00 2001 From: Kennan Keim Date: Fri, 29 Sep 2023 12:21:18 -0500 Subject: [PATCH 02/11] Observation R4 resource change --- content/millennium/r4/clinical/diagnostics/diagnostic-report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/millennium/r4/clinical/diagnostics/diagnostic-report.md b/content/millennium/r4/clinical/diagnostics/diagnostic-report.md index ed7779b01..b1e337e7a 100644 --- a/content/millennium/r4/clinical/diagnostics/diagnostic-report.md +++ b/content/millennium/r4/clinical/diagnostics/diagnostic-report.md @@ -170,4 +170,4 @@ The common [errors] and [OperationOutcomes] may be returned. [errors]: ../../#client-errors [OperationOutcomes]: ../../#operation-outcomes [Update documentation]: https://www.hl7.org/fhir/r4/http.html#update -[`Observation`]: ../Observation +[`Observation`]: /Observation From 0dd203b22ea8c9a628b393b8b7c2c72c85ca4ed5 Mon Sep 17 00:00:00 2001 From: Kennan Keim Date: Fri, 29 Sep 2023 12:36:08 -0500 Subject: [PATCH 03/11] Observation link still not behaving + escapes add --- .../millennium/r4/clinical/diagnostics/diagnostic-report.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/millennium/r4/clinical/diagnostics/diagnostic-report.md b/content/millennium/r4/clinical/diagnostics/diagnostic-report.md index b1e337e7a..e58a47539 100644 --- a/content/millennium/r4/clinical/diagnostics/diagnostic-report.md +++ b/content/millennium/r4/clinical/diagnostics/diagnostic-report.md @@ -69,8 +69,8 @@ The following fields are returned if valued: `encounter` | N | [`reference`] | The Encounter when the order was made. Must represent an Encounter resource. Example: `encounter=1621910` `date` | N | [`date`] | Date range into which the diagnostic report falls (effectiveDateTime). Either 1 or 2 date/times can be given. Example: `date=lt2017-01-5` `_count` | N | [`number`] | The maximum number of results to return. Defaults to `10` and a maximum of `100` documents can be returned. - `category` | N | [`token`] | The diagnostic discipline/department which created the report. Example: `http://terminology.hl7.org/CodeSystem/v2-0074|LAB` or `http://loinc.org|LP29684-5` - `code` | N | [`token`] | The specific code for describing the report. Example: `http://loinc.org|24323-8` + `category` | N | [`token`] | The diagnostic discipline/department which created the report. Example: `http://terminology.hl7.org/CodeSystem/v2-0074\|LAB` or `http://loinc.org|LP29684-5` + `code` | N | [`token`] | The specific code for describing the report. Example: `http://loinc.org\|24323-8` `_revinclude` | N | [`token`] | Provenance resource entries to be returned as part of the bundle. Example: `_revinclude=Provenance:target` _Implementation Notes_ @@ -170,4 +170,4 @@ The common [errors] and [OperationOutcomes] may be returned. [errors]: ../../#client-errors [OperationOutcomes]: ../../#operation-outcomes [Update documentation]: https://www.hl7.org/fhir/r4/http.html#update -[`Observation`]: /Observation +[`Observation`]: ./Observation From b6f115ec3cb864f65bcd16561d82b81459a274d4 Mon Sep 17 00:00:00 2001 From: Kennan Keim Date: Fri, 29 Sep 2023 12:37:17 -0500 Subject: [PATCH 04/11] One more escaped pipe - should have them all now --- content/millennium/r4/clinical/diagnostics/diagnostic-report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/millennium/r4/clinical/diagnostics/diagnostic-report.md b/content/millennium/r4/clinical/diagnostics/diagnostic-report.md index e58a47539..95d3197bb 100644 --- a/content/millennium/r4/clinical/diagnostics/diagnostic-report.md +++ b/content/millennium/r4/clinical/diagnostics/diagnostic-report.md @@ -69,7 +69,7 @@ The following fields are returned if valued: `encounter` | N | [`reference`] | The Encounter when the order was made. Must represent an Encounter resource. Example: `encounter=1621910` `date` | N | [`date`] | Date range into which the diagnostic report falls (effectiveDateTime). Either 1 or 2 date/times can be given. Example: `date=lt2017-01-5` `_count` | N | [`number`] | The maximum number of results to return. Defaults to `10` and a maximum of `100` documents can be returned. - `category` | N | [`token`] | The diagnostic discipline/department which created the report. Example: `http://terminology.hl7.org/CodeSystem/v2-0074\|LAB` or `http://loinc.org|LP29684-5` + `category` | N | [`token`] | The diagnostic discipline/department which created the report. Example: `http://terminology.hl7.org/CodeSystem/v2-0074\|LAB` or `http://loinc.org\|LP29684-5` `code` | N | [`token`] | The specific code for describing the report. Example: `http://loinc.org\|24323-8` `_revinclude` | N | [`token`] | Provenance resource entries to be returned as part of the bundle. Example: `_revinclude=Provenance:target` From 62d36d9d9250ddee8066e29d659a59ede4b61d23 Mon Sep 17 00:00:00 2001 From: Kennan Keim Date: Fri, 29 Sep 2023 12:41:03 -0500 Subject: [PATCH 05/11] Forced link now Can't get the relative link behaving without some other foundational work. Adding it to the list of relative links to build --- .../millennium/r4/clinical/diagnostics/diagnostic-report.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/content/millennium/r4/clinical/diagnostics/diagnostic-report.md b/content/millennium/r4/clinical/diagnostics/diagnostic-report.md index 95d3197bb..9f34a0521 100644 --- a/content/millennium/r4/clinical/diagnostics/diagnostic-report.md +++ b/content/millennium/r4/clinical/diagnostics/diagnostic-report.md @@ -13,7 +13,7 @@ The DiagnosticReport resource provides a set of information and interpretation f Report conclusions can be expressed as a simple text blob, structured coded data, or as an attached fully formatted report (such as a PDF). This resource can retrieve reports of various `Status` types which may need to be considered for filtering purposes if only `Final` or `Corrected` results are desired for retrieval, or to exclude any results that were `Entered-in-Error`. See the `Status` field below for more detail. -In cases where results without textual reports are desired, such as General Laboratory or Vital Signs results, the [`Observation`] resource should be used instead. +In cases where results without textual reports are desired, such as General Laboratory or Vital Signs results, the [`Observation`](http://fhir.cerner.com/millennium/r4/clinical/diagnostics/observation/) resource should be used instead. * 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: @@ -170,4 +170,3 @@ The common [errors] and [OperationOutcomes] may be returned. [errors]: ../../#client-errors [OperationOutcomes]: ../../#operation-outcomes [Update documentation]: https://www.hl7.org/fhir/r4/http.html#update -[`Observation`]: ./Observation From 6e5b74b4775722fc485eefab3438530e2579aab4 Mon Sep 17 00:00:00 2001 From: Kennan Keim Date: Fri, 29 Sep 2023 12:54:33 -0500 Subject: [PATCH 06/11] Add Top section of the Retrieve by ID portion of the page --- .../millennium/r4/clinical/diagnostics/diagnostic-report.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/content/millennium/r4/clinical/diagnostics/diagnostic-report.md b/content/millennium/r4/clinical/diagnostics/diagnostic-report.md index 9f34a0521..2220ec3dc 100644 --- a/content/millennium/r4/clinical/diagnostics/diagnostic-report.md +++ b/content/millennium/r4/clinical/diagnostics/diagnostic-report.md @@ -137,6 +137,11 @@ The common [errors] and [OperationOutcomes] may be returned. ## Retrieve by id +Retrieve an individual DiagnosticReport by its id: + + GET /DiagnosticReport/:id + + ### Authorization Types <%= authorization_types(provider: true, patient: true, system: true) %> From d91283f98a4b52dc1eeba483ffba02a711d34264 Mon Sep 17 00:00:00 2001 From: Kennan Keim Date: Fri, 29 Sep 2023 13:58:03 -0500 Subject: [PATCH 07/11] formatting fixes to example file to pass Rubocop --- .../example_json/r4_examples_diagnostic_report.rb | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/lib/resources/example_json/r4_examples_diagnostic_report.rb b/lib/resources/example_json/r4_examples_diagnostic_report.rb index a2629de32..48beffedd 100644 --- a/lib/resources/example_json/r4_examples_diagnostic_report.rb +++ b/lib/resources/example_json/r4_examples_diagnostic_report.rb @@ -7,9 +7,9 @@ module Resources "id": '4e95721b-490b-4c57-84f5-7d055a8a5dec', "type": 'searchset', "link": [ - { - "relation": 'self', - "url": 'https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport?patient=12724066&category=http%3A%2F%2Fterminology.hl7.org%2FCodeSystem%2Fv2-0074%7CRAD' + { + "relation": 'self', + "url": 'https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport?patient=12724066&category=http%3A%2F%2Fterminology.hl7.org%2FCodeSystem%2Fv2-0074%7CRAD' }, { "relation": 'next', @@ -33,7 +33,8 @@ module Resources '

Document Title: Some Title 4x

'\ '

Status: Final

'\ '

Code: Radiology Reports

'\ - '

Effective End Date: Aug 13, 2020 7:36 P.M. UTC

Verifying Provider: Portal, Portal

' + '

Effective End Date: Aug 13, 2020 7:36 P.M. UTC

'\ + '

Verifying Provider: Portal, Portal

' }, "identifier": [ { @@ -84,7 +85,7 @@ module Resources "performer": [ { "reference": 'Practitioner/12742069', - "display": "Portal, Portal" + "display": 'Portal, Portal' } ], "resultsInterpreter": [ From 359d9f34688e07654c873687383916fe4cbbb564 Mon Sep 17 00:00:00 2001 From: Kennan Keim Date: Fri, 29 Sep 2023 14:04:23 -0500 Subject: [PATCH 08/11] Replaced auto-inserted tabs on correcting an issue --- lib/resources/example_json/r4_examples_diagnostic_report.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/resources/example_json/r4_examples_diagnostic_report.rb b/lib/resources/example_json/r4_examples_diagnostic_report.rb index 48beffedd..876417e67 100644 --- a/lib/resources/example_json/r4_examples_diagnostic_report.rb +++ b/lib/resources/example_json/r4_examples_diagnostic_report.rb @@ -34,7 +34,7 @@ module Resources '

Status: Final

'\ '

Code: Radiology Reports

'\ '

Effective End Date: Aug 13, 2020 7:36 P.M. UTC

'\ - '

Verifying Provider: Portal, Portal

' + '

Verifying Provider: Portal, Portal

' }, "identifier": [ { From c1a8511ae36ff265ad180c30c07ed05bafc154d2 Mon Sep 17 00:00:00 2001 From: Kennan Keim Date: Mon, 2 Oct 2023 10:40:21 -0500 Subject: [PATCH 09/11] Flipped updated example to Open endpoint Flipped the updated example's call to the Open endpoint, for ease of developers' use. --- .../r4/clinical/diagnostics/diagnostic-report.md | 2 +- .../example_json/r4_examples_diagnostic_report.rb | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/content/millennium/r4/clinical/diagnostics/diagnostic-report.md b/content/millennium/r4/clinical/diagnostics/diagnostic-report.md index 2220ec3dc..76e640aee 100644 --- a/content/millennium/r4/clinical/diagnostics/diagnostic-report.md +++ b/content/millennium/r4/clinical/diagnostics/diagnostic-report.md @@ -99,7 +99,7 @@ The common [errors] and [OperationOutcomes] may be returned. #### Request - GET https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport?patient=12724066&category=http://terminology.hl7.org/CodeSystem/v2-0074|RAD + GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport?patient=12724066&category=http://terminology.hl7.org/CodeSystem/v2-0074|RAD #### Response diff --git a/lib/resources/example_json/r4_examples_diagnostic_report.rb b/lib/resources/example_json/r4_examples_diagnostic_report.rb index 876417e67..732db3ae4 100644 --- a/lib/resources/example_json/r4_examples_diagnostic_report.rb +++ b/lib/resources/example_json/r4_examples_diagnostic_report.rb @@ -9,16 +9,16 @@ module Resources "link": [ { "relation": 'self', - "url": 'https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport?patient=12724066&category=http%3A%2F%2Fterminology.hl7.org%2FCodeSystem%2Fv2-0074%7CRAD' + "url": 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport?patient=12724066&category=http%3A%2F%2Fterminology.hl7.org%2FCodeSystem%2Fv2-0074%7CRAD' }, { "relation": 'next', - "url": 'https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport?patient=12724066&category=http%3A%2F%2Fterminology.hl7.org%2FCodeSystem%2Fv2-0074%7CRAD&-pageContext=eJwdyk0KwjAURtG9fOME8jTNT8GJbqBQcVpCmtaCJJImKJTu3eLwHu4Gn2osaEkwjGFy9XXEBl_zmjJa3Lqclofsr59lpq7eSy8vYHi6dYjhe7wl18DwdnMYfIrlb2hO9mxISG61aLgkIbihMHIySupJKU3WYd9_FHYmXg%3D%3D&-pageDirection=NEXT' + "url": 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport?patient=12724066&category=http%3A%2F%2Fterminology.hl7.org%2FCodeSystem%2Fv2-0074%7CRAD&-pageContext=eJwdyk0KwjAURtG9fOME8jTNT8GJbqBQcVpCmtaCJJImKJTu3eLwHu4Gn2osaEkwjGFy9XXEBl_zmjJa3Lqclofsr59lpq7eSy8vYHi6dYjhe7wl18DwdnMYfIrlb2hO9mxISG61aLgkIbihMHIySupJKU3WYd9_FHYmXg%3D%3D&-pageDirection=NEXT' } ], "entry": [ { - "fullUrl": 'https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport/197369077', + "fullUrl": 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport/197369077', "resource": { "resourceType": 'DiagnosticReport', "id": '197369077', @@ -97,19 +97,19 @@ module Resources "presentedForm": [ { "contentType": 'application/pdf', - "url": 'https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/XR-197369077', + "url": 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/XR-197369077', "title": 'Some Title 4x', "creation": '2020-08-13T19:36:00.000Z' }, { "contentType": 'application/xml', - "url": 'https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/XML-197369077', + "url": 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/XML-197369077', "title": 'Some Title 4x', "creation": '2020-08-13T19:36:00.000Z' }, { "contentType": 'text/html', - "url": 'https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/TR-197369077', + "url": 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/TR-197369077', "title": 'Some Title 4x', "creation": '2020-08-13T19:36:00.000Z' } From 0ce8fbcf9bc9a126e623fb10756f4f3ff794ac8f Mon Sep 17 00:00:00 2001 From: kckeim Date: Mon, 23 Oct 2023 12:45:42 -0500 Subject: [PATCH 10/11] Removed extraneous vertical pipe escapes --- .../millennium/r4/clinical/diagnostics/diagnostic-report.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/millennium/r4/clinical/diagnostics/diagnostic-report.md b/content/millennium/r4/clinical/diagnostics/diagnostic-report.md index 76e640aee..ee3dd4247 100644 --- a/content/millennium/r4/clinical/diagnostics/diagnostic-report.md +++ b/content/millennium/r4/clinical/diagnostics/diagnostic-report.md @@ -69,8 +69,8 @@ The following fields are returned if valued: `encounter` | N | [`reference`] | The Encounter when the order was made. Must represent an Encounter resource. Example: `encounter=1621910` `date` | N | [`date`] | Date range into which the diagnostic report falls (effectiveDateTime). Either 1 or 2 date/times can be given. Example: `date=lt2017-01-5` `_count` | N | [`number`] | The maximum number of results to return. Defaults to `10` and a maximum of `100` documents can be returned. - `category` | N | [`token`] | The diagnostic discipline/department which created the report. Example: `http://terminology.hl7.org/CodeSystem/v2-0074\|LAB` or `http://loinc.org\|LP29684-5` - `code` | N | [`token`] | The specific code for describing the report. Example: `http://loinc.org\|24323-8` + `category` | N | [`token`] | The diagnostic discipline/department which created the report. Example: `http://terminology.hl7.org/CodeSystem/v2-0074|LAB` or `http://loinc.org|LP29684-5` + `code` | N | [`token`] | The specific code for describing the report. Example: `http://loinc.org|24323-8` `_revinclude` | N | [`token`] | Provenance resource entries to be returned as part of the bundle. Example: `_revinclude=Provenance:target` _Implementation Notes_ From 555822efabd392de609fcc113d789c2038fd8fb7 Mon Sep 17 00:00:00 2001 From: kckeim Date: Mon, 23 Oct 2023 14:43:47 -0500 Subject: [PATCH 11/11] Updates/edits per Aaron McGinn --- .../clinical/diagnostics/diagnostic-report.md | 23 +++++++++++++------ 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/content/millennium/r4/clinical/diagnostics/diagnostic-report.md b/content/millennium/r4/clinical/diagnostics/diagnostic-report.md index ee3dd4247..80c1fc372 100644 --- a/content/millennium/r4/clinical/diagnostics/diagnostic-report.md +++ b/content/millennium/r4/clinical/diagnostics/diagnostic-report.md @@ -56,6 +56,11 @@ The following fields are returned if valued: ## Search +Search for DiagnosticReports that meet supplied query parameters: + + GET /DiagnosticReport/?:parameters + + ### Authorization Types <%= authorization_types(provider: true, patient: true, system: true) %> @@ -67,7 +72,7 @@ The following fields are returned if valued: `_id` | This or `patient` | [`token`] | The logical resource id associated with the resource. Example: `12345` `patient` | This or `_id` | [`reference`] | The subject of the report if a patient. Example: `12345` `encounter` | N | [`reference`] | The Encounter when the order was made. Must represent an Encounter resource. Example: `encounter=1621910` - `date` | N | [`date`] | Date range into which the diagnostic report falls (effectiveDateTime). Either 1 or 2 date/times can be given. Example: `date=lt2017-01-5` + `date` | N | [`date`] | Date range into which the diagnostic report falls (effectiveDateTime). Either 1 or 2 date/times can be given. Example: `date=ge2020-01-01T08:00:00.000Z&date=le2020-01-31T17:00:00.000Z` `_count` | N | [`number`] | The maximum number of results to return. Defaults to `10` and a maximum of `100` documents can be returned. `category` | N | [`token`] | The diagnostic discipline/department which created the report. Example: `http://terminology.hl7.org/CodeSystem/v2-0074|LAB` or `http://loinc.org|LP29684-5` `code` | N | [`token`] | The specific code for describing the report. Example: `http://loinc.org|24323-8` @@ -76,8 +81,12 @@ The following fields are returned if valued: _Implementation Notes_ * When searching with the `date` parameter: - * It must be provided once or twice, with or without prefixes. - * If time is provided, it must be provided consistently. + * For a single `date` occurrence: + * It can be provided with a prefix to imply a date range, or without a prefix to search for report(s) last updated at a specific date/time. + * The `time` component is optional. + * For two `date` occurences: + * It must be provided with `le` or `lt` and `ge` or `gt` prefixes to search for report(s) within a specific range. + * The `time` component is required for both parameters. * When searching with the `encounter` parameter: * Patient level documents are filtered out from responses when the encounter id is zero/blank. @@ -109,7 +118,7 @@ The common [errors] and [OperationOutcomes] may be returned. <%= disclaimer %> -### Example Search by _ID with RevInclude +### Example Search by _id with RevInclude ### Authorization Types @@ -135,11 +144,11 @@ The common [errors] and [OperationOutcomes] may be returned. The common [errors] and [OperationOutcomes] may be returned. -## Retrieve by id +## Retrieve by ID -Retrieve an individual DiagnosticReport by its id: +Retrieve an individual DiagnosticReport by its ID: - GET /DiagnosticReport/:id + GET /DiagnosticReport/:ID ### Authorization Types