CambioOpenServicesIG - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• JSON

Resource Profile: EncounterLite

Introduction

The EncounterLite profile is created from the FHIR resource Encounter.

Intended Use

EncounterLite profile is created to fetch inpatient encounters at a given location.

The intended use for reading data with this API is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for "data copying" between care providers, patient consent must be handled outside the API. Note that the security rules (i.e. PDL block) are not applied in particularly in this API and Consumer must handle the data carefully and with the awareness.

Specific Rules and Limitations

Versions

Mapping for Payment Types

Supported Operations

Search Parameters

Supported Queries

1. Search [baseURL]/Encounter

Supported _include params

• Encounter:subject
• Encounter:location
• Encounter:serviceProvider

Supported _revinclude params

N/A

Error Codes

For common codes, refer to Error handling section.

Usages:

• CapabilityStatements using this Profile: Cambio Open Services
• This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	Encounter	An interaction during which services are provided to the patient
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
class	Σ	1..1	Coding	Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter.
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	1..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
subject	Σ	1..1	Reference(PatientLiteSe)	The patient or group present at the encounter
period		1..1	Period	The start and end time of the encounter
start	ΣC	1..1	dateTime	Starting time with inclusive boundary
location		1..*	BackboneElement	List of locations where the patient has been
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
location		1..1	Reference(LocationUnitSe)	Location the encounter takes place
status		1..1	code	planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location.
physicalType		1..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.
serviceProvider		1..1	Reference(OrganizationSEVendorLite)	The organization (facility) responsible for this encounter
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.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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	Encounter	An interaction during which services are provided to the patient
identifier
use		0..0
type		0..0
system		1..1	uri	The namespace for the identifier value
value		1..1	string	The value that is unique
period		0..0
assigner		0..0
statusHistory		0..0
class		1..1	Coding	Classification of patient encounter
system		1..1	uri	Identity of the terminology system
version		1..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
userSelected		0..0
classHistory		0..0
type		0..0
serviceType		0..0
priority		0..0
subject		1..1	Reference(PatientLiteSe)	The patient or group present at the encounter
episodeOfCare		0..0
basedOn		0..0
participant		0..0
appointment		0..0
period		1..1	Period	The start and end time of the encounter
start		1..1	dateTime	Starting time with inclusive boundary
length		0..0
reasonCode		0..0
reasonReference		0..0
diagnosis		0..0
account		0..0
hospitalization		0..0
location		1..*	BackboneElement	List of locations where the patient has been
location		1..1	Reference(LocationUnitSe)	Location the encounter takes place
status		1..1	code	planned | active | reserved | completed
physicalType		1..1	CodeableConcept	The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
period		0..0
serviceProvider		1..1	Reference(OrganizationSEVendorLite)	The organization (facility) responsible for this encounter
partOf		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
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
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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
status	?!Σ	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
class	Σ	1..1	Coding	Classification of patient encounter Binding: ActEncounterCode (extensible): Classification 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
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	1..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
subject	Σ	1..1	Reference(PatientLiteSe)	The patient or group present at the encounter
period		1..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	ΣC	1..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
location		1..*	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(LocationUnitSe)	Location the encounter takes place
status		1..1	code	planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location.
physicalType		1..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.
serviceProvider		1..1	Reference(OrganizationSEVendorLite)	The organization (facility) responsible for this encounter
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.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.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Encounter.diagnosis.use	preferred	DiagnosisRole http://hl7.org/fhir/ValueSet/diagnosis-role 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

Mandatory: 11 elements(2 nested mandatory elements)
Prohibited: 29 elements

Structures

This structure refers to these other structures:

• PatientLiteSe (https://fhir.cambio.se/StructureDefinition/PatientLiteSe/v1)
• LocationUnitSe (https://fhir.cambio.se/StructureDefinition/LocationUnitSe/v1)
• OrganizationSEVendorLite (https://commonprofiles.care/StructureDefinition/OrganizationSEVendorLite/v1)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	Encounter	An interaction during which services are provided to the patient
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
class	Σ	1..1	Coding	Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter.
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	1..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
subject	Σ	1..1	Reference(PatientLiteSe)	The patient or group present at the encounter
period		1..1	Period	The start and end time of the encounter
start	ΣC	1..1	dateTime	Starting time with inclusive boundary
location		1..*	BackboneElement	List of locations where the patient has been
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
location		1..1	Reference(LocationUnitSe)	Location the encounter takes place
status		1..1	code	planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location.
physicalType		1..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.
serviceProvider		1..1	Reference(OrganizationSEVendorLite)	The organization (facility) responsible for this encounter
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.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()

Differential View

This structure is derived from Encounter

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	Encounter	An interaction during which services are provided to the patient
identifier
use		0..0
type		0..0
system		1..1	uri	The namespace for the identifier value
value		1..1	string	The value that is unique
period		0..0
assigner		0..0
statusHistory		0..0
class		1..1	Coding	Classification of patient encounter
system		1..1	uri	Identity of the terminology system
version		1..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
userSelected		0..0
classHistory		0..0
type		0..0
serviceType		0..0
priority		0..0
subject		1..1	Reference(PatientLiteSe)	The patient or group present at the encounter
episodeOfCare		0..0
basedOn		0..0
participant		0..0
appointment		0..0
period		1..1	Period	The start and end time of the encounter
start		1..1	dateTime	Starting time with inclusive boundary
length		0..0
reasonCode		0..0
reasonReference		0..0
diagnosis		0..0
account		0..0
hospitalization		0..0
location		1..*	BackboneElement	List of locations where the patient has been
location		1..1	Reference(LocationUnitSe)	Location the encounter takes place
status		1..1	code	planned | active | reserved | completed
physicalType		1..1	CodeableConcept	The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
period		0..0
serviceProvider		1..1	Reference(OrganizationSEVendorLite)	The organization (facility) responsible for this encounter
partOf		0..0
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
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
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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
status	?!Σ	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
class	Σ	1..1	Coding	Classification of patient encounter Binding: ActEncounterCode (extensible): Classification 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
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	1..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
subject	Σ	1..1	Reference(PatientLiteSe)	The patient or group present at the encounter
period		1..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	ΣC	1..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
location		1..*	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(LocationUnitSe)	Location the encounter takes place
status		1..1	code	planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location.
physicalType		1..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.
serviceProvider		1..1	Reference(OrganizationSEVendorLite)	The organization (facility) responsible for this encounter
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.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.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Encounter.diagnosis.use	preferred	DiagnosisRole http://hl7.org/fhir/ValueSet/diagnosis-role 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

Mandatory: 11 elements(2 nested mandatory elements)
Prohibited: 29 elements

Structures

This structure refers to these other structures:

• PatientLiteSe (https://fhir.cambio.se/StructureDefinition/PatientLiteSe/v1)
• LocationUnitSe (https://fhir.cambio.se/StructureDefinition/LocationUnitSe/v1)
• OrganizationSEVendorLite (https://commonprofiles.care/StructureDefinition/OrganizationSEVendorLite/v1)

Other representations of profile: CSV, Excel, Schematron