GetCCDAXml Method |
Retrieves patient data as a CCDA document in XML format.
Method Type: GETAuthorization:
- Token (Required)
- Type: Bearer Token
Authorization token
Syntax
C#
https://test.hs1api.com/ascend-gateway/api/v0/MU/getccdaxml?filter=patId==1000006,patDb==1000016,startDate==1/1/2015,endDate==3/18/2019
Parameters
- filter (Required)
- Filter expression, using a combination of the following parameters:
- patId (Required)
- Type: numeric
Patient Id - patDb (Required)
- Type: numeric
Patient Db - startDate (Optional)
- Type: Date
Start date of the time period - endDate (Optional)
- Type: Date
End date of the time period
Headers
- Organization-ID (Required)
- Type: string
Organization Id
Request Body
NoneResponse
- statusCode
- Type: numeric
Response status code - data
- Type: xml
CCDA document in XML format
Example
{
"statusCode": 200,
"data": "<?xml version=\"1.0\" encoding=\"utf-8\"?>XML content </xml>"
}
Possible Errors
"Execution timeout expired"
- See General Errors
"Access token expired" - See Authentication Errors
"Invalid access token" - See Authentication Errors
"Patient not found" - See Patient Data Errors
"From date is set later than To date" - See Patient Data Errors
"Patient ID and Patient DB must be greater than 0" - See Patient Data Errors
"The Patient does not have any visits within the specified date range" - See Patient Data Errors
"Access token expired" - See Authentication Errors
"Invalid access token" - See Authentication Errors
"Patient not found" - See Patient Data Errors
"From date is set later than To date" - See Patient Data Errors
"Patient ID and Patient DB must be greater than 0" - See Patient Data Errors
"The Patient does not have any visits within the specified date range" - See Patient Data Errors