HRSA 2024 Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+) FHIR IG
2.0.0 - STU2 Release 1 - Standard for Trial-Use

Publication Build: This will be filled in by the publication tooling

## Resource Profile: UDSPlusEncounter - Detailed Descriptions

Page standards status: Trial-use | Maturity Level: 2

Definitions for the uds-plus-encounter resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here

0. Encounter
Definition | The UDS+ profile is based on the Encounter resource and establishes the core elements, extensions, vocabularies and value sets for representing encounters,visit information for UDS+ program. 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.
Short | De-Identified UDS Plus EncounterAn interaction during which services are provided to the patient
Control | 0..*
Is Modifier | false
Summary | false
Alternate Names | Visit
Invariants | 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.id
Definition | De-dentified Encounter resource identifier. The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | The de-identified Encounter identifier created by the health center to send data to UDS+ Data ReceiverLogical id of this artifact
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.
Control | 0..1
Type | id string
Is Modifier | false
Must Support | true
Summary | true
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.
Short | A set of rules under which this content was created
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.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | 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.
Short | Cannot include any text in the resource as part of the de-identified data.Text summary of the resource, for human interpretation
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.
Control | 0..01
Type | Narrative
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. 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.
Short | Cannot include any contained resources in the resource as part of the de-identified data.Contained, inline 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.
Control | 0..0*
Type | Resource
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
10. Encounter.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional content defined by implementations
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.
Control | 10..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
12. Encounter.extension:uds-plus-age-extension
Slice Name | uds-plus-age-extension
Definition | Indicates the age of the Patient computed based on date of birth at a specific time
Short | Age of the Patient computed using birthDate and the visit dates of the encounter
Control | 1..1 This element is affected by the following invariants: ele-1
Type | Extension(UDS Plus Age Extension) (Extension Type: Quantity)
Is Modifier | false
Must Support | true
Invariants | 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()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. 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).
Short | Extensions that cannot be ignored
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
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
Invariants | 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())
16. Encounter.status
Definition | planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
Short | planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Comments | Note that internal business rules will determine the appropriate transitions that may occur between statuses (and also classes).
Control | 1..1
Binding | The codes SHALL be taken from EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 (required to `http://hl7.org/fhir/ValueSet/encounter-status|4.0.1` ) Current state of the encounter.
Type | code
Is Modifier | true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Encounter.class
Definition | Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
Short | Classification of patient encounter
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode (extensible to `http://terminology.hl7.org/ValueSet/v3-ActEncounterCode` ) Classification of the encounter.
Type | Coding
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Encounter.type
Definition | Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
Short | Specific type of encounter
Comments | Since there are many ways to further classify encounters, this element is 0..*.
Control | 10..*
Binding | Unless not suitable, these codes SHALL be taken from For example codes, see US Core Encounter Type http://hl7.org/fhir/ValueSet/encounter-type (extensible to `http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type` ) The set of codes indicating the type of encounter The type of encounter.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Encounter.subject
Definition | The patient or group present at the encounter.
Short | The patient or group present at the encounter
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).
Control | 10..1
Type | Reference(De-Identified UDS Plus Patient, Patient, Group)
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | patient
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Encounter.subject.display
Definition | Plain text narrative that identifies the resource in addition to the resource reference.
Short | Text alternative for the resource
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Control | 0..01
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Encounter.participant
Definition | The list of people responsible for providing the service.
Short | List of participants involved in the encounter
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Encounter.participant.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).
Short | Extensions that cannot be ignored even if unrecognized
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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, modifiers
Invariants | 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())
30. Encounter.participant.type
Definition | Role of participant in encounter.
Short | Role of participant in encounter
Comments | The 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.
Control | 0..*
Binding | Unless not suitable, these codes SHALL be taken from ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type (extensible to `http://hl7.org/fhir/ValueSet/encounter-participant-type` ) Role of participant in encounter.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Encounter.participant.period
Definition | The period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period.
Short | Period of time during the encounter that the participant participated
Control | 0..1
Type | Period
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) uds-plus-enc-1: All Period.start data elements should be truncated to a year only for de-identified resources. (`$this is Period and $this.start.exists() implies $this.start.toString().length() = 4`) uds-plus-enc-1a: All Period.start data elements should have valid year > 1900 (`$this is Period and Period.start.exists() implies $this.start.toString() >= '1900'`) uds-plus-enc-1b: All Period.start data elements should have valid year < 2030 (`$this is Period and Period.start.exists() implies $this.start.toString() <= '2030'`) uds-plus-enc-2: All Period.emd data elements should be truncated to a year only for de-identified resources. (`$this is Period and $this.end.exists() implies $this.end.toString().length() = 4`) uds-plus-enc-2a: All Period.end data elements should have valid year > 1900 (`$this is Period and Period.end.exists() implies $this.end.toString() >= '1900'`) uds-plus-enc-2b: All Period.end data elements should have valid year < 2030 (`$this is Period and Period.end.exists() implies $this.end.toString() <= '2030'`)
34. Encounter.participant.individual
Definition | Persons involved in the encounter other than the patient.
Short | Persons involved in the encounter other than the patient
Control | 0..1
Type | Reference(US Core Practitioner Profile, Practitioner, PractitionerRole, RelatedPerson)
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Encounter.period
Definition | The start and end time of the encounter.
Short | The start and end time of the encounter
Comments | If not (yet) known, the end of the Period may be omitted.
Control | 0..1
Type | Period
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) uds-plus-enc-3: All Period.start data elements should be truncated to a year only for de-identified resources. (`$this is Period and $this.start.exists() implies $this.start.toString().length() = 4`) uds-plus-enc-3a: All Period.start data elements should have valid year > 1900 (`$this is Period and Period.start.exists() implies $this.start.toString() >= '1900'`) uds-plus-enc-3b: All Period.start data elements should have valid year < 2030 (`$this is Period and Period.start.exists() implies $this.start.toString() <= '2030'`) uds-plus-enc-4: All Period.emd data elements should be truncated to a year only for de-identified resources. (`$this is Period and $this.end.exists() implies $this.end.toString().length() = 4`) uds-plus-enc-4a: All Period.end data elements should have valid year > 1900 (`$this is Period and Period.end.exists() implies $this.end.toString() >= '1900'`) uds-plus-enc-4b: All Period.end data elements should have valid year < 2030 (`$this is Period and Period.end.exists() implies $this.end.toString() <= '2030'`)
38. Encounter.reasonCode
Definition | Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
Short | Coded reason the encounter takes place
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).
Control | 0..*
Binding | The codes SHOULD be taken from EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reason (preferred to `http://hl7.org/fhir/ValueSet/encounter-reason` ) Reason why the encounter takes place.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | Indication, Admission diagnosis
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. Encounter.reasonReference
Definition | Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
Short | Reason the encounter takes place (reference)
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).
Control | 0..*
Type | Reference(De-Identified UDS Plus Diagnosis, Condition, Procedure, Observation, ImmunizationRecommendation)
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | Indication, Admission diagnosis
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. Encounter.diagnosis
Definition | The list of diagnosis relevant to this encounter.
Short | The list of diagnosis relevant to this encounter
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. Encounter.diagnosis.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).
Short | Extensions that cannot be ignored even if unrecognized
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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, modifiers
Invariants | 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())
46. Encounter.diagnosis.condition
Definition | Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
Short | The diagnosis or procedure relevant to the encounter
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).
Control | 1..1
Type | Reference(De-Identified UDS Plus Diagnosis, Condition, Procedure)
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | Admission diagnosis, discharge diagnosis, indication
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. Encounter.diagnosis.use
Definition | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …).
Short | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Control | 0..1
Binding | The codes SHOULD be taken from DiagnosisRole http://hl7.org/fhir/ValueSet/diagnosis-role (preferred to `http://hl7.org/fhir/ValueSet/diagnosis-role` ) The type of diagnosis this condition represents.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. Encounter.diagnosis.rank
Definition | Ranking of the diagnosis (for each role type).
Short | Ranking of the diagnosis (for each role type)
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. Encounter.hospitalization
Definition | Details about the admission to a healthcare service.
Short | Details about the admission to a healthcare service
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.
Control | 0..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. Encounter.hospitalization.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).
Short | Extensions that cannot be ignored even if unrecognized
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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, modifiers
Invariants | 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())
56. Encounter.hospitalization.dischargeDisposition
Definition | Category or kind of location after discharge.
Short | Category or kind of location after discharge
Control | 0..1
Binding | The codes SHOULD be taken from For example codes, see US Core Discharge Disposition http://hl7.org/fhir/ValueSet/encounter-discharge-disposition (preferred to `http://hl7.org/fhir/us/core/ValueSet/us-core-discharge-disposition` ) The set of codes indicating the discharge disposition Discharge Disposition.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. Encounter.location
Definition | List of locations where the patient has been during this encounter.
Short | List of locations where the patient has been
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".
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. Encounter.location.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).
Short | Extensions that cannot be ignored even if unrecognized
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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, modifiers
Invariants | 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())
62. Encounter.location.location
Definition | The location where the encounter takes place.
Short | Location the encounter takes place
Control | 1..1
Type | Reference(UDS Plus Location, Location)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. 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.
Short | The organization (facility) responsible for this encounter
Control | 0..1
Type | Reference(US Core Organization Profile, Organization)
Is Modifier | false
Must Support | true
Summary | false
Invariants | 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

