Healthcare Financial Services IG Edition 1 - Local Development build (v0.3.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: Nphies Encounter ( Abstract )

Encounter Profile

Usage:

• Derived from this Resource Profile: Nphies Encounter AMB (Auth), Nphies Encounter EMER (Auth), Nphies Encounter HH (Auth), Nphies Encounter IMP (Auth)... Show 8 more, Nphies Encounter SS (Auth), Nphies Encounter VR (Auth), Nphies Encounter AMB (Claim), Nphies Encounter EMER (Claim), Nphies Encounter HH (Claim), Nphies Encounter IMP (Claim), Nphies Encounter SS (Claim) and Nphies Encounter VR (Claim)
• Refer to this Resource Profile: Encounter
• Examples for this Resource Profile: Encounter/10121, Encounter/10122, Encounter/10123, Encounter/10128 and Encounter/10129

Formal Views of Profile Content

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

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

This structure is derived from Encounter

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	Encounter	This is an abstract profile. Child profiles: NphiesEncounter_Auth_AMB, NphiesEncounter_Auth_EMER, NphiesEncounter_Auth_HH, NphiesEncounter_Auth_IMP, NphiesEncounter_Auth_SS, NphiesEncounter_Auth_VR, NphiesEncounter_Claim_AMB, NphiesEncounter_Claim_EMER, NphiesEncounter_Claim_HH, NphiesEncounter_Claim_IMP, NphiesEncounter_Claim_SS, NphiesEncounter_Claim_VR An interaction during which services are provided to the patient
id		1..1	id	Logical id of this artifact Max Length:64
meta		1..1	Meta	Metadata about the resource
profile		1..*	DP_canonical(StructureDefinition)	Profiles this resource claims to conform to
identifier		1..1	DP_Identifier_A	Identifier(s) by which this encounter is known
status		1..1	DP_code	planned | arrived | triaged | in-progress | onleave | finished | cancelled +
class		1..1	DP_Coding	Classification of patient encounter Binding: Encounter Class (required)
serviceType	S	0..1	DP_CodeableConcept	Specific type of service Binding: Service Type (required)
priority	S	0..1	DP_CodeableConcept	Indicates the urgency of the encounter Binding: V3 ActPriority (required)
subject		1..1	DP_Reference_1(Nphies Patient)	The patient or group present at the encounter
period		1..1	DP_Period_3	The start and end time of the encounter
hospitalization	S	0..1	BackboneElement	Details about the admission to a healthcare service
origin		0..1	DP_Reference_1or2b(Nphies Location | Nphies Provider Organization)	The location/organization from which the patient came before admission
serviceProvider		1..1	Reference(Nphies Provider Organization)	The organization (facility) responsible for this encounter
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Encounter.class	required	EncounterClass http://nphies.sa/terminology/ValueSet/encounter-class from this IG
Encounter.serviceType	required	ServiceType (a valid code from Service Type) http://nphies.sa/terminology/ValueSet/service-type from this IG
Encounter.priority	required	V3ActPriority http://nphies.sa/terminology/ValueSet/v3-ActPriority from this IG

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	Encounter	This is an abstract profile. Child profiles: NphiesEncounter_Auth_AMB, NphiesEncounter_Auth_EMER, NphiesEncounter_Auth_HH, NphiesEncounter_Auth_IMP, NphiesEncounter_Auth_SS, NphiesEncounter_Auth_VR, NphiesEncounter_Claim_AMB, NphiesEncounter_Claim_EMER, NphiesEncounter_Claim_HH, NphiesEncounter_Claim_IMP, NphiesEncounter_Claim_SS, NphiesEncounter_Claim_VR An interaction during which services are provided to the patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
id	Σ	1..1	id	Logical id of this artifact Max Length:64
meta	Σ	1..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
profile	Σ	1..*	DP_canonical(StructureDefinition)	Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	Σ	1..1	DP_Identifier_A	Identifier(s) by which this encounter is known ele-1: All FHIR elements must have a @value or children
status	?!Σ	1..1	DP_code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. ele-1: All FHIR elements must have a @value or children
class	Σ	1..1	DP_Coding	Classification of patient encounter Binding: Encounter Class (required) ele-1: All FHIR elements must have a @value or children
serviceType	SΣ	0..1	DP_CodeableConcept	Specific type of service Binding: Service Type (required) ele-1: All FHIR elements must have a @value or children
priority	S	0..1	DP_CodeableConcept	Indicates the urgency of the encounter Binding: V3 ActPriority (required) ele-1: All FHIR elements must have a @value or children
subject	Σ	1..1	DP_Reference_1(Nphies Patient)	The patient or group present at the encounter ele-1: All FHIR elements must have a @value or children
period		1..1	DP_Period_3	The start and end time of the encounter ele-1: All FHIR elements must have a @value or children
hospitalization	S	0..1	BackboneElement	Details about the admission to a healthcare service ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
origin		0..1	DP_Reference_1or2b(Nphies Location | Nphies Provider Organization)	The location/organization from which the patient came before admission ele-1: All FHIR elements must have a @value or children
serviceProvider		1..1	Reference(Nphies Provider Organization)	The organization (facility) responsible for this encounter ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Encounter.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard
Encounter.class	required	EncounterClass http://nphies.sa/terminology/ValueSet/encounter-class from this IG
Encounter.serviceType	required	ServiceType (a valid code from Service Type) http://nphies.sa/terminology/ValueSet/service-type from this IG
Encounter.priority	required	V3ActPriority http://nphies.sa/terminology/ValueSet/v3-ActPriority from this IG

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

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	Encounter	This is an abstract profile. Child profiles: NphiesEncounter_Auth_AMB, NphiesEncounter_Auth_EMER, NphiesEncounter_Auth_HH, NphiesEncounter_Auth_IMP, NphiesEncounter_Auth_SS, NphiesEncounter_Auth_VR, NphiesEncounter_Claim_AMB, NphiesEncounter_Claim_EMER, NphiesEncounter_Claim_HH, NphiesEncounter_Claim_IMP, NphiesEncounter_Claim_SS, NphiesEncounter_Claim_VR An interaction during which services are provided to the patient
id	Σ	1..1	id	Logical id of this artifact Max Length:64
meta	Σ	1..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	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	1..*	DP_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
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	1..1	DP_Identifier_A	Identifier(s) by which this encounter is known
status	?!Σ	1..1	DP_code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
statusHistory		0..*	BackboneElement	List of past encounter statuses
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	Σ	1..1	DP_Coding	Classification of patient encounter Binding: Encounter Class (required)
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: EncounterType (example): The type of encounter.
serviceType	SΣ	0..1	DP_CodeableConcept	Specific type of service Binding: Service Type (required)
priority	S	0..1	DP_CodeableConcept	Indicates the urgency of the encounter Binding: V3 ActPriority (required)
subject	Σ	1..1	DP_Reference_1(Nphies Patient)	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	Σ	0..*	BackboneElement	List of participants involved in the 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
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		1..1	DP_Period_3	The start and end time of the encounter
length		0..1	Duration	Quantity of time the encounter lasted (less time absent)
reasonCode	Σ	0..*	CodeableConcept	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..*	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	S	0..1	BackboneElement	Details about the admission to a healthcare 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
preAdmissionIdentifier		0..1	Identifier	Pre-admission identifier
origin		0..1	DP_Reference_1or2b(Nphies Location | Nphies Provider Organization)	The location/organization from which the patient came before admission
admitSource		0..1	CodeableConcept	From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted.
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: DischargeDisposition (example): Discharge Disposition.
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: LocationType (example): Physical form of the location.
period		0..1	Period	Time period during which the patient was present at the location
serviceProvider		1..1	Reference(Nphies Provider 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.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	required	EncounterClass http://nphies.sa/terminology/ValueSet/encounter-class from this IG
Encounter.classHistory.class	extensible	ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.type	example	EncounterType http://hl7.org/fhir/ValueSet/encounter-type from the FHIR Standard
Encounter.serviceType	required	ServiceType (a valid code from Service Type) http://nphies.sa/terminology/ValueSet/service-type from this IG
Encounter.priority	required	V3ActPriority http://nphies.sa/terminology/ValueSet/v3-ActPriority from this IG
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	AdmitSource http://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard
Encounter.hospitalization.reAdmission	example	Hl7VSReAdmissionIndicator http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreference	example	Diet http://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard
Encounter.hospitalization.specialCourtesy	preferred	SpecialCourtesy http://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard
Encounter.hospitalization.specialArrangement	preferred	SpecialArrangements http://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard
Encounter.hospitalization.dischargeDisposition	example	DischargeDisposition http://hl7.org/fhir/ValueSet/encounter-discharge-disposition from the FHIR Standard
Encounter.location.status	required	EncounterLocationStatus http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard
Encounter.location.physicalType	example	LocationType http://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Encounter	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Encounter	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Encounter	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Encounter

Summary

Mandatory: 7 elements
Must-Support: 3 elements

Structures

This structure refers to these other structures:

• DP_canonical (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-canonical)
• DP_Identifier_A (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Identifier-A)
• DP_code (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-code)
• DP_Coding (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Coding)
• DP_CodeableConcept (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-CodeableConcept)
• DP_Reference_1 (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Reference-1)
• Nphies Patient (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/patient)
• DP_Period_3 (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Period-3)
• DP_Reference_1or2b (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Reference-1or2b)
• Nphies Location (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/location)
• Nphies Provider Organization (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/provider-organization)

Differential View

This structure is derived from Encounter

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	Encounter	This is an abstract profile. Child profiles: NphiesEncounter_Auth_AMB, NphiesEncounter_Auth_EMER, NphiesEncounter_Auth_HH, NphiesEncounter_Auth_IMP, NphiesEncounter_Auth_SS, NphiesEncounter_Auth_VR, NphiesEncounter_Claim_AMB, NphiesEncounter_Claim_EMER, NphiesEncounter_Claim_HH, NphiesEncounter_Claim_IMP, NphiesEncounter_Claim_SS, NphiesEncounter_Claim_VR An interaction during which services are provided to the patient
id		1..1	id	Logical id of this artifact Max Length:64
meta		1..1	Meta	Metadata about the resource
profile		1..*	DP_canonical(StructureDefinition)	Profiles this resource claims to conform to
identifier		1..1	DP_Identifier_A	Identifier(s) by which this encounter is known
status		1..1	DP_code	planned | arrived | triaged | in-progress | onleave | finished | cancelled +
class		1..1	DP_Coding	Classification of patient encounter Binding: Encounter Class (required)
serviceType	S	0..1	DP_CodeableConcept	Specific type of service Binding: Service Type (required)
priority	S	0..1	DP_CodeableConcept	Indicates the urgency of the encounter Binding: V3 ActPriority (required)
subject		1..1	DP_Reference_1(Nphies Patient)	The patient or group present at the encounter
period		1..1	DP_Period_3	The start and end time of the encounter
hospitalization	S	0..1	BackboneElement	Details about the admission to a healthcare service
origin		0..1	DP_Reference_1or2b(Nphies Location | Nphies Provider Organization)	The location/organization from which the patient came before admission
serviceProvider		1..1	Reference(Nphies Provider Organization)	The organization (facility) responsible for this encounter
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Encounter.class	required	EncounterClass http://nphies.sa/terminology/ValueSet/encounter-class from this IG
Encounter.serviceType	required	ServiceType (a valid code from Service Type) http://nphies.sa/terminology/ValueSet/service-type from this IG
Encounter.priority	required	V3ActPriority http://nphies.sa/terminology/ValueSet/v3-ActPriority from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	Encounter	This is an abstract profile. Child profiles: NphiesEncounter_Auth_AMB, NphiesEncounter_Auth_EMER, NphiesEncounter_Auth_HH, NphiesEncounter_Auth_IMP, NphiesEncounter_Auth_SS, NphiesEncounter_Auth_VR, NphiesEncounter_Claim_AMB, NphiesEncounter_Claim_EMER, NphiesEncounter_Claim_HH, NphiesEncounter_Claim_IMP, NphiesEncounter_Claim_SS, NphiesEncounter_Claim_VR An interaction during which services are provided to the patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
id	Σ	1..1	id	Logical id of this artifact Max Length:64
meta	Σ	1..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
profile	Σ	1..*	DP_canonical(StructureDefinition)	Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	Σ	1..1	DP_Identifier_A	Identifier(s) by which this encounter is known ele-1: All FHIR elements must have a @value or children
status	?!Σ	1..1	DP_code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. ele-1: All FHIR elements must have a @value or children
class	Σ	1..1	DP_Coding	Classification of patient encounter Binding: Encounter Class (required) ele-1: All FHIR elements must have a @value or children
serviceType	SΣ	0..1	DP_CodeableConcept	Specific type of service Binding: Service Type (required) ele-1: All FHIR elements must have a @value or children
priority	S	0..1	DP_CodeableConcept	Indicates the urgency of the encounter Binding: V3 ActPriority (required) ele-1: All FHIR elements must have a @value or children
subject	Σ	1..1	DP_Reference_1(Nphies Patient)	The patient or group present at the encounter ele-1: All FHIR elements must have a @value or children
period		1..1	DP_Period_3	The start and end time of the encounter ele-1: All FHIR elements must have a @value or children
hospitalization	S	0..1	BackboneElement	Details about the admission to a healthcare service ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
origin		0..1	DP_Reference_1or2b(Nphies Location | Nphies Provider Organization)	The location/organization from which the patient came before admission ele-1: All FHIR elements must have a @value or children
serviceProvider		1..1	Reference(Nphies Provider Organization)	The organization (facility) responsible for this encounter ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Encounter.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard
Encounter.class	required	EncounterClass http://nphies.sa/terminology/ValueSet/encounter-class from this IG
Encounter.serviceType	required	ServiceType (a valid code from Service Type) http://nphies.sa/terminology/ValueSet/service-type from this IG
Encounter.priority	required	V3ActPriority http://nphies.sa/terminology/ValueSet/v3-ActPriority from this IG

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

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	Encounter	This is an abstract profile. Child profiles: NphiesEncounter_Auth_AMB, NphiesEncounter_Auth_EMER, NphiesEncounter_Auth_HH, NphiesEncounter_Auth_IMP, NphiesEncounter_Auth_SS, NphiesEncounter_Auth_VR, NphiesEncounter_Claim_AMB, NphiesEncounter_Claim_EMER, NphiesEncounter_Claim_HH, NphiesEncounter_Claim_IMP, NphiesEncounter_Claim_SS, NphiesEncounter_Claim_VR An interaction during which services are provided to the patient
id	Σ	1..1	id	Logical id of this artifact Max Length:64
meta	Σ	1..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	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	1..*	DP_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
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	1..1	DP_Identifier_A	Identifier(s) by which this encounter is known
status	?!Σ	1..1	DP_code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
statusHistory		0..*	BackboneElement	List of past encounter statuses
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	Σ	1..1	DP_Coding	Classification of patient encounter Binding: Encounter Class (required)
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: EncounterType (example): The type of encounter.
serviceType	SΣ	0..1	DP_CodeableConcept	Specific type of service Binding: Service Type (required)
priority	S	0..1	DP_CodeableConcept	Indicates the urgency of the encounter Binding: V3 ActPriority (required)
subject	Σ	1..1	DP_Reference_1(Nphies Patient)	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	Σ	0..*	BackboneElement	List of participants involved in the 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
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		1..1	DP_Period_3	The start and end time of the encounter
length		0..1	Duration	Quantity of time the encounter lasted (less time absent)
reasonCode	Σ	0..*	CodeableConcept	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..*	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	S	0..1	BackboneElement	Details about the admission to a healthcare 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
preAdmissionIdentifier		0..1	Identifier	Pre-admission identifier
origin		0..1	DP_Reference_1or2b(Nphies Location | Nphies Provider Organization)	The location/organization from which the patient came before admission
admitSource		0..1	CodeableConcept	From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted.
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: DischargeDisposition (example): Discharge Disposition.
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: LocationType (example): Physical form of the location.
period		0..1	Period	Time period during which the patient was present at the location
serviceProvider		1..1	Reference(Nphies Provider 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.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	required	EncounterClass http://nphies.sa/terminology/ValueSet/encounter-class from this IG
Encounter.classHistory.class	extensible	ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.type	example	EncounterType http://hl7.org/fhir/ValueSet/encounter-type from the FHIR Standard
Encounter.serviceType	required	ServiceType (a valid code from Service Type) http://nphies.sa/terminology/ValueSet/service-type from this IG
Encounter.priority	required	V3ActPriority http://nphies.sa/terminology/ValueSet/v3-ActPriority from this IG
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	AdmitSource http://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard
Encounter.hospitalization.reAdmission	example	Hl7VSReAdmissionIndicator http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreference	example	Diet http://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard
Encounter.hospitalization.specialCourtesy	preferred	SpecialCourtesy http://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard
Encounter.hospitalization.specialArrangement	preferred	SpecialArrangements http://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard
Encounter.hospitalization.dischargeDisposition	example	DischargeDisposition http://hl7.org/fhir/ValueSet/encounter-discharge-disposition from the FHIR Standard
Encounter.location.status	required	EncounterLocationStatus http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard
Encounter.location.physicalType	example	LocationType http://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Encounter	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Encounter	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Encounter	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Encounter

Summary

Mandatory: 7 elements
Must-Support: 3 elements

Structures

This structure refers to these other structures:

• DP_canonical (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-canonical)
• DP_Identifier_A (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Identifier-A)
• DP_code (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-code)
• DP_Coding (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Coding)
• DP_CodeableConcept (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-CodeableConcept)
• DP_Reference_1 (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Reference-1)
• Nphies Patient (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/patient)
• DP_Period_3 (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Period-3)
• DP_Reference_1or2b (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Reference-1or2b)
• Nphies Location (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/location)
• Nphies Provider Organization (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/provider-organization)

Other representations of profile: CSV, Excel, Schematron