Virtually Healthcare - IHE Patient Care Coordination (PCC) - Local Development build (v0.1.1-current) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• XML
• JSON

Resource Profile: Encounter

Merge of NHS England HL7 v2 ADT and UKCore-Encounter

Usages:

• Refer to this Profile: DiagnosticReport, DocumentReference and ServiceRequest
• Examples for this Profile: Encounter/93d2c059-a934-4796-827b-dee1158cc4dc
• CapabilityStatements using this Profile: Facade - IM1 Patient EMIS

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..*	UKCoreEncounter	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				Content/Rules for all slices
extension:dischargeMethod	N	0..1	CodeableConcept	An extension to support the method of discharge from a hospital. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DischargeMethod Binding: UK Core Discharge Method (extensible): The method by which a patient was discharged from hospital
extension:emergencyCareDischargeStatus	N	0..1	CodeableConcept	An extension to support the status of an individual on discharge from an Emergency Care Department. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EmergencyCareDischargeStatus Binding: UK Core Emergency Care Discharge Status (preferred): The status of a patient on discharge from an Emergency Care Department
extension:legalStatus	N	0..*	(Complex)	Information relating to a patient's legal status on admission or discharge. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-LegalStatus
extension:OutcomeOfAttendance	N	0..1	CodeableConcept	An extension to support the outcome of an Outpatient attendance. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OutcomeOfAttendance Binding: UK Core Outcome Of Attendance (extensible): The outcome of an outpatient attendance
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Identifier(s) by which this encounter is known.
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
value	SΣ	0..1	string	The value that is unique Example General: 123456
status	?!SΣ	1..1	code	The status of this encounter: planned | arrived | triaged | in-progress | onleave | finished | cancelled | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter.
class	SΣ	1..1	Coding	Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations. Binding: ActEncounterCode (extensible): Classification of the encounter.
subject	SΣ	0..1	Reference(Patient | Group)	The patient or group present at the encounter.
participant	SΣ	0..*	BackboneElement	The list of people responsible for providing the service.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
period	S	0..1	Period	The start and end time of the encounter
start	SΣC	0..1	dateTime	Starting time with inclusive boundary
reasonCode	SΣ	0..*	CodeableConcept	Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis. Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
reasonReference	SΣ	0..*	Reference(Condition | Procedure | Observation | ImmunizationRecommendation)	Reason the encounter takes place, expressed as a reference to a Condition, Procedure, Observation, or ImmunizationRecommendation.
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.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.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 UKCoreEncounter

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter			UKCoreEncounter
identifier
value	S	0..1	string	The value that is unique
period	S	0..1	Period	The start and end time of the encounter
start	S	0..1	dateTime	Starting time with inclusive boundary
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	UKCoreEncounter	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	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:dischargeMethod	N	0..1	CodeableConcept	An extension to support the method of discharge from a hospital. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DischargeMethod Binding: UK Core Discharge Method (extensible): The method by which a patient was discharged from hospital
extension:emergencyCareDischargeStatus	N	0..1	CodeableConcept	An extension to support the status of an individual on discharge from an Emergency Care Department. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EmergencyCareDischargeStatus Binding: UK Core Emergency Care Discharge Status (preferred): The status of a patient on discharge from an Emergency Care Department
extension:legalStatus	N	0..*	(Complex)	Information relating to a patient's legal status on admission or discharge. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-LegalStatus
extension:OutcomeOfAttendance	N	0..1	CodeableConcept	An extension to support the outcome of an Outpatient attendance. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OutcomeOfAttendance Binding: UK Core Outcome Of Attendance (extensible): The outcome of an outpatient attendance
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Identifier(s) by which this encounter is known.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
status	?!SΣ	1..1	code	The status of this encounter: planned | arrived | triaged | in-progress | onleave | finished | cancelled | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter.
statusHistory		0..*	BackboneElement	List of past encounter statuses
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
status		1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
period		1..1	Period	The time that the episode was in the specified status
class	SΣ	1..1	Coding	Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations. Binding: ActEncounterCode (extensible): Classification of the encounter.
classHistory		0..*	BackboneElement	List of past encounter classes
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
class		1..1	Coding	inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter.
period		1..1	Period	The time that the episode was in the specified class
type	Σ	0..*	CodeableConcept	Specific type of encounter Binding: UK Core Encounter Type (preferred): A code from the SNOMED Clinical Terminology UK coding system that describes an encounter between a care professional and the patient (or patient's record).
serviceType	Σ	0..1	CodeableConcept	Specific type of service Binding: UK Core Care Setting Type (preferred): Any code from the SNOMED CT UK Refset with fully specified name 'Services simple reference set (foundation metadata concept)' with Refset Id 1127531000000102.
priority		0..1	CodeableConcept	Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter.
subject	SΣ	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
participant	SΣ	0..*	BackboneElement	The list of people responsible for providing the service.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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
appointment	Σ	0..*	Reference(Appointment)	The appointment that scheduled this encounter
period	S	0..1	Period	The start and end time of the encounter
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	SΣ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)
reasonCode	SΣ	0..*	CodeableConcept	Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis. Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
reasonReference	SΣ	0..*	Reference(Condition | Procedure | Observation | ImmunizationRecommendation)	Reason the encounter takes place, expressed as a reference to a Condition, Procedure, Observation, or ImmunizationRecommendation.
diagnosis	Σ	0..*	BackboneElement	The list of diagnosis relevant to this encounter
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
condition	Σ	1..1	Reference(Condition | Procedure)	The diagnosis or procedure relevant to the encounter
use		0..1	CodeableConcept	Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
rank		0..1	positiveInt	Ranking of the diagnosis (for each role type)
account		0..*	Reference(Account)	The set of accounts that may be used for billing for this Encounter
hospitalization		0..1	BackboneElement	Details about the admission to a healthcare service
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:admissionMethod	N	0..1	CodeableConcept	An extension to support the method by which an individual was admitted into hospital. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdmissionMethod Binding: UK Core Admission Method (extensible): The method by which a patient was admitted to hospital
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
preAdmissionIdentifier		0..1	Identifier	Pre-admission identifier
origin		0..1	Reference(Location | Organization)	The location/organization from which the patient came before admission
admitSource		0..1	CodeableConcept	From where patient was admitted (physician referral, transfer) Binding: UK Core Source Of Admission (preferred): The source of admission to a Hospital Provider Spell or a Nursing Episode when the Patient is in a Hospital Site or a Care Home.
reAdmission		0..1	CodeableConcept	The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
dietPreference		0..*	CodeableConcept	Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
specialCourtesy		0..*	CodeableConcept	Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies.
specialArrangement		0..*	CodeableConcept	Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements.
destination		0..1	Reference(Location | Organization)	Location/organization to which the patient is discharged
dischargeDisposition		0..1	CodeableConcept	Category or kind of location after discharge Binding: UK Core Discharge Destination (preferred): The destination of a Patient on completion of a Hospital Provider Spell, or a note that the Patient died or was a still birth.
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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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: UK Core Encounter Location Type (preferred): A set of codes that define the physical type of location where an encounter takes place.
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	Conformance	ValueSet	URI
Encounter.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
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	preferred	UKCoreEncounterType https://fhir.hl7.org.uk/ValueSet/UKCore-EncounterType
Encounter.serviceType	preferred	UKCoreCareSettingType https://fhir.hl7.org.uk/ValueSet/UKCore-CareSettingType
Encounter.priority	example	ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Encounter.reasonCode	preferred	EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reason From the FHIR Standard
Encounter.diagnosis.use	preferred	DiagnosisRole http://hl7.org/fhir/ValueSet/diagnosis-role From the FHIR Standard
Encounter.hospitalization.admitSource	preferred	UKCoreSourceOfAdmission https://fhir.hl7.org.uk/ValueSet/UKCore-SourceOfAdmission
Encounter.hospitalization.reAdmission	example	Hl7VSReAdmissionIndicator http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreference	example	Diet http://hl7.org/fhir/ValueSet/encounter-diet From the FHIR Standard
Encounter.hospitalization.specialCourtesy	preferred	SpecialCourtesy http://hl7.org/fhir/ValueSet/encounter-special-courtesy From the FHIR Standard
Encounter.hospitalization.specialArrangement	preferred	SpecialArrangements http://hl7.org/fhir/ValueSet/encounter-special-arrangements From the FHIR Standard
Encounter.hospitalization.dischargeDisposition	preferred	UKCoreDischargeDestination https://fhir.hl7.org.uk/ValueSet/UKCore-DischargeDestination
Encounter.location.status	required	EncounterLocationStatus http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 From the FHIR Standard
Encounter.location.physicalType	preferred	UKCoreEncounterLocationType https://fhir.hl7.org.uk/ValueSet/UKCore-EncounterLocationType

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 UKCoreEncounter

