UKCoreEncounter (Encounter) | C | | Encounter | There are no (further) constraints on this element Element idEncounter Short descriptionAn interaction during which services are provided to the patient Alternate namesVisit DefinitionAn interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
Data typeEncounter Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty() - dom-3: 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-4: 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() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() - dom-6: A resource should have narrative for robust management
text.`div`.exists() Mappings- rim: Entity. Role, or Act
- workflow: Event
- rim: Encounter[@moodCode='EVN']
|
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idEncounter.id Short descriptionLogical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
CommentsThe only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Data typestring |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idEncounter.meta Short descriptionMetadata about the resource DefinitionThe 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.
Data typeMeta Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idEncounter.implicitRules Short descriptionA set of rules under which this content was created DefinitionA 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.
CommentsAsserting 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 it's narrative along with other profiles, value sets, etc.
Data typeuri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idEncounter.language Short descriptionLanguage of the resource content DefinitionThe base language in which the resource is written.
CommentsLanguage 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).
Data typecode BindingCommonLanguages (preferred) Binding extensionsConstraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
text | | 0..1 | Narrative | There are no (further) constraints on this element Element idEncounter.text Short descriptionText summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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.
CommentsContained resources do not have 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.
Data typeNarrative Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
contained | | 0..* | Resource | There are no (further) constraints on this element Element idEncounter.contained Short descriptionContained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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.
CommentsThis 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.
Data typeResource Mappings |
extension | C | 0..* | Extension | Element idEncounter.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
dischargeMethod | C | 0..1 | Extension(CodeableConcept) | Element idEncounter.extension:dischargeMethod Short descriptionAn extension to support the method of discharge from a hospital. Alternate namesextensions, user content DefinitionThis extension has been developed to demonstrate the representation of the method by which a patient was discharged from hospital.
CommentsThere 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.
Data typeExtension(CodeableConcept) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DischargeMethod ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
emergencyCareDischargeStatus | C | 0..1 | Extension(CodeableConcept) | Element idEncounter.extension:emergencyCareDischargeStatus Short descriptionAn extension to support the status of an individual on discharge from an Emergency Care Department. Alternate namesextensions, user content DefinitionThis extension has been developed to demonstrate the representation of the status of a patient on discharge from an Emergency Care Department.
CommentsThere 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.
Data typeExtension(CodeableConcept) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EmergencyCareDischargeStatus ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
legalStatus | C | 0..* | Extension(Complex) | Element idEncounter.extension:legalStatus Short descriptionInformation relating to a patient's legal status on admission or discharge. Alternate namesextensions, user content DefinitionInformation relating to a patient's legal status on admission or discharge.
CommentsThere 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.
Data typeExtension(Complex) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-LegalStatus ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
OutcomeOfAttendance | C | 0..1 | Extension(CodeableConcept) | Element idEncounter.extension:OutcomeOfAttendance Short descriptionAn extension to support the outcome of an Outpatient attendance. Alternate namesextensions, user content DefinitionThis extension has been developed to demonstrate the representation of the outcome of an Outpatient attendance.
CommentsThere 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.
Data typeExtension(CodeableConcept) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OutcomeOfAttendance ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.modifierExtension Short descriptionExtensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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).
RequirementsModifier 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.
CommentsThere 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.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
identifier | S Σ | 0..* | Identifier | There are no (further) constraints on this element Element idEncounter.identifier Short descriptionIdentifier(s) by which this encounter is known DefinitionIdentifier(s) by which this encounter is known.
Data typeIdentifier Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Event.identifier
- w5: FiveWs.identifier
- v2: PV1-19
- rim: .id
|
status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idEncounter.status Short descriptionplanned | arrived | triaged | in-progress | onleave | finished | cancelled + Definitionplanned | arrived | triaged | in-progress | onleave | finished | cancelled +.
CommentsNote that internal business rules will determine the appropriate transitions that may occur between statuses (and also classes).
Data typecode BindingCurrent state of the encounter.
EncounterStatus (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Event.status
- w5: FiveWs.status
- v2: 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
- rim: .statusCode
|
statusHistory | | 0..* | BackboneElement | There are no (further) constraints on this element Element idEncounter.statusHistory Short descriptionList of past encounter statuses DefinitionThe 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.
CommentsThe current status is always found in the current version of the resource, not the status history.
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
id | | 0..1 | string | There are no (further) constraints on this element Element idEncounter.statusHistory.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.statusHistory.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.statusHistory.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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).
RequirementsModifier 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.
CommentsThere 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.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
status | | 1..1 | codeBinding | There are no (further) constraints on this element Element idEncounter.statusHistory.status Short descriptionplanned | arrived | triaged | in-progress | onleave | finished | cancelled + Definitionplanned | arrived | triaged | in-progress | onleave | finished | cancelled +.
Data typecode BindingCurrent state of the encounter.
EncounterStatus (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
period | | 1..1 | Period | There are no (further) constraints on this element Element idEncounter.statusHistory.period Short descriptionThe time that the episode was in the specified status DefinitionThe time that the episode was in the specified status.
Data typePeriod Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
class | S Σ | 1..1 | CodingBinding | There are no (further) constraints on this element Element idEncounter.class Short descriptionClassification of patient encounter DefinitionConcepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
Data typeCoding BindingClassification of the encounter.
v3.ActEncounterCode (extensible) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.class
- v2: PV1-2
- rim: .inboundRelationship[typeCode=SUBJ].source[classCode=LIST].code
|
classHistory | | 0..* | BackboneElement | There are no (further) constraints on this element Element idEncounter.classHistory Short descriptionList of past encounter classes DefinitionThe 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.
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
id | | 0..1 | string | There are no (further) constraints on this element Element idEncounter.classHistory.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.classHistory.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.classHistory.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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).
RequirementsModifier 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.
CommentsThere 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.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
class | | 1..1 | CodingBinding | There are no (further) constraints on this element Element idEncounter.classHistory.class Short descriptioninpatient | outpatient | ambulatory | emergency + Definitioninpatient | outpatient | ambulatory | emergency +.
Data typeCoding BindingClassification of the encounter.
v3.ActEncounterCode (extensible) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
period | | 1..1 | Period | There are no (further) constraints on this element Element idEncounter.classHistory.period Short descriptionThe time that the episode was in the specified class DefinitionThe time that the episode was in the specified class.
Data typePeriod Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
type | Σ | 0..* | CodeableConceptBinding | Element idEncounter.type Short descriptionSpecific type of encounter DefinitionSpecific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
CommentsSince there are many ways to further classify encounters, this element is 0..*.
Data typeCodeableConcept BindingA code from the SNOMED Clinical Terminology UK coding system that describes an encounter between a care professional and the patient (or patient's record).
UKCoreEncounterType (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Event.code
- w5: FiveWs.class
- v2: PV1-4 / PV1-18
- rim: .code
|
serviceType | Σ | 0..1 | CodeableConceptBinding | Element idEncounter.serviceType Short descriptionSpecific type of service DefinitionBroad categorization of the service that is to be provided (e.g. cardiology).
Data typeCodeableConcept BindingAny code from the SNOMED CT UK Refset with fully specified name 'Services simple reference set (foundation metadata concept)' with Refset Id 1127531000000102.
UKCoreCareSettingType (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Event.code
- v2: PV1-10
- rim: n/a
|
priority | | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idEncounter.priority Short descriptionIndicates the urgency of the encounter DefinitionIndicates the urgency of the encounter.
Data typeCodeableConcept BindingIndicates the urgency of the encounter.
v3.ActPriority (example) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.grade
- v2: PV2-25
- rim: .priorityCode
|
subject | S Σ | 0..1 | Reference(Patient | Group) | There are no (further) constraints on this element Element idEncounter.subject Short descriptionThe patient or group present at the encounter Alternate namespatient DefinitionThe patient or group present at the encounter.
CommentsWhile 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).
Data typeReference(Patient | Group) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Event.subject
- w5: FiveWs.subject[x]
- v2: PID-3
- rim: .participation[typeCode=SBJ]/role[classCode=PAT]
- w5: FiveWs.subject
|
episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | There are no (further) constraints on this element Element idEncounter.episodeOfCare Short descriptionEpisode(s) of care that this encounter should be recorded against DefinitionWhere 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).
Data typeReference(EpisodeOfCare) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Event.context
- w5: FiveWs.context
- v2: PV1-54, PV1-53
- rim: n/a
|
basedOn | | 0..* | Reference(ServiceRequest) | There are no (further) constraints on this element Element idEncounter.basedOn Short descriptionThe ServiceRequest that initiated this encounter Alternate namesincomingReferral DefinitionThe request this encounter satisfies (e.g. incoming referral or procedure request).
Data typeReference(ServiceRequest) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Event.basedOn
- rim: .reason.ClinicalDocument
|
participant | S Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idEncounter.participant Short descriptionList of participants involved in the encounter DefinitionThe list of people responsible for providing the service.
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Event.performer
- v2: ROL
- rim: .participation[typeCode=PFM]
|
id | | 0..1 | string | There are no (further) constraints on this element Element idEncounter.participant.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.participant.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.participant.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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).
RequirementsModifier 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.
CommentsThere 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.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
type | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.participant.type Short descriptionRole of participant in encounter DefinitionRole of participant in encounter.
CommentsThe participant type indicates how an individual 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.
Data typeCodeableConcept BindingRole of participant in encounter.
ParticipantType (extensible) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Event.performer.function
- v2: ROL-3 (or maybe PRT-4)
- rim: .functionCode
|
period | | 0..1 | Period | There are no (further) constraints on this element Element idEncounter.participant.period Short descriptionPeriod of time during the encounter that the participant participated DefinitionThe period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period.
Data typePeriod Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: ROL-5, ROL-6 (or maybe PRT-5)
- rim: .time
|
individual | Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | There are no (further) constraints on this element Element idEncounter.participant.individual Short descriptionPersons involved in the encounter other than the patient DefinitionPersons involved in the encounter other than the patient.
Data typeReference(Practitioner | PractitionerRole | RelatedPerson) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Event.performer.actor
- w5: FiveWs.who
- v2: ROL-4
- rim: .role
|
appointment | Σ | 0..* | Reference(Appointment) | There are no (further) constraints on this element Element idEncounter.appointment Short descriptionThe appointment that scheduled this encounter DefinitionThe appointment that scheduled this encounter.
Data typeReference(Appointment) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Event.basedOn
- v2: SCH-1 / SCH-2
- rim: .outboundRelationship[typeCode=FLFS].target[classCode=ENC, moodCode=APT]
|
period | | 0..1 | Period | There are no (further) constraints on this element Element idEncounter.period Short descriptionThe start and end time of the encounter DefinitionThe start and end time of the encounter.
CommentsIf not (yet) known, the end of the Period may be omitted.
Data typePeriod Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Event.occurrence[x]
- w5: FiveWs.done[x]
- v2: PV1-44, PV1-45
- rim: .effectiveTime (low & high)
|
length | | 0..1 | Duration | There are no (further) constraints on this element Element idEncounter.length Short descriptionQuantity of time the encounter lasted (less time absent) DefinitionQuantity of time the encounter lasted. This excludes the time during leaves of absence.
CommentsMay differ from the time the Encounter.period lasted because of leave of absence.
Data typeDuration Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Event.occurrence[x]
- v2: (PV1-45 less PV1-44) iff ( (PV1-44 not empty) and (PV1-45 not empty) ); units in minutes
- rim: .lengthOfStayQuantity
|
reasonCode | S Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.reasonCode Short descriptionCoded reason the encounter takes place Alternate namesIndication, Admission diagnosis DefinitionReason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
CommentsFor systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).
Data typeCodeableConcept BindingReason why the encounter takes place.
EncounterReasonCodes (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Event.reasonCode
- w5: FiveWs.why[x]
- v2: 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 )
- rim: .reasonCode
|
reasonReference | S Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | There are no (further) constraints on this element Element idEncounter.reasonReference Short descriptionReason the encounter takes place (reference) Alternate namesIndication, Admission diagnosis DefinitionReason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
CommentsFor systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).
Data typeReference(Condition | Procedure | Observation | ImmunizationRecommendation) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Event.reasonCode
- w5: FiveWs.why[x]
- v2: 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 )
- rim: .reasonCode
|
diagnosis | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idEncounter.diagnosis Short descriptionThe list of diagnosis relevant to this encounter DefinitionThe list of diagnosis relevant to this encounter.
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: .outboundRelationship[typeCode=RSON]
|
id | | 0..1 | string | There are no (further) constraints on this element Element idEncounter.diagnosis.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.diagnosis.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.diagnosis.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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).
RequirementsModifier 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.
CommentsThere 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.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
condition | Σ | 1..1 | Reference(Condition | Procedure) | There are no (further) constraints on this element Element idEncounter.diagnosis.condition Short descriptionThe diagnosis or procedure relevant to the encounter Alternate namesAdmission diagnosis, discharge diagnosis, indication DefinitionReason 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.
CommentsFor systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).
Data typeReference(Condition | Procedure) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Event.reasonReference
- w5: FiveWs.why[x]
- v2: Resources that would commonly referenced at Encounter.indication would be Condition and/or Procedure. These most closely align with DG1/PRB and PR1 respectively.
- rim: .outboundRelationship[typeCode=RSON].target
|
use | | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.diagnosis.use Short descriptionRole that this diagnosis has within the encounter (e.g. admission, billing, discharge …) DefinitionRole that this diagnosis has within the encounter (e.g. admission, billing, discharge …).
Data typeCodeableConcept BindingThe type of diagnosis this condition represents.
DiagnosisRole (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
rank | | 0..1 | positiveInt | There are no (further) constraints on this element Element idEncounter.diagnosis.rank Short descriptionRanking of the diagnosis (for each role type) DefinitionRanking of the diagnosis (for each role type).
Data typepositiveInt Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: .outboundRelationship[typeCode=RSON].priority
|
account | | 0..* | Reference(Account) | There are no (further) constraints on this element Element idEncounter.account Short descriptionThe set of accounts that may be used for billing for this Encounter DefinitionThe set of accounts that may be used for billing for this Encounter.
CommentsThe billing system may choose to allocate billable items associated with the Encounter to different referenced Accounts based on internal business rules.
Data typeReference(Account) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
hospitalization | | 0..1 | BackboneElement | There are no (further) constraints on this element Element idEncounter.hospitalization Short descriptionDetails about the admission to a healthcare service DefinitionDetails about the admission to a healthcare service.
CommentsAn 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 hospitalization record.
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: .outboundRelationship[typeCode=COMP].target[classCode=ENC, moodCode=EVN]
|
id | | 0..1 | string | There are no (further) constraints on this element Element idEncounter.hospitalization.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..* | Extension | Element idEncounter.hospitalization.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
admissionMethod | C | 0..1 | Extension(CodeableConcept) | Element idEncounter.hospitalization.extension:admissionMethod Short descriptionAn extension to support the method by which an individual was admitted into hospital. Alternate namesextensions, user content DefinitionThis extension has been developed to demonstrate the representation of the method by which a patient was admitted to hospital.
CommentsThere 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.
Data typeExtension(CodeableConcept) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdmissionMethod ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.hospitalization.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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).
RequirementsModifier 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.
CommentsThere 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.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
preAdmissionIdentifier | | 0..1 | Identifier | There are no (further) constraints on this element Element idEncounter.hospitalization.preAdmissionIdentifier Short descriptionPre-admission identifier DefinitionPre-admission identifier.
Data typeIdentifier Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
origin | | 0..1 | Reference(Location | Organization) | There are no (further) constraints on this element Element idEncounter.hospitalization.origin Short descriptionThe location/organization from which the patient came before admission DefinitionThe location/organization from which the patient came before admission.
Data typeReference(Location | Organization) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: .participation[typeCode=ORG].role
|
admitSource | | 0..1 | CodeableConceptBinding | Element idEncounter.hospitalization.admitSource Short descriptionFrom where patient was admitted (physician referral, transfer) DefinitionFrom where patient was admitted (physician referral, transfer).
Data typeCodeableConcept BindingThe source of admission to a Hospital Provider Spell or a Nursing Episode when the Patient is in a Hospital Site or a Care Home.
UKCoreSourceOfAdmission (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: PV1-14
- rim: .admissionReferralSourceCode
|
reAdmission | | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idEncounter.hospitalization.reAdmission Short descriptionThe type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission DefinitionWhether this hospitalization is a readmission and why if known.
Data typeCodeableConcept BindingThe reason for re-admission of this hospitalization encounter.
v2.0092 (example) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
dietPreference | | 0..* | CodeableConcept | There are no (further) constraints on this element Element idEncounter.hospitalization.dietPreference Short descriptionDiet preferences reported by the patient DefinitionDiet preferences reported by the patient.
RequirementsUsed 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.
CommentsFor example, a patient may request both a dairy-free and nut-free diet preference (not mutually exclusive).
Data typeCodeableConcept BindingMedical, cultural or ethical food preferences to help with catering requirements.
Diet (example) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: PV1-38
- rim: .outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=EVN, code="diet"]
|
specialCourtesy | | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.hospitalization.specialCourtesy Short descriptionSpecial courtesies (VIP, board member) DefinitionSpecial courtesies (VIP, board member).
Data typeCodeableConcept BindingSpecialCourtesy (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: PV1-16
- rim: .specialCourtesiesCode
|
specialArrangement | | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.hospitalization.specialArrangement Short descriptionWheelchair, translator, stretcher, etc. DefinitionAny special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things.
Data typeCodeableConcept BindingSpecialArrangements (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: PV1-15 / OBR-30 / OBR-43
- rim: .specialArrangementCode
|
destination | | 0..1 | Reference(Location | Organization) | There are no (further) constraints on this element Element idEncounter.hospitalization.destination Short descriptionLocation/organization to which the patient is discharged DefinitionLocation/organization to which the patient is discharged.
Data typeReference(Location | Organization) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: PV1-37
- rim: .participation[typeCode=DST]
|
dischargeDisposition | | 0..1 | CodeableConceptBinding | Element idEncounter.hospitalization.dischargeDisposition Short descriptionCategory or kind of location after discharge DefinitionCategory or kind of location after discharge.
Data typeCodeableConcept BindingThe destination of a Patient on completion of a Hospital Provider Spell, or a note that the Patient died or was a still birth.
UKCoreDischargeDestination (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: PV1-36
- rim: .dischargeDispositionCode
|
location | | 0..* | BackboneElement | There are no (further) constraints on this element Element idEncounter.location Short descriptionList of locations where the patient has been DefinitionList of locations where the patient has been during this encounter.
CommentsVirtual 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".
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: .participation[typeCode=LOC]
|
id | | 0..1 | string | There are no (further) constraints on this element Element idEncounter.location.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.location.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.location.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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).
RequirementsModifier 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.
CommentsThere 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.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
location | | 1..1 | Reference(Location) | There are no (further) constraints on this element Element idEncounter.location.location Short descriptionLocation the encounter takes place DefinitionThe location where the encounter takes place.
Data typeReference(Location) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Event.location
- w5: FiveWs.where[x]
- v2: PV1-3 / PV1-6 / PV1-11 / PV1-42 / PV1-43
- rim: .role
|
status | | 0..1 | codeBinding | There are no (further) constraints on this element Element idEncounter.location.status Short descriptionplanned | active | reserved | completed DefinitionThe 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.
CommentsWhen the patient is no longer active at a location, then the period end date is entered, and the status may be changed to completed.
Data typecode BindingThe status of the location.
EncounterLocationStatus (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
physicalType | | 0..1 | CodeableConceptBinding | Element idEncounter.location.physicalType Short descriptionThe physical type of the location (usually the level in the location hierachy - bed room ward etc.) DefinitionThis will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query.
CommentsThis 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.
Data typeCodeableConcept BindingA set of codes that define the physical type of location where an encounter takes place.
UKCoreEncounterLocationType (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
period | | 0..1 | Period | There are no (further) constraints on this element Element idEncounter.location.period Short descriptionTime period during which the patient was present at the location DefinitionTime period during which the patient was present at the location.
Data typePeriod Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
serviceProvider | | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idEncounter.serviceProvider Short descriptionThe organization (facility) responsible for this encounter DefinitionThe 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.
Data typeReference(Organization) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Event.performer.actor
- v2: PL.6 & PL.1
- rim: .particiaption[typeCode=PFM].role
|
partOf | | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idEncounter.partOf Short descriptionAnother Encounter this encounter is part of DefinitionAnother Encounter of which this encounter is a part of (administratively or in time).
CommentsThis 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.
Data typeReference(Encounter) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Event.partOf
- rim: .inboundRelationship[typeCode=COMP].source[classCode=COMP, moodCode=EVN]
|