From 7d18ecf6f32b252d30816b6450e78b0d0dfdf0b8 Mon Sep 17 00:00:00 2001 From: Kennan Keim Date: Wed, 20 Sep 2023 14:44:02 -0500 Subject: [PATCH 1/4] Updated DSTU2 Binary Resource General formatting updates Itemized list follows on Pull Request's Description Verified good links throughout document, and have validated that example API calls behave as noted with examples --- .../millennium/dstu2/infrastructure/binary.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/content/millennium/dstu2/infrastructure/binary.md b/content/millennium/dstu2/infrastructure/binary.md index cae08b42c..63d25421a 100644 --- a/content/millennium/dstu2/infrastructure/binary.md +++ b/content/millennium/dstu2/infrastructure/binary.md @@ -10,12 +10,13 @@ title: Binary | DSTU 2 API ## Overview The Binary resource can contain any clinical content such as text, images, and PDFs. This resource is currently limited to Continuity of Care Documents (CCD), clinical documents, and diagnostic reports. +_The list of clinical documents and diagnostic reports is subject to change, as the list of clinical events that may qualify can be customized by clients_ -It is recommended to request all Binary resources only after obtaining a link to the resource via references from DiagnosticReport or DocumentReference. It is not recommended to start a workflow in the Binary resource. +It is recommended to request Binary resources only after obtaining a link to the resource via references from [DiagnosticReport](http://fhir.cerner.com/millennium/r4/clinical/diagnostics/diagnostic-report) or [DocumentReference](http://fhir.cerner.com/millennium/r4/foundation/documents/document-reference). It is not recommended to start a workflow in the Binary resource. -The consumer must populate the Accept header with either application/json+fhir or the format returned in the attachment.contentType of the referring resource. If the Accept header is application/json+fhir, a FHIR Binary resource is returned with the raw data populated in the content. Otherwise, the raw data will be returned (not contained within a FHIR resource). For more information see [the Binary Documentation](http://hl7.org/fhir/dstu2/binary.html#rest). +The consumer must populate the `Accept` header with either `application/json+fhir` or the format returned in the `attachment.contentType` of the referring resource. If the `Accept` header is `application/json+fhir`, a FHIR Binary resource is returned with the raw data populated in the content. Otherwise, the raw data will be returned (not contained within a FHIR resource). For more information see the HL7® FHIR® [Binary Documentation](http://hl7.org/fhir/dstu2/binary.html#rest). -NOTE: To retrieve documents with application/pdf contentType, the client must have installed Cerner’s Clinical Reporting (XR) solution. For additional information about Cerner’s Clinical Reporting (XR) solution see [Clinical Reporting (XR) Reference Pages](https://wiki.ucern.com/display/reference/Clinical+Reporting+XR+Reference+Pages). +NOTE: To retrieve documents with `application/pdf` contentType, the client must have installed Cerner’s Clinical Reporting (XR) solution. For additional information about Cerner’s Clinical Reporting (XR) solution see [Clinical Reporting (XR) Reference Pages](https://wiki.ucern.com/display/reference/Clinical+Reporting+XR+Reference+Pages). The following fields are returned if valued: @@ -31,14 +32,14 @@ List an individual Binary by its id: _Implementation Notes_ -* This is usually linked from DocumentReference or DiagnosticReport and should generally be accessed using the exact link given in the referring resource. Modifying the link has undefined consequences. +* This is usually linked from [DocumentReference](http://fhir.cerner.com/millennium/r4/foundation/documents/document-reference) or [DiagnosticReport](http://fhir.cerner.com/millennium/r4/clinical/diagnostics/diagnostic-report) and should generally be accessed using the exact link given in the referring resource. Modifying the link has undefined consequences. * Documents containing URL sections are unsupported with contentType of `application/pdf` * See the [headers](#headers) section for concerns about the Accept header. * See the [authorization](#authorization-types) section for concerns about the required OAuth scopes. ### Authorization Types -The necessary OAuth scopes can be determined by checking the attachment.contentType in the referring resource. For attachments with the `application/pdf` contentType, the Binary.read and DocumentReference.read scopes are required. For attachments with the `text/html` contentType, the Binary.read and DiagnosticReport.read scopes are required. +The necessary OAuth scopes can be determined by checking the `attachment.contentType` in the referring resource. For attachments with the `application/pdf` contentType, the `Binary.read` and `DocumentReference.read` scopes are required. For attachments with the `text/html` contentType, the `Binary.read` and `DiagnosticReport.read` scopes are required. <%= authorization_types(provider: true, patient: true, system: true) %> @@ -90,13 +91,13 @@ Generates the Continuity of Care Document (CCD) as a Binary for the supplied que _Implementation Notes_ -* This is usually linked from DocumentReference, and should generally be accessed using the exact link given in that resource. Modifying the link has undefined consequences. +* This is usually linked from [DocumentReference](http://fhir.cerner.com/millennium/r4/foundation/documents/document-reference), and should generally be accessed using the exact link given in that resource. Modifying the link has undefined consequences. * See the [headers](#headers-1) section for concerns about the Accept header. * See the [authorization](#authorization-types-1) section for concerns about the required OAuth scopes. ### Authorization Types -Requires both the appropriate Binary.read and DocumentReference.read scopes to be granted to the caller. +Requires both the appropriate `Binary.read` and `DocumentReference.read` scopes to be granted to the caller. <%= authorization_types(provider: true, patient: true, system: true) %> @@ -114,7 +115,8 @@ Notes: ### Headers -The `DocumentReference.content.attachment.contentType` should be used to set the `Accept` header. An `Accept` header of `application/json+fhir` could be supplied instead, if the JSON Binary resource is desired insetad of the raw data. +The `DocumentReference.content.attachment.contentType` should be used to set the `Accept` header. +An `Accept` header of `application/json+fhir` could be supplied instead, if the JSON Binary resource is desired insetad of the raw data. This resource will not accept the `application/json` mime type unless the underlying binary data is json. From 5ca9c6c0d10cc74235a53365423df64742a31acd Mon Sep 17 00:00:00 2001 From: Kennan Keim Date: Thu, 21 Sep 2023 09:47:16 -0500 Subject: [PATCH 2/4] Update binary.md Updated R4 links to point correctly back to DSTU2 resources --- content/millennium/dstu2/infrastructure/binary.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/millennium/dstu2/infrastructure/binary.md b/content/millennium/dstu2/infrastructure/binary.md index 63d25421a..213b03cc9 100644 --- a/content/millennium/dstu2/infrastructure/binary.md +++ b/content/millennium/dstu2/infrastructure/binary.md @@ -12,7 +12,7 @@ title: Binary | DSTU 2 API The Binary resource can contain any clinical content such as text, images, and PDFs. This resource is currently limited to Continuity of Care Documents (CCD), clinical documents, and diagnostic reports. _The list of clinical documents and diagnostic reports is subject to change, as the list of clinical events that may qualify can be customized by clients_ -It is recommended to request Binary resources only after obtaining a link to the resource via references from [DiagnosticReport](http://fhir.cerner.com/millennium/r4/clinical/diagnostics/diagnostic-report) or [DocumentReference](http://fhir.cerner.com/millennium/r4/foundation/documents/document-reference). It is not recommended to start a workflow in the Binary resource. +It is recommended to request Binary resources only after obtaining a link to the resource via references from [DiagnosticReport](http://fhir.cerner.com/millennium/dstu2/diagnostic/diagnostic-report/) or [DocumentReference](http://fhir.cerner.com/millennium/dstu2/infrastructure/document-reference/). It is not recommended to start a workflow in the Binary resource. The consumer must populate the `Accept` header with either `application/json+fhir` or the format returned in the `attachment.contentType` of the referring resource. If the `Accept` header is `application/json+fhir`, a FHIR Binary resource is returned with the raw data populated in the content. Otherwise, the raw data will be returned (not contained within a FHIR resource). For more information see the HL7® FHIR® [Binary Documentation](http://hl7.org/fhir/dstu2/binary.html#rest). @@ -32,7 +32,7 @@ List an individual Binary by its id: _Implementation Notes_ -* This is usually linked from [DocumentReference](http://fhir.cerner.com/millennium/r4/foundation/documents/document-reference) or [DiagnosticReport](http://fhir.cerner.com/millennium/r4/clinical/diagnostics/diagnostic-report) and should generally be accessed using the exact link given in the referring resource. Modifying the link has undefined consequences. +* This is usually linked from [DocumentReference](http://fhir.cerner.com/millennium/dstu2/infrastructure/document-reference/) or [DiagnosticReport](http://fhir.cerner.com/millennium/dstu2/diagnostic/diagnostic-report/) and should generally be accessed using the exact link given in the referring resource. Modifying the link has undefined consequences. * Documents containing URL sections are unsupported with contentType of `application/pdf` * See the [headers](#headers) section for concerns about the Accept header. * See the [authorization](#authorization-types) section for concerns about the required OAuth scopes. @@ -91,7 +91,7 @@ Generates the Continuity of Care Document (CCD) as a Binary for the supplied que _Implementation Notes_ -* This is usually linked from [DocumentReference](http://fhir.cerner.com/millennium/r4/foundation/documents/document-reference), and should generally be accessed using the exact link given in that resource. Modifying the link has undefined consequences. +* This is usually linked from [DocumentReference](http://fhir.cerner.com/millennium/dstu2/infrastructure/document-reference/), and should generally be accessed using the exact link given in that resource. Modifying the link has undefined consequences. * See the [headers](#headers-1) section for concerns about the Accept header. * See the [authorization](#authorization-types-1) section for concerns about the required OAuth scopes. From 87f35952c3af1fa3bf786d29820edb0fdc063515 Mon Sep 17 00:00:00 2001 From: Kennan Keim Date: Mon, 25 Sep 2023 11:11:05 -0500 Subject: [PATCH 3/4] Changed to less "general" language "Implementation Notes" sections had their language adjusted to be more direct by dropping the filler wording. --- content/millennium/dstu2/infrastructure/binary.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/millennium/dstu2/infrastructure/binary.md b/content/millennium/dstu2/infrastructure/binary.md index 213b03cc9..cb45a2de5 100644 --- a/content/millennium/dstu2/infrastructure/binary.md +++ b/content/millennium/dstu2/infrastructure/binary.md @@ -32,7 +32,7 @@ List an individual Binary by its id: _Implementation Notes_ -* This is usually linked from [DocumentReference](http://fhir.cerner.com/millennium/dstu2/infrastructure/document-reference/) or [DiagnosticReport](http://fhir.cerner.com/millennium/dstu2/diagnostic/diagnostic-report/) and should generally be accessed using the exact link given in the referring resource. Modifying the link has undefined consequences. +* This is usually linked from [DocumentReference](http://fhir.cerner.com/millennium/dstu2/infrastructure/document-reference/) or [DiagnosticReport](http://fhir.cerner.com/millennium/dstu2/diagnostic/diagnostic-report/) and should be accessed using the exact link given in the referring resource. Modifying the link has undefined consequences. * Documents containing URL sections are unsupported with contentType of `application/pdf` * See the [headers](#headers) section for concerns about the Accept header. * See the [authorization](#authorization-types) section for concerns about the required OAuth scopes. @@ -91,7 +91,7 @@ Generates the Continuity of Care Document (CCD) as a Binary for the supplied que _Implementation Notes_ -* This is usually linked from [DocumentReference](http://fhir.cerner.com/millennium/dstu2/infrastructure/document-reference/), and should generally be accessed using the exact link given in that resource. Modifying the link has undefined consequences. +* This is usually linked from [DocumentReference](http://fhir.cerner.com/millennium/dstu2/infrastructure/document-reference/), and should be accessed using the exact link given in that resource. Modifying the link has undefined consequences. * See the [headers](#headers-1) section for concerns about the Accept header. * See the [authorization](#authorization-types-1) section for concerns about the required OAuth scopes. From 8634386304b7257650abc588c1cdcaadec0fdfc2 Mon Sep 17 00:00:00 2001 From: Kennan Keim Date: Mon, 25 Sep 2023 11:12:25 -0500 Subject: [PATCH 4/4] Missed a period --- content/millennium/dstu2/infrastructure/binary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/millennium/dstu2/infrastructure/binary.md b/content/millennium/dstu2/infrastructure/binary.md index cb45a2de5..a3c24e0bb 100644 --- a/content/millennium/dstu2/infrastructure/binary.md +++ b/content/millennium/dstu2/infrastructure/binary.md @@ -10,7 +10,7 @@ title: Binary | DSTU 2 API ## Overview The Binary resource can contain any clinical content such as text, images, and PDFs. This resource is currently limited to Continuity of Care Documents (CCD), clinical documents, and diagnostic reports. -_The list of clinical documents and diagnostic reports is subject to change, as the list of clinical events that may qualify can be customized by clients_ +_The list of clinical documents and diagnostic reports is subject to change, as the list of clinical events that may qualify can be customized by clients._ It is recommended to request Binary resources only after obtaining a link to the resource via references from [DiagnosticReport](http://fhir.cerner.com/millennium/dstu2/diagnostic/diagnostic-report/) or [DocumentReference](http://fhir.cerner.com/millennium/dstu2/infrastructure/document-reference/). It is not recommended to start a workflow in the Binary resource.