Skip to content
This repository has been archived by the owner on May 7, 2024. It is now read-only.

Updated R4 Binary Resource #983

Merged
merged 1 commit into from
Sep 25, 2023
Merged

Updated R4 Binary Resource #983

merged 1 commit into from
Sep 25, 2023

Conversation

kckeim
Copy link
Contributor

@kckeim kckeim commented Sep 20, 2023

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

  • Overview paragraph changed to indicate that the list of supported reports types is subject to change over time
  • Formatting for a lot of untagged "code" elements/parameters by adding backticks
  • Added links out to other R4 resources where referenced (e.g. DocumentReference and DiagnosticReport)
  • Formatting updates in autogen-ccd-if section (e.g. properly spacing over the example GET command)

PR Checklist

  • Overview paragraph before
    image

  • Overview paragraph after
    image


  • Resources w/o links
    image

  • Resources w/ links
    image


  • Example autogen-ccd-id update before
    image

  • Example autogen-ccd-id update after
    image

General formatting updates.  Itemized list follows on Pull Request.
Verified good links throughout document, and have validated that example API calls behave as noted with examples

It is recommended to request Binary resources only after obtaining links to the resources via references from DiagnosticReport or DocumentReference. It is not recommended to start a workflow with Binary resources.
It is recommended to request Binary resources only after obtaining links to the resources 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 with Binary resources.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is it possible to build internal reference links dynamically? If the R4 DocumentReference documentation moves from that URL, when this will break

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spoke with George over IM about this.
We have identified links like these as something that will need to be updated in tandem with our hosting on the new site.

We'll be looking to complete that work over the coming sprints, and be tracking that work under separate stories.

For now, the links will work as intended to redirect users over to the correct endpoint.
We'd like to proceed with merging, understanding that these will be adjusted at a later date.

@@ -31,7 +33,7 @@ List an individual Binary by its id:

_Implementation Notes_

* This is usually linked from DocumentReference, DiagnosticReport, or Communication 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), [DiagnosticReport](http://fhir.cerner.com/millennium/r4/clinical/diagnostics/diagnostic-report), or [Communication](http://fhir.cerner.com/millennium/r4/clinical/request-and-response/communication) and should generally be accessed using the exact link given in the referring resource. Modifying the link has undefined consequences.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as above, is it possible to have dynamic link?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spoke with George over IM about this.
We have identified links like these as something that will need to be updated in tandem with our hosting on the new site.

We'll be looking to complete that work over the coming sprints, and be tracking that work under separate stories.

For now, the links will work as intended to redirect users over to the correct endpoint.
We'd like to proceed with merging, understanding that these will be adjusted at a later date.


The consumer must populate the Accept header with either `application/fhir+json` or the format returned in the `attachment.contentType` of the referring resource. If the Accept header is `application/fhir+json`, a FHIR Binary resource is returned with the raw data populated in `Binary.data`. If the Accept header is anything else, the raw data will be returned instead of a FHIR Binary resource. For more information, see the HL7<sup>®</sup> FHIR<sup>®</sup> [Binary documentation](http://hl7.org/fhir/r4/binary.html#rest).
The consumer must populate the `Accept` header with either `application/fhir+json` or the format returned in the `attachment.contentType` of the referring resource. If the `Accept` header is `application/fhir+json`, a FHIR Binary resource is returned with the raw data populated in `Binary.data`. If the `Accept` header is anything else, the raw data will be returned instead of a FHIR Binary resource. For more information, see the HL7<sup>®</sup> FHIR<sup>®</sup> [Binary documentation](http://hl7.org/fhir/r4/binary.html#rest).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

<sup> isn't necessary

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Didn't know, and didn't want to break it on accident, so I left it there.

@gmodrogan gmodrogan merged commit 27273c6 into main Sep 25, 2023
1 check passed
@gmodrogan gmodrogan deleted the BinaryR4-docs-migrate branch September 25, 2023 07:15
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.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants