MaxIntegration V1.0 Documentation CCDS Support - Procedures

Procedure

In FHIR STU3 standard, Procedure resource is representing an action performed on a patient, which also can be a physical intervention like an operation, or less invasive like counseling or hypnothyerapy.

Procedure is also an event resource, designed to record the details of procedures performed on patients. Here, this resource is used to contain CCDS element named procedure.

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 the procedure Identifier
status The status code code (EventStatus)
notDone If the procedure was not performed as scheduled boolean
notDoneReason Reason why this procedure was not performed CodeableConcept (Procedure Not Performed Reason (SNOMED-CT))
category Classification of the procedure CodeableConcept (Procedure Category Codes (SNOMED CT))
code Identification of the procedure CodeableConcept (Procedure Codes (SNOMED CT))
subject Who the procedure was performed on Reference (Patient | Group)
context Encounter or episode associated with the procedure Reference (Encounter | EpisodeOfCare)
performed Date/Period the procedure was performed performedDateTime: dateTime, performedPeriod: Period
performer (BackboneElement) Participants in producing the report role: CodeableConcept (Procedure Performer Role Codes)
actor: Reference (Practitioner | Organization | Patient | RelatedPerson | Device)
onBehalfOf: Reference (Organization)

Get Procedures by Patient

GET https://evalfhir.directmdemail.com/fhir/baseDstu3/Procedure?patient={id}

Example:

GET https://evalfhir.directmdemail.com/fhir/baseDstu3/Procedure?patient=452
                {
    "resourceType": "Bundle",
    "id": "18df4d16-8500-4a70-a8f7-77b88ec3ad58",
    "meta": {
        "lastUpdated": "2017-12-26T09:16:44.000-06:00"
    },
    "type": "searchset",
    "total": 2,
    "link": [
        {
            "relation": "self",
            "url": "https://evalfhir.directmdemail.com/fhir/baseDstu3/Procedure?patient=608"
        }
    ],
    "entry": [
        {
            "fullUrl": "https://evalfhir.directmdemail.com/fhir/baseDstu3/Procedure/647",
            "resource": {
                "resourceType": "Procedure",
                "id": "647",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2017-12-22T09:08:24.000-06:00"
                },
                "status": "completed",
                "code": {
                    "coding": [
                        {
                            "system": "SNOMED CT",
                            "code": "56251003",
                            "display": "Nebulizer Therapy"
                        }
                    ]
                },
                "subject": {
                    "reference": "Patient/608"
                },
                "context": {
                    "reference": "Encounter/619"
                },
                "performedDateTime": "2015-06-22T11:00:00-04:00",
                "location": {
                    "reference": "Location/648"
                },
                "bodySite": [
                    {
                        "coding": [
                            {
                                "system": "SNOMED CT",
                                "code": "82094008",
                                "display": "Lower Respiratory Tract Structure"
                            }
                        ]
                    }
                ]
            },
            "search": {
                "mode": "match"
            }
        },
        {
            "fullUrl": "https://evalfhir.directmdemail.com/fhir/baseDstu3/Procedure/649",
            "resource": {
                "resourceType": "Procedure",
                "id": "649",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2017-12-22T09:08:24.000-06:00"
                },
                "status": "completed",
                "code": {
                    "coding": [
                        {
                            "system": "SNOMED CT",
                            "code": "175135009",
                            "display": "Introduction of cardiac pacemaker system via vein"
                        }
                    ]
                },
                "subject": {
                    "reference": "Patient/608"
                },
                "context": {
                    "reference": "Encounter/619"
                },
                "performedDateTime": "2011-10-05T00:00:00-04:00",
                "location": {
                    "reference": "Location/650"
                },
                "bodySite": [
                    {
                        "coding": [
                            {
                                "system": "SNOMED CT",
                                "code": "9454009",
                                "display": "Structure of subclavian vein"
                            }
                        ]
                    }
                ]
            },
            "search": {
                "mode": "match"
            }
        }
    ]
}
                
    

Search Procedures With Specific Date

