170.315(g)(8)(A) Data Category Request

Respond to requests for patient data (based on an ID or other token) for each of the individual data categories specified in the Common Clinical Data Set and return the full set of data for that data category (according to the specified standards, where applicable) in a computable format.

Respond to requests for patient data associated with a specific date as well as requests for patient data within a specified date range.

The requests are built on the FHIR R4 REST Operation: Operation-patient-everything.

Request

GET [base]/fhir/Patient/[id]/$everything?[_type=]

Parameters

Name	Description	Optional?
id	The patient ID	false
_type	One or more parameters, each containing one or more comma-delimited FHIR resource types to include in the return resources. In the absence of any specified types, the server returns all resource types	true
start	All records relating to care provided in a certain date range. If no start date is provided, all records prior to the end date are in scope. format: YYYY-MM-DD	true
end	All records relating to care provided in a certain date range. If no end date is provided, all records subsequent to the start date are in scope. format: YYYY-MM-DD	true

Available Resources

Use these values in the _type parameter to filter data by categories. The response will be in the format of a FHIR Bundle ‘searchset’. These resulting resource’s will exist within the FHIR bundle’s entry set. Each list item below links to a sample entry based on request type.

Date Range Filtering Rules

Data is filtered based on category. Each category is filtered by a different field in the C-CDA or FHIR bundle.

Medications
- period start date
Allergies
- onset (currently when allergy is created in EHR system)
Problem Conditions
- onset (EHR start date)
Health Concern Conditions
- onset (effective date in EHR)
Care Plan
- end period (effective date in EHR)
Encounters and Diagnosis
- end period (EHR chart effective date)
Vital Signs
- effective date/time (EHR assessment date)
Smoking Status
- effective date/time
Labs
- start time (EHR Lab Panel report time)
Diagnostic Images
- start time (EHR examination date)
Procedures
- performed date/time
Vaccination
- occurrence date/time (EHR Start of Administration)
Encounter Diagnosis
- NP in CCDA or FHIR (EHR reviewed problems: assessment date)

Examples

Observation Resource Vital Response

{
    "id": "vital-signs:body_temperature:1196",
    "meta": {
        "profile": [
            "http://hl7.org/fhir/StructureDefinition/vitalsigns"
        ]
    },
    "text": {
        "status": "generated",
        "div": "<div><p><strong>Reading: </strong>Body Temperature<br><strong>Value: </strong>Not Performed<br><strong>Performed By: </strong>Jarvis, David<br><strong>Assessment Date: </strong>[\"2020-03-06\"]</p></div>"
    },
    "status": "final",
    "category": [
        {
            "coding": [
                {
                    "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                    "code": "vital-signs",
                    "display": "Vital Signs"
                }
            ],
            "text": "Vital Signs"
        }
    ],
    "code": {
        "coding": [
            {
                "system": "http://loinc.org",
                "code": "8310-5",
                "display": "Body Temperature"
            }
        ],
        "text": "Body Temperature"
    },
    "subject": {
        "reference": "Patient/a3a2e697-3035-4d9e-a7d5-73f9f567bdaa",
        "type": "Patient",
        "display": "Blitzenberg, Wolf"
    },
    "encounter": {
        "reference": "Encounter/442e2ffe-9c95-420e-8cb8-9feac4531d99",
        "type": "Encounter",
        "display": "RN Clinical Chart (3321) by Jarvis, David Dated 03/06/2020"
    },
    "effectiveDateTime": [
        "2020-03-06"
    ],
    "issued": "2020-03-06T13:17:47-05:00",
    "performer": {
        "reference": "Practitioner/193",
        "type": "Practitioner",
        "display": "Jarvis, David"
    },
    "dataAbsentReason": {
        "coding": [
            {
                "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                "code": "not-performed",
                "display": "Not Performed"
            }
        ],
        "text": "Not Performed"
    },
    "method": {
        "coding": [
            {
                "system": "http://snomed.info/sct",
                "code": "129265001",
                "display": "Patient evaluation - action"
            }
        ],
        "text": "Patient evaluation - action"
    },
    "resourceType": "Observation"
}

Observation Resource Smoking Status Response

