The Encounter resource implements the FHIR R4 Encounter specification and US Core v3.1.1 Encounter profile

Fields

Name Type Cardinality Required Description
identifier Identifier 0..*   Identifier(s) by which this encounter is known
status code 1..1 * planned | arrived | triaged | in-progress | onleave | finished | cancelled +
statusHistory BackboneElement 0..*   List of past encounter statuses
class Coding 1..1 * inpatient | outpatient | ambulatory | emergency +
classHistory BackboneElement 0..*   List of past encounter classes
type CodeableConcept 1..* * Specific type of encounter - Binding
serviceType CodeableConcept 0..1   Specific type of service
priority CodeableConcept 0..1   Indicates the urgency of the encounter
subject Reference(US Core Patient Profile) 1..1 * The patient or group present at the encounter
episodeOfCare Reference 0..*   Episode(s) of care that this encounter should be recorded against
basedOn Reference 0..*   The ServiceRequest that initiated this encounter
participant BackboneElement 0..*   List of participants involved in the encounter
appointment Reference 0..*   The appointment that scheduled this encounter
period Period 0..1   The start and end time of the encounter
length Duration 0..1   Quantity of time the encounter lasted (less time absent)
reasonCode CodeableConcept 0..*   Coded reason the encounter takes place
reasonReference Reference 0..*   Reason the encounter takes place (reference)
diagnosis BackboneElement 0..*   The list of diagnosis relevant to this encounter
account Reference 0..*   The set of accounts that may be used for billing for this Encounter
hospitalization BackboneElement 0..1   Details about the admission to a healthcare service
hospitalization.dischargeDisposition CodeableConcept 0..1   Category or kind of location after discharge
location BackboneElement 0..*   List of locations where the patient has been
location.location Location 1..1 * Location the encounter takes place
serviceProvider Reference 0..1   The custodian organization of this Encounter record
partOf Reference 0..1   Another Encounter this encounter is part of

Interactions

Read

Get an Encounter entry by id

GET /Encounter/:id

Example

Request

https://r4cert.medicasoft.us/api/fhir/Encounter/1cc3365a-46f4-3ab0-dd9d-d8a8b79af6cd

Response

{
  "resourceType": "Encounter",
  "identifier": [
    {
      "value": "1cc3365a-46f4-3ab0-dd9d-d8a8b79af6cd",
      "system": "https://github.com/synthetichealth/synthea"
    }
  ],
  "status": "finished",
  "class": {
    "code": "EMER",
    "system": "http://hl7.org/fhir/v3/ActCode",
    "display": "emergency"
  },
  "type": [
    {
      "coding": [
        {
          "code": "50849002",
          "system": "http://snomed.info/sct",
          "display": "Emergency room admission (procedure)"
        }
      ],
      "text": "Emergency room admission (procedure)"
    }
  ],
  "subject": {
    "reference": "Patient/bcfa83df-ee8c-9721-cc07-bdcfc2b1e3f2",
    "display": "Mr. Walton167 Veum823"
  },
  "participant": [
    {
      "individual": {
        "reference": "Practitioner/938fcb90-fd0a-351e-a874-a0cd3bdc81b9",
        "display": "Dr. Ingrid581 Jacobson885"
      },
      "type": [
        {
          "coding": [
            {
              "code": "PPRF",
              "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
              "display": "primary performer"
            }
          ],
          "text": "primary performer"
        }
      ],
      "period": {
        "start": "1957-04-18T00:19:44-05:00",
        "end": "1957-04-18T01:19:44-05:00"
      }
    }
  ],
  "period": {
    "start": "1957-04-18T00:19:44-05:00",
    "end": "1957-04-18T01:19:44-05:00"
  },
  "location": [
    {
      "location": {
        "reference": "Location/80e11f9b-dff5-3ffe-7b86-badb7cb41ad0",
        "display": "BETH ISRAEL DEACONESS HOSPITAL - PLYMOUTH"
      }
    }
  ],
  "id": "1cc3365a-46f4-3ab0-dd9d-d8a8b79af6cd"
}

Query Encounter resources

GET /Encounter?:query_parameters

Parameters

Name Type Description
date date A date within the period the Encounter lasted
identifier token Identifier(s) by which this encounter is known
episodeofcare reference Episode(s) of care that this encounter should be recorded against
participant-type token Role of participant in encounter
practitioner reference Persons involved in the encounter other than the patient
subject reference The patient ro group present at the encounter
length number Length of encounter in days
diagnosis reference Reason the encounter takes place (resource)
appointment reference The appointment that scheduled this encounter
participant reference Persons involved in the encounter other than the patient
patient reference The patient ro group present at the encounter
location-period date Time period during which the patient was present at the location
location reference Location the encounter takes place
service-provider reference The custodian organization of this Encounter record
class token inpatient | outpatient | ambulatory | emergency +
status token planned | arrived | triaged | in-progress | onleave | finished | cancelled +
service-type token  
_include   Encounter:episodeofcare | Encounter:subject | Encounter:diagnosis | Encounter:appointment | Encounter:participant | Encounter:patient | Encounter:location | Encounter:service-provider | Encounter:account
_revinclude   Provenance:target

Errors

Code Description
400 Invalid parameters
404 Resource not found