Da Vinci Prior Authorization Support (PAS) FHIR IG
2.2.0-ballot - STU 2.2 - Ballot

Da Vinci Prior Authorization Support (PAS) FHIR IG, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.2.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-pas/ and changes regularly. See the Directory of published versions

## Resource Profile: PAS Encounter

Official URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-encounter | Version: 2.2.0-ballot
Standards status: Trial-use Active as of 2026-01-30 | Maturity Level: 3 | Computable Name: PASEncounter
Other Identifiers: OID:2.16.840.1.113883.4.642.40.24.42.57

PAS constraints on the Encounter resource mandating support for elements relevant to details of a requested institutional stay on the prior authorization request

Usages:

- Refer to this Profile: PAS Claim Update, PAS Claim, PAS Claim Update and PAS Claim
- Examples for this Profile: Encounter/SurgicalEncounterExample

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | USCoreEncounterProfile(7.0.0) | An interaction during which services are provided to the patient This profile also complies with the profiles US Core Encounter Profile (3.1.1) and US Core Encounter Profile (6.1.0)
meta | S Σ | 0..1 | Meta | Metadata about the resource
lastUpdated | S Σ | 0..1 | instant | When the resource last changed
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:patientStatus | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-patientStatus Binding: https://valueset.x12.org/x217/005010/request/2000E/CL1/1/03/00/1352 (required): Codes indicating patient status as of the 'statement covers through date'. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
extension:nursingHomeResidentialStatus | S | 0..1 | (Complex) | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-nursingHomeResidentialStatus
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-nursingHomeResidentialStatus"
value[x] | S | 0..1 | CodeableConcept | Value of extension Binding: https://valueset.x12.org/x217/005010/request/2000E/CL1/1/04/00/1345 (required): Codes specifying the status of a nursing home resident at the time of service. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | 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 Σ | 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
status | ?!S Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. Fixed Value: planned
class | S Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
type | S Σ | 1..* | CodeableConcept | Specific type of encounter Binding: https://valueset.x12.org/x217/005010/request/2000E/CL1/1/01/00/1315 (required): Codes indicating the priority of this admission. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
subject | S Σ | 1..1 | Reference(PAS Beneficiary Patient(2.2.0-ballot)) | 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 Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
period | S | 0..1 | Period | Period of time during the encounter that the participant participated
individual | S Σ | 0..1 | Reference(US Core Practitioner Profile(7.0.0) S | US Core PractitionerRole Profile(7.0.0) | US Core RelatedPerson Profile(7.0.0)) | Persons involved in the encounter other than the patient
period | S | 0..1 | Period | The start and end time of the encounter
reasonCode | S Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
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)
hospitalization | S | 0..1 | BackboneElement | Details about the admission to a healthcare service
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
admitSource | S | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: https://valueset.x12.org/x217/005010/request/2000E/CL1/1/02/00/1314 (required): Codes indicating the source of this admission. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
dischargeDisposition | S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: USCoreDischargeDisposition (7.0.0) (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17
location | S | 0..* | 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(US Core Location Profile(7.0.0)) | Location the encounter takes place
serviceProvider | S | 0..1 | Reference(US Core Organization Profile(7.0.0)) | The organization (facility) responsible for this encounter
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Encounter.extension:nursingHomeResidentialStatus.​value[x] | Base | required | https://valueset.x12.org/x217/005010/request/2000E/CL1/1/04/00/1345 | Not State | Unknown
Encounter.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std.
Encounter.class | Base | extensible | ActEncounterCode | 📍3.0.0 | THO v7.0
Encounter.type | Base | required | https://valueset.x12.org/x217/005010/request/2000E/CL1/1/01/00/1315 | Not State | Unknown
Encounter.participant.​type | Base | extensible | Participant type | 📦4.0.1 | FHIR Std.
Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📦4.0.1 | FHIR Std.
Encounter.hospitalization.​admitSource | Base | required | https://valueset.x12.org/x217/005010/request/2000E/CL1/1/02/00/1314 | Not State | Unknown
Encounter.hospitalization.​dischargeDisposition | Base | preferred | US Core Discharge Disposition | 📍7.0.0 | US Core v7.0

#### 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())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | USCoreEncounterProfile(7.0.0) | An interaction during which services are provided to the patient This profile also complies with the profiles US Core Encounter Profile (3.1.1) and US Core Encounter Profile (6.1.0)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:patientStatus | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-patientStatus Binding: https://valueset.x12.org/x217/005010/request/2000E/CL1/1/03/00/1352 (required): Codes indicating patient status as of the 'statement covers through date'. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
extension:nursingHomeResidentialStatus | S | 0..1 | (Complex) | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-nursingHomeResidentialStatus
value[x] | S | 0..1 | CodeableConcept | Value of extension Binding: https://valueset.x12.org/x217/005010/request/2000E/CL1/1/04/00/1345 (required): Codes specifying the status of a nursing home resident at the time of service. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
status |  | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Fixed Value: planned
type |  | 1..* | CodeableConcept | Specific type of encounter Binding: https://valueset.x12.org/x217/005010/request/2000E/CL1/1/01/00/1315 (required): Codes indicating the priority of this admission. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
subject |  | 1..1 | Reference(PAS Beneficiary Patient(2.2.0-ballot)) | The patient or group present at the encounter
hospitalization |  |  |  |
admitSource | S | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: https://valueset.x12.org/x217/005010/request/2000E/CL1/1/02/00/1314 (required): Codes indicating the source of this admission. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Encounter.extension:nursingHomeResidentialStatus.​value[x] | Base | required | https://valueset.x12.org/x217/005010/request/2000E/CL1/1/04/00/1345 | Not State | Unknown
Encounter.type | Base | required | https://valueset.x12.org/x217/005010/request/2000E/CL1/1/01/00/1315 | Not State | Unknown
Encounter.hospitalization.​admitSource | Base | required | https://valueset.x12.org/x217/005010/request/2000E/CL1/1/02/00/1314 | Not State | Unknown

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | USCoreEncounterProfile(7.0.0) | An interaction during which services are provided to the patient This profile also complies with the profiles US Core Encounter Profile (3.1.1) and US Core Encounter Profile (6.1.0)
id | Σ | 0..1 | id | Logical id of this artifact
meta | S Σ | 0..1 | Meta | Metadata about the resource
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | S Σ | 0..1 | instant | When the resource last changed
source | Σ | 0..1 | uri | Identifies where the resource comes from
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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 Bindings | Purpose
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:patientStatus | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-patientStatus Binding: https://valueset.x12.org/x217/005010/request/2000E/CL1/1/03/00/1352 (required): Codes indicating patient status as of the 'statement covers through date'. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
extension:nursingHomeResidentialStatus | S | 0..1 | (Complex) | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-nursingHomeResidentialStatus
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://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-nursingHomeResidentialStatus"
value[x] | S | 0..1 | CodeableConcept | Value of extension Binding: https://valueset.x12.org/x217/005010/request/2000E/CL1/1/04/00/1345 (required): Codes specifying the status of a nursing home resident at the time of service. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | 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 Σ | 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)
status | ?!S Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. Fixed Value: planned
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: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
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 (3.0.0) (extensible): Classification of the encounter.
period |  | 1..1 | Period | The time that the episode was in the specified class
type | S Σ | 1..* | CodeableConcept | Specific type of encounter Binding: https://valueset.x12.org/x217/005010/request/2000E/CL1/1/01/00/1315 (required): Codes indicating the priority of this admission. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
serviceType | Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.
priority |  | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter.
subject | S Σ | 1..1 | Reference(PAS Beneficiary Patient(2.2.0-ballot)) | 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 Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
period | S | 0..1 | Period | Period of time during the encounter that the participant participated
individual | S Σ | 0..1 | Reference(US Core Practitioner Profile(7.0.0) S | US Core PractitionerRole Profile(7.0.0) | US Core RelatedPerson Profile(7.0.0)) | Persons involved in the encounter other than the patient
appointment | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter
period | S | 0..1 | Period | The start and end time of the encounter
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.
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 | Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter
use |  | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
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 | S | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: https://valueset.x12.org/x217/005010/request/2000E/CL1/1/02/00/1314 (required): Codes indicating the source of this admission. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
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: USCoreDischargeDisposition (7.0.0) (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17
location | S | 0..* | 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(US Core Location Profile(7.0.0)) | 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(US Core Organization Profile(7.0.0)) | The organization (facility) responsible for this encounter
partOf |  | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Encounter.meta.security | Base | extensible | SecurityLabels | 📦4.0.1 | FHIR Std.
Encounter.meta.tag | Base | example | Common Tags | 📦4.0.1 | FHIR Std.
Encounter.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
Encounter.extension:nursingHomeResidentialStatus.​value[x] | Base | required | https://valueset.x12.org/x217/005010/request/2000E/CL1/1/04/00/1345 | Not State | Unknown
Encounter.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Encounter.identifier.​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 | extensible | ActEncounterCode | 📍3.0.0 | THO v7.0
Encounter.classHistory.​class | Base | extensible | ActEncounterCode | 📍3.0.0 | THO v7.0
Encounter.type | Base | required | https://valueset.x12.org/x217/005010/request/2000E/CL1/1/01/00/1315 | Not State | Unknown
Encounter.serviceType | Base | example | Service type | 📦4.0.1 | FHIR Std.
Encounter.priority | Base | example | ActPriority | 📍3.0.0 | THO v7.0
Encounter.participant.​type | Base | extensible | Participant type | 📦4.0.1 | FHIR Std.
Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📦4.0.1 | FHIR Std.
Encounter.diagnosis.​use | Base | preferred | DiagnosisRole | 📦4.0.1 | FHIR Std.
Encounter.hospitalization.​admitSource | Base | required | https://valueset.x12.org/x217/005010/request/2000E/CL1/1/02/00/1314 | Not State | Unknown
Encounter.hospitalization.​reAdmission | Base | example | hl7VS-re-admissionIndicator | 📦2.0.0 | THO v7.0
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.

#### 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())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Summary

Must-Support: 4 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

- PAS Beneficiary Patient (http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-beneficiary|2.2.0-ballot)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-patientStatus|2.2.0-ballot
- http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-nursingHomeResidentialStatus|2.2.0-ballot

Maturity: 3

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | USCoreEncounterProfile(7.0.0) | An interaction during which services are provided to the patient This profile also complies with the profiles US Core Encounter Profile (3.1.1) and US Core Encounter Profile (6.1.0)
meta | S Σ | 0..1 | Meta | Metadata about the resource
lastUpdated | S Σ | 0..1 | instant | When the resource last changed
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:patientStatus | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-patientStatus Binding: https://valueset.x12.org/x217/005010/request/2000E/CL1/1/03/00/1352 (required): Codes indicating patient status as of the 'statement covers through date'. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
extension:nursingHomeResidentialStatus | S | 0..1 | (Complex) | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-nursingHomeResidentialStatus
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-nursingHomeResidentialStatus"
value[x] | S | 0..1 | CodeableConcept | Value of extension Binding: https://valueset.x12.org/x217/005010/request/2000E/CL1/1/04/00/1345 (required): Codes specifying the status of a nursing home resident at the time of service. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | 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 Σ | 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
status | ?!S Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. Fixed Value: planned
class | S Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
type | S Σ | 1..* | CodeableConcept | Specific type of encounter Binding: https://valueset.x12.org/x217/005010/request/2000E/CL1/1/01/00/1315 (required): Codes indicating the priority of this admission. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
subject | S Σ | 1..1 | Reference(PAS Beneficiary Patient(2.2.0-ballot)) | 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 Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
period | S | 0..1 | Period | Period of time during the encounter that the participant participated
individual | S Σ | 0..1 | Reference(US Core Practitioner Profile(7.0.0) S | US Core PractitionerRole Profile(7.0.0) | US Core RelatedPerson Profile(7.0.0)) | Persons involved in the encounter other than the patient
period | S | 0..1 | Period | The start and end time of the encounter
reasonCode | S Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
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)
hospitalization | S | 0..1 | BackboneElement | Details about the admission to a healthcare service
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
admitSource | S | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: https://valueset.x12.org/x217/005010/request/2000E/CL1/1/02/00/1314 (required): Codes indicating the source of this admission. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
dischargeDisposition | S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: USCoreDischargeDisposition (7.0.0) (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17
location | S | 0..* | 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(US Core Location Profile(7.0.0)) | Location the encounter takes place
serviceProvider | S | 0..1 | Reference(US Core Organization Profile(7.0.0)) | The organization (facility) responsible for this encounter
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Encounter.extension:nursingHomeResidentialStatus.​value[x] | Base | required | https://valueset.x12.org/x217/005010/request/2000E/CL1/1/04/00/1345 | Not State | Unknown
Encounter.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std.
Encounter.class | Base | extensible | ActEncounterCode | 📍3.0.0 | THO v7.0
Encounter.type | Base | required | https://valueset.x12.org/x217/005010/request/2000E/CL1/1/01/00/1315 | Not State | Unknown
Encounter.participant.​type | Base | extensible | Participant type | 📦4.0.1 | FHIR Std.
Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📦4.0.1 | FHIR Std.
Encounter.hospitalization.​admitSource | Base | required | https://valueset.x12.org/x217/005010/request/2000E/CL1/1/02/00/1314 | Not State | Unknown
Encounter.hospitalization.​dischargeDisposition | Base | preferred | US Core Discharge Disposition | 📍7.0.0 | US Core v7.0

#### 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())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Differential View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | USCoreEncounterProfile(7.0.0) | An interaction during which services are provided to the patient This profile also complies with the profiles US Core Encounter Profile (3.1.1) and US Core Encounter Profile (6.1.0)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:patientStatus | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-patientStatus Binding: https://valueset.x12.org/x217/005010/request/2000E/CL1/1/03/00/1352 (required): Codes indicating patient status as of the 'statement covers through date'. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
extension:nursingHomeResidentialStatus | S | 0..1 | (Complex) | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-nursingHomeResidentialStatus
value[x] | S | 0..1 | CodeableConcept | Value of extension Binding: https://valueset.x12.org/x217/005010/request/2000E/CL1/1/04/00/1345 (required): Codes specifying the status of a nursing home resident at the time of service. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
status |  | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Fixed Value: planned
type |  | 1..* | CodeableConcept | Specific type of encounter Binding: https://valueset.x12.org/x217/005010/request/2000E/CL1/1/01/00/1315 (required): Codes indicating the priority of this admission. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
subject |  | 1..1 | Reference(PAS Beneficiary Patient(2.2.0-ballot)) | The patient or group present at the encounter
hospitalization |  |  |  |
admitSource | S | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: https://valueset.x12.org/x217/005010/request/2000E/CL1/1/02/00/1314 (required): Codes indicating the source of this admission. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Encounter.extension:nursingHomeResidentialStatus.​value[x] | Base | required | https://valueset.x12.org/x217/005010/request/2000E/CL1/1/04/00/1345 | Not State | Unknown
Encounter.type | Base | required | https://valueset.x12.org/x217/005010/request/2000E/CL1/1/01/00/1315 | Not State | Unknown
Encounter.hospitalization.​admitSource | Base | required | https://valueset.x12.org/x217/005010/request/2000E/CL1/1/02/00/1314 | Not State | Unknown

Snapshot ViewView

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | USCoreEncounterProfile(7.0.0) | An interaction during which services are provided to the patient This profile also complies with the profiles US Core Encounter Profile (3.1.1) and US Core Encounter Profile (6.1.0)
id | Σ | 0..1 | id | Logical id of this artifact
meta | S Σ | 0..1 | Meta | Metadata about the resource
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | S Σ | 0..1 | instant | When the resource last changed
source | Σ | 0..1 | uri | Identifies where the resource comes from
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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 Bindings | Purpose
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:patientStatus | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-patientStatus Binding: https://valueset.x12.org/x217/005010/request/2000E/CL1/1/03/00/1352 (required): Codes indicating patient status as of the 'statement covers through date'. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
extension:nursingHomeResidentialStatus | S | 0..1 | (Complex) | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-nursingHomeResidentialStatus
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://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-nursingHomeResidentialStatus"
value[x] | S | 0..1 | CodeableConcept | Value of extension Binding: https://valueset.x12.org/x217/005010/request/2000E/CL1/1/04/00/1345 (required): Codes specifying the status of a nursing home resident at the time of service. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | 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 Σ | 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)
status | ?!S Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. Fixed Value: planned
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: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
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 (3.0.0) (extensible): Classification of the encounter.
period |  | 1..1 | Period | The time that the episode was in the specified class
type | S Σ | 1..* | CodeableConcept | Specific type of encounter Binding: https://valueset.x12.org/x217/005010/request/2000E/CL1/1/01/00/1315 (required): Codes indicating the priority of this admission. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
serviceType | Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.
priority |  | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter.
subject | S Σ | 1..1 | Reference(PAS Beneficiary Patient(2.2.0-ballot)) | 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 Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
period | S | 0..1 | Period | Period of time during the encounter that the participant participated
individual | S Σ | 0..1 | Reference(US Core Practitioner Profile(7.0.0) S | US Core PractitionerRole Profile(7.0.0) | US Core RelatedPerson Profile(7.0.0)) | Persons involved in the encounter other than the patient
appointment | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter
period | S | 0..1 | Period | The start and end time of the encounter
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.
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 | Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter
use |  | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
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 | S | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: https://valueset.x12.org/x217/005010/request/2000E/CL1/1/02/00/1314 (required): Codes indicating the source of this admission. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
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: USCoreDischargeDisposition (7.0.0) (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17
location | S | 0..* | 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(US Core Location Profile(7.0.0)) | 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(US Core Organization Profile(7.0.0)) | The organization (facility) responsible for this encounter
partOf |  | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Encounter.meta.security | Base | extensible | SecurityLabels | 📦4.0.1 | FHIR Std.
Encounter.meta.tag | Base | example | Common Tags | 📦4.0.1 | FHIR Std.
Encounter.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
Encounter.extension:nursingHomeResidentialStatus.​value[x] | Base | required | https://valueset.x12.org/x217/005010/request/2000E/CL1/1/04/00/1345 | Not State | Unknown
Encounter.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Encounter.identifier.​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 | extensible | ActEncounterCode | 📍3.0.0 | THO v7.0
Encounter.classHistory.​class | Base | extensible | ActEncounterCode | 📍3.0.0 | THO v7.0
Encounter.type | Base | required | https://valueset.x12.org/x217/005010/request/2000E/CL1/1/01/00/1315 | Not State | Unknown
Encounter.serviceType | Base | example | Service type | 📦4.0.1 | FHIR Std.
Encounter.priority | Base | example | ActPriority | 📍3.0.0 | THO v7.0
Encounter.participant.​type | Base | extensible | Participant type | 📦4.0.1 | FHIR Std.
Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📦4.0.1 | FHIR Std.
Encounter.diagnosis.​use | Base | preferred | DiagnosisRole | 📦4.0.1 | FHIR Std.
Encounter.hospitalization.​admitSource | Base | required | https://valueset.x12.org/x217/005010/request/2000E/CL1/1/02/00/1314 | Not State | Unknown
Encounter.hospitalization.​reAdmission | Base | example | hl7VS-re-admissionIndicator | 📦2.0.0 | THO v7.0
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.

#### 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())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Summary

Must-Support: 4 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

- PAS Beneficiary Patient (http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-beneficiary|2.2.0-ballot)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-patientStatus|2.2.0-ballot
- http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-nursingHomeResidentialStatus|2.2.0-ballot

Maturity: 3

Other representations of profile: CSV, Excel, Schematron