VoiceaBiomarkerforAI - Local Development build (v2.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: VBAI Encounter

An encounter profile based on US Core Encounter.

Usage:

• Refer to this Resource Profile: VBAI Body Height, VBAI Body Weight, VBAI Condition, VBAI Imaging Media... Show 3 more, VBAI Imaging Study, VBAI Vital Signs and VBAI Waveform Media

Formal Views of Profile Content

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

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

This structure is derived from USCoreEncounterProfile

Name	Flags	Card.	Type	Description & Constraints
Encounter			USCoreEncounterProfile
type		1..*	CodeableConcept	Specific type of encounter Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 308335008
display		1..1	string	Representation defined by the system Fixed Value: Patient encounter procedure
subject		1..1	Reference(VBAI Patient)	The patient or group present at the encounter
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	USCoreEncounterProfile	An interaction during which services are provided to the patient
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Identifier(s) by which this encounter is known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
status	?!SΣ	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
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: US Core Encounter Type (extensible): Valueset to describe the Encounter Type Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 308335008
display		1..1	string	Representation defined by the system Fixed Value: Patient encounter procedure
subject	SΣ	1..1	Reference(VBAI 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)	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 | US Core Condition Encounter Diagnosis Profile)	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
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(Location)	Location the encounter takes place
serviceProvider	S	0..1	Reference(US Core Organization Profile)	The organization (facility) responsible for this encounter
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Encounter.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Encounter.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard
Encounter.class	extensible	ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.type	extensible	Pattern: SNOMED-CT Code 308335008("Patient encounter procedure") http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type
Encounter.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Encounter.reasonCode	preferred	EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard
Encounter.hospitalization.dischargeDisposition	preferred	USCoreDischargeDisposition (a valid code from http://www.nubc.org/patient-discharge) http://hl7.org/fhir/us/core/ValueSet/us-core-discharge-disposition

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Encounter	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Encounter	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Encounter	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	USCoreEncounterProfile	An interaction during which services are provided to the patient
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
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.
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: US Core Encounter Type (extensible): Valueset to describe the Encounter Type Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 308335008
display		1..1	string	Representation defined by the system Fixed Value: Patient encounter procedure
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
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(VBAI 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 S | US Core PractitionerRole Profile | US Core RelatedPerson Profile)	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 S | US Core Condition Encounter Diagnosis Profile S | US Core Procedure Profile | 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		0..1	CodeableConcept	From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted.
reAdmission		0..1	CodeableConcept	The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
dietPreference		0..*	CodeableConcept	Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
specialCourtesy		0..*	CodeableConcept	Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies.
specialArrangement		0..*	CodeableConcept	Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements.
destination		0..1	Reference(Location | Organization)	Location/organization to which the patient is discharged
dischargeDisposition	S	0..1	CodeableConcept	Category or kind of location after discharge Binding: US Core Discharge Disposition (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17
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(Location)	Location the encounter takes place
status		0..1	code	planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location.
physicalType		0..1	CodeableConcept	The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location.
period		0..1	Period	Time period during which the patient was present at the location
serviceProvider	S	0..1	Reference(US Core Organization Profile)	The organization (facility) responsible for this encounter
partOf		0..1	Reference(Encounter)	Another Encounter this encounter is part of
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Encounter.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Encounter.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Encounter.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Encounter.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard
Encounter.statusHistory.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard
Encounter.class	extensible	ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.classHistory.class	extensible	ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.type	extensible	Pattern: SNOMED-CT Code 308335008("Patient encounter procedure") http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type
Encounter.serviceType	example	ServiceType http://hl7.org/fhir/ValueSet/service-type from the FHIR Standard
Encounter.priority	example	ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Encounter.reasonCode	preferred	EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard
Encounter.diagnosis.use	preferred	DiagnosisRole http://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard
Encounter.hospitalization.admitSource	preferred	AdmitSource http://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard
Encounter.hospitalization.reAdmission	example	Hl7VSReAdmissionIndicator http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreference	example	Diet http://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard
Encounter.hospitalization.specialCourtesy	preferred	SpecialCourtesy http://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard
Encounter.hospitalization.specialArrangement	preferred	SpecialArrangements http://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard
Encounter.hospitalization.dischargeDisposition	preferred	USCoreDischargeDisposition (a valid code from http://www.nubc.org/patient-discharge) http://hl7.org/fhir/us/core/ValueSet/us-core-discharge-disposition
Encounter.location.status	required	EncounterLocationStatus http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard
Encounter.location.physicalType	example	LocationType http://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Encounter	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Encounter	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Encounter	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from USCoreEncounterProfile

Summary

Structures

This structure refers to these other structures:

• VBAI Patient (https://kind-lab.github.io/vbai-fhir/StructureDefinition/vbai-patient)

Differential View

This structure is derived from USCoreEncounterProfile

Name	Flags	Card.	Type	Description & Constraints
Encounter			USCoreEncounterProfile
type		1..*	CodeableConcept	Specific type of encounter Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 308335008
display		1..1	string	Representation defined by the system Fixed Value: Patient encounter procedure
subject		1..1	Reference(VBAI Patient)	The patient or group present at the encounter
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	USCoreEncounterProfile	An interaction during which services are provided to the patient
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Identifier(s) by which this encounter is known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
status	?!SΣ	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
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: US Core Encounter Type (extensible): Valueset to describe the Encounter Type Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 308335008
display		1..1	string	Representation defined by the system Fixed Value: Patient encounter procedure
subject	SΣ	1..1	Reference(VBAI 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)	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 | US Core Condition Encounter Diagnosis Profile)	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
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(Location)	Location the encounter takes place
serviceProvider	S	0..1	Reference(US Core Organization Profile)	The organization (facility) responsible for this encounter
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Encounter.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Encounter.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard
Encounter.class	extensible	ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.type	extensible	Pattern: SNOMED-CT Code 308335008("Patient encounter procedure") http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type
Encounter.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Encounter.reasonCode	preferred	EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard
Encounter.hospitalization.dischargeDisposition	preferred	USCoreDischargeDisposition (a valid code from http://www.nubc.org/patient-discharge) http://hl7.org/fhir/us/core/ValueSet/us-core-discharge-disposition

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Encounter	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Encounter	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Encounter	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	USCoreEncounterProfile	An interaction during which services are provided to the patient
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
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.
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: US Core Encounter Type (extensible): Valueset to describe the Encounter Type Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 308335008
display		1..1	string	Representation defined by the system Fixed Value: Patient encounter procedure
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
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(VBAI 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 S | US Core PractitionerRole Profile | US Core RelatedPerson Profile)	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 S | US Core Condition Encounter Diagnosis Profile S | US Core Procedure Profile | 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		0..1	CodeableConcept	From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted.
reAdmission		0..1	CodeableConcept	The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
dietPreference		0..*	CodeableConcept	Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
specialCourtesy		0..*	CodeableConcept	Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies.
specialArrangement		0..*	CodeableConcept	Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements.
destination		0..1	Reference(Location | Organization)	Location/organization to which the patient is discharged
dischargeDisposition	S	0..1	CodeableConcept	Category or kind of location after discharge Binding: US Core Discharge Disposition (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17
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(Location)	Location the encounter takes place
status		0..1	code	planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location.
physicalType		0..1	CodeableConcept	The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location.
period		0..1	Period	Time period during which the patient was present at the location
serviceProvider	S	0..1	Reference(US Core Organization Profile)	The organization (facility) responsible for this encounter
partOf		0..1	Reference(Encounter)	Another Encounter this encounter is part of
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Encounter.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Encounter.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Encounter.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Encounter.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard
Encounter.statusHistory.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard
Encounter.class	extensible	ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.classHistory.class	extensible	ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.type	extensible	Pattern: SNOMED-CT Code 308335008("Patient encounter procedure") http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type
Encounter.serviceType	example	ServiceType http://hl7.org/fhir/ValueSet/service-type from the FHIR Standard
Encounter.priority	example	ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Encounter.reasonCode	preferred	EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard
Encounter.diagnosis.use	preferred	DiagnosisRole http://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard
Encounter.hospitalization.admitSource	preferred	AdmitSource http://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard
Encounter.hospitalization.reAdmission	example	Hl7VSReAdmissionIndicator http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreference	example	Diet http://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard
Encounter.hospitalization.specialCourtesy	preferred	SpecialCourtesy http://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard
Encounter.hospitalization.specialArrangement	preferred	SpecialArrangements http://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard
Encounter.hospitalization.dischargeDisposition	preferred	USCoreDischargeDisposition (a valid code from http://www.nubc.org/patient-discharge) http://hl7.org/fhir/us/core/ValueSet/us-core-discharge-disposition
Encounter.location.status	required	EncounterLocationStatus http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard
Encounter.location.physicalType	example	LocationType http://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Encounter	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Encounter	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Encounter	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from USCoreEncounterProfile

Summary

Structures

This structure refers to these other structures:

• VBAI Patient (https://kind-lab.github.io/vbai-fhir/StructureDefinition/vbai-patient)

Other representations of profile: CSV, Excel, Schematron