Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions

• Content
• Detailed Descriptions
• XML
• JSON
• TTL

Resource Profile: Profile_R5_Encounter_R4

This cross-version profile allows R5 Encounter content to be represented via FHIR R4 Encounter resources.

Usages:

• Refer to this Profile: R5: Encounter within which this event occurred or which the event is tightly associated (new), R5: Encounters associated with the listed treatments (new), R5: Encounters associated with the listed treatments (new), R5: Encounter detected issue is part of (new)... Show 11 more, R5: Encounter associated with event (new), R5: The encounter or episode of care that establishes the context for this device use statement (new), R5: Context of the document content additional types, R5: The Encounter associated with this set of historic values (new), R5: Encounters associated with the listed treatments (new), R5: The healthcare event with which this genomics study is associated (new), R5: Encounter associated with NutritionIntake (new), R5: Applied-to encounter (new), R5: Subject of the payment (new), R5: Encounter within which this event occurred or which the event is tightly associated (new) and R5: Healthcare event during which this transport originated (new)

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	Encounter(4.0.1)	An interaction during which services are provided to the patient
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 Constraints: ext-1
extension:subjectStatus		0..1	CodeableConcept	R5: The current status of the subject in relation to the Encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.subjectStatus Binding: R5EncounterSubjectStatusForR4 (0.1.0) (example): Current status of the subject within the encounter. Constraints: ext-1
extension:careTeam		0..*	Reference(Cross-version Profile for R5.CareTeam for use in FHIR R4(0.1.0) | CareTeam)	R5: The group(s) that are allocated to participate in this encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.careTeam Constraints: ext-1
extension:virtualService		0..*	(Complex)	R5: Connection details of a virtual service (e.g. conference call) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.virtualService Constraints: ext-1
extension:plannedStartDate		0..1	dateTime	R5: The planned start date/time (or admission date) of the encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedStartDate Constraints: ext-1
extension:plannedEndDate		0..1	dateTime	R5: The planned end date/time (or discharge date) of the encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedEndDate Constraints: ext-1
extension:value		0..*	(Complex)	R5: Reason the encounter takes place (core or reference) additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.reason.value Constraints: ext-1
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
status	?!Σ	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:status		0..1	code	R5: planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.status Binding: R5EncounterStatusForR4 (0.1.0) (required): Current state of the encounter. Constraints: ext-1
class	Σ	1..1	Coding	Classification of patient encounter Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:class		0..*	CodeableConcept	R5: Classification of patient encounter context - e.g. Inpatient, outpatient additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.class Binding: R5EncounterClassForR4 (0.1.0) (preferred): Classification of the encounter. Constraints: ext-1
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Encounter.status	Base	required	EncounterStatus	📍4.0.1	tx.fhir.org
Encounter.class	Base	extensible	ActEncounterCode	📍3.0.0	THO v7.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	Encounter.implicitRules, Encounter.extension, Encounter.extension:subjectStatus, Encounter.extension:careTeam, Encounter.extension:virtualService, Encounter.extension:plannedStartDate, Encounter.extension:plannedEndDate, Encounter.extension:value, Encounter.modifierExtension, Encounter.status, Encounter.status.extension, Encounter.status.extension:status, Encounter.class, Encounter.class.extension, Encounter.class.extension:class	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Encounter.extension, Encounter.extension:subjectStatus, Encounter.extension:careTeam, Encounter.extension:virtualService, Encounter.extension:plannedStartDate, Encounter.extension:plannedEndDate, Encounter.extension:value, Encounter.modifierExtension, Encounter.status.extension, Encounter.status.extension:status, Encounter.class.extension, Encounter.class.extension:class	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from Encounter

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	Encounter(4.0.1)	An interaction during which services are provided to the patient
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:subjectStatus		0..1	CodeableConcept	R5: The current status of the subject in relation to the Encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.subjectStatus Binding: R5EncounterSubjectStatusForR4 (0.1.0) (example): Current status of the subject within the encounter.
extension:careTeam		0..*	Reference(Cross-version Profile for R5.CareTeam for use in FHIR R4(0.1.0) | CareTeam)	R5: The group(s) that are allocated to participate in this encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.careTeam
extension:virtualService		0..*	(Complex)	R5: Connection details of a virtual service (e.g. conference call) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.virtualService
extension:plannedStartDate		0..1	dateTime	R5: The planned start date/time (or admission date) of the encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedStartDate
extension:plannedEndDate		0..1	dateTime	R5: The planned end date/time (or discharge date) of the encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedEndDate
extension:value		0..*	(Complex)	R5: Reason the encounter takes place (core or reference) additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.reason.value
status
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:status		0..1	code	R5: planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.status Binding: R5EncounterStatusForR4 (0.1.0) (required): Current state of the encounter.
class
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:class		0..*	CodeableConcept	R5: Classification of patient encounter context - e.g. Inpatient, outpatient additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.class Binding: R5EncounterClassForR4 (0.1.0) (preferred): Classification of the encounter.
serviceType
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:serviceType		0..*	Reference(Cross-version Profile for R5.HealthcareService for use in FHIR R4(0.1.0) | HealthcareService)	R5: serviceType additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.serviceType
basedOn
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:basedOn		0..*	Reference(Resource)	R5: The request that initiated this encounter URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
participant
individual
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:actor		0..1	Reference(Resource)	R5: The individual, device, or service participating in the encounter URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
diagnosis
condition
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:condition		0..*	CodeableConcept	R5: The diagnosis relevant to the encounter additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.diagnosis.condition
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	Encounter(4.0.1)	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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:subjectStatus		0..1	CodeableConcept	R5: The current status of the subject in relation to the Encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.subjectStatus Binding: R5EncounterSubjectStatusForR4 (0.1.0) (example): Current status of the subject within the encounter. Constraints: ext-1
extension:careTeam		0..*	Reference(Cross-version Profile for R5.CareTeam for use in FHIR R4(0.1.0) | CareTeam)	R5: The group(s) that are allocated to participate in this encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.careTeam Constraints: ext-1
extension:virtualService		0..*	(Complex)	R5: Connection details of a virtual service (e.g. conference call) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.virtualService Constraints: ext-1
extension:plannedStartDate		0..1	dateTime	R5: The planned start date/time (or admission date) of the encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedStartDate Constraints: ext-1
extension:plannedEndDate		0..1	dateTime	R5: The planned end date/time (or discharge date) of the encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedEndDate Constraints: ext-1
extension:value		0..*	(Complex)	R5: Reason the encounter takes place (core or reference) additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.reason.value Constraints: ext-1
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
identifier	Σ	0..*	Identifier	Identifier(s) by which this encounter is known
status	?!Σ	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:status		0..1	code	R5: planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.status Binding: R5EncounterStatusForR4 (0.1.0) (required): Current state of the encounter. Constraints: ext-1
value		0..1	string	Primitive value for code
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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
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	Σ	1..1	Coding	Classification of patient encounter Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:class		0..*	CodeableConcept	R5: Classification of patient encounter context - e.g. Inpatient, outpatient additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.class Binding: R5EncounterClassForR4 (0.1.0) (preferred): Classification of the encounter. Constraints: ext-1
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
class		1..1	Coding	inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
period		1..1	Period	The time that the episode was in the specified class
type	Σ	0..*	CodeableConcept	Specific type of encounter Binding: EncounterType (example): The type of encounter.
serviceType	Σ	0..1	CodeableConcept	Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:serviceType		0..*	Reference(Cross-version Profile for R5.HealthcareService for use in FHIR R4(0.1.0) | HealthcareService)	R5: serviceType additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.serviceType Constraints: ext-1
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
priority		0..1	CodeableConcept	Indicates the urgency of the encounter Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter.
subject	Σ	0..1	Reference(Patient | Group)	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
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:basedOn		0..1	Reference(Resource)	R5: The request that initiated this encounter URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
participant	Σ	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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
type	Σ	0..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
period		0..1	Period	Period of time during the encounter that the participant participated
individual	Σ	0..1	Reference(Practitioner | PractitionerRole | RelatedPerson)	Persons involved in the encounter other than the patient
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:actor		0..1	Reference(Resource)	R5: The individual, device, or service participating in the encounter URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
appointment	Σ	0..*	Reference(Appointment)	The appointment that scheduled this encounter
period		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	Σ	0..*	CodeableConcept	Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
reasonReference	Σ	0..*	Reference(Condition | Procedure | 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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
condition	Σ	1..1	Reference(Condition | Procedure)	The diagnosis or procedure relevant to the encounter
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:condition		0..*	CodeableConcept	R5: The diagnosis relevant to the encounter additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.diagnosis.condition Constraints: ext-1
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
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		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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
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: Hl7VSReAdmissionIndicator (3.0.0) (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		0..1	CodeableConcept	Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition.
location		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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
location		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		0..1	Reference(Organization)	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	tx.fhir.org
Encounter.status	Base	required	EncounterStatus	📍4.0.1	tx.fhir.org
Encounter.statusHistory.​status	Base	required	EncounterStatus	📍4.0.1	tx.fhir.org
Encounter.class	Base	extensible	ActEncounterCode	📍3.0.0	THO v7.1
Encounter.classHistory.​class	Base	extensible	ActEncounterCode	📍3.0.0	THO v7.1
Encounter.type	Base	example	Encounter type	📍4.0.1	FHIR Std.
Encounter.serviceType	Base	example	Service type	📍4.0.1	FHIR Std.
Encounter.priority	Base	example	ActPriority	📍3.0.0	THO v7.1
Encounter.basedOn.type	Base	extensible	ResourceType	📍4.0.1	tx.fhir.org
Encounter.participant.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Encounter.participant.​individual.type	Base	extensible	ResourceType	📍4.0.1	tx.fhir.org
Encounter.reasonCode	Base	preferred	Encounter Reason Codes	📍4.0.1	FHIR Std.
Encounter.diagnosis.​condition.type	Base	extensible	ResourceType	📍4.0.1	tx.fhir.org
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.1
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	example	Discharge disposition	📍4.0.1	FHIR Std.
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	Encounter.meta, Encounter.implicitRules, Encounter.language, Encounter.text, Encounter.extension, Encounter.extension:subjectStatus, Encounter.extension:careTeam, Encounter.extension:virtualService, Encounter.extension:plannedStartDate, Encounter.extension:plannedEndDate, Encounter.extension:value, Encounter.modifierExtension, Encounter.identifier, Encounter.status, Encounter.status.extension, Encounter.status.extension:status, Encounter.statusHistory, Encounter.statusHistory.extension, Encounter.statusHistory.modifierExtension, Encounter.statusHistory.status, Encounter.statusHistory.period, Encounter.class, Encounter.class.extension, Encounter.class.extension:class, Encounter.class.system, Encounter.class.version, Encounter.class.code, Encounter.class.display, Encounter.class.userSelected, Encounter.classHistory, Encounter.classHistory.extension, Encounter.classHistory.modifierExtension, Encounter.classHistory.class, Encounter.classHistory.period, Encounter.type, Encounter.serviceType, Encounter.serviceType.extension, Encounter.serviceType.extension:serviceType, Encounter.serviceType.coding, Encounter.serviceType.text, Encounter.priority, Encounter.subject, Encounter.episodeOfCare, Encounter.basedOn, Encounter.basedOn.extension, Encounter.basedOn.extension:basedOn, Encounter.basedOn.reference, Encounter.basedOn.type, Encounter.basedOn.identifier, Encounter.basedOn.display, Encounter.participant, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant.type, Encounter.participant.period, Encounter.participant.individual, Encounter.participant.individual.extension, Encounter.participant.individual.extension:actor, Encounter.participant.individual.reference, Encounter.participant.individual.type, Encounter.participant.individual.identifier, Encounter.participant.individual.display, Encounter.appointment, Encounter.period, Encounter.length, Encounter.reasonCode, Encounter.reasonReference, Encounter.diagnosis, Encounter.diagnosis.extension, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition, Encounter.diagnosis.condition.extension, Encounter.diagnosis.condition.extension:condition, Encounter.diagnosis.condition.reference, Encounter.diagnosis.condition.type, Encounter.diagnosis.condition.identifier, Encounter.diagnosis.condition.display, Encounter.diagnosis.use, Encounter.diagnosis.rank, Encounter.account, Encounter.hospitalization, Encounter.hospitalization.extension, Encounter.hospitalization.modifierExtension, Encounter.hospitalization.preAdmissionIdentifier, Encounter.hospitalization.origin, Encounter.hospitalization.admitSource, Encounter.hospitalization.reAdmission, Encounter.hospitalization.dietPreference, Encounter.hospitalization.specialCourtesy, Encounter.hospitalization.specialArrangement, Encounter.hospitalization.destination, Encounter.hospitalization.dischargeDisposition, Encounter.location, Encounter.location.extension, Encounter.location.modifierExtension, Encounter.location.location, Encounter.location.status, Encounter.location.physicalType, Encounter.location.period, Encounter.serviceProvider, Encounter.partOf	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Encounter.extension, Encounter.extension:subjectStatus, Encounter.extension:careTeam, Encounter.extension:virtualService, Encounter.extension:plannedStartDate, Encounter.extension:plannedEndDate, Encounter.extension:value, Encounter.modifierExtension, Encounter.status.extension, Encounter.status.extension:status, Encounter.statusHistory.extension, Encounter.statusHistory.modifierExtension, Encounter.class.extension, Encounter.class.extension:class, Encounter.classHistory.extension, Encounter.classHistory.modifierExtension, Encounter.serviceType.extension, Encounter.serviceType.extension:serviceType, Encounter.basedOn.extension, Encounter.basedOn.extension:basedOn, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant.individual.extension, Encounter.participant.individual.extension:actor, Encounter.diagnosis.extension, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition.extension, Encounter.diagnosis.condition.extension:condition, Encounter.hospitalization.extension, Encounter.hospitalization.modifierExtension, Encounter.location.extension, Encounter.location.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from Encounter

Summary

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.subjectStatus|0.1.0
• http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.careTeam|0.1.0
• http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.virtualService|0.1.0
• http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedStartDate|0.1.0
• http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedEndDate|0.1.0
• http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.reason.value|0.1.0
• http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.status|0.1.0
• http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.class|0.1.0
• http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.serviceType|0.1.0
• http://hl7.org/fhir/StructureDefinition/alternate-reference|5.2.0
• http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.diagnosis.condition|0.1.0

Maturity: 0

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	Encounter(4.0.1)	An interaction during which services are provided to the patient
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 Constraints: ext-1
extension:subjectStatus		0..1	CodeableConcept	R5: The current status of the subject in relation to the Encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.subjectStatus Binding: R5EncounterSubjectStatusForR4 (0.1.0) (example): Current status of the subject within the encounter. Constraints: ext-1
extension:careTeam		0..*	Reference(Cross-version Profile for R5.CareTeam for use in FHIR R4(0.1.0) | CareTeam)	R5: The group(s) that are allocated to participate in this encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.careTeam Constraints: ext-1
extension:virtualService		0..*	(Complex)	R5: Connection details of a virtual service (e.g. conference call) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.virtualService Constraints: ext-1
extension:plannedStartDate		0..1	dateTime	R5: The planned start date/time (or admission date) of the encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedStartDate Constraints: ext-1
extension:plannedEndDate		0..1	dateTime	R5: The planned end date/time (or discharge date) of the encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedEndDate Constraints: ext-1
extension:value		0..*	(Complex)	R5: Reason the encounter takes place (core or reference) additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.reason.value Constraints: ext-1
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
status	?!Σ	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:status		0..1	code	R5: planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.status Binding: R5EncounterStatusForR4 (0.1.0) (required): Current state of the encounter. Constraints: ext-1
class	Σ	1..1	Coding	Classification of patient encounter Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:class		0..*	CodeableConcept	R5: Classification of patient encounter context - e.g. Inpatient, outpatient additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.class Binding: R5EncounterClassForR4 (0.1.0) (preferred): Classification of the encounter. Constraints: ext-1
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Encounter.status	Base	required	EncounterStatus	📍4.0.1	tx.fhir.org
Encounter.class	Base	extensible	ActEncounterCode	📍3.0.0	THO v7.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	Encounter.implicitRules, Encounter.extension, Encounter.extension:subjectStatus, Encounter.extension:careTeam, Encounter.extension:virtualService, Encounter.extension:plannedStartDate, Encounter.extension:plannedEndDate, Encounter.extension:value, Encounter.modifierExtension, Encounter.status, Encounter.status.extension, Encounter.status.extension:status, Encounter.class, Encounter.class.extension, Encounter.class.extension:class	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Encounter.extension, Encounter.extension:subjectStatus, Encounter.extension:careTeam, Encounter.extension:virtualService, Encounter.extension:plannedStartDate, Encounter.extension:plannedEndDate, Encounter.extension:value, Encounter.modifierExtension, Encounter.status.extension, Encounter.status.extension:status, Encounter.class.extension, Encounter.class.extension:class	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Differential View

This structure is derived from Encounter

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	Encounter(4.0.1)	An interaction during which services are provided to the patient
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:subjectStatus		0..1	CodeableConcept	R5: The current status of the subject in relation to the Encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.subjectStatus Binding: R5EncounterSubjectStatusForR4 (0.1.0) (example): Current status of the subject within the encounter.
extension:careTeam		0..*	Reference(Cross-version Profile for R5.CareTeam for use in FHIR R4(0.1.0) | CareTeam)	R5: The group(s) that are allocated to participate in this encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.careTeam
extension:virtualService		0..*	(Complex)	R5: Connection details of a virtual service (e.g. conference call) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.virtualService
extension:plannedStartDate		0..1	dateTime	R5: The planned start date/time (or admission date) of the encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedStartDate
extension:plannedEndDate		0..1	dateTime	R5: The planned end date/time (or discharge date) of the encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedEndDate
extension:value		0..*	(Complex)	R5: Reason the encounter takes place (core or reference) additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.reason.value
status
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:status		0..1	code	R5: planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.status Binding: R5EncounterStatusForR4 (0.1.0) (required): Current state of the encounter.
class
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:class		0..*	CodeableConcept	R5: Classification of patient encounter context - e.g. Inpatient, outpatient additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.class Binding: R5EncounterClassForR4 (0.1.0) (preferred): Classification of the encounter.
serviceType
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:serviceType		0..*	Reference(Cross-version Profile for R5.HealthcareService for use in FHIR R4(0.1.0) | HealthcareService)	R5: serviceType additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.serviceType
basedOn
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:basedOn		0..*	Reference(Resource)	R5: The request that initiated this encounter URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
participant
individual
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:actor		0..1	Reference(Resource)	R5: The individual, device, or service participating in the encounter URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
diagnosis
condition
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:condition		0..*	CodeableConcept	R5: The diagnosis relevant to the encounter additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.diagnosis.condition
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	Encounter(4.0.1)	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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:subjectStatus		0..1	CodeableConcept	R5: The current status of the subject in relation to the Encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.subjectStatus Binding: R5EncounterSubjectStatusForR4 (0.1.0) (example): Current status of the subject within the encounter. Constraints: ext-1
extension:careTeam		0..*	Reference(Cross-version Profile for R5.CareTeam for use in FHIR R4(0.1.0) | CareTeam)	R5: The group(s) that are allocated to participate in this encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.careTeam Constraints: ext-1
extension:virtualService		0..*	(Complex)	R5: Connection details of a virtual service (e.g. conference call) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.virtualService Constraints: ext-1
extension:plannedStartDate		0..1	dateTime	R5: The planned start date/time (or admission date) of the encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedStartDate Constraints: ext-1
extension:plannedEndDate		0..1	dateTime	R5: The planned end date/time (or discharge date) of the encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedEndDate Constraints: ext-1
extension:value		0..*	(Complex)	R5: Reason the encounter takes place (core or reference) additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.reason.value Constraints: ext-1
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
identifier	Σ	0..*	Identifier	Identifier(s) by which this encounter is known
status	?!Σ	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:status		0..1	code	R5: planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.status Binding: R5EncounterStatusForR4 (0.1.0) (required): Current state of the encounter. Constraints: ext-1
value		0..1	string	Primitive value for code
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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
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	Σ	1..1	Coding	Classification of patient encounter Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:class		0..*	CodeableConcept	R5: Classification of patient encounter context - e.g. Inpatient, outpatient additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.class Binding: R5EncounterClassForR4 (0.1.0) (preferred): Classification of the encounter. Constraints: ext-1
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
class		1..1	Coding	inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
period		1..1	Period	The time that the episode was in the specified class
type	Σ	0..*	CodeableConcept	Specific type of encounter Binding: EncounterType (example): The type of encounter.
serviceType	Σ	0..1	CodeableConcept	Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:serviceType		0..*	Reference(Cross-version Profile for R5.HealthcareService for use in FHIR R4(0.1.0) | HealthcareService)	R5: serviceType additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.serviceType Constraints: ext-1
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
priority		0..1	CodeableConcept	Indicates the urgency of the encounter Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter.
subject	Σ	0..1	Reference(Patient | Group)	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
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:basedOn		0..1	Reference(Resource)	R5: The request that initiated this encounter URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
participant	Σ	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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
type	Σ	0..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
period		0..1	Period	Period of time during the encounter that the participant participated
individual	Σ	0..1	Reference(Practitioner | PractitionerRole | RelatedPerson)	Persons involved in the encounter other than the patient
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:actor		0..1	Reference(Resource)	R5: The individual, device, or service participating in the encounter URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
appointment	Σ	0..*	Reference(Appointment)	The appointment that scheduled this encounter
period		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	Σ	0..*	CodeableConcept	Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
reasonReference	Σ	0..*	Reference(Condition | Procedure | 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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
condition	Σ	1..1	Reference(Condition | Procedure)	The diagnosis or procedure relevant to the encounter
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:condition		0..*	CodeableConcept	R5: The diagnosis relevant to the encounter additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.diagnosis.condition Constraints: ext-1
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
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		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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
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: Hl7VSReAdmissionIndicator (3.0.0) (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		0..1	CodeableConcept	Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition.
location		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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
location		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		0..1	Reference(Organization)	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	tx.fhir.org
Encounter.status	Base	required	EncounterStatus	📍4.0.1	tx.fhir.org
Encounter.statusHistory.​status	Base	required	EncounterStatus	📍4.0.1	tx.fhir.org
Encounter.class	Base	extensible	ActEncounterCode	📍3.0.0	THO v7.1
Encounter.classHistory.​class	Base	extensible	ActEncounterCode	📍3.0.0	THO v7.1
Encounter.type	Base	example	Encounter type	📍4.0.1	FHIR Std.
Encounter.serviceType	Base	example	Service type	📍4.0.1	FHIR Std.
Encounter.priority	Base	example	ActPriority	📍3.0.0	THO v7.1
Encounter.basedOn.type	Base	extensible	ResourceType	📍4.0.1	tx.fhir.org
Encounter.participant.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Encounter.participant.​individual.type	Base	extensible	ResourceType	📍4.0.1	tx.fhir.org
Encounter.reasonCode	Base	preferred	Encounter Reason Codes	📍4.0.1	FHIR Std.
Encounter.diagnosis.​condition.type	Base	extensible	ResourceType	📍4.0.1	tx.fhir.org
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.1
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	example	Discharge disposition	📍4.0.1	FHIR Std.
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	Encounter.meta, Encounter.implicitRules, Encounter.language, Encounter.text, Encounter.extension, Encounter.extension:subjectStatus, Encounter.extension:careTeam, Encounter.extension:virtualService, Encounter.extension:plannedStartDate, Encounter.extension:plannedEndDate, Encounter.extension:value, Encounter.modifierExtension, Encounter.identifier, Encounter.status, Encounter.status.extension, Encounter.status.extension:status, Encounter.statusHistory, Encounter.statusHistory.extension, Encounter.statusHistory.modifierExtension, Encounter.statusHistory.status, Encounter.statusHistory.period, Encounter.class, Encounter.class.extension, Encounter.class.extension:class, Encounter.class.system, Encounter.class.version, Encounter.class.code, Encounter.class.display, Encounter.class.userSelected, Encounter.classHistory, Encounter.classHistory.extension, Encounter.classHistory.modifierExtension, Encounter.classHistory.class, Encounter.classHistory.period, Encounter.type, Encounter.serviceType, Encounter.serviceType.extension, Encounter.serviceType.extension:serviceType, Encounter.serviceType.coding, Encounter.serviceType.text, Encounter.priority, Encounter.subject, Encounter.episodeOfCare, Encounter.basedOn, Encounter.basedOn.extension, Encounter.basedOn.extension:basedOn, Encounter.basedOn.reference, Encounter.basedOn.type, Encounter.basedOn.identifier, Encounter.basedOn.display, Encounter.participant, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant.type, Encounter.participant.period, Encounter.participant.individual, Encounter.participant.individual.extension, Encounter.participant.individual.extension:actor, Encounter.participant.individual.reference, Encounter.participant.individual.type, Encounter.participant.individual.identifier, Encounter.participant.individual.display, Encounter.appointment, Encounter.period, Encounter.length, Encounter.reasonCode, Encounter.reasonReference, Encounter.diagnosis, Encounter.diagnosis.extension, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition, Encounter.diagnosis.condition.extension, Encounter.diagnosis.condition.extension:condition, Encounter.diagnosis.condition.reference, Encounter.diagnosis.condition.type, Encounter.diagnosis.condition.identifier, Encounter.diagnosis.condition.display, Encounter.diagnosis.use, Encounter.diagnosis.rank, Encounter.account, Encounter.hospitalization, Encounter.hospitalization.extension, Encounter.hospitalization.modifierExtension, Encounter.hospitalization.preAdmissionIdentifier, Encounter.hospitalization.origin, Encounter.hospitalization.admitSource, Encounter.hospitalization.reAdmission, Encounter.hospitalization.dietPreference, Encounter.hospitalization.specialCourtesy, Encounter.hospitalization.specialArrangement, Encounter.hospitalization.destination, Encounter.hospitalization.dischargeDisposition, Encounter.location, Encounter.location.extension, Encounter.location.modifierExtension, Encounter.location.location, Encounter.location.status, Encounter.location.physicalType, Encounter.location.period, Encounter.serviceProvider, Encounter.partOf	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Encounter.extension, Encounter.extension:subjectStatus, Encounter.extension:careTeam, Encounter.extension:virtualService, Encounter.extension:plannedStartDate, Encounter.extension:plannedEndDate, Encounter.extension:value, Encounter.modifierExtension, Encounter.status.extension, Encounter.status.extension:status, Encounter.statusHistory.extension, Encounter.statusHistory.modifierExtension, Encounter.class.extension, Encounter.class.extension:class, Encounter.classHistory.extension, Encounter.classHistory.modifierExtension, Encounter.serviceType.extension, Encounter.serviceType.extension:serviceType, Encounter.basedOn.extension, Encounter.basedOn.extension:basedOn, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant.individual.extension, Encounter.participant.individual.extension:actor, Encounter.diagnosis.extension, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition.extension, Encounter.diagnosis.condition.extension:condition, Encounter.hospitalization.extension, Encounter.hospitalization.modifierExtension, Encounter.location.extension, Encounter.location.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from Encounter

Summary

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.subjectStatus|0.1.0
• http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.careTeam|0.1.0
• http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.virtualService|0.1.0
• http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedStartDate|0.1.0
• http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedEndDate|0.1.0
• http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.reason.value|0.1.0
• http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.status|0.1.0
• http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.class|0.1.0
• http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.serviceType|0.1.0
• http://hl7.org/fhir/StructureDefinition/alternate-reference|5.2.0
• http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.diagnosis.condition|0.1.0

Maturity: 0

Other representations of profile: CSV, Excel, Schematron