BioMaxis Implementation Guide
0.0.0-semantic-release - ci-build

BioMaxis Implementation Guide - Local Development build (v0.0.0-semantic-release) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: BioMaxis Encounter

Official URL: http://biomaxis.com/fhir/StructureDefinition/biomaxis-encounter Version: 0.0.0-semantic-release
Active as of 2026-02-04 Computable Name: BioMaxisEncounter

A profile for the Encounter resource used in BioMaxis HIS.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:encounter-actor-healthcareService 0..* Reference(HealthcareService) Encounter Actor HealthcareService
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-actorHealthcareService
.... extension:visitType 0..1 Coding New visit or follow-up visit
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-visit-type
Binding: HMIS Visit Type (required)
.... extension:costExemption 0..1 Coding Cost exemption category
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-cost-exemption
Binding: Free Service Eligibility Categories (required)
.... extension:policeCase 0..1 boolean Police case flag
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-police-case
.... extension:nextVisitDate 0..1 date Scheduled return date
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-next-visit-date
.... extension:genderBasedViolence 0..1 boolean GBV/OCMC case flag
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-gender-based-violence
.... extension:referringInstitution 0..1 string, Reference(Organization) Referring health facility
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-referring-institution
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... class Σ 1..1 Coding Encounter class (OPD, Emergency, IPD, Outreach Clinic)
Binding: HMIS Encounter Class (extensible)
... participant Σ 0..* BackboneElement Practitioners involved in the encounter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... individual Σ 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson) Reference to Practitioner or PractitionerRole
... period 0..1 Period Encounter period (admission to discharge)
.... start ΣC 0..1 dateTime Admission/Registration date and time
.... end ΣC 0..1 dateTime Discharge date and time
... reasonCode Σ 0..* CodeableConcept Main complaint/symptoms at admission
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
... diagnosis Σ 0..* BackboneElement Encounter diagnoses
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition Σ 1..1 Reference(Condition | Procedure) Reference to the diagnosis Condition
.... use 0..1 CodeableConcept Role of diagnosis (provisional, final)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
... hospitalization 0..1 BackboneElement Hospitalization details for inpatient encounters
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... admitSource 0..1 CodeableConcept Source of admission (self-referred, emergency-to-ipd, referred, opd-to-ipd)
Binding: HMIS Admission Source Value Set (extensible)
.... dischargeDisposition 0..1 CodeableConcept Discharge outcome (recovered, stable, referred-out, LAMA, DOPR, absconded, death)
Binding: HMIS Discharge Disposition Value Set (extensible)
... location 0..* BackboneElement Location(s) during the encounter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location 1..1 Reference(Location) Ward or bed location
.... period 0..1 Period Time period at this location

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base extensible HMIS Encounter Class 📦0.0.0-semantic-release This IG
Encounter.reasonCode Base preferred Encounter Reason Codes 📍4.0.1 FHIR Std.
Encounter.diagnosis.​use Base preferred DiagnosisRole 📍4.0.1 FHIR Std.
Encounter.hospitalization.​admitSource Base extensible HMIS Admission Source Value Set 📦0.0.0-semantic-release This IG
Encounter.hospitalization.​dischargeDisposition Base extensible HMIS Discharge Disposition Value Set 📦0.0.0-semantic-release This IG

