1.1.0 - release
This page is part of the KL Gateway (v1.1.0: Release) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Active as of 2023-06-21 |
Definitions for the klgateway-care-encounter resource profile.
Guidance on how to interpret the contents of this table can be found here.
1. Encounter | |
2. Encounter.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..0* |
3. Encounter.status | |
4. Encounter.statusHistory | |
Control | 0..0* |
5. Encounter.class | |
Pattern Value | <valueCoding xmlns="http://hl7.org/fhir"> <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/> <code value="HH"/> </valueCoding> |
6. Encounter.class.version | |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..0 |
7. Encounter.class.display | |
Control | 0..0 |
8. Encounter.class.userSelected | |
Control | 0..0 |
9. Encounter.classHistory | |
Control | 0..0* |
10. Encounter.type | |
Control | 10..1* |
Binding | The codes SHALL be taken from KLKontaktTyperFor example codes, see EncounterType |
11. Encounter.type.coding | |
Control | 1..1 |
Pattern Value | <valueCoding xmlns="http://hl7.org/fhir"> <system value="http://fhir.kl.dk/term/CodeSystem/CareSocialCodes"/> <code value="9f03dfbb-7a97-45a5-94db-d4c3501714a9"/> </valueCoding> |
12. Encounter.type.coding.version | |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..0 |
13. Encounter.type.coding.display | |
Control | 0..0 |
14. Encounter.type.coding.userSelected | |
Control | 0..0 |
15. Encounter.type.text | |
Control | 0..0 |
16. Encounter.serviceType | |
Control | 0..01 |
17. Encounter.priority | |
Control | 0..01 |
18. Encounter.subject | |
Control | 10..1 |
Type | Reference(KLGatewayCareCitizen|Patient|Group) : {b} |
19. Encounter.episodeOfCare | |
Control | 0..0* |
20. Encounter.basedOn | |
Control | 0..0* |
21. Encounter.participant | |
Control | 0..0* |
22. Encounter.appointment | |
Control | 0..0* |
23. Encounter.period | |
Control | 10..1 |
24. Encounter.period.start | |
Control | 1..? |
25. Encounter.period.end | |
Control | 0..0 |
26. Encounter.length | |
Control | 0..01 |
27. Encounter.reasonCode | |
Control | 0..0* |
28. Encounter.reasonReference | |
Control | 0..0* |
29. Encounter.diagnosis | |
Control | 0..0* |
30. Encounter.account | |
Control | 0..0* |
31. Encounter.hospitalization | |
Control | 0..01 |
32. Encounter.location | |
Control | 0..0* |
33. Encounter.serviceProvider | |
Control | 0..01 |
34. Encounter.partOf | |
Control | 0..01 |
Guidance on how to interpret the contents of this table can be found here.
1. 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. | ||
Control | 0..* | ||
Summary | false | ||
Alternate Names | Visit | ||
Invariants | Defined on this element 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()) | ||
2. 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. | ||
Control | 0..1 | ||
Type | uri | ||
Is Modifier | true | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
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 it's narrative along with other profiles, value sets, etc. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
3. 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 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). | ||
Control | 0..* | ||
Type | Extension | ||
Is Modifier | true | ||
Summary | false | ||
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. | ||
Alternate Names | 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. | ||
Invariants | Defined on this element 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()) | ||
4. Encounter.identifier | |||
Definition | Identifier(s) by which this encounter is known. | ||
Note | This is a business identifier, not a resource identifier (see discussion) | ||
Control | 0..0* | ||
Type | Identifier | ||
Summary | true | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
5. Encounter.status | |||
Definition | planned | arrived | triaged | in-progress | onleave | finished | cancelled +. | ||
Control | 1..1 | ||
Binding | The codes SHALL be taken from EncounterStatus Current state of the encounter. | ||
Type | code | ||
Is Modifier | true | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Summary | true | ||
Comments | Note that internal business rules will determine the appropriate transitions that may occur between statuses (and also classes). | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
6. Encounter.statusHistory | |||
Definition | The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them. | ||
Control | 0..0* | ||
Type | BackboneElement | ||
Obligations |
| ||
Summary | false | ||
Comments | The current status is always found in the current version of the resource, not the status history. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
7. Encounter.class | |||
Definition | Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations. | ||
Control | 1..1 | ||
Binding | The codes SHALL be taken from ActEncounterCode; other codes may be used where these codes are not suitable Classification of the encounter. | ||
Type | Coding | ||
Summary | true | ||
Pattern Value | <valueCoding xmlns="http://hl7.org/fhir"> <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/> <code value="HH"/> </valueCoding> | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
8. Encounter.class.version | |||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||
Note | This is a business versionId, not a resource version id (see discussion) | ||
Control | 0..01 | ||
Type | string | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Summary | true | ||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
9. Encounter.class.display | |||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||
Control | 0..01 | ||
Type | string | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Obligations |
| ||
Summary | true | ||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
10. Encounter.class.userSelected | |||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||
Control | 0..01 | ||
Type | boolean | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Summary | true | ||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
11. Encounter.classHistory | |||
Definition | The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient. | ||
Control | 0..0* | ||
Type | BackboneElement | ||
Obligations |
| ||
Summary | false | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
12. Encounter.type | |||
Definition | Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation). | ||
Control | 10..1* | ||
Binding | The codes SHALL be taken from KLKontaktTyperFor example codes, see EncounterType | ||
Type | CodeableConcept | ||
Summary | true | ||
Comments | Since there are many ways to further classify encounters, this element is 0..*. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
13. Encounter.type.coding | |||
Definition | A reference to a code defined by a terminology system. | ||
Control | 10..1* | ||
Type | Coding | ||
Summary | true | ||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||
Pattern Value | <valueCoding xmlns="http://hl7.org/fhir"> <system value="http://fhir.kl.dk/term/CodeSystem/CareSocialCodes"/> <code value="9f03dfbb-7a97-45a5-94db-d4c3501714a9"/> </valueCoding> | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
14. Encounter.type.coding.version | |||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||
Note | This is a business versionId, not a resource version id (see discussion) | ||
Control | 0..01 | ||
Type | string | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Summary | true | ||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
15. Encounter.type.coding.display | |||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||
Control | 0..01 | ||
Type | string | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Obligations |
| ||
Summary | true | ||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
16. Encounter.type.coding.userSelected | |||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||
Control | 0..01 | ||
Type | boolean | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Summary | true | ||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
17. Encounter.type.text | |||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||
Control | 0..01 | ||
Type | string | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Obligations |
| ||
Summary | true | ||
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||
Comments | Very often the text is the same as a displayName of one of the codings. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
18. Encounter.serviceType | |||
Definition | Broad categorization of the service that is to be provided (e.g. cardiology). | ||
Control | 0..01 | ||
Binding | For example codes, see ServiceType Broad categorization of the service that is to be provided. | ||
Type | CodeableConcept | ||
Summary | true | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
19. Encounter.priority | |||
Definition | Indicates the urgency of the encounter. | ||
Control | 0..01 | ||
Binding | For example codes, see ActPriority Indicates the urgency of the encounter. | ||
Type | CodeableConcept | ||
Summary | false | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
20. Encounter.subject | |||
Definition | The patient or group present at the encounter. | ||
Control | 10..1 | ||
Type | Reference(KLGatewayCareCitizen|Patient|Group) : {b} | ||
Summary | true | ||
Alternate Names | 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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
21. 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). | ||
Control | 0..0* | ||
Type | Reference(EpisodeOfCare) | ||
Summary | true | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
22. Encounter.basedOn | |||
Definition | The request this encounter satisfies (e.g. incoming referral or procedure request). | ||
Control | 0..0* | ||
Type | Reference(ServiceRequest) | ||
Summary | false | ||
Alternate Names | incomingReferral | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
23. Encounter.participant | |||
Definition | The list of people responsible for providing the service. | ||
Control | 0..0* | ||
Type | BackboneElement | ||
Summary | true | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
24. Encounter.appointment | |||
Definition | The appointment that scheduled this encounter. | ||
Control | 0..0* | ||
Type | Reference(Appointment) | ||
Summary | true | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
25. Encounter.period | |||
Definition | The start and end time of the encounter. | ||
Control | 10..1 | ||
Type | Period | ||
Summary | false | ||
Comments | If not (yet) known, the end of the Period may be omitted. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
26. Encounter.period.start | |||
Definition | The start of the period. The boundary is inclusive. | ||
Control | 10..1 This element is affected by the following invariants: per-1 | ||
Type | dateTime | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Summary | true | ||
Comments | If the low element is missing, the meaning is that the low boundary is not known. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
27. Encounter.period.end | |||
Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. | ||
Control | 0..01 This element is affected by the following invariants: per-1 | ||
Type | dateTime | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Summary | true | ||
Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. | ||
Meaning if Missing | If the end of the period is missing, it means that the period is ongoing | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
28. Encounter.length | |||
Definition | Quantity of time the encounter lasted. This excludes the time during leaves of absence. | ||
Control | 0..01 | ||
Type | Duration | ||
Summary | false | ||
Comments | May differ from the time the Encounter.period lasted because of leave of absence. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
29. Encounter.reasonCode | |||
Definition | Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis. | ||
Control | 0..0* | ||
Binding | The codes SHOULD be taken from EncounterReasonCodes Reason why the encounter takes place. | ||
Type | CodeableConcept | ||
Summary | true | ||
Alternate Names | Indication, Admission diagnosis | ||
Comments | For 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). | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
30. Encounter.reasonReference | |||
Definition | Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis. | ||
Control | 0..0* | ||
Type | Reference(Condition|Procedure|Observation|ImmunizationRecommendation) | ||
Summary | true | ||
Alternate Names | Indication, Admission diagnosis | ||
Comments | For 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). | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
31. Encounter.diagnosis | |||
Definition | The list of diagnosis relevant to this encounter. | ||
Control | 0..0* | ||
Type | BackboneElement | ||
Obligations |
| ||
Summary | true | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
32. Encounter.account | |||
Definition | The set of accounts that may be used for billing for this Encounter. | ||
Control | 0..0* | ||
Type | Reference(Account) | ||
Summary | false | ||
Comments | The billing system may choose to allocate billable items associated with the Encounter to different referenced Accounts based on internal business rules. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
33. Encounter.hospitalization | |||
Definition | Details about the admission to a healthcare service. | ||
Control | 0..01 | ||
Type | BackboneElement | ||
Summary | false | ||
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 hospitalization record. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
34. Encounter.location | |||
Definition | List of locations where the patient has been during this encounter. | ||
Control | 0..0* | ||
Type | BackboneElement | ||
Summary | false | ||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
35. 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 example bundle showing an abbreviated set of Encounters for a colonoscopy. | ||
Control | 0..01 | ||
Type | Reference(Organization) | ||
Summary | false | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
36. Encounter.partOf | |||
Definition | Another Encounter of which this encounter is a part of (administratively or in time). | ||
Control | 0..01 | ||
Type | Reference(Encounter) | ||
Summary | false | ||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here.
1. 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. | ||||
Control | 0..* | ||||
Summary | false | ||||
Alternate Names | Visit | ||||
2. Encounter.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Control | 0..1 | ||||
Type | id | ||||
Summary | true | ||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
3. 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. | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
4. 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. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
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 it's narrative along with other profiles, value sets, etc. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
5. Encounter.language | |||||
Definition | The base language in which the resource is written. | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from CommonLanguages
A human language
| ||||
Type | code | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
6. 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. | ||||
Control | 0..1 | ||||
Type | Narrative | ||||
Summary | false | ||||
Alternate Names | narrative, html, xhtml, display | ||||
Comments | Contained 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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
7. Encounter.contained | |||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Summary | false | ||||
Alternate Names | 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. | ||||
8. 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 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | 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. | ||||
Invariants | Defined on this element 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()) | ||||
9. 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 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). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | false | ||||
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. | ||||
Alternate Names | 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. | ||||
Invariants | Defined on this element 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()) | ||||
10. Encounter.identifier | |||||
Definition | Identifier(s) by which this encounter is known. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..0 | ||||
Type | Identifier | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
11. Encounter.status | |||||
Definition | planned | arrived | triaged | in-progress | onleave | finished | cancelled +. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from EncounterStatus Current state of the encounter | ||||
Type | code | ||||
Is Modifier | true | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Comments | Note that internal business rules will determine the appropriate transitions that may occur between statuses (and also classes). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
12. Encounter.statusHistory | |||||
Definition | The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them. | ||||
Control | 0..0 | ||||
Type | BackboneElement | ||||
Obligations |
| ||||
Summary | false | ||||
Comments | The current status is always found in the current version of the resource, not the status history. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
13. Encounter.class | |||||
Definition | Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from ActEncounterCode; other codes may be used where these codes are not suitable Classification of the encounter | ||||
Type | Coding | ||||
Summary | true | ||||
Pattern Value | <valueCoding xmlns="http://hl7.org/fhir"> <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/> <code value="HH"/> </valueCoding> | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
14. Encounter.class.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
15. Encounter.class.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 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | 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. | ||||
Invariants | Defined on this element 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()) | ||||
Slicing | This element introduces a set of slices on Encounter.class.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
16. Encounter.class.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
17. Encounter.class.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..0 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
18. Encounter.class.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 0..1 | ||||
Type | code | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
19. Encounter.class.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..0 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Obligations |
| ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
20. Encounter.class.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
Control | 0..0 | ||||
Type | boolean | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
21. Encounter.classHistory | |||||
Definition | The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient. | ||||
Control | 0..0 | ||||
Type | BackboneElement | ||||
Obligations |
| ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
22. Encounter.type | |||||
Definition | Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation). | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from KLKontaktTyper | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Comments | Since there are many ways to further classify encounters, this element is 0..*. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
23. Encounter.type.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
24. Encounter.type.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 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | 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. | ||||
Invariants | Defined on this element 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()) | ||||
Slicing | This element introduces a set of slices on Encounter.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
25. Encounter.type.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 1..1 | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
Pattern Value | <valueCoding xmlns="http://hl7.org/fhir"> <system value="http://fhir.kl.dk/term/CodeSystem/CareSocialCodes"/> <code value="9f03dfbb-7a97-45a5-94db-d4c3501714a9"/> </valueCoding> | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
26. Encounter.type.coding.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
27. Encounter.type.coding.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 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | 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. | ||||
Invariants | Defined on this element 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()) | ||||
Slicing | This element introduces a set of slices on Encounter.type.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
28. Encounter.type.coding.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
29. Encounter.type.coding.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..0 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
30. Encounter.type.coding.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 0..1 | ||||
Type | code | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
31. Encounter.type.coding.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..0 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Obligations |
| ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
32. Encounter.type.coding.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
Control | 0..0 | ||||
Type | boolean | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
33. Encounter.type.text | |||||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
Control | 0..0 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Obligations |
| ||||
Summary | true | ||||
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
34. Encounter.serviceType | |||||
Definition | Broad categorization of the service that is to be provided (e.g. cardiology). | ||||
Control | 0..0 | ||||
Binding | For example codes, see ServiceType Broad categorization of the service that is to be provided | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
35. Encounter.priority | |||||
Definition | Indicates the urgency of the encounter. | ||||
Control | 0..0 | ||||
Binding | For example codes, see ActPriority Indicates the urgency of the encounter | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
36. Encounter.subject | |||||
Definition | The patient or group present at the encounter. | ||||
Control | 1..1 | ||||
Type | Reference(KLGatewayCareCitizen) : {b} | ||||
Summary | true | ||||
Alternate Names | 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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
37. 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). | ||||
Control | 0..0 | ||||
Type | Reference(EpisodeOfCare) | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
38. Encounter.basedOn | |||||
Definition | The request this encounter satisfies (e.g. incoming referral or procedure request). | ||||
Control | 0..0 | ||||
Type | Reference(ServiceRequest) | ||||
Summary | false | ||||
Alternate Names | incomingReferral | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
39. Encounter.participant | |||||
Definition | The list of people responsible for providing the service. | ||||
Control | 0..0 | ||||
Type | BackboneElement | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
40. Encounter.appointment | |||||
Definition | The appointment that scheduled this encounter. | ||||
Control | 0..0 | ||||
Type | Reference(Appointment) | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
41. Encounter.period | |||||
Definition | The start and end time of the encounter. | ||||
Control | 1..1 | ||||
Type | Period | ||||
Summary | false | ||||
Comments | If not (yet) known, the end of the Period may be omitted. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
42. Encounter.period.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
43. Encounter.period.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 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Summary | false | ||||
Alternate Names | 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. | ||||
Invariants | Defined on this element 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()) | ||||
Slicing | This element introduces a set of slices on Encounter.period.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
44. Encounter.period.start | |||||
Definition | The start of the period. The boundary is inclusive. | ||||
Control | 1..1 This element is affected by the following invariants: per-1 | ||||
Type | dateTime | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Comments | If the low element is missing, the meaning is that the low boundary is not known. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
45. Encounter.period.end | |||||
Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. | ||||
Control | 0..0 This element is affected by the following invariants: per-1 | ||||
Type | dateTime | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. | ||||
Meaning if Missing | If the end of the period is missing, it means that the period is ongoing | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
46. Encounter.length | |||||
Definition | Quantity of time the encounter lasted. This excludes the time during leaves of absence. | ||||
Control | 0..0 | ||||
Type | Duration | ||||
Summary | false | ||||
Comments | May differ from the time the Encounter.period lasted because of leave of absence. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
47. Encounter.reasonCode | |||||
Definition | Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis. | ||||
Control | 0..0 | ||||
Binding | The codes SHOULD be taken from EncounterReasonCodes Reason why the encounter takes place | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Alternate Names | Indication, Admission diagnosis | ||||
Comments | For 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). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
48. Encounter.reasonReference | |||||
Definition | Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis. | ||||
Control | 0..0 | ||||
Type | Reference(Condition|Procedure|Observation|ImmunizationRecommendation) | ||||
Summary | true | ||||
Alternate Names | Indication, Admission diagnosis | ||||
Comments | For 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). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
49. Encounter.diagnosis | |||||
Definition | The list of diagnosis relevant to this encounter. | ||||
Control | 0..0 | ||||
Type | BackboneElement | ||||
Obligations |
| ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
50. Encounter.account | |||||
Definition | The set of accounts that may be used for billing for this Encounter. | ||||
Control | 0..0 | ||||
Type | Reference(Account) | ||||
Summary | false | ||||
Comments | The billing system may choose to allocate billable items associated with the Encounter to different referenced Accounts based on internal business rules. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
51. Encounter.hospitalization | |||||
Definition | Details about the admission to a healthcare service. | ||||
Control | 0..0 | ||||
Type | BackboneElement | ||||
Summary | false | ||||
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 hospitalization record. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
52. Encounter.location | |||||
Definition | List of locations where the patient has been during this encounter. | ||||
Control | 0..0 | ||||
Type | BackboneElement | ||||
Summary | false | ||||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
53. 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 example bundle showing an abbreviated set of Encounters for a colonoscopy. | ||||
Control | 0..0 | ||||
Type | Reference(Organization) | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
54. Encounter.partOf | |||||
Definition | Another Encounter of which this encounter is a part of (administratively or in time). | ||||
Control | 0..0 | ||||
Type | Reference(Encounter) | ||||
Summary | false | ||||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |