haau3 Encounter - haau3 FHIR Implementation Guide (HFIG) v1.0.0

A set of rules under which this content was created

language

0..1

Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional Bindings

Purpose

AllLanguages

Max Binding

text

0..1

Narrative

Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements

contained

0..*

Resource

Contained, inline Resources

0..*

Additional content defined by implementations

0..*

Extensions that cannot be ignored

identifier

1..*

(USCDI) Identifier(s) by which this encounter is known

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

use

0..1

usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

0..1

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

1..1

(USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient

value

1..1

(USCDI) The value that is unique
Example General: 123456

0..1

Time period when id is/was valid for use

assigner

0..1

Reference(Organization)

Organization that issued id (may be just text)

1..1

statusHistory

0..*

List of past encounter statuses

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

0..*

Extensions that cannot be ignored even if unrecognized

1..1

1..1

The time that the episode was in the specified status

1..1

(USCDI) Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.

classHistory

0..*

List of past encounter classes

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

0..*

Extensions that cannot be ignored even if unrecognized

1..1

inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.

1..1

The time that the episode was in the specified class

1..*

(USCDI) Specific type of encounter
Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type

serviceType

0..1

Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.

priority

0..1

Reference(US Core Patient Profile)

Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.

subject

1..1

(USCDI) 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

0..*

(USCDI) List of participants involved in the encounter

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

0..*

Extensions that cannot be ignored even if unrecognized

0..*

(USCDI) Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.

0..1

Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile)

(USCDI) Period of time during the encounter that the participant participated

individual

0..1

(USCDI) Persons involved in the encounter other than the patient

appointment

0..*

Reference(Appointment)

The appointment that scheduled this encounter

0..1

(USCDI) The start and end time of the encounter

length

0..1

Duration

Quantity of time the encounter lasted (less time absent)

reasonCode

0..*

Reference(US Core Condition Problems and Health Concerns Profile | US Core Condition Encounter Diagnosis Profile | US Core Procedure Profile | Observation | ImmunizationRecommendation)

(USCDI) Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.

reasonReference

0..*

(USCDI) Reason the encounter takes place (reference)

diagnosis

0..*

The list of diagnosis relevant to this encounter

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

0..*

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

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

0..1

(USCDI) Details about the admission to a healthcare service

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

0..*

Extensions that cannot be ignored even if unrecognized

preAdmissionIdentifier

0..1

Pre-admission identifier

origin

0..1

The location/organization from which the patient came before admission

admitSource

0..1

From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.

reAdmission

0..1

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

Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.

specialCourtesy

0..*

Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.

specialArrangement

0..*

Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.

destination

0..1

Location/organization to which the patient is discharged

dischargeDisposition

0..1