Constraints

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

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:encounter-actor-healthcareService 0..* Reference(HealthcareService) Encounter Actor HealthcareService
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-actorHealthcareService
.... extension:visitType 0..1 Coding New visit or follow-up visit
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-visit-type
Binding: HMIS Visit Type (required)
.... extension:costExemption 0..1 Coding Cost exemption category
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-cost-exemption
Binding: Free Service Eligibility Categories (required)
.... extension:policeCase 0..1 boolean Police case flag
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-police-case
.... extension:nextVisitDate 0..1 date Scheduled return date
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-next-visit-date
.... extension:genderBasedViolence 0..1 boolean GBV/OCMC case flag
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-gender-based-violence
.... extension:referringInstitution 0..1 string, Reference(Organization) Referring health facility
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-referring-institution
... class 1..1 Coding Encounter class (OPD, Emergency, IPD, Outreach Clinic)
Binding: HMIS Encounter Class (extensible)
... participant 0..* BackboneElement Practitioners involved in the encounter
.... individual 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson) Reference to Practitioner or PractitionerRole
.... start 0..1 dateTime Admission/Registration date and time
.... end 0..1 dateTime Discharge date and time
... reasonCode 0..* CodeableConcept Main complaint/symptoms at admission
... diagnosis 0..* BackboneElement Encounter diagnoses
.... condition 1..1 Reference(Condition | Procedure) Reference to the diagnosis Condition
.... use 0..1 CodeableConcept Role of diagnosis (provisional, final)
... hospitalization 0..1 BackboneElement Hospitalization details for inpatient encounters
.... admitSource 0..1 CodeableConcept Source of admission (self-referred, emergency-to-ipd, referred, opd-to-ipd)
Binding: HMIS Admission Source Value Set (extensible)
.... dischargeDisposition 0..1 CodeableConcept Discharge outcome (recovered, stable, referred-out, LAMA, DOPR, absconded, death)
Binding: HMIS Discharge Disposition Value Set (extensible)
... location 0..* BackboneElement Location(s) during the encounter
.... location 1..1 Reference(Location) Ward or bed location
.... period 0..1 Period Time period at this location

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Encounter.class Base extensible HMIS Encounter Class 📦0.0.0-semantic-release This IG
Encounter.hospitalization.​admitSource Base extensible HMIS Admission Source Value Set 📦0.0.0-semantic-release This IG
Encounter.hospitalization.​dischargeDisposition Base extensible HMIS Discharge Disposition Value Set 📦0.0.0-semantic-release This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:encounter-actor-healthcareService 0..* Reference(HealthcareService) Encounter Actor HealthcareService
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-actorHealthcareService
.... extension:visitType 0..1 Coding New visit or follow-up visit
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-visit-type
Binding: HMIS Visit Type (required)
.... extension:costExemption 0..1 Coding Cost exemption category
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-cost-exemption
Binding: Free Service Eligibility Categories (required)
.... extension:policeCase 0..1 boolean Police case flag
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-police-case
.... extension:nextVisitDate 0..1 date Scheduled return date
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-next-visit-date
.... extension:genderBasedViolence 0..1 boolean GBV/OCMC case flag
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-gender-based-violence
.... extension:referringInstitution 0..1 string, Reference(Organization) Referring health facility
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-referring-institution
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Identifier(s) by which this encounter is known
... status ?!Σ 1..1 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 Coding Encounter class (OPD, Emergency, IPD, Outreach Clinic)
Binding: HMIS Encounter Class (extensible)
... 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 Σ 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.
... subject Σ 0..1 Reference(Patient | Group) 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 Practitioners 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) Reference to Practitioner or PractitionerRole
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
... period 0..1 Period Encounter period (admission to discharge)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣC 0..1 dateTime Admission/Registration date and time
.... end ΣC 0..1 dateTime Discharge date and time
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... reasonCode Σ 0..* CodeableConcept Main complaint/symptoms at admission
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 Encounter diagnoses
.... 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) Reference to the diagnosis Condition
.... use 0..1 CodeableConcept Role of diagnosis (provisional, final)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
.... rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
... account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
... hospitalization 0..1 BackboneElement Hospitalization details for inpatient encounters
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
.... admitSource 0..1 CodeableConcept Source of admission (self-referred, emergency-to-ipd, referred, opd-to-ipd)
Binding: HMIS Admission Source Value Set (extensible)
.... reAdmission 0..1 CodeableConcept The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
.... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
.... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
.... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.
.... destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
.... dischargeDisposition 0..1 CodeableConcept Discharge outcome (recovered, stable, referred-out, LAMA, DOPR, absconded, death)
Binding: HMIS Discharge Disposition Value Set (extensible)
... location 0..* BackboneElement Location(s) during 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
.... location 1..1 Reference(Location) Ward or bed location
.... 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 at this location
... serviceProvider 0..1 Reference(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

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

Constraints

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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:encounter-actor-healthcareService 0..* Reference(HealthcareService) Encounter Actor HealthcareService
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-actorHealthcareService
.... extension:visitType 0..1 Coding New visit or follow-up visit
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-visit-type
Binding: HMIS Visit Type (required)
.... extension:costExemption 0..1 Coding Cost exemption category
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-cost-exemption
Binding: Free Service Eligibility Categories (required)
.... extension:policeCase 0..1 boolean Police case flag
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-police-case
.... extension:nextVisitDate 0..1 date Scheduled return date
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-next-visit-date
.... extension:genderBasedViolence 0..1 boolean GBV/OCMC case flag
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-gender-based-violence
.... extension:referringInstitution 0..1 string, Reference(Organization) Referring health facility
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-referring-institution
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... class Σ 1..1 Coding Encounter class (OPD, Emergency, IPD, Outreach Clinic)
Binding: HMIS Encounter Class (extensible)
... participant Σ 0..* BackboneElement Practitioners involved in the encounter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... individual Σ 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson) Reference to Practitioner or PractitionerRole
... period 0..1 Period Encounter period (admission to discharge)
.... start ΣC 0..1 dateTime Admission/Registration date and time
.... end ΣC 0..1 dateTime Discharge date and time
... reasonCode Σ 0..* CodeableConcept Main complaint/symptoms at admission
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
... diagnosis Σ 0..* BackboneElement Encounter diagnoses
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition Σ 1..1 Reference(Condition | Procedure) Reference to the diagnosis Condition
.... use 0..1 CodeableConcept Role of diagnosis (provisional, final)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
... hospitalization 0..1 BackboneElement Hospitalization details for inpatient encounters
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... admitSource 0..1 CodeableConcept Source of admission (self-referred, emergency-to-ipd, referred, opd-to-ipd)
Binding: HMIS Admission Source Value Set (extensible)
.... dischargeDisposition 0..1 CodeableConcept Discharge outcome (recovered, stable, referred-out, LAMA, DOPR, absconded, death)
Binding: HMIS Discharge Disposition Value Set (extensible)
... location 0..* BackboneElement Location(s) during the encounter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location 1..1 Reference(Location) Ward or bed location
.... period 0..1 Period Time period at this location

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base extensible HMIS Encounter Class 📦0.0.0-semantic-release This IG
Encounter.reasonCode Base preferred Encounter Reason Codes 📍4.0.1 FHIR Std.
Encounter.diagnosis.​use Base preferred DiagnosisRole 📍4.0.1 FHIR Std.
Encounter.hospitalization.​admitSource Base extensible HMIS Admission Source Value Set 📦0.0.0-semantic-release This IG
Encounter.hospitalization.​dischargeDisposition Base extensible HMIS Discharge Disposition Value Set 📦0.0.0-semantic-release This IG

