PT_Encounter - HL7 PT FHIR Implementation Guide: Visita do Utente v1.0.0

HL7 PT FHIR Implementation Guide: Visita do Utente
1.0.0 - STU1 Portugal flag

HL7 PT FHIR Implementation Guide: Visita do Utente, published by HL7 Portugal. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-pt/workflow-ep-ig/tree/master and changes regularly. See the Directory of published versions

Resource Profile: PT_Encounter

Official URL: https://hl7.pt/fhir/patient-visit/StructureDefinition/PTEncounter				Version: 1.0.0
Active as of 2022-01-13				Computable Name: PT_Encounter

Representa a interação entre o utente e os cuidados de saúde, como consultas, internamentos, intervenções cirúrgicas, exames, urgências e outros eventos clínicos. Inclui informações como motivo do episódio, profissionais envolvidos, intervenções realizadas e resultados obtidos, sendo essencial para a continuidade dos cuidados. Este registo detalhado é essencial para construir um histórico completo e acessível do percurso de saúde do utente, facilitando a continuidade dos cuidados e o planeamento de futuras intervenções.

Usage:

This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	Encounter	An interaction during which services are provided to the patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
meta	Σ	0..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
lastUpdated	Σ	0..1	instant	When the resource version last changed ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!Σ	1..1	code	planned \| arrived \| triaged \| in-progress \| onleave \| finished \| cancelled + Binding: EncounterStatus (required): Current state of the encounter. ele-1: All FHIR elements must have a @value or children
statusHistory		0..*	BackboneElement	List of past encounter statuses ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status		1..1	code	planned \| arrived \| triaged \| in-progress \| onleave \| finished \| cancelled + Binding: EncounterStatus (required): Current state of the encounter. ele-1: All FHIR elements must have a @value or children
period		1..1	Period	The time that the episode was in the specified status ele-1: All FHIR elements must have a @value or children
class	Σ	1..1	Coding	Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. ele-1: All FHIR elements must have a @value or children
code	Σ	0..1	code	Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children
classHistory		0..*	BackboneElement	List of past encounter classes ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
class		1..1	Coding	inpatient \| outpatient \| ambulatory \| emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. ele-1: All FHIR elements must have a @value or children
period		1..1	Period	The time that the episode was in the specified class ele-1: All FHIR elements must have a @value or children
type	Σ	0..*	CodeableConcept	Specific type of encounter Binding: hl7VS-admissionType (example) ele-1: All FHIR elements must have a @value or children
text	Σ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children
serviceType	Σ	0..1	CodeableConcept	Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. ele-1: All FHIR elements must have a @value or children
text	Σ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children
priority		0..1	CodeableConcept	Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. ele-1: All FHIR elements must have a @value or children
text	Σ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children
subject	Σ	0..1	Reference(PT_Patient)	The patient or group present at the encounter ele-1: All FHIR elements must have a @value or children
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children
participant	Σ	0..*	BackboneElement	List of participants involved in the encounter ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type	Σ	0..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. ele-1: All FHIR elements must have a @value or children
text	Σ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children
individual	Σ	0..1	Reference(PT_Practitioner \| PT_PractitionerRole \| https://hl7.pt/fhir/patient-visit/StructureDefinition/PTRelatedPerson)	Persons involved in the encounter other than the patient ele-1: All FHIR elements must have a @value or children
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children
reasonCode	Σ	0..*	CodeableConcept	Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. ele-1: All FHIR elements must have a @value or children
text	Σ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children
reasonReference	Σ	0..*	Reference(https://hl7.pt/fhir/patient-visit/StructureDefinition/PTCondition)	Reason the encounter takes place (reference) ele-1: All FHIR elements must have a @value or children
serviceProvider		0..1	Reference(PT_Organization)	The organization (facility) responsible for this encounter ele-1: All FHIR elements must have a @value or children
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
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	example	Hl7VSAdmissionType `http://terminology.hl7.org/ValueSet/v2-0007`
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

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 Encounter

Name	Card.	Type	Description & Constraints
Encounter	0..*	Encounter	An interaction during which services are provided to the patient
meta	0..1	Meta	Metadata about the resource
id	0..0
versionId	0..0
lastUpdated	0..1	instant	When the resource version last changed
source	0..0
profile	0..0
security	0..0
tag	0..0
implicitRules	0..0
language	0..0
text	0..0
contained	0..0
identifier
id	0..0
use	0..1	code	usual \| official \| temp \| secondary \| old (If known)
type
id	0..0
coding
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
value	0..1	string	The value that is unique
period
id	0..0
start	0..1	dateTime	Starting time with inclusive boundary
end	0..1	dateTime	End time with inclusive boundary, if not ongoing
assigner
id	0..0
reference	0..0
type	0..0
identifier	0..0
display	0..1	string	Text alternative for the resource
status	1..1	code	planned \| arrived \| triaged \| in-progress \| onleave \| finished \| cancelled +
statusHistory	0..*	BackboneElement	List of past encounter statuses
id	0..0
class	1..1	Coding	Classification of patient encounter
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
userSelected	0..0
classHistory	0..*	BackboneElement	List of past encounter classes
id	0..0
type	0..*	CodeableConcept	Specific type of encounter Binding: hl7VS-admissionType (example)
id	0..0
coding
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
serviceType	0..1	CodeableConcept	Specific type of service
id	0..0
coding
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
priority	0..1	CodeableConcept	Indicates the urgency of the encounter
id	0..0
coding
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
subject	0..1	Reference(PT_Patient)	The patient or group present at the encounter
id	0..0
reference	0..1	string	Literal reference, Relative, internal or absolute URL
type	0..0
identifier	0..0
display	0..0
episodeOfCare	0..0
participant	0..*	BackboneElement	List of participants involved in the encounter
id	0..0
type	0..*	CodeableConcept	Role of participant in encounter
id	0..0
coding
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
display	0..1	string	Representation defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
period
id	0..0
start	0..1	dateTime	Starting time with inclusive boundary
end	0..1	dateTime	End time with inclusive boundary, if not ongoing
individual	0..1	Reference(PT_Practitioner \| PT_PractitionerRole \| https://hl7.pt/fhir/patient-visit/StructureDefinition/PTRelatedPerson)	Persons involved in the encounter other than the patient
id	0..0
reference	0..1	string	Literal reference, Relative, internal or absolute URL
type	0..0
identifier	0..0
display	0..0
period
id	0..0
start	0..1	dateTime	Starting time with inclusive boundary
end	0..1	dateTime	End time with inclusive boundary, if not ongoing
length
id	0..0
value	0..1	decimal	Numerical value (with implicit precision)
comparator	0..0
unit	0..1	string	Unit representation Example Unit: days
system	0..1	uri	System that defines coded unit form Binding: CommonUCUMCodesForDuration (preferred): Unified Code for Units of Measure (UCUM)
code	0..1	code	Coded form of the unit Example Code: d
reasonCode	0..*	CodeableConcept	Coded reason the encounter takes place
id	0..0
coding
id	0..0
system	0..1	uri	Identity of the terminology system Example System: http://snomed.info/sct
version	0..0
code	0..1	code	Symbol in syntax defined by the system
display	0..1	string	Representation defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
reasonReference	0..*	Reference(https://hl7.pt/fhir/patient-visit/StructureDefinition/PTCondition)	Reason the encounter takes place (reference)
id	0..0
type	0..0
identifier	0..0
display	0..0
diagnosis
id	0..0
condition	1..1	Reference(https://hl7.pt/fhir/patient-visit/StructureDefinition/PTCondition)	The diagnosis or procedure relevant to the encounter
id	0..0
reference	0..1	string	Literal reference, Relative, internal or absolute URL
type	0..0
identifier	0..0
display	0..0
use	0..1	CodeableConcept	Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
id	0..0
coding
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
rank	0..1	positiveInt	Ranking of the diagnosis (for each role type)
account	0..0
hospitalization
id	0..0
preAdmissionIdentifier	0..1	Identifier	Pre-admission identifier
id	0..0
type	0..1	CodeableConcept	Description of identifier
id	0..0
coding
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
value	0..1	string	The value that is unique
period
id	0..0
start	0..1	dateTime	Starting time with inclusive boundary
end	0..1	dateTime	End time with inclusive boundary, if not ongoing
assigner
id	0..0
reference	0..0
type	0..0
identifier	0..0
display	0..1	string	Text alternative for the resource
origin	0..1	Reference(PT_Location \| PT_Organization)	The location/organization from which the patient came before admission
id	0..0
type	0..0
identifier	0..0
display	0..0
admitSource	0..1	CodeableConcept	From where patient was admitted (physician referral, transfer)
id	0..0
coding
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
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
id	0..0
coding
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
dietPreference	0..*	CodeableConcept	Diet preferences reported by the patient
id	0..0
coding
id	0..0
system	0..1	uri	Identity of the terminology system
version	0..0
code	0..1	code	Symbol in syntax defined by the system
display	0..1	string	Representation defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
specialCourtesy	0..*	CodeableConcept	Special courtesies (VIP, board member)
id	0..0
coding
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
specialArrangement
id	0..0
coding
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
destination	0..1	Reference(PT_Organization \| PT_Location)	Location/organization to which the patient is discharged
id	0..0
reference	0..1	string	Literal reference, Relative, internal or absolute URL
type	0..0
identifier	0..0
display	0..0
dischargeDisposition	0..1	CodeableConcept	Category or kind of location after discharge
id	0..0
coding
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
location
id	0..0
location	1..1	Reference(PT_Location)	Location the encounter takes place
id	0..0
reference	0..1	string	Literal reference, Relative, internal or absolute URL
type	0..0
identifier	0..0
display	0..0
status	0..1	code	planned \| active \| reserved \| completed
physicalType
id	0..0
coding
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
period	0..0
serviceProvider	0..1	Reference(PT_Organization)	The organization (facility) responsible for this encounter
id	0..0
reference	0..1	string	Literal reference, Relative, internal or absolute URL
type	0..0
identifier	0..0
display	0..0
partOf	0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Encounter.type	example	Hl7VSAdmissionType `http://terminology.hl7.org/ValueSet/v2-0007`
Encounter.length.system	preferred	CommonUCUMCodesForDuration `http://hl7.org/fhir/ValueSet/duration-units` from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	Encounter	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
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
lastUpdated	Σ	0..1	instant	When the resource version last changed
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Identifier(s) by which this encounter is known
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.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
display	Σ	0..1	string	Text alternative for the resource
status	?!Σ	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
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	Σ	1..1	Coding	Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
classHistory		0..*	BackboneElement	List of past encounter classes
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	Σ	0..*	CodeableConcept	Specific type of encounter Binding: hl7VS-admissionType (example)
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
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.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
priority		0..1	CodeableConcept	Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
subject	Σ	0..1	Reference(PT_Patient)	The patient or group present at the encounter
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
basedOn		0..*	Reference(ServiceRequest)	The ServiceRequest that initiated this encounter
participant	Σ	0..*	BackboneElement	List of participants involved in the encounter
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
period		0..1	Period	Period of time during the encounter that the participant participated
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
individual	Σ	0..1	Reference(PT_Practitioner \| PT_PractitionerRole \| https://hl7.pt/fhir/patient-visit/StructureDefinition/PTRelatedPerson)	Persons involved in the encounter other than the patient
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
appointment	Σ	0..*	Reference(Appointment)	The appointment that scheduled this encounter
period		0..1	Period	The start and end time of the encounter
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
length		0..1	Duration	Quantity of time the encounter lasted (less time absent)
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
value	Σ	0..1	decimal	Numerical value (with implicit precision)
unit	Σ	0..1	string	Unit representation Example Unit: days
system	ΣC	0..1	uri	System that defines coded unit form Binding: CommonUCUMCodesForDuration (preferred): Unified Code for Units of Measure (UCUM)
code	Σ	0..1	code	Coded form of the unit Example Code: d
reasonCode	Σ	0..*	CodeableConcept	Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Example System: http://snomed.info/sct
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
reasonReference	Σ	0..*	Reference(https://hl7.pt/fhir/patient-visit/StructureDefinition/PTCondition)	Reason the encounter takes place (reference)
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
diagnosis	Σ	0..*	BackboneElement	The list of diagnosis relevant to this encounter
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
condition	Σ	1..1	Reference(https://hl7.pt/fhir/patient-visit/StructureDefinition/PTCondition)	The diagnosis or procedure relevant to the encounter
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
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.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
rank		0..1	positiveInt	Ranking of the diagnosis (for each role type)
hospitalization		0..1	BackboneElement	Details about the admission to a healthcare service
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
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.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
display	Σ	0..1	string	Text alternative for the resource
origin		0..1	Reference(PT_Location \| PT_Organization)	The location/organization from which the patient came before admission
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
admitSource		0..1	CodeableConcept	From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
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.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
dietPreference		0..*	CodeableConcept	Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
specialCourtesy		0..*	CodeableConcept	Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
specialArrangement		0..*	CodeableConcept	Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
destination		0..1	Reference(PT_Organization \| PT_Location)	Location/organization to which the patient is discharged
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
dischargeDisposition		0..1	CodeableConcept	Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
location		0..*	BackboneElement	List of locations where the patient has been
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
location		1..1	Reference(PT_Location)	Location the encounter takes place
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
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.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
serviceProvider		0..1	Reference(PT_Organization)	The organization (facility) responsible for this encounter
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
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	example	Hl7VSAdmissionType `http://terminology.hl7.org/ValueSet/v2-0007`
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.length.system	preferred	CommonUCUMCodesForDuration `http://hl7.org/fhir/ValueSet/duration-units` 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.preAdmissionIdentifier.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.1` from the FHIR Standard
Encounter.hospitalization.preAdmissionIdentifier.type	extensible	Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` 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	example	DischargeDisposition `http://hl7.org/fhir/ValueSet/encounter-discharge-disposition` from the FHIR Standard
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 Encounter

Summary

Prohibited: 131 elements

Structures

This structure refers to these other structures:

PT_Patient (https://hl7.pt/fhir/patient-visit/StructureDefinition/PTPatient)
PT_Practitioner (https://hl7.pt/fhir/patient-visit/StructureDefinition/PTPractitioner)
PT_PractitionerRole (https://hl7.pt/fhir/patient-visit/StructureDefinition/PTPractitionerRole)
Unable to summarise profile https://hl7.pt/fhir/patient-visit/StructureDefinition/PTRelatedPerson (no profile found)
Unable to summarise profile https://hl7.pt/fhir/patient-visit/StructureDefinition/PTCondition (no profile found)
PT_Location (https://hl7.pt/fhir/patient-visit/StructureDefinition/PTLocation)
PT_Organization (https://hl7.pt/fhir/patient-visit/StructureDefinition/PTOrganization)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	Encounter	An interaction during which services are provided to the patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
meta	Σ	0..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
lastUpdated	Σ	0..1	instant	When the resource version last changed ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!Σ	1..1	code	planned \| arrived \| triaged \| in-progress \| onleave \| finished \| cancelled + Binding: EncounterStatus (required): Current state of the encounter. ele-1: All FHIR elements must have a @value or children
statusHistory		0..*	BackboneElement	List of past encounter statuses ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status		1..1	code	planned \| arrived \| triaged \| in-progress \| onleave \| finished \| cancelled + Binding: EncounterStatus (required): Current state of the encounter. ele-1: All FHIR elements must have a @value or children
period		1..1	Period	The time that the episode was in the specified status ele-1: All FHIR elements must have a @value or children
class	Σ	1..1	Coding	Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. ele-1: All FHIR elements must have a @value or children
code	Σ	0..1	code	Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children
classHistory		0..*	BackboneElement	List of past encounter classes ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
class		1..1	Coding	inpatient \| outpatient \| ambulatory \| emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. ele-1: All FHIR elements must have a @value or children
period		1..1	Period	The time that the episode was in the specified class ele-1: All FHIR elements must have a @value or children
type	Σ	0..*	CodeableConcept	Specific type of encounter Binding: hl7VS-admissionType (example) ele-1: All FHIR elements must have a @value or children
text	Σ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children
serviceType	Σ	0..1	CodeableConcept	Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. ele-1: All FHIR elements must have a @value or children
text	Σ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children
priority		0..1	CodeableConcept	Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. ele-1: All FHIR elements must have a @value or children
text	Σ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children
subject	Σ	0..1	Reference(PT_Patient)	The patient or group present at the encounter ele-1: All FHIR elements must have a @value or children
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children
participant	Σ	0..*	BackboneElement	List of participants involved in the encounter ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type	Σ	0..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. ele-1: All FHIR elements must have a @value or children
text	Σ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children
individual	Σ	0..1	Reference(PT_Practitioner \| PT_PractitionerRole \| https://hl7.pt/fhir/patient-visit/StructureDefinition/PTRelatedPerson)	Persons involved in the encounter other than the patient ele-1: All FHIR elements must have a @value or children
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children
reasonCode	Σ	0..*	CodeableConcept	Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. ele-1: All FHIR elements must have a @value or children
text	Σ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children
reasonReference	Σ	0..*	Reference(https://hl7.pt/fhir/patient-visit/StructureDefinition/PTCondition)	Reason the encounter takes place (reference) ele-1: All FHIR elements must have a @value or children
serviceProvider		0..1	Reference(PT_Organization)	The organization (facility) responsible for this encounter ele-1: All FHIR elements must have a @value or children
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
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	example	Hl7VSAdmissionType `http://terminology.hl7.org/ValueSet/v2-0007`
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

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

Differential View

This structure is derived from Encounter

Name	Card.	Type	Description & Constraints
Encounter	0..*	Encounter	An interaction during which services are provided to the patient
meta	0..1	Meta	Metadata about the resource
id	0..0
versionId	0..0
lastUpdated	0..1	instant	When the resource version last changed
source	0..0
profile	0..0
security	0..0
tag	0..0
implicitRules	0..0
language	0..0
text	0..0
contained	0..0
identifier
id	0..0
use	0..1	code	usual \| official \| temp \| secondary \| old (If known)
type
id	0..0
coding
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
value	0..1	string	The value that is unique
period
id	0..0
start	0..1	dateTime	Starting time with inclusive boundary
end	0..1	dateTime	End time with inclusive boundary, if not ongoing
assigner
id	0..0
reference	0..0
type	0..0
identifier	0..0
display	0..1	string	Text alternative for the resource
status	1..1	code	planned \| arrived \| triaged \| in-progress \| onleave \| finished \| cancelled +
statusHistory	0..*	BackboneElement	List of past encounter statuses
id	0..0
class	1..1	Coding	Classification of patient encounter
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
userSelected	0..0
classHistory	0..*	BackboneElement	List of past encounter classes
id	0..0
type	0..*	CodeableConcept	Specific type of encounter Binding: hl7VS-admissionType (example)
id	0..0
coding
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
serviceType	0..1	CodeableConcept	Specific type of service
id	0..0
coding
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
priority	0..1	CodeableConcept	Indicates the urgency of the encounter
id	0..0
coding
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
subject	0..1	Reference(PT_Patient)	The patient or group present at the encounter
id	0..0
reference	0..1	string	Literal reference, Relative, internal or absolute URL
type	0..0
identifier	0..0
display	0..0
episodeOfCare	0..0
participant	0..*	BackboneElement	List of participants involved in the encounter
id	0..0
type	0..*	CodeableConcept	Role of participant in encounter
id	0..0
coding
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
display	0..1	string	Representation defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
period
id	0..0
start	0..1	dateTime	Starting time with inclusive boundary
end	0..1	dateTime	End time with inclusive boundary, if not ongoing
individual	0..1	Reference(PT_Practitioner \| PT_PractitionerRole \| https://hl7.pt/fhir/patient-visit/StructureDefinition/PTRelatedPerson)	Persons involved in the encounter other than the patient
id	0..0
reference	0..1	string	Literal reference, Relative, internal or absolute URL
type	0..0
identifier	0..0
display	0..0
period
id	0..0
start	0..1	dateTime	Starting time with inclusive boundary
end	0..1	dateTime	End time with inclusive boundary, if not ongoing
length
id	0..0
value	0..1	decimal	Numerical value (with implicit precision)
comparator	0..0
unit	0..1	string	Unit representation Example Unit: days
system	0..1	uri	System that defines coded unit form Binding: CommonUCUMCodesForDuration (preferred): Unified Code for Units of Measure (UCUM)
code	0..1	code	Coded form of the unit Example Code: d
reasonCode	0..*	CodeableConcept	Coded reason the encounter takes place
id	0..0
coding
id	0..0
system	0..1	uri	Identity of the terminology system Example System: http://snomed.info/sct
version	0..0
code	0..1	code	Symbol in syntax defined by the system
display	0..1	string	Representation defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
reasonReference	0..*	Reference(https://hl7.pt/fhir/patient-visit/StructureDefinition/PTCondition)	Reason the encounter takes place (reference)
id	0..0
type	0..0
identifier	0..0
display	0..0
diagnosis
id	0..0
condition	1..1	Reference(https://hl7.pt/fhir/patient-visit/StructureDefinition/PTCondition)	The diagnosis or procedure relevant to the encounter
id	0..0
reference	0..1	string	Literal reference, Relative, internal or absolute URL
type	0..0
identifier	0..0
display	0..0
use	0..1	CodeableConcept	Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
id	0..0
coding
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
rank	0..1	positiveInt	Ranking of the diagnosis (for each role type)
account	0..0
hospitalization
id	0..0
preAdmissionIdentifier	0..1	Identifier	Pre-admission identifier
id	0..0
type	0..1	CodeableConcept	Description of identifier
id	0..0
coding
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
value	0..1	string	The value that is unique
period
id	0..0
start	0..1	dateTime	Starting time with inclusive boundary
end	0..1	dateTime	End time with inclusive boundary, if not ongoing
assigner
id	0..0
reference	0..0
type	0..0
identifier	0..0
display	0..1	string	Text alternative for the resource
origin	0..1	Reference(PT_Location \| PT_Organization)	The location/organization from which the patient came before admission
id	0..0
type	0..0
identifier	0..0
display	0..0
admitSource	0..1	CodeableConcept	From where patient was admitted (physician referral, transfer)
id	0..0
coding
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
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
id	0..0
coding
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
dietPreference	0..*	CodeableConcept	Diet preferences reported by the patient
id	0..0
coding
id	0..0
system	0..1	uri	Identity of the terminology system
version	0..0
code	0..1	code	Symbol in syntax defined by the system
display	0..1	string	Representation defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
specialCourtesy	0..*	CodeableConcept	Special courtesies (VIP, board member)
id	0..0
coding
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
specialArrangement
id	0..0
coding
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
destination	0..1	Reference(PT_Organization \| PT_Location)	Location/organization to which the patient is discharged
id	0..0
reference	0..1	string	Literal reference, Relative, internal or absolute URL
type	0..0
identifier	0..0
display	0..0
dischargeDisposition	0..1	CodeableConcept	Category or kind of location after discharge
id	0..0
coding
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
location
id	0..0
location	1..1	Reference(PT_Location)	Location the encounter takes place
id	0..0
reference	0..1	string	Literal reference, Relative, internal or absolute URL
type	0..0
identifier	0..0
display	0..0
status	0..1	code	planned \| active \| reserved \| completed
physicalType
id	0..0
coding
id	0..0
version	0..0
code	0..1	code	Symbol in syntax defined by the system
userSelected	0..0
text	0..1	string	Plain text representation of the concept
period	0..0
serviceProvider	0..1	Reference(PT_Organization)	The organization (facility) responsible for this encounter
id	0..0
reference	0..1	string	Literal reference, Relative, internal or absolute URL
type	0..0
identifier	0..0
display	0..0
partOf	0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Encounter.type	example	Hl7VSAdmissionType `http://terminology.hl7.org/ValueSet/v2-0007`
Encounter.length.system	preferred	CommonUCUMCodesForDuration `http://hl7.org/fhir/ValueSet/duration-units` from the FHIR Standard

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	Encounter	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
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
lastUpdated	Σ	0..1	instant	When the resource version last changed
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Identifier(s) by which this encounter is known
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.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
display	Σ	0..1	string	Text alternative for the resource
status	?!Σ	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
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	Σ	1..1	Coding	Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
classHistory		0..*	BackboneElement	List of past encounter classes
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	Σ	0..*	CodeableConcept	Specific type of encounter Binding: hl7VS-admissionType (example)
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
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.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
priority		0..1	CodeableConcept	Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
subject	Σ	0..1	Reference(PT_Patient)	The patient or group present at the encounter
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
basedOn		0..*	Reference(ServiceRequest)	The ServiceRequest that initiated this encounter
participant	Σ	0..*	BackboneElement	List of participants involved in the encounter
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
period		0..1	Period	Period of time during the encounter that the participant participated
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
individual	Σ	0..1	Reference(PT_Practitioner \| PT_PractitionerRole \| https://hl7.pt/fhir/patient-visit/StructureDefinition/PTRelatedPerson)	Persons involved in the encounter other than the patient
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
appointment	Σ	0..*	Reference(Appointment)	The appointment that scheduled this encounter
period		0..1	Period	The start and end time of the encounter
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
length		0..1	Duration	Quantity of time the encounter lasted (less time absent)
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
value	Σ	0..1	decimal	Numerical value (with implicit precision)
unit	Σ	0..1	string	Unit representation Example Unit: days
system	ΣC	0..1	uri	System that defines coded unit form Binding: CommonUCUMCodesForDuration (preferred): Unified Code for Units of Measure (UCUM)
code	Σ	0..1	code	Coded form of the unit Example Code: d
reasonCode	Σ	0..*	CodeableConcept	Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Example System: http://snomed.info/sct
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
reasonReference	Σ	0..*	Reference(https://hl7.pt/fhir/patient-visit/StructureDefinition/PTCondition)	Reason the encounter takes place (reference)
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
diagnosis	Σ	0..*	BackboneElement	The list of diagnosis relevant to this encounter
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
condition	Σ	1..1	Reference(https://hl7.pt/fhir/patient-visit/StructureDefinition/PTCondition)	The diagnosis or procedure relevant to the encounter
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
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.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
rank		0..1	positiveInt	Ranking of the diagnosis (for each role type)
hospitalization		0..1	BackboneElement	Details about the admission to a healthcare service
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
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.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
display	Σ	0..1	string	Text alternative for the resource
origin		0..1	Reference(PT_Location \| PT_Organization)	The location/organization from which the patient came before admission
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
admitSource		0..1	CodeableConcept	From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
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.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
dietPreference		0..*	CodeableConcept	Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
specialCourtesy		0..*	CodeableConcept	Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
specialArrangement		0..*	CodeableConcept	Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
destination		0..1	Reference(PT_Organization \| PT_Location)	Location/organization to which the patient is discharged
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
dischargeDisposition		0..1	CodeableConcept	Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
location		0..*	BackboneElement	List of locations where the patient has been
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
location		1..1	Reference(PT_Location)	Location the encounter takes place
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
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.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
serviceProvider		0..1	Reference(PT_Organization)	The organization (facility) responsible for this encounter
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
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	example	Hl7VSAdmissionType `http://terminology.hl7.org/ValueSet/v2-0007`
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.length.system	preferred	CommonUCUMCodesForDuration `http://hl7.org/fhir/ValueSet/duration-units` 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.preAdmissionIdentifier.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.1` from the FHIR Standard
Encounter.hospitalization.preAdmissionIdentifier.type	extensible	Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` 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	example	DischargeDisposition `http://hl7.org/fhir/ValueSet/encounter-discharge-disposition` from the FHIR Standard
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 Encounter

Summary

Prohibited: 131 elements

Structures

This structure refers to these other structures:

PT_Patient (https://hl7.pt/fhir/patient-visit/StructureDefinition/PTPatient)
PT_Practitioner (https://hl7.pt/fhir/patient-visit/StructureDefinition/PTPractitioner)
PT_PractitionerRole (https://hl7.pt/fhir/patient-visit/StructureDefinition/PTPractitionerRole)
Unable to summarise profile https://hl7.pt/fhir/patient-visit/StructureDefinition/PTRelatedPerson (no profile found)
Unable to summarise profile https://hl7.pt/fhir/patient-visit/StructureDefinition/PTCondition (no profile found)
PT_Location (https://hl7.pt/fhir/patient-visit/StructureDefinition/PTLocation)
PT_Organization (https://hl7.pt/fhir/patient-visit/StructureDefinition/PTOrganization)

Other representations of profile: CSV, Excel, Schematron

IG © 2025+ HL7 Portugal. Package hl7.fhir.pt.patientvisit#1.0.0 based on FHIR 4.0.1. Generated 2025-02-12
Links: Table of Contents | QA Report