MaxIntegration V1.0 Documentation CCDS Support - Smoking Status

Smoking Status

In FHIR STU3 standard, Observation resource is designed as a type of event resource describing, measurements and simple assertions made about a patient, device or other subject. For smoking status, we are using this resource.

Using Observation resource defined in FHIR, CCDS element as Smoking Status and Vital Signs are concluded utilizing this resource.

Required or some important fields and parameters would be given in the following tables. Operations and parameters of this resource would also be listed.

Resource Element Fields

Name Description Type
identifier The identifier for this specific observation Identifier
status The status code code (ObservationStatus)
category Classification of type of observation CodeableConcept (Observation Category Codes)
code Type of observation CodeableConcept (LOINC Codes)
subject Who and/or what this is about Reference (Patient | Group | Device | Location)
effective Clinically relevant time/time-period for observation effectiveDateTime: dateTime, effectivePeriod: Period
value The result of the observation valueQuantity: Quantity
valueCodeableConcept: CodeableConcept
valueString: string
valueBoolean: boolean
valueRange: Range
valueRatio: Ratio
valueSampledData: SampledData
valueAttachment: Attachment
valueTime: time
valueDateTime: dateTime
valuePeriod: Period
referenceRange Provides guide for interpretation low: SimpleQuantity
high: SimpleQuantity
type: CodeableConcept (Observation Reference Range Meaning Codes)
appliesTo: CodeableConcept (Observation Reference Range Applies To Codes)
age: Range
text: string

Smoking Status

Get Smoking Status by Patient

GET https://evalfhir.directmdemail.com/fhir/baseDstu3/Observation?patient={id}&category=http://hl7.org/fhir/observation-category|social-history&code=LOINC|72166-2

Example:

GET https://evalfhir.directmdemail.com/fhir/baseDstu3/Observation?patient=232&category=http://hl7.org/fhir/observation-category|social-history&code=LOINC|72166-2
                {
    "resourceType": "Bundle",
    "id": "2ffde0ef-7cb6-4b39-91f5-0f092ca550ec",
    "meta": {
        "lastUpdated": "2017-12-19T16:07:24.299-06:00"
    },
    "type": "searchset",
    "total": 1,
    "link": [
        {
            "relation": "self",
            "url": "https://evalfhir.directmdemail.com/fhir/baseDstu3/Observation?category=http%3A%2F%2Fhl7.org%2Ffhir%2Fobservation-category%7Csocial-history&code=LOINC%7C72166-2&patient=232"
        }
    ],
    "entry": [
        {
            "fullUrl": "https://evalfhir.directmdemail.com/fhir/baseDstu3/Observation/270",
            "resource": {
                "resourceType": "Observation",
                "id": "270",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2017-12-15T15:18:36.000-06:00"
                },
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://hl7.org/fhir/observation-category",
                                "code": "social-history",
                                "display": "Social History"
                            }
                        ]
                    }
                ],
                "code": {
                    "coding": [
                        {
                            "system": "LOINC",
                            "code": "72166-2",
                            "display": "Current Smoking Status"
                        }
                    ]
                },
                "subject": {
                    "reference": "Patient/232"
                },
                "context": {
                    "reference": "Encounter/243"
                },
                "effectivePeriod": {
                    "start": "2015-06-22T00:00:00-04:00"
                },
                "valueCodeableConcept": {
                    "coding": [
                        {
                            "system": "SNOMED CT",
                            "code": "449868002",
                            "display": "Current every day"
                        }
                    ]
                }
            },
            "search": {
                "mode": "match"
            }
        }
    ]
}
                
    

Search Smoking Status With Specific Date

For this resource, users are able to search using parameters like date, patient, and identifier etc. Important searching parameters would be listed in the following table.

Parameter Name Description Type Required
_id The Id of the certain resource string False
identifier The unique identifier for the observation string False
date The exact date when the observation took place dateTime False
patient The Id representing the specific patient integer True (If the Smoking Status or Vital Signs is concering a specific patient)
category The category of the observation, this parameter is used to search specific type of observation
Smoking Status, Vital Signs, for example
string True (Required searching for Smoking Status, and Vital Signs)
code Filtering the type of observation string True (Required searching for Smoking Status; optional for Vital Signs)
encounter Specify the encounter Id to find the observation referencing the specific encounter integer False
subject Who and/or what this is about string False

This following request format indicates how to get the smoking status observation on a specific date, by limiting the same date range.

