JanuSync Encounter - JanuSync Implementation Guide v1.0.0

A set of rules under which this content was created

language

0..1

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:krcore-insuranceTypes

Extension
Slice: Unordered, Open by value:url

0..1

환자 보험 유형정보 (Patient insurance type information)
URL: http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-insuranceTypes

extension:visitType

0..1

초진/재진 유형 (Initial visit / Follow-up visit classification)
URL: http://connectdtx.kr/fhir/StructureDefinition/JanuSyncEncounterVisitType
Binding: JanuSync Encounter Visit Type (required)

extension:authoredOn

0..1

의료인이 내원을 결정한 시점 (Time of medical provider’s decision to schedule patient visit)
URL: http://connectdtx.kr/fhir/StructureDefinition/JanuSyncEncounterAuthoredOn

?!

0..*

Extensions that cannot be ignored

identifier

Σ

0..*

Identifier(s) by which this encounter is known

?!SΣ

1..1

내원 상태 (Patient visit status) : in-progress | finished +
Binding: EncounterStatus (required)
Example Value (Preferred): finished

statusHistory

0..*

List of past encounter statuses

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

1..1

1..1

The time that the episode was in the specified status

SΣ

1..1

내원 구분 (Classification of patient visit type)
Binding: ActEncounterCode (required)

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

system

SΣ

1..1

진료 구분 코드체계
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode

version

Σ

0..1

Version of the system - if relevant

SΣ

1..1

진료 구분 코드 (Clinical service classification code) : AMB | IMP | EMER +

display

Σ

0..1

Representation defined by the system

userSelected

Σ

0..1

boolean

If this coding was chosen directly by the user

classHistory

0..*

List of past encounter classes

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

1..1

inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.

1..1

The time that the episode was in the specified class

Σ

0..*

Specific type of encounter
Binding: EncounterType (example): The type of encounter.

serviceType

Σ

0..1

Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.

priority

0..1

Reference(JanuSync Patient)

Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.

subject

Σ

1..1

진료 환자 (Subject Information)

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

Σ

1..*

진료 참여 의료인 (Medical professionals participating in patient care)

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

Σ

0..*

Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.

0..1

Reference(JanuSync MedicalDoctor PractitionerRole)

Period of time during the encounter that the participant participated

individual

Σ

1..1

진료 참여 의료인 역할 (Medical professionals participating in patient care)

appointment

Σ

0..*

Reference(Appointment)

The appointment that scheduled this encounter

S

1..1

내원 기간 (Patient visit period)

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

start

SΣC

1..1

내원 시작 일시 (Start date and time of patient visit)

end

SΣC

0..1

내원 종료 일시 (End date and time of patient visit)

length

0..1

Duration

Quantity of time the encounter lasted (less time absent)

reasonCode

Σ

0..*

Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.

reasonReference

Σ

0..*

Reference(Condition | Procedure | Observation | ImmunizationRecommendation)

Reason the encounter takes place (reference)

diagnosis

Σ

0..*

The list of diagnosis relevant to this encounter

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

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

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

Details about the admission to a healthcare service

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

preAdmissionIdentifier

0..1

Pre-admission identifier

origin

0..1

The location/organization from which the patient came before admission

admitSource

0..1

From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.

reAdmission

0..1

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..*

Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.

specialCourtesy

0..*

Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.

specialArrangement

0..*

Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.

destination

0..1

Location/organization to which the patient is discharged

dischargeDisposition

0..1

Category or kind of location after discharge
Binding: DischargeDisposition (example): Discharge Disposition.

0..*

List of locations where the patient has been

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

1..1

Reference(Location)

Location the encounter takes place

0..1

planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.

physicalType

0..1

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.

0..1

Reference(JanuSync Healthcare Organization)

Time period during which the patient was present at the location

serviceProvider

1..1

내원 기관 (Patient visit institution)

partOf

0..1

Reference(Encounter)

