Skip to main content

Encounter

ResourceBase · ManagementTrial useMaturity 2

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.

Tested supportFull test results →
Backends
PostgreSQLElasticsearch
Interactions
CreateReadUpdatePatchDelete
Search
23 of 23 parameters tested

Structure​

ElementCard.TypeDescription
identifierΣ
0..*IdentifierIdentifier(s) by which this encounter is known
statusRequired?!Σ
1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +Binding (required): encounter-status
statusHistory
0..*BackboneElementList of past encounter statuses
statusRequired
1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +Binding (required): encounter-status
periodRequired
1..1PeriodThe time that the episode was in the specified status
classRequiredΣ
1..1CodingClassification of patient encounterBinding (extensible): v3-ActEncounterCode
classHistory
0..*BackboneElementList of past encounter classes
classRequired
1..1Codinginpatient | outpatient | ambulatory | emergency +Binding (extensible): v3-ActEncounterCode
periodRequired
1..1PeriodThe time that the episode was in the specified class
typeΣ
0..*CodeableConceptSpecific type of encounterBinding (example): encounter-type
serviceTypeΣ
0..1CodeableConceptSpecific type of serviceBinding (example): service-type
priority
0..1CodeableConceptIndicates the urgency of the encounterBinding (example): v3-ActPriority
subjectΣ
0..1Reference(Patient | Group)The patient or group present at the encounter
episodeOfCareΣ
0..*Reference(EpisodeOfCare)Episode(s) of care that this encounter should be recorded against
basedOn
0..*Reference(ServiceRequest)The ServiceRequest that initiated this encounter
participantΣ
0..*BackboneElementList of participants involved in the encounter
typeΣ
0..*CodeableConceptRole of participant in encounterBinding (extensible): encounter-participant-type
period
0..1PeriodPeriod of time during the encounter that the participant participated
individualΣ
0..1Reference(Practitioner | PractitionerRole | RelatedPerson)Persons involved in the encounter other than the patient
appointmentΣ
0..*Reference(Appointment)The appointment that scheduled this encounter
period
0..1PeriodThe start and end time of the encounter
length
0..1DurationQuantity of time the encounter lasted (less time absent)
reasonCodeΣ
0..*CodeableConceptCoded reason the encounter takes placeBinding (preferred): encounter-reason
reasonReferenceΣ
0..*Reference(Condition | Procedure | Observation | ImmunizationRecommendation)Reason the encounter takes place (reference)
diagnosisΣ
0..*BackboneElementThe list of diagnosis relevant to this encounter
conditionRequiredΣ
1..1Reference(Condition | Procedure)The diagnosis or procedure relevant to the encounter
use
0..1CodeableConceptRole that this diagnosis has within the encounter (e.g. admission, billing, discharge …)Binding (preferred): diagnosis-role
rank
0..1positiveIntRanking of the diagnosis (for each role type)
account
0..*Reference(Account)The set of accounts that may be used for billing for this Encounter
hospitalization
0..1BackboneElementDetails about the admission to a healthcare service
preAdmissionIdentifier
0..1IdentifierPre-admission identifier
origin
0..1Reference(Location | Organization)The location/organization from which the patient came before admission
admitSource
0..1CodeableConceptFrom where patient was admitted (physician referral, transfer)Binding (preferred): encounter-admit-source
reAdmission
0..1CodeableConceptThe type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmissionBinding (example): v2-0092
dietPreference
0..*CodeableConceptDiet preferences reported by the patientBinding (example): encounter-diet
specialCourtesy
0..*CodeableConceptSpecial courtesies (VIP, board member)Binding (preferred): encounter-special-courtesy
specialArrangement
0..*CodeableConceptWheelchair, translator, stretcher, etc.Binding (preferred): encounter-special-arrangements
destination
0..1Reference(Location | Organization)Location/organization to which the patient is discharged
dischargeDisposition
0..1CodeableConceptCategory or kind of location after dischargeBinding (example): encounter-discharge-disposition
location
0..*BackboneElementList of locations where the patient has been
locationRequired
1..1Reference(Location)Location the encounter takes place
status
0..1codeplanned | active | reserved | completedBinding (required): encounter-location-status
physicalType
0..1CodeableConceptThe physical type of the location (usually the level in the location hierachy - bed room ward etc.)Binding (example): location-physical-type
period
0..1PeriodTime period during which the patient was present at the location
serviceProvider
0..1Reference(Organization)The organization (facility) responsible for this encounter
partOf
0..1Reference(Encounter)Another Encounter this encounter is part of

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters​

Query with GET [base]/Encounter?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

ParameterTypeDescriptionPGES
accountreference

The set of accounts that may be used for billing for this Encounter

Encounter.account
appointmentreference

The appointment that scheduled this encounter

Encounter.appointment
based-onreference

The ServiceRequest that initiated this encounter

Encounter.basedOn
classtoken

Classification of patient encounter

Encounter.class
datedate

A date within the period the Encounter lasted

Encounter.period
diagnosisreference

The diagnosis or procedure relevant to the encounter

Encounter.diagnosis.condition
episode-of-carereference

Episode(s) of care that this encounter should be recorded against

Encounter.episodeOfCare
identifiertoken

Identifier(s) by which this encounter is known

Encounter.identifier
lengthquantity

Length of encounter in days

Encounter.length
locationreference

Location the encounter takes place

Encounter.location.location
location-perioddate

Time period during which the patient was present at the location

Encounter.location.period
part-ofreference

Another Encounter this encounter is part of

Encounter.partOf
participantreference

Persons involved in the encounter other than the patient

Encounter.participant.individual
participant-typetoken

Role of participant in encounter

Encounter.participant.type
patientreference

The patient or group present at the encounter

Encounter.subject.where(resolve() is Patient)
practitionerreference

Persons involved in the encounter other than the patient

Encounter.participant.individual.where(resolve() is Practitioner)
reason-codetoken

Coded reason the encounter takes place

Encounter.reasonCode
reason-referencereference

Reason the encounter takes place (reference)

Encounter.reasonReference
service-providerreference

The organization (facility) responsible for this encounter

Encounter.serviceProvider
special-arrangementtoken

Wheelchair, translator, stretcher, etc.

Encounter.hospitalization.specialArrangement
statustoken

planned | arrived | triaged | in-progress | onleave | finished | cancelled +

Encounter.status
subjectreference

The patient or group present at the encounter

Encounter.subject
typetoken

Specific type of encounter

Encounter.type

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)
_haste-health-authorreference

The author of the resource

_idtoken

Logical id of this artifact

_lastUpdateddate

When the resource version last changed

_profileuri

Profiles this resource claims to conform to

_securitytoken

Security Labels applied to this resource

_sourceuri

Identifies where the resource comes from

_tagtoken

Tags applied to this resource

_typetoken

Derived from the R4B Definition