Nerve
Functions

binary.search

Clinical Notes

This API takes in a Binary FHIR ID and returns an HTML version of the note.

Native Request Elements

To get the Binary FHIR ID, you should use DocumentReference.Search to obtain the FHIR ID.

NameDescriptionRequiredIs ArrayTypes
id (String)The FHIR ID.falsestring

Native Response Elements

NameDescriptionRequiredIs ArrayTypes
Binary (Binary)A single instance of a FHIR Binary resource.falsestring

Types

Binary

NameDescriptionRequiredIs ArrayTypes
contentType (String)Mime content type string. This is "text/html" or "text/rtf" for clinical notes.falsestring
data (String)The note or document content as a base64-encoded string.falsestring

Example Payload

fhir_id = client.documentReference.search()[][]
client.binary.read('example')

Request

On this page