Encounter

Property	Value
Publisher
Name	Encounter
URL	http://hl7.org/fhir/StructureDefinition/Encounter
Status	draft
Description
Abstract	false

Structure

Path	Cardinality	Type	Description
Encounter	0..*	Encounter	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.id	0..1	http://hl7.org/fhirpath/System.String	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Encounter.meta	0..1	Meta	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Encounter.implicitRules	0..1	uri	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Encounter.language	0..1	code	The base language in which the resource is written.
Encounter.text	0..1	Narrative	A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Encounter.contained	0..*	Resource	These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Encounter.extension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Encounter.modifierExtension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Encounter.identifier	0..*	Identifier	Identifier(s) by which this encounter is known.
Encounter.status	1..1	code	planned / arrived / triaged / in-progress / onleave / finished / cancelled +.
Encounter.statusHistory	0..*	BackboneElement	The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.
Encounter.statusHistory.id	0..1	http://hl7.org/fhirpath/System.String	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Encounter.statusHistory.extension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Encounter.statusHistory.modifierExtension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Encounter.statusHistory.status	1..1	code	planned / arrived / triaged / in-progress / onleave / finished / cancelled +.
Encounter.statusHistory.period	1..1	Period	The time that the episode was in the specified status.
Encounter.class	1..1	Coding	Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
Encounter.classHistory	0..*	BackboneElement	The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient.
Encounter.classHistory.id	0..1	http://hl7.org/fhirpath/System.String	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Encounter.classHistory.extension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Encounter.classHistory.modifierExtension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Encounter.classHistory.class	1..1	Coding	inpatient / outpatient / ambulatory / emergency +.
Encounter.classHistory.period	1..1	Period	The time that the episode was in the specified class.
Encounter.type	0..*	CodeableConcept	Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
Encounter.serviceType	0..1	CodeableConcept	Broad categorization of the service that is to be provided (e.g. cardiology).
Encounter.priority	0..1	CodeableConcept	Indicates the urgency of the encounter.
Encounter.subject	0..1	Reference	The patient or group present at the encounter.
Encounter.episodeOfCare	0..*	Reference	Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).
Encounter.basedOn	0..*	Reference	The request this encounter satisfies (e.g. incoming referral or procedure request).
Encounter.participant	0..*	BackboneElement	The list of people responsible for providing the service.
Encounter.participant.id	0..1	http://hl7.org/fhirpath/System.String	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Encounter.participant.extension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Encounter.participant.modifierExtension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Encounter.participant.type	0..*	CodeableConcept	Role of participant in encounter.
Encounter.participant.period	0..1	Period	The period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period.
Encounter.participant.individual	0..1	Reference	Persons involved in the encounter other than the patient.
Encounter.appointment	0..*	Reference	The appointment that scheduled this encounter.
Encounter.period	0..1	Period	The start and end time of the encounter.
Encounter.length	0..1	Duration	Quantity of time the encounter lasted. This excludes the time during leaves of absence.
Encounter.reasonCode	0..*	CodeableConcept	Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
Encounter.reasonReference	0..*	Reference	Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
Encounter.diagnosis	0..*	BackboneElement	The list of diagnosis relevant to this encounter.
Encounter.diagnosis.id	0..1	http://hl7.org/fhirpath/System.String	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Encounter.diagnosis.extension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Encounter.diagnosis.modifierExtension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Encounter.diagnosis.condition	1..1	Reference	Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
Encounter.diagnosis.use	0..1	CodeableConcept	Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …).
Encounter.diagnosis.rank	0..1	positiveInt	Ranking of the diagnosis (for each role type).
Encounter.account	0..*	Reference	The set of accounts that may be used for billing for this Encounter.
Encounter.hospitalization	0..1	BackboneElement	Details about the admission to a healthcare service.
Encounter.hospitalization.id	0..1	http://hl7.org/fhirpath/System.String	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Encounter.hospitalization.extension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Encounter.hospitalization.modifierExtension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Encounter.hospitalization.preAdmissionIdentifier	0..1	Identifier	Pre-admission identifier.
Encounter.hospitalization.origin	0..1	Reference	The location/organization from which the patient came before admission.
Encounter.hospitalization.admitSource	0..1	CodeableConcept	From where patient was admitted (physician referral, transfer).
Encounter.hospitalization.reAdmission	0..1	CodeableConcept	Whether this hospitalization is a readmission and why if known.
Encounter.hospitalization.dietPreference	0..*	CodeableConcept	Diet preferences reported by the patient.
Encounter.hospitalization.specialCourtesy	0..*	CodeableConcept	Special courtesies (VIP, board member).
Encounter.hospitalization.specialArrangement	0..*	CodeableConcept	Any special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things.
Encounter.hospitalization.destination	0..1	Reference	Location/organization to which the patient is discharged.
Encounter.hospitalization.dischargeDisposition	0..1	CodeableConcept	Category or kind of location after discharge.
Encounter.location	0..*	BackboneElement	List of locations where the patient has been during this encounter.
Encounter.location.id	0..1	http://hl7.org/fhirpath/System.String	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Encounter.location.extension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Encounter.location.modifierExtension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Encounter.location.location	1..1	Reference	The location where the encounter takes place.
Encounter.location.status	0..1	code	The status of the participants' presence at the specified location during the period specified. If the participant is no longer at the location, then the period will have an end date/time.
Encounter.location.physicalType	0..1	CodeableConcept	This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query.
Encounter.location.period	0..1	Period	Time period during which the patient was present at the location.
Encounter.serviceProvider	0..1	Reference	The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.
Encounter.partOf	0..1	Reference	Another Encounter of which this encounter is a part of (administratively or in time).

Search Parameters

Name	Type	Description	Expression
_text	string	Search on the narrative of the resource
_content	string	Search on the entire content of the resource
_id	token	Logical id of this artifact	Resource.id
_lastUpdated	date	When the resource version last changed	Resource.meta.lastUpdated
_profile	uri	Profiles this resource claims to conform to	Resource.meta.profile
_query	token	A custom search profile that describes a specific defined query operation
_security	token	Security Labels applied to this resource	Resource.meta.security
_source	uri	Identifies where the resource comes from	Resource.meta.source
_tag	token	Tags applied to this resource	Resource.meta.tag
date	date	Multiple Resources: * AllergyIntolerance: Date first version of the resource instance was recorded* CarePlan: Time period plan covers* CareTeam: Time period team covers* ClinicalImpression: When the assessment was documented* Composition: Composition editing time* Consent: When this Consent was created or indexed* DiagnosticReport: The clinically relevant time of the report* Encounter: A date within the period the Encounter lasted* EpisodeOfCare: The provided date search value falls within the episode of care's period* FamilyMemberHistory: When history was recorded or last updated* Flag: Time period when flag is active* Immunization: Vaccination (non)-Administration Date* List: When the list was prepared* Observation: Obtained date/time. If the obtained element is a period, a date that falls in the period* Procedure: When the procedure was performed* RiskAssessment: When was assessment made?* SupplyRequest: When the request was made	AllergyIntolerance.recordedDate / CarePlan.period / CareTeam.period / ClinicalImpression.date / Composition.date / Consent.dateTime / DiagnosticReport.effective / Encounter.period / EpisodeOfCare.period / FamilyMemberHistory.date / Flag.period / Immunization.occurrence / List.date / Observation.effective / Procedure.performed / (RiskAssessment.occurrence.ofType(dateTime)) / SupplyRequest.authoredOn
identifier	token	Multiple Resources: * AllergyIntolerance: External ids for this item* CarePlan: External Ids for this plan* CareTeam: External Ids for this team* Composition: Version-independent identifier for the Composition* Condition: A unique identifier of the condition record* Consent: Identifier for this record (external references)* DetectedIssue: Unique id for the detected issue* DeviceRequest: Business identifier for request/order* DiagnosticReport: An identifier for the report* DocumentManifest: Unique Identifier for the set of documents* DocumentReference: Master Version Specific Identifier* Encounter: Identifier(s) by which this encounter is known* EpisodeOfCare: Business Identifier(s) relevant for this EpisodeOfCare* FamilyMemberHistory: A search by a record identifier* Goal: External Ids for this goal* ImagingStudy: Identifiers for the Study, such as DICOM Study Instance UID and Accession number* Immunization: Business identifier* List: Business identifier* MedicationAdministration: Return administrations with this external identifier* MedicationDispense: Returns dispenses with this external identifier* MedicationRequest: Return prescriptions with this external identifier* MedicationStatement: Return statements with this external identifier* NutritionOrder: Return nutrition orders with this external identifier* Observation: The unique id for a particular observation* Procedure: A unique identifier for a procedure* RiskAssessment: Unique identifier for the assessment* ServiceRequest: Identifiers assigned to this order* SupplyDelivery: External identifier* SupplyRequest: Business Identifier for SupplyRequest* VisionPrescription: Return prescriptions with this external identifier	AllergyIntolerance.identifier / CarePlan.identifier / CareTeam.identifier / Composition.identifier / Condition.identifier / Consent.identifier / DetectedIssue.identifier / DeviceRequest.identifier / DiagnosticReport.identifier / DocumentManifest.masterIdentifier / DocumentManifest.identifier / DocumentReference.masterIdentifier / DocumentReference.identifier / Encounter.identifier / EpisodeOfCare.identifier / FamilyMemberHistory.identifier / Goal.identifier / ImagingStudy.identifier / Immunization.identifier / List.identifier / MedicationAdministration.identifier / MedicationDispense.identifier / MedicationRequest.identifier / MedicationStatement.identifier / NutritionOrder.identifier / Observation.identifier / Procedure.identifier / RiskAssessment.identifier / ServiceRequest.identifier / SupplyDelivery.identifier / SupplyRequest.identifier / VisionPrescription.identifier
patient	reference	Multiple Resources: * AllergyIntolerance: Who the sensitivity is for* CarePlan: Who the care plan is for* CareTeam: Who care team is for* ClinicalImpression: Patient or group assessed* Composition: Who and/or what the composition is about* Condition: Who has the condition?* Consent: Who the consent applies to* DetectedIssue: Associated patient* DeviceRequest: Individual the service is ordered for* DeviceUseStatement: Search by subject - a patient* DiagnosticReport: The subject of the report if a patient* DocumentManifest: The subject of the set of documents* DocumentReference: Who/what is the subject of the document* Encounter: The patient or group present at the encounter* EpisodeOfCare: The patient who is the focus of this episode of care* FamilyMemberHistory: The identity of a subject to list family member history items for* Flag: The identity of a subject to list flags for* Goal: Who this goal is intended for* ImagingStudy: Who the study is about* Immunization: The patient for the vaccination record* List: If all resources have the same subject* MedicationAdministration: The identity of a patient to list administrations for* MedicationDispense: The identity of a patient to list dispenses for* MedicationRequest: Returns prescriptions for a specific patient* MedicationStatement: Returns statements for a specific patient.* NutritionOrder: The identity of the person who requires the diet, formula or nutritional supplement* Observation: The subject that the observation is about (if patient)* Procedure: Search by subject - a patient* RiskAssessment: Who/what does assessment apply to?* ServiceRequest: Search by subject - a patient* SupplyDelivery: Patient for whom the item is supplied* VisionPrescription: The identity of a patient to list dispenses for	AllergyIntolerance.patient / CarePlan.subject.where(resolve() is Patient) / CareTeam.subject.where(resolve() is Patient) / ClinicalImpression.subject.where(resolve() is Patient) / Composition.subject.where(resolve() is Patient) / Condition.subject.where(resolve() is Patient) / Consent.patient / DetectedIssue.patient / DeviceRequest.subject.where(resolve() is Patient) / DeviceUseStatement.subject / DiagnosticReport.subject.where(resolve() is Patient) / DocumentManifest.subject.where(resolve() is Patient) / DocumentReference.subject.where(resolve() is Patient) / Encounter.subject.where(resolve() is Patient) / EpisodeOfCare.patient / FamilyMemberHistory.patient / Flag.subject.where(resolve() is Patient) / Goal.subject.where(resolve() is Patient) / ImagingStudy.subject.where(resolve() is Patient) / Immunization.patient / List.subject.where(resolve() is Patient) / MedicationAdministration.subject.where(resolve() is Patient) / MedicationDispense.subject.where(resolve() is Patient) / MedicationRequest.subject.where(resolve() is Patient) / MedicationStatement.subject.where(resolve() is Patient) / NutritionOrder.patient / Observation.subject.where(resolve() is Patient) / Procedure.subject.where(resolve() is Patient) / RiskAssessment.subject.where(resolve() is Patient) / ServiceRequest.subject.where(resolve() is Patient) / SupplyDelivery.patient / VisionPrescription.patient
type	token	Multiple Resources: * AllergyIntolerance: allergy / intolerance - Underlying mechanism (if known)* Composition: Kind of composition (LOINC if possible)* DocumentManifest: Kind of document set* DocumentReference: Kind of document (LOINC if possible)* Encounter: Specific type of encounter* EpisodeOfCare: Type/class - e.g. specialist referral, disease management	AllergyIntolerance.type / Composition.type / DocumentManifest.type / DocumentReference.type / Encounter.type / EpisodeOfCare.type
account	reference	The set of accounts that may be used for billing for this Encounter	Encounter.account
appointment	reference	The appointment that scheduled this encounter	Encounter.appointment
based-on	reference	The ServiceRequest that initiated this encounter	Encounter.basedOn
class	token	Classification of patient encounter	Encounter.class
diagnosis	reference	The diagnosis or procedure relevant to the encounter	Encounter.diagnosis.condition
episode-of-care	reference	Episode(s) of care that this encounter should be recorded against	Encounter.episodeOfCare
length	quantity	Length of encounter in days	Encounter.length
location	reference	Location the encounter takes place	Encounter.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
participant	reference	Persons involved in the encounter other than the patient	Encounter.participant.individual
participant-type	token	Role of participant in encounter	Encounter.participant.type
practitioner	reference	Persons involved in the encounter other than the patient	Encounter.participant.individual.where(resolve() is Practitioner)
reason-code	token	Coded reason the encounter takes place	Encounter.reasonCode
reason-reference	reference	Reason the encounter takes place (reference)	Encounter.reasonReference
service-provider	reference	The organization (facility) responsible for this encounter	Encounter.serviceProvider
special-arrangement	token	Wheelchair, translator, stretcher, etc.	Encounter.hospitalization.specialArrangement
status	token	planned / arrived / triaged / in-progress / onleave / finished / cancelled +	Encounter.status
subject	reference	The patient or group present at the encounter	Encounter.subject
_iguhealth-version-seq	number	The version sequence of the resource	Resource.meta.extension.where(url='https://iguhealth.app/version-sequence').value
_iguhealth-author	reference	The author of the resource	Resource.meta.extension.where(url='https://iguhealth.app/author').value