Procedure

Top  Previous  Next

An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy.

 

Response Description

Sample Response

{

  "resourceType": "Procedure",

  "id": "DEV-DEV-11913-0014800",

  "meta": {

     "lastUpdated": "2022-11-15T12:00:00-05:00",

     "profile": [

        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"

     ]

  },

  "text": {

     "status": "generated",

     "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table><tbody><tr><td>Patient:</td><td>Cole Andersonian, Sr. (DEV-DEV-11913)</td></tr><tr><td>Accession#:</td><td>0014800</td></tr><tr><td>Provider:</td><td>Steven Aspen, M. D. (117)</td></tr><tr><td>Location:</td><td>Inglenook Center (IH1)</td></tr><tr><td>Procedure Date:</td><td>09/20/2022,  1:20 pm</td></tr><tr><td>Description:</td><td>CD Orbits, Face, and Neck, with and without contrast (CPT 70482)</td></tr></tbody></table></div>"

  },

  "status": "completed",

  "code": {

     "coding": [

        {

           "system": "http://www.ama-assn.org/go/cpt",

           "code": "70482",

           "display": "CD Orbits, Face, and Neck, with and without contrast"

        }

     ]

  },

  "subject": {

     "reference": "Patient/DEV-DEV-11913",

     "display": "Cole Andersonian, Sr. (DEV-DEV-11913)"

  },

  "location": {

     "reference": "Location/DEV--IH1",

     "display": "Inglenook Center"

  },

  "performedDateTime": "2022-09-20T13:20:00-04:00",

  "encounter": {

     "reference": "Encounter/DEV-DEV-11913-0014800",

     "display": "09/20/2022 at 1:20 pm, CD Orbits, Face, and Neck, with and without contrast with provider 117 at location IH1"

  },

  "performer": [

     {

        "actor": {

           "reference": "Practitioner/117",

           "display": "Aspen, Steven, MD"

        }

     }

  ]

}

 

 

Procedure.id

 

The logical ID of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Cardinality

0..1

Type

string

 

 

Procedure.meta

 

Metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Cardinality

0..1

Type

Meta

 

 

Procedure.text

 

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.

Cardinality

0..1

Type

Narrative

Comment

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

 

 

Procedure.status

 

A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.

Cardinality

1..1

Type

code: EventStatus

Comment

always completed

 

 

Procedure.code

 

The specific procedure that is performed.

Cardinality

1..1

Type

CodeableConcept Procedure Codes (SNOMED CT)

Comment

always a CPT code.

 

 

Procedure.subject

 

The person on which the procedure was performed.

Cardinality

1..1

Type

Reference(Patient)

 

 

Procedure.location

 

The location where the procedure actually happened

Cardinality

0..*

Type

Reference(Location)

Requirements

Ties a procedure to where the records are likely kept.

 

 

Procedure.performedDateTime

 

Estimated or actual date when the procedure was performed.

Cardinality

0..1

Type

dateTime

 

 

Procedure.encounter

 

The Encounter during which this procedure was created or performed or to which the creation of this record is tightly associated.

Cardinality

0..1

Type

Reference(Encounter)

 

 

Procedure.performer

 

Limited to "real" people rather than equipment.

Cardinality

0..*

Type

BackboneElement

 

 


 

Search

 

URL Syntax

Two HTTP methods are supported for searching: GET and POST. It is recommended to use HTTP POST.

Visit the FHIR Sandbox to try requests.

 

 

HTTP GET - searching

https://sandbox.pai.healthcare/preview/fhir/Procedure?{query string}

 

HTTP GET - return single record

https://sandbox.pai.healthcare/preview/fhir/Procedure/{resource id}

 

HTTP POST - searching

https://sandbox.pai.healthcare/preview/fhir/Procedure/_search

Set the Content-Type header to application/x-www-urlencoded

The body of the request is a similar query string used in the GET type of request detailed above.

 

 

Error Handling

If no records are returned or invalid search parameters are provided, then an HTTP 400 Bad Request is returned.

The body of the response will be an OperationOutcome.

 

 

Supported Search Parameters

 

_id

Corresponds to

Procedure.id

Search

exact

Example

https://sandbox.pai.healthcare/preview/fhir/Procedure/dev-DEV-11913-5926

https://sandbox.pai.healthcare/preview/fhir/Procedure?_id=dev-DEV-11913-5926

 

 

Returns the Procedure for account 11913 in the dev practice where the table ID is 5926.

 

patient

Corresponds to

Procedure.patient

Search

exact

Required

true

Example

https://sandbox.pai.healthcare/preview/fhir/Procedure?patient=Patient/dev-dev-test

 

Returns all Procedures for the test account in the dev practice

 

patient + date

Corresponds to

Procedure.performedDateTime and Procedure.patient

Search

exact

Example

https://sandbox.pai.healthcare/preview/fhir/Procedure?patient=Patient/DEV-DEV-test&date=2020-09-08

 

Returns all Procedures for patient test performed on 09/08/2020.

 

patient + code

Corresponds to

Procedure.code and Procedure.patient

Search

exact

Example

https://sandbox.pai.healthcare/preview/fhir/Procedure?patient=Patient/DEV-DEV-11913&date=2020-09-08&code=74010,12345

 

Returns all Procedures with codes 74010 or 12345 for patient 11913 on 09/08/2020.