SGHI FHIR Profile Implementation Guide
0.1.0 - ci-build

SGHI FHIR Profile Implementation Guide, published by Kathurima Kimathi. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/savannahghi/sil_fhir_profile_ig/ and changes regularly. See the Directory of published versions

Resource Profile: SGHI Encounter

Official URL: https://fhir.slade360.co.ke/fhir/StructureDefinition/sghi-encounter Version: 0.1.0
Draft as of 2025-09-17 Computable Name: SGHIEncounter

An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. Encounter is primarily used to record information about the actual activities that occurred, where Appointment is used to record planned activities.

Usages:

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
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 SGHICodeableConcept Description of identifier
Binding: SGHI Standard Identifier Types (required)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 1..1 string The value that is unique
Example General: 123456
.... assigner Σ 1..1 SGHIReference(SGHI Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
Binding: EncounterStatus (required): Current state of the encounter.
... class Σ 1..1 SGHICodeableConcept Classification of patient encounter context - e.g. Inpatient, outpatient
Binding: Encounter class (preferred): Classification of the encounter.
... priority 0..1 SGHICodeableConcept Indicates the urgency of the encounter
Binding: SGHI Encounter Priority (required)
... type Σ 0..* SGHICodeableConcept Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...)
Binding: EncounterType (example): A specific code indicating type of service provided
... subject Σ 1..1 SGHIReference(SGHI Patient) The patient or group related to this encounter
... subjectStatus 0..1 SGHICodeableConcept The current status of the subject in relation to the Encounter
Binding: EncounterSubjectStatus (example): Current status of the subject within the encounter.
... episodeOfCare Σ 1..* SGHIReference(SGHI EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
... basedOn 0..* SGHIReference(SGHI MedicationRequest | SGHI ServiceRequest) The request that initiated this encounter
... partOf 0..1 SGHIReference(SGHI Encounter) Another Encounter this encounter is part of
... serviceProvider 1..1 SGHIReference(SGHI Organization) The organization (facility) responsible for this encounter
... participant ΣC 1..* BackboneElement List of participants involved in the encounter
Constraints: enc-1, enc-2
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type ΣC 0..* SGHICodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
.... actor ΣC 1..1 SGHIReference(SGHI Patient) The individual, device, or service participating in the encounter
... appointment Σ 0..* SGHIReference(SGHI Appointment Profile) The appointment that scheduled this encounter

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
From the FHIR Standard
Encounter.identifier.typerequiredSGHIIdentifierTypes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types
From this IG
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|5.0.0
From the FHIR Standard
Encounter.classpreferredEncounterClass
http://terminology.hl7.org/ValueSet/encounter-class
Encounter.priorityrequiredSGHIActPriority
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-encounter-act-priority
From this IG
Encounter.typeexampleEncounterType
http://hl7.org/fhir/ValueSet/encounter-type|5.0.0
From the FHIR Standard
Encounter.subjectStatusexampleEncounterSubjectStatus
http://hl7.org/fhir/ValueSet/encounter-subject-status|5.0.0
From the FHIR Standard
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorEncounterIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
enc-1errorEncounter.participantA type must be provided when no explicit actor is specified
: actor.exists() or type.exists()
enc-2errorEncounter.participantA type cannot be provided for a patient or group participant
: actor.exists(resolve() is Patient or resolve() is Group) implies type.exists().not()
ext-1error**ALL** extensionsMust 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
... text
.... status 1..1 code generated | extensions | additional | empty
Fixed Value: generated
.... div 1..1 xhtml Limited xhtml content
... identifier 1..* Identifier Identifier(s) by which this encounter is known
.... use 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type 0..1 SGHICodeableConcept Description of identifier
Binding: SGHI Standard Identifier Types (required)
.... system 1..1 uri The namespace for the identifier value
.... value 1..1 string The value that is unique
.... assigner 1..1 SGHIReference(SGHI Organization) Organization that issued id (may be just text)
... class 1..1 SGHICodeableConcept Classification of patient encounter context - e.g. Inpatient, outpatient
... type 0..* SGHICodeableConcept Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...)
... subject 1..1 SGHIReference(SGHI Patient) The patient or group related to this encounter
... subjectStatus 0..1 SGHICodeableConcept The current status of the subject in relation to the Encounter
... episodeOfCare 1..* SGHIReference(SGHI EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
... basedOn 0..* SGHIReference(SGHI MedicationRequest | SGHI ServiceRequest) The request that initiated this encounter
... partOf 0..1 SGHIReference(SGHI Encounter) Another Encounter this encounter is part of
... serviceProvider 1..1 SGHIReference(SGHI Organization) The organization (facility) responsible for this encounter
... participant 1..* BackboneElement List of participants involved in the encounter
.... type 0..* SGHICodeableConcept Role of participant in encounter
.... actor 1..1 SGHIReference(SGHI Patient) The individual, device, or service participating in the encounter
... appointment 0..* SGHIReference(SGHI Appointment Profile) The appointment that scheduled this encounter
... reason
.... value 0..* SGHICodeableReference(SGHI Condition | SGHI Observation | SGHI DiagnosticReport) Reason the encounter takes place (core or reference)
... diagnosis
.... condition 1..* SGHICodeableReference(SGHI Condition) The diagnosis relevant to the encounter
Binding: All ICD-11 codes (required)
... admission
.... origin 0..1 SGHIReference(SGHI Location | SGHI Organization) The location/organization from which the patient came before admission
.... destination 0..1 SGHIReference(SGHI Location | SGHI Organization) Location/organization to which the patient is discharged
... location
.... location 1..1 SGHIReference(SGHI Location) Location the encounter takes place

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Encounter.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
From the FHIR Standard
Encounter.identifier.typerequiredSGHIIdentifierTypes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types
From this IG
Encounter.priorityrequiredSGHIActPriority
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-encounter-act-priority
From this IG
Encounter.diagnosis.conditionrequiredICD11Codes
https://fhir.slade360.co.ke/fhir/ValueSet/ICD11Codes
From 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: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... 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
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
Fixed Value: generated
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier Identifier(s) by which this encounter is known
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 SGHICodeableConcept Description of identifier
Binding: SGHI Standard Identifier Types (required)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 1..1 SGHIReference(SGHI Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
Binding: EncounterStatus (required): Current state of the encounter.
... class Σ 1..1 SGHICodeableConcept Classification of patient encounter context - e.g. Inpatient, outpatient
Binding: Encounter class (preferred): Classification of the encounter.
... priority 0..1 SGHICodeableConcept Indicates the urgency of the encounter
Binding: SGHI Encounter Priority (required)
... type Σ 0..* SGHICodeableConcept Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...)
Binding: EncounterType (example): A specific code indicating type of service provided
... serviceType Σ 0..* CodeableReference(HealthcareService) Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
... subject Σ 1..1 SGHIReference(SGHI Patient) The patient or group related to this encounter
... subjectStatus 0..1 SGHICodeableConcept The current status of the subject in relation to the Encounter
Binding: EncounterSubjectStatus (example): Current status of the subject within the encounter.
... episodeOfCare Σ 1..* SGHIReference(SGHI EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
... basedOn 0..* SGHIReference(SGHI MedicationRequest | SGHI ServiceRequest) The request that initiated this encounter
... careTeam 0..* Reference(CareTeam) The group(s) that are allocated to participate in this encounter
... partOf 0..1 SGHIReference(SGHI Encounter) Another Encounter this encounter is part of
... serviceProvider 1..1 SGHIReference(SGHI Organization) The organization (facility) responsible for this encounter
... participant ΣC 1..* BackboneElement List of participants involved in the encounter
Constraints: enc-1, enc-2
.... 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 ΣC 0..* SGHICodeableConcept 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
.... actor ΣC 1..1 SGHIReference(SGHI Patient) The individual, device, or service participating in the encounter
... appointment Σ 0..* SGHIReference(SGHI Appointment Profile) The appointment that scheduled this encounter
... virtualService 0..* VirtualServiceDetail Connection details of a virtual service (e.g. conference call)
... actualPeriod 0..1 Period The actual start and end time of the encounter
... plannedStartDate 0..1 dateTime The planned start date/time (or admission date) of the encounter
... plannedEndDate 0..1 dateTime The planned end date/time (or discharge date) of the encounter
... length 0..1 Duration Actual quantity of time the encounter lasted (less time absent)
... reason Σ 0..* BackboneElement The list of medical reasons that are expected to be addressed during the episode of care
.... 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
.... use Σ 0..* CodeableConcept What the reason value should be used for/as
Binding: EncounterReasonUse (example)
.... value Σ 0..* SGHICodeableReference(SGHI Condition | SGHI Observation | SGHI DiagnosticReport) Reason the encounter takes place (core or reference)
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition Σ 1..* SGHICodeableReference(SGHI Condition) The diagnosis relevant to the encounter
Binding: All ICD-11 codes (required)
.... use 0..* CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: EncounterDiagnosisUse (preferred): The type of diagnosis this condition represents.
... account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: EncounterDiet (example): Medical, cultural or ethical food preferences to help with catering requirements.
... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc
Binding: SpecialArrangements (preferred): Special arrangements.
... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
... admission 0..1 BackboneElement Details about the admission to a healthcare service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin 0..1 SGHIReference(SGHI Location | SGHI Organization) The location/organization from which the patient came before admission
.... admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.
.... reAdmission 0..1 CodeableConcept Indicates that the patient is being re-admitted
Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this admission encounter.
.... destination 0..1 SGHIReference(SGHI Location | SGHI Organization) Location/organization to which the patient is discharged
.... dischargeDisposition 0..1 CodeableConcept Category or kind of location after discharge
Binding: DischargeDisposition (example): Discharge Disposition.
... location 0..* BackboneElement List of locations where the patient has been
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location 1..1 SGHIReference(SGHI Location) Location the encounter takes place
.... status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
.... form 0..1 CodeableConcept The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.)
Binding: LocationForm (example): Physical form of the location.
.... period 0..1 Period Time period during which the patient was present at the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
Encounter.text.statusrequiredFixed Value: generated
http://hl7.org/fhir/ValueSet/narrative-status|5.0.0
From the FHIR Standard
Encounter.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
From the FHIR Standard
Encounter.identifier.typerequiredSGHIIdentifierTypes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types
From this IG
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|5.0.0
From the FHIR Standard
Encounter.classpreferredEncounterClass
http://terminology.hl7.org/ValueSet/encounter-class
Encounter.priorityrequiredSGHIActPriority
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-encounter-act-priority
From this IG
Encounter.typeexampleEncounterType
http://hl7.org/fhir/ValueSet/encounter-type|5.0.0
From the FHIR Standard
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type|5.0.0
From the FHIR Standard
Encounter.subjectStatusexampleEncounterSubjectStatus
http://hl7.org/fhir/ValueSet/encounter-subject-status|5.0.0
From the FHIR Standard
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0
From the FHIR Standard
Encounter.reason.useexampleEncounterReasonUse
http://hl7.org/fhir/ValueSet/encounter-reason-use|5.0.0
From the FHIR Standard
Encounter.reason.valuepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason|5.0.0
From the FHIR Standard
Encounter.diagnosis.conditionrequiredICD11Codes
https://fhir.slade360.co.ke/fhir/ValueSet/ICD11Codes
From this IG
Encounter.diagnosis.usepreferredEncounterDiagnosisUse
http://hl7.org/fhir/ValueSet/encounter-diagnosis-use|5.0.0
From the FHIR Standard
Encounter.dietPreferenceexampleEncounterDiet
http://hl7.org/fhir/ValueSet/encounter-diet|5.0.0
From the FHIR Standard
Encounter.specialArrangementpreferredSpecialArrangements
http://hl7.org/fhir/ValueSet/encounter-special-arrangements|5.0.0
From the FHIR Standard
Encounter.specialCourtesypreferredSpecialCourtesy
http://hl7.org/fhir/ValueSet/encounter-special-courtesy|5.0.0
From the FHIR Standard
Encounter.admission.admitSourcepreferredAdmitSource
http://hl7.org/fhir/ValueSet/encounter-admit-source|5.0.0
From the FHIR Standard
Encounter.admission.reAdmissionexampleHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
Encounter.admission.dischargeDispositionexampleDischargeDisposition
http://hl7.org/fhir/ValueSet/encounter-discharge-disposition|5.0.0
From the FHIR Standard
Encounter.location.statusrequiredEncounterLocationStatus
http://hl7.org/fhir/ValueSet/encounter-location-status|5.0.0
From the FHIR Standard
Encounter.location.formexampleLocationForm
http://hl7.org/fhir/ValueSet/location-form|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorEncounterIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
enc-1errorEncounter.participantA type must be provided when no explicit actor is specified
: actor.exists() or type.exists()
enc-2errorEncounter.participantA type cannot be provided for a patient or group participant
: actor.exists(resolve() is Patient or resolve() is Group) implies type.exists().not()
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
txt-1errorEncounter.text.divThe narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
: htmlChecks()
txt-2errorEncounter.text.divThe narrative SHALL have some non-whitespace content
: htmlChecks()

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
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 SGHICodeableConcept Description of identifier
Binding: SGHI Standard Identifier Types (required)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 1..1 string The value that is unique
Example General: 123456
.... assigner Σ 1..1 SGHIReference(SGHI Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
Binding: EncounterStatus (required): Current state of the encounter.
... class Σ 1..1 SGHICodeableConcept Classification of patient encounter context - e.g. Inpatient, outpatient
Binding: Encounter class (preferred): Classification of the encounter.
... priority 0..1 SGHICodeableConcept Indicates the urgency of the encounter
Binding: SGHI Encounter Priority (required)
... type Σ 0..* SGHICodeableConcept Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...)
Binding: EncounterType (example): A specific code indicating type of service provided
... subject Σ 1..1 SGHIReference(SGHI Patient) The patient or group related to this encounter
... subjectStatus 0..1 SGHICodeableConcept The current status of the subject in relation to the Encounter
Binding: EncounterSubjectStatus (example): Current status of the subject within the encounter.
... episodeOfCare Σ 1..* SGHIReference(SGHI EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
... basedOn 0..* SGHIReference(SGHI MedicationRequest | SGHI ServiceRequest) The request that initiated this encounter
... partOf 0..1 SGHIReference(SGHI Encounter) Another Encounter this encounter is part of
... serviceProvider 1..1 SGHIReference(SGHI Organization) The organization (facility) responsible for this encounter
... participant ΣC 1..* BackboneElement List of participants involved in the encounter
Constraints: enc-1, enc-2
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type ΣC 0..* SGHICodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
.... actor ΣC 1..1 SGHIReference(SGHI Patient) The individual, device, or service participating in the encounter
... appointment Σ 0..* SGHIReference(SGHI Appointment Profile) The appointment that scheduled this encounter

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
From the FHIR Standard
Encounter.identifier.typerequiredSGHIIdentifierTypes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types
From this IG
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|5.0.0
From the FHIR Standard
Encounter.classpreferredEncounterClass
http://terminology.hl7.org/ValueSet/encounter-class
Encounter.priorityrequiredSGHIActPriority
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-encounter-act-priority
From this IG
Encounter.typeexampleEncounterType
http://hl7.org/fhir/ValueSet/encounter-type|5.0.0
From the FHIR Standard
Encounter.subjectStatusexampleEncounterSubjectStatus
http://hl7.org/fhir/ValueSet/encounter-subject-status|5.0.0
From the FHIR Standard
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorEncounterIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
enc-1errorEncounter.participantA type must be provided when no explicit actor is specified
: actor.exists() or type.exists()
enc-2errorEncounter.participantA type cannot be provided for a patient or group participant
: actor.exists(resolve() is Patient or resolve() is Group) implies type.exists().not()
ext-1error**ALL** extensionsMust 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
... text
.... status 1..1 code generated | extensions | additional | empty
Fixed Value: generated
.... div 1..1 xhtml Limited xhtml content
... identifier 1..* Identifier Identifier(s) by which this encounter is known
.... use 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type 0..1 SGHICodeableConcept Description of identifier
Binding: SGHI Standard Identifier Types (required)
.... system 1..1 uri The namespace for the identifier value
.... value 1..1 string The value that is unique
.... assigner 1..1 SGHIReference(SGHI Organization) Organization that issued id (may be just text)
... class 1..1 SGHICodeableConcept Classification of patient encounter context - e.g. Inpatient, outpatient
... type 0..* SGHICodeableConcept Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...)
... subject 1..1 SGHIReference(SGHI Patient) The patient or group related to this encounter
... subjectStatus 0..1 SGHICodeableConcept The current status of the subject in relation to the Encounter
... episodeOfCare 1..* SGHIReference(SGHI EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
... basedOn 0..* SGHIReference(SGHI MedicationRequest | SGHI ServiceRequest) The request that initiated this encounter
... partOf 0..1 SGHIReference(SGHI Encounter) Another Encounter this encounter is part of
... serviceProvider 1..1 SGHIReference(SGHI Organization) The organization (facility) responsible for this encounter
... participant 1..* BackboneElement List of participants involved in the encounter
.... type 0..* SGHICodeableConcept Role of participant in encounter
.... actor 1..1 SGHIReference(SGHI Patient) The individual, device, or service participating in the encounter
... appointment 0..* SGHIReference(SGHI Appointment Profile) The appointment that scheduled this encounter
... reason
.... value 0..* SGHICodeableReference(SGHI Condition | SGHI Observation | SGHI DiagnosticReport) Reason the encounter takes place (core or reference)
... diagnosis
.... condition 1..* SGHICodeableReference(SGHI Condition) The diagnosis relevant to the encounter
Binding: All ICD-11 codes (required)
... admission
.... origin 0..1 SGHIReference(SGHI Location | SGHI Organization) The location/organization from which the patient came before admission
.... destination 0..1 SGHIReference(SGHI Location | SGHI Organization) Location/organization to which the patient is discharged
... location
.... location 1..1 SGHIReference(SGHI Location) Location the encounter takes place

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Encounter.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
From the FHIR Standard
Encounter.identifier.typerequiredSGHIIdentifierTypes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types
From this IG
Encounter.priorityrequiredSGHIActPriority
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-encounter-act-priority
From this IG
Encounter.diagnosis.conditionrequiredICD11Codes
https://fhir.slade360.co.ke/fhir/ValueSet/ICD11Codes
From 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: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... 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
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
Fixed Value: generated
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier Identifier(s) by which this encounter is known
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 SGHICodeableConcept Description of identifier
Binding: SGHI Standard Identifier Types (required)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 1..1 SGHIReference(SGHI Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
Binding: EncounterStatus (required): Current state of the encounter.
... class Σ 1..1 SGHICodeableConcept Classification of patient encounter context - e.g. Inpatient, outpatient
Binding: Encounter class (preferred): Classification of the encounter.
... priority 0..1 SGHICodeableConcept Indicates the urgency of the encounter
Binding: SGHI Encounter Priority (required)
... type Σ 0..* SGHICodeableConcept Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...)
Binding: EncounterType (example): A specific code indicating type of service provided
... serviceType Σ 0..* CodeableReference(HealthcareService) Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
... subject Σ 1..1 SGHIReference(SGHI Patient) The patient or group related to this encounter
... subjectStatus 0..1 SGHICodeableConcept The current status of the subject in relation to the Encounter
Binding: EncounterSubjectStatus (example): Current status of the subject within the encounter.
... episodeOfCare Σ 1..* SGHIReference(SGHI EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
... basedOn 0..* SGHIReference(SGHI MedicationRequest | SGHI ServiceRequest) The request that initiated this encounter
... careTeam 0..* Reference(CareTeam) The group(s) that are allocated to participate in this encounter
... partOf 0..1 SGHIReference(SGHI Encounter) Another Encounter this encounter is part of
... serviceProvider 1..1 SGHIReference(SGHI Organization) The organization (facility) responsible for this encounter
... participant ΣC 1..* BackboneElement List of participants involved in the encounter
Constraints: enc-1, enc-2
.... 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 ΣC 0..* SGHICodeableConcept 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
.... actor ΣC 1..1 SGHIReference(SGHI Patient) The individual, device, or service participating in the encounter
... appointment Σ 0..* SGHIReference(SGHI Appointment Profile) The appointment that scheduled this encounter
... virtualService 0..* VirtualServiceDetail Connection details of a virtual service (e.g. conference call)
... actualPeriod 0..1 Period The actual start and end time of the encounter
... plannedStartDate 0..1 dateTime The planned start date/time (or admission date) of the encounter
... plannedEndDate 0..1 dateTime The planned end date/time (or discharge date) of the encounter
... length 0..1 Duration Actual quantity of time the encounter lasted (less time absent)
... reason Σ 0..* BackboneElement The list of medical reasons that are expected to be addressed during the episode of care
.... 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
.... use Σ 0..* CodeableConcept What the reason value should be used for/as
Binding: EncounterReasonUse (example)
.... value Σ 0..* SGHICodeableReference(SGHI Condition | SGHI Observation | SGHI DiagnosticReport) Reason the encounter takes place (core or reference)
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition Σ 1..* SGHICodeableReference(SGHI Condition) The diagnosis relevant to the encounter
Binding: All ICD-11 codes (required)
.... use 0..* CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: EncounterDiagnosisUse (preferred): The type of diagnosis this condition represents.
... account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: EncounterDiet (example): Medical, cultural or ethical food preferences to help with catering requirements.
... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc
Binding: SpecialArrangements (preferred): Special arrangements.
... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
... admission 0..1 BackboneElement Details about the admission to a healthcare service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin 0..1 SGHIReference(SGHI Location | SGHI Organization) The location/organization from which the patient came before admission
.... admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.
.... reAdmission 0..1 CodeableConcept Indicates that the patient is being re-admitted
Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this admission encounter.
.... destination 0..1 SGHIReference(SGHI Location | SGHI Organization) Location/organization to which the patient is discharged
.... dischargeDisposition 0..1 CodeableConcept Category or kind of location after discharge
Binding: DischargeDisposition (example): Discharge Disposition.
... location 0..* BackboneElement List of locations where the patient has been
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location 1..1 SGHIReference(SGHI Location) Location the encounter takes place
.... status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
.... form 0..1 CodeableConcept The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.)
Binding: LocationForm (example): Physical form of the location.
.... period 0..1 Period Time period during which the patient was present at the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
Encounter.text.statusrequiredFixed Value: generated
http://hl7.org/fhir/ValueSet/narrative-status|5.0.0
From the FHIR Standard
Encounter.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
From the FHIR Standard
Encounter.identifier.typerequiredSGHIIdentifierTypes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types
From this IG
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|5.0.0
From the FHIR Standard
Encounter.classpreferredEncounterClass
http://terminology.hl7.org/ValueSet/encounter-class
Encounter.priorityrequiredSGHIActPriority
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-encounter-act-priority
From this IG
Encounter.typeexampleEncounterType
http://hl7.org/fhir/ValueSet/encounter-type|5.0.0
From the FHIR Standard
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type|5.0.0
From the FHIR Standard
Encounter.subjectStatusexampleEncounterSubjectStatus
http://hl7.org/fhir/ValueSet/encounter-subject-status|5.0.0
From the FHIR Standard
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0
From the FHIR Standard
Encounter.reason.useexampleEncounterReasonUse
http://hl7.org/fhir/ValueSet/encounter-reason-use|5.0.0
From the FHIR Standard
Encounter.reason.valuepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason|5.0.0
From the FHIR Standard
Encounter.diagnosis.conditionrequiredICD11Codes
https://fhir.slade360.co.ke/fhir/ValueSet/ICD11Codes
From this IG
Encounter.diagnosis.usepreferredEncounterDiagnosisUse
http://hl7.org/fhir/ValueSet/encounter-diagnosis-use|5.0.0
From the FHIR Standard
Encounter.dietPreferenceexampleEncounterDiet
http://hl7.org/fhir/ValueSet/encounter-diet|5.0.0
From the FHIR Standard
Encounter.specialArrangementpreferredSpecialArrangements
http://hl7.org/fhir/ValueSet/encounter-special-arrangements|5.0.0
From the FHIR Standard
Encounter.specialCourtesypreferredSpecialCourtesy
http://hl7.org/fhir/ValueSet/encounter-special-courtesy|5.0.0
From the FHIR Standard
Encounter.admission.admitSourcepreferredAdmitSource
http://hl7.org/fhir/ValueSet/encounter-admit-source|5.0.0
From the FHIR Standard
Encounter.admission.reAdmissionexampleHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
Encounter.admission.dischargeDispositionexampleDischargeDisposition
http://hl7.org/fhir/ValueSet/encounter-discharge-disposition|5.0.0
From the FHIR Standard
Encounter.location.statusrequiredEncounterLocationStatus
http://hl7.org/fhir/ValueSet/encounter-location-status|5.0.0
From the FHIR Standard
Encounter.location.formexampleLocationForm
http://hl7.org/fhir/ValueSet/location-form|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorEncounterIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
enc-1errorEncounter.participantA type must be provided when no explicit actor is specified
: actor.exists() or type.exists()
enc-2errorEncounter.participantA type cannot be provided for a patient or group participant
: actor.exists(resolve() is Patient or resolve() is Group) implies type.exists().not()
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
txt-1errorEncounter.text.divThe narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
: htmlChecks()
txt-2errorEncounter.text.divThe narrative SHALL have some non-whitespace content
: htmlChecks()

 

Other representations of profile: CSV, Excel, Schematron