Constraints

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

Differential View

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:encounter-actor-healthcareService 0..* Reference(HealthcareService) Encounter Actor HealthcareService
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-actorHealthcareService
.... extension:visitType 0..1 Coding New visit or follow-up visit
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-visit-type
Binding: HMIS Visit Type (required)
.... extension:costExemption 0..1 Coding Cost exemption category
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-cost-exemption
Binding: Free Service Eligibility Categories (required)
.... extension:policeCase 0..1 boolean Police case flag
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-police-case
.... extension:nextVisitDate 0..1 date Scheduled return date
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-next-visit-date
.... extension:genderBasedViolence 0..1 boolean GBV/OCMC case flag
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-gender-based-violence
.... extension:referringInstitution 0..1 string, Reference(Organization) Referring health facility
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-referring-institution
... class 1..1 Coding Encounter class (OPD, Emergency, IPD, Outreach Clinic)
Binding: HMIS Encounter Class (extensible)
... participant 0..* BackboneElement Practitioners involved in the encounter
.... individual 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson) Reference to Practitioner or PractitionerRole
.... start 0..1 dateTime Admission/Registration date and time
.... end 0..1 dateTime Discharge date and time
... reasonCode 0..* CodeableConcept Main complaint/symptoms at admission
... diagnosis 0..* BackboneElement Encounter diagnoses
.... condition 1..1 Reference(Condition | Procedure) Reference to the diagnosis Condition
.... use 0..1 CodeableConcept Role of diagnosis (provisional, final)
... hospitalization 0..1 BackboneElement Hospitalization details for inpatient encounters
.... admitSource 0..1 CodeableConcept Source of admission (self-referred, emergency-to-ipd, referred, opd-to-ipd)
Binding: HMIS Admission Source Value Set (extensible)
.... dischargeDisposition 0..1 CodeableConcept Discharge outcome (recovered, stable, referred-out, LAMA, DOPR, absconded, death)
Binding: HMIS Discharge Disposition Value Set (extensible)
... location 0..* BackboneElement Location(s) during the encounter
.... location 1..1 Reference(Location) Ward or bed location
.... period 0..1 Period Time period at this location

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Encounter.class Base extensible HMIS Encounter Class 📦0.0.0-semantic-release This IG
Encounter.hospitalization.​admitSource Base extensible HMIS Admission Source Value Set 📦0.0.0-semantic-release This IG
Encounter.hospitalization.​dischargeDisposition Base extensible HMIS Discharge Disposition Value Set 📦0.0.0-semantic-release This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:encounter-actor-healthcareService 0..* Reference(HealthcareService) Encounter Actor HealthcareService
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-actorHealthcareService
.... extension:visitType 0..1 Coding New visit or follow-up visit
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-visit-type
Binding: HMIS Visit Type (required)
.... extension:costExemption 0..1 Coding Cost exemption category
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-cost-exemption
Binding: Free Service Eligibility Categories (required)
.... extension:policeCase 0..1 boolean Police case flag
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-police-case
.... extension:nextVisitDate 0..1 date Scheduled return date
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-next-visit-date
.... extension:genderBasedViolence 0..1 boolean GBV/OCMC case flag
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-gender-based-violence
.... extension:referringInstitution 0..1 string, Reference(Organization) Referring health facility
URL: http://biomaxis.com/fhir/StructureDefinition/encounter-referring-institution
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Identifier(s) by which this encounter is known
... status ?!Σ 1..1 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 Coding Encounter class (OPD, Emergency, IPD, Outreach Clinic)
Binding: HMIS Encounter Class (extensible)
... 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 Σ 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.
... subject Σ 0..1 Reference(Patient | Group) 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 Practitioners 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) Reference to Practitioner or PractitionerRole
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
... period 0..1 Period Encounter period (admission to discharge)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣC 0..1 dateTime Admission/Registration date and time
.... end ΣC 0..1 dateTime Discharge date and time
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... reasonCode Σ 0..* CodeableConcept Main complaint/symptoms at admission
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 Encounter diagnoses
.... 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) Reference to the diagnosis Condition
.... use 0..1 CodeableConcept Role of diagnosis (provisional, final)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
.... rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
... account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
... hospitalization 0..1 BackboneElement Hospitalization details for inpatient encounters
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
.... admitSource 0..1 CodeableConcept Source of admission (self-referred, emergency-to-ipd, referred, opd-to-ipd)
Binding: HMIS Admission Source Value Set (extensible)
.... reAdmission 0..1 CodeableConcept The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
.... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
.... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
.... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.
.... destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
.... dischargeDisposition 0..1 CodeableConcept Discharge outcome (recovered, stable, referred-out, LAMA, DOPR, absconded, death)
Binding: HMIS Discharge Disposition Value Set (extensible)
... location 0..* BackboneElement Location(s) during 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
.... location 1..1 Reference(Location) Ward or bed location
.... 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 at this location
... serviceProvider 0..1 Reference(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

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

Constraints

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

 

Other representations of profile: CSV, Excel, Schematron