Encounter - FHIR Resource (stu3)


This Encounter Resource uses the FHIR API standard for access and structure.

Resource Attributes

AttributeField is listTypeDescription
accounttrueReference The set of accounts that may be used for billing for this Encounter
appointmentfalseReference The appointment that scheduled this encounter
classfalseCoding inpatient | outpatient | ambulatory | emergency +
classHistorytrueData Type List of past encounter classes
diagnosistrueData Type The list of diagnosis relevant to this encounter
episodeOfCaretrueReference Episode(s) of care that this encounter should be recorded against
hospitalizationfalseData Type Details about the admission to a healthcare service
identifiertrueIdentifier Identifier(s) by which this encounter is known
incomingReferraltrueReference The ReferralRequest that initiated this encounter
lengthfalseDuration Quantity of time the encounter lasted (less time absent)
locationtrueData Type List of locations where the patient has been
partOffalseReference Another Encounter this encounter is part of
participanttrueData Type List of participants involved in the encounter
periodfalsePeriod The time that the episode was in the specified status
priorityfalseCodeableConcept Indicates the urgency of the encounter
reasontrueCodeableConcept Reason the encounter takes place (code)
serviceProviderfalseReference The custodian organization of this Encounter record
statusfalsecode planned | arrived | triaged | in-progress | onleave | finished | cancelled +
statusHistorytrueData Type List of past encounter statuses
subjectfalseReference The patient ro group present at the encounter
typetrueCodeableConcept Specific type of encounter

Encounter Example

{
  "status": "in-progress",
  "resourceType": "Encounter",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Encounter with patient @example</div>"
  },
  "class": {
    "code": "IMP",
    "system": "http://hl7.org/fhir/v3/ActCode",
    "display": "inpatient encounter"
  },
  "id": "example",
  "subject": {
    "reference": "Patient/example"
  }
}

Encounter Structure


  
{
  "resourceType" : "Encounter",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Identifier(s) by which this encounter is known
  "status" : "<code>", // R!  planned | arrived | triaged | in-progress | onleave | finished | cancelled +
  "statusHistory" : [{ // List of past encounter statuses
    "status" : "<code>", // R!  planned | arrived | triaged | in-progress | onleave | finished | cancelled +
    "period" : { Period } // R!  The time that the episode was in the specified status
  }],
  "class" : { Coding }, // inpatient | outpatient | ambulatory | emergency +
  "classHistory" : [{ // List of past encounter classes
    "class" : { Coding }, // R!  inpatient | outpatient | ambulatory | emergency +
    "period" : { Period } // R!  The time that the episode was in the specified class
  }],
  "type" : [{ CodeableConcept }], // Specific type of encounter
  "priority" : { CodeableConcept }, // Indicates the urgency of the encounter
  "subject" : { Reference(Patient|Group) }, // The patient ro group present at the encounter
  "episodeOfCare" : [{ Reference(EpisodeOfCare) }], // Episode(s) of care that this encounter should be recorded against
  "incomingReferral" : [{ Reference(ReferralRequest) }], // The ReferralRequest that initiated this encounter
  "participant" : [{ // List of participants involved in the encounter
    "type" : [{ CodeableConcept }], // Role of participant in encounter
    "period" : { Period }, // Period of time during the encounter that the participant participated
    "individual" : { Reference(Practitioner|RelatedPerson) } // Persons involved in the encounter other than the patient
  }],
  "appointment" : { Reference(Appointment) }, // The appointment that scheduled this encounter
  "period" : { Period }, // The start and end time of the encounter
  "length" : { Duration }, // Quantity of time the encounter lasted (less time absent)
  "reason" : [{ CodeableConcept }], // Reason the encounter takes place (code)
  "diagnosis" : [{ // The list of diagnosis relevant to this encounter
    "condition" : { Reference(Condition|Procedure) }, // R!  Reason the encounter takes place (resource)
    "role" : { CodeableConcept }, // Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
    "rank" : "<positiveInt>" // Ranking of the diagnosis (for each role type)
  }],
  "account" : [{ Reference(Account) }], // The set of accounts that may be used for billing for this Encounter
  "hospitalization" : { // Details about the admission to a healthcare service
    "preAdmissionIdentifier" : { Identifier }, // Pre-admission identifier
    "origin" : { Reference(Location) }, // The location from which the patient came before admission
    "admitSource" : { CodeableConcept }, // From where patient was admitted (physician referral, transfer)
    "reAdmission" : { CodeableConcept }, // The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
    "dietPreference" : [{ CodeableConcept }], // Diet preferences reported by the patient
    "specialCourtesy" : [{ CodeableConcept }], // Special courtesies (VIP, board member)
    "specialArrangement" : [{ CodeableConcept }], // Wheelchair, translator, stretcher, etc.
    "destination" : { Reference(Location) }, // Location to which the patient is discharged
    "dischargeDisposition" : { CodeableConcept } // Category or kind of location after discharge
  },
  "location" : [{ // List of locations where the patient has been
    "location" : { Reference(Location) }, // R!  Location the encounter takes place
    "status" : "<code>", // planned | active | reserved | completed
    "period" : { Period } // Time period during which the patient was present at the location
  }],
  "serviceProvider" : { Reference(Organization) }, // The custodian organization of this Encounter record
  "partOf" : { Reference(Encounter) } // Another Encounter this encounter is part of
}


 

Encounter Search Parameters

The following search parameters can be used to query Encounter resources. Just submit the like so:

https://api.1up.health/fhir/stu3/Encounter?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
appointmentreferenceappointment
classtextclass
datedateperiod
diagnosisreferencediagnosis.condition
episodeofcarereferenceepisodeOfCare
identifiertextidentifier
incomingreferralreferenceincomingReferral
lengthnumberlength
locationreferencelocation.location
location-perioddatelocation.period
part-ofreferencepartOf
participantreferenceparticipant.individual
participant-typetextparticipant.type
patientreferencesubject
practitionerreferenceparticipant.individual
reasontextreason
service-providerreferenceserviceProvider
special-arrangementtexthospitalization.specialArrangement
statustextstatus
subjectreferencesubject
typetexttype