Encounter

An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

Response Description

Sample Response

{

  "resourceType": "Encounter",

  "id": "DEV-DEV-11913-0014789",

  "meta": {

     "lastUpdated": "2022-10-26T12:00:00-04:00",

     "profile": [

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

     ]

  },

  "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>0014789</td></tr><tr><td>Provider:</td><td>Steven Aspen, M. D. (117)</td></tr><tr><td>Location:</td><td>GreenTree Medical Office (OF1)</td></tr><tr><td>Encounter Date:</td><td>10/24/2022,  7:00 am, 10 minutes long</td></tr><tr><td>Description:</td><td>MRI L/Knee<br/>The patient has limited mobility and will need extra assistance for the test.</td></tr></tbody></table></div>"

  },

  "identifier": [

     {

        "system": "https://pai.healthcare",

        "value": "DEV-DEV-11913-0014789"

     }

  ],

  "status": "cancelled",

  "class": {

     "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",

     "code": "AMB",

     "display": "ambulatory"

  },

  "type": [

     {

        "coding": [

           {

              "system": "http://snomed.info/sct",

              "code": "270427003",

              "display": "Patient-initiated encounter"

           }

        ]

     }

  ],

  "subject": {

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

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

  },

  "period": {

     "start": "2022-10-24T07:00:00-04:00"

  },

  "participant": [

     {

        "type": [

           {

              "coding": [

                 {

                    "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",

                    "code": "PART",

                    "display": "Participation"

                 }

              ]

           }

        ],

        "individual": {

           "reference": "Practitioner/117"

        },

        "period": {

           "start": "2022-10-24T07:00:00-04:00"

        }

     }

  ],

  "hospitalization": {

      "dischargeDisposition": {

         "coding": [

            {

               "system": "http://www.nubc.org/patient-discharge",

               "code": "01",

               "display": "Discharged to Home"

            }

         ]

      }

  },

  "reasonCode": [

     {

        "text": "MRI L/Knee"

     }

  ],

  "location": [

     {

        "location": {

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

           "display": "GreenTree Medical Office"

        }

     }

  ]

}

Encounter.id

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

Encounter.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.

Encounter.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.

Encounter.identifier

Identifier(s) by which this encounter is known.

Encounter.identifier.system

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Encounter.identifier.value

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Encounter.status

The status of the encounter.

Encounter.class

Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.

Encounter.type

Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).

Encounter.subject

The patient present at the encounter.

Encounter.period

The start and end time of the encounter.

Encounter.participant

The list of people responsible for providing the service.

Encounter.participant.type

Role of participant in encounter.

Encounter.participant.period

The period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period.

Encounter.participant.individual

Persons involved in the encounter other than the patient.

Encounter.hospitalization

Details about the admission to a healthcare service.

Encounter.hospitalization.dischargeDisposition

Category or kind of location after discharge.

Encounter.reasonCode

Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.

Encounter.location

List of locations where the patient has been during this encounter.

Encounter.location.location

The location where the encounter takes place.

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/Encounter?{query string}

HTTP GET - return single record

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

HTTP POST - searching

https://sandbox.pai.healthcare/preview/fhir/Encounter/_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

patient

date