Get Document Reference
GET {{baseUrl}}/api/v2/DocumentReference?patient=<integer>&departmentId=<integer>&category=surgery
Overview:
Retrieves detailed information on documents linked to patient care, allowing healthcare developers to access and display real-time data regarding diverse clinical documents for streamlined information retrieval within clinical workflows.
Use Cases:
Assemble Health History: Retrieve document catalog
Check Consent Details: Get consent document references
Review Care Plan Instructions: Obtain care plan document details
Share Referral Recommendations: Access recommendation document specifics
Evaluate Document Usage: Retrieve documents for analysis
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
patient | string | (Required) The patient identifier associated with the document reference. | |
departmentId | string | (Required) The department identifier | |
category | string | (Required) The category of the document reference |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
x-source-id | string | (Required) The source id provided for connecting to the data source | |
Authorization | string |
RESPONSES
status: OK
[{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e","notify":"\u003cboolean\u003e"},"data":{"resourceType":"Bundle","type":"searchset","total":"\u003cinteger\u003e","entry":[{"resource":{"resourceType":"DocumentReference","id":"\u003cstring\u003e","identifier":[{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"status":"current","docStatus":"amended","type":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"category":[{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}],"text":"\u003cstring\u003e"},{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}],"text":"\u003cstring\u003e"}],"author":[{"reference":"\u003cstring\u003e"},{"reference":"\u003cstring\u003e"}],"subject":{"reference":"\u003cstring\u003e"},"context":{"encounter":[{"reference":"\u003cstring\u003e"},{"reference":"\u003cstring\u003e"}],"period":{"start":"\u003cdateTime\u003e"},"related":[{"reference":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"reference":"\u003cstring\u003e","display":"\u003cstring\u003e"}],"sourcePatientInfo":{"extension":[{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueString":"\u003cstring\u003e"}]}},"content":[{"attachment":{"contentType":"\u003cstring\u003e","data":"\u003cstring\u003e","title":"\u003cstring\u003e"}},{"attachment":{"contentType":"\u003cstring\u003e","data":"\u003cstring\u003e","title":"\u003cstring\u003e"}}],"extension":[{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueString":"\u003cstring\u003e"}],"contained":[{"resourceType":"\u003cstring\u003e","code":{}},{"resourceType":"\u003cstring\u003e","code":{}}]}},{"resource":{"resourceType":"DocumentReference","id":"\u003cstring\u003e","identifier":[{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"status":"superseded","docStatus":"final","type":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"category":[{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}],"text":"\u003cstring\u003e"},{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}],"text":"\u003cstring\u003e"}],"author":[{"reference":"\u003cstring\u003e"},{"reference":"\u003cstring\u003e"}],"subject":{"reference":"\u003cstring\u003e"},"context":{"encounter":[{"reference":"\u003cstring\u003e"},{"reference":"\u003cstring\u003e"}],"period":{"start":"\u003cdateTime\u003e"},"related":[{"reference":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"reference":"\u003cstring\u003e","display":"\u003cstring\u003e"}],"sourcePatientInfo":{"extension":[{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueString":"\u003cstring\u003e"}]}},"content":[{"attachment":{"contentType":"\u003cstring\u003e","data":"\u003cstring\u003e","title":"\u003cstring\u003e"}},{"attachment":{"contentType":"\u003cstring\u003e","data":"\u003cstring\u003e","title":"\u003cstring\u003e"}}],"extension":[{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueString":"\u003cstring\u003e"}],"contained":[{"resourceType":"\u003cstring\u003e","code":{}},{"resourceType":"\u003cstring\u003e","code":{}}]}}]}},{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e","notify":"\u003cboolean\u003e"},"data":{"resourceType":"Bundle","type":"searchset","total":"\u003cinteger\u003e","entry":[{"resource":{"resourceType":"DocumentReference","id":"\u003cstring\u003e","identifier":[{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"status":"superseded","docStatus":"amended","type":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"category":[{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}],"text":"\u003cstring\u003e"},{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}],"text":"\u003cstring\u003e"}],"author":[{"reference":"\u003cstring\u003e"},{"reference":"\u003cstring\u003e"}],"subject":{"reference":"\u003cstring\u003e"},"context":{"encounter":[{"reference":"\u003cstring\u003e"},{"reference":"\u003cstring\u003e"}],"period":{"start":"\u003cdateTime\u003e"},"related":[{"reference":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"reference":"\u003cstring\u003e","display":"\u003cstring\u003e"}],"sourcePatientInfo":{"extension":[{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueString":"\u003cstring\u003e"}]}},"content":[{"attachment":{"contentType":"\u003cstring\u003e","data":"\u003cstring\u003e","title":"\u003cstring\u003e"}},{"attachment":{"contentType":"\u003cstring\u003e","data":"\u003cstring\u003e","title":"\u003cstring\u003e"}}],"extension":[{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueString":"\u003cstring\u003e"}],"contained":[{"resourceType":"\u003cstring\u003e","code":{}},{"resourceType":"\u003cstring\u003e","code":{}}]}},{"resource":{"resourceType":"DocumentReference","id":"\u003cstring\u003e","identifier":[{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"status":"current","docStatus":"preliminary","type":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"category":[{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}],"text":"\u003cstring\u003e"},{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}],"text":"\u003cstring\u003e"}],"author":[{"reference":"\u003cstring\u003e"},{"reference":"\u003cstring\u003e"}],"subject":{"reference":"\u003cstring\u003e"},"context":{"encounter":[{"reference":"\u003cstring\u003e"},{"reference":"\u003cstring\u003e"}],"period":{"start":"\u003cdateTime\u003e"},"related":[{"reference":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"reference":"\u003cstring\u003e","display":"\u003cstring\u003e"}],"sourcePatientInfo":{"extension":[{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueString":"\u003cstring\u003e"}]}},"content":[{"attachment":{"contentType":"\u003cstring\u003e","data":"\u003cstring\u003e","title":"\u003cstring\u003e"}},{"attachment":{"contentType":"\u003cstring\u003e","data":"\u003cstring\u003e","title":"\u003cstring\u003e"}}],"extension":[{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueString":"\u003cstring\u003e"}],"contained":[{"resourceType":"\u003cstring\u003e","code":{}},{"resourceType":"\u003cstring\u003e","code":{}}]}}]}}]