Update Document Reference

PUT {{baseUrl}}/api/v2/DocumentReference/:document-id?patient=<integer>

Overview:

Updates existing document reference data, empowering developers to modify specific details associated with a particular patient's linked documents, ensuring accurate and current information for optimized clinical workflows.

Use Cases:

  • Update Patient Records: Modify existing patient documents

  • Revise Lab Results: Edit and update laboratory data

  • Amend Medication Information: Update medication records

  • Modify Treatment Details: Make changes to treatment plans

  • Edit Vital Sign Records: Update patient vital signs

Request Params

KeyDatatypeRequiredDescription
patientstring(Required) The patient identifier associated with the document reference.

Request Body

{"context"=>{"departmentId"=>"<string>"}, "data"=>{"resourceType"=>"DocumentReference", "status"=>"current", "docStatus"=>"amended", "type"=>{"coding"=>[{"system"=>"<string>", "code"=>"<string>", "display"=>"<string>"}, {"system"=>"<string>", "code"=>"<string>", "display"=>"<string>"}]}, "category"=>[{"coding"=>[{"system"=>"<string>", "code"=>"<string>", "display"=>"<string>"}, {"system"=>"<string>", "code"=>"<string>", "display"=>"<string>"}], "text"=>"<string>"}, {"coding"=>[{"system"=>"<string>", "code"=>"<string>", "display"=>"<string>"}, {"system"=>"<string>", "code"=>"<string>", "display"=>"<string>"}], "text"=>"<string>"}], "author"=>[{"reference"=>"<string>"}, {"reference"=>"<string>"}], "subject"=>{"reference"=>"<string>"}, "context"=>{"encounter"=>[{"reference"=>"<string>"}, {"reference"=>"<string>"}], "period"=>{"start"=>"<dateTime>"}, "related"=>[{"reference"=>"<string>", "display"=>"<string>"}, {"reference"=>"<string>", "display"=>"<string>"}], "sourcePatientInfo"=>{"extension"=>[{"url"=>"<string>", "valueInteger"=>"<integer>", "valueString"=>"<string>"}, {"url"=>"<string>", "valueInteger"=>"<integer>", "valueString"=>"<string>"}]}}, "content"=>[{"attachment"=>{"contentType"=>"<string>", "data"=>"<string>", "title"=>"<string>"}}, {"attachment"=>{"contentType"=>"<string>", "data"=>"<string>", "title"=>"<string>"}}], "extension"=>[{"url"=>"<string>", "valueInteger"=>"<integer>", "valueString"=>"<string>"}, {"url"=>"<string>", "valueInteger"=>"<integer>", "valueString"=>"<string>"}], "contained"=>[{"resourceType"=>"<string>"}, {"resourceType"=>"<string>"}]}}

HEADERS

KeyDatatypeRequiredDescription
x-source-idstring(Required) The source id provided for connecting to the data source
Content-Typestring
Authorizationstring

RESPONSES

status: OK

[{&quot;context&quot;:{&quot;requestId&quot;:&quot;\u003cstring\u003e&quot;,&quot;source&quot;:&quot;\u003cstring\u003e&quot;,&quot;quorum&quot;:&quot;\u003cboolean\u003e&quot;,&quot;notify&quot;:&quot;\u003cboolean\u003e&quot;},&quot;data&quot;:{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;status&quot;:&quot;\u003cstring\u003e&quot;}},{&quot;context&quot;:{&quot;requestId&quot;:&quot;\u003cstring\u003e&quot;,&quot;source&quot;:&quot;\u003cstring\u003e&quot;,&quot;quorum&quot;:&quot;\u003cboolean\u003e&quot;,&quot;notify&quot;:&quot;\u003cboolean\u003e&quot;},&quot;data&quot;:{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;status&quot;:&quot;\u003cstring\u003e&quot;}}]