Summary

Must-Support: 3 elements

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	UKCoreEncounter	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				Content/Rules for all slices
extension:dischargeMethod	N	0..1	CodeableConcept	An extension to support the method of discharge from a hospital. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DischargeMethod Binding: UK Core Discharge Method (extensible): The method by which a patient was discharged from hospital
extension:emergencyCareDischargeStatus	N	0..1	CodeableConcept	An extension to support the status of an individual on discharge from an Emergency Care Department. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EmergencyCareDischargeStatus Binding: UK Core Emergency Care Discharge Status (preferred): The status of a patient on discharge from an Emergency Care Department
extension:legalStatus	N	0..*	(Complex)	Information relating to a patient's legal status on admission or discharge. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-LegalStatus
extension:OutcomeOfAttendance	N	0..1	CodeableConcept	An extension to support the outcome of an Outpatient attendance. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OutcomeOfAttendance Binding: UK Core Outcome Of Attendance (extensible): The outcome of an outpatient attendance
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Identifier(s) by which this encounter is known.
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
value	SΣ	0..1	string	The value that is unique Example General: 123456
status	?!SΣ	1..1	code	The status of this encounter: planned | arrived | triaged | in-progress | onleave | finished | cancelled | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter.
class	SΣ	1..1	Coding	Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations. Binding: ActEncounterCode (extensible): Classification of the encounter.
subject	SΣ	0..1	Reference(Patient | Group)	The patient or group present at the encounter.
participant	SΣ	0..*	BackboneElement	The list of people responsible for providing the service.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
period	S	0..1	Period	The start and end time of the encounter
start	SΣC	0..1	dateTime	Starting time with inclusive boundary
reasonCode	SΣ	0..*	CodeableConcept	Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis. Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
reasonReference	SΣ	0..*	Reference(Condition | Procedure | Observation | ImmunizationRecommendation)	Reason the encounter takes place, expressed as a reference to a Condition, Procedure, Observation, or ImmunizationRecommendation.
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.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.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 UKCoreEncounter

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter			UKCoreEncounter
identifier
value	S	0..1	string	The value that is unique
period	S	0..1	Period	The start and end time of the encounter
start	S	0..1	dateTime	Starting time with inclusive boundary
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	UKCoreEncounter	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	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:dischargeMethod	N	0..1	CodeableConcept	An extension to support the method of discharge from a hospital. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DischargeMethod Binding: UK Core Discharge Method (extensible): The method by which a patient was discharged from hospital
extension:emergencyCareDischargeStatus	N	0..1	CodeableConcept	An extension to support the status of an individual on discharge from an Emergency Care Department. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EmergencyCareDischargeStatus Binding: UK Core Emergency Care Discharge Status (preferred): The status of a patient on discharge from an Emergency Care Department
extension:legalStatus	N	0..*	(Complex)	Information relating to a patient's legal status on admission or discharge. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-LegalStatus
extension:OutcomeOfAttendance	N	0..1	CodeableConcept	An extension to support the outcome of an Outpatient attendance. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OutcomeOfAttendance Binding: UK Core Outcome Of Attendance (extensible): The outcome of an outpatient attendance
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Identifier(s) by which this encounter is known.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
status	?!SΣ	1..1	code	The status of this encounter: planned | arrived | triaged | in-progress | onleave | finished | cancelled | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter.
statusHistory		0..*	BackboneElement	List of past encounter statuses
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
status		1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
period		1..1	Period	The time that the episode was in the specified status
class	SΣ	1..1	Coding	Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations. Binding: ActEncounterCode (extensible): Classification of the encounter.
classHistory		0..*	BackboneElement	List of past encounter classes
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
class		1..1	Coding	inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter.
period		1..1	Period	The time that the episode was in the specified class
type	Σ	0..*	CodeableConcept	Specific type of encounter Binding: UK Core Encounter Type (preferred): A code from the SNOMED Clinical Terminology UK coding system that describes an encounter between a care professional and the patient (or patient's record).
serviceType	Σ	0..1	CodeableConcept	Specific type of service Binding: UK Core Care Setting Type (preferred): Any code from the SNOMED CT UK Refset with fully specified name 'Services simple reference set (foundation metadata concept)' with Refset Id 1127531000000102.
priority		0..1	CodeableConcept	Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter.
subject	SΣ	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
participant	SΣ	0..*	BackboneElement	The list of people responsible for providing the service.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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
appointment	Σ	0..*	Reference(Appointment)	The appointment that scheduled this encounter
period	S	0..1	Period	The start and end time of the encounter
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	SΣ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)
reasonCode	SΣ	0..*	CodeableConcept	Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis. Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
reasonReference	SΣ	0..*	Reference(Condition | Procedure | Observation | ImmunizationRecommendation)	Reason the encounter takes place, expressed as a reference to a Condition, Procedure, Observation, or ImmunizationRecommendation.
diagnosis	Σ	0..*	BackboneElement	The list of diagnosis relevant to this encounter
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
condition	Σ	1..1	Reference(Condition | Procedure)	The diagnosis or procedure relevant to the encounter
use		0..1	CodeableConcept	Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
rank		0..1	positiveInt	Ranking of the diagnosis (for each role type)
account		0..*	Reference(Account)	The set of accounts that may be used for billing for this Encounter
hospitalization		0..1	BackboneElement	Details about the admission to a healthcare service
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:admissionMethod	N	0..1	CodeableConcept	An extension to support the method by which an individual was admitted into hospital. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdmissionMethod Binding: UK Core Admission Method (extensible): The method by which a patient was admitted to hospital
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
preAdmissionIdentifier		0..1	Identifier	Pre-admission identifier
origin		0..1	Reference(Location | Organization)	The location/organization from which the patient came before admission
admitSource		0..1	CodeableConcept	From where patient was admitted (physician referral, transfer) Binding: UK Core Source Of Admission (preferred): The source of admission to a Hospital Provider Spell or a Nursing Episode when the Patient is in a Hospital Site or a Care Home.
reAdmission		0..1	CodeableConcept	The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
dietPreference		0..*	CodeableConcept	Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
specialCourtesy		0..*	CodeableConcept	Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies.
specialArrangement		0..*	CodeableConcept	Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements.
destination		0..1	Reference(Location | Organization)	Location/organization to which the patient is discharged
dischargeDisposition		0..1	CodeableConcept	Category or kind of location after discharge Binding: UK Core Discharge Destination (preferred): The destination of a Patient on completion of a Hospital Provider Spell, or a note that the Patient died or was a still birth.
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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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: UK Core Encounter Location Type (preferred): A set of codes that define the physical type of location where an encounter takes place.
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	Conformance	ValueSet	URI
Encounter.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
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	preferred	UKCoreEncounterType https://fhir.hl7.org.uk/ValueSet/UKCore-EncounterType
Encounter.serviceType	preferred	UKCoreCareSettingType https://fhir.hl7.org.uk/ValueSet/UKCore-CareSettingType
Encounter.priority	example	ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Encounter.reasonCode	preferred	EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reason From the FHIR Standard
Encounter.diagnosis.use	preferred	DiagnosisRole http://hl7.org/fhir/ValueSet/diagnosis-role From the FHIR Standard
Encounter.hospitalization.admitSource	preferred	UKCoreSourceOfAdmission https://fhir.hl7.org.uk/ValueSet/UKCore-SourceOfAdmission
Encounter.hospitalization.reAdmission	example	Hl7VSReAdmissionIndicator http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreference	example	Diet http://hl7.org/fhir/ValueSet/encounter-diet From the FHIR Standard
Encounter.hospitalization.specialCourtesy	preferred	SpecialCourtesy http://hl7.org/fhir/ValueSet/encounter-special-courtesy From the FHIR Standard
Encounter.hospitalization.specialArrangement	preferred	SpecialArrangements http://hl7.org/fhir/ValueSet/encounter-special-arrangements From the FHIR Standard
Encounter.hospitalization.dischargeDisposition	preferred	UKCoreDischargeDestination https://fhir.hl7.org.uk/ValueSet/UKCore-DischargeDestination
Encounter.location.status	required	EncounterLocationStatus http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 From the FHIR Standard
Encounter.location.physicalType	preferred	UKCoreEncounterLocationType https://fhir.hl7.org.uk/ValueSet/UKCore-EncounterLocationType

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 UKCoreEncounter

Summary

Must-Support: 3 elements

Other representations of profile: CSV, Excel, Schematron