Another Encounter this encounter is part of

Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Encounter.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Encounter.status	Base	required	EncounterStatus	📦4.0.1	FHIR Std.
Encounter.statusHistory.status	Base	required	EncounterStatus	📍4.0.1	FHIR Std.
Encounter.class	Base	required	ActEncounterCode	📦3.0.0	THO v7.0
Encounter.classHistory.class	Base	extensible	ActEncounterCode	📦3.0.0	THO v7.0
Encounter.type	Base	example	Encounter type	📦4.0.1	FHIR Std.
Encounter.serviceType	Base	example	Service type	📦4.0.1	FHIR Std.
Encounter.priority	Base	example	ActPriority	📦3.0.0	THO v7.0
Encounter.participant.type	Base	extensible	Participant type	📦4.0.1	FHIR Std.
Encounter.reasonCode	Base	preferred	Encounter Reason Codes	📦4.0.1	FHIR Std.
Encounter.diagnosis.use	Base	preferred	DiagnosisRole	📦4.0.1	FHIR Std.
Encounter.hospitalization.admitSource	Base	preferred	Admit source	📦4.0.1	FHIR Std.
Encounter.hospitalization.reAdmission	Base	example	hl7VS-re-admissionIndicator	📦2.0.0	THO v7.0
Encounter.hospitalization.dietPreference	Base	example	Diet	📦4.0.1	FHIR Std.
Encounter.hospitalization.specialCourtesy	Base	preferred	Special courtesy	📦4.0.1	FHIR Std.
Encounter.hospitalization.specialArrangement	Base	preferred	Special arrangements	📦4.0.1	FHIR Std.
Encounter.hospitalization.dischargeDisposition	Base	example	Discharge disposition	📦4.0.1	FHIR Std.
Encounter.location.status	Base	required	EncounterLocationStatus	📍4.0.1	FHIR Std.
Encounter.location.physicalType	Base	example	Location type	📦4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Encounter	If the resource is contained in another resource, it SHALL NOT contain nested Resources	`contained.contained.empty()`
dom-3	error	Encounter	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	`contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	`contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a security label	`contained.meta.security.empty()`
dom-6	best practice	Encounter	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	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 KRCore_Encounter

Summary

Mandatory: 6 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Key Elements View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Encounter		0..*	KRCore_Encounter	KR Core Encoutner Profile
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
extension:krcore-insuranceTypes		0..1	CodeableConcept	환자 보험 유형정보 (Patient insurance type information) URL: http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-insuranceTypes
extension:visitType		0..1	CodeableConcept	초진/재진 유형 (Initial visit / Follow-up visit classification) URL: http://connectdtx.kr/fhir/StructureDefinition/JanuSyncEncounterVisitType Binding: JanuSync Encounter Visit Type (required)
extension:authoredOn		0..1	dateTime	의료인이 내원을 결정한 시점 (Time of medical provider’s decision to schedule patient visit) URL: http://connectdtx.kr/fhir/StructureDefinition/JanuSyncEncounterAuthoredOn
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	내원 상태 (Patient visit status) : in-progress \| finished + Binding: EncounterStatus (required) Example Value (Preferred): finished
class	SΣ	1..1	Coding	내원 구분 (Classification of patient visit type) Binding: ActEncounterCode (required)
system	SΣ	1..1	uri	진료 구분 코드체계 Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
code	SΣ	1..1	code	진료 구분 코드 (Clinical service classification code) : AMB \| IMP \| EMER +
subject	Σ	1..1	Reference(JanuSync Patient)	진료 환자 (Subject Information)
participant	Σ	1..*	BackboneElement	진료 참여 의료인 (Medical professionals participating in patient care)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
individual	Σ	1..1	Reference(JanuSync MedicalDoctor PractitionerRole)	진료 참여 의료인 역할 (Medical professionals participating in patient care)
period	S	1..1	Period	내원 기간 (Patient visit period)
start	SΣC	1..1	dateTime	내원 시작 일시 (Start date and time of patient visit)
end	SΣC	0..1	dateTime	내원 종료 일시 (End date and time of patient visit)
serviceProvider		1..1	Reference(JanuSync Healthcare Organization)	내원 기관 (Patient visit institution)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Encounter.status	Base	required	EncounterStatus	📦4.0.1	FHIR Std.
Encounter.class	Base	required	ActEncounterCode	📦3.0.0	THO v7.0

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Encounter	If the resource is contained in another resource, it SHALL NOT contain nested Resources	`contained.contained.empty()`
dom-3	error	Encounter	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	`contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	`contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a security label	`contained.meta.security.empty()`
dom-6	best practice	Encounter	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	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 KRCore_Encounter

Name	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Encounter	0..*	KRCore_Encounter	KR Core Encoutner Profile
Slices for extension			Content/Rules for all slices
extension:krcore-insuranceTypes	0..1	KRCore_InsuranceTypes_Extension	환자 보험 유형정보 (Patient insurance type information)
extension:visitType	0..1	CodeableConcept	초진/재진 유형 (Initial visit / Follow-up visit classification) URL: http://connectdtx.kr/fhir/StructureDefinition/JanuSyncEncounterVisitType Binding: JanuSync Encounter Visit Type (required)
extension:authoredOn	0..1	dateTime	의료인이 내원을 결정한 시점 (Time of medical provider’s decision to schedule patient visit) URL: http://connectdtx.kr/fhir/StructureDefinition/JanuSyncEncounterAuthoredOn
status	1..1	code	내원 상태 (Patient visit status) : in-progress \| finished + Binding: EncounterStatus (required)
class	1..1	Coding	내원 구분 (Classification of patient visit type) Binding: ActEncounterCode (required)
system	1..1	uri	진료 구분 코드체계 Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
code	1..1	code	진료 구분 코드 (Clinical service classification code) : AMB \| IMP \| EMER +
subject	1..1	Reference(JanuSync Patient)	진료 환자 (Subject Information)
participant	1..*	BackboneElement	진료 참여 의료인 (Medical professionals participating in patient care)
individual	1..1	Reference(JanuSync MedicalDoctor PractitionerRole)	진료 참여 의료인 역할 (Medical professionals participating in patient care)
period	1..1	Period	내원 기간 (Patient visit period)
start	1..1	dateTime	내원 시작 일시 (Start date and time of patient visit)
end	0..1	dateTime	내원 종료 일시 (End date and time of patient visit)
serviceProvider	1..1	Reference(JanuSync Healthcare Organization)	내원 기관 (Patient visit institution)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Encounter.status	Base	required	EncounterStatus	📦4.0.1	FHIR Std.
Encounter.class	Base	required	ActEncounterCode	📦3.0.0	THO v7.0

