Create Document Reference
POST {{baseUrl}}/api/v2/DocumentReference?patient=<integer>&encounter=<integer>
Overview:
Adds new document reference records to the system, facilitating the seamless integration of updated clinical documents and supporting efficient document management within healthcare applications.
Use Cases:
Submit Patient Notes: Send clinical notes for storage
Capture Lab Results: Record and store laboratory results
Update Medication Records: Add new medications to patient records
Document Treatment Plans: Store details of treatment plans
Record Vital Signs: Save patient vital sign data
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
patient | string | (Required) The patient identifier associated with the document reference. | |
encounter | string | (Required) The encounter 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
Key | Datatype | Required | Description |
---|---|---|---|
x-source-id | string | (Required) The source id provided for connecting to the data source | |
Content-Type | string | ||
Authorization | string |
RESPONSES
status: OK
[{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e","notify":"\u003cboolean\u003e"},"data":{"id":"\u003cinteger\u003e","status":"\u003cstring\u003e"}},{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e","notify":"\u003cboolean\u003e"},"data":{"id":"\u003cinteger\u003e","status":"\u003cstring\u003e"}}]