(USCDI) Category or kind of location after discharge
Binding: US Core Discharge Disposition (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17

0..*

(USCDI) List of locations where the patient has been

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

0..*

Extensions that cannot be ignored even if unrecognized

1..1

Reference(Location)

(USCDI) Location the encounter takes place

0..1

planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.

physicalType

0..1

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.

0..1

Reference(US Core Organization Profile)

Time period during which the patient was present at the location

serviceProvider

0..1

(USCDI) The organization (facility) responsible for this encounter

partOf

0..1

Reference(Encounter)

Another Encounter this encounter is part of

Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Encounter.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
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	extensible	US Core Encounter Type	📦6.1.0	US Core v6.1
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	preferred	Admit source	📦4.0.1	FHIR Std.
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	📦6.1.0	US Core v6.1
Encounter.location.status	Base	required	EncounterLocationStatus	📍4.0.1	FHIR Std.
Encounter.location.physicalType	Base	example	Location type	📦4.0.1	FHIR Std.

Constraints

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

This structure is derived from USCoreEncounterProfile

Summary

Mandatory: 1 element

Key Elements View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Encounter		0..*	USCoreEncounterProfile(6.1.0)	An interaction during which services are provided to the patient
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.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.	1..*	Identifier	(USCDI) 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	(USCDI) 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	(USCDI) 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	(USCDI) planned \| arrived \| triaged \| in-progress \| onleave \| finished \| cancelled + Binding: EncounterStatus (required): Current state of the encounter.
Encounter.class	This element must be supported. This element is included in summaries.	1..1	Coding	(USCDI) Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter.
Encounter.type	This element must be supported. This element is included in summaries.	1..*	CodeableConcept	(USCDI) Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type
Encounter.subject	This element must be supported. This element is included in summaries.	1..1	Reference(US Core Patient Profile)	(USCDI) The patient or group present at the encounter
Encounter.participant	This element must be supported. This element is included in summaries.	0..*	BackboneElement	(USCDI) 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	(USCDI) Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
Encounter.participant.period	This element must be supported.	0..1	Period	(USCDI) 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 This type must be supported. \| US Core PractitionerRole Profile \| US Core RelatedPerson Profile)	(USCDI) Persons involved in the encounter other than the patient
Encounter.period	This element must be supported.	0..1	Period	(USCDI) The start and end time of the encounter
Encounter.reasonCode	This element must be supported. This element is included in summaries.	0..*	CodeableConcept	(USCDI) 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 This type must be supported. \| US Core Condition Encounter Diagnosis Profile This type must be supported. \| US Core Procedure Profile \| Observation \| ImmunizationRecommendation)	(USCDI) Reason the encounter takes place (reference)
Encounter.hospitalization	This element must be supported.	0..1	BackboneElement	(USCDI) 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.dischargeDisposition	This element must be supported.	0..1	CodeableConcept	(USCDI) Category or kind of location after discharge Binding: US Core Discharge Disposition (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17
Encounter.location	This element must be supported.	0..*	BackboneElement	(USCDI) 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(Location)	(USCDI) Location the encounter takes place
Encounter.serviceProvider	This element must be supported.	0..1	Reference(US Core Organization Profile)	(USCDI) The organization (facility) responsible for this encounter
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
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	extensible	US Core Encounter Type	📦6.1.0	US Core v6.1
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.dischargeDisposition	Base	preferred	US Core Discharge Disposition	📦6.1.0	US Core v6.1

Constraints

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

Differential View

This structure is derived from USCoreEncounterProfile

Name	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Encounter	0..*	USCoreEncounterProfile(6.1.0)	An interaction during which services are provided to the patient
Encounter.identifier	1..*	Identifier	(USCDI) Identifier(s) by which this encounter is known
Documentation for this format

Snapshot View

Description & Constraints Filter:

Encounter

0..*

USCoreEncounterProfile(6.1.0)

An interaction during which services are provided to the patient

0..1

Logical id of this artifact

Meta

Metadata about the resource

implicitRules

0..1

A set of rules under which this content was created

language

0..1

Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional Bindings

Purpose

AllLanguages

Max Binding

text

0..1

Narrative

Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements

contained

0..*

Resource

Contained, inline Resources

0..*

Additional content defined by implementations

0..*

Extensions that cannot be ignored

identifier

1..*

(USCDI) Identifier(s) by which this encounter is known

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

use

0..1

usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

0..1

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

1..1

(USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient

value

1..1

(USCDI) The value that is unique
Example General: 123456

0..1

Time period when id is/was valid for use

assigner

0..1

Reference(Organization)

Organization that issued id (may be just text)

1..1

statusHistory

0..*

List of past encounter statuses

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

0..*

Extensions that cannot be ignored even if unrecognized

1..1

1..1

The time that the episode was in the specified status

1..1

(USCDI) Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.

classHistory

0..*

List of past encounter classes

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

0..*

Extensions that cannot be ignored even if unrecognized

1..1

inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.

1..1

The time that the episode was in the specified class

1..*

(USCDI) Specific type of encounter
Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type

serviceType

0..1

Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.

priority

0..1

Reference(US Core Patient Profile)

Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.

subject

1..1

(USCDI) 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

0..*

(USCDI) List of participants involved in the encounter

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

0..*

Extensions that cannot be ignored even if unrecognized

0..*

(USCDI) Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.

0..1

Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile)

(USCDI) Period of time during the encounter that the participant participated

individual

0..1

(USCDI) Persons involved in the encounter other than the patient

appointment

0..*

Reference(Appointment)

The appointment that scheduled this encounter

0..1

(USCDI) The start and end time of the encounter

length

0..1

Duration

Quantity of time the encounter lasted (less time absent)

reasonCode

0..*

Reference(US Core Condition Problems and Health Concerns Profile | US Core Condition Encounter Diagnosis Profile | US Core Procedure Profile | Observation | ImmunizationRecommendation)

(USCDI) Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.

reasonReference

0..*

(USCDI) Reason the encounter takes place (reference)

diagnosis

0..*

The list of diagnosis relevant to this encounter

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

0..*

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

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

0..1

(USCDI) Details about the admission to a healthcare service

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

0..*

Extensions that cannot be ignored even if unrecognized

preAdmissionIdentifier

0..1

Pre-admission identifier

origin

0..1

The location/organization from which the patient came before admission

admitSource

0..1

From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.

0..1

0..*

Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.

specialCourtesy

0..*

Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.

specialArrangement

0..*

Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.

destination

0..1

Location/organization to which the patient is discharged

dischargeDisposition

0..1

(USCDI) Category or kind of location after discharge
Binding: US Core Discharge Disposition (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17

0..*

(USCDI) List of locations where the patient has been

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

0..*

Extensions that cannot be ignored even if unrecognized

1..1

Reference(Location)

(USCDI) Location the encounter takes place

0..1

planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.

physicalType

0..1

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.

0..1