Encounter - FHIR Resource (r4)
This Encounter Resource uses the FHIR API standard for access and structure.
Validate an Encounter FHIR Resource (r4)
Encounter Attributes
AttributeField is listTypeDescription
Description: Identifier(s) by which this encounter is known
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (Encounter) identifier FHIR attribute
Description: planned | arrived | triaged | in-progress | onleave | finished | cancelled +
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "in-progress"Learn more about the (Encounter) status FHIR attribute
Description: List of past encounter statuses
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"statusHistory": Learn more about the (Encounter) statusHistory FHIR attribute
Description: Classification of patient encounter
FHIR Version: r4
Attribute Type : Coding
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"class": {
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "IMP",
"display": "inpatient encounter"
}Learn more about the (Encounter) class FHIR attribute
Description: List of past encounter classes
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"classHistory": Learn more about the (Encounter) classHistory FHIR attribute
Description: Specific type of encounter
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": Learn more about the (Encounter) type FHIR attribute
Description: Specific type of service
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"serviceType": Learn more about the (Encounter) serviceType FHIR attribute
Description: Indicates the urgency of the encounter
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"priority": Learn more about the (Encounter) priority FHIR attribute
Description: The patient or group present at the encounter
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject": {
"reference": "Patient/example"
}Learn more about the (Encounter) subject FHIR attribute
Description: Episode(s) of care that this encounter should be recorded against
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"episodeOfCare": Learn more about the (Encounter) episodeOfCare FHIR attribute
Description: The ServiceRequest that initiated this encounter
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"basedOn": Learn more about the (Encounter) basedOn FHIR attribute
Description: List of participants involved in the encounter
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"participant": Learn more about the (Encounter) participant FHIR attribute
Description: The appointment that scheduled this encounter
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"appointment": Learn more about the (Encounter) appointment FHIR attribute
Description: The time that the episode was in the specified status
FHIR Version: r4
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"period": Learn more about the (Encounter) period FHIR attribute
Description: Quantity of time the encounter lasted (less time absent)
FHIR Version: r4
Attribute Type : Duration
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"length": Learn more about the (Encounter) length FHIR attribute
Description: Coded reason the encounter takes place
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reasonCode": Learn more about the (Encounter) reasonCode FHIR attribute
Description: "reasonReference" : [{ Reference(Condition|Procedure|Observation|
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reasonReference": Learn more about the (Encounter) reasonReference FHIR attribute
Description: The list of diagnosis relevant to this encounter
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"diagnosis": Learn more about the (Encounter) diagnosis FHIR attribute
Description: The set of accounts that may be used for billing for this Encounter
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"account": Learn more about the (Encounter) account FHIR attribute
Description: Details about the admission to a healthcare service
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"hospitalization": Learn more about the (Encounter) hospitalization FHIR attribute
Description: List of locations where the patient has been
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"location": Learn more about the (Encounter) location FHIR attribute
Description: The organization (facility) responsible for this encounter
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"serviceProvider": Learn more about the (Encounter) serviceProvider FHIR attribute
Description: Another Encounter this encounter is part of
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"partOf": Learn more about the (Encounter) partOf FHIR attribute
Encounter Example
{
"resourceType": "Encounter",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Encounter with patient @example</div>"
},
"status": "in-progress",
"class": {
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "IMP",
"display": "inpatient encounter"
},
"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 }, // R! Classification of patient encounter
"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
"serviceType" : { CodeableConcept }, // Specific type of service
"priority" : { CodeableConcept }, // Indicates the urgency of the encounter
"subject" : { Reference(Patient|Group) }, // The patient or group present at the encounter
"episodeOfCare" : [{ Reference(EpisodeOfCare) }], // Episode(s) of care that this encounter should be recorded against
"basedOn" : [{ Reference(ServiceRequest) }], // The ServiceRequest 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|PractitionerRole|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)
"reasonCode" : [{ CodeableConcept }], // Coded reason the encounter takes place
"reasonReference" : [{ Reference(Condition|Procedure|Observation|
ImmunizationRecommendation) }], // Reason the encounter takes place (reference)
"diagnosis" : [{ // The list of diagnosis relevant to this encounter
"condition" : { Reference(Condition|Procedure) }, // R! The diagnosis or procedure relevant to the encounter
"use" : { 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|Organization) }, // The location/organization 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|Organization) }, // Location/organization 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
"physicalType" : { CodeableConcept }, // The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
"period" : { Period } // Time period during which the patient was present at the location
}],
"serviceProvider" : { Reference(Organization) }, // The organization (facility) responsible for this encounter
"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 them like so:
https://api.1up.health/fhir/r4/Encounter?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
account | reference | account |
appointment | reference | appointment |
based-on | reference | basedOn |
class | text | class |
date | date | period |
diagnosis | reference | diagnosis.condition |
episode-of-care | reference | episodeOfCare |
identifier | text | identifier |
length | quantity | length |
location | reference | location.location |
location-period | date | location.period |
part-of | reference | partOf |
participant | reference | participant.individual |
participant-type | text | participant.type |
patient | reference | subject.where |
practitioner | reference | participant.individual.where |
reason-code | text | reasonCode |
reason-reference | reference | reasonReference |
service-provider | reference | serviceProvider |
special-arrangement | text | hospitalization.specialArrangement |
status | text | status |
subject | reference | subject |
type | text | type |
