Release
4B
5
Ballot
Administration
This
page
is
part
of
the
FHIR
Specification
(v4.3.0:
R4B
(v5.0.0-ballot:
R5
Ballot
-
STU
see
ballot
notes
).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
|
Patient
Administration
Work
Group
|
Maturity Level : 2 | Trial Use | Security Category : Patient | Compartments : Encounter , Patient , Practitioner , RelatedPerson |
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. Encounter is primarily used to record information about the actual activities that occurred, where Appointment is used to record planned activities.
A patient encounter is further characterized by the setting in which it takes place. Amongst them are ambulatory, emergency, home health, inpatient and virtual encounters. An Encounter encompasses the lifecycle from pre-admission, the actual encounter (for ambulatory encounters), and admission, stay and discharge (for inpatient encounters). During the encounter the patient may move from practitioner to practitioner and location to location.
Because
of
the
broad
scope
of
Encounter,
not
all
elements
will
be
relevant
in
all
settings.
For
this
reason,
admission/discharge
related
information
is
kept
in
a
separate
Hospitalization
admission
component
within
Encounter.
The
class
element
is
used
to
distinguish
between
these
settings,
which
will
guide
further
validation
and
application
of
business
rules.
There
is
also
substantial
variance
from
organization
to
organization
(and
between
jurisdictions
and
countries)
on
which
business
events
translate
to
the
start
of
a
new
Encounter,
or
what
level
of
aggregation
is
used
for
Encounter.
For
example,
each
single
visit
of
a
practitioner
during
a
hospitalization
may
lead
to
a
new
instance
of
Encounter,
but
depending
on
local
practice
and
the
systems
involved,
it
may
well
be
that
this
is
aggregated
to
a
single
instance
for
a
whole
hospitalization.
admission.
Even
more
aggregation
may
occur
where
jurisdictions
introduce
groups
of
Encounters
for
financial
or
other
reasons.
Encounters
can
be
aggregated
or
grouped
under
other
Encounters
using
the
partOf
element.
See
below
for
examples.
Encounter instances may exist before the actual encounter takes place to convey pre-admission information, including using Encounters elements to reflect the planned start date or planned encounter locations. In this case the status element is set to 'planned'.
The
Hospitalization
admission
component
is
intended
to
store
the
extended
information
relating
to
a
hospitalization
admission
event.
It
is
always
expected
to
be
the
same
period
as
the
encounter
itself.
Where
the
period
is
different,
another
encounter
instance
should
be
used
to
capture
this
information
as
a
partOf
this
encounter
instance.
The
Procedure
and
encounter
have
references
to
each
other,
and
these
should
be
to
different
procedures;
one
for
the
procedure
that
was
performed
during
the
encounter
(stored
in
Procedure.encounter),
and
another
for
cases
where
an
encounter
is
a
result
of
another
procedure
(stored
in
Encounter.indication)
Encounter.reason)
such
as
a
follow-up
encounter
to
resolve
complications
from
an
earlier
procedure.
During
the
life-cycle
of
an
encounter
it
will
pass
through
many
statuses.
Typically
these
are
in
order
or
the
organization's
workflow:
planned,
in-progress,
finished/cancelled.
This
status
information
is
often
used
for
other
things,
and
often
an
analysis
of
the
status
history
is
required.
This
could
be
done
by
scanning
through
all
the
versions
of
the
encounter,
checking
the
period
of
each,
and
then
doing
some
form
of
post
processing.
To
ease
the
burden
of
this
(or
where
a
system
doesn't
support
resource
histories)
a
status
history
component
is
included.
There
is
no
direct
indication
purely
by
the
status
field
as
to
whether
an
encounter
is
considered
"admitted".
The
context
of
the
encounter
and
business
practices/policies/workflows/types
can
influence
this
definition.
(e.g.,
acute
care
facility,
aged
care
center,
outpatient
clinic,
emergency
department,
community-based
clinic).
Statuses
of
"arrived",
"triaged"
or
"in
progress"
could
be
considered
the
start
of
the
admission,
and
also
have
the
presence
of
the
hospitalization
admission
sub-component
entered.
The
"discharged"
status
can
be
used
when
the
patient
care
is
complete
but
the
encounter
itself
is
not
yet
completed,
such
as
while
collating
required
information
for
billing
or
other
purposes,
or
could
be
skipped
and
go
direct
to
"completed".
The
"on
leave"
status
might
or
might
not
be
a
part
of
the
admission,
for
example
if
the
patient
was
permitted
to
go
home
for
a
weekend
or
some
other
form
of
external
event.
The
location
is
also
likely
to
be
filled
in
with
a
location
status
of
"present".
"active".
For
other
examples
such
as
an
outpatient
visit
(day
procedure
-
colonoscopy),
the
patient
could
also
be
considered
to
be
admitted,
hence
the
encounter
doesn't
have
a
fixed
definition
of
admitted.
At
a
minimum,
we
do
believe
that
a
patient
IS
admitted
when
the
status
is
in-progress.
The
Encounter
resource
is
not
to
be
used
to
store
appointment
information,
the
Appointment
resource
is
intended
to
be
used
for
that.
Note
that
in
many
systems
outpatient
encounters
(which
are
in
scope
for
Encounter)
and
Appointment
are
used
concurrently.
In
FHIR,
Appointment
is
used
for
establishing
a
date
for
the
encounter,
while
Encounter
is
applicable
to
information
about
the
actual
Encounter,
i.e.,
the
patient
showing
up.
As
such,
an
encounter
in
the
"planned"
status
is
not
identical
to
the
appointment
that
scheduled
it,
but
it
is
the
encounter
prior
to
its
actual
occurrence,
with
the
expectation
that
encounter
will
be
updated
as
it
progresses
to
completion.
Patient
arrival
at
a
location
does
not
necessarily
mean
the
start
of
the
encounter
(e.g.
a
patient
arrives
an
hour
earlier
than
he
is
actually
seen
by
a
practitioner).
An
appointment
is
normally
used
for
the
planning
stage
of
an
appointment,
searching,
locating
an
available
time,
then
making
the
appointment.
Once
this
process
is
completed
and
the
appointment
is
about
to
start,
then
the
appointment
will
be
marked
as
fulfilled,
and
linked
to
the
newly
created
encounter.
This
new
encounter
may
start
in
an
"arrived"
status
when
they
are
admitted
at
a
location
of
the
facility,
and
then
will
move
to
the
ward
where
another
part-of
encounter
may
begin.
Communication
resources
are
used
for
a
simultaneous
interaction
between
a
practitioner
and
a
patient
where
there
is
no
direct
contact.
Examples
include
a
phone
message,
or
transmission
of
some
correspondence
documentation.
There
is
no
duration
recorded
for
a
communication
resource,
but
it
could
contain
sent
and
received
times.
Standard
Extension:
Associated
Encounter
This
extension
should
be
used
to
reference
an
encounter
where
there
is
no
property
that
already
defines
this
association
on
the
resource.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
Encounter
|
TU | DomainResource |
An
interaction
during
which
services
are
provided
to
the
patient
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
identifier
|
Σ | 0..* | Identifier |
Identifier(s)
by
which
this
encounter
is
known
|
status
|
?! Σ | 1..1 | code |
planned
|
EncounterStatus ( Required ) |
statusHistory
|
0..* | BackboneElement |
List
of
past
encounter
statuses
|
|
status
|
1..1 | code |
planned
|
EncounterStatus ( Required ) |
|
period
|
1..1 | Period |
The
time
that
the
episode
was
in
the
specified
status
|
|
|
class
|
Σ |
|
|
Classification
of
patient
encounter
(
|
|
classHistory
|
0..* | BackboneElement |
List
of
past
encounter
classes
|
|
|
class
|
1..1 | Coding |
inpatient
|
outpatient
|
ambulatory
|
emergency
+
(
|
|
|
period
|
1..1 | Period |
The
time
that
the
episode
was
in
the
specified
class
|
|
|
|
|
|
CodeableConcept |
(
Example
)
|
|
|
Σ |
|
CodeableConcept |
Specific
type
of
|
serviceType
|
Σ |
|
|
|
|
subject
|
Σ | 0..1 | Reference ( Patient | Group ) |
The
patient
or
group
|
|
subjectStatus
| 0..1 | CodeableConcept |
The
current
status
of
the
subject
in
relation
to
the
Encounter
EncounterSubjectStatus ( Example ) | |
|
episodeOfCare
|
Σ | 0..* | Reference ( EpisodeOfCare ) |
Episode(s)
of
care
that
this
encounter
should
be
recorded
against
|
|
basedOn
|
0..* | Reference ( CarePlan | DeviceRequest | MedicationRequest | ServiceRequest ) |
The
request
that
initiated
this
encounter
| |
|
careTeam
|
0..* |
Reference
(
|
The
|
|
|
partOf
| 0..1 | Reference ( Encounter ) |
Another
Encounter
this
encounter
is
part
of
| |
|
serviceProvider
| 0..1 | Reference ( Organization ) |
The
organization
(facility)
responsible
for
this
encounter
| |
|
participant
|
Σ C | 0..* | BackboneElement |
List
of
participants
involved
in
the
encounter
+ Rule: A type must be provided when no explicit actor is specified + Rule: A type cannot be provided for a patient or group participant |
|
type
|
Σ | 0..* | CodeableConcept |
Role
of
participant
in
encounter
ParticipantType ( Extensible ) |
|
period
|
0..1 | Period |
Period
of
time
during
the
encounter
that
the
participant
participated
|
|
|
|
Σ | 0..1 |
Reference
(
Patient
|
Group
|
RelatedPerson
|
Practitioner
|
PractitionerRole
|
|
|
|
appointment
|
Σ | 0..* | Reference ( Appointment ) |
The
appointment
that
scheduled
this
encounter
|
|
|
| VirtualServiceDetail |
Connection
details
of
a
virtual
service
(e.g.
conference
call)
| |
|
actualPeriod
| 0..1 | Period |
The
actual
start
and
end
time
of
the
encounter
|
|
|
plannedStartDate
| 0..1 | dateTime |
The
planned
start
date/time
(or
admission
date)
of
the
encounter
| |
|
plannedEndDate
|
0..1 |
|
|
|
|
|
|
|
|
|
|
|
Σ | 0..* |
|
Reason
the
encounter
takes
place
Encounter Reason Codes ( Preferred ) |
|
diagnosis
|
Σ | 0..* | BackboneElement |
The
list
of
diagnosis
relevant
to
this
encounter
|
|
condition
|
Σ | 1..1 | Reference ( Condition | Procedure ) |
The
diagnosis
or
procedure
relevant
to
the
encounter
|
|
use
|
0..1 | CodeableConcept |
Role
that
this
diagnosis
has
within
the
encounter
(e.g.
admission,
billing,
discharge
…)
DiagnosisRole ( Preferred ) |
|
|
rank
|
0..1 | positiveInt |
Ranking
of
the
diagnosis
(for
each
role
type)
|
|
|
account
|
0..* | Reference ( Account ) |
The
set
of
accounts
that
may
be
used
for
billing
for
this
Encounter
|
|
|
|
0..1 | BackboneElement |
Details
about
the
admission
to
a
healthcare
service
|
|
|
preAdmissionIdentifier
|
0..1 | Identifier |
Pre-admission
identifier
|
|
|
origin
|
0..1 | Reference ( Location | Organization ) |
The
location/organization
from
which
the
patient
came
before
admission
|
|
|
admitSource
|
0..1 | CodeableConcept |
From
where
patient
was
admitted
(physician
referral,
transfer)
AdmitSource ( Preferred ) |
|
|
reAdmission
|
0..1 | CodeableConcept |
The
type
of
hl7VS-re-admissionIndicator
(
Example
)
|
|
|
dietPreference
|
0..* | CodeableConcept |
Diet
preferences
reported
by
the
patient
Diet ( Example ) |
|
|
specialCourtesy
|
0..* | CodeableConcept |
Special
courtesies
(VIP,
board
member)
SpecialCourtesy ( Preferred ) |
|
|
specialArrangement
|
0..* | CodeableConcept |
Wheelchair,
translator,
stretcher,
etc.
SpecialArrangements ( Preferred ) |
|
|
destination
|
0..1 | Reference ( Location | Organization ) |
Location/organization
to
which
the
patient
is
discharged
|
|
|
dischargeDisposition
|
0..1 | CodeableConcept |
Category
or
kind
of
location
after
discharge
DischargeDisposition ( Example ) |
|
location
|
0..* | BackboneElement |
List
of
locations
where
the
patient
has
been
|
|
location
|
1..1 | Reference ( Location ) |
Location
the
encounter
takes
place
|
|
|
status
|
0..1 | code |
planned
|
active
|
reserved
|
completed
EncounterLocationStatus ( Required ) |
|
|
|
0..1 | CodeableConcept |
The
physical
type
of
the
location
(usually
the
level
in
the
location
|
|
|
period
|
0..1 | Period |
Time
period
during
which
the
patient
was
present
at
the
location
|
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
UML Diagram ( Legend )
XML Template
<<Encounter xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Identifier(s) by which this encounter is known --></identifier>
<<status value="[code]"/><!-- 1..1 planned | in-progress | onhold | discharged | completed | cancelled | discontinued | entered-in-error | unknown --> <statusHistory> <!-- 0..* List of past encounter statuses --><<status value="[code]"/><!-- 1..1 planned | in-progress | onhold | discharged | completed | cancelled | discontinued | entered-in-error | unknown --> <period><!-- 1..1 Period The time that the episode was in the specified status --></period> </statusHistory><</class><class><!-- 0..* CodeableConcept Classification of patient encounter<</class><class><!-- 1..1 Coding inpatient | outpatient | ambulatory | emergency +<</serviceType> <</priority> <</subject><serviceType><!-- 0..* CodeableReference(HealthcareService) Specific type of service --></serviceType> <subject><!-- 0..1 Reference(Group|Patient) The patient or group related to this encounter --></subject> <subjectStatus><!-- 0..1 CodeableConcept The current status of the subject in relation to the Encounter --></subjectStatus> <episodeOfCare><!-- 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against --></episodeOfCare><</basedOn><basedOn><!-- 0..* Reference(CarePlan|DeviceRequest|MedicationRequest| ServiceRequest) The request that initiated this encounter --></basedOn> <careTeam><!-- 0..* Reference(CareTeam) The group(s) that are allocated to participate in this encounter --></careTeam> <partOf><!-- 0..1 Reference(Encounter) Another Encounter this encounter is part of --></partOf> <serviceProvider><!-- 0..1 Reference(Organization) The organization (facility) responsible for this encounter --></serviceProvider> <participant> <!-- 0..* List of participants involved in the encounter --> <type><!-- 0..* CodeableConcept Role of participant in encounter --></type> <period><!-- 0..1 Period Period of time during the encounter that the participant participated --></period><</individual><actor><!-- 0..1 Reference(Device|Group|HealthcareService|Patient|Practitioner| PractitionerRole|RelatedPerson) The individual, device, or service participating in the encounter --></actor> </participant> <appointment><!-- 0..* Reference(Appointment) The appointment that scheduled this encounter --></appointment><</period> <</length> <</reasonCode> <| </reasonReference><virtualService><!-- 0..* VirtualServiceDetail Connection details of a virtual service (e.g. conference call) --></virtualService> <actualPeriod><!-- 0..1 Period The actual start and end time of the encounter --></actualPeriod> <plannedStartDate value="[dateTime]"/><!-- 0..1 The planned start date/time (or admission date) of the encounter --> <plannedEndDate value="[dateTime]"/><!-- 0..1 The planned end date/time (or discharge date) of the encounter --> <length><!-- 0..1 Duration Actual quantity of time the encounter lasted (less time absent) --></length> <reason><!-- 0..* CodeableReference(Condition|DiagnosticReport| ImmunizationRecommendation|Observation|Procedure) Reason the encounter takes place (core or reference) --></reason> <diagnosis> <!-- 0..* The list of diagnosis relevant to this encounter --> <condition><!-- 1..1 Reference(Condition|Procedure) The diagnosis or procedure relevant to the encounter --></condition> <use><!-- 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) --></use> <rank value="[positiveInt]"/><!-- 0..1 Ranking of the diagnosis (for each role type) --> </diagnosis> <account><!-- 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter --></account>< <</preAdmissionIdentifier> <</origin> <</admitSource> <</reAdmission> <</dietPreference> <</specialCourtesy> <</specialArrangement> <</destination> <</dischargeDisposition> </hospitalization><admission> <!-- 0..1 Details about the admission to a healthcare service --> <preAdmissionIdentifier><!-- 0..1 Identifier Pre-admission identifier --></preAdmissionIdentifier> <origin><!-- 0..1 Reference(Location|Organization) The location/organization from which the patient came before admission --></origin> <admitSource><!-- 0..1 CodeableConcept From where patient was admitted (physician referral, transfer) --></admitSource> <reAdmission><!-- 0..1 CodeableConcept The type of re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission<</physicalType><form><!-- 0..1 CodeableConcept The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.) --></form> <period><!-- 0..1 Period Time period during which the patient was present at the location --></period> </location><</serviceProvider> <</partOf></Encounter>
JSON Template
{
"resourceType" : "",
"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 | in-progress | onhold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
"statusHistory" : [{ // List of past encounter statuses
"
"status" : "<code>", // R! planned | in-progress | onhold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
"period" : { Period } // R! The time that the episode was in the specified status
}],
"
"class" : [{ CodeableConcept }], // 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
}],
"priority" : { CodeableConcept }, // Indicates the urgency of the encounter
"type" : [{ CodeableConcept }], // Specific type of encounter
"
"
"
"serviceType" : [{ CodeableReference(HealthcareService) }], // Specific type of service
"subject" : { Reference(Group|Patient) }, // The patient or group related to this encounter
"subjectStatus" : { CodeableConcept }, // The current status of the subject in relation to the Encounter
"episodeOfCare" : [{ Reference(EpisodeOfCare) }], // Episode(s) of care that this encounter should be recorded against
"
"basedOn" : [{ Reference(CarePlan|DeviceRequest|MedicationRequest|
ServiceRequest) }], // The request that initiated this encounter
"careTeam" : [{ Reference(CareTeam) }], // The group(s) that are allocated to participate in this encounter
"partOf" : { Reference(Encounter) }, // Another Encounter this encounter is part of
"serviceProvider" : { Reference(Organization) }, // The organization (facility) responsible for 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
"
"actor" : { Reference(Device|Group|HealthcareService|Patient|Practitioner|
PractitionerRole|RelatedPerson) } // The individual, device, or service participating in the encounter
}],
"appointment" : [{ Reference(Appointment) }], // The appointment that scheduled this encounter
"
"
"
"|
"virtualService" : [{ VirtualServiceDetail }], // Connection details of a virtual service (e.g. conference call)
"actualPeriod" : { Period }, // The actual start and end time of the encounter
"plannedStartDate" : "<dateTime>", // The planned start date/time (or admission date) of the encounter
"plannedEndDate" : "<dateTime>", // The planned end date/time (or discharge date) of the encounter
"length" : { Duration }, // Actual quantity of time the encounter lasted (less time absent)
"reason" : [{ CodeableReference(Condition|DiagnosticReport|
ImmunizationRecommendation|Observation|Procedure) }], // Reason the encounter takes place (core or 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
"
"
"
"
"
"
"
"
"
"
"admission" : { // 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 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
"
"form" : { CodeableConcept }, // The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.)
"period" : { Period } // Time period during which the patient was present at the location
}],
"
"
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:;[ a fhir:Encounter; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:Encounter.identifier [ Identifier ], ... ; # 0..* Identifier(s) by which this encounter is knownfhir:fhir:Encounter.status [ code ]; # 1..1 planned | in-progress | onhold | discharged | completed | cancelled | discontinued | entered-in-error | unknown fhir:Encounter.statusHistory [ # 0..* List of past encounter statusesfhir:fhir:Encounter.statusHistory.status [ code ]; # 1..1 planned | in-progress | onhold | discharged | completed | cancelled | discontinued | entered-in-error | unknown fhir:Encounter.statusHistory.period [ Period ]; # 1..1 The time that the episode was in the specified status ], ...;fhir:fhir:Encounter.class [ CodeableConcept ], ... ; # 0..* Classification of patient encounter fhir:Encounter.classHistory [ # 0..* List of past encounter classes fhir:Encounter.classHistory.class [ Coding ]; # 1..1 inpatient | outpatient | ambulatory | emergency + fhir:Encounter.classHistory.period [ Period ]; # 1..1 The time that the episode was in the specified class ], ...;fhir: fhir:fhir:Encounter.priority [ CodeableConcept ]; # 0..1 Indicates the urgency of the encounterfhir:fhir:Encounter.type [ CodeableConcept ], ... ; # 0..* Specific type of encounter fhir:Encounter.serviceType [ CodeableReference(HealthcareService) ], ... ; # 0..* Specific type of service fhir:Encounter.subject [ Reference(Group|Patient) ]; # 0..1 The patient or group related to this encounter fhir:Encounter.subjectStatus [ CodeableConcept ]; # 0..1 The current status of the subject in relation to the Encounter fhir:Encounter.episodeOfCare [ Reference(EpisodeOfCare) ], ... ; # 0..* Episode(s) of care that this encounter should be recorded againstfhir:fhir:Encounter.basedOn [ Reference(CarePlan|DeviceRequest|MedicationRequest|ServiceRequest) ], ... ; # 0..* The request that initiated this encounter fhir:Encounter.careTeam [ Reference(CareTeam) ], ... ; # 0..* The group(s) that are allocated to participate in this encounter fhir:Encounter.partOf [ Reference(Encounter) ]; # 0..1 Another Encounter this encounter is part of fhir:Encounter.serviceProvider [ Reference(Organization) ]; # 0..1 The organization (facility) responsible for this encounter fhir:Encounter.participant [ # 0..* List of participants involved in the encounter fhir:Encounter.participant.type [ CodeableConcept ], ... ; # 0..* Role of participant in encounter fhir:Encounter.participant.period [ Period ]; # 0..1 Period of time during the encounter that the participant participatedfhir:fhir:Encounter.participant.actor [ Reference(Device|Group|HealthcareService|Patient|Practitioner|PractitionerRole| RelatedPerson) ]; # 0..1 The individual, device, or service participating in the encounter ], ...; fhir:Encounter.appointment [ Reference(Appointment) ], ... ; # 0..* The appointment that scheduled this encounterfhir: fhir: fhir: fhir:fhir:Encounter.virtualService [ VirtualServiceDetail ], ... ; # 0..* Connection details of a virtual service (e.g. conference call) fhir:Encounter.actualPeriod [ Period ]; # 0..1 The actual start and end time of the encounter fhir:Encounter.plannedStartDate [ dateTime ]; # 0..1 The planned start date/time (or admission date) of the encounter fhir:Encounter.plannedEndDate [ dateTime ]; # 0..1 The planned end date/time (or discharge date) of the encounter fhir:Encounter.length [ Duration ]; # 0..1 Actual quantity of time the encounter lasted (less time absent) fhir:Encounter.reason [ CodeableReference(Condition|DiagnosticReport|ImmunizationRecommendation|Observation|Procedure) ], ... ; # 0..* Reason the encounter takes place (core or reference) fhir:Encounter.diagnosis [ # 0..* The list of diagnosis relevant to this encounter fhir:Encounter.diagnosis.condition [ Reference(Condition|Procedure) ]; # 1..1 The diagnosis or procedure relevant to the encounter fhir:Encounter.diagnosis.use [ CodeableConcept ]; # 0..1 Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) fhir:Encounter.diagnosis.rank [ positiveInt ]; # 0..1 Ranking of the diagnosis (for each role type) ], ...; fhir:Encounter.account [ Reference(Account) ], ... ; # 0..* The set of accounts that may be used for billing for this Encounterfhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir:fhir:Encounter.admission [ # 0..1 Details about the admission to a healthcare service fhir:Encounter.admission.preAdmissionIdentifier [ Identifier ]; # 0..1 Pre-admission identifier fhir:Encounter.admission.origin [ Reference(Location|Organization) ]; # 0..1 The location/organization from which the patient came before admission fhir:Encounter.admission.admitSource [ CodeableConcept ]; # 0..1 From where patient was admitted (physician referral, transfer) fhir:Encounter.admission.reAdmission [ CodeableConcept ]; # 0..1 The type of re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission fhir:Encounter.admission.dietPreference [ CodeableConcept ], ... ; # 0..* Diet preferences reported by the patient fhir:Encounter.admission.specialCourtesy [ CodeableConcept ], ... ; # 0..* Special courtesies (VIP, board member) fhir:Encounter.admission.specialArrangement [ CodeableConcept ], ... ; # 0..* Wheelchair, translator, stretcher, etc. fhir:Encounter.admission.destination [ Reference(Location|Organization) ]; # 0..1 Location/organization to which the patient is discharged fhir:Encounter.admission.dischargeDisposition [ CodeableConcept ]; # 0..1 Category or kind of location after discharge ]; fhir:Encounter.location [ # 0..* List of locations where the patient has been fhir:Encounter.location.location [ Reference(Location) ]; # 1..1 Location the encounter takes place fhir:Encounter.location.status [ code ]; # 0..1 planned | active | reserved | completedfhir:fhir:Encounter.location.form [ CodeableConcept ]; # 0..1 The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.) fhir:Encounter.location.period [ Period ]; # 0..1 Time period during which the patient was present at the location ], ...;fhir: fhir:]
Changes since R4
| Encounter | |
| Encounter.class |
|
| Encounter.classHistory.class |
|
| Encounter.serviceType |
|
| Encounter.subjectStatus |
|
| Encounter.basedOn |
|
| Encounter.careTeam |
|
| Encounter.participant.actor |
|
| Encounter.virtualService |
|
| Encounter.actualPeriod |
|
| Encounter.plannedStartDate |
|
| Encounter.plannedEndDate |
|
| Encounter.reason |
|
| Encounter.admission |
|
| Encounter.admission.preAdmissionIdentifier |
|
| Encounter.admission.origin |
|
| Encounter.admission.admitSource |
|
| Encounter.admission.reAdmission |
|
| Encounter.admission.dietPreference |
|
| Encounter.admission.specialCourtesy |
|
| Encounter.admission.specialArrangement |
|
| Encounter.admission.destination |
|
| Encounter.admission.dischargeDisposition |
|
| Encounter.location.form |
|
| Encounter.participant.individual |
|
| Encounter.period |
|
| Encounter.reasonCode |
|
| Encounter.reasonReference |
|
| Encounter.hospitalization |
|
| Encounter.location.physicalType |
|
See the Full Difference for further information
This analysis is available as XML or JSON .
Conversions
between
R3
and
R4
See
R3
<-->
R4
Conversion
Maps
(status
=
10
tests
that
all
execute
ok.
All
tests
pass
round-trip
testing
and
3
r3
resources
are
invalid
(0
errors).
)
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
Encounter
|
TU | DomainResource |
An
interaction
during
which
services
are
provided
to
the
patient
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
identifier
|
Σ | 0..* | Identifier |
Identifier(s)
by
which
this
encounter
is
known
|
|
status
|
?! Σ | 1..1 | code |
planned
|
EncounterStatus ( Required ) |
|
statusHistory
|
0..* | BackboneElement |
List
of
past
encounter
statuses
|
|
|
status
|
1..1 | code |
planned
|
EncounterStatus ( Required ) |
|
|
period
|
1..1 | Period |
The
time
that
the
episode
was
in
the
specified
status
|
|
|
class
|
Σ |
|
|
Classification
of
patient
encounter
(
|
|
classHistory
|
0..* | BackboneElement |
List
of
past
encounter
classes
|
|
|
class
|
1..1 | Coding |
inpatient
|
outpatient
|
ambulatory
|
emergency
+
(
|
|
|
period
|
1..1 | Period |
The
time
that
the
episode
was
in
the
specified
class
|
|
|
|
|
|
CodeableConcept |
(
Example
)
|
|
|
Σ |
|
CodeableConcept |
Specific
type
of
|
|
serviceType
|
Σ |
|
|
|
|
subject
|
Σ | 0..1 | Reference ( Patient | Group ) |
The
patient
or
group
|
|
subjectStatus
| 0..1 | CodeableConcept |
The
current
status
of
the
subject
in
relation
to
the
Encounter
EncounterSubjectStatus ( Example ) | |
|
episodeOfCare
|
Σ | 0..* | Reference ( EpisodeOfCare ) |
Episode(s)
of
care
that
this
encounter
should
be
recorded
against
|
|
basedOn
|
0..* | Reference ( CarePlan | DeviceRequest | MedicationRequest | ServiceRequest ) |
The
request
that
initiated
this
encounter
| |
|
careTeam
|
0..* |
Reference
(
|
The
|
|
|
partOf
| 0..1 | Reference ( Encounter ) |
Another
Encounter
this
encounter
is
part
of
| |
|
serviceProvider
| 0..1 | Reference ( Organization ) |
The
organization
(facility)
responsible
for
this
encounter
| |
|
participant
|
Σ C | 0..* | BackboneElement |
List
of
participants
involved
in
the
encounter
+ Rule: A type must be provided when no explicit actor is specified + Rule: A type cannot be provided for a patient or group participant |
|
type
|
Σ | 0..* | CodeableConcept |
Role
of
participant
in
encounter
ParticipantType ( Extensible ) |
|
period
|
0..1 | Period |
Period
of
time
during
the
encounter
that
the
participant
participated
|
|
|
|
Σ | 0..1 |
Reference
(
Patient
|
Group
|
RelatedPerson
|
Practitioner
|
PractitionerRole
|
|
|
|
appointment
|
Σ | 0..* | Reference ( Appointment ) |
The
appointment
that
scheduled
this
encounter
|
|
|
|
VirtualServiceDetail |
Connection
details
of
a
virtual
service
(e.g.
conference
call)
| |
|
actualPeriod
| 0..1 | Period |
The
actual
start
and
end
time
of
the
encounter
|
|
|
plannedStartDate
| 0..1 | dateTime |
The
planned
start
date/time
(or
admission
date)
of
the
encounter
|
|
|
plannedEndDate
|
0..1 |
|
|
|
|
|
|
|
|
|
|
|
Σ | 0..* |
|
Reason
the
encounter
takes
place
Encounter Reason Codes ( Preferred ) |
|
diagnosis
|
Σ | 0..* | BackboneElement |
The
list
of
diagnosis
relevant
to
this
encounter
|
|
condition
|
Σ | 1..1 | Reference ( Condition | Procedure ) |
The
diagnosis
or
procedure
relevant
to
the
encounter
|
|
use
|
0..1 | CodeableConcept |
Role
that
this
diagnosis
has
within
the
encounter
(e.g.
admission,
billing,
discharge
…)
DiagnosisRole ( Preferred ) |
|
|
rank
|
0..1 | positiveInt |
Ranking
of
the
diagnosis
(for
each
role
type)
|
|
|
account
|
0..* | Reference ( Account ) |
The
set
of
accounts
that
may
be
used
for
billing
for
this
Encounter
|
|
|
|
0..1 | BackboneElement |
Details
about
the
admission
to
a
healthcare
service
|
|
|
preAdmissionIdentifier
|
0..1 | Identifier |
Pre-admission
identifier
|
|
|
origin
|
0..1 | Reference ( Location | Organization ) |
The
location/organization
from
which
the
patient
came
before
admission
|
|
|
admitSource
|
0..1 | CodeableConcept |
From
where
patient
was
admitted
(physician
referral,
transfer)
AdmitSource ( Preferred ) |
|
|
reAdmission
|
0..1 | CodeableConcept |
The
type
of
hl7VS-re-admissionIndicator
(
Example
)
|
|
|
dietPreference
|
0..* | CodeableConcept |
Diet
preferences
reported
by
the
patient
Diet ( Example ) |
|
|
specialCourtesy
|
0..* | CodeableConcept |
Special
courtesies
(VIP,
board
member)
SpecialCourtesy ( Preferred ) |
|
|
specialArrangement
|
0..* | CodeableConcept |
Wheelchair,
translator,
stretcher,
etc.
SpecialArrangements ( Preferred ) |
|
|
destination
|
0..1 | Reference ( Location | Organization ) |
Location/organization
to
which
the
patient
is
discharged
|
|
|
dischargeDisposition
|
0..1 | CodeableConcept |
Category
or
kind
of
location
after
discharge
DischargeDisposition ( Example ) |
|
|
location
|
0..* | BackboneElement |
List
of
locations
where
the
patient
has
been
|
|
|
location
|
1..1 | Reference ( Location ) |
Location
the
encounter
takes
place
|
|
|
status
|
0..1 | code |
planned
|
active
|
reserved
|
completed
EncounterLocationStatus ( Required ) |
|
|
|
0..1 | CodeableConcept |
The
physical
type
of
the
location
(usually
the
level
in
the
location
|
|
|
period
|
0..1 | Period |
Time
period
during
which
the
patient
was
present
at
the
location
|
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
XML Template
<<Encounter xmlns="http://hl7.org/fhir"><<status value="[code]"/><!-- 1..1 planned | in-progress | onhold | discharged | completed | cancelled | discontinued | entered-in-error | unknown --> <statusHistory> <!-- 0..* List of past encounter statuses --><<status value="[code]"/><!-- 1..1 planned | in-progress | onhold | discharged | completed | cancelled | discontinued | entered-in-error | unknown --> <period><!-- 1..1 Period The time that the episode was in the specified status --></period> </statusHistory><</class><class><!-- 0..* CodeableConcept Classification of patient encounter<</class><class><!-- 1..1 Coding inpatient | outpatient | ambulatory | emergency +<</serviceType> <</priority> <</subject><serviceType><!-- 0..* CodeableReference(HealthcareService) Specific type of service --></serviceType> <subject><!-- 0..1 Reference(Group|Patient) The patient or group related to this encounter --></subject> <subjectStatus><!-- 0..1 CodeableConcept The current status of the subject in relation to the Encounter --></subjectStatus> <episodeOfCare><!-- 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against --></episodeOfCare><</basedOn><basedOn><!-- 0..* Reference(CarePlan|DeviceRequest|MedicationRequest| ServiceRequest) The request that initiated this encounter --></basedOn> <careTeam><!-- 0..* Reference(CareTeam) The group(s) that are allocated to participate in this encounter --></careTeam> <partOf><!-- 0..1 Reference(Encounter) Another Encounter this encounter is part of --></partOf> <serviceProvider><!-- 0..1 Reference(Organization) The organization (facility) responsible for this encounter --></serviceProvider> <participant> <!-- 0..* List of participants involved in the encounter --> <type><!-- 0..* CodeableConcept Role of participant in encounter --></type> <period><!-- 0..1 Period Period of time during the encounter that the participant participated --></period><</individual><actor><!-- 0..1 Reference(Device|Group|HealthcareService|Patient|Practitioner| PractitionerRole|RelatedPerson) The individual, device, or service participating in the encounter --></actor> </participant> <appointment><!-- 0..* Reference(Appointment) The appointment that scheduled this encounter --></appointment><</period> <</length> <</reasonCode> <| </reasonReference><virtualService><!-- 0..* VirtualServiceDetail Connection details of a virtual service (e.g. conference call) --></virtualService> <actualPeriod><!-- 0..1 Period The actual start and end time of the encounter --></actualPeriod> <plannedStartDate value="[dateTime]"/><!-- 0..1 The planned start date/time (or admission date) of the encounter --> <plannedEndDate value="[dateTime]"/><!-- 0..1 The planned end date/time (or discharge date) of the encounter --> <length><!-- 0..1 Duration Actual quantity of time the encounter lasted (less time absent) --></length> <reason><!-- 0..* CodeableReference(Condition|DiagnosticReport| ImmunizationRecommendation|Observation|Procedure) Reason the encounter takes place (core or reference) --></reason> <diagnosis> <!-- 0..* The list of diagnosis relevant to this encounter --> <condition><!-- 1..1 Reference(Condition|Procedure) The diagnosis or procedure relevant to the encounter --></condition> <use><!-- 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) --></use> <rank value="[positiveInt]"/><!-- 0..1 Ranking of the diagnosis (for each role type) --> </diagnosis> <account><!-- 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter --></account>< <</preAdmissionIdentifier> <</origin> <</admitSource> <</reAdmission> <</dietPreference> <</specialCourtesy> <</specialArrangement> <</destination> <</dischargeDisposition> </hospitalization><admission> <!-- 0..1 Details about the admission to a healthcare service --> <preAdmissionIdentifier><!-- 0..1 Identifier Pre-admission identifier --></preAdmissionIdentifier> <origin><!-- 0..1 Reference(Location|Organization) The location/organization from which the patient came before admission --></origin> <admitSource><!-- 0..1 CodeableConcept From where patient was admitted (physician referral, transfer) --></admitSource> <reAdmission><!-- 0..1 CodeableConcept The type of re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission<</physicalType><form><!-- 0..1 CodeableConcept The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.) --></form> <period><!-- 0..1 Period Time period during which the patient was present at the location --></period> </location><</serviceProvider> <</partOf></Encounter>
JSON Template
{
"resourceType" : "",
"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 | in-progress | onhold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
"statusHistory" : [{ // List of past encounter statuses
"
"status" : "<code>", // R! planned | in-progress | onhold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
"period" : { Period } // R! The time that the episode was in the specified status
}],
"
"class" : [{ CodeableConcept }], // 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
}],
"priority" : { CodeableConcept }, // Indicates the urgency of the encounter
"type" : [{ CodeableConcept }], // Specific type of encounter
"
"
"
"serviceType" : [{ CodeableReference(HealthcareService) }], // Specific type of service
"subject" : { Reference(Group|Patient) }, // The patient or group related to this encounter
"subjectStatus" : { CodeableConcept }, // The current status of the subject in relation to the Encounter
"episodeOfCare" : [{ Reference(EpisodeOfCare) }], // Episode(s) of care that this encounter should be recorded against
"
"basedOn" : [{ Reference(CarePlan|DeviceRequest|MedicationRequest|
ServiceRequest) }], // The request that initiated this encounter
"careTeam" : [{ Reference(CareTeam) }], // The group(s) that are allocated to participate in this encounter
"partOf" : { Reference(Encounter) }, // Another Encounter this encounter is part of
"serviceProvider" : { Reference(Organization) }, // The organization (facility) responsible for 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
"
"actor" : { Reference(Device|Group|HealthcareService|Patient|Practitioner|
PractitionerRole|RelatedPerson) } // The individual, device, or service participating in the encounter
}],
"appointment" : [{ Reference(Appointment) }], // The appointment that scheduled this encounter
"
"
"
"|
"virtualService" : [{ VirtualServiceDetail }], // Connection details of a virtual service (e.g. conference call)
"actualPeriod" : { Period }, // The actual start and end time of the encounter
"plannedStartDate" : "<dateTime>", // The planned start date/time (or admission date) of the encounter
"plannedEndDate" : "<dateTime>", // The planned end date/time (or discharge date) of the encounter
"length" : { Duration }, // Actual quantity of time the encounter lasted (less time absent)
"reason" : [{ CodeableReference(Condition|DiagnosticReport|
ImmunizationRecommendation|Observation|Procedure) }], // Reason the encounter takes place (core or 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
"
"
"
"
"
"
"
"
"
"
"admission" : { // 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 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
"
"form" : { CodeableConcept }, // The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.)
"period" : { Period } // Time period during which the patient was present at the location
}],
"
"
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:;[ a fhir:Encounter; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:Encounter.identifier [ Identifier ], ... ; # 0..* Identifier(s) by which this encounter is knownfhir:fhir:Encounter.status [ code ]; # 1..1 planned | in-progress | onhold | discharged | completed | cancelled | discontinued | entered-in-error | unknown fhir:Encounter.statusHistory [ # 0..* List of past encounter statusesfhir:fhir:Encounter.statusHistory.status [ code ]; # 1..1 planned | in-progress | onhold | discharged | completed | cancelled | discontinued | entered-in-error | unknown fhir:Encounter.statusHistory.period [ Period ]; # 1..1 The time that the episode was in the specified status ], ...;fhir:fhir:Encounter.class [ CodeableConcept ], ... ; # 0..* Classification of patient encounter fhir:Encounter.classHistory [ # 0..* List of past encounter classes fhir:Encounter.classHistory.class [ Coding ]; # 1..1 inpatient | outpatient | ambulatory | emergency + fhir:Encounter.classHistory.period [ Period ]; # 1..1 The time that the episode was in the specified class ], ...;fhir: fhir:fhir:Encounter.priority [ CodeableConcept ]; # 0..1 Indicates the urgency of the encounterfhir:fhir:Encounter.type [ CodeableConcept ], ... ; # 0..* Specific type of encounter fhir:Encounter.serviceType [ CodeableReference(HealthcareService) ], ... ; # 0..* Specific type of service fhir:Encounter.subject [ Reference(Group|Patient) ]; # 0..1 The patient or group related to this encounter fhir:Encounter.subjectStatus [ CodeableConcept ]; # 0..1 The current status of the subject in relation to the Encounter fhir:Encounter.episodeOfCare [ Reference(EpisodeOfCare) ], ... ; # 0..* Episode(s) of care that this encounter should be recorded againstfhir:fhir:Encounter.basedOn [ Reference(CarePlan|DeviceRequest|MedicationRequest|ServiceRequest) ], ... ; # 0..* The request that initiated this encounter fhir:Encounter.careTeam [ Reference(CareTeam) ], ... ; # 0..* The group(s) that are allocated to participate in this encounter fhir:Encounter.partOf [ Reference(Encounter) ]; # 0..1 Another Encounter this encounter is part of fhir:Encounter.serviceProvider [ Reference(Organization) ]; # 0..1 The organization (facility) responsible for this encounter fhir:Encounter.participant [ # 0..* List of participants involved in the encounter fhir:Encounter.participant.type [ CodeableConcept ], ... ; # 0..* Role of participant in encounter fhir:Encounter.participant.period [ Period ]; # 0..1 Period of time during the encounter that the participant participatedfhir:fhir:Encounter.participant.actor [ Reference(Device|Group|HealthcareService|Patient|Practitioner|PractitionerRole| RelatedPerson) ]; # 0..1 The individual, device, or service participating in the encounter ], ...; fhir:Encounter.appointment [ Reference(Appointment) ], ... ; # 0..* The appointment that scheduled this encounterfhir: fhir: fhir: fhir:fhir:Encounter.virtualService [ VirtualServiceDetail ], ... ; # 0..* Connection details of a virtual service (e.g. conference call) fhir:Encounter.actualPeriod [ Period ]; # 0..1 The actual start and end time of the encounter fhir:Encounter.plannedStartDate [ dateTime ]; # 0..1 The planned start date/time (or admission date) of the encounter fhir:Encounter.plannedEndDate [ dateTime ]; # 0..1 The planned end date/time (or discharge date) of the encounter fhir:Encounter.length [ Duration ]; # 0..1 Actual quantity of time the encounter lasted (less time absent) fhir:Encounter.reason [ CodeableReference(Condition|DiagnosticReport|ImmunizationRecommendation|Observation|Procedure) ], ... ; # 0..* Reason the encounter takes place (core or reference) fhir:Encounter.diagnosis [ # 0..* The list of diagnosis relevant to this encounter fhir:Encounter.diagnosis.condition [ Reference(Condition|Procedure) ]; # 1..1 The diagnosis or procedure relevant to the encounter fhir:Encounter.diagnosis.use [ CodeableConcept ]; # 0..1 Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) fhir:Encounter.diagnosis.rank [ positiveInt ]; # 0..1 Ranking of the diagnosis (for each role type) ], ...; fhir:Encounter.account [ Reference(Account) ], ... ; # 0..* The set of accounts that may be used for billing for this Encounterfhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir:fhir:Encounter.admission [ # 0..1 Details about the admission to a healthcare service fhir:Encounter.admission.preAdmissionIdentifier [ Identifier ]; # 0..1 Pre-admission identifier fhir:Encounter.admission.origin [ Reference(Location|Organization) ]; # 0..1 The location/organization from which the patient came before admission fhir:Encounter.admission.admitSource [ CodeableConcept ]; # 0..1 From where patient was admitted (physician referral, transfer) fhir:Encounter.admission.reAdmission [ CodeableConcept ]; # 0..1 The type of re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission fhir:Encounter.admission.dietPreference [ CodeableConcept ], ... ; # 0..* Diet preferences reported by the patient fhir:Encounter.admission.specialCourtesy [ CodeableConcept ], ... ; # 0..* Special courtesies (VIP, board member) fhir:Encounter.admission.specialArrangement [ CodeableConcept ], ... ; # 0..* Wheelchair, translator, stretcher, etc. fhir:Encounter.admission.destination [ Reference(Location|Organization) ]; # 0..1 Location/organization to which the patient is discharged fhir:Encounter.admission.dischargeDisposition [ CodeableConcept ]; # 0..1 Category or kind of location after discharge ]; fhir:Encounter.location [ # 0..* List of locations where the patient has been fhir:Encounter.location.location [ Reference(Location) ]; # 1..1 Location the encounter takes place fhir:Encounter.location.status [ code ]; # 0..1 planned | active | reserved | completedfhir:fhir:Encounter.location.form [ CodeableConcept ]; # 0..1 The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.) fhir:Encounter.location.period [ Period ]; # 0..1 Time period during which the patient was present at the location ], ...;fhir: fhir:]
Changes since Release 4
| Encounter | |
| Encounter.class |
|
| Encounter.classHistory.class |
|
| Encounter.serviceType |
|
| Encounter.subjectStatus |
|
| Encounter.basedOn |
|
| Encounter.careTeam |
|
| Encounter.participant.actor |
|
| Encounter.virtualService |
|
| Encounter.actualPeriod |
|
| Encounter.plannedStartDate |
|
| Encounter.plannedEndDate |
|
| Encounter.reason |
|
| Encounter.admission |
|
| Encounter.admission.preAdmissionIdentifier |
|
| Encounter.admission.origin |
|
| Encounter.admission.admitSource |
|
| Encounter.admission.reAdmission |
|
| Encounter.admission.dietPreference |
|
| Encounter.admission.specialCourtesy |
|
| Encounter.admission.specialArrangement |
|
| Encounter.admission.destination |
|
| Encounter.admission.dischargeDisposition |
|
| Encounter.location.form |
|
| Encounter.participant.individual |
|
| Encounter.period |
|
| Encounter.reasonCode |
|
| Encounter.reasonReference |
|
| Encounter.hospitalization |
|
| Encounter.location.physicalType |
|
See the Full Difference for further information
This analysis is available as XML or JSON .
Conversions
between
R3
and
R4
See
R3
<-->
R4
Conversion
Maps
(status
=
10
tests
that
all
execute
ok.
All
tests
pass
round-trip
testing
and
3
r3
resources
are
invalid
(0
errors).
)
See
the
Profiles
&
Extensions
and
the
alternate
Additional
definitions:
Master
Definition
XML
+
JSON
,
XML
Schema
/
Schematron
+
JSON
Schema
,
ShEx
(for
Turtle
)
+
see
the
extensions
,
the
spreadsheet
version
&
the
dependency
analysis
| Path | Definition | Type | Reference |
|---|---|---|---|
| Encounter.status |
Current state of the encounter. |
Required | EncounterStatus |
| Encounter.statusHistory.status |
Current state of the encounter. |
Required | EncounterStatus |
| Encounter.class |
|
|
|
| Encounter.classHistory.class |
|
| |
| Encounter.priority | A code or set of codes (e.g., for routine, emergency,) specifying the urgency under which the Act happened, can happen, is happening, is intended to happen, or is requested/demanded to happen. Discussion: This attribute is used in orders to indicate the ordered priority, and in event documentation it indicates the actual priority used to perform the act. In definition mood it indicates the available priorities. | Example |
ActPriority
|
| Encounter.type |
This example value set defines a set of codes that can be used to indicate the type of encounter: a specific code indicating type of service provided. |
Example | EncounterType |
| Encounter.serviceType |
This value set defines an example set of codes of service-types. |
Example | ServiceType |
| Encounter.subjectStatus |
This example value set defines a set of codes that can be used to indicate the status of the subject within the encounter |
Example |
|
| Encounter.participant.type |
This value set defines a set of codes that can be used to indicate how an individual participates in an encounter. |
Extensible | ParticipantType |
|
|
This examples value set defines the set of codes that can be used to indicate reasons for an encounter. |
Preferred | EncounterReasonCodes |
| Encounter.diagnosis.use |
This value set defines a set of codes that can be used to express the role of a diagnosis on the Encounter or EpisodeOfCare record. |
Preferred | DiagnosisRole |
|
|
This value set defines a set of codes that can be used to indicate from where the patient came in. |
Preferred | AdmitSource |
|
|
Value Set of codes which are used to specify that a patient is being re-admitted to a healthcare facility from which they were discharged, and indicates the circumstances around such re-admission. |
Example |
Hl7VSReAdmissionIndicator
|
|
|
This value set defines a set of codes that can be used to indicate dietary preferences or restrictions a patient may have. |
Example | Diet |
|
|
This value set defines a set of codes that can be used to indicate special courtesies provided to the patient. |
Preferred | SpecialCourtesy |
|
|
This value set defines a set of codes that can be used to indicate the kinds of special arrangements in place for a patients visit. |
Preferred | SpecialArrangements |
|
|
This value set defines a set of codes that can be used to where the patient left the hospital. |
Example | DischargeDisposition |
| Encounter.location.status |
The status of the location. |
Required | EncounterLocationStatus |
| Encounter.location.form |
This example value set defines a set of codes that can be used to indicate the physical form of the Location. |
Example |
|
| UniqueKey | Level | Location | Description | Expression |
enc-1
| Rule | Encounter.participant | A type must be provided when no explicit actor is specified | actor.exists() or type.exists() |
|
enc-2
| Rule | Encounter.participant | A type cannot be provided for a patient or group participant | actor.exists(resolve() is Patient or resolve() is Group) implies type.exists().not() |
As stated, Encounter allows a flexible nesting of Encounters using the partOf element. For example:
Exactly how the Encounter is used depends on information available in the source system, the relevance of exchange of each level of Encounter and demands specific to the communicating partners. The expectation is that for each domain of exchange, profiles are used to limit the flexibility of Encounter to meet the demands of the use case.
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
| Name | Type | Description | Expression | In Common |
| account | reference | The set of accounts that may be used for billing for this Encounter |
Encounter.account
( Account ) |
|
| appointment | reference | The appointment that scheduled this encounter |
Encounter.appointment
( Appointment ) |
|
| based-on | reference | The ServiceRequest that initiated this encounter |
Encounter.basedOn
( CarePlan , MedicationRequest , DeviceRequest , ServiceRequest ) |
|
| careteam | reference | Careteam allocated to participate in the encounter |
Encounter.careTeam
( CareTeam ) | |
| class | token | Classification of patient encounter | Encounter.class | |
| date | date |
A
date
within
the
|
| |
| date-start | date | The actual start date of the Encounter | Encounter.actualPeriod.start | |
| diagnosis | reference | The diagnosis or procedure relevant to the encounter |
Encounter.diagnosis.condition
( Condition , Procedure ) |
|
| end-date | date | The actual end date of the Encounter | Encounter.actualPeriod.end | |
| episode-of-care | reference | Episode(s) of care that this encounter should be recorded against |
Encounter.episodeOfCare
( EpisodeOfCare ) |
|
| identifier | token | Identifier(s) by which this encounter is known | Encounter.identifier | |
| length | quantity | Length of encounter in days | Encounter.length | |
| location | reference | Location the encounter takes place |
Encounter.location.location
( Location ) |
|
| location-period | date | Time period during which the patient was present at the location | Encounter.location.period | |
| part-of | reference | Another Encounter this encounter is part of |
Encounter.partOf
( Encounter ) |
|
| participant | reference | Persons involved in the encounter other than the patient |
( Practitioner , Group , Device , Patient , HealthcareService , PractitionerRole , RelatedPerson ) |
|
| participant-type | token | Role of participant in encounter | Encounter.participant.type | |
| patient | reference |
The
patient
|
Encounter.subject.where(resolve()
is
Patient)
( Patient ) |
|
| practitioner | reference | Persons involved in the encounter other than the patient |
( Practitioner ) |
|
| reason-code D | token |
|
|
|
| reason-reference D | reference |
|
|
|
| service-provider | reference | The organization (facility) responsible for this encounter |
Encounter.serviceProvider
( Organization ) |
|
| special-arrangement | token | Wheelchair, translator, stretcher, etc. |
|
|
| status N | token |
planned
|
|
Encounter.status | |
| subject | reference | The patient or group present at the encounter |
Encounter.subject
( Group , Patient ) |
|
| subject-status | token | The current status of the subject in relation to the Encounter | Encounter.subjectStatus | |
| type | token | Specific type of encounter | Encounter.type |
FHIR
®©
HL7.org
2011+.
FHIR
Release
4B
(v4.3.0)
hl7.fhir.r4b.core#4.3.0
R5
Ballot
hl7.fhir.core#5.0.0-ballot
generated
on
Sat,
May
28,
Sep
10,
2022
12:55+1000.
05:03+1000.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Glossary
|
QA
Page
|
Compare
to
R4
R4B
|
Compare
to
R5
Draft
|
|
Propose
a
change