GetCategoriesCCDS Method

Retrieves the set of patient data for the specified CCDS categories.

Method Type: GET
Authorization:

Token (Required): Type: Bearer Token
Authorization token

Request

Usage

Copy

https://test.hs1api.com/ascend-gateway/api/v0/MU/GetCategoriesCCDS?filter=patId==1000006,patDb==1000016,categories==8,startDate==03/01/2005,endDate==3/1/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
categories (Optional): Type: numeric
The set of CCDS categories to get as a result of a binary bitwise OR operation on CCDSCategories enumeration
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

None

Response

statusCode: Type: numeric
Response status code
data: Type: categoriesCCDSList
Array of CCDSCategory objects:

PatientInfoCategory
SmokingStatusCategory
MedicationCategory
LaboratoryTestCategory
GoalCategory
ProblemCategory
MedicationAllergyCategory
LaboratoryResultCategory
VitalSignCategory
DentalProcedureCategory
ImmunizationCategory
AssessmentAndTreatmentPlanCategory
CareTeamMemberCategory
UniqueDeviceIdentifierCategory
HealthConcernsCategory
MedicalProceduresCategory

{
    "statusCode": 200,
    "data": {
        "categoriesCCDSList": [
            {
                "Category": "PatientInfo",
                "PatientId": 1000006,
                "PatientDb": 1000016,
                "FirstName": "Alice",
                "LastName": "Newman",
                "PreviousFirstName": "Alicia",
                "PreviousLastName": "Newman",
                "MiddleName": "Jones",
                "Suffix": "",
                "PatientPreviousName": "Alicia Newman",
                "PatientName": "FirstName=Alice,\nLastName=Newman",
                "GenderId": 2,
                "RaceCode": "2106-3",
                "RaceDescription": "White",
                "RaceCodeSystem": "2.16.840.1.113883.6.238",
                "RaceCodeSystemName": "CDC",
                "SexCode": "F",
                "Sex": "Female",
                "GenderCodeSystem": "2.16.840.1.113883.5.1",
                "GenderCodeSystemName": "AdministrativeGender",
                "OtherRaceCode": "2108-9",
                "OtherRaceDescription": "European",
                "OtherRaceCodeSystem": "2.16.840.1.113883.6.238",
                "OtherRaceCodeSystemName": "CDC",
                "EthnicityCode": "2186-5",
                "Ethnicity": "Not Hispanic or Latino",
                "EthnicitySystemCode": "2.16.840.1.113883.6.238",
                "EthnicitySystemCodeName": "CDC",
                "OtherEthnicityCode": "",
                "OtherEthnicity": "",
                "OtherEthnicityCodeSystem": "",
                "OtherEthnicityCodeSystemName": "",
                "LanguageCode": "en",
                "LanguageCodeSystemId": "19",
                "LanguageDescription": "English",
                "LanguageFlagCode": "first",
                "LanguageCodeDescription": "en",
                "LanguageSystemCode": "2.16.840.1.113883.6.316",
                "LanguageSystemCodeName": "ISO639-1",
                "BirthDate": "1978-11-11T00:00:00.000Z",
                "BirthDateStr": "11/11/1978"
            },            {
                "Category": "LaboratoryTests",
                "OrderDate": "2015-06-22T00:00:00.000Z",
                "SchedTestDate": "2015-06-22T00:00:00.000Z",
                "Description": "UA Dipstick Pnl Ur",
                "OrderCode": "24357-6",
                "OrderStatusDescription": "Completed",
                "LoincNum": "24357-6",
                "CodeSystem": "2.16.840.1.113883.6.1",
                "CodeSystemName": "LOINC"
            },
            {
                "Category": "LaboratoryTests",
                "OrderDate": "2015-06-22T00:00:00.000Z",
                "SchedTestDate": "2015-06-29T00:00:00.000Z",
                "Description": "UA Dipstick Pnl Ur",
                "OrderCode": "24357-6",
                "OrderStatusDescription": "Ordered",
                "LoincNum": "24357-6",
                "CodeSystem": "2.16.840.1.113883.6.1",
                "CodeSystemName": "LOINC"
            }
        ]
    }
}

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