{
    "id": "smoking-status:39",
    "meta": {
        "profile": [
            "https://hl7.org/fhir/us/core/StructureDefinition-us-core-smokingstatus.html"
        ]
    },
    "text": {
        "status": "generated",
        "div": "<div><p><strong>Social History Element: </strong>Tobacco smoking status NHIS<br><strong>Description: </strong>Former Smoker<br><strong>Effective Dates: </strong>2020-10-15T00:00:00Z</p></div>"
    },
    "status": "final",
    "category": {
        "coding": [
            {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "social-history",
                "display": "Social History"
            }
        ],
        "text": "Social History"
    },
    "code": {
        "coding": [
            {
                "system": "http://loinc.org",
                "code": "72166-2",
                "display": "Tobacco smoking status NHIS"
            }
        ],
        "text": "Tobacco smoking status NHIS"
    },
    "subject": {
        "reference": "Patient/a3a2e697-3035-4d9e-a7d5-73f9f567bdaa",
        "type": "Patient",
        "display": "Blitzenberg, Wolf"
    },
    "issued": "2020-10-15T00:00:00Z",
    "valueCodeableConcept": {
        "coding": [
            {
                "system": "http://snomed.info/sct",
                "code": "8517006",
                "display": "Former Smoker"
            }
        ],
        "text": "Former Smoker"
    },
    "resourceType": "Observation"
}

Patient Resource Type Response

{
    "id": "a3a2e697-3035-4d9e-a7d5-73f9f567bdaa",
    "meta": {
        "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
        ]
    },
    "text": {
        "status": "generated",
        "div": "<div><ul>\n<li>\n<strong>Patient Name</strong><p>Wolf Blitzenberg</p>\n</li>\n<li>\n<strong>Date of Birth</strong><p>1949-01-17</p>\n</li>\n<li>\n<strong>Gender</strong><p>male</p>\n</li>\n<li>\n<strong>Address</strong><p>123 W Main St, Lexington, KY, 40507-1320</p>\n</li>\n<li>\n<strong>Social Security Number</strong><p>***-**-1011</p>\n</li>\n<li>\n<strong>Driver's License Number</strong><p>K452115730420</p>\n</li>\n</ul></div>"
    },
    "extension": [
        {
            "extension": [
                {
                    "url": "ombCategory",
                    "valueCoding": {
                        "system": "urn:oid:2.16.840.1.113883.6.238",
                        "code": "2106-3",
                        "display": "White"
                    }
                },
                {
                    "url": "detailed",
                    "valueCoding": {
                        "system": "urn:oid:2.16.840.1.113883.6.238",
                        "code": "2110-5",
                        "display": "English"
                    }
                }
            ],
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
        },
        {
            "extension": [
                {
                    "url": "ombCategory",
                    "valueCoding": {
                        "system": "urn:oid:2.16.840.1.113883.6.238",
                        "code": "2135-2",
                        "display": "Hispanic or Latino"
                    }
                },
                {
                    "url": "detailed",
                    "valueCoding": {
                        "system": "urn:oid:2.16.840.1.113883.6.238",
                        "code": "2182-4",
                        "display": "Cuban"
                    }
                }
            ],
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
        },
        {
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
            "valueCode": "M"
        }
    ],
    "identifier": [
        {
            "use": "secondary",
            "type": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                        "code": "DL",
                        "display": "Driver's license number"
                    }
                ],
                "text": "Patient Driver's License Number: K452115730420"
            },
            "value": "K452115730420"
        },
        {
            "use": "usual",
            "type": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                        "code": "SB",
                        "display": "Social Security Number"
                    }
                ],
                "text": "Patient Social Security Number: 101111011"
            },
            "value": "101111011"
        }
    ],
    "active": true,
    "name": [
        {
            "use": "usual",
            "text": "Wolf Blitzenberg",
            "family": "Blitzenberg",
            "given": [
                "Wolf"
            ]
        }
    ],
    "telecom": [
        {
            "system": "phone",
            "value": "5555555555",
            "use": "home"
        },
        {
            "system": "phone",
            "value": "5555555555 (H)",
            "use": "home"
        },
        {
            "system": "phone",
            "value": "5555555555",
            "use": "mobile"
        },
        {
            "system": "email",
            "value": "wolf.blitzenberg@odey.com",
            "use": "home"
        }
    ],
    "gender": "male",
    "birthDate": "1949-01-17",
    "address": [
        {
            "use": "home",
            "type": "both",
            "text": "123 W Main St, Lexington, KY, 40507-1320",
            "line": [
                "123 W Main St"
            ],
            "city": "Lexington",
            "district": "Fayette",
            "state": "KY",
            "postalCode": "40507-1320",
            "country": "USA"
        }
    ],
    "maritalStatus": {
        "coding": [
            {
                "system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
                "code": "M",
                "display": "Married"
            }
        ],
        "text": "Marital Status: Married"
    },
    "communication": [
        {
            "language": {
                "coding": [
                    {
                        "system": "urn:ietf:bcp:47",
                        "code": "en"
                    }
                ]
            },
            "preferred": true
        }
    ],
    "managingOrganization": {
        "reference": "https://api.testing.consolo.services/fhir/Organization/4ea0c05b-ebab-4353-b957-b6295ad9c6da",
        "display": "Consolo Demo"
    },
    "resourceType": "Patient"
}