GET https://evalfhir.directmdemail.com/fhir/baseDstu3/Observation?patient=452&category=http://hl7.org/fhir/observation-category|social-history&code=LOINC|72166-2&date=>={dateTime}&date=<{dateTime}

Example:

GET https://evalfhir.directmdemail.com/fhir/baseDstu3/Observation?patient=452&category=http://hl7.org/fhir/observation-category|social-history&code=LOINC|72166-2&date=>=2015-06-22&date=<2015-06-23
        {
    "resourceType": "Bundle",
    "id": "b5d5f54c-8146-4464-854e-edb892e70887",
    "meta": {
        "lastUpdated": "2017-12-19T17:09:31.787-06:00"
    },
    "type": "searchset",
    "total": 1,
    "link": [
        {
            "relation": "self",
            "url": "https://evalfhir.directmdemail.com/fhir/baseDstu3/Observation?category=http%3A%2F%2Fhl7.org%2Ffhir%2Fobservation-category%7Csocial-history&code=LOINC%7C72166-2&date=%3E%3D2015-06-22&date=%3C2015-06-23&patient=452"
        }
    ],
    "entry": [
        {
            "fullUrl": "https://evalfhir.directmdemail.com/fhir/baseDstu3/Observation/490",
            "resource": {
                "resourceType": "Observation",
                "id": "490",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2017-12-19T10:05:25.000-06:00"
                },
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://hl7.org/fhir/observation-category",
                                "code": "social-history",
                                "display": "Social History"
                            }
                        ]
                    }
                ],
                "code": {
                    "coding": [
                        {
                            "system": "LOINC",
                            "code": "72166-2",
                            "display": "Current Smoking Status"
                        }
                    ]
                },
                "subject": {
                    "reference": "Patient/452"
                },
                "context": {
                    "reference": "Encounter/463"
                },
                "effectivePeriod": {
                    "start": "2015-06-22T11:00:00-04:00"
                },
                "valueCodeableConcept": {
                    "coding": [
                        {
                            "system": "SNOMED CT",
                            "code": "449868002",
                            "display": "Current every day"
                        }
                    ]
                }
            },
            "search": {
                "mode": "match"
            }
        }
    ]
}
        
    

Search Smoking Status With a Date Range

The request format would be like:

GET https://evalfhir.directmdemail.com/fhir/baseDstu3/Observation?patient=452&category=http://hl7.org/fhir/observation-category|social-history&code=LOINC|72166-2&date=>={dateTime}&date=<{dateTime (later than previous dateTime)}

Example:

GET https://evalfhir.directmdemail.com/fhir/baseDstu3/Observation?patient=452&category=http://hl7.org/fhir/observation-category|social-history&code=LOINC|72166-2&date=>=2015-05-22&date=<2015-06-29
        {
    "resourceType": "Bundle",
    "id": "7ef23371-f371-4bf3-93f7-becdeda9c108",
    "meta": {
        "lastUpdated": "2017-12-19T17:13:02.616-06:00"
    },
    "type": "searchset",
    "total": 1,
    "link": [
        {
            "relation": "self",
            "url": "https://evalfhir.directmdemail.com/fhir/baseDstu3/Observation?category=http%3A%2F%2Fhl7.org%2Ffhir%2Fobservation-category%7Csocial-history&code=LOINC%7C72166-2&date=%3E%3D2015-05-22&date=%3C2015-06-29&patient=452"
        }
    ],
    "entry": [
        {
            "fullUrl": "https://evalfhir.directmdemail.com/fhir/baseDstu3/Observation/490",
            "resource": {
                "resourceType": "Observation",
                "id": "490",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2017-12-19T10:05:25.000-06:00"
                },
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://hl7.org/fhir/observation-category",
                                "code": "social-history",
                                "display": "Social History"
                            }
                        ]
                    }
                ],
                "code": {
                    "coding": [
                        {
                            "system": "LOINC",
                            "code": "72166-2",
                            "display": "Current Smoking Status"
                        }
                    ]
                },
                "subject": {
                    "reference": "Patient/452"
                },
                "context": {
                    "reference": "Encounter/463"
                },
                "effectivePeriod": {
                    "start": "2015-06-22T11:00:00-04:00"
                },
                "valueCodeableConcept": {
                    "coding": [
                        {
                            "system": "SNOMED CT",
                            "code": "449868002",
                            "display": "Current every day"
                        }
                    ]
                }
            },
            "search": {
                "mode": "match"
            }
        }
    ]
}