For this resource, users are able to search using parameters like date, patient, and category 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 this procedure string False
date Date/Period the procedure was performed dateTime False
patient The Id representing the specific patient related with this resource integer True (If the query is concerning a specific patient)
category Category of this resource string False
code Identification of this procedure string False
status The status of the report string False

This following request format indicates how to get procedures on a specific date, using parameter date.

GET https://evalfhir.directmdemail.com/fhir/baseDstu3/Procedure?patient={id}&date={dateTime}

Example:

GET https://evalfhir.directmdemail.com/fhir/baseDstu3/Procedure?patient=726&date=2015-06-22
        {
    "resourceType": "Bundle",
    "id": "5b43727a-61cb-414a-b934-85bacec40508",
    "meta": {
        "lastUpdated": "2017-12-26T09:28:33.633-06:00"
    },
    "type": "searchset",
    "total": 1,
    "link": [
        {
            "relation": "self",
            "url": "https://evalfhir.directmdemail.com/fhir/baseDstu3/Procedure?date=2015-06-22&patient=726"
        }
    ],
    "entry": [
        {
            "fullUrl": "https://evalfhir.directmdemail.com/fhir/baseDstu3/Procedure/765",
            "resource": {
                "resourceType": "Procedure",
                "id": "765",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2017-12-26T09:21:57.000-06:00"
                },
                "status": "completed",
                "code": {
                    "coding": [
                        {
                            "system": "SNOMED CT",
                            "code": "56251003",
                            "display": "Nebulizer Therapy"
                        }
                    ]
                },
                "subject": {
                    "reference": "Patient/726"
                },
                "context": {
                    "reference": "Encounter/737"
                },
                "performedDateTime": "2015-06-22T11:00:00-04:00",
                "location": {
                    "reference": "Location/766"
                },
                "bodySite": [
                    {
                        "coding": [
                            {
                                "system": "SNOMED CT",
                                "code": "82094008",
                                "display": "Lower Respiratory Tract Structure"
                            }
                        ]
                    }
                ]
            },
            "search": {
                "mode": "match"
            }
        }
    ]
}
        
    

Search Procedures With a Date Range

The request format would be like:

GET https://evalfhir.directmdemail.com/fhir/baseDstu3/Procedure?patient={id}&date=>={dateTime}&date=<{dateTime (later than previous dateTIme)}

Example:

GET https://evalfhir.directmdemail.com/fhir/baseDstu3/Procedure?patient=726&date=>=2015-05-22&date=<2015-12-31
        {
    "resourceType": "Bundle",
    "id": "b09c02b8-5b13-4a32-a47f-09a30a203159",
    "meta": {
        "lastUpdated": "2017-12-26T09:30:35.634-06:00"
    },
    "type": "searchset",
    "total": 1,
    "link": [
        {
            "relation": "self",
            "url": "https://evalfhir.directmdemail.com/fhir/baseDstu3/Procedure?date=%3E%3D2015-05-22&date=%3C2015-12-31&patient=726"
        }
    ],
    "entry": [
        {
            "fullUrl": "https://evalfhir.directmdemail.com/fhir/baseDstu3/Procedure/765",
            "resource": {
                "resourceType": "Procedure",
                "id": "765",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2017-12-26T09:21:57.000-06:00"
                },
                "status": "completed",
                "code": {
                    "coding": [
                        {
                            "system": "SNOMED CT",
                            "code": "56251003",
                            "display": "Nebulizer Therapy"
                        }
                    ]
                },
                "subject": {
                    "reference": "Patient/726"
                },
                "context": {
                    "reference": "Encounter/737"
                },
                "performedDateTime": "2015-06-22T11:00:00-04:00",
                "location": {
                    "reference": "Location/766"
                },
                "bodySite": [
                    {
                        "coding": [
                            {
                                "system": "SNOMED CT",
                                "code": "82094008",
                                "display": "Lower Respiratory Tract Structure"
                            }
                        ]
                    }
                ]
            },
            "search": {
                "mode": "match"
            }
        }
    ]
}