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
Official URL: https://fhir.slade360.co.ke/fhir/StructureDefinition/sghi-encounter | Version: 0.1.0 | |||
Draft as of 2025-09-04 | 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
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Encounter | An interaction during which services are provided to the patient | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 1..* | Identifier | Identifier(s) by which this encounter is known |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() ![]() |
Σ | 0..1 | SGHICodeableConcept | Description of identifier Binding: SGHI Standard Identifier Types (required) |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
ΣC | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() |
Σ | 1..1 | SGHIReference(SGHI Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
?!Σ | 1..1 | code | planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter. |
![]() ![]() ![]() |
Σ | 1..1 | SGHICodeableConcept | Classification of patient encounter context - e.g. Inpatient, outpatient Binding: Encounter class (preferred): Classification of the encounter. |
![]() ![]() ![]() |
0..1 | SGHICodeableConcept | Indicates the urgency of the encounter Binding: SGHI Encounter Priority (required) | |
![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() |
Σ | 1..1 | SGHIReference(SGHI Patient) | The patient or group related to this encounter |
![]() ![]() ![]() |
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. | |
![]() ![]() ![]() |
Σ | 1..* | SGHIReference(SGHI EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against |
![]() ![]() ![]() |
0..* | SGHIReference(SGHI MedicationRequest | SGHI ServiceRequest) | The request that initiated this encounter | |
![]() ![]() ![]() |
0..1 | SGHIReference(SGHI Encounter) | Another Encounter this encounter is part of | |
![]() ![]() ![]() |
1..1 | SGHIReference(SGHI Organization) | The organization (facility) responsible for this encounter | |
![]() ![]() ![]() |
ΣC | 1..* | BackboneElement | List of participants involved in the encounter Constraints: enc-1, enc-2 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
ΣC | 0..* | SGHICodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. |
![]() ![]() ![]() ![]() |
ΣC | 1..1 | SGHIReference(SGHI Patient) | The individual, device, or service participating in the encounter |
![]() ![]() ![]() |
Σ | 0..* | SGHIReference(SGHI Appointment Profile) | The appointment that scheduled this encounter |
![]() |
Path | Conformance | ValueSet | URI |
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use From the FHIR Standard | |
Encounter.identifier.type | required | SGHIIdentifierTypeshttps://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types From this IG | |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|5.0.0 From the FHIR Standard | |
Encounter.class | preferred | EncounterClasshttp://terminology.hl7.org/ValueSet/encounter-class | |
Encounter.priority | required | SGHIActPriorityhttps://fhir.slade360.co.ke/fhir/ValueSet/sghi-encounter-act-priority From this IG | |
Encounter.type | example | EncounterTypehttp://hl7.org/fhir/ValueSet/encounter-type From the FHIR Standard | |
Encounter.subjectStatus | example | EncounterSubjectStatushttp://hl7.org/fhir/ValueSet/encounter-subject-status From the FHIR Standard | |
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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-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()) | |
enc-1 | error | Encounter.participant | A type must be provided when no explicit actor is specified : actor.exists() or type.exists() | |
enc-2 | error | Encounter.participant | A type cannot be provided for a patient or group participant : actor.exists(resolve() is Patient or resolve() is Group) implies type.exists().not() | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Encounter
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Encounter | An interaction during which services are provided to the patient | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | code | generated | extensions | additional | empty Fixed Value: generated | |
![]() ![]() ![]() ![]() |
1..1 | xhtml | Limited xhtml content | |
![]() ![]() ![]() |
1..* | Identifier | Identifier(s) by which this encounter is known | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
![]() ![]() ![]() ![]() |
0..1 | SGHICodeableConcept | Description of identifier Binding: SGHI Standard Identifier Types (required) | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() |
1..1 | SGHIReference(SGHI Organization) | Organization that issued id (may be just text) | |
![]() ![]() ![]() |
1..1 | SGHICodeableConcept | Classification of patient encounter context - e.g. Inpatient, outpatient | |
![]() ![]() ![]() |
0..1 | SGHICodeableConcept | Indicates the urgency of the encounter Binding: SGHI Encounter Priority (required) | |
![]() ![]() ![]() |
0..* | SGHICodeableConcept | Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...) | |
![]() ![]() ![]() |
1..1 | SGHIReference(SGHI Patient) | The patient or group related to this encounter | |
![]() ![]() ![]() |
0..1 | SGHICodeableConcept | The current status of the subject in relation to the Encounter | |
![]() ![]() ![]() |
1..* | SGHIReference(SGHI EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | |
![]() ![]() ![]() |
0..* | SGHIReference(SGHI MedicationRequest | SGHI ServiceRequest) | The request that initiated this encounter | |
![]() ![]() ![]() |
0..1 | SGHIReference(SGHI Encounter) | Another Encounter this encounter is part of | |
![]() ![]() ![]() |
1..1 | SGHIReference(SGHI Organization) | The organization (facility) responsible for this encounter | |
![]() ![]() ![]() |
1..* | BackboneElement | List of participants involved in the encounter | |
![]() ![]() ![]() ![]() |
0..* | SGHICodeableConcept | Role of participant in encounter | |
![]() ![]() ![]() ![]() |
1..1 | SGHIReference(SGHI Patient) | The individual, device, or service participating in the encounter | |
![]() ![]() ![]() |
0..* | SGHIReference(SGHI Appointment Profile) | The appointment that scheduled this encounter | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..* | SGHICodeableReference(SGHI Condition | SGHI Observation | SGHI DiagnosticReport) | Reason the encounter takes place (core or reference) | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..* | SGHICodeableReference(SGHI Condition) | The diagnosis relevant to the encounter Binding: All ICD-11 codes (required) | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | SGHIReference(SGHI Location | SGHI Organization) | The location/organization from which the patient came before admission | |
![]() ![]() ![]() ![]() |
0..1 | SGHIReference(SGHI Location | SGHI Organization) | Location/organization to which the patient is discharged | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | SGHIReference(SGHI Location) | Location the encounter takes place | |
![]() |
Path | Conformance | ValueSet | URI |
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use From the FHIR Standard | |
Encounter.identifier.type | required | SGHIIdentifierTypeshttps://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types From this IG | |
Encounter.priority | required | SGHIActPriorityhttps://fhir.slade360.co.ke/fhir/ValueSet/sghi-encounter-act-priority From this IG | |
Encounter.diagnosis.condition | required | ICD11Codeshttps://fhir.slade360.co.ke/fhir/ValueSet/ICD11Codes From this IG |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Encounter | An interaction during which services are provided to the patient | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. Fixed Value: generated | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..* | Identifier | Identifier(s) by which this encounter is known | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | SGHICodeableConcept | Description of identifier Binding: SGHI Standard Identifier Types (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | SGHIReference(SGHI Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter. | ||||
![]() ![]() ![]() |
Σ | 1..1 | SGHICodeableConcept | Classification of patient encounter context - e.g. Inpatient, outpatient Binding: Encounter class (preferred): Classification of the encounter. | ||||
![]() ![]() ![]() |
0..1 | SGHICodeableConcept | Indicates the urgency of the encounter Binding: SGHI Encounter Priority (required) | |||||
![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableReference(HealthcareService) | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
![]() ![]() ![]() |
Σ | 1..1 | SGHIReference(SGHI Patient) | The patient or group related to this encounter | ||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
Σ | 1..* | SGHIReference(SGHI EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
![]() ![]() ![]() |
0..* | SGHIReference(SGHI MedicationRequest | SGHI ServiceRequest) | The request that initiated this encounter | |||||
![]() ![]() ![]() |
0..* | Reference(CareTeam) | The group(s) that are allocated to participate in this encounter | |||||
![]() ![]() ![]() |
0..1 | SGHIReference(SGHI Encounter) | Another Encounter this encounter is part of | |||||
![]() ![]() ![]() |
1..1 | SGHIReference(SGHI Organization) | The organization (facility) responsible for this encounter | |||||
![]() ![]() ![]() |
ΣC | 1..* | BackboneElement | List of participants involved in the encounter Constraints: enc-1, enc-2 | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | SGHICodeableConcept | 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 | |||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | SGHIReference(SGHI Patient) | The individual, device, or service participating in the encounter | ||||
![]() ![]() ![]() |
Σ | 0..* | SGHIReference(SGHI Appointment Profile) | The appointment that scheduled this encounter | ||||
![]() ![]() ![]() |
0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | |||||
![]() ![]() ![]() |
0..1 | Period | The actual start and end time of the encounter | |||||
![]() ![]() ![]() |
0..1 | dateTime | The planned start date/time (or admission date) of the encounter | |||||
![]() ![]() ![]() |
0..1 | dateTime | The planned end date/time (or discharge date) of the encounter | |||||
![]() ![]() ![]() |
0..1 | Duration | Actual quantity of time the encounter lasted (less time absent) | |||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | The list of medical reasons that are expected to be addressed during the episode of care | ||||
![]() ![]() ![]() ![]() |
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 | What the reason value should be used for/as Binding: EncounterReasonUse (example) | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
Σ | 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..* | SGHICodeableReference(SGHI Condition) | The diagnosis relevant to the encounter Binding: All ICD-11 codes (required) | ||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Diet preferences reported by the patient Binding: EncounterDiet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Wheelchair, translator, stretcher, etc Binding: SpecialArrangements (preferred): Special arrangements. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
![]() ![]() ![]() |
0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
![]() ![]() ![]() ![]() |
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..1 | Identifier | Pre-admission identifier | |||||
![]() ![]() ![]() ![]() |
0..1 | SGHIReference(SGHI Location | SGHI Organization) | The location/organization from which the patient came before admission | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
0..1 | SGHIReference(SGHI Location | SGHI Organization) | Location/organization to which the patient is discharged | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | |||||
![]() ![]() ![]() |
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 | SGHIReference(SGHI 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 hierarchy - bed, room, ward, virtual etc.) Binding: LocationForm (example): Physical form of the location. | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period during which the patient was present at the location | |||||
![]() |
Path | Conformance | ValueSet / Code | URI |
Encounter.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard | |
Encounter.text.status | required | Fixed Value: generatedhttp://hl7.org/fhir/ValueSet/narrative-status|5.0.0 From the FHIR Standard | |
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use From the FHIR Standard | |
Encounter.identifier.type | required | SGHIIdentifierTypeshttps://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types From this IG | |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|5.0.0 From the FHIR Standard | |
Encounter.class | preferred | EncounterClasshttp://terminology.hl7.org/ValueSet/encounter-class | |
Encounter.priority | required | SGHIActPriorityhttps://fhir.slade360.co.ke/fhir/ValueSet/sghi-encounter-act-priority From this IG | |
Encounter.type | example | EncounterTypehttp://hl7.org/fhir/ValueSet/encounter-type From the FHIR Standard | |
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type From the FHIR Standard | |
Encounter.subjectStatus | example | EncounterSubjectStatushttp://hl7.org/fhir/ValueSet/encounter-subject-status From the FHIR Standard | |
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard | |
Encounter.reason.use | example | EncounterReasonUsehttp://hl7.org/fhir/ValueSet/encounter-reason-use From the FHIR Standard | |
Encounter.reason.value | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason From the FHIR Standard | |
Encounter.diagnosis.condition | required | ICD11Codeshttps://fhir.slade360.co.ke/fhir/ValueSet/ICD11Codes From this IG | |
Encounter.diagnosis.use | preferred | EncounterDiagnosisUsehttp://hl7.org/fhir/ValueSet/encounter-diagnosis-use From the FHIR Standard | |
Encounter.dietPreference | example | EncounterDiethttp://hl7.org/fhir/ValueSet/encounter-diet From the FHIR Standard | |
Encounter.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements From the FHIR Standard | |
Encounter.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy From the FHIR Standard | |
Encounter.admission.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-source From the FHIR Standard | |
Encounter.admission.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | |
Encounter.admission.dischargeDisposition | example | DischargeDispositionhttp://hl7.org/fhir/ValueSet/encounter-discharge-disposition From the FHIR Standard | |
Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|5.0.0 From the FHIR Standard | |
Encounter.location.form | example | LocationFormhttp://hl7.org/fhir/ValueSet/location-form From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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-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()) | |
enc-1 | error | Encounter.participant | A type must be provided when no explicit actor is specified : actor.exists() or type.exists() | |
enc-2 | error | Encounter.participant | A type cannot be provided for a patient or group participant : actor.exists(resolve() is Patient or resolve() is Group) implies type.exists().not() | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
txt-1 | error | Encounter.text.div | The 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-2 | error | Encounter.text.div | The narrative SHALL have some non-whitespace content : htmlChecks() |
This structure is derived from Encounter
Summary
Mandatory: 10 elements(1 nested mandatory element)
Fixed: 1 element
Structures
This structure refers to these other structures:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Encounter | An interaction during which services are provided to the patient | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 1..* | Identifier | Identifier(s) by which this encounter is known |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() ![]() |
Σ | 0..1 | SGHICodeableConcept | Description of identifier Binding: SGHI Standard Identifier Types (required) |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
ΣC | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() |
Σ | 1..1 | SGHIReference(SGHI Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
?!Σ | 1..1 | code | planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter. |
![]() ![]() ![]() |
Σ | 1..1 | SGHICodeableConcept | Classification of patient encounter context - e.g. Inpatient, outpatient Binding: Encounter class (preferred): Classification of the encounter. |
![]() ![]() ![]() |
0..1 | SGHICodeableConcept | Indicates the urgency of the encounter Binding: SGHI Encounter Priority (required) | |
![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() |
Σ | 1..1 | SGHIReference(SGHI Patient) | The patient or group related to this encounter |
![]() ![]() ![]() |
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. | |
![]() ![]() ![]() |
Σ | 1..* | SGHIReference(SGHI EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against |
![]() ![]() ![]() |
0..* | SGHIReference(SGHI MedicationRequest | SGHI ServiceRequest) | The request that initiated this encounter | |
![]() ![]() ![]() |
0..1 | SGHIReference(SGHI Encounter) | Another Encounter this encounter is part of | |
![]() ![]() ![]() |
1..1 | SGHIReference(SGHI Organization) | The organization (facility) responsible for this encounter | |
![]() ![]() ![]() |
ΣC | 1..* | BackboneElement | List of participants involved in the encounter Constraints: enc-1, enc-2 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
ΣC | 0..* | SGHICodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. |
![]() ![]() ![]() ![]() |
ΣC | 1..1 | SGHIReference(SGHI Patient) | The individual, device, or service participating in the encounter |
![]() ![]() ![]() |
Σ | 0..* | SGHIReference(SGHI Appointment Profile) | The appointment that scheduled this encounter |
![]() |
Path | Conformance | ValueSet | URI |
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use From the FHIR Standard | |
Encounter.identifier.type | required | SGHIIdentifierTypeshttps://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types From this IG | |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|5.0.0 From the FHIR Standard | |
Encounter.class | preferred | EncounterClasshttp://terminology.hl7.org/ValueSet/encounter-class | |
Encounter.priority | required | SGHIActPriorityhttps://fhir.slade360.co.ke/fhir/ValueSet/sghi-encounter-act-priority From this IG | |
Encounter.type | example | EncounterTypehttp://hl7.org/fhir/ValueSet/encounter-type From the FHIR Standard | |
Encounter.subjectStatus | example | EncounterSubjectStatushttp://hl7.org/fhir/ValueSet/encounter-subject-status From the FHIR Standard | |
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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-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()) | |
enc-1 | error | Encounter.participant | A type must be provided when no explicit actor is specified : actor.exists() or type.exists() | |
enc-2 | error | Encounter.participant | A type cannot be provided for a patient or group participant : actor.exists(resolve() is Patient or resolve() is Group) implies type.exists().not() | |
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
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Encounter | An interaction during which services are provided to the patient | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | code | generated | extensions | additional | empty Fixed Value: generated | |
![]() ![]() ![]() ![]() |
1..1 | xhtml | Limited xhtml content | |
![]() ![]() ![]() |
1..* | Identifier | Identifier(s) by which this encounter is known | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
![]() ![]() ![]() ![]() |
0..1 | SGHICodeableConcept | Description of identifier Binding: SGHI Standard Identifier Types (required) | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() |
1..1 | SGHIReference(SGHI Organization) | Organization that issued id (may be just text) | |
![]() ![]() ![]() |
1..1 | SGHICodeableConcept | Classification of patient encounter context - e.g. Inpatient, outpatient | |
![]() ![]() ![]() |
0..1 | SGHICodeableConcept | Indicates the urgency of the encounter Binding: SGHI Encounter Priority (required) | |
![]() ![]() ![]() |
0..* | SGHICodeableConcept | Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...) | |
![]() ![]() ![]() |
1..1 | SGHIReference(SGHI Patient) | The patient or group related to this encounter | |
![]() ![]() ![]() |
0..1 | SGHICodeableConcept | The current status of the subject in relation to the Encounter | |
![]() ![]() ![]() |
1..* | SGHIReference(SGHI EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | |
![]() ![]() ![]() |
0..* | SGHIReference(SGHI MedicationRequest | SGHI ServiceRequest) | The request that initiated this encounter | |
![]() ![]() ![]() |
0..1 | SGHIReference(SGHI Encounter) | Another Encounter this encounter is part of | |
![]() ![]() ![]() |
1..1 | SGHIReference(SGHI Organization) | The organization (facility) responsible for this encounter | |
![]() ![]() ![]() |
1..* | BackboneElement | List of participants involved in the encounter | |
![]() ![]() ![]() ![]() |
0..* | SGHICodeableConcept | Role of participant in encounter | |
![]() ![]() ![]() ![]() |
1..1 | SGHIReference(SGHI Patient) | The individual, device, or service participating in the encounter | |
![]() ![]() ![]() |
0..* | SGHIReference(SGHI Appointment Profile) | The appointment that scheduled this encounter | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..* | SGHICodeableReference(SGHI Condition | SGHI Observation | SGHI DiagnosticReport) | Reason the encounter takes place (core or reference) | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..* | SGHICodeableReference(SGHI Condition) | The diagnosis relevant to the encounter Binding: All ICD-11 codes (required) | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | SGHIReference(SGHI Location | SGHI Organization) | The location/organization from which the patient came before admission | |
![]() ![]() ![]() ![]() |
0..1 | SGHIReference(SGHI Location | SGHI Organization) | Location/organization to which the patient is discharged | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | SGHIReference(SGHI Location) | Location the encounter takes place | |
![]() |
Path | Conformance | ValueSet | URI |
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use From the FHIR Standard | |
Encounter.identifier.type | required | SGHIIdentifierTypeshttps://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types From this IG | |
Encounter.priority | required | SGHIActPriorityhttps://fhir.slade360.co.ke/fhir/ValueSet/sghi-encounter-act-priority From this IG | |
Encounter.diagnosis.condition | required | ICD11Codeshttps://fhir.slade360.co.ke/fhir/ValueSet/ICD11Codes From this IG |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Encounter | An interaction during which services are provided to the patient | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. Fixed Value: generated | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..* | Identifier | Identifier(s) by which this encounter is known | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | SGHICodeableConcept | Description of identifier Binding: SGHI Standard Identifier Types (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | SGHIReference(SGHI Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter. | ||||
![]() ![]() ![]() |
Σ | 1..1 | SGHICodeableConcept | Classification of patient encounter context - e.g. Inpatient, outpatient Binding: Encounter class (preferred): Classification of the encounter. | ||||
![]() ![]() ![]() |
0..1 | SGHICodeableConcept | Indicates the urgency of the encounter Binding: SGHI Encounter Priority (required) | |||||
![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableReference(HealthcareService) | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
![]() ![]() ![]() |
Σ | 1..1 | SGHIReference(SGHI Patient) | The patient or group related to this encounter | ||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
Σ | 1..* | SGHIReference(SGHI EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
![]() ![]() ![]() |
0..* | SGHIReference(SGHI MedicationRequest | SGHI ServiceRequest) | The request that initiated this encounter | |||||
![]() ![]() ![]() |
0..* | Reference(CareTeam) | The group(s) that are allocated to participate in this encounter | |||||
![]() ![]() ![]() |
0..1 | SGHIReference(SGHI Encounter) | Another Encounter this encounter is part of | |||||
![]() ![]() ![]() |
1..1 | SGHIReference(SGHI Organization) | The organization (facility) responsible for this encounter | |||||
![]() ![]() ![]() |
ΣC | 1..* | BackboneElement | List of participants involved in the encounter Constraints: enc-1, enc-2 | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | SGHICodeableConcept | 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 | |||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | SGHIReference(SGHI Patient) | The individual, device, or service participating in the encounter | ||||
![]() ![]() ![]() |
Σ | 0..* | SGHIReference(SGHI Appointment Profile) | The appointment that scheduled this encounter | ||||
![]() ![]() ![]() |
0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | |||||
![]() ![]() ![]() |
0..1 | Period | The actual start and end time of the encounter | |||||
![]() ![]() ![]() |
0..1 | dateTime | The planned start date/time (or admission date) of the encounter | |||||
![]() ![]() ![]() |
0..1 | dateTime | The planned end date/time (or discharge date) of the encounter | |||||
![]() ![]() ![]() |
0..1 | Duration | Actual quantity of time the encounter lasted (less time absent) | |||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | The list of medical reasons that are expected to be addressed during the episode of care | ||||
![]() ![]() ![]() ![]() |
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 | What the reason value should be used for/as Binding: EncounterReasonUse (example) | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
Σ | 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..* | SGHICodeableReference(SGHI Condition) | The diagnosis relevant to the encounter Binding: All ICD-11 codes (required) | ||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Diet preferences reported by the patient Binding: EncounterDiet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Wheelchair, translator, stretcher, etc Binding: SpecialArrangements (preferred): Special arrangements. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
![]() ![]() ![]() |
0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
![]() ![]() ![]() ![]() |
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..1 | Identifier | Pre-admission identifier | |||||
![]() ![]() ![]() ![]() |
0..1 | SGHIReference(SGHI Location | SGHI Organization) | The location/organization from which the patient came before admission | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
0..1 | SGHIReference(SGHI Location | SGHI Organization) | Location/organization to which the patient is discharged | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | |||||
![]() ![]() ![]() |
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 | SGHIReference(SGHI 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 hierarchy - bed, room, ward, virtual etc.) Binding: LocationForm (example): Physical form of the location. | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period during which the patient was present at the location | |||||
![]() |
Path | Conformance | ValueSet / Code | URI |
Encounter.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard | |
Encounter.text.status | required | Fixed Value: generatedhttp://hl7.org/fhir/ValueSet/narrative-status|5.0.0 From the FHIR Standard | |
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use From the FHIR Standard | |
Encounter.identifier.type | required | SGHIIdentifierTypeshttps://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types From this IG | |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|5.0.0 From the FHIR Standard | |
Encounter.class | preferred | EncounterClasshttp://terminology.hl7.org/ValueSet/encounter-class | |
Encounter.priority | required | SGHIActPriorityhttps://fhir.slade360.co.ke/fhir/ValueSet/sghi-encounter-act-priority From this IG | |
Encounter.type | example | EncounterTypehttp://hl7.org/fhir/ValueSet/encounter-type From the FHIR Standard | |
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type From the FHIR Standard | |
Encounter.subjectStatus | example | EncounterSubjectStatushttp://hl7.org/fhir/ValueSet/encounter-subject-status From the FHIR Standard | |
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard | |
Encounter.reason.use | example | EncounterReasonUsehttp://hl7.org/fhir/ValueSet/encounter-reason-use From the FHIR Standard | |
Encounter.reason.value | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason From the FHIR Standard | |
Encounter.diagnosis.condition | required | ICD11Codeshttps://fhir.slade360.co.ke/fhir/ValueSet/ICD11Codes From this IG | |
Encounter.diagnosis.use | preferred | EncounterDiagnosisUsehttp://hl7.org/fhir/ValueSet/encounter-diagnosis-use From the FHIR Standard | |
Encounter.dietPreference | example | EncounterDiethttp://hl7.org/fhir/ValueSet/encounter-diet From the FHIR Standard | |
Encounter.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements From the FHIR Standard | |
Encounter.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy From the FHIR Standard | |
Encounter.admission.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-source From the FHIR Standard | |
Encounter.admission.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | |
Encounter.admission.dischargeDisposition | example | DischargeDispositionhttp://hl7.org/fhir/ValueSet/encounter-discharge-disposition From the FHIR Standard | |
Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|5.0.0 From the FHIR Standard | |
Encounter.location.form | example | LocationFormhttp://hl7.org/fhir/ValueSet/location-form From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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-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()) | |
enc-1 | error | Encounter.participant | A type must be provided when no explicit actor is specified : actor.exists() or type.exists() | |
enc-2 | error | Encounter.participant | A type cannot be provided for a patient or group participant : actor.exists(resolve() is Patient or resolve() is Group) implies type.exists().not() | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
txt-1 | error | Encounter.text.div | The 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-2 | error | Encounter.text.div | The narrative SHALL have some non-whitespace content : htmlChecks() |
This structure is derived from Encounter
Summary
Mandatory: 10 elements(1 nested mandatory element)
Fixed: 1 element
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron