Da Vinci Prior Authorization Support (PAS) FHIR IG
2.1.0-preview - STU 2 United States of America flag

This page is part of the Da Vinci Prior Authorization Support (PAS) FHIR IG (v2.1.0-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.0.1. For a full list of available versions, see the Directory of published versions

Resource Profile: PAS Encounter

Official URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-encounter Version: 2.1.0-preview
Standards status: Trial-use Maturity Level: 3 Computable Name: PASEncounter

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

Usage:

Formal Views of Profile Content

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

This structure is derived from USCoreEncounterProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter USCoreEncounterProfile(7.0.0) 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
.... 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.

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

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

... location
.... location 1..1 Reference(US Core Location Profile(7.0.0)) Location the encounter takes place

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Encounter.extension:nursingHomeResidentialStatus.value[x]requiredhttps://valueset.x12.org/x217/005010/request/2000E/CL1/1/04/00/1345
https://valueset.x12.org/x217/005010/request/2000E/CL1/1/04/00/1345
Encounter.typerequiredhttps://valueset.x12.org/x217/005010/request/2000E/CL1/1/01/00/1315
https://valueset.x12.org/x217/005010/request/2000E/CL1/1/01/00/1315
Encounter.hospitalization.admitSourcerequiredhttps://valueset.x12.org/x217/005010/request/2000E/CL1/1/02/00/1314
https://valueset.x12.org/x217/005010/request/2000E/CL1/1/02/00/1314
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... 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.


.... nursingHomeResidentialStatus S 0..1 (Complex) Extension
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-nursingHomeResidentialStatus
..... extension 0..0
..... 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.

... 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 (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) 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)) 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) | US Core Condition Encounter Diagnosis Profile(7.0.0)) 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: US Core Discharge Disposition (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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.extension:nursingHomeResidentialStatus.value[x]requiredhttps://valueset.x12.org/x217/005010/request/2000E/CL1/1/04/00/1345
https://valueset.x12.org/x217/005010/request/2000E/CL1/1/04/00/1345
Encounter.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Encounter.statusrequiredFixed Value: planned
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typerequiredhttps://valueset.x12.org/x217/005010/request/2000E/CL1/1/01/00/1315
https://valueset.x12.org/x217/005010/request/2000E/CL1/1/01/00/1315
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Encounter.hospitalization.admitSourcerequiredhttps://valueset.x12.org/x217/005010/request/2000E/CL1/1/02/00/1314
https://valueset.x12.org/x217/005010/request/2000E/CL1/1/02/00/1314
Encounter.hospitalization.dischargeDispositionpreferredUSCoreDischargeDisposition
http://hl7.org/fhir/us/core/ValueSet/us-core-discharge-disposition
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... 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.


.... 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
..... 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 (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 (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 (example): Indicates the urgency of the encounter.

... subject SΣ 1..1 Reference(PAS Beneficiary Patient) The patient or group present at the encounter
... episodeOfCare Σ 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
... basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
... participant SΣ 0..* BackboneElement List of participants involved in the encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣ 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: US Core Discharge Disposition (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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Encounter.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Encounter.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Encounter.extension:nursingHomeResidentialStatus.value[x]requiredhttps://valueset.x12.org/x217/005010/request/2000E/CL1/1/04/00/1345
https://valueset.x12.org/x217/005010/request/2000E/CL1/1/04/00/1345
Encounter.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Encounter.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Encounter.statusrequiredFixed Value: planned
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typerequiredhttps://valueset.x12.org/x217/005010/request/2000E/CL1/1/01/00/1315
https://valueset.x12.org/x217/005010/request/2000E/CL1/1/01/00/1315
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Encounter.priorityexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Encounter.diagnosis.usepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
from the FHIR Standard
Encounter.hospitalization.admitSourcerequiredhttps://valueset.x12.org/x217/005010/request/2000E/CL1/1/02/00/1314
https://valueset.x12.org/x217/005010/request/2000E/CL1/1/02/00/1314
Encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreferenceexampleDiet
http://hl7.org/fhir/ValueSet/encounter-diet
from the FHIR Standard
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
http://hl7.org/fhir/ValueSet/encounter-special-courtesy
from the FHIR Standard
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
http://hl7.org/fhir/ValueSet/encounter-special-arrangements
from the FHIR Standard
Encounter.hospitalization.dischargeDispositionpreferredUSCoreDischargeDisposition
http://hl7.org/fhir/us/core/ValueSet/us-core-discharge-disposition
Encounter.location.statusrequiredEncounterLocationStatus
http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1
from the FHIR Standard
Encounter.location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard

Differential View

This structure is derived from USCoreEncounterProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter USCoreEncounterProfile(7.0.0) 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
.... 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.

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

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

... location
.... location 1..1 Reference(US Core Location Profile(7.0.0)) Location the encounter takes place

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Encounter.extension:nursingHomeResidentialStatus.value[x]requiredhttps://valueset.x12.org/x217/005010/request/2000E/CL1/1/04/00/1345
https://valueset.x12.org/x217/005010/request/2000E/CL1/1/04/00/1345
Encounter.typerequiredhttps://valueset.x12.org/x217/005010/request/2000E/CL1/1/01/00/1315
https://valueset.x12.org/x217/005010/request/2000E/CL1/1/01/00/1315
Encounter.hospitalization.admitSourcerequiredhttps://valueset.x12.org/x217/005010/request/2000E/CL1/1/02/00/1314
https://valueset.x12.org/x217/005010/request/2000E/CL1/1/02/00/1314

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... 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.


.... nursingHomeResidentialStatus S 0..1 (Complex) Extension
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-nursingHomeResidentialStatus
..... extension 0..0
..... 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.

... 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 (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) 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)) 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) | US Core Condition Encounter Diagnosis Profile(7.0.0)) 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: US Core Discharge Disposition (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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.extension:nursingHomeResidentialStatus.value[x]requiredhttps://valueset.x12.org/x217/005010/request/2000E/CL1/1/04/00/1345
https://valueset.x12.org/x217/005010/request/2000E/CL1/1/04/00/1345
Encounter.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Encounter.statusrequiredFixed Value: planned
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typerequiredhttps://valueset.x12.org/x217/005010/request/2000E/CL1/1/01/00/1315
https://valueset.x12.org/x217/005010/request/2000E/CL1/1/01/00/1315
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Encounter.hospitalization.admitSourcerequiredhttps://valueset.x12.org/x217/005010/request/2000E/CL1/1/02/00/1314
https://valueset.x12.org/x217/005010/request/2000E/CL1/1/02/00/1314
Encounter.hospitalization.dischargeDispositionpreferredUSCoreDischargeDisposition
http://hl7.org/fhir/us/core/ValueSet/us-core-discharge-disposition

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... 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.


.... 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
..... 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 (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 (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 (example): Indicates the urgency of the encounter.

... subject SΣ 1..1 Reference(PAS Beneficiary Patient) The patient or group present at the encounter
... episodeOfCare Σ 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
... basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
... participant SΣ 0..* BackboneElement List of participants involved in the encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣ 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: US Core Discharge Disposition (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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Encounter.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Encounter.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Encounter.extension:nursingHomeResidentialStatus.value[x]requiredhttps://valueset.x12.org/x217/005010/request/2000E/CL1/1/04/00/1345
https://valueset.x12.org/x217/005010/request/2000E/CL1/1/04/00/1345
Encounter.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Encounter.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Encounter.statusrequiredFixed Value: planned
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typerequiredhttps://valueset.x12.org/x217/005010/request/2000E/CL1/1/01/00/1315
https://valueset.x12.org/x217/005010/request/2000E/CL1/1/01/00/1315
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Encounter.priorityexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Encounter.diagnosis.usepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
from the FHIR Standard
Encounter.hospitalization.admitSourcerequiredhttps://valueset.x12.org/x217/005010/request/2000E/CL1/1/02/00/1314
https://valueset.x12.org/x217/005010/request/2000E/CL1/1/02/00/1314
Encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreferenceexampleDiet
http://hl7.org/fhir/ValueSet/encounter-diet
from the FHIR Standard
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
http://hl7.org/fhir/ValueSet/encounter-special-courtesy
from the FHIR Standard
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
http://hl7.org/fhir/ValueSet/encounter-special-arrangements
from the FHIR Standard
Encounter.hospitalization.dischargeDispositionpreferredUSCoreDischargeDisposition
http://hl7.org/fhir/us/core/ValueSet/us-core-discharge-disposition
Encounter.location.statusrequiredEncounterLocationStatus
http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1
from the FHIR Standard
Encounter.location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard

 

Other representations of profile: CSV, Excel, Schematron