0. Encounter
Definition | The UDS+ profile is based on the Encounter resource and establishes the core elements, extensions, vocabularies and value sets for representing encounters,visit information for UDS+ program.
Short | De-Identified UDS Plus Encounter
2. Encounter.id
Definition | De-dentified Encounter resource identifier.
Short | The de-identified Encounter identifier created by the health center to send data to UDS+ Data Receiver
Must Support | true
4. Encounter.text
Short | Cannot include any text in the resource as part of the de-identified data.
Control | 0..0
Must Support | false
6. Encounter.contained
Short | Cannot include any contained resources in the resource as part of the de-identified data.
Control | 0..0
Must Support | false
8. Encounter.extension:uds-plus-age-extension
Slice Name | uds-plus-age-extension
Short | Age of the Patient computed using birthDate and the visit dates of the encounter
Control | 1..1
Type | Extension(UDS Plus Age Extension) (Extension Type: Quantity)
Must Support | true
10. Encounter.status
Control | 1..1
Must Support | true
12. Encounter.class
Control | 1..1
Must Support | true
14. Encounter.type
Control | 1..*
Binding | Unless not suitable, these codes SHALL be taken from US Core Encounter Type (extensible to `http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type` ) The set of codes indicating the type of encounter
Must Support | true
16. Encounter.subject
Control | 1..1
Type | Reference(De-Identified UDS Plus Patient)
Must Support | true
18. Encounter.subject.display
Control | 0..0
Must Support | false
20. Encounter.participant
Control | 0..*
Must Support | true
22. Encounter.participant.type
Control | 0..*
Must Support | true
24. Encounter.participant.period
Control | 0..1
Must Support | true
Invariants | uds-plus-enc-1: All Period.start data elements should be truncated to a year only for de-identified resources. (`$this is Period and $this.start.exists() implies $this.start.toString().length() = 4`) uds-plus-enc-1a: All Period.start data elements should have valid year > 1900 (`$this is Period and Period.start.exists() implies $this.start.toString() >= '1900'`) uds-plus-enc-1b: All Period.start data elements should have valid year < 2030 (`$this is Period and Period.start.exists() implies $this.start.toString() <= '2030'`) uds-plus-enc-2: All Period.emd data elements should be truncated to a year only for de-identified resources. (`$this is Period and $this.end.exists() implies $this.end.toString().length() = 4`) uds-plus-enc-2a: All Period.end data elements should have valid year > 1900 (`$this is Period and Period.end.exists() implies $this.end.toString() >= '1900'`) uds-plus-enc-2b: All Period.end data elements should have valid year < 2030 (`$this is Period and Period.end.exists() implies $this.end.toString() <= '2030'`)
26. Encounter.participant.individual
Control | 0..1
Type | Reference(US Core Practitioner Profile)
Must Support | true
28. Encounter.period
Control | 0..1
Must Support | true
Invariants | uds-plus-enc-3: All Period.start data elements should be truncated to a year only for de-identified resources. (`$this is Period and $this.start.exists() implies $this.start.toString().length() = 4`) uds-plus-enc-3a: All Period.start data elements should have valid year > 1900 (`$this is Period and Period.start.exists() implies $this.start.toString() >= '1900'`) uds-plus-enc-3b: All Period.start data elements should have valid year < 2030 (`$this is Period and Period.start.exists() implies $this.start.toString() <= '2030'`) uds-plus-enc-4: All Period.emd data elements should be truncated to a year only for de-identified resources. (`$this is Period and $this.end.exists() implies $this.end.toString().length() = 4`) uds-plus-enc-4a: All Period.end data elements should have valid year > 1900 (`$this is Period and Period.end.exists() implies $this.end.toString() >= '1900'`) uds-plus-enc-4b: All Period.end data elements should have valid year < 2030 (`$this is Period and Period.end.exists() implies $this.end.toString() <= '2030'`)
30. Encounter.reasonCode
Control | 0..*
Must Support | true
32. Encounter.reasonReference
Control | 0..*
Type | Reference(De-Identified UDS Plus Diagnosis)
Must Support | true
34. Encounter.diagnosis
Control | 0..*
Must Support | true
36. Encounter.diagnosis.condition
Control | 1..1
Type | Reference(De-Identified UDS Plus Diagnosis)
Must Support | true
38. Encounter.diagnosis.use
Control | 0..1
Must Support | true
40. Encounter.diagnosis.rank
Control | 0..1
Must Support | true
42. Encounter.hospitalization
Control | 0..1
Must Support | true
44. Encounter.hospitalization.dischargeDisposition
Control | 0..1
Binding | The codes SHOULD be taken from US Core Discharge Disposition (preferred to `http://hl7.org/fhir/us/core/ValueSet/us-core-discharge-disposition` ) The set of codes indicating the discharge disposition
Must Support | true
46. Encounter.location
Control | 0..*
Must Support | true
48. Encounter.location.location
Control | 1..1
Type | Reference(UDS Plus Location)
Must Support | true
50. Encounter.serviceProvider
Control | 0..1
Type | Reference(US Core Organization Profile)
Must Support | true

