Da Vinci Prior Authorization Support (PAS) FHIR IG
2.2.1 - STU 2.2 United States of America flag

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.1 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.1
Standards status: Trial-use Maturity Level: 4 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:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
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)
Encounter.meta This element must be supported. This element is included in summaries. 0..1 Meta Metadata about the resource
Encounter.meta.lastUpdated This element must be supported. This element is included in summaries. 0..1 instant When the resource last changed
Encounter.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Encounter.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for extension.extension:patientStatus This element must be supported. 0..1 CodeableConcept Patient Status
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.
Encounter.Slices for extension.extension:nursingHomeResidentialStatus This element must be supported. 0..1 (Complex) Nursing Home Residential Status
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-nursingHomeResidentialStatus
Encounter.Slices for extension.extension:nursingHomeResidentialStatus.extension 0..0 Extension
Slice: Unordered, Open by value:url
Encounter.Slices for extension.extension:nursingHomeResidentialStatus.url 1..1 uri "http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-nursingHomeResidentialStatus"
Encounter.Slices for extension.extension:nursingHomeResidentialStatus.value[x] This element must be supported. 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.
Encounter.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Encounter.identifier This element must be supported. This element is included in summaries. 0..* Identifier Identifier(s) by which this encounter is known
Encounter.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Encounter.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Encounter.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Encounter.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
Fixed Value: planned
Encounter.class This element must be supported. This element is included in summaries. 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
Encounter.type This element must be supported. This element is included in summaries. 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.
Encounter.subject This element must be supported. This element is included in summaries. 1..1 Reference(PAS Beneficiary Patient(2.2.1)) The patient or group present at the encounter
Encounter.participant This element must be supported. This element is included in summaries. 0..* BackboneElement List of participants involved in the encounter
Encounter.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.participant.type This element must be supported. This element is included in summaries. 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
Encounter.participant.period This element must be supported. 0..1 Period Period of time during the encounter that the participant participated
Encounter.participant.individual This element must be supported. This element is included in summaries. 0..1 Reference(US Core Practitioner Profile(7.0.0) This type must be supported. | US Core PractitionerRole Profile(7.0.0) | US Core RelatedPerson Profile(7.0.0)) Persons involved in the encounter other than the patient
Encounter.period This element must be supported. 0..1 Period The start and end time of the encounter
Encounter.reasonCode This element must be supported. This element is included in summaries. 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
Encounter.reasonReference This element must be supported. This element is included in summaries. 0..* Reference(US Core Condition Problems and Health Concerns Profile(7.0.0) This type must be supported. | US Core Condition Encounter Diagnosis Profile(7.0.0) This type must be supported. | US Core Procedure Profile(7.0.0) | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
Encounter.hospitalization This element must be supported. 0..1 BackboneElement Details about the admission to a healthcare service
Encounter.hospitalization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.hospitalization.admitSource This element must be supported. 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.
Encounter.hospitalization.dischargeDisposition This element must be supported. 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
Encounter.location This element must be supported. 0..* BackboneElement List of locations where the patient has been
Encounter.location.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.location.location This element must be supported. 1..1 Reference(US Core Location Profile(7.0.0)) Location the encounter takes place
Encounter.serviceProvider This element must be supported. 0..1 Reference(US Core Organization Profile(7.0.0)) The organization (facility) responsible for this encounter

doco 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.4
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

This structure is derived from USCoreEncounterProfile

NameFlagsCard.TypeDescription & Constraints    Filter: doco
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)
Encounter.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for extension.extension:patientStatus This element must be supported. 0..1 CodeableConcept Patient Status
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.
Encounter.Slices for extension.extension:nursingHomeResidentialStatus This element must be supported. 0..1 (Complex) Nursing Home Residential Status
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-nursingHomeResidentialStatus
Encounter.Slices for extension.extension:nursingHomeResidentialStatus.value[x] This element must be supported. 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.
Encounter.status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Fixed Value: planned
Encounter.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.
Encounter.hospitalization
Encounter.hospitalization.admitSource This element must be supported. 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.