Snapshot View

Description & Constraints Filter: Filters

Encounter

0..*

KRCore_Encounter

KR Core Encoutner Profile

id

Σ

0..1

id

Logical id of this artifact

Meta

Metadata about the resource

implicitRules

?!Σ

0..1

A set of rules under which this content was created

language

0..1

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:krcore-insuranceTypes

Extension
Slice: Unordered, Open by value:url

0..1

환자 보험 유형정보 (Patient insurance type information)
URL: http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-insuranceTypes

extension:visitType

0..1

초진/재진 유형 (Initial visit / Follow-up visit classification)
URL: http://connectdtx.kr/fhir/StructureDefinition/JanuSyncEncounterVisitType
Binding: JanuSync Encounter Visit Type (required)

extension:authoredOn

0..1

의료인이 내원을 결정한 시점 (Time of medical provider’s decision to schedule patient visit)
URL: http://connectdtx.kr/fhir/StructureDefinition/JanuSyncEncounterAuthoredOn

?!

0..*

Extensions that cannot be ignored

identifier

Σ

0..*

Identifier(s) by which this encounter is known

?!SΣ

1..1

내원 상태 (Patient visit status) : in-progress | finished +
Binding: EncounterStatus (required)
Example Value (Preferred): finished

statusHistory

0..*

List of past encounter statuses

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

1..1

1..1

The time that the episode was in the specified status

SΣ

1..1

내원 구분 (Classification of patient visit type)
Binding: ActEncounterCode (required)

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

system

SΣ

1..1

진료 구분 코드체계
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode

version

Σ

0..1

Version of the system - if relevant

SΣ

1..1

진료 구분 코드 (Clinical service classification code) : AMB | IMP | EMER +

display

Σ

0..1

Representation defined by the system

userSelected

Σ

0..1

boolean

If this coding was chosen directly by the user

classHistory

0..*

List of past encounter classes

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

1..1

inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.

1..1

The time that the episode was in the specified class

Σ

0..*

Specific type of encounter
Binding: EncounterType (example): The type of encounter.

serviceType

Σ

0..1

Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.

priority

0..1

Reference(JanuSync Patient)

Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.

subject

Σ

1..1

진료 환자 (Subject Information)

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

Σ

1..*

진료 참여 의료인 (Medical professionals participating in patient care)

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

Σ

0..*

Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.

0..1

Reference(JanuSync MedicalDoctor PractitionerRole)

Period of time during the encounter that the participant participated

individual

Σ

1..1

진료 참여 의료인 역할 (Medical professionals participating in patient care)

appointment

Σ

0..*

Reference(Appointment)

The appointment that scheduled this encounter

S

1..1

내원 기간 (Patient visit period)

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

start

SΣC

1..1

내원 시작 일시 (Start date and time of patient visit)

end

SΣC

0..1

내원 종료 일시 (End date and time of patient visit)

length

0..1

Duration

Quantity of time the encounter lasted (less time absent)

reasonCode

Σ

0..*

Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.

reasonReference

Σ

0..*

Reference(Condition | Procedure | Observation | ImmunizationRecommendation)

Reason the encounter takes place (reference)

diagnosis

Σ

0..*

The list of diagnosis relevant to this encounter

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

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

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

Details about the admission to a healthcare service

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

preAdmissionIdentifier

0..1

Pre-admission identifier

origin

0..1

The location/organization from which the patient came before admission

admitSource

0..1

From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.

reAdmission

0..1

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..*

Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.

specialCourtesy

0..*

Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.

specialArrangement

0..*

Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.

destination

0..1

Location/organization to which the patient is discharged

dischargeDisposition

0..1

Category or kind of location after discharge
Binding: DischargeDisposition (example): Discharge Disposition.

0..*

List of locations where the patient has been

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

1..1

Reference(Location)

Location the encounter takes place

0..1

planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.

physicalType

0..1

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.

0..1