This repository has been archived by the owner on May 7, 2024. It is now read-only.
Updated DSTU2 Binary Resource #984
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
kckeim
requested review from
gmodrogan,
AlexandruBasarab,
amcginn,
krycunn and
RicardoCrespo-ora
Updated R4 links to point correctly back to DSTU2 resources
RicardoCrespo-ora
approved these changes
Sep 21, 2023
amcginn
approved these changes
Sep 21, 2023
| @@ -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_ | |||
|
|
||
| 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<sup>®</sup> FHIR<sup>®</sup> [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). |
There was a problem hiding this comment.
not sure on the updated naming, but I know we've had some communication already. is something we should note for some point
| @@ -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/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. | |||
| @@ -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/dstu2/infrastructure/document-reference/), and should generally be accessed using the exact link given in that resource. Modifying the link has undefined consequences. | |||
There was a problem hiding this comment.
we should generally avoid vague language 😃
"Implementation Notes" sections had their language adjusted to be more direct by dropping the filler wording.
gmodrogan
approved these changes
Sep 26, 2023
Surya-Rnsit
pushed a commit
that referenced
this pull request
Sep 28, 2023
* Review and corrections for ChargeItem (#976) * typo fix for CapabilityStatement (#977) * fixing URLs for scope and purpose in consent (#979) * Updated DSTU2 care-plan (#980) * Updated R4 CarePlan Resource (#981) * Updated R4 CareTeam Resource (#982) * Updated R4 CareTeam Resource (#983) * Updated DSTU2 Binary Resource (#984) * Review and Corrections for Device (#985) * Consent updated examples (#986) * Updated AllergyIntolerance R4 resource (#987) * Custom encounter search (#989) * Updated AllergyIntolerance DSTU2 resource (#990)
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
Description
PR Checklist
Overview paragraph before
Overview paragraph after
Resources w/o links
Resources w/ links