doco 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
NameFlagsCard.TypeDescription & Constraints    Filter: doco
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)
Encounter.id This element is included in summaries. 0..1 id Logical id of this artifact
Encounter.meta This element must be supported. This element is included in summaries. 0..1 Meta Metadata about the resource
Encounter.meta.id 0..1 string Unique id for inter-element referencing
Encounter.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Encounter.meta.lastUpdated This element must be supported. This element is included in summaries. 0..1 instant When the resource last changed
Encounter.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Encounter.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Encounter.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Encounter.meta.tag This element is included in summaries. 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".
Encounter.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Encounter.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Encounter.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
Encounter.contained 0..* Resource Contained, inline Resources
Encounter.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for extension.extension:patientStatus This element must be supported. 0..1 CodeableConcept Patient Status
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.
Encounter.Slices for extension.extension:nursingHomeResidentialStatus This element must be supported. 0..1 (Complex) Nursing Home Residential Status
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-nursingHomeResidentialStatus
Encounter.Slices for extension.extension:nursingHomeResidentialStatus.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for extension.extension:nursingHomeResidentialStatus.extension 0..0 Extension
Slice: Unordered, Open by value:url
Encounter.Slices for extension.extension:nursingHomeResidentialStatus.url 1..1 uri "http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-nursingHomeResidentialStatus"
Encounter.Slices for extension.extension:nursingHomeResidentialStatus.value[x] This element must be supported. 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.
Encounter.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Encounter.identifier This element must be supported. This element is included in summaries. 0..* Identifier Identifier(s) by which this encounter is known
Encounter.identifier.id 0..1 string Unique id for inter-element referencing
Encounter.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Encounter.identifier.type This element is included in summaries. 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.
Encounter.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Encounter.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Encounter.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Encounter.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Encounter.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
Fixed Value: planned
Encounter.statusHistory 0..* BackboneElement List of past encounter statuses
Encounter.statusHistory.id 0..1 string Unique id for inter-element referencing
Encounter.statusHistory.extension 0..* Extension Additional content defined by implementations
Encounter.statusHistory.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.statusHistory.status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
Encounter.statusHistory.period 1..1 Period The time that the episode was in the specified status
Encounter.class This element must be supported. This element is included in summaries. 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
Encounter.classHistory 0..* BackboneElement List of past encounter classes
Encounter.classHistory.id 0..1 string Unique id for inter-element referencing
Encounter.classHistory.extension 0..* Extension Additional content defined by implementations
Encounter.classHistory.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.classHistory.class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
Encounter.classHistory.period 1..1 Period The time that the episode was in the specified class
Encounter.type This element must be supported. This element is included in summaries. 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.
Encounter.serviceType This element is included in summaries. 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
Encounter.priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter.
Encounter.subject This element must be supported. This element is included in summaries. 1..1 Reference(PAS Beneficiary Patient(2.2.1)) The patient or group present at the encounter
Encounter.episodeOfCare This element is included in summaries. 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
Encounter.basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
Encounter.participant This element must be supported. This element is included in summaries. 0..* BackboneElement List of participants involved in the encounter
Encounter.participant.id 0..1 string Unique id for inter-element referencing
Encounter.participant.extension 0..* Extension Additional content defined by implementations
Encounter.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.participant.type This element must be supported. This element is included in summaries. 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
Encounter.participant.period This element must be supported. 0..1 Period Period of time during the encounter that the participant participated
Encounter.participant.individual This element must be supported. This element is included in summaries. 0..1 Reference(US Core Practitioner Profile(7.0.0) This type must be supported. | US Core PractitionerRole Profile(7.0.0) | US Core RelatedPerson Profile(7.0.0)) Persons involved in the encounter other than the patient
Encounter.appointment This element is included in summaries. 0..* Reference(Appointment) The appointment that scheduled this encounter
Encounter.period This element must be supported. 0..1 Period The start and end time of the encounter
Encounter.length 0..1 Duration Quantity of time the encounter lasted (less time absent)
Encounter.reasonCode This element must be supported. This element is included in summaries. 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
Encounter.reasonReference This element must be supported. This element is included in summaries. 0..* Reference(US Core Condition Problems and Health Concerns Profile(7.0.0) This type must be supported. | US Core Condition Encounter Diagnosis Profile(7.0.0) This type must be supported. | US Core Procedure Profile(7.0.0) | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
Encounter.diagnosis This element is included in summaries. 0..* BackboneElement The list of diagnosis relevant to this encounter
Encounter.diagnosis.id 0..1 string Unique id for inter-element referencing
Encounter.diagnosis.extension 0..* Extension Additional content defined by implementations
Encounter.diagnosis.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.diagnosis.condition This element is included in summaries. 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
Encounter.diagnosis.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.
Encounter.diagnosis.rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
Encounter.account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
Encounter.hospitalization This element must be supported. 0..1 BackboneElement Details about the admission to a healthcare service
Encounter.hospitalization.id 0..1 string Unique id for inter-element referencing
Encounter.hospitalization.extension 0..* Extension Additional content defined by implementations
Encounter.hospitalization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.hospitalization.preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
Encounter.hospitalization.origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
Encounter.hospitalization.admitSource This element must be supported. 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.
Encounter.hospitalization.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: Hl7VSReAdmissionIndicator (3.0.0) (example): The reason for re-admission of this hospitalization encounter.
Encounter.hospitalization.dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
Encounter.hospitalization.specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
Encounter.hospitalization.specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.
Encounter.hospitalization.destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
Encounter.hospitalization.dischargeDisposition This element must be supported. 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
Encounter.location This element must be supported. 0..* BackboneElement List of locations where the patient has been
Encounter.location.id 0..1 string Unique id for inter-element referencing
Encounter.location.extension 0..* Extension Additional content defined by implementations
Encounter.location.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.location.location This element must be supported. 1..1 Reference(US Core Location Profile(7.0.0)) Location the encounter takes place
Encounter.location.status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
Encounter.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.
Encounter.location.period 0..1 Period Time period during which the patient was present at the location
Encounter.serviceProvider This element must be supported. 0..1 Reference(US Core Organization Profile(7.0.0)) The organization (facility) responsible for this encounter
Encounter.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.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.4
Encounter.classHistory.​class Base extensible ActEncounterCode 📍3.0.0 THO v7.4
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.4
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 📍3.0.0 THO v7.4
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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
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)
Encounter.meta This element must be supported. This element is included in summaries. 0..1 Meta Metadata about the resource
Encounter.meta.lastUpdated This element must be supported. This element is included in summaries. 0..1 instant When the resource last changed
Encounter.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Encounter.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for extension.extension:patientStatus This element must be supported. 0..1 CodeableConcept Patient Status
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.
Encounter.Slices for extension.extension:nursingHomeResidentialStatus This element must be supported. 0..1 (Complex) Nursing Home Residential Status
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-nursingHomeResidentialStatus
Encounter.Slices for extension.extension:nursingHomeResidentialStatus.extension 0..0 Extension
Slice: Unordered, Open by value:url
Encounter.Slices for extension.extension:nursingHomeResidentialStatus.url 1..1 uri "http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-nursingHomeResidentialStatus"
Encounter.Slices for extension.extension:nursingHomeResidentialStatus.value[x] This element must be supported. 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.
Encounter.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Encounter.identifier This element must be supported. This element is included in summaries. 0..* Identifier Identifier(s) by which this encounter is known
Encounter.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Encounter.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Encounter.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Encounter.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
Fixed Value: planned
Encounter.class This element must be supported. This element is included in summaries. 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
Encounter.type This element must be supported. This element is included in summaries. 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.
Encounter.subject This element must be supported. This element is included in summaries. 1..1 Reference(PAS Beneficiary Patient(2.2.1)) The patient or group present at the encounter
Encounter.participant This element must be supported. This element is included in summaries. 0..* BackboneElement List of participants involved in the encounter
Encounter.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.participant.type This element must be supported. This element is included in summaries. 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
Encounter.participant.period This element must be supported. 0..1 Period Period of time during the encounter that the participant participated
Encounter.participant.individual This element must be supported. This element is included in summaries. 0..1 Reference(US Core Practitioner Profile(7.0.0) This type must be supported. | US Core PractitionerRole Profile(7.0.0) | US Core RelatedPerson Profile(7.0.0)) Persons involved in the encounter other than the patient
Encounter.period This element must be supported. 0..1 Period The start and end time of the encounter
Encounter.reasonCode This element must be supported. This element is included in summaries. 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
Encounter.reasonReference This element must be supported. This element is included in summaries. 0..* Reference(US Core Condition Problems and Health Concerns Profile(7.0.0) This type must be supported. | US Core Condition Encounter Diagnosis Profile(7.0.0) This type must be supported. | US Core Procedure Profile(7.0.0) | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
Encounter.hospitalization This element must be supported. 0..1 BackboneElement Details about the admission to a healthcare service
Encounter.hospitalization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.hospitalization.admitSource This element must be supported. 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.
Encounter.hospitalization.dischargeDisposition This element must be supported. 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
Encounter.location This element must be supported. 0..* BackboneElement List of locations where the patient has been
Encounter.location.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.location.location This element must be supported. 1..1 Reference(US Core Location Profile(7.0.0)) Location the encounter takes place
Encounter.serviceProvider This element must be supported. 0..1 Reference(US Core Organization Profile(7.0.0)) The organization (facility) responsible for this encounter

doco 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.4
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

Differential View

This structure is derived from USCoreEncounterProfile

NameFlagsCard.TypeDescription & Constraints    Filter: doco
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)
Encounter.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for extension.extension:patientStatus This element must be supported. 0..1 CodeableConcept Patient Status
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.
Encounter.Slices for extension.extension:nursingHomeResidentialStatus This element must be supported. 0..1 (Complex) Nursing Home Residential Status
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-nursingHomeResidentialStatus
Encounter.Slices for extension.extension:nursingHomeResidentialStatus.value[x] This element must be supported. 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.
Encounter.status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Fixed Value: planned
Encounter.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.
Encounter.subject 1..1 Reference(PAS Beneficiary Patient(2.2.1)) The patient or group present at the encounter
Encounter.hospitalization
Encounter.hospitalization.admitSource This element must be supported. 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.

