US Veterans Health Administration FHIR Map Set Implementation Guide
1.10.0 - 251101 United States of America flag

US Veterans Health Administration FHIR Map Set Implementation Guide - Downloaded Version 1.10.0 See the Directory of published versions

Resource Profile: Encounter: Visit

Official URL: http://va.gov/fhir/StructureDefinition/EncounterVisit Version: 1.10.0
Active as of 2025-11-04 Computable Name: EncounterVisit

This StructureDefinition contains the maps for VistA file VISIT (9000010) to us-core-encounter.

See also the FHIR Shorthand.

Use Case Overview

Use Case: Encounter: Visit«us-core-encounter»EncounterVisitsubjectlocation[va-stop].locationlocation[va-loc].locationserviceProviderparticipant.individualPatientLocationLocationOrganizationPractitionerRole

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* USCoreEncounterProfile(5.0.1) An interaction during which services are provided to the patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:resource-serviceConnection S 0..1 (Complex) Extension
URL: http://va.gov/fhir/StructureDefinition/resource-serviceConnection
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://va.gov/fhir/StructureDefinition/resource-serviceConnection"
..... value[x] SC 0..1 Coding Value of extension
Binding: VSResourceServiceConnection (required)
Constraints: ev-14-2035, ev-14-2036
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:va-visitid SΣ 0..1 Identifier Identifier(s) by which this encounter is known

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://va.gov/identifiers/{sta3n}/9000010-15001
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:va-movement SΣ 0..1 Identifier Identifier(s) by which this encounter is known
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣC 1..1 uri The namespace for the identifier value
Constraints: ev-14-2241-1
Example General: http://www.acme.com/identifiers/patient
..... value SΣC 1..1 string The value that is unique
Constraints: ev-14-2241
Example General: 123456
... status ?!SΣC 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
Constraints: ev-14-430, ev-14-431, ev-14-432
... class SΣ 1..1 Coding Classification of patient encounter
Binding: encounterClass FHIR (required): see mapping VF_encounterClass
... type SΣC 1..* CodeableConcept Specific type of encounter
Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type
Constraints: ev-14-1615
.... coding Σ 0..* Coding Code defined by a terminology system
..... system SΣC 0..1 uri Identity of the terminology system
Constraints: ev-14-1615-1
..... code SΣC 0..1 code Symbol in syntax defined by the system
Constraints: ev-14-1615-2
..... display SΣC 0..1 string Representation defined by the system
Constraints: ev-14-1615-3
.... text SΣC 0..1 string Plain text representation of the concept
Constraints: ev-14-1615-4
... serviceType Σ 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
.... coding Σ 0..* Coding Code defined by a terminology system
..... system SΣ 0..1 uri Identity of the terminology system
Required Pattern: http://va.gov/terminology/VistADefinedTerms/9000010-.07
..... code SΣ 0..1 code Symbol in syntax defined by the system
... subject SΣ 1..1 Reference(Patient) The patient or group present at the encounter
... participant SΣ 0..* BackboneElement List of participants involved in the encounter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣC 0..* CodeableConcept Role of participant in encounter
Binding: encounterParticipationType FHIR (required): see mapping VF_encounterParticipationType
Constraints: ev-14-1854
.... period S 0..1 Period Period of time during the encounter that the participant participated
.... individual SΣC 0..1 Reference(Practitioner Role) Persons involved in the encounter other than the patient
Constraints: ev-14-1614
... period S 0..1 Period The start and end time of the encounter
.... start SΣC 0..1 dateTime Starting time with inclusive boundary
.... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... reasonCode SΣ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
.... coding Σ 0..* Coding Code defined by a terminology system
..... system SΣC 0..1 uri Identity of the terminology system
Constraints: ev-14-447-1
..... code SΣC 0..1 code Symbol in syntax defined by the system
Constraints: ev-14-447
... reasonReference SΣ 0..* Reference(US Core Condition Problems and Health Concerns Profile(7.0.0) S | US Core Condition Encounter Diagnosis Profile(7.0.0) S | US Core Procedure Profile(7.0.0) | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition SΣC 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
Constraints: ev-14-2244
.... use SC 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: EncounterDiagnosisUse FHIR (required): see mapping VF_EncounterDiagnosisUse
Constraints: ev-14-2245
... hospitalization S 0..1 BackboneElement Details about the admission to a healthcare service
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... dischargeDisposition S 0..1 CodeableConcept Category or kind of location after discharge
Binding: US Core Discharge Disposition (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17
... Slices for location S 0..* BackboneElement List of locations where the patient has been
Slice: Unordered, Open by value:$this
.... location:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... location S 1..1 Reference(Location) Location the encounter takes place
.... location:va-stop S 0..1 BackboneElement List of locations where the patient has been
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... location S 1..1 Reference(Location) Location the encounter takes place
.... location:va-loc S 0..1 BackboneElement List of locations where the patient has been
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... location S 1..1 Reference(Location) Location the encounter takes place
... serviceProvider S 0..1 Reference(Organization) The organization (facility) responsible for this encounter
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 0..1 uri The namespace for the identifier value
Required Pattern: http://va.gov/identifiers/4-99
..... value SΣ 0..1 string The value that is unique
Example General: 123456
.... display SΣ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.extension:resource-serviceConnection.​value[x] Base required VSResourceServiceConnection 📦1.10.0 This IG
Encounter.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.identifier:va-visitid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.identifier:va-movement.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base required encounterClass FHIR 📦1.10.0 This IG
Encounter.type Base extensible US Core Encounter Type 📦7.0.0 US Core v7.0
Encounter.serviceType Base example Service type 📦4.0.1 FHIR Std.
Encounter.participant.​type Base required encounterParticipationType FHIR 📦1.10.0 This IG
Encounter.reasonCode Base preferred Encounter Reason Codes 📦4.0.1 FHIR Std.
Encounter.diagnosis.​use Base required EncounterDiagnosisUse FHIR 📦1.10.0 This IG
Encounter.hospitalization.​dischargeDisposition Base preferred US Core Discharge Disposition 📦7.0.0 US Core v7.0
Encounter.serviceProvider.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Encounter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Encounter 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 error Encounter 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 error Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ev-14-430 best practice Encounter.status If (9000010-.01) is IMP, null or > now then fixed value #planned true
ev-14-431 best practice Encounter.status If (9000010-.01) is IMP, not null, < now, .18 null then fixed value #in-progress true
ev-14-432 best practice Encounter.status If (9000010-.18) is IMP, not null, < now then fixed value #finished true
ev-14-447 best practice Encounter.reasonCode.coding.code If {.03>9000010} 9000010.07-.12 = 'P' then source value from (9000010.07-.01 > 80-.01) true
ev-14-1614 best practice Encounter.participant.individual If {.03>9000010} then reference /PractitionerRole based on (9000010.06-.01 > 200-) true
ev-14-1615 best practice Encounter.type If {.03>9000010} Not admission record (rule not needed in examples we've seen) then source value from (9000010.18-.01 > 81-) true
ev-14-1854 best practice Encounter.participant.type If {.03>9000010} then terminologyMaps (9000010.06-.04) using VF_encounterParticipationType true
ev-14-2035 best practice Encounter.extension:resource-serviceConnection.value[x] If (409.68-.1 > 409.1-.01) is {.03>9000010} SERVICE CONNECTED then fixed value http://va.gov/fhir/vistaDefinedTerms/409.1#SC "Service Connected" true
ev-14-2036 best practice Encounter.extension:resource-serviceConnection.value[x] If (409.68-.1 > 409.1-.01) is {.03>9000010} Not SERVICE CONNECTED then fixed value http://va.gov/fhir/vistaDefinedTerms/409.1#NSC "Not Service Connected" true
ev-14-2241 best practice Encounter.identifier:va-movement.value If admission record (9000010-.07 = H) then source value from (405-.27) true
ev-14-2244 best practice Encounter.diagnosis.condition If {.03>9000010} then source value from (9000010.07-.01 > 80-) true
ev-14-2245 best practice Encounter.diagnosis.use If {.03>9000010} then terminologyMaps (9000010.07-.12) using VF_EncounterDiagnosisUse true
ev-14-1615-1 best practice Encounter.type.coding.system If {.03>9000010} Not admission record (rule not needed in examples we've seen) then fixed value http://www.ama-assn.org/go/cpt true
ev-14-1615-2 best practice Encounter.type.coding.code If {.03>9000010} Not admission record (rule not needed in examples we've seen) then source value from (9000010.18-.01 > 81-.01) true
ev-14-1615-3 best practice Encounter.type.coding.display If {.03>9000010} Not admission record (rule not needed in examples we've seen) then source value from (9000010.18-.01 > 81-2) true
ev-14-1615-4 best practice Encounter.type.text If {.03>9000010} Not admission record (rule not needed in examples we've seen) then source value from (9000010.18-.01 > 81-2) true
ev-14-2241-1 best practice Encounter.identifier:va-movement.system If admission record (9000010-.07 = H) then fixed value http://va.gov/identifiers/{sta3n}/405 true
ev-14-447-1 best practice Encounter.reasonCode.coding.system If {.03>9000010} 9000010.07-.12 = 'P' then fixed value urn:see-termmap-in-mapParameter true
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from USCoreEncounterProfile

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* USCoreEncounterProfile(5.0.1) An interaction during which services are provided to the patient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:resource-serviceConnection S 0..1 (Complex) Extension
URL: http://va.gov/fhir/StructureDefinition/resource-serviceConnection
..... value[x] SC 0..1 Coding Value of extension
Constraints: ev-14-2035, ev-14-2036
... Slices for identifier 0..* Identifier Identifier(s) by which this encounter is known
Slice: Unordered, Open by value:$this
.... identifier:va-visitid S 0..1 Identifier Identifier(s) by which this encounter is known
Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://va.gov/identifiers/{sta3n}/9000010-15001
..... system 1..1 uri The namespace for the identifier value
..... value 1..1 string The value that is unique
.... identifier:va-movement S 0..1 Identifier Identifier(s) by which this encounter is known
..... system C 1..1 uri The namespace for the identifier value
Constraints: ev-14-2241-1
..... value C 1..1 string The value that is unique
Constraints: ev-14-2241
... status C 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Constraints: ev-14-430, ev-14-431, ev-14-432
... type C 1..* CodeableConcept Specific type of encounter
Constraints: ev-14-1615
.... coding
..... system SC 0..1 uri Identity of the terminology system
Constraints: ev-14-1615-1
..... code SC 0..1 code Symbol in syntax defined by the system
Constraints: ev-14-1615-2
..... display SC 0..1 string Representation defined by the system
Constraints: ev-14-1615-3
.... text SC 0..1 string Plain text representation of the concept
Constraints: ev-14-1615-4
... serviceType
.... coding
..... system S 0..1 uri Identity of the terminology system
Required Pattern: http://va.gov/terminology/VistADefinedTerms/9000010-.07
..... code S 0..1 code Symbol in syntax defined by the system
... subject 1..1 Reference(Patient) The patient or group present at the encounter
... participant
.... type C 0..* CodeableConcept Role of participant in encounter
Binding: encounterParticipationType FHIR (required): see mapping VF_encounterParticipationType
Constraints: ev-14-1854
.... period 0..1 Period Period of time during the encounter that the participant participated
.... individual C 0..1 Reference(Practitioner Role) Persons involved in the encounter other than the patient
Constraints: ev-14-1614
... period
.... start S 0..1 dateTime Starting time with inclusive boundary
.... end S 0..1 dateTime End time with inclusive boundary, if not ongoing
... reasonCode
.... coding
..... system SC 0..1 uri Identity of the terminology system
Constraints: ev-14-447-1
..... code SC 0..1 code Symbol in syntax defined by the system
Constraints: ev-14-447
... diagnosis
.... condition SC 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
Constraints: ev-14-2244
.... use SC 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: EncounterDiagnosisUse FHIR (required): see mapping VF_EncounterDiagnosisUse
Constraints: ev-14-2245
... hospitalization 0..1 BackboneElement Details about the admission to a healthcare service
... Slices for location 0..* BackboneElement List of locations where the patient has been
Slice: Unordered, Open by value:$this
.... location:va-stop S 0..1 BackboneElement List of locations where the patient has been
..... location 1..1 Reference(Location) Location the encounter takes place
.... location:va-loc S 0..1 BackboneElement List of locations where the patient has been
..... location 1..1 Reference(Location) Location the encounter takes place
... serviceProvider 0..1 Reference(Organization) The organization (facility) responsible for this encounter
.... identifier
..... system S 0..1 uri The namespace for the identifier value
Required Pattern: http://va.gov/identifiers/4-99
..... value S 0..1 string The value that is unique
.... display S 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Encounter.class Base required encounterClass FHIR 📦1.10.0 This IG
Encounter.participant.​type Base required encounterParticipationType FHIR 📦1.10.0 This IG
Encounter.diagnosis.​use Base required EncounterDiagnosisUse FHIR 📦1.10.0 This IG

Constraints

Id Grade Path(s) Description Expression
ev-14-430 best practice Encounter.status If (9000010-.01) is IMP, null or > now then fixed value #planned true
ev-14-431 best practice Encounter.status If (9000010-.01) is IMP, not null, < now, .18 null then fixed value #in-progress true
ev-14-432 best practice Encounter.status If (9000010-.18) is IMP, not null, < now then fixed value #finished true
ev-14-447 best practice Encounter.reasonCode.coding.code If {.03>9000010} 9000010.07-.12 = 'P' then source value from (9000010.07-.01 > 80-.01) true
ev-14-1614 best practice Encounter.participant.individual If {.03>9000010} then reference /PractitionerRole based on (9000010.06-.01 > 200-) true
ev-14-1615 best practice Encounter.type If {.03>9000010} Not admission record (rule not needed in examples we've seen) then source value from (9000010.18-.01 > 81-) true
ev-14-1854 best practice Encounter.participant.type If {.03>9000010} then terminologyMaps (9000010.06-.04) using VF_encounterParticipationType true
ev-14-2035 best practice Encounter.extension:resource-serviceConnection.value[x] If (409.68-.1 > 409.1-.01) is {.03>9000010} SERVICE CONNECTED then fixed value http://va.gov/fhir/vistaDefinedTerms/409.1#SC "Service Connected" true
ev-14-2036 best practice Encounter.extension:resource-serviceConnection.value[x] If (409.68-.1 > 409.1-.01) is {.03>9000010} Not SERVICE CONNECTED then fixed value http://va.gov/fhir/vistaDefinedTerms/409.1#NSC "Not Service Connected" true
ev-14-2241 best practice Encounter.identifier:va-movement.value If admission record (9000010-.07 = H) then source value from (405-.27) true
ev-14-2244 best practice Encounter.diagnosis.condition If {.03>9000010} then source value from (9000010.07-.01 > 80-) true
ev-14-2245 best practice Encounter.diagnosis.use If {.03>9000010} then terminologyMaps (9000010.07-.12) using VF_EncounterDiagnosisUse true
ev-14-1615-1 best practice Encounter.type.coding.system If {.03>9000010} Not admission record (rule not needed in examples we've seen) then fixed value http://www.ama-assn.org/go/cpt true
ev-14-1615-2 best practice Encounter.type.coding.code If {.03>9000010} Not admission record (rule not needed in examples we've seen) then source value from (9000010.18-.01 > 81-.01) true
ev-14-1615-3 best practice Encounter.type.coding.display If {.03>9000010} Not admission record (rule not needed in examples we've seen) then source value from (9000010.18-.01 > 81-2) true
ev-14-1615-4 best practice Encounter.type.text If {.03>9000010} Not admission record (rule not needed in examples we've seen) then source value from (9000010.18-.01 > 81-2) true
ev-14-2241-1 best practice Encounter.identifier:va-movement.system If admission record (9000010-.07 = H) then fixed value http://va.gov/identifiers/{sta3n}/405 true
ev-14-447-1 best practice Encounter.reasonCode.coding.system If {.03>9000010} 9000010.07-.12 = 'P' then fixed value urn:see-termmap-in-mapParameter true
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* USCoreEncounterProfile(5.0.1) An interaction during which services are provided to the patient
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:resource-serviceConnection S 0..1 (Complex) Extension
URL: http://va.gov/fhir/StructureDefinition/resource-serviceConnection
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://va.gov/fhir/StructureDefinition/resource-serviceConnection"
..... value[x] SC 0..1 Coding Value of extension
Binding: VSResourceServiceConnection (required)
Constraints: ev-14-2035, ev-14-2036
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier Identifier(s) by which this encounter is known
Slice: Unordered, Open by value:$this
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:va-visitid SΣ 0..1 Identifier Identifier(s) by which this encounter is known

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://va.gov/identifiers/{sta3n}/9000010-15001
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:va-movement SΣ 0..1 Identifier Identifier(s) by which this encounter is known
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣC 1..1 uri The namespace for the identifier value
Constraints: ev-14-2241-1
Example General: http://www.acme.com/identifiers/patient
..... value SΣC 1..1 string The value that is unique
Constraints: ev-14-2241
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣC 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
Constraints: ev-14-430, ev-14-431, ev-14-432
... statusHistory 0..* BackboneElement List of past encounter statuses
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
.... period 1..1 Period The time that the episode was in the specified status
... class SΣ 1..1 Coding Classification of patient encounter
Binding: encounterClass FHIR (required): see mapping VF_encounterClass
... classHistory 0..* BackboneElement List of past encounter classes
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.
.... period 1..1 Period The time that the episode was in the specified class
... type SΣC 1..* CodeableConcept Specific type of encounter
Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type
Constraints: ev-14-1615
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 0..1 uri Identity of the terminology system
Constraints: ev-14-1615-1
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣC 0..1 code Symbol in syntax defined by the system
Constraints: ev-14-1615-2
..... display SΣC 0..1 string Representation defined by the system
Constraints: ev-14-1615-3
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣC 0..1 string Plain text representation of the concept
Constraints: ev-14-1615-4
... serviceType Σ 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 0..1 uri Identity of the terminology system
Required Pattern: http://va.gov/terminology/VistADefinedTerms/9000010-.07
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.
... subject SΣ 1..1 Reference(Patient) The patient or group present at the encounter
... episodeOfCare Σ 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
... basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
... participant SΣ 0..* BackboneElement List of participants involved in the encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣC 0..* CodeableConcept Role of participant in encounter
Binding: encounterParticipationType FHIR (required): see mapping VF_encounterParticipationType
Constraints: ev-14-1854
.... period S 0..1 Period Period of time during the encounter that the participant participated
.... individual SΣC 0..1 Reference(Practitioner Role) Persons involved in the encounter other than the patient
Constraints: ev-14-1614
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
... period S 0..1 Period The start and end time of the encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC 0..1 dateTime Starting time with inclusive boundary
.... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... reasonCode SΣ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 0..1 uri Identity of the terminology system
Constraints: ev-14-447-1
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣC 0..1 code Symbol in syntax defined by the system
Constraints: ev-14-447
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... reasonReference SΣ 0..* Reference(US Core Condition Problems and Health Concerns Profile(7.0.0) S | US Core Condition Encounter Diagnosis Profile(7.0.0) S | US Core Procedure Profile(7.0.0) | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition SΣC 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
Constraints: ev-14-2244
.... use SC 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: EncounterDiagnosisUse FHIR (required): see mapping VF_EncounterDiagnosisUse
Constraints: ev-14-2245
.... rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
... account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
... hospitalization S 0..1 BackboneElement Details about the admission to a healthcare service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
.... admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.
.... reAdmission 0..1 CodeableConcept The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
.... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
.... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
.... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.
.... destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
.... dischargeDisposition S 0..1 CodeableConcept Category or kind of location after discharge
Binding: US Core Discharge Disposition (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17
... Slices for location S 0..* BackboneElement List of locations where the patient has been
Slice: Unordered, Open by value:$this
.... location:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... location S 1..1 Reference(Location) Location the encounter takes place
..... status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
..... physicalType 0..1 CodeableConcept The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example): Physical form of the location.
..... period 0..1 Period Time period during which the patient was present at the location
.... location:va-stop S 0..1 BackboneElement List of locations where the patient has been
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... location S 1..1 Reference(Location) Location the encounter takes place
..... status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
..... physicalType 0..1 CodeableConcept The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example): Physical form of the location.
..... period 0..1 Period Time period during which the patient was present at the location
.... location:va-loc S 0..1 BackboneElement List of locations where the patient has been
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... location S 1..1 Reference(Location) Location the encounter takes place
..... status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
..... physicalType 0..1 CodeableConcept The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example): Physical form of the location.
..... period 0..1 Period Time period during which the patient was present at the location
... serviceProvider S 0..1 Reference(Organization) The organization (facility) responsible for this encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 0..1 uri The namespace for the identifier value
Required Pattern: http://va.gov/identifiers/4-99
..... value SΣ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... display SΣ 0..1 string Text alternative for the resource
... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Encounter.extension:resource-serviceConnection.​value[x] Base required VSResourceServiceConnection 📦1.10.0 This IG
Encounter.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.identifier.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Encounter.identifier:va-visitid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.identifier:va-visitid.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Encounter.identifier:va-movement.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.identifier:va-movement.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.statusHistory.​status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base required encounterClass FHIR 📦1.10.0 This IG
Encounter.classHistory.​class Base extensible ActEncounterCode 📦3.0.0 THO v6.5
Encounter.type Base extensible US Core Encounter Type 📦7.0.0 US Core v7.0
Encounter.serviceType Base example Service type 📦4.0.1 FHIR Std.
Encounter.priority Base example ActPriority 📦3.0.0 THO v6.5
Encounter.participant.​type Base required encounterParticipationType FHIR 📦1.10.0 This IG
Encounter.reasonCode Base preferred Encounter Reason Codes 📦4.0.1 FHIR Std.
Encounter.diagnosis.​use Base required EncounterDiagnosisUse FHIR 📦1.10.0 This IG
Encounter.hospitalization.​admitSource Base preferred Admit source 📦4.0.1 FHIR Std.
Encounter.hospitalization.​reAdmission Base example hl7VS-re-admissionIndicator 📦2.0.0 THO v6.5
Encounter.hospitalization.​dietPreference Base example Diet 📦4.0.1 FHIR Std.
Encounter.hospitalization.​specialCourtesy Base preferred Special courtesy 📦4.0.1 FHIR Std.
Encounter.hospitalization.​specialArrangement Base preferred Special arrangements 📦4.0.1 FHIR Std.
Encounter.hospitalization.​dischargeDisposition Base preferred US Core Discharge Disposition 📦7.0.0 US Core v7.0
Encounter.location.status Base required EncounterLocationStatus 📍4.0.1 FHIR Std.
Encounter.location.physicalType Base example Location type 📦4.0.1 FHIR Std.
Encounter.location:va-stop.​status Base required EncounterLocationStatus 📍4.0.1 FHIR Std.
Encounter.location:va-stop.​physicalType Base example Location type 📦4.0.1 FHIR Std.
Encounter.location:va-loc.​status Base required EncounterLocationStatus 📍4.0.1 FHIR Std.
Encounter.location:va-loc.​physicalType Base example Location type 📦4.0.1 FHIR Std.
Encounter.serviceProvider.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Encounter.serviceProvider.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.serviceProvider.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Encounter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Encounter 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 error Encounter 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 error Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ev-14-430 best practice Encounter.status If (9000010-.01) is IMP, null or > now then fixed value #planned true
ev-14-431 best practice Encounter.status If (9000010-.01) is IMP, not null, < now, .18 null then fixed value #in-progress true
ev-14-432 best practice Encounter.status If (9000010-.18) is IMP, not null, < now then fixed value #finished true
ev-14-447 best practice Encounter.reasonCode.coding.code If {.03>9000010} 9000010.07-.12 = 'P' then source value from (9000010.07-.01 > 80-.01) true
ev-14-1614 best practice Encounter.participant.individual If {.03>9000010} then reference /PractitionerRole based on (9000010.06-.01 > 200-) true
ev-14-1615 best practice Encounter.type If {.03>9000010} Not admission record (rule not needed in examples we've seen) then source value from (9000010.18-.01 > 81-) true
ev-14-1854 best practice Encounter.participant.type If {.03>9000010} then terminologyMaps (9000010.06-.04) using VF_encounterParticipationType true
ev-14-2035 best practice Encounter.extension:resource-serviceConnection.value[x] If (409.68-.1 > 409.1-.01) is {.03>9000010} SERVICE CONNECTED then fixed value http://va.gov/fhir/vistaDefinedTerms/409.1#SC "Service Connected" true
ev-14-2036 best practice Encounter.extension:resource-serviceConnection.value[x] If (409.68-.1 > 409.1-.01) is {.03>9000010} Not SERVICE CONNECTED then fixed value http://va.gov/fhir/vistaDefinedTerms/409.1#NSC "Not Service Connected" true
ev-14-2241 best practice Encounter.identifier:va-movement.value If admission record (9000010-.07 = H) then source value from (405-.27) true
ev-14-2244 best practice Encounter.diagnosis.condition If {.03>9000010} then source value from (9000010.07-.01 > 80-) true
ev-14-2245 best practice Encounter.diagnosis.use If {.03>9000010} then terminologyMaps (9000010.07-.12) using VF_EncounterDiagnosisUse true
ev-14-1615-1 best practice Encounter.type.coding.system If {.03>9000010} Not admission record (rule not needed in examples we've seen) then fixed value http://www.ama-assn.org/go/cpt true
ev-14-1615-2 best practice Encounter.type.coding.code If {.03>9000010} Not admission record (rule not needed in examples we've seen) then source value from (9000010.18-.01 > 81-.01) true
ev-14-1615-3 best practice Encounter.type.coding.display If {.03>9000010} Not admission record (rule not needed in examples we've seen) then source value from (9000010.18-.01 > 81-2) true
ev-14-1615-4 best practice Encounter.type.text If {.03>9000010} Not admission record (rule not needed in examples we've seen) then source value from (9000010.18-.01 > 81-2) true
ev-14-2241-1 best practice Encounter.identifier:va-movement.system If admission record (9000010-.07 = H) then fixed value http://va.gov/identifiers/{sta3n}/405 true
ev-14-447-1 best practice Encounter.reasonCode.coding.system If {.03>9000010} 9000010.07-.12 = 'P' then fixed value urn:see-termmap-in-mapParameter true
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from USCoreEncounterProfile

Summary

Must-Support: 21 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Encounter.identifier
  • The element 1 is sliced based on the value of Encounter.location

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* USCoreEncounterProfile(5.0.1) An interaction during which services are provided to the patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:resource-serviceConnection S 0..1 (Complex) Extension
URL: http://va.gov/fhir/StructureDefinition/resource-serviceConnection
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://va.gov/fhir/StructureDefinition/resource-serviceConnection"
..... value[x] SC 0..1 Coding Value of extension
Binding: VSResourceServiceConnection (required)
Constraints: ev-14-2035, ev-14-2036
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:va-visitid SΣ 0..1 Identifier Identifier(s) by which this encounter is known

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://va.gov/identifiers/{sta3n}/9000010-15001
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:va-movement SΣ 0..1 Identifier Identifier(s) by which this encounter is known
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣC 1..1 uri The namespace for the identifier value
Constraints: ev-14-2241-1
Example General: http://www.acme.com/identifiers/patient
..... value SΣC 1..1 string The value that is unique
Constraints: ev-14-2241
Example General: 123456
... status ?!SΣC 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
Constraints: ev-14-430, ev-14-431, ev-14-432
... class SΣ 1..1 Coding Classification of patient encounter
Binding: encounterClass FHIR (required): see mapping VF_encounterClass
... type SΣC 1..* CodeableConcept Specific type of encounter
Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type
Constraints: ev-14-1615
.... coding Σ 0..* Coding Code defined by a terminology system
..... system SΣC 0..1 uri Identity of the terminology system
Constraints: ev-14-1615-1
..... code SΣC 0..1 code Symbol in syntax defined by the system
Constraints: ev-14-1615-2
..... display SΣC 0..1 string Representation defined by the system
Constraints: ev-14-1615-3
.... text SΣC 0..1 string Plain text representation of the concept
Constraints: ev-14-1615-4
... serviceType Σ 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
.... coding Σ 0..* Coding Code defined by a terminology system
..... system SΣ 0..1 uri Identity of the terminology system
Required Pattern: http://va.gov/terminology/VistADefinedTerms/9000010-.07
..... code SΣ 0..1 code Symbol in syntax defined by the system
... subject SΣ 1..1 Reference(Patient) The patient or group present at the encounter
... participant SΣ 0..* BackboneElement List of participants involved in the encounter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣC 0..* CodeableConcept Role of participant in encounter
Binding: encounterParticipationType FHIR (required): see mapping VF_encounterParticipationType
Constraints: ev-14-1854
.... period S 0..1 Period Period of time during the encounter that the participant participated
.... individual SΣC 0..1 Reference(Practitioner Role) Persons involved in the encounter other than the patient
Constraints: ev-14-1614
... period S 0..1 Period The start and end time of the encounter
.... start SΣC 0..1 dateTime Starting time with inclusive boundary
.... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... reasonCode SΣ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
.... coding Σ 0..* Coding Code defined by a terminology system
..... system SΣC 0..1 uri Identity of the terminology system
Constraints: ev-14-447-1
..... code SΣC 0..1 code Symbol in syntax defined by the system
Constraints: ev-14-447
... reasonReference SΣ 0..* Reference(US Core Condition Problems and Health Concerns Profile(7.0.0) S | US Core Condition Encounter Diagnosis Profile(7.0.0) S | US Core Procedure Profile(7.0.0) | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition SΣC 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
Constraints: ev-14-2244
.... use SC 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: EncounterDiagnosisUse FHIR (required): see mapping VF_EncounterDiagnosisUse
Constraints: ev-14-2245
... hospitalization S 0..1 BackboneElement Details about the admission to a healthcare service
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... dischargeDisposition S 0..1 CodeableConcept Category or kind of location after discharge
Binding: US Core Discharge Disposition (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17
... Slices for location S 0..* BackboneElement List of locations where the patient has been
Slice: Unordered, Open by value:$this
.... location:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... location S 1..1 Reference(Location) Location the encounter takes place
.... location:va-stop S 0..1 BackboneElement List of locations where the patient has been
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... location S 1..1 Reference(Location) Location the encounter takes place
.... location:va-loc S 0..1 BackboneElement List of locations where the patient has been
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... location S 1..1 Reference(Location) Location the encounter takes place
... serviceProvider S 0..1 Reference(Organization) The organization (facility) responsible for this encounter
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 0..1 uri The namespace for the identifier value
Required Pattern: http://va.gov/identifiers/4-99
..... value SΣ 0..1 string The value that is unique
Example General: 123456
.... display SΣ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.extension:resource-serviceConnection.​value[x] Base required VSResourceServiceConnection 📦1.10.0 This IG
Encounter.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.identifier:va-visitid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.identifier:va-movement.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base required encounterClass FHIR 📦1.10.0 This IG
Encounter.type Base extensible US Core Encounter Type 📦7.0.0 US Core v7.0
Encounter.serviceType Base example Service type 📦4.0.1 FHIR Std.
Encounter.participant.​type Base required encounterParticipationType FHIR 📦1.10.0 This IG
Encounter.reasonCode Base preferred Encounter Reason Codes 📦4.0.1 FHIR Std.
Encounter.diagnosis.​use Base required EncounterDiagnosisUse FHIR 📦1.10.0 This IG
Encounter.hospitalization.​dischargeDisposition Base preferred US Core Discharge Disposition 📦7.0.0 US Core v7.0
Encounter.serviceProvider.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Encounter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Encounter 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 error Encounter 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 error Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ev-14-430 best practice Encounter.status If (9000010-.01) is IMP, null or > now then fixed value #planned true
ev-14-431 best practice Encounter.status If (9000010-.01) is IMP, not null, < now, .18 null then fixed value #in-progress true
ev-14-432 best practice Encounter.status If (9000010-.18) is IMP, not null, < now then fixed value #finished true
ev-14-447 best practice Encounter.reasonCode.coding.code If {.03>9000010} 9000010.07-.12 = 'P' then source value from (9000010.07-.01 > 80-.01) true
ev-14-1614 best practice Encounter.participant.individual If {.03>9000010} then reference /PractitionerRole based on (9000010.06-.01 > 200-) true
ev-14-1615 best practice Encounter.type If {.03>9000010} Not admission record (rule not needed in examples we've seen) then source value from (9000010.18-.01 > 81-) true
ev-14-1854 best practice Encounter.participant.type If {.03>9000010} then terminologyMaps (9000010.06-.04) using VF_encounterParticipationType true
ev-14-2035 best practice Encounter.extension:resource-serviceConnection.value[x] If (409.68-.1 > 409.1-.01) is {.03>9000010} SERVICE CONNECTED then fixed value http://va.gov/fhir/vistaDefinedTerms/409.1#SC "Service Connected" true
ev-14-2036 best practice Encounter.extension:resource-serviceConnection.value[x] If (409.68-.1 > 409.1-.01) is {.03>9000010} Not SERVICE CONNECTED then fixed value http://va.gov/fhir/vistaDefinedTerms/409.1#NSC "Not Service Connected" true
ev-14-2241 best practice Encounter.identifier:va-movement.value If admission record (9000010-.07 = H) then source value from (405-.27) true
ev-14-2244 best practice Encounter.diagnosis.condition If {.03>9000010} then source value from (9000010.07-.01 > 80-) true
ev-14-2245 best practice Encounter.diagnosis.use If {.03>9000010} then terminologyMaps (9000010.07-.12) using VF_EncounterDiagnosisUse true
ev-14-1615-1 best practice Encounter.type.coding.system If {.03>9000010} Not admission record (rule not needed in examples we've seen) then fixed value http://www.ama-assn.org/go/cpt true
ev-14-1615-2 best practice Encounter.type.coding.code If {.03>9000010} Not admission record (rule not needed in examples we've seen) then source value from (9000010.18-.01 > 81-.01) true
ev-14-1615-3 best practice Encounter.type.coding.display If {.03>9000010} Not admission record (rule not needed in examples we've seen) then source value from (9000010.18-.01 > 81-2) true
ev-14-1615-4 best practice Encounter.type.text If {.03>9000010} Not admission record (rule not needed in examples we've seen) then source value from (9000010.18-.01 > 81-2) true
ev-14-2241-1 best practice Encounter.identifier:va-movement.system If admission record (9000010-.07 = H) then fixed value http://va.gov/identifiers/{sta3n}/405 true
ev-14-447-1 best practice Encounter.reasonCode.coding.system If {.03>9000010} 9000010.07-.12 = 'P' then fixed value urn:see-termmap-in-mapParameter true
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from USCoreEncounterProfile

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* USCoreEncounterProfile(5.0.1) An interaction during which services are provided to the patient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:resource-serviceConnection S 0..1 (Complex) Extension
URL: http://va.gov/fhir/StructureDefinition/resource-serviceConnection
..... value[x] SC 0..1 Coding Value of extension
Constraints: ev-14-2035, ev-14-2036
... Slices for identifier 0..* Identifier Identifier(s) by which this encounter is known
Slice: Unordered, Open by value:$this
.... identifier:va-visitid S 0..1 Identifier Identifier(s) by which this encounter is known
Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://va.gov/identifiers/{sta3n}/9000010-15001
..... system 1..1 uri The namespace for the identifier value
..... value 1..1 string The value that is unique
.... identifier:va-movement S 0..1 Identifier Identifier(s) by which this encounter is known
..... system C 1..1 uri The namespace for the identifier value
Constraints: ev-14-2241-1
..... value C 1..1 string The value that is unique
Constraints: ev-14-2241
... status C 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Constraints: ev-14-430, ev-14-431, ev-14-432
... type C 1..* CodeableConcept Specific type of encounter
Constraints: ev-14-1615
.... coding
..... system SC 0..1 uri Identity of the terminology system
Constraints: ev-14-1615-1
..... code SC 0..1 code Symbol in syntax defined by the system
Constraints: ev-14-1615-2
..... display SC 0..1 string Representation defined by the system
Constraints: ev-14-1615-3
.... text SC 0..1 string Plain text representation of the concept
Constraints: ev-14-1615-4
... serviceType
.... coding
..... system S 0..1 uri Identity of the terminology system
Required Pattern: http://va.gov/terminology/VistADefinedTerms/9000010-.07
..... code S 0..1 code Symbol in syntax defined by the system
... subject 1..1 Reference(Patient) The patient or group present at the encounter
... participant
.... type C 0..* CodeableConcept Role of participant in encounter
Binding: encounterParticipationType FHIR (required): see mapping VF_encounterParticipationType
Constraints: ev-14-1854
.... period 0..1 Period Period of time during the encounter that the participant participated
.... individual C 0..1 Reference(Practitioner Role) Persons involved in the encounter other than the patient
Constraints: ev-14-1614
... period
.... start S 0..1 dateTime Starting time with inclusive boundary
.... end S 0..1 dateTime End time with inclusive boundary, if not ongoing
... reasonCode
.... coding
..... system SC 0..1 uri Identity of the terminology system
Constraints: ev-14-447-1
..... code SC 0..1 code Symbol in syntax defined by the system
Constraints: ev-14-447
... diagnosis
.... condition SC 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
Constraints: ev-14-2244
.... use SC 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: EncounterDiagnosisUse FHIR (required): see mapping VF_EncounterDiagnosisUse
Constraints: ev-14-2245
... hospitalization 0..1 BackboneElement Details about the admission to a healthcare service
... Slices for location 0..* BackboneElement List of locations where the patient has been
Slice: Unordered, Open by value:$this
.... location:va-stop S 0..1 BackboneElement List of locations where the patient has been
..... location 1..1 Reference(Location) Location the encounter takes place
.... location:va-loc S 0..1 BackboneElement List of locations where the patient has been
..... location 1..1 Reference(Location) Location the encounter takes place
... serviceProvider 0..1 Reference(Organization) The organization (facility) responsible for this encounter
.... identifier
..... system S 0..1 uri The namespace for the identifier value
Required Pattern: http://va.gov/identifiers/4-99
..... value S 0..1 string The value that is unique
.... display S 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Encounter.class Base required encounterClass FHIR 📦1.10.0 This IG
Encounter.participant.​type Base required encounterParticipationType FHIR 📦1.10.0 This IG
Encounter.diagnosis.​use Base required EncounterDiagnosisUse FHIR 📦1.10.0 This IG

Constraints

Id Grade Path(s) Description Expression
ev-14-430 best practice Encounter.status If (9000010-.01) is IMP, null or > now then fixed value #planned true
ev-14-431 best practice Encounter.status If (9000010-.01) is IMP, not null, < now, .18 null then fixed value #in-progress true
ev-14-432 best practice Encounter.status If (9000010-.18) is IMP, not null, < now then fixed value #finished true
ev-14-447 best practice Encounter.reasonCode.coding.code If {.03>9000010} 9000010.07-.12 = 'P' then source value from (9000010.07-.01 > 80-.01) true
ev-14-1614 best practice Encounter.participant.individual If {.03>9000010} then reference /PractitionerRole based on (9000010.06-.01 > 200-) true
ev-14-1615 best practice Encounter.type If {.03>9000010} Not admission record (rule not needed in examples we've seen) then source value from (9000010.18-.01 > 81-) true
ev-14-1854 best practice Encounter.participant.type If {.03>9000010} then terminologyMaps (9000010.06-.04) using VF_encounterParticipationType true
ev-14-2035 best practice Encounter.extension:resource-serviceConnection.value[x] If (409.68-.1 > 409.1-.01) is {.03>9000010} SERVICE CONNECTED then fixed value http://va.gov/fhir/vistaDefinedTerms/409.1#SC "Service Connected" true
ev-14-2036 best practice Encounter.extension:resource-serviceConnection.value[x] If (409.68-.1 > 409.1-.01) is {.03>9000010} Not SERVICE CONNECTED then fixed value http://va.gov/fhir/vistaDefinedTerms/409.1#NSC "Not Service Connected" true
ev-14-2241 best practice Encounter.identifier:va-movement.value If admission record (9000010-.07 = H) then source value from (405-.27) true
ev-14-2244 best practice Encounter.diagnosis.condition If {.03>9000010} then source value from (9000010.07-.01 > 80-) true
ev-14-2245 best practice Encounter.diagnosis.use If {.03>9000010} then terminologyMaps (9000010.07-.12) using VF_EncounterDiagnosisUse true
ev-14-1615-1 best practice Encounter.type.coding.system If {.03>9000010} Not admission record (rule not needed in examples we've seen) then fixed value http://www.ama-assn.org/go/cpt true
ev-14-1615-2 best practice Encounter.type.coding.code If {.03>9000010} Not admission record (rule not needed in examples we've seen) then source value from (9000010.18-.01 > 81-.01) true
ev-14-1615-3 best practice Encounter.type.coding.display If {.03>9000010} Not admission record (rule not needed in examples we've seen) then source value from (9000010.18-.01 > 81-2) true
ev-14-1615-4 best practice Encounter.type.text If {.03>9000010} Not admission record (rule not needed in examples we've seen) then source value from (9000010.18-.01 > 81-2) true
ev-14-2241-1 best practice Encounter.identifier:va-movement.system If admission record (9000010-.07 = H) then fixed value http://va.gov/identifiers/{sta3n}/405 true
ev-14-447-1 best practice Encounter.reasonCode.coding.system If {.03>9000010} 9000010.07-.12 = 'P' then fixed value urn:see-termmap-in-mapParameter true

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* USCoreEncounterProfile(5.0.1) An interaction during which services are provided to the patient
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:resource-serviceConnection S 0..1 (Complex) Extension
URL: http://va.gov/fhir/StructureDefinition/resource-serviceConnection
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://va.gov/fhir/StructureDefinition/resource-serviceConnection"
..... value[x] SC 0..1 Coding Value of extension
Binding: VSResourceServiceConnection (required)
Constraints: ev-14-2035, ev-14-2036
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier Identifier(s) by which this encounter is known
Slice: Unordered, Open by value:$this
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:va-visitid SΣ 0..1 Identifier Identifier(s) by which this encounter is known

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://va.gov/identifiers/{sta3n}/9000010-15001
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:va-movement SΣ 0..1 Identifier Identifier(s) by which this encounter is known
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣC 1..1 uri The namespace for the identifier value
Constraints: ev-14-2241-1
Example General: http://www.acme.com/identifiers/patient
..... value SΣC 1..1 string The value that is unique
Constraints: ev-14-2241
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣC 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
Constraints: ev-14-430, ev-14-431, ev-14-432
... statusHistory 0..* BackboneElement List of past encounter statuses
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
.... period 1..1 Period The time that the episode was in the specified status
... class SΣ 1..1 Coding Classification of patient encounter
Binding: encounterClass FHIR (required): see mapping VF_encounterClass
... classHistory 0..* BackboneElement List of past encounter classes
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.
.... period 1..1 Period The time that the episode was in the specified class
... type SΣC 1..* CodeableConcept Specific type of encounter
Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type
Constraints: ev-14-1615
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 0..1 uri Identity of the terminology system
Constraints: ev-14-1615-1
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣC 0..1 code Symbol in syntax defined by the system
Constraints: ev-14-1615-2
..... display SΣC 0..1 string Representation defined by the system
Constraints: ev-14-1615-3
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣC 0..1 string Plain text representation of the concept
Constraints: ev-14-1615-4
... serviceType Σ 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 0..1 uri Identity of the terminology system
Required Pattern: http://va.gov/terminology/VistADefinedTerms/9000010-.07
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.
... subject SΣ 1..1 Reference(Patient) The patient or group present at the encounter
... episodeOfCare Σ 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
... basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
... participant SΣ 0..* BackboneElement List of participants involved in the encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣC 0..* CodeableConcept Role of participant in encounter
Binding: encounterParticipationType FHIR (required): see mapping VF_encounterParticipationType
Constraints: ev-14-1854
.... period S 0..1 Period Period of time during the encounter that the participant participated
.... individual SΣC 0..1 Reference(Practitioner Role) Persons involved in the encounter other than the patient
Constraints: ev-14-1614
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
... period S 0..1 Period The start and end time of the encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC 0..1 dateTime Starting time with inclusive boundary
.... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... reasonCode SΣ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 0..1 uri Identity of the terminology system
Constraints: ev-14-447-1
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣC 0..1 code Symbol in syntax defined by the system
Constraints: ev-14-447
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... reasonReference SΣ 0..* Reference(US Core Condition Problems and Health Concerns Profile(7.0.0) S | US Core Condition Encounter Diagnosis Profile(7.0.0) S | US Core Procedure Profile(7.0.0) | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition SΣC 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
Constraints: ev-14-2244
.... use SC 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: EncounterDiagnosisUse FHIR (required): see mapping VF_EncounterDiagnosisUse
Constraints: ev-14-2245
.... rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
... account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
... hospitalization S 0..1 BackboneElement Details about the admission to a healthcare service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
.... admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.
.... reAdmission 0..1 CodeableConcept The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
.... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
.... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
.... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.
.... destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
.... dischargeDisposition S 0..1 CodeableConcept Category or kind of location after discharge
Binding: US Core Discharge Disposition (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17
... Slices for location S 0..* BackboneElement List of locations where the patient has been
Slice: Unordered, Open by value:$this
.... location:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... location S 1..1 Reference(Location) Location the encounter takes place
..... status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
..... physicalType 0..1 CodeableConcept The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example): Physical form of the location.
..... period 0..1 Period Time period during which the patient was present at the location
.... location:va-stop S 0..1 BackboneElement List of locations where the patient has been
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... location S 1..1 Reference(Location) Location the encounter takes place
..... status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
..... physicalType 0..1 CodeableConcept The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example): Physical form of the location.
..... period 0..1 Period Time period during which the patient was present at the location
.... location:va-loc S 0..1 BackboneElement List of locations where the patient has been
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... location S 1..1 Reference(Location) Location the encounter takes place
..... status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
..... physicalType 0..1 CodeableConcept The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example): Physical form of the location.
..... period 0..1 Period Time period during which the patient was present at the location
... serviceProvider S 0..1 Reference(Organization) The organization (facility) responsible for this encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 0..1 uri The namespace for the identifier value
Required Pattern: http://va.gov/identifiers/4-99
..... value SΣ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... display SΣ 0..1 string Text alternative for the resource
... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Encounter.extension:resource-serviceConnection.​value[x] Base required VSResourceServiceConnection 📦1.10.0 This IG
Encounter.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.identifier.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Encounter.identifier:va-visitid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.identifier:va-visitid.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Encounter.identifier:va-movement.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.identifier:va-movement.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.statusHistory.​status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base required encounterClass FHIR 📦1.10.0 This IG
Encounter.classHistory.​class Base extensible ActEncounterCode 📦3.0.0 THO v6.5
Encounter.type Base extensible US Core Encounter Type 📦7.0.0 US Core v7.0
Encounter.serviceType Base example Service type 📦4.0.1 FHIR Std.
Encounter.priority Base example ActPriority 📦3.0.0 THO v6.5
Encounter.participant.​type Base required encounterParticipationType FHIR 📦1.10.0 This IG
Encounter.reasonCode Base preferred Encounter Reason Codes 📦4.0.1 FHIR Std.
Encounter.diagnosis.​use Base required EncounterDiagnosisUse FHIR 📦1.10.0 This IG
Encounter.hospitalization.​admitSource Base preferred Admit source 📦4.0.1 FHIR Std.
Encounter.hospitalization.​reAdmission Base example hl7VS-re-admissionIndicator 📦2.0.0 THO v6.5
Encounter.hospitalization.​dietPreference Base example Diet 📦4.0.1 FHIR Std.
Encounter.hospitalization.​specialCourtesy Base preferred Special courtesy 📦4.0.1 FHIR Std.
Encounter.hospitalization.​specialArrangement Base preferred Special arrangements 📦4.0.1 FHIR Std.
Encounter.hospitalization.​dischargeDisposition Base preferred US Core Discharge Disposition 📦7.0.0 US Core v7.0
Encounter.location.status Base required EncounterLocationStatus 📍4.0.1 FHIR Std.
Encounter.location.physicalType Base example Location type 📦4.0.1 FHIR Std.
Encounter.location:va-stop.​status Base required EncounterLocationStatus 📍4.0.1 FHIR Std.
Encounter.location:va-stop.​physicalType Base example Location type 📦4.0.1 FHIR Std.
Encounter.location:va-loc.​status Base required EncounterLocationStatus 📍4.0.1 FHIR Std.
Encounter.location:va-loc.​physicalType Base example Location type 📦4.0.1 FHIR Std.
Encounter.serviceProvider.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Encounter.serviceProvider.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.serviceProvider.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Encounter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Encounter 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 error Encounter 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 error Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ev-14-430 best practice Encounter.status If (9000010-.01) is IMP, null or > now then fixed value #planned true
ev-14-431 best practice Encounter.status If (9000010-.01) is IMP, not null, < now, .18 null then fixed value #in-progress true
ev-14-432 best practice Encounter.status If (9000010-.18) is IMP, not null, < now then fixed value #finished true
ev-14-447 best practice Encounter.reasonCode.coding.code If {.03>9000010} 9000010.07-.12 = 'P' then source value from (9000010.07-.01 > 80-.01) true
ev-14-1614 best practice Encounter.participant.individual If {.03>9000010} then reference /PractitionerRole based on (9000010.06-.01 > 200-) true
ev-14-1615 best practice Encounter.type If {.03>9000010} Not admission record (rule not needed in examples we've seen) then source value from (9000010.18-.01 > 81-) true
ev-14-1854 best practice Encounter.participant.type If {.03>9000010} then terminologyMaps (9000010.06-.04) using VF_encounterParticipationType true
ev-14-2035 best practice Encounter.extension:resource-serviceConnection.value[x] If (409.68-.1 > 409.1-.01) is {.03>9000010} SERVICE CONNECTED then fixed value http://va.gov/fhir/vistaDefinedTerms/409.1#SC "Service Connected" true
ev-14-2036 best practice Encounter.extension:resource-serviceConnection.value[x] If (409.68-.1 > 409.1-.01) is {.03>9000010} Not SERVICE CONNECTED then fixed value http://va.gov/fhir/vistaDefinedTerms/409.1#NSC "Not Service Connected" true
ev-14-2241 best practice Encounter.identifier:va-movement.value If admission record (9000010-.07 = H) then source value from (405-.27) true
ev-14-2244 best practice Encounter.diagnosis.condition If {.03>9000010} then source value from (9000010.07-.01 > 80-) true
ev-14-2245 best practice Encounter.diagnosis.use If {.03>9000010} then terminologyMaps (9000010.07-.12) using VF_EncounterDiagnosisUse true
ev-14-1615-1 best practice Encounter.type.coding.system If {.03>9000010} Not admission record (rule not needed in examples we've seen) then fixed value http://www.ama-assn.org/go/cpt true
ev-14-1615-2 best practice Encounter.type.coding.code If {.03>9000010} Not admission record (rule not needed in examples we've seen) then source value from (9000010.18-.01 > 81-.01) true
ev-14-1615-3 best practice Encounter.type.coding.display If {.03>9000010} Not admission record (rule not needed in examples we've seen) then source value from (9000010.18-.01 > 81-2) true
ev-14-1615-4 best practice Encounter.type.text If {.03>9000010} Not admission record (rule not needed in examples we've seen) then source value from (9000010.18-.01 > 81-2) true
ev-14-2241-1 best practice Encounter.identifier:va-movement.system If admission record (9000010-.07 = H) then fixed value http://va.gov/identifiers/{sta3n}/405 true
ev-14-447-1 best practice Encounter.reasonCode.coding.system If {.03>9000010} 9000010.07-.12 = 'P' then fixed value urn:see-termmap-in-mapParameter true
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from USCoreEncounterProfile

Summary

Must-Support: 21 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Encounter.identifier
  • The element 1 is sliced based on the value of Encounter.location

 

Other representations of profile: CSV, Excel, Schematron