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
Official URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/encounter-claim-IMP | Version: 0.3.0 | |||
Draft as of 2025-06-23 | Computable Name: NphiesEncounter_Claim_IMP | |||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License |
Encounter In-Patient Profile for Claim
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from NphiesEncounter
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
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-00737: Encounter hospitalization admission Specialty SHALL be provided for claim with Inpatient Admission Encounter Class. 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. |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..1 | DP_CodeableConcept | Cause Of Death URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-causeOfDeath Binding: Cause of death (required) |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | DP_CodeableConcept | Admission Specialty URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-admissionSpecialty Binding: Practice Codes (required) |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | DP_CodeableConcept | Discharge Specialty URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty Binding: Practice Codes (required) |
![]() ![]() ![]() ![]() ![]() |
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) | |
![]() ![]() ![]() ![]() |
S | 0..1 | DP_Reference_1or2b(Nphies Location | Nphies Provider Organization) | The location/organization from which the patient came before admission |
![]() ![]() ![]() ![]() |
1..1 | DP_CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: Admit Source (required) | |
![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() |
S | 0..1 | DP_CodeableConcept | Category or kind of location after discharge Binding: Discharge Disposition (required) |
![]() |
Path | Conformance | ValueSet | URI |
Encounter.hospitalization.admitSource | required | AdmitSource (a valid code from Admit Source)http://nphies.sa/terminology/ValueSet/admit-source from this IG | |
Encounter.hospitalization.reAdmission | required | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | |
Encounter.hospitalization.dischargeDisposition | required | DischargeDisposition (a valid code from Discharge disposition)http://nphies.sa/terminology/ValueSet/encounter-discharge-disposition from this IG |
Id | Grade | Path(s) | Details | Requirements |
BV-00727 | error | Encounter | If Encounter.class = 'Inpatient Encounter' or 'Day Case Admission' Then Encounter.hospitalization.admitSource SHALL be provided : hospitalization.admitSource.exists() | |
BV-00737 | error | Encounter | Encounter hospitalization admission Specialty SHALL be provided for claim with Inpatient Admission Encounter Class. : hospitalization.extension('http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-admissionSpecialty').exists() | |
BV-00740 | error | Encounter | Extension 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-00744 | error | Encounter | Hospitalization 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-00758 | error | Encounter | If 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-00759 | error | Encounter | Hospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class. : period.end.exists() implies hospitalization.dischargeDisposition.exists() | |
BV-00852 | error | Encounter | Discharge 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()) |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
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-00737: Encounter hospitalization admission Specialty SHALL be provided for claim with Inpatient Admission Encounter Class. 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. |
![]() ![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact Max Length:64 |
![]() ![]() ![]() |
Σ | 1..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 1..* | DP_canonical(StructureDefinition) | Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
0..* | 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 | |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
?! | 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 |
![]() ![]() ![]() |
Σ | 1..1 | DP_Identifier_A | Identifier(s) by which this encounter is known ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() |
Σ | 1..1 | DP_Coding | Classification of patient encounter Binding: Encounter Class (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | DP_CodeableConcept | Specific type of service Binding: Service Type (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() |
1..1 | DP_Period_3 | The start and end time of the encounter ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Details about the admission to a healthcare service ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
1..1 | Reference(Nphies Provider Organization) | The organization (facility) responsible for this encounter ele-1: All FHIR elements must have a @value or children | |
![]() |
Path | Conformance | ValueSet | URI |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | |
Encounter.class | required | EncounterClasshttp://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 | V3ActPriorityhttp://nphies.sa/terminology/ValueSet/v3-ActPriority from this IG | |
Encounter.hospitalization.admitSource | required | AdmitSource (a valid code from Admit Source)http://nphies.sa/terminology/ValueSet/admit-source from this IG | |
Encounter.hospitalization.reAdmission | required | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | |
Encounter.hospitalization.dischargeDisposition | required | DischargeDisposition (a valid code from Discharge disposition)http://nphies.sa/terminology/ValueSet/encounter-discharge-disposition from this IG |
Id | Grade | Path(s) | Details | Requirements |
BV-00727 | error | Encounter | If Encounter.class = 'Inpatient Encounter' or 'Day Case Admission' Then Encounter.hospitalization.admitSource SHALL be provided : hospitalization.admitSource.exists() | |
BV-00737 | error | Encounter | Encounter hospitalization admission Specialty SHALL be provided for claim with Inpatient Admission Encounter Class. : hospitalization.extension('http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-admissionSpecialty').exists() | |
BV-00740 | error | Encounter | Extension 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-00744 | error | Encounter | Hospitalization 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-00758 | error | Encounter | If 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-00759 | error | Encounter | Hospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class. : period.end.exists() implies hospitalization.dischargeDisposition.exists() | |
BV-00852 | error | Encounter | Discharge 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-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![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
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-00737: Encounter hospitalization admission Specialty SHALL be provided for claim with Inpatient Admission Encounter Class. 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. | ||||
![]() ![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact Max Length:64 | ||||
![]() ![]() ![]() |
Σ | 1..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 1..* | DP_canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | DP_CodeableConcept | Cause Of Death URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-causeOfDeath Binding: Cause of death (required) | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..1 | DP_Identifier_A | Identifier(s) by which this encounter is known | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | DP_code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||
![]() ![]() ![]() |
0..* | BackboneElement | List of past encounter statuses | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
![]() ![]() ![]() ![]() |
1..1 | Period | The time that the episode was in the specified status | |||||
![]() ![]() ![]() |
Σ | 1..1 | DP_Coding | Classification of patient encounter Binding: Encounter Class (required) | ||||
![]() ![]() ![]() |
0..* | BackboneElement | List of past encounter classes | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
![]() ![]() ![]() ![]() |
1..1 | Period | The time that the episode was in the specified class | |||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | DP_CodeableConcept | Specific type of service Binding: Service Type (required) | ||||
![]() ![]() ![]() |
S | 0..1 | DP_CodeableConcept | Indicates the urgency of the encounter Binding: V3 ActPriority (required) | ||||
![]() ![]() ![]() |
Σ | 1..1 | DP_Reference_1(Nphies Patient) | The patient or group present at the encounter | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
![]() ![]() ![]() |
0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
![]() ![]() ![]() ![]() |
0..1 | Period | Period of time during the encounter that the participant participated | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
![]() ![]() ![]() |
1..1 | DP_Period_3 | The start and end time of the encounter | |||||
![]() ![]() ![]() |
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | ||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
![]() ![]() ![]() |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Details about the admission to a healthcare service | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | DP_CodeableConcept | Admission Specialty URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-admissionSpecialty Binding: Practice Codes (required) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | DP_CodeableConcept | Discharge Specialty URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty Binding: Practice Codes (required) | ||||
![]() ![]() ![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | Identifier | Pre-admission identifier | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | DP_Reference_1or2b(Nphies Location | Nphies Provider Organization) | The location/organization from which the patient came before admission | ||||
![]() ![]() ![]() ![]() |
1..1 | DP_CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: Admit Source (required) | |||||
![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | DP_CodeableConcept | Category or kind of location after discharge Binding: Discharge Disposition (required) | ||||
![]() ![]() ![]() |
0..* | BackboneElement | List of locations where the patient has been | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Location) | Location the encounter takes place | |||||
![]() ![]() ![]() ![]() |
0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period during which the patient was present at the location | |||||
![]() ![]() ![]() |
1..1 | Reference(Nphies Provider Organization) | The organization (facility) responsible for this encounter | |||||
![]() ![]() ![]() |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
Encounter.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Encounter.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Encounter.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.class | required | EncounterClasshttp://nphies.sa/terminology/ValueSet/encounter-class from this IG | ||||
Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.type | example | EncounterTypehttp://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 | V3ActPriorityhttp://nphies.sa/terminology/ValueSet/v3-ActPriority from this IG | ||||
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | ||||
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard | ||||
Encounter.hospitalization.admitSource | required | AdmitSource (a valid code from Admit Source)http://nphies.sa/terminology/ValueSet/admit-source from this IG | ||||
Encounter.hospitalization.reAdmission | required | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | ||||
Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard | ||||
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard | ||||
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard | ||||
Encounter.hospitalization.dischargeDisposition | required | DischargeDisposition (a valid code from Discharge disposition)http://nphies.sa/terminology/ValueSet/encounter-discharge-disposition from this IG | ||||
Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard | ||||
Encounter.location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
BV-00727 | error | Encounter | If Encounter.class = 'Inpatient Encounter' or 'Day Case Admission' Then Encounter.hospitalization.admitSource SHALL be provided : hospitalization.admitSource.exists() | |
BV-00737 | error | Encounter | Encounter hospitalization admission Specialty SHALL be provided for claim with Inpatient Admission Encounter Class. : hospitalization.extension('http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-admissionSpecialty').exists() | |
BV-00740 | error | Encounter | Extension 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-00744 | error | Encounter | Hospitalization 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-00758 | error | Encounter | If 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-00759 | error | Encounter | Hospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class. : period.end.exists() implies hospitalization.dischargeDisposition.exists() | |
BV-00852 | error | Encounter | Discharge 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-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 NphiesEncounter
Summary
Mandatory: 0 element(3 nested mandatory elements)
Must-Support: 6 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from NphiesEncounter
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
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-00737: Encounter hospitalization admission Specialty SHALL be provided for claim with Inpatient Admission Encounter Class. 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. |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..1 | DP_CodeableConcept | Cause Of Death URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-causeOfDeath Binding: Cause of death (required) |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | DP_CodeableConcept | Admission Specialty URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-admissionSpecialty Binding: Practice Codes (required) |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | DP_CodeableConcept | Discharge Specialty URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty Binding: Practice Codes (required) |
![]() ![]() ![]() ![]() ![]() |
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) | |
![]() ![]() ![]() ![]() |
S | 0..1 | DP_Reference_1or2b(Nphies Location | Nphies Provider Organization) | The location/organization from which the patient came before admission |
![]() ![]() ![]() ![]() |
1..1 | DP_CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: Admit Source (required) | |
![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() |
S | 0..1 | DP_CodeableConcept | Category or kind of location after discharge Binding: Discharge Disposition (required) |
![]() |
Path | Conformance | ValueSet | URI |
Encounter.hospitalization.admitSource | required | AdmitSource (a valid code from Admit Source)http://nphies.sa/terminology/ValueSet/admit-source from this IG | |
Encounter.hospitalization.reAdmission | required | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | |
Encounter.hospitalization.dischargeDisposition | required | DischargeDisposition (a valid code from Discharge disposition)http://nphies.sa/terminology/ValueSet/encounter-discharge-disposition from this IG |
Id | Grade | Path(s) | Details | Requirements |
BV-00727 | error | Encounter | If Encounter.class = 'Inpatient Encounter' or 'Day Case Admission' Then Encounter.hospitalization.admitSource SHALL be provided : hospitalization.admitSource.exists() | |
BV-00737 | error | Encounter | Encounter hospitalization admission Specialty SHALL be provided for claim with Inpatient Admission Encounter Class. : hospitalization.extension('http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-admissionSpecialty').exists() | |
BV-00740 | error | Encounter | Extension 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-00744 | error | Encounter | Hospitalization 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-00758 | error | Encounter | If 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-00759 | error | Encounter | Hospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class. : period.end.exists() implies hospitalization.dischargeDisposition.exists() | |
BV-00852 | error | Encounter | Discharge 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
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
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-00737: Encounter hospitalization admission Specialty SHALL be provided for claim with Inpatient Admission Encounter Class. 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. |
![]() ![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact Max Length:64 |
![]() ![]() ![]() |
Σ | 1..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 1..* | DP_canonical(StructureDefinition) | Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
0..* | 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 | |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
?! | 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 |
![]() ![]() ![]() |
Σ | 1..1 | DP_Identifier_A | Identifier(s) by which this encounter is known ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() |
Σ | 1..1 | DP_Coding | Classification of patient encounter Binding: Encounter Class (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | DP_CodeableConcept | Specific type of service Binding: Service Type (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() |
1..1 | DP_Period_3 | The start and end time of the encounter ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Details about the admission to a healthcare service ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
1..1 | Reference(Nphies Provider Organization) | The organization (facility) responsible for this encounter ele-1: All FHIR elements must have a @value or children | |
![]() |
Path | Conformance | ValueSet | URI |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | |
Encounter.class | required | EncounterClasshttp://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 | V3ActPriorityhttp://nphies.sa/terminology/ValueSet/v3-ActPriority from this IG | |
Encounter.hospitalization.admitSource | required | AdmitSource (a valid code from Admit Source)http://nphies.sa/terminology/ValueSet/admit-source from this IG | |
Encounter.hospitalization.reAdmission | required | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | |
Encounter.hospitalization.dischargeDisposition | required | DischargeDisposition (a valid code from Discharge disposition)http://nphies.sa/terminology/ValueSet/encounter-discharge-disposition from this IG |
Id | Grade | Path(s) | Details | Requirements |
BV-00727 | error | Encounter | If Encounter.class = 'Inpatient Encounter' or 'Day Case Admission' Then Encounter.hospitalization.admitSource SHALL be provided : hospitalization.admitSource.exists() | |
BV-00737 | error | Encounter | Encounter hospitalization admission Specialty SHALL be provided for claim with Inpatient Admission Encounter Class. : hospitalization.extension('http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-admissionSpecialty').exists() | |
BV-00740 | error | Encounter | Extension 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-00744 | error | Encounter | Hospitalization 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-00758 | error | Encounter | If 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-00759 | error | Encounter | Hospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class. : period.end.exists() implies hospitalization.dischargeDisposition.exists() | |
BV-00852 | error | Encounter | Discharge 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-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![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
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-00737: Encounter hospitalization admission Specialty SHALL be provided for claim with Inpatient Admission Encounter Class. 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. | ||||
![]() ![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact Max Length:64 | ||||
![]() ![]() ![]() |
Σ | 1..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 1..* | DP_canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | DP_CodeableConcept | Cause Of Death URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-causeOfDeath Binding: Cause of death (required) | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..1 | DP_Identifier_A | Identifier(s) by which this encounter is known | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | DP_code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||
![]() ![]() ![]() |
0..* | BackboneElement | List of past encounter statuses | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
![]() ![]() ![]() ![]() |
1..1 | Period | The time that the episode was in the specified status | |||||
![]() ![]() ![]() |
Σ | 1..1 | DP_Coding | Classification of patient encounter Binding: Encounter Class (required) | ||||
![]() ![]() ![]() |
0..* | BackboneElement | List of past encounter classes | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
![]() ![]() ![]() ![]() |
1..1 | Period | The time that the episode was in the specified class | |||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | DP_CodeableConcept | Specific type of service Binding: Service Type (required) | ||||
![]() ![]() ![]() |
S | 0..1 | DP_CodeableConcept | Indicates the urgency of the encounter Binding: V3 ActPriority (required) | ||||
![]() ![]() ![]() |
Σ | 1..1 | DP_Reference_1(Nphies Patient) | The patient or group present at the encounter | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
![]() ![]() ![]() |
0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
![]() ![]() ![]() ![]() |
0..1 | Period | Period of time during the encounter that the participant participated | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
![]() ![]() ![]() |
1..1 | DP_Period_3 | The start and end time of the encounter | |||||
![]() ![]() ![]() |
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | ||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
![]() ![]() ![]() |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Details about the admission to a healthcare service | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | DP_CodeableConcept | Admission Specialty URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-admissionSpecialty Binding: Practice Codes (required) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | DP_CodeableConcept | Discharge Specialty URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-dischargeSpecialty Binding: Practice Codes (required) | ||||
![]() ![]() ![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | Identifier | Pre-admission identifier | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | DP_Reference_1or2b(Nphies Location | Nphies Provider Organization) | The location/organization from which the patient came before admission | ||||
![]() ![]() ![]() ![]() |
1..1 | DP_CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: Admit Source (required) | |||||
![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | DP_CodeableConcept | Category or kind of location after discharge Binding: Discharge Disposition (required) | ||||
![]() ![]() ![]() |
0..* | BackboneElement | List of locations where the patient has been | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Location) | Location the encounter takes place | |||||
![]() ![]() ![]() ![]() |
0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period during which the patient was present at the location | |||||
![]() ![]() ![]() |
1..1 | Reference(Nphies Provider Organization) | The organization (facility) responsible for this encounter | |||||
![]() ![]() ![]() |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
Encounter.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Encounter.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Encounter.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.class | required | EncounterClasshttp://nphies.sa/terminology/ValueSet/encounter-class from this IG | ||||
Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.type | example | EncounterTypehttp://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 | V3ActPriorityhttp://nphies.sa/terminology/ValueSet/v3-ActPriority from this IG | ||||
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | ||||
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard | ||||
Encounter.hospitalization.admitSource | required | AdmitSource (a valid code from Admit Source)http://nphies.sa/terminology/ValueSet/admit-source from this IG | ||||
Encounter.hospitalization.reAdmission | required | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | ||||
Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard | ||||
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard | ||||
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard | ||||
Encounter.hospitalization.dischargeDisposition | required | DischargeDisposition (a valid code from Discharge disposition)http://nphies.sa/terminology/ValueSet/encounter-discharge-disposition from this IG | ||||
Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard | ||||
Encounter.location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
BV-00727 | error | Encounter | If Encounter.class = 'Inpatient Encounter' or 'Day Case Admission' Then Encounter.hospitalization.admitSource SHALL be provided : hospitalization.admitSource.exists() | |
BV-00737 | error | Encounter | Encounter hospitalization admission Specialty SHALL be provided for claim with Inpatient Admission Encounter Class. : hospitalization.extension('http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/extension-admissionSpecialty').exists() | |
BV-00740 | error | Encounter | Extension 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-00744 | error | Encounter | Hospitalization 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-00758 | error | Encounter | If 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-00759 | error | Encounter | Hospitalization Intended Length Of Stay SHALL be provided for claim with Inpatient Admission or DayCase Encounter Class. : period.end.exists() implies hospitalization.dischargeDisposition.exists() | |
BV-00852 | error | Encounter | Discharge 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-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 NphiesEncounter
Summary
Mandatory: 0 element(3 nested mandatory elements)
Must-Support: 6 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron