Generated Narrative: StructureDefinition hr-encounter Name Flags Card. Type Description & Constraints Encounter 0..* Encounter An interaction during which services are provided to the patient Slices for extension 1..* Extension Extension Slice: Unordered, Open by value:url extension:tenant S 1..1 Identifier Owning site tenant URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-tenant identifier S 0..* Identifier Identifier(s) by which this encounter is known status S 1..1 code planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown class S 1..* CodeableConcept Classification of patient encounter context - e.g. Inpatient, outpatient subject S 1..1 Reference(Healthy Route Patient) The patient or group related to this encounter subjectStatus S 0..1 CodeableConcept The current status of the subject in relation to the Encounter serviceProvider S 1..1 Reference(Healthy Route Organization) The organization (facility) responsible for this encounter participant S 0..* BackboneElement Study team members present actor 0..1 Reference(Healthy Route Practitioner | Healthy Route Patient) The individual, device, or service participating in the encounter actualPeriod S 1..1 Period When the visit happened location S 0..* BackboneElement List of locations where the patient has been location 1..1 Reference(Healthy Route Location) Location the encounter takes place Documentation for this format
The single visit at which a participant is screened, measured and photographed.
Groups everything collected from one participant on one occasion, and records where it happened. The clinic a participant was seen in is a source of spectrum variation that has to survive to analysis, and it is a property of the visit rather than of the participant.
An interaction during which services are provided to the patient
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.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
Entity, Role, or Act,PatientEncounter[@moodCode='EVN']
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
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.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
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.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Text summary of the resource, for human interpretation
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.
Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.
Must have either extensions or value[x], not both
Identifies the site tenant that owns the resource.
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 managable, 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).
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Identifier(s) by which this encounter is known
Identifier(s) by which this encounter is known.
planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
The current state of the encounter (not the state of the patient within the encounter - that is subjectState).
Note that internal business rules will determine the appropriate transitions that may occur between statuses (and also classes).
This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
No clear equivalent in HL7 V2; active/finished could be inferred from PV1-44, PV1-45, PV2-24; inactive could be inferred from PV2-16
Classification of patient encounter context - e.g. Inpatient, outpatient
Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
R5 changed this from a single Coding to a repeating CodeableConcept. Ambulatory for every visit in this study; there is no admission and no follow-up contact.
Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...)
Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
Since there are many ways to further classify encounters, this element is 0..*.
A specific code indicating type of service provided
Broad categorization of the service that is to be provided (e.g. cardiology).
Broad categorization of the service that is to be provided.
The patient or group related to this encounter
The patient or group related to this encounter. In some use-cases the patient MAY not be present, such as a case meeting about a patient between several practitioners or a careteam.
While the encounter is always about the patient, the patient might not actually be known in all contexts of use, and there may be a group of patients that could be anonymous (such as in a group therapy for Alcoholics Anonymous - where the recording of the encounter could be used for billing on the number of people/staff and not important to the context of the specific patients) or alternately in veterinary care a herd of sheep receiving treatment (where the animals are not individually tracked).
The current status of the subject in relation to the Encounter
The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status.
There is no link from Encounter to ResearchSubject in R5. A visit is tied to the study through its subject, which resolves to the participant and from there to their enrolment.
Current status of the subject within the encounter.
Episode(s) of care that this encounter should be recorded against
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).
The request that initiated this encounter
The request this encounter satisfies (e.g. incoming referral or procedure request).
The group(s) that are allocated to participate in this encounter
The group(s) of individuals, organizations that are allocated to participate in this encounter. The participants backbone will record the actuals of when these individuals participated during the encounter.
Another Encounter this encounter is part of
Another Encounter of which this encounter is a part of (administratively or in time).
This is also used for associating a child's encounter back to the mother's encounter. Refer to the Notes section in the Patient resource for further details.
.inboundRelationship[typeCode=COMP].source[classCode=COMP, moodCode=EVN]
The organization (facility) responsible for this encounter
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 colonoscopy example on the Encounter examples tab.
The list of people responsible for providing the service.
Any Patient or Group present in the participation.actor must also be the subject, though the subject may be absent from the participation.actor for cases where the patient (or group) is not present, such as during a case review conference.
A type must be provided when no explicit actor is specified
A type cannot be provided for a patient or group participant
actor.exists(resolve() is Patient or resolve() is Group) implies type.exists().not()
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Additional content defined by implementations
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 managable, 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.
Extensions that cannot be ignored even if unrecognized
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 managable, 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).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
The participant type indicates how an individual actor participates in an encounter. It includes non-practitioner participants, and for practitioners this is to describe the action type in the context of this encounter (e.g. Admitting Dr, Attending Dr, Translator, Consulting Dr). This is different to the practitioner roles which are functional roles, derived from terms of employment, education, licensing, etc.
Period of time during the encounter that the participant participated
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.
The individual, device, or service participating in the encounter
Person involved in the encounter, the patient/group is also included here to indicate that the patient was actually participating in the encounter. Not including the patient here covers use cases such as a case meeting between practitioners about a patient - non contact times.
For planning purposes, Appointments may include a CareTeam participant to indicate that one specific person from the CareTeam will be assigned, but that assignment might not happen until the Encounter begins. Hence CareTeam is not included in Encounter.participant, as the specific individual should be assigned and represented as a Practitioner or other person resource. Similarly, Location can be included in Appointment.participant to assist with planning. However, the patient location is tracked on the Encounter in the Encounter.location property to allow for additional metadata and history to be recorded. The role of the participant can be used to declare what the actor will be doing in the scope of this encounter participation. If the individual is not specified during planning, then it is expected that the individual will be filled in at a later stage prior to the encounter commencing.
The appointment that scheduled this encounter
The appointment that scheduled this encounter.
.outboundRelationship[typeCode=FLFS].target[classCode=ENC, moodCode=APT]
Connection details of a virtual service (e.g. conference call)
Connection details of a virtual service (e.g. conference call).
There are two types of virtual meetings that often exist: * a persistent, virtual meeting room that can only be used for a single purpose at a time, * and a dynamic virtual meeting room that is generated on demand for a specific purpose. Implementers may consider using Location.virtualService for persistent meeting rooms. If each participant would have a different meeting link, an extension using the VirtualServiceContactDetail can be applied to the Encounter.participant BackboneElement.
The actual start and end time of the encounter.
Named period in R4. Required here because it is what a consent date is compared against: a visit preceding the date on the signed form is a protocol deviation, and the comparison needs both dates recorded rather than one inferred.
The planned start date/time (or admission date) of the encounter
The planned start date/time (or admission date) of the encounter.
The planned end date/time (or discharge date) of the encounter
The planned end date/time (or discharge date) of the encounter.
Actual quantity of time the encounter lasted (less time absent)
Actual quantity of time the encounter lasted. This excludes the time during leaves of absence. When missing it is the time in between the start and end values.
If the precision on these values is low (e.g. to the day only) then this may be considered was an all day (or multi-day) encounter, unless the duration is included, where that amount of time occurred sometime during the interval. May differ from the time in `Encounter.period` due to leave of absence(s).
(PV1-45 less PV1-44) iff ( (PV1-44 not empty) and (PV1-45 not empty) ); units in minutes or PV2-11 (which is actual length in days)
The list of medical reasons that are expected to be addressed during the episode of care
The list of medical reasons that are expected to be addressed during the episode of care.
The reason communicates what medical problem the patient has that should be addressed during the episode of care. This reason could be patient reported complaint, a clinical indication that was determined in a previous encounter or episode of care, or some planned care such as an immunization recommendation. In the case where you have a primary reason, but are expecting to also address other problems, you can list the primary reason with a use code of 'Chief Complaint', while the other problems being addressed would have a use code of 'Reason for Visit'. Examples: * pregnancy would use HealthcareService or a coding as the reason * patient home monitoring could use Condition as the reason
What the reason value should be used for/as
What the reason value should be used as e.g. Chief Complaint, Health Concern, Health Maintenance (including screening).
Reason the encounter takes place (core or reference)
Reason the encounter takes place, expressed as a code or a reference to another resource. For admissions, this can be used for a coded admission diagnosis.
EVN-4 / PV2-3 (note: PV2-3 is nominally constrained to inpatient admissions; HL7 V2 makes no vocabulary suggestions for PV2-3; would not expect PV2 segment or PV2-3 to be in use in all implementations )
The list of diagnosis relevant to this encounter
The list of diagnosis relevant to this encounter.
Also note that for the purpose of billing, the diagnoses are recorded in the account where they can be ranked appropriately for how the invoicing/claiming documentation needs to be prepared.
The coded diagnosis or a reference to a Condition (with other resources referenced in the evidence.detail), the use property will indicate the purpose of this specific diagnosis.
Resources that would commonly referenced at Encounter.indication would be Condition and/or Procedure. These most closely align with DG1/PRB and PR1 respectively.
Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …).
The type of diagnosis this condition represents.
The set of accounts that may be used for billing for this Encounter
The set of accounts that may be used for billing for this Encounter.
The billing system may choose to allocate billable items associated with the Encounter to different referenced Accounts based on internal business rules.
Diet preferences reported by the patient
Diet preferences reported by the patient.
For example, a patient may request both a dairy-free and nut-free diet preference (not mutually exclusive).
Used to track patient's diet restrictions and/or preference. For a complete description of the nutrition needs of a patient during their stay, one should use the nutritionOrder resource which links to Encounter.
Medical, cultural or ethical food preferences to help with catering requirements.
.outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=EVN, code="diet"]
Any special requests that have been made for this encounter, such as the provision of specific equipment or other things.
Special courtesies that may be provided to the patient during the encounter (VIP, board member, professional courtesy).
Although the specialCourtesy property can contain values like VIP, the purpose of this field is intended to be used for flagging additional `benefits` that might occur for the patient during the encounter. It could include things like the patient is to have a private room, special room features, receive a friendly visit from hospital adminisitration, or should be briefed on treatment by senior staff during the stay. It is not specifically intended to be used for securing the specific record - that is the purpose of the security meta tag, and where appropriate, both fields could be used.
Details about the admission to a healthcare service
Details about the stay during which a healthcare service is provided. This does not describe the event of admitting the patient, but rather any information that is relevant from the time of admittance until the time of discharge.
An Encounter may cover more than just the inpatient stay. Contexts such as outpatients, community clinics, and aged care facilities are also included. The duration recorded in the period of this encounter covers the entire scope of this admission record.
.outboundRelationship[typeCode=COMP].target[classCode=ENC, moodCode=EVN]
The location/organization from which the patient came before admission
The location/organization from which the patient came before admission.
From where patient was admitted (physician referral, transfer)
From where patient was admitted (physician referral, transfer).
Indicates that the patient is being re-admitted
Indicates that this encounter is directly related to a prior admission, often because the conditions addressed in the prior admission were not fully addressed.
The reason for re-admission of this admission encounter.
Location/organization to which the patient is discharged
Location/organization to which the patient is discharged.
Category or kind of location after discharge
Category or kind of location after discharge.
List of locations where the patient has been
List of locations where the patient has been during this encounter.
Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type "kind" such as "client's home" and an encounter.class = "virtual".
The location where the encounter takes place.
Both protocols recruit from the general out-patient, hypertension, diabetes and renal clinics of their sites. Disease prevalence differs between those clinics, and predictive values move with prevalence, so which one a participant was seen in is an analysis variable rather than an operational detail.
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.
When the patient is no longer active at a location, then the period end date is entered, and the status may be changed to completed.
The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.)
This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query.
This information is de-normalized from the Location resource to support the easier understanding of the encounter resource and processing in messaging or query. There may be many levels in the hierachy, and this may only pic specific levels that are required for a specific usage scenario.
Time period during which the patient was present at the location
Time period during which the patient was present at the location.