Healthcare Financial Services IG Edition 1
0.3.0 - ci-build Saudi Arabia flag

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

Resource Profile: Nphies Encounter SS (Claim)

Official URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/encounter-claim-SS Version: 0.3.0
Draft as of 2025-06-23 Computable Name: NphiesEncounter_Claim_SS

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

Encounter Day Case Profile for Claim

Usage:

Formal Views of Profile Content

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

This structure is derived from NphiesEncounter

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter C 0..* NphiesEncounter An interaction during which services are provided to the patient
BV-00740: Extension CauseOfDeath is required if dischargeDisposition is 'died' or Emergency department Disposition is 'DED' or 'DOA'.
BV-00758: If any of period.end, hospitalization.dischargeDisposition, hospitalization extension dischargeSpecialty then all must be specified.
BV-00727: If Encounter.class = 'Inpatient Encounter' or 'Day Case Admission' Then Encounter.hospitalization.admitSource SHALL be provided
BV-00744: Hospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class.
BV-00759: Hospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class.
BV-00852: Discharge Disposition and Encounter end Date SHALL be provided in claims with Inpatient or DayCase Admission Encounter Class when Discharge Specialty exists.
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:causeOfDeath S 0..1 DP_CodeableConcept Cause Of Death
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-causeOfDeath
Binding: Cause of death (required)
... hospitalization
.... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:admissionSpecialty S 1..1 DP_CodeableConcept Admission Specialty
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-admissionSpecialty
Binding: Practice Codes (required)
..... extension:dischargeSpecialty S 0..1 DP_CodeableConcept Discharge Specialty
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty
Binding: Practice Codes (required)
..... extension:intendedLengthOfStay 1..1 DP_CodeableConcept Intended Length Of Stay
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-intendedLengthOfStay
Binding: Intended Length Of Stay (required)
.... origin S 0..1 DP_Reference_1or2b(Nphies Location | Nphies Provider Organization) The location/organization from which the patient came before admission
.... admitSource 1..1 DP_CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: Admit Source (required)
.... reAdmission S 0..1 DP_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 (required)
.... dischargeDisposition S 0..1 DP_CodeableConcept Category or kind of location after discharge
Binding: Discharge Disposition (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Encounter.hospitalization.admitSourcerequiredAdmitSource (a valid code from Admit Source)
http://nphies.sa/terminology/ValueSet/admit-source
from this IG
Encounter.hospitalization.reAdmissionrequiredHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dischargeDispositionrequiredDischargeDisposition (a valid code from Discharge disposition)
http://nphies.sa/terminology/ValueSet/encounter-discharge-disposition
from this IG

Constraints

IdGradePath(s)DetailsRequirements
BV-00727errorEncounterIf Encounter.class = 'Inpatient Encounter' or 'Day Case Admission' Then Encounter.hospitalization.admitSource SHALL be provided
: hospitalization.admitSource.exists()
BV-00740errorEncounterExtension CauseOfDeath is required if dischargeDisposition is 'died' or Emergency department Disposition is 'DED' or 'DOA'.
: (hospitalization.exists() implies hospitalization.dischargeDisposition.exists() implies hospitalization.dischargeDisposition.coding.first().code='died') or (extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-emergencyDepartmentDisposition').value.ofType(CodeableConcept).coding.first().code='DED') or (extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-emergencyDepartmentDisposition').value.ofType(CodeableConcept).coding.first().code='DOA') implies extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-causeOfDeath').exists()
BV-00744errorEncounterHospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class.
: hospitalization.extension('http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-intendedLengthOfStay').exists()
BV-00758errorEncounterIf any of period.end, hospitalization.dischargeDisposition, hospitalization extension dischargeSpecialty then all must be specified.
: period.end.exists() or (hospitalization.exists() implies hospitalization.dischargeDisposition.exists()) or (hospitalization.extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty').exists()) implies (period.end.exists() and hospitalization.dischargeDisposition.exists() and hospitalization.extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty').exists())
BV-00759errorEncounterHospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class.
: period.end.exists() implies hospitalization.dischargeDisposition.exists()
BV-00852errorEncounterDischarge Disposition and Encounter end Date SHALL be provided in claims with Inpatient or DayCase Admission Encounter Class when Discharge Specialty exists.
: hospitalization.extension('http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty').exists() implies (hospitalization.dischargeDisposition.exists() and period.end.exists())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter C 0..* NphiesEncounter 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
BV-00740: Extension CauseOfDeath is required if dischargeDisposition is 'died' or Emergency department Disposition is 'DED' or 'DOA'.
BV-00758: If any of period.end, hospitalization.dischargeDisposition, hospitalization extension dischargeSpecialty then all must be specified.
BV-00727: If Encounter.class = 'Inpatient Encounter' or 'Day Case Admission' Then Encounter.hospitalization.admitSource SHALL be provided
BV-00744: Hospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class.
BV-00759: Hospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class.
BV-00852: Discharge Disposition and Encounter end Date SHALL be provided in claims with Inpatient or DayCase Admission Encounter Class when Discharge Specialty exists.
... 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
.... extension:causeOfDeath S 0..1 DP_CodeableConcept Cause Of Death
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-causeOfDeath
Binding: Cause of death (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... 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
.... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:admissionSpecialty S 1..1 DP_CodeableConcept Admission Specialty
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-admissionSpecialty
Binding: Practice Codes (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:dischargeSpecialty S 0..1 DP_CodeableConcept Discharge Specialty
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty
Binding: Practice Codes (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:intendedLengthOfStay 1..1 DP_CodeableConcept Intended Length Of Stay
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-intendedLengthOfStay
Binding: Intended Length Of Stay (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... 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 S 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
.... admitSource 1..1 DP_CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: Admit Source (required)
ele-1: All FHIR elements must have a @value or children
.... reAdmission S 0..1 DP_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 (required)
ele-1: All FHIR elements must have a @value or children
.... dischargeDisposition S 0..1 DP_CodeableConcept Category or kind of location after discharge
Binding: Discharge Disposition (required)
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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.classrequiredEncounterClass
http://nphies.sa/terminology/ValueSet/encounter-class
from this IG
Encounter.serviceTyperequiredServiceType (a valid code from Service Type)
http://nphies.sa/terminology/ValueSet/service-type
from this IG
Encounter.priorityrequiredV3ActPriority
http://nphies.sa/terminology/ValueSet/v3-ActPriority
from this IG
Encounter.hospitalization.admitSourcerequiredAdmitSource (a valid code from Admit Source)
http://nphies.sa/terminology/ValueSet/admit-source
from this IG
Encounter.hospitalization.reAdmissionrequiredHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dischargeDispositionrequiredDischargeDisposition (a valid code from Discharge disposition)
http://nphies.sa/terminology/ValueSet/encounter-discharge-disposition
from this IG

Constraints

IdGradePath(s)DetailsRequirements
BV-00727errorEncounterIf Encounter.class = 'Inpatient Encounter' or 'Day Case Admission' Then Encounter.hospitalization.admitSource SHALL be provided
: hospitalization.admitSource.exists()
BV-00740errorEncounterExtension CauseOfDeath is required if dischargeDisposition is 'died' or Emergency department Disposition is 'DED' or 'DOA'.
: (hospitalization.exists() implies hospitalization.dischargeDisposition.exists() implies hospitalization.dischargeDisposition.coding.first().code='died') or (extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-emergencyDepartmentDisposition').value.ofType(CodeableConcept).coding.first().code='DED') or (extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-emergencyDepartmentDisposition').value.ofType(CodeableConcept).coding.first().code='DOA') implies extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-causeOfDeath').exists()
BV-00744errorEncounterHospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class.
: hospitalization.extension('http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-intendedLengthOfStay').exists()
BV-00758errorEncounterIf any of period.end, hospitalization.dischargeDisposition, hospitalization extension dischargeSpecialty then all must be specified.
: period.end.exists() or (hospitalization.exists() implies hospitalization.dischargeDisposition.exists()) or (hospitalization.extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty').exists()) implies (period.end.exists() and hospitalization.dischargeDisposition.exists() and hospitalization.extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty').exists())
BV-00759errorEncounterHospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class.
: period.end.exists() implies hospitalization.dischargeDisposition.exists()
BV-00852errorEncounterDischarge Disposition and Encounter end Date SHALL be provided in claims with Inpatient or DayCase Admission Encounter Class when Discharge Specialty exists.
: hospitalization.extension('http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty').exists() implies (hospitalization.dischargeDisposition.exists() and period.end.exists())
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter C 0..* NphiesEncounter An interaction during which services are provided to the patient
BV-00740: Extension CauseOfDeath is required if dischargeDisposition is 'died' or Emergency department Disposition is 'DED' or 'DOA'.
BV-00758: If any of period.end, hospitalization.dischargeDisposition, hospitalization extension dischargeSpecialty then all must be specified.
BV-00727: If Encounter.class = 'Inpatient Encounter' or 'Day Case Admission' Then Encounter.hospitalization.admitSource SHALL be provided
BV-00744: Hospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class.
BV-00759: Hospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class.
BV-00852: Discharge Disposition and Encounter end Date SHALL be provided in claims with Inpatient or DayCase Admission Encounter Class when Discharge Specialty exists.
... 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 BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:causeOfDeath S 0..1 DP_CodeableConcept Cause Of Death
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-causeOfDeath
Binding: Cause of death (required)
... 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
.... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:admissionSpecialty S 1..1 DP_CodeableConcept Admission Specialty
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-admissionSpecialty
Binding: Practice Codes (required)
..... extension:dischargeSpecialty S 0..1 DP_CodeableConcept Discharge Specialty
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty
Binding: Practice Codes (required)
..... extension:intendedLengthOfStay 1..1 DP_CodeableConcept Intended Length Of Stay
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-intendedLengthOfStay
Binding: Intended Length Of Stay (required)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin S 0..1 DP_Reference_1or2b(Nphies Location | Nphies Provider Organization) The location/organization from which the patient came before admission
.... admitSource 1..1 DP_CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: Admit Source (required)
.... reAdmission S 0..1 DP_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 (required)
.... 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 S 0..1 DP_CodeableConcept Category or kind of location after discharge
Binding: Discharge Disposition (required)
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Encounter.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Encounter.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.classrequiredEncounterClass
http://nphies.sa/terminology/ValueSet/encounter-class
from this IG
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typeexampleEncounterType
http://hl7.org/fhir/ValueSet/encounter-type
from the FHIR Standard
Encounter.serviceTyperequiredServiceType (a valid code from Service Type)
http://nphies.sa/terminology/ValueSet/service-type
from this IG
Encounter.priorityrequiredV3ActPriority
http://nphies.sa/terminology/ValueSet/v3-ActPriority
from this IG
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Encounter.diagnosis.usepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
from the FHIR Standard
Encounter.hospitalization.admitSourcerequiredAdmitSource (a valid code from Admit Source)
http://nphies.sa/terminology/ValueSet/admit-source
from this IG
Encounter.hospitalization.reAdmissionrequiredHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreferenceexampleDiet
http://hl7.org/fhir/ValueSet/encounter-diet
from the FHIR Standard
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
http://hl7.org/fhir/ValueSet/encounter-special-courtesy
from the FHIR Standard
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
http://hl7.org/fhir/ValueSet/encounter-special-arrangements
from the FHIR Standard
Encounter.hospitalization.dischargeDispositionrequiredDischargeDisposition (a valid code from Discharge disposition)
http://nphies.sa/terminology/ValueSet/encounter-discharge-disposition
from this IG
Encounter.location.statusrequiredEncounterLocationStatus
http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1
from the FHIR Standard
Encounter.location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
BV-00727errorEncounterIf Encounter.class = 'Inpatient Encounter' or 'Day Case Admission' Then Encounter.hospitalization.admitSource SHALL be provided
: hospitalization.admitSource.exists()
BV-00740errorEncounterExtension CauseOfDeath is required if dischargeDisposition is 'died' or Emergency department Disposition is 'DED' or 'DOA'.
: (hospitalization.exists() implies hospitalization.dischargeDisposition.exists() implies hospitalization.dischargeDisposition.coding.first().code='died') or (extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-emergencyDepartmentDisposition').value.ofType(CodeableConcept).coding.first().code='DED') or (extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-emergencyDepartmentDisposition').value.ofType(CodeableConcept).coding.first().code='DOA') implies extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-causeOfDeath').exists()
BV-00744errorEncounterHospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class.
: hospitalization.extension('http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-intendedLengthOfStay').exists()
BV-00758errorEncounterIf any of period.end, hospitalization.dischargeDisposition, hospitalization extension dischargeSpecialty then all must be specified.
: period.end.exists() or (hospitalization.exists() implies hospitalization.dischargeDisposition.exists()) or (hospitalization.extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty').exists()) implies (period.end.exists() and hospitalization.dischargeDisposition.exists() and hospitalization.extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty').exists())
BV-00759errorEncounterHospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class.
: period.end.exists() implies hospitalization.dischargeDisposition.exists()
BV-00852errorEncounterDischarge Disposition and Encounter end Date SHALL be provided in claims with Inpatient or DayCase Admission Encounter Class when Discharge Specialty exists.
: hospitalization.extension('http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty').exists() implies (hospitalization.dischargeDisposition.exists() and period.end.exists())
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from NphiesEncounter

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter C 0..* NphiesEncounter An interaction during which services are provided to the patient
BV-00740: Extension CauseOfDeath is required if dischargeDisposition is 'died' or Emergency department Disposition is 'DED' or 'DOA'.
BV-00758: If any of period.end, hospitalization.dischargeDisposition, hospitalization extension dischargeSpecialty then all must be specified.
BV-00727: If Encounter.class = 'Inpatient Encounter' or 'Day Case Admission' Then Encounter.hospitalization.admitSource SHALL be provided
BV-00744: Hospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class.
BV-00759: Hospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class.
BV-00852: Discharge Disposition and Encounter end Date SHALL be provided in claims with Inpatient or DayCase Admission Encounter Class when Discharge Specialty exists.
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:causeOfDeath S 0..1 DP_CodeableConcept Cause Of Death
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-causeOfDeath
Binding: Cause of death (required)
... hospitalization
.... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:admissionSpecialty S 1..1 DP_CodeableConcept Admission Specialty
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-admissionSpecialty
Binding: Practice Codes (required)
..... extension:dischargeSpecialty S 0..1 DP_CodeableConcept Discharge Specialty
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty
Binding: Practice Codes (required)
..... extension:intendedLengthOfStay 1..1 DP_CodeableConcept Intended Length Of Stay
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-intendedLengthOfStay
Binding: Intended Length Of Stay (required)
.... origin S 0..1 DP_Reference_1or2b(Nphies Location | Nphies Provider Organization) The location/organization from which the patient came before admission
.... admitSource 1..1 DP_CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: Admit Source (required)
.... reAdmission S 0..1 DP_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 (required)
.... dischargeDisposition S 0..1 DP_CodeableConcept Category or kind of location after discharge
Binding: Discharge Disposition (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Encounter.hospitalization.admitSourcerequiredAdmitSource (a valid code from Admit Source)
http://nphies.sa/terminology/ValueSet/admit-source
from this IG
Encounter.hospitalization.reAdmissionrequiredHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dischargeDispositionrequiredDischargeDisposition (a valid code from Discharge disposition)
http://nphies.sa/terminology/ValueSet/encounter-discharge-disposition
from this IG

Constraints

IdGradePath(s)DetailsRequirements
BV-00727errorEncounterIf Encounter.class = 'Inpatient Encounter' or 'Day Case Admission' Then Encounter.hospitalization.admitSource SHALL be provided
: hospitalization.admitSource.exists()
BV-00740errorEncounterExtension CauseOfDeath is required if dischargeDisposition is 'died' or Emergency department Disposition is 'DED' or 'DOA'.
: (hospitalization.exists() implies hospitalization.dischargeDisposition.exists() implies hospitalization.dischargeDisposition.coding.first().code='died') or (extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-emergencyDepartmentDisposition').value.ofType(CodeableConcept).coding.first().code='DED') or (extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-emergencyDepartmentDisposition').value.ofType(CodeableConcept).coding.first().code='DOA') implies extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-causeOfDeath').exists()
BV-00744errorEncounterHospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class.
: hospitalization.extension('http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-intendedLengthOfStay').exists()
BV-00758errorEncounterIf any of period.end, hospitalization.dischargeDisposition, hospitalization extension dischargeSpecialty then all must be specified.
: period.end.exists() or (hospitalization.exists() implies hospitalization.dischargeDisposition.exists()) or (hospitalization.extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty').exists()) implies (period.end.exists() and hospitalization.dischargeDisposition.exists() and hospitalization.extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty').exists())
BV-00759errorEncounterHospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class.
: period.end.exists() implies hospitalization.dischargeDisposition.exists()
BV-00852errorEncounterDischarge Disposition and Encounter end Date SHALL be provided in claims with Inpatient or DayCase Admission Encounter Class when Discharge Specialty exists.
: hospitalization.extension('http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty').exists() implies (hospitalization.dischargeDisposition.exists() and period.end.exists())

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter C 0..* NphiesEncounter 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
BV-00740: Extension CauseOfDeath is required if dischargeDisposition is 'died' or Emergency department Disposition is 'DED' or 'DOA'.
BV-00758: If any of period.end, hospitalization.dischargeDisposition, hospitalization extension dischargeSpecialty then all must be specified.
BV-00727: If Encounter.class = 'Inpatient Encounter' or 'Day Case Admission' Then Encounter.hospitalization.admitSource SHALL be provided
BV-00744: Hospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class.
BV-00759: Hospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class.
BV-00852: Discharge Disposition and Encounter end Date SHALL be provided in claims with Inpatient or DayCase Admission Encounter Class when Discharge Specialty exists.
... 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
.... extension:causeOfDeath S 0..1 DP_CodeableConcept Cause Of Death
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-causeOfDeath
Binding: Cause of death (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... 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
.... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:admissionSpecialty S 1..1 DP_CodeableConcept Admission Specialty
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-admissionSpecialty
Binding: Practice Codes (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:dischargeSpecialty S 0..1 DP_CodeableConcept Discharge Specialty
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty
Binding: Practice Codes (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:intendedLengthOfStay 1..1 DP_CodeableConcept Intended Length Of Stay
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-intendedLengthOfStay
Binding: Intended Length Of Stay (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... 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 S 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
.... admitSource 1..1 DP_CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: Admit Source (required)
ele-1: All FHIR elements must have a @value or children
.... reAdmission S 0..1 DP_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 (required)
ele-1: All FHIR elements must have a @value or children
.... dischargeDisposition S 0..1 DP_CodeableConcept Category or kind of location after discharge
Binding: Discharge Disposition (required)
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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.classrequiredEncounterClass
http://nphies.sa/terminology/ValueSet/encounter-class
from this IG
Encounter.serviceTyperequiredServiceType (a valid code from Service Type)
http://nphies.sa/terminology/ValueSet/service-type
from this IG
Encounter.priorityrequiredV3ActPriority
http://nphies.sa/terminology/ValueSet/v3-ActPriority
from this IG
Encounter.hospitalization.admitSourcerequiredAdmitSource (a valid code from Admit Source)
http://nphies.sa/terminology/ValueSet/admit-source
from this IG
Encounter.hospitalization.reAdmissionrequiredHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dischargeDispositionrequiredDischargeDisposition (a valid code from Discharge disposition)
http://nphies.sa/terminology/ValueSet/encounter-discharge-disposition
from this IG

Constraints

IdGradePath(s)DetailsRequirements
BV-00727errorEncounterIf Encounter.class = 'Inpatient Encounter' or 'Day Case Admission' Then Encounter.hospitalization.admitSource SHALL be provided
: hospitalization.admitSource.exists()
BV-00740errorEncounterExtension CauseOfDeath is required if dischargeDisposition is 'died' or Emergency department Disposition is 'DED' or 'DOA'.
: (hospitalization.exists() implies hospitalization.dischargeDisposition.exists() implies hospitalization.dischargeDisposition.coding.first().code='died') or (extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-emergencyDepartmentDisposition').value.ofType(CodeableConcept).coding.first().code='DED') or (extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-emergencyDepartmentDisposition').value.ofType(CodeableConcept).coding.first().code='DOA') implies extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-causeOfDeath').exists()
BV-00744errorEncounterHospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class.
: hospitalization.extension('http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-intendedLengthOfStay').exists()
BV-00758errorEncounterIf any of period.end, hospitalization.dischargeDisposition, hospitalization extension dischargeSpecialty then all must be specified.
: period.end.exists() or (hospitalization.exists() implies hospitalization.dischargeDisposition.exists()) or (hospitalization.extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty').exists()) implies (period.end.exists() and hospitalization.dischargeDisposition.exists() and hospitalization.extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty').exists())
BV-00759errorEncounterHospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class.
: period.end.exists() implies hospitalization.dischargeDisposition.exists()
BV-00852errorEncounterDischarge Disposition and Encounter end Date SHALL be provided in claims with Inpatient or DayCase Admission Encounter Class when Discharge Specialty exists.
: hospitalization.extension('http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty').exists() implies (hospitalization.dischargeDisposition.exists() and period.end.exists())
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter C 0..* NphiesEncounter An interaction during which services are provided to the patient
BV-00740: Extension CauseOfDeath is required if dischargeDisposition is 'died' or Emergency department Disposition is 'DED' or 'DOA'.
BV-00758: If any of period.end, hospitalization.dischargeDisposition, hospitalization extension dischargeSpecialty then all must be specified.
BV-00727: If Encounter.class = 'Inpatient Encounter' or 'Day Case Admission' Then Encounter.hospitalization.admitSource SHALL be provided
BV-00744: Hospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class.
BV-00759: Hospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class.
BV-00852: Discharge Disposition and Encounter end Date SHALL be provided in claims with Inpatient or DayCase Admission Encounter Class when Discharge Specialty exists.
... 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 BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:causeOfDeath S 0..1 DP_CodeableConcept Cause Of Death
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-causeOfDeath
Binding: Cause of death (required)
... 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
.... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:admissionSpecialty S 1..1 DP_CodeableConcept Admission Specialty
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-admissionSpecialty
Binding: Practice Codes (required)
..... extension:dischargeSpecialty S 0..1 DP_CodeableConcept Discharge Specialty
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty
Binding: Practice Codes (required)
..... extension:intendedLengthOfStay 1..1 DP_CodeableConcept Intended Length Of Stay
URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-intendedLengthOfStay
Binding: Intended Length Of Stay (required)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin S 0..1 DP_Reference_1or2b(Nphies Location | Nphies Provider Organization) The location/organization from which the patient came before admission
.... admitSource 1..1 DP_CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: Admit Source (required)
.... reAdmission S 0..1 DP_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 (required)
.... 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 S 0..1 DP_CodeableConcept Category or kind of location after discharge
Binding: Discharge Disposition (required)
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Encounter.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Encounter.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.classrequiredEncounterClass
http://nphies.sa/terminology/ValueSet/encounter-class
from this IG
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typeexampleEncounterType
http://hl7.org/fhir/ValueSet/encounter-type
from the FHIR Standard
Encounter.serviceTyperequiredServiceType (a valid code from Service Type)
http://nphies.sa/terminology/ValueSet/service-type
from this IG
Encounter.priorityrequiredV3ActPriority
http://nphies.sa/terminology/ValueSet/v3-ActPriority
from this IG
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Encounter.diagnosis.usepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
from the FHIR Standard
Encounter.hospitalization.admitSourcerequiredAdmitSource (a valid code from Admit Source)
http://nphies.sa/terminology/ValueSet/admit-source
from this IG
Encounter.hospitalization.reAdmissionrequiredHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreferenceexampleDiet
http://hl7.org/fhir/ValueSet/encounter-diet
from the FHIR Standard
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
http://hl7.org/fhir/ValueSet/encounter-special-courtesy
from the FHIR Standard
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
http://hl7.org/fhir/ValueSet/encounter-special-arrangements
from the FHIR Standard
Encounter.hospitalization.dischargeDispositionrequiredDischargeDisposition (a valid code from Discharge disposition)
http://nphies.sa/terminology/ValueSet/encounter-discharge-disposition
from this IG
Encounter.location.statusrequiredEncounterLocationStatus
http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1
from the FHIR Standard
Encounter.location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
BV-00727errorEncounterIf Encounter.class = 'Inpatient Encounter' or 'Day Case Admission' Then Encounter.hospitalization.admitSource SHALL be provided
: hospitalization.admitSource.exists()
BV-00740errorEncounterExtension CauseOfDeath is required if dischargeDisposition is 'died' or Emergency department Disposition is 'DED' or 'DOA'.
: (hospitalization.exists() implies hospitalization.dischargeDisposition.exists() implies hospitalization.dischargeDisposition.coding.first().code='died') or (extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-emergencyDepartmentDisposition').value.ofType(CodeableConcept).coding.first().code='DED') or (extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-emergencyDepartmentDisposition').value.ofType(CodeableConcept).coding.first().code='DOA') implies extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-causeOfDeath').exists()
BV-00744errorEncounterHospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class.
: hospitalization.extension('http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-intendedLengthOfStay').exists()
BV-00758errorEncounterIf any of period.end, hospitalization.dischargeDisposition, hospitalization extension dischargeSpecialty then all must be specified.
: period.end.exists() or (hospitalization.exists() implies hospitalization.dischargeDisposition.exists()) or (hospitalization.extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty').exists()) implies (period.end.exists() and hospitalization.dischargeDisposition.exists() and hospitalization.extension.where(url = 'http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty').exists())
BV-00759errorEncounterHospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class.
: period.end.exists() implies hospitalization.dischargeDisposition.exists()
BV-00852errorEncounterDischarge Disposition and Encounter end Date SHALL be provided in claims with Inpatient or DayCase Admission Encounter Class when Discharge Specialty exists.
: hospitalization.extension('http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty').exists() implies (hospitalization.dischargeDisposition.exists() and period.end.exists())
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron