EncounterProfile
⚠️ This is an introduction of our profile EncounterProfile, this profile is for visit patient
Metadata
These are the details for this resource:
Resource content
These are different views on this resource:
EncounterProfile (Encounter) | I | Encounter | |
id | Σ | 0..1 | id |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | I | 0..1 | Narrative |
contained | I | 0..* | Resource |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
identifier | Σ I | 0..* | Identifier |
status | Σ ?! | 1..1 | codeBinding |
class | Σ | 1..1 | CodeableConceptBinding |
priority | 0..0 | CodeableConcept | |
type | Σ | 0..* | CodeableConcept |
serviceType | Σ | 0..0 | CodeableReference(HealthcareService) |
subject | Σ I | 0..1 | Reference(Patient | Group) |
subjectStatus | 0..1 | CodeableConcept | |
episodeOfCare | Σ I | 0..0 | Reference(EpisodeOfCare) |
basedOn | I | 0..* | Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest) |
careTeam | I | 0..* | Reference(CareTeam) |
partOf | I | 0..0 | Reference(Encounter) |
serviceProvider | I | 0..1 | Reference(Organization) |
participant | Σ I | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
type | Σ I | 0..* | CodeableConceptBinding |
period | I | 0..1 | Period |
actor | Σ I | 0..1 | Reference(CFBPractitioner) |
appointment | Σ I | 0..* | Reference(Appointment) |
virtualService | 0..0 | VirtualServiceDetail | |
actualPeriod | I | 0..1 | Period |
plannedStartDate | 0..1 | dateTime | |
plannedEndDate | 0..1 | dateTime | |
length | I | 0..0 | Duration |
reason | Σ | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
use | Σ | 0..* | CodeableConcept |
value | Σ | 0..* | CodeableReference(Condition | DiagnosticReport | Observation | ImmunizationRecommendation | Procedure)Binding |
diagnosis | Σ | 0..0 | BackboneElement |
account | I | 0..* | Reference(Account) |
dietPreference | 0..0 | CodeableConcept | |
specialArrangement | 0..0 | CodeableConceptBinding | |
specialCourtesy | 0..0 | CodeableConceptBinding | |
admission | 0..1 | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
preAdmissionIdentifier | I | 0..1 | Identifier |
origin | I | 0..1 | Reference(Location | Organization) |
admitSource | 0..1 | CodeableConceptBinding | |
reAdmission | 1..1 | CodeableConcept | |
destination | I | 0..1 | Reference(Location | Organization) |
dischargeDisposition | 0..1 | CodeableConcept | |
location | 1..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
location | I | 1..1 | Reference(Location) |
status | 0..1 | codeBinding | |
form | 0..1 | CodeableConcept | |
period | I | 0..1 | Period |
Encounter | |
Definition | 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. |
Cardinality | 0...* |
Alias | Visit |
Invariants |
|
Mappings |
|
Encounter.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | id |
Summary | True |
Comments | 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. |
Encounter.meta | |
Definition | 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. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
Encounter.implicitRules | |
Definition | 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. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
Encounter.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | IETF language tag for a human language |
Comments | 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). |
Invariants |
|
Mappings |
|
Encounter.text | |
Definition | 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. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | 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. |
Invariants |
|
Mappings |
|
Encounter.contained | |
Definition | 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. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | 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. |
Mappings |
|
Encounter.extension | |
Definition | 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 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Encounter.modifierExtension | |
Definition | 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content |
Requirements | 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. |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Encounter.identifier | |
Definition | Identifier(s) by which this encounter is known. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Comments | The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension. |
Invariants |
|
Mappings |
|
Encounter.status | |
Definition | The current state of the encounter (not the state of the patient within the encounter - that is subjectState). |
Cardinality | 1...1 |
Type | code |
Binding | Current state of the encounter. |
Modifier | True |
Summary | True |
Comments | Note that internal business rules will determine the appropriate transitions that may occur between statuses (and also classes). |
Invariants |
|
Mappings |
|
Encounter.class | |
Definition | Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Classification of the encounter. |
Summary | True |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Encounter.priority | |
Definition | Indicates the urgency of the encounter. |
Cardinality | 0...0 |
Type | CodeableConcept |
Binding | Indicates the urgency of the encounter. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Encounter.type | |
Definition | Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation). |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | A specific code indicating type of service provided |
Summary | True |
Comments | Since there are many ways to further classify encounters, this element is 0..*. |
Invariants |
|
Mappings |
|
Encounter.serviceType | |
Definition | Broad categorization of the service that is to be provided (e.g. cardiology). |
Cardinality | 0...0 |
Type | CodeableReference(HealthcareService) |
Binding | Broad categorization of the service that is to be provided. |
Summary | True |
Invariants |
|
Mappings |
|
Encounter.subject | |
Definition | 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. |
Cardinality | 0...1 |
Type | Reference(Patient | Group) |
Summary | True |
Alias | patient |
Comments | 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). |
Invariants |
|
Mappings |
|
Encounter.subjectStatus | |
Definition | 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. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Current status of the subject within the encounter. |
Comments | Different use-cases are likely to have different permitted transitions between states, such as an Emergency department could use |
Invariants |
|
Mappings |
|
Encounter.episodeOfCare | |
Definition | 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). |
Cardinality | 0...0 |
Type | Reference(EpisodeOfCare) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Encounter.basedOn | |
Definition | The request this encounter satisfies (e.g. incoming referral or procedure request). |
Cardinality | 0...* |
Type | Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest) |
Alias | incomingReferral |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Encounter.careTeam | |
Definition | 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. |
Cardinality | 0...* |
Type | Reference(CareTeam) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Encounter.partOf | |
Definition | Another Encounter of which this encounter is a part of (administratively or in time). |
Cardinality | 0...0 |
Type | Reference(Encounter) |
Comments | 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. |
Invariants |
|
Mappings |
|
Encounter.serviceProvider | |
Definition | 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. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Encounter.participant | |
Definition | The list of people responsible for providing the service. |
Cardinality | 0...* |
Type | BackboneElement |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
Encounter.participant.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Encounter.participant.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Encounter.participant.modifierExtension | |
Definition | 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
Encounter.participant.type | |
Definition | Role of participant in encounter. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Role of participant in encounter. |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
Encounter.participant.period | |
Definition | 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. |
Cardinality | 0...1 |
Type | Period |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Mappings |
|
Encounter.participant.actor | |
Definition | 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. |
Cardinality | 0...1 |
Type | Reference(CFBPractitioner) |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
Encounter.appointment | |
Definition | The appointment that scheduled this encounter. |
Cardinality | 0...* |
Type | Reference(Appointment) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Encounter.virtualService | |
Definition | Connection details of a virtual service (e.g. conference call). |
Cardinality | 0...0 |
Type | VirtualServiceDetail |
Comments | There are two types of virtual meetings that often exist:
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. |
Invariants |
|
Mappings |
|
Encounter.actualPeriod | |
Definition | The actual start and end time of the encounter. |
Cardinality | 0...1 |
Type | Period |
Comments | If not (yet) known, the end of the Period may be omitted. |
Invariants |
|
Mappings |
|
Encounter.plannedStartDate | |
Definition | The planned start date/time (or admission date) of the encounter. |
Cardinality | 0...1 |
Type | dateTime |
Comments | UTC offset is allowed for dates and partial dates |
Invariants |
|
Mappings |
|
Encounter.plannedEndDate | |
Definition | The planned end date/time (or discharge date) of the encounter. |
Cardinality | 0...1 |
Type | dateTime |
Comments | UTC offset is allowed for dates and partial dates |
Invariants |
|
Mappings |
|
Encounter.length | |
Definition | 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. |
Cardinality | 0...0 |
Type | Duration |
Comments | 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 |
Invariants |
|
Mappings |
|
Encounter.reason | |
Definition | The list of medical reasons that are expected to be addressed during the episode of care. |
Cardinality | 0...* |
Type | BackboneElement |
Summary | True |
Comments | 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:
|
Invariants |
|
Mappings |
|
Encounter.reason.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Encounter.reason.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Encounter.reason.modifierExtension | |
Definition | 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
Encounter.reason.use | |
Definition | What the reason value should be used as e.g. Chief Complaint, Health Concern, Health Maintenance (including screening). |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | EncounterReasonUse (example) |
Summary | True |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Encounter.reason.value | |
Definition | 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. |
Cardinality | 0...* |
Type | CodeableReference(Condition | DiagnosticReport | Observation | ImmunizationRecommendation | Procedure) |
Binding | Reason why the encounter takes place. |
Summary | True |
Alias | Indication, Admission diagnosis |
Invariants |
|
Mappings |
|
Encounter.diagnosis | |
Definition | The list of diagnosis relevant to this encounter. |
Cardinality | 0...0 |
Type | BackboneElement |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
Encounter.diagnosis.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Encounter.diagnosis.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Encounter.diagnosis.modifierExtension | |
Definition | 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
Encounter.diagnosis.condition | |
Definition | 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. |
Cardinality | 0...* |
Type | CodeableReference(Condition) |
Binding | ConditionProblemDiagnosisCodes (example) |
Summary | True |
Alias | Admission diagnosis, discharge diagnosis, indication |
Invariants |
|
Mappings |
|
Encounter.diagnosis.use | |
Definition | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …). |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The type of diagnosis this condition represents. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Encounter.account | |
Definition | The set of accounts that may be used for billing for this Encounter. |
Cardinality | 0...* |
Type | Reference(Account) |
Comments | The billing system may choose to allocate billable items associated with the Encounter to different referenced Accounts based on internal business rules. |
Invariants |
|
Mappings |
|
Encounter.dietPreference | |
Definition | Diet preferences reported by the patient. |
Cardinality | 0...0 |
Type | CodeableConcept |
Binding | Medical, cultural or ethical food preferences to help with catering requirements. |
Requirements | 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. |
Comments | For example, a patient may request both a dairy-free and nut-free diet preference (not mutually exclusive). |
Invariants |
|
Mappings |
|
Encounter.specialArrangement | |
Definition | Any special requests that have been made for this encounter, such as the provision of specific equipment or other things. |
Cardinality | 0...0 |
Type | CodeableConcept |
Binding | Special arrangements. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Encounter.specialCourtesy | |
Definition | Special courtesies that may be provided to the patient during the encounter (VIP, board member, professional courtesy). |
Cardinality | 0...0 |
Type | CodeableConcept |
Binding | Special courtesies. |
Comments | Although the specialCourtesy property can contain values like VIP, the purpose of this field is intended to be used for flagging additional 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. |
Invariants |
|
Mappings |
|
Encounter.admission | |
Definition | 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. |
Cardinality | 0...1 |
Type | BackboneElement |
Comments | 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. |
Invariants |
|
Mappings |
|
Encounter.admission.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Encounter.admission.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Encounter.admission.modifierExtension | |
Definition | 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
Encounter.admission.preAdmissionIdentifier | |
Definition | Pre-admission identifier. |
Cardinality | 0...1 |
Type | Identifier |
Comments | The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension. |
Invariants |
|
Mappings |
|
Encounter.admission.origin | |
Definition | The location/organization from which the patient came before admission. |
Cardinality | 0...1 |
Type | Reference(Location | Organization) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Encounter.admission.admitSource | |
Definition | From where patient was admitted (physician referral, transfer). |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | From where the patient was admitted. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Encounter.admission.reAdmission | |
Definition | Indicates that this encounter is directly related to a prior admission, often because the conditions addressed in the prior admission were not fully addressed. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | The reason for re-admission of this admission encounter. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Encounter.admission.destination | |
Definition | Location/organization to which the patient is discharged. |
Cardinality | 0...1 |
Type | Reference(Location | Organization) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Encounter.admission.dischargeDisposition | |
Definition | Category or kind of location after discharge. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Discharge Disposition. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Encounter.location | |
Definition | List of locations where the patient has been during this encounter. |
Cardinality | 1...* |
Type | BackboneElement |
Comments | 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". |
Invariants |
|
Mappings |
|
Encounter.location.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Encounter.location.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Encounter.location.modifierExtension | |
Definition | 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
Encounter.location.location | |
Definition | The location where the encounter takes place. |
Cardinality | 1...1 |
Type | Reference(Location) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Encounter.location.status | |
Definition | 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. |
Cardinality | 0...1 |
Type | code |
Binding | The status of the location. |
Comments | 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. |
Invariants |
|
Mappings |
|
Encounter.location.form | |
Definition | This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Physical form of the location. |
Comments | 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. |
Invariants |
|
Mappings |
|
Encounter.location.period | |
Definition | Time period during which the patient was present at the location. |
Cardinality | 0...1 |
Type | Period |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <url value="https://luxith-etab.org/fhir/StructureDefinition/lu/EncounterProfile" /> <name value="EncounterProfile" /> <status value="draft" /> <fhirVersion value="5.0.0" /> <kind value="resource" /> <abstract value="false" /> <type value="Encounter" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Encounter" /> <derivation value="constraint" /> <differential> <element id="Encounter.class"> <path value="Encounter.class" /> <min value="1" /> <max value="1" /> </element> <element id="Encounter.priority"> <path value="Encounter.priority" /> <max value="0" /> </element> <element id="Encounter.serviceType"> <path value="Encounter.serviceType" /> <max value="0" /> </element> <element id="Encounter.episodeOfCare"> <path value="Encounter.episodeOfCare" /> <max value="0" /> </element> <element id="Encounter.partOf"> <path value="Encounter.partOf" /> <max value="0" /> </element> <element id="Encounter.participant.actor"> <path value="Encounter.participant.actor" /> <type> <code value="Reference" /> <targetProfile value="https://luxith-etab.org/fhir/StructureDefinition/lu/CFBPractitioner" /> </type> </element> <element id="Encounter.virtualService"> <path value="Encounter.virtualService" /> <max value="0" /> </element> <element id="Encounter.length"> <path value="Encounter.length" /> <max value="0" /> </element> <element id="Encounter.diagnosis"> <path value="Encounter.diagnosis" /> <max value="0" /> </element> <element id="Encounter.dietPreference"> <path value="Encounter.dietPreference" /> <max value="0" /> </element> <element id="Encounter.specialArrangement"> <path value="Encounter.specialArrangement" /> <max value="0" /> </element> <element id="Encounter.specialCourtesy"> <path value="Encounter.specialCourtesy" /> <max value="0" /> </element> <element id="Encounter.admission.reAdmission"> <path value="Encounter.admission.reAdmission" /> <min value="1" /> </element> <element id="Encounter.location"> <path value="Encounter.location" /> <min value="1" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "url": "https://luxith-etab.org/fhir/StructureDefinition/lu/EncounterProfile", "name": "EncounterProfile", "status": "draft", "fhirVersion": "5.0.0", "kind": "resource", "abstract": false, "type": "Encounter", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Encounter", "derivation": "constraint", "differential": { "element": [ { "id": "Encounter.class", "path": "Encounter.class", "min": 1, "max": "1" }, { "id": "Encounter.priority", "path": "Encounter.priority", "max": "0" }, { "id": "Encounter.serviceType", "path": "Encounter.serviceType", "max": "0" }, { "id": "Encounter.episodeOfCare", "path": "Encounter.episodeOfCare", "max": "0" }, { "id": "Encounter.partOf", "path": "Encounter.partOf", "max": "0" }, { "id": "Encounter.participant.actor", "path": "Encounter.participant.actor", "type": [ { "code": "Reference", "targetProfile": [ "https://luxith-etab.org/fhir/StructureDefinition/lu/CFBPractitioner" ] } ] }, { "id": "Encounter.virtualService", "path": "Encounter.virtualService", "max": "0" }, { "id": "Encounter.length", "path": "Encounter.length", "max": "0" }, { "id": "Encounter.diagnosis", "path": "Encounter.diagnosis", "max": "0" }, { "id": "Encounter.dietPreference", "path": "Encounter.dietPreference", "max": "0" }, { "id": "Encounter.specialArrangement", "path": "Encounter.specialArrangement", "max": "0" }, { "id": "Encounter.specialCourtesy", "path": "Encounter.specialCourtesy", "max": "0" }, { "id": "Encounter.admission.reAdmission", "path": "Encounter.admission.reAdmission", "min": 1 }, { "id": "Encounter.location", "path": "Encounter.location", "min": 1 } ] } }