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: EncounterSelfService(Version 2)

Introduction

The EncounterSelfService profile is used for retrieving the contact information needed for self-service workflow (arrival and payment registration). The profile is based on the Encounter resource in the FHIR R4 specification.

In the profile version 2, the extension RegisterPaymentPossible has been removed.

Intended Use

EncounterSelfService is currently only used as a contained resource within the InvoiceSe resource. It contains three extension to include additional details about the visit.

Specific Rules and Limitations

Versions

Extensions

Encounter Statuses

Supported Operations

Not applicable, this profile is just used as a contained resource and there is no API for EncounterSelfService. For examples, refer to InvoiceSe.

Error Codes

Not applicable, this profile is just used as a contained resource and there is no API for EncounterSelfService.

Usages:

• Refer to this Profile: ChargeItemSe(Version 2)

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..*	EncounterCore	An interaction during which services are provided to the patient
meta	Σ	0..1	Meta	Metadata about the resource
source	SΣ	0..1	uri	Identifies where the resource comes from
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:informationToPatient		0..1	string	Optional Extensions Element URL: https://fhir.cambio.se/StructureDefinition/encounter-InformationToPatient
extension:arrivalRegistrationPossible		0..1	boolean	Optional Extensions Element URL: https://fhir.cambio.se/StructureDefinition/encounter-registerPaymentPossible
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	Σ	0..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
code	Σ	0..1	code	Symbol in syntax defined by the system Fixed Value: PRENC
display	Σ	0..1	string	Representation defined by the system Fixed Value: pre-admission
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	Fixed Value: PRENC http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.classHistory.class	extensible	ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode

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 EncounterCore

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter			EncounterCore
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:informationToPatient		0..1	string	Optional Extensions Element URL: https://fhir.cambio.se/StructureDefinition/encounter-InformationToPatient
extension:arrivalRegistrationPossible		0..1	boolean	Optional Extensions Element URL: https://fhir.cambio.se/StructureDefinition/encounter-registerPaymentPossible
identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.cambio.se/Encounter
statusHistory		0..0
class
system		0..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
code		0..1	code	Symbol in syntax defined by the system Fixed Value: PRENC
display		0..1	string	Representation defined by the system Fixed Value: pre-admission
type		0..0
serviceType		0..0
priority		0..0
subject		0..0
episodeOfCare		0..0
basedOn		0..0
participant		0..0
appointment		0..0
period		0..0
length		0..0
reasonCode		0..0
reasonReference		0..0
diagnosis		0..0
account		0..0
hospitalization		0..0
location		0..0
serviceProvider		0..0
partOf		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	EncounterCore	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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	SΣ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:informationToPatient		0..1	string	Optional Extensions Element URL: https://fhir.cambio.se/StructureDefinition/encounter-InformationToPatient
extension:arrivalRegistrationPossible		0..1	boolean	Optional Extensions Element URL: https://fhir.cambio.se/StructureDefinition/encounter-registerPaymentPossible
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 Fixed Value: https://fhir.cambio.se/Encounter
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	Σ	0..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Fixed Value: PRENC
display	Σ	0..1	string	Representation defined by the system Fixed Value: pre-admission
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Encounter.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
Encounter.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
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	Fixed Value: PRENC 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.admitSource	preferred	AdmitSource http://hl7.org/fhir/ValueSet/encounter-admit-source 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 EncounterCore

Summary

Fixed: 4 elements
Prohibited: 19 elements

Extensions

This structure refers to these extensions:

• https://fhir.cambio.se/StructureDefinition/encounter-InformationToPatient
• https://fhir.cambio.se/StructureDefinition/encounter-registerPaymentPossible

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	EncounterCore	An interaction during which services are provided to the patient
meta	Σ	0..1	Meta	Metadata about the resource
source	SΣ	0..1	uri	Identifies where the resource comes from
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:informationToPatient		0..1	string	Optional Extensions Element URL: https://fhir.cambio.se/StructureDefinition/encounter-InformationToPatient
extension:arrivalRegistrationPossible		0..1	boolean	Optional Extensions Element URL: https://fhir.cambio.se/StructureDefinition/encounter-registerPaymentPossible
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	Σ	0..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
code	Σ	0..1	code	Symbol in syntax defined by the system Fixed Value: PRENC
display	Σ	0..1	string	Representation defined by the system Fixed Value: pre-admission
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	Fixed Value: PRENC http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.classHistory.class	extensible	ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode

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 EncounterCore

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter			EncounterCore
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:informationToPatient		0..1	string	Optional Extensions Element URL: https://fhir.cambio.se/StructureDefinition/encounter-InformationToPatient
extension:arrivalRegistrationPossible		0..1	boolean	Optional Extensions Element URL: https://fhir.cambio.se/StructureDefinition/encounter-registerPaymentPossible
identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.cambio.se/Encounter
statusHistory		0..0
class
system		0..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
code		0..1	code	Symbol in syntax defined by the system Fixed Value: PRENC
display		0..1	string	Representation defined by the system Fixed Value: pre-admission
type		0..0
serviceType		0..0
priority		0..0
subject		0..0
episodeOfCare		0..0
basedOn		0..0
participant		0..0
appointment		0..0
period		0..0
length		0..0
reasonCode		0..0
reasonReference		0..0
diagnosis		0..0
account		0..0
hospitalization		0..0
location		0..0
serviceProvider		0..0
partOf		0..0
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	EncounterCore	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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	SΣ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:informationToPatient		0..1	string	Optional Extensions Element URL: https://fhir.cambio.se/StructureDefinition/encounter-InformationToPatient
extension:arrivalRegistrationPossible		0..1	boolean	Optional Extensions Element URL: https://fhir.cambio.se/StructureDefinition/encounter-registerPaymentPossible
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 Fixed Value: https://fhir.cambio.se/Encounter
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	Σ	0..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Fixed Value: PRENC
display	Σ	0..1	string	Representation defined by the system Fixed Value: pre-admission
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Encounter.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
Encounter.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
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	Fixed Value: PRENC 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.admitSource	preferred	AdmitSource http://hl7.org/fhir/ValueSet/encounter-admit-source 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 EncounterCore

Summary

Fixed: 4 elements
Prohibited: 19 elements

Extensions

This structure refers to these extensions:

• https://fhir.cambio.se/StructureDefinition/encounter-InformationToPatient
• https://fhir.cambio.se/StructureDefinition/encounter-registerPaymentPossible

Other representations of profile: CSV, Excel, Schematron