Guidance on how to interpret the contents of this table can be found here

0. Encounter
Definition | The UDS+ profile is based on the Encounter resource and establishes the core elements, extensions, vocabularies and value sets for representing encounters,visit information for UDS+ program.
Short | De-Identified UDS Plus Encounter
Control | 0..*
Is Modifier | false
Summary | false
Alternate Names | Visit
Invariants | 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.id
Definition | De-dentified Encounter resource identifier.
Short | The de-identified Encounter identifier created by the health center to send data to UDS+ Data Receiver
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.
Control | 0..1
Type | id
Is Modifier | false
Must Support | true
Summary | true
4. 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.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. 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.
Short | A set of rules under which this content was created
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.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. Encounter.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
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).
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
10. 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.
Short | Cannot include any text in the resource as part of the de-identified data.
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.
Control | 0..0
Type | Narrative
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. 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.
Short | Cannot include any contained resources in the resource as part of the de-identified data.
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.
Control | 0..0
Type | Resource
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
14. Encounter.extension
Definition | An Extension
Short | Extension
Control | 1..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | 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.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
16. Encounter.extension:uds-plus-age-extension
Slice Name | uds-plus-age-extension
Definition | Indicates the age of the Patient computed based on date of birth at a specific time
Short | Age of the Patient computed using birthDate and the visit dates of the encounter
Control | 1..1 This element is affected by the following invariants: ele-1
Type | Extension(UDS Plus Age Extension) (Extension Type: Quantity)
Is Modifier | false
Must Support | true
Invariants | 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()`)
18. 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).
Short | Extensions that cannot be ignored
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
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
Invariants | 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()`)
20. Encounter.identifier
Definition | Identifier(s) by which this encounter is known.
Short | Identifier(s) by which this encounter is known
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. Encounter.status
Definition | planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
Short | planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Comments | Note that internal business rules will determine the appropriate transitions that may occur between statuses (and also classes).
Control | 1..1
Binding | The codes SHALL be taken from EncounterStatus (required to `http://hl7.org/fhir/ValueSet/encounter-status|4.0.1` ) Current state of the encounter.
Type | code
Is Modifier | true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
24. 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.
Short | List of past encounter statuses
Comments | The current status is always found in the current version of the resource, not the status history.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. Encounter.statusHistory.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
28. Encounter.statusHistory.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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
30. Encounter.statusHistory.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).
Short | Extensions that cannot be ignored even if unrecognized
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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, modifiers
Invariants | 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()`)
32. Encounter.statusHistory.status
Definition | planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
Short | planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Control | 1..1
Binding | The codes SHALL be taken from EncounterStatus (required to `http://hl7.org/fhir/ValueSet/encounter-status|4.0.1` ) Current state of the encounter.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
34. Encounter.statusHistory.period
Definition | The time that the episode was in the specified status.
Short | The time that the episode was in the specified status
Control | 1..1
Type | Period
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
36. Encounter.class
Definition | Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
Short | Classification of patient encounter
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from ActEncounterCode (extensible to `http://terminology.hl7.org/ValueSet/v3-ActEncounterCode` ) Classification of the encounter.
Type | Coding
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
38. 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.
Short | List of past encounter classes
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
40. Encounter.classHistory.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
42. Encounter.classHistory.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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
44. Encounter.classHistory.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).
Short | Extensions that cannot be ignored even if unrecognized
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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, modifiers
Invariants | 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()`)
46. Encounter.classHistory.class
Definition | inpatient | outpatient | ambulatory | emergency +.
Short | inpatient | outpatient | ambulatory | emergency +
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from ActEncounterCode (extensible to `http://terminology.hl7.org/ValueSet/v3-ActEncounterCode` ) Classification of the encounter.
Type | Coding
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
48. Encounter.classHistory.period
Definition | The time that the episode was in the specified class.
Short | The time that the episode was in the specified class
Control | 1..1
Type | Period
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
50. Encounter.type
Definition | Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
Short | Specific type of encounter
Comments | Since there are many ways to further classify encounters, this element is 0..*.
Control | 1..*
Binding | Unless not suitable, these codes SHALL be taken from US Core Encounter Type (extensible to `http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type` ) The set of codes indicating the type of encounter
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
52. Encounter.serviceType
Definition | Broad categorization of the service that is to be provided (e.g. cardiology).
Short | Specific type of service
Control | 0..1
Binding | For example codes, see ServiceType (example to `http://hl7.org/fhir/ValueSet/service-type` ) Broad categorization of the service that is to be provided.
Type | CodeableConcept
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
54. Encounter.priority
Definition | Indicates the urgency of the encounter.
Short | Indicates the urgency of the encounter
Control | 0..1
Binding | For example codes, see ActPriority (example to `http://terminology.hl7.org/ValueSet/v3-ActPriority` ) Indicates the urgency of the encounter.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
56. Encounter.subject
Definition | The patient or group present at the encounter.
Short | The patient or group present at the encounter
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).
Control | 1..1
Type | Reference(De-Identified UDS Plus Patient)
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
58. Encounter.subject.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
60. Encounter.subject.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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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.subject.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
62. Encounter.subject.reference
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Short | Literal reference, Relative, internal or absolute URL
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Control | 0..1 This element is affected by the following invariants: ref-1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
64. Encounter.subject.type
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Short | Type the reference refers to (e.g. "Patient")
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to `http://hl7.org/fhir/ValueSet/resource-types` ) Aa resource (or, for logical models, the URI of the logical model).
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
66. Encounter.subject.identifier
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Short | Logical reference, when literal reference is not known
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
68. Encounter.subject.display
Definition | Plain text narrative that identifies the resource in addition to the resource reference.
Short | Text alternative for the resource
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Control | 0..0
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
70. 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).
Short | Episode(s) of care that this encounter should be recorded against
Control | 0..*
Type | Reference(EpisodeOfCare)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
72. Encounter.basedOn
Definition | The request this encounter satisfies (e.g. incoming referral or procedure request).
Short | The ServiceRequest that initiated this encounter
Control | 0..*
Type | Reference(ServiceRequest)
Is Modifier | false
Summary | false
Alternate Names | incomingReferral
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
74. Encounter.participant
Definition | The list of people responsible for providing the service.
Short | List of participants involved in the encounter
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
76. Encounter.participant.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
78. Encounter.participant.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
80. Encounter.participant.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).
Short | Extensions that cannot be ignored even if unrecognized
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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, modifiers
Invariants | 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()`)
82. Encounter.participant.type
Definition | Role of participant in encounter.
Short | Role of participant in encounter
Comments | The 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.
Control | 0..*
Binding | Unless not suitable, these codes SHALL be taken from ParticipantType (extensible to `http://hl7.org/fhir/ValueSet/encounter-participant-type` ) Role of participant in encounter.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
84. Encounter.participant.period
Definition | The period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period.
Short | Period of time during the encounter that the participant participated
Control | 0..1
Type | Period
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) uds-plus-enc-1: All Period.start data elements should be truncated to a year only for de-identified resources. (`$this is Period and $this.start.exists() implies $this.start.toString().length() = 4`) uds-plus-enc-1a: All Period.start data elements should have valid year > 1900 (`$this is Period and Period.start.exists() implies $this.start.toString() >= '1900'`) uds-plus-enc-1b: All Period.start data elements should have valid year < 2030 (`$this is Period and Period.start.exists() implies $this.start.toString() <= '2030'`) uds-plus-enc-2: All Period.emd data elements should be truncated to a year only for de-identified resources. (`$this is Period and $this.end.exists() implies $this.end.toString().length() = 4`) uds-plus-enc-2a: All Period.end data elements should have valid year > 1900 (`$this is Period and Period.end.exists() implies $this.end.toString() >= '1900'`) uds-plus-enc-2b: All Period.end data elements should have valid year < 2030 (`$this is Period and Period.end.exists() implies $this.end.toString() <= '2030'`)
86. Encounter.participant.individual
Definition | Persons involved in the encounter other than the patient.
Short | Persons involved in the encounter other than the patient
Control | 0..1
Type | Reference(US Core Practitioner Profile)
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
88. Encounter.appointment
Definition | The appointment that scheduled this encounter.
Short | The appointment that scheduled this encounter
Control | 0..*
Type | Reference(Appointment)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
90. Encounter.period
Definition | The start and end time of the encounter.
Short | The start and end time of the encounter
Comments | If not (yet) known, the end of the Period may be omitted.
Control | 0..1
Type | Period
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) uds-plus-enc-3: All Period.start data elements should be truncated to a year only for de-identified resources. (`$this is Period and $this.start.exists() implies $this.start.toString().length() = 4`) uds-plus-enc-3a: All Period.start data elements should have valid year > 1900 (`$this is Period and Period.start.exists() implies $this.start.toString() >= '1900'`) uds-plus-enc-3b: All Period.start data elements should have valid year < 2030 (`$this is Period and Period.start.exists() implies $this.start.toString() <= '2030'`) uds-plus-enc-4: All Period.emd data elements should be truncated to a year only for de-identified resources. (`$this is Period and $this.end.exists() implies $this.end.toString().length() = 4`) uds-plus-enc-4a: All Period.end data elements should have valid year > 1900 (`$this is Period and Period.end.exists() implies $this.end.toString() >= '1900'`) uds-plus-enc-4b: All Period.end data elements should have valid year < 2030 (`$this is Period and Period.end.exists() implies $this.end.toString() <= '2030'`)
92. Encounter.length
Definition | Quantity of time the encounter lasted. This excludes the time during leaves of absence.
Short | Quantity of time the encounter lasted (less time absent)
Comments | May differ from the time the Encounter.period lasted because of leave of absence.
Control | 0..1
Type | Duration
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
94. Encounter.reasonCode
Definition | Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
Short | Coded reason the encounter takes place
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).
Control | 0..*
Binding | The codes SHOULD be taken from EncounterReasonCodes (preferred to `http://hl7.org/fhir/ValueSet/encounter-reason` ) Reason why the encounter takes place.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | Indication, Admission diagnosis
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
96. Encounter.reasonReference
Definition | Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
Short | Reason the encounter takes place (reference)
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).
Control | 0..*
Type | Reference(De-Identified UDS Plus Diagnosis)
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | Indication, Admission diagnosis
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
98. Encounter.diagnosis
Definition | The list of diagnosis relevant to this encounter.
Short | The list of diagnosis relevant to this encounter
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
100. Encounter.diagnosis.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
102. Encounter.diagnosis.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
104. Encounter.diagnosis.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).
Short | Extensions that cannot be ignored even if unrecognized
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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, modifiers
Invariants | 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()`)
106. Encounter.diagnosis.condition
Definition | Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
Short | The diagnosis or procedure relevant to the encounter
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).
Control | 1..1
Type | Reference(De-Identified UDS Plus Diagnosis)
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | Admission diagnosis, discharge diagnosis, indication
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
108. Encounter.diagnosis.use
Definition | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …).
Short | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Control | 0..1
Binding | The codes SHOULD be taken from DiagnosisRole (preferred to `http://hl7.org/fhir/ValueSet/diagnosis-role` ) The type of diagnosis this condition represents.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
110. Encounter.diagnosis.rank
Definition | Ranking of the diagnosis (for each role type).
Short | Ranking of the diagnosis (for each role type)
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
112. Encounter.account
Definition | The set of accounts that may be used for billing for this Encounter.
Short | The set of accounts that may be used for billing for this Encounter
Comments | The billing system may choose to allocate billable items associated with the Encounter to different referenced Accounts based on internal business rules.
Control | 0..*
Type | Reference(Account)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
114. Encounter.hospitalization
Definition | Details about the admission to a healthcare service.
Short | Details about the admission to a healthcare service
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.
Control | 0..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
116. Encounter.hospitalization.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
118. Encounter.hospitalization.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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
120. Encounter.hospitalization.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).
Short | Extensions that cannot be ignored even if unrecognized
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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, modifiers
Invariants | 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()`)
122. Encounter.hospitalization.preAdmissionIdentifier
Definition | Pre-admission identifier.
Short | Pre-admission identifier
Control | 0..1
Type | Identifier
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
124. Encounter.hospitalization.origin
Definition | The location/organization from which the patient came before admission.
Short | The location/organization from which the patient came before admission
Control | 0..1
Type | Reference(Location, Organization)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
126. Encounter.hospitalization.admitSource
Definition | From where patient was admitted (physician referral, transfer).
Short | From where patient was admitted (physician referral, transfer)
Control | 0..1
Binding | The codes SHOULD be taken from AdmitSource (preferred to `http://hl7.org/fhir/ValueSet/encounter-admit-source` ) From where the patient was admitted.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
128. Encounter.hospitalization.reAdmission
Definition | Whether this hospitalization is a readmission and why if known.
Short | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Control | 0..1
Binding | For example codes, see hl7VS-re-admissionIndicator (example to `http://terminology.hl7.org/ValueSet/v2-0092` ) The reason for re-admission of this hospitalization encounter.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
130. Encounter.hospitalization.dietPreference
Definition | Diet preferences reported by the patient.
Short | Diet preferences reported by the patient
Comments | For example, a patient may request both a dairy-free and nut-free diet preference (not mutually exclusive).
Control | 0..*
Binding | For example codes, see Diet (example to `http://hl7.org/fhir/ValueSet/encounter-diet` ) Medical, cultural or ethical food preferences to help with catering requirements.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Used to track patient's diet restrictions and/or preference. For a complete description of the nutrition needs of a patient during their stay, one should use the nutritionOrder resource which links to Encounter.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
132. Encounter.hospitalization.specialCourtesy
Definition | Special courtesies (VIP, board member).
Short | Special courtesies (VIP, board member)
Control | 0..*
Binding | The codes SHOULD be taken from SpecialCourtesy (preferred to `http://hl7.org/fhir/ValueSet/encounter-special-courtesy` ) Special courtesies.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
134. Encounter.hospitalization.specialArrangement
Definition | Any special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things.
Short | Wheelchair, translator, stretcher, etc.
Control | 0..*
Binding | The codes SHOULD be taken from SpecialArrangements (preferred to `http://hl7.org/fhir/ValueSet/encounter-special-arrangements` ) Special arrangements.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
136. Encounter.hospitalization.destination
Definition | Location/organization to which the patient is discharged.
Short | Location/organization to which the patient is discharged
Control | 0..1
Type | Reference(Location, Organization)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
138. Encounter.hospitalization.dischargeDisposition
Definition | Category or kind of location after discharge.
Short | Category or kind of location after discharge
Control | 0..1
Binding | The codes SHOULD be taken from US Core Discharge Disposition (preferred to `http://hl7.org/fhir/us/core/ValueSet/us-core-discharge-disposition` ) The set of codes indicating the discharge disposition
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
140. Encounter.location
Definition | List of locations where the patient has been during this encounter.
Short | List of locations where the patient has been
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".
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
142. Encounter.location.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
144. Encounter.location.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | 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()`)
146. Encounter.location.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).
Short | Extensions that cannot be ignored even if unrecognized
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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, modifiers
Invariants | 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()`)
148. Encounter.location.location
Definition | The location where the encounter takes place.
Short | Location the encounter takes place
Control | 1..1
Type | Reference(UDS Plus Location)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
150. Encounter.location.status
Definition | The status of the participants' presence at the specified location during the period specified. If the participant is no longer at the location, then the period will have an end date/time.
Short | planned | active | reserved | completed
Comments | When the patient is no longer active at a location, then the period end date is entered, and the status may be changed to completed.
Control | 0..1
Binding | The codes SHALL be taken from EncounterLocationStatus (required to `http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1` ) The status of the location.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
152. Encounter.location.physicalType
Definition | This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query.
Short | The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Comments | This information is de-normalized from the Location resource to support the easier understanding of the encounter resource and processing in messaging or query. There may be many levels in the hierachy, and this may only pic specific levels that are required for a specific usage scenario.
Control | 0..1
Binding | For example codes, see LocationType (example to `http://hl7.org/fhir/ValueSet/location-physical-type` ) Physical form of the location.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
154. Encounter.location.period
Definition | Time period during which the patient was present at the location.
Short | Time period during which the patient was present at the location
Control | 0..1
Type | Period
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
156. 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.
Short | The organization (facility) responsible for this encounter
Control | 0..1
Type | Reference(US Core Organization Profile)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
158. Encounter.partOf
Definition | Another Encounter of which this encounter is a part of (administratively or in time).
Short | Another Encounter this encounter is part of
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.
Control | 0..1
Type | Reference(Encounter)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)