doco 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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
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)
Encounter.id This element is included in summaries. 0..1 id Logical id of this artifact
Encounter.meta This element must be supported. This element is included in summaries. 0..1 Meta Metadata about the resource
Encounter.meta.id 0..1 string Unique id for inter-element referencing
Encounter.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Encounter.meta.lastUpdated This element must be supported. This element is included in summaries. 0..1 instant When the resource last changed
Encounter.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Encounter.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Encounter.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Encounter.meta.tag This element is included in summaries. 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".
Encounter.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Encounter.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Encounter.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
Encounter.contained 0..* Resource Contained, inline Resources
Encounter.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for extension.extension:patientStatus This element must be supported. 0..1 CodeableConcept Patient Status
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.
Encounter.Slices for extension.extension:nursingHomeResidentialStatus This element must be supported. 0..1 (Complex) Nursing Home Residential Status
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-nursingHomeResidentialStatus
Encounter.Slices for extension.extension:nursingHomeResidentialStatus.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for extension.extension:nursingHomeResidentialStatus.extension 0..0 Extension
Slice: Unordered, Open by value:url
Encounter.Slices for extension.extension:nursingHomeResidentialStatus.url 1..1 uri "http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-nursingHomeResidentialStatus"
Encounter.Slices for extension.extension:nursingHomeResidentialStatus.value[x] This element must be supported. 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.
Encounter.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Encounter.identifier This element must be supported. This element is included in summaries. 0..* Identifier Identifier(s) by which this encounter is known
Encounter.identifier.id 0..1 string Unique id for inter-element referencing
Encounter.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Encounter.identifier.type This element is included in summaries. 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.
Encounter.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Encounter.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Encounter.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Encounter.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Encounter.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
Fixed Value: planned
Encounter.statusHistory 0..* BackboneElement List of past encounter statuses
Encounter.statusHistory.id 0..1 string Unique id for inter-element referencing
Encounter.statusHistory.extension 0..* Extension Additional content defined by implementations
Encounter.statusHistory.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.statusHistory.status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
Encounter.statusHistory.period 1..1 Period The time that the episode was in the specified status
Encounter.class This element must be supported. This element is included in summaries. 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
Encounter.classHistory 0..* BackboneElement List of past encounter classes
Encounter.classHistory.id 0..1 string Unique id for inter-element referencing
Encounter.classHistory.extension 0..* Extension Additional content defined by implementations
Encounter.classHistory.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.classHistory.class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
Encounter.classHistory.period 1..1 Period The time that the episode was in the specified class
Encounter.type This element must be supported. This element is included in summaries. 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.
Encounter.serviceType This element is included in summaries. 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
Encounter.priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter.
Encounter.subject This element must be supported. This element is included in summaries. 1..1 Reference(PAS Beneficiary Patient(2.2.1)) The patient or group present at the encounter
Encounter.episodeOfCare This element is included in summaries. 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
Encounter.basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
Encounter.participant This element must be supported. This element is included in summaries. 0..* BackboneElement List of participants involved in the encounter
Encounter.participant.id 0..1 string Unique id for inter-element referencing
Encounter.participant.extension 0..* Extension Additional content defined by implementations
Encounter.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.participant.type This element must be supported. This element is included in summaries. 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
Encounter.participant.period This element must be supported. 0..1 Period Period of time during the encounter that the participant participated
Encounter.participant.individual This element must be supported. This element is included in summaries. 0..1 Reference(US Core Practitioner Profile(7.0.0) This type must be supported. | US Core PractitionerRole Profile(7.0.0) | US Core RelatedPerson Profile(7.0.0)) Persons involved in the encounter other than the patient
Encounter.appointment This element is included in summaries. 0..* Reference(Appointment) The appointment that scheduled this encounter
Encounter.period This element must be supported. 0..1 Period The start and end time of the encounter
Encounter.length 0..1 Duration Quantity of time the encounter lasted (less time absent)
Encounter.reasonCode This element must be supported. This element is included in summaries. 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
Encounter.reasonReference This element must be supported. This element is included in summaries. 0..* Reference(US Core Condition Problems and Health Concerns Profile(7.0.0) This type must be supported. | US Core Condition Encounter Diagnosis Profile(7.0.0) This type must be supported. | US Core Procedure Profile(7.0.0) | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
Encounter.diagnosis This element is included in summaries. 0..* BackboneElement The list of diagnosis relevant to this encounter
Encounter.diagnosis.id 0..1 string Unique id for inter-element referencing
Encounter.diagnosis.extension 0..* Extension Additional content defined by implementations
Encounter.diagnosis.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.diagnosis.condition This element is included in summaries. 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
Encounter.diagnosis.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.
Encounter.diagnosis.rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
Encounter.account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
Encounter.hospitalization This element must be supported. 0..1 BackboneElement Details about the admission to a healthcare service
Encounter.hospitalization.id 0..1 string Unique id for inter-element referencing
Encounter.hospitalization.extension 0..* Extension Additional content defined by implementations
Encounter.hospitalization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.hospitalization.preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
Encounter.hospitalization.origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
Encounter.hospitalization.admitSource This element must be supported. 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.
Encounter.hospitalization.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: Hl7VSReAdmissionIndicator (3.0.0) (example): The reason for re-admission of this hospitalization encounter.
Encounter.hospitalization.dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
Encounter.hospitalization.specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
Encounter.hospitalization.specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.
Encounter.hospitalization.destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
Encounter.hospitalization.dischargeDisposition This element must be supported. 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
Encounter.location This element must be supported. 0..* BackboneElement List of locations where the patient has been
Encounter.location.id 0..1 string Unique id for inter-element referencing
Encounter.location.extension 0..* Extension Additional content defined by implementations
Encounter.location.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.location.location This element must be supported. 1..1 Reference(US Core Location Profile(7.0.0)) Location the encounter takes place
Encounter.location.status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
Encounter.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.
Encounter.location.period 0..1 Period Time period during which the patient was present at the location
Encounter.serviceProvider This element must be supported. 0..1 Reference(US Core Organization Profile(7.0.0)) The organization (facility) responsible for this encounter
Encounter.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.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.4
Encounter.classHistory.​class Base extensible ActEncounterCode 📍3.0.0 THO v7.4
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.4
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 📍3.0.0 THO v7.4
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

 

Other representations of profile: CSV, Excel, Schematron