Kenya-ePrescription-IG
0.1.0 - ci-build

Kenya-ePrescription-IG - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Encounter - ePrescription

Official URL: http://example.org/StructureDefinition/kenya-eprescription-encounter Version: 0.1.0
Draft as of 2025-12-09 Computable Name: KenyaEPrescriptionEncounter

Encounter constraints for ePrescription workflow.

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
... id SΣ 1..1 id Unique identifier for this Encounter within the bundle.
... meta SΣ 1..1 Meta Metadata about the resource
.... profile SΣ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier SΣ 1..1 Identifier Identifier by which this encounter is known.
... status ?!SΣ 1..1 code Current state of the encounter.
Binding: EncounterStatus (required): Current state of the encounter.
... class SΣ 1..1 Coding Classification such as ambulatory, inpatient, emergency.
Binding: ActEncounterCode (extensible): Classification of the encounter.
... serviceType SΣ 0..1 CodeableConcept Broad categorization of the service provided (e.g., cardiology).
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
... priority S 0..1 CodeableConcept Indicates urgency of encounter.
Binding: ActPriority (example): Indicates the urgency of the encounter.
... subject SΣ 1..1 Reference(Patient - ePrescription) The patient or group present at the encounter.
... participant SΣ 1..1 BackboneElement The practitioner involved in the encounter.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... individual SΣ 1..1 Reference(Practitioner - ePrescription) Persons involved in the encounter other than the patient
... period S 1..1 Period The start and end time of the encounter
.... start SΣC 0..1 dateTime The start time of the encounter.
.... end SΣC 0..1 dateTime The end time of the encounter.
... hospitalization S 0..1 BackboneElement Details about the admission to a healthcare service
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... origin S 0..1 Reference(Location | Organization) Location/organization patient came from before admission.
.... admitSource S 0..1 CodeableConcept From where patient was admitted.
Binding: AdmitSource (preferred): From where the patient was admitted.
.... reAdmission S 0..1 CodeableConcept Type of hospital re-admission (if any).
Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
..... coding Σ 0..* Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 1..1 string Representation defined by the system
.... dischargeDisposition S 0..1 CodeableConcept Category of location after discharge.
Binding: DischargeDisposition (example): Discharge Disposition.
... serviceProvider S 1..1 Reference(Organization - ePrescription) Organization primarily responsible for the Encounter.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base extensible ActEncounterCode 📦3.0.0 THO v7.0
Encounter.serviceType Base example Service type 📍4.0.1 FHIR Std.
Encounter.priority Base example ActPriority 📦3.0.0 THO v7.0
Encounter.hospitalization.​admitSource Base preferred Admit source 📍4.0.1 FHIR Std.
Encounter.hospitalization.​reAdmission Base example hl7VS-re-admissionIndicator 📦2.0.0 THO v7.0
Encounter.hospitalization.​dischargeDisposition Base example Discharge disposition 📍4.0.1 FHIR Std.

Constraints

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

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... id S 1..1 id Unique identifier for this Encounter within the bundle.
... meta S 1..1 Meta Metadata about the resource
.... profile S 1..* canonical(StructureDefinition) Profiles this resource claims to conform to.
... identifier S 1..1 Identifier Identifier by which this encounter is known.
... class S 1..1 Coding Classification such as ambulatory, inpatient, emergency.
... serviceType S 0..1 CodeableConcept Broad categorization of the service provided (e.g., cardiology).
... priority S 0..1 CodeableConcept Indicates urgency of encounter.
... subject S 1..1 Reference(Patient - ePrescription) The patient or group present at the encounter.
... participant S 1..1 BackboneElement The practitioner involved in the encounter.
.... individual S 1..1 Reference(Practitioner - ePrescription) Persons involved in the encounter other than the patient
... period S 1..1 Period The start and end time of the encounter
.... start S 0..1 dateTime The start time of the encounter.
.... end S 0..1 dateTime The end time of the encounter.
... hospitalization S 0..1 BackboneElement Details about the admission to a healthcare service
.... origin S 0..1 Reference(Location | Organization) Location/organization patient came from before admission.
.... admitSource S 0..1 CodeableConcept From where patient was admitted.
.... reAdmission S 0..1 CodeableConcept Type of hospital re-admission (if any).
..... coding
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 1..1 string Representation defined by the system
.... dischargeDisposition S 0..1 CodeableConcept Category of location after discharge.
... serviceProvider S 1..1 Reference(Organization - ePrescription) Organization primarily responsible for the Encounter.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... id SΣ 1..1 id Unique identifier for this Encounter within the bundle.
... meta SΣ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to.
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..1 Identifier Identifier by which this encounter is known.
... status ?!SΣ 1..1 code Current state of the encounter.
Binding: EncounterStatus (required): Current state of the encounter.
... statusHistory 0..* BackboneElement List of past encounter statuses
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
.... period 1..1 Period The time that the episode was in the specified status
... class SΣ 1..1 Coding Classification such as ambulatory, inpatient, emergency.
Binding: ActEncounterCode (extensible): Classification of the encounter.
... classHistory 0..* BackboneElement List of past encounter classes
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.
.... period 1..1 Period The time that the episode was in the specified class
... type Σ 0..* CodeableConcept Specific type of encounter
Binding: EncounterType (example): The type of encounter.
... serviceType SΣ 0..1 CodeableConcept Broad categorization of the service provided (e.g., cardiology).
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
... priority S 0..1 CodeableConcept Indicates urgency of encounter.
Binding: ActPriority (example): Indicates the urgency of the encounter.
... subject SΣ 1..1 Reference(Patient - ePrescription) The patient or group present at the encounter.
... episodeOfCare Σ 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
... basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
... participant SΣ 1..1 BackboneElement The practitioner involved in the encounter.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
.... period 0..1 Period Period of time during the encounter that the participant participated
.... individual SΣ 1..1 Reference(Practitioner - ePrescription) Persons involved in the encounter other than the patient
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
... period S 1..1 Period The start and end time of the encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC 0..1 dateTime The start time of the encounter.
.... end SΣC 0..1 dateTime The end time of the encounter.
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... reasonCode Σ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
... reasonReference Σ 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition Σ 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
.... use 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
.... rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
... account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
... hospitalization S 0..1 BackboneElement Details about the admission to a healthcare service
.... id 0..1 string Unique id for inter-element referencing
.... 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 S 0..1 Reference(Location | Organization) Location/organization patient came from before admission.
.... admitSource S 0..1 CodeableConcept From where patient was admitted.
Binding: AdmitSource (preferred): From where the patient was admitted.
.... reAdmission S 0..1 CodeableConcept Type of hospital re-admission (if any).
Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 1..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
.... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
.... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.
.... destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
.... dischargeDisposition S 0..1 CodeableConcept Category 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 Reference(Location) Location the encounter takes place
.... status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
.... physicalType 0..1 CodeableConcept The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example): Physical form of the location.
.... period 0..1 Period Time period during which the patient was present at the location
... serviceProvider S 1..1 Reference(Organization - ePrescription) Organization primarily responsible for the Encounter.
... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Encounter.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Encounter.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.statusHistory.​status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base extensible ActEncounterCode 📦3.0.0 THO v7.0
Encounter.classHistory.​class Base extensible ActEncounterCode 📦3.0.0 THO v7.0
Encounter.type Base example Encounter type 📍4.0.1 FHIR Std.
Encounter.serviceType Base example Service type 📍4.0.1 FHIR Std.
Encounter.priority Base example ActPriority 📦3.0.0 THO v7.0
Encounter.participant.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Encounter.reasonCode Base preferred Encounter Reason Codes 📍4.0.1 FHIR Std.
Encounter.diagnosis.​use Base preferred DiagnosisRole 📍4.0.1 FHIR Std.
Encounter.hospitalization.​admitSource Base preferred Admit source 📍4.0.1 FHIR Std.
Encounter.hospitalization.​reAdmission Base example hl7VS-re-admissionIndicator 📦2.0.0 THO v7.0
Encounter.hospitalization.​dietPreference Base example Diet 📍4.0.1 FHIR Std.
Encounter.hospitalization.​specialCourtesy Base preferred Special courtesy 📍4.0.1 FHIR Std.
Encounter.hospitalization.​specialArrangement Base preferred Special arrangements 📍4.0.1 FHIR Std.
Encounter.hospitalization.​dischargeDisposition Base example Discharge disposition 📍4.0.1 FHIR Std.
Encounter.location.status Base required EncounterLocationStatus 📍4.0.1 FHIR Std.
Encounter.location.physicalType Base example Location type 📍4.0.1 FHIR Std.

Constraints

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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... id SΣ 1..1 id Unique identifier for this Encounter within the bundle.
... meta SΣ 1..1 Meta Metadata about the resource
.... profile SΣ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier SΣ 1..1 Identifier Identifier by which this encounter is known.
... status ?!SΣ 1..1 code Current state of the encounter.
Binding: EncounterStatus (required): Current state of the encounter.
... class SΣ 1..1 Coding Classification such as ambulatory, inpatient, emergency.
Binding: ActEncounterCode (extensible): Classification of the encounter.
... serviceType SΣ 0..1 CodeableConcept Broad categorization of the service provided (e.g., cardiology).
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
... priority S 0..1 CodeableConcept Indicates urgency of encounter.
Binding: ActPriority (example): Indicates the urgency of the encounter.
... subject SΣ 1..1 Reference(Patient - ePrescription) The patient or group present at the encounter.
... participant SΣ 1..1 BackboneElement The practitioner involved in the encounter.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... individual SΣ 1..1 Reference(Practitioner - ePrescription) Persons involved in the encounter other than the patient
... period S 1..1 Period The start and end time of the encounter
.... start SΣC 0..1 dateTime The start time of the encounter.
.... end SΣC 0..1 dateTime The end time of the encounter.
... hospitalization S 0..1 BackboneElement Details about the admission to a healthcare service
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... origin S 0..1 Reference(Location | Organization) Location/organization patient came from before admission.
.... admitSource S 0..1 CodeableConcept From where patient was admitted.
Binding: AdmitSource (preferred): From where the patient was admitted.
.... reAdmission S 0..1 CodeableConcept Type of hospital re-admission (if any).
Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
..... coding Σ 0..* Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 1..1 string Representation defined by the system
.... dischargeDisposition S 0..1 CodeableConcept Category of location after discharge.
Binding: DischargeDisposition (example): Discharge Disposition.
... serviceProvider S 1..1 Reference(Organization - ePrescription) Organization primarily responsible for the Encounter.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base extensible ActEncounterCode 📦3.0.0 THO v7.0
Encounter.serviceType Base example Service type 📍4.0.1 FHIR Std.
Encounter.priority Base example ActPriority 📦3.0.0 THO v7.0
Encounter.hospitalization.​admitSource Base preferred Admit source 📍4.0.1 FHIR Std.
Encounter.hospitalization.​reAdmission Base example hl7VS-re-admissionIndicator 📦2.0.0 THO v7.0
Encounter.hospitalization.​dischargeDisposition Base example Discharge disposition 📍4.0.1 FHIR Std.

Constraints

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

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
... id S 1..1 id Unique identifier for this Encounter within the bundle.
... meta S 1..1 Meta Metadata about the resource
.... profile S 1..* canonical(StructureDefinition) Profiles this resource claims to conform to.
... identifier S 1..1 Identifier Identifier by which this encounter is known.
... class S 1..1 Coding Classification such as ambulatory, inpatient, emergency.
... serviceType S 0..1 CodeableConcept Broad categorization of the service provided (e.g., cardiology).
... priority S 0..1 CodeableConcept Indicates urgency of encounter.
... subject S 1..1 Reference(Patient - ePrescription) The patient or group present at the encounter.
... participant S 1..1 BackboneElement The practitioner involved in the encounter.
.... individual S 1..1 Reference(Practitioner - ePrescription) Persons involved in the encounter other than the patient
... period S 1..1 Period The start and end time of the encounter
.... start S 0..1 dateTime The start time of the encounter.
.... end S 0..1 dateTime The end time of the encounter.
... hospitalization S 0..1 BackboneElement Details about the admission to a healthcare service
.... origin S 0..1 Reference(Location | Organization) Location/organization patient came from before admission.
.... admitSource S 0..1 CodeableConcept From where patient was admitted.
.... reAdmission S 0..1 CodeableConcept Type of hospital re-admission (if any).
..... coding
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 1..1 string Representation defined by the system
.... dischargeDisposition S 0..1 CodeableConcept Category of location after discharge.
... serviceProvider S 1..1 Reference(Organization - ePrescription) Organization primarily responsible for the Encounter.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... id SΣ 1..1 id Unique identifier for this Encounter within the bundle.
... meta SΣ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to.
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..1 Identifier Identifier by which this encounter is known.
... status ?!SΣ 1..1 code Current state of the encounter.
Binding: EncounterStatus (required): Current state of the encounter.
... statusHistory 0..* BackboneElement List of past encounter statuses
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
.... period 1..1 Period The time that the episode was in the specified status
... class SΣ 1..1 Coding Classification such as ambulatory, inpatient, emergency.
Binding: ActEncounterCode (extensible): Classification of the encounter.
... classHistory 0..* BackboneElement List of past encounter classes
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.
.... period 1..1 Period The time that the episode was in the specified class
... type Σ 0..* CodeableConcept Specific type of encounter
Binding: EncounterType (example): The type of encounter.
... serviceType SΣ 0..1 CodeableConcept Broad categorization of the service provided (e.g., cardiology).
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
... priority S 0..1 CodeableConcept Indicates urgency of encounter.
Binding: ActPriority (example): Indicates the urgency of the encounter.
... subject SΣ 1..1 Reference(Patient - ePrescription) The patient or group present at the encounter.
... episodeOfCare Σ 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
... basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
... participant SΣ 1..1 BackboneElement The practitioner involved in the encounter.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
.... period 0..1 Period Period of time during the encounter that the participant participated
.... individual SΣ 1..1 Reference(Practitioner - ePrescription) Persons involved in the encounter other than the patient
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
... period S 1..1 Period The start and end time of the encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC 0..1 dateTime The start time of the encounter.
.... end SΣC 0..1 dateTime The end time of the encounter.
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... reasonCode Σ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
... reasonReference Σ 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition Σ 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
.... use 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
.... rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
... account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
... hospitalization S 0..1 BackboneElement Details about the admission to a healthcare service
.... id 0..1 string Unique id for inter-element referencing
.... 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 S 0..1 Reference(Location | Organization) Location/organization patient came from before admission.
.... admitSource S 0..1 CodeableConcept From where patient was admitted.
Binding: AdmitSource (preferred): From where the patient was admitted.
.... reAdmission S 0..1 CodeableConcept Type of hospital re-admission (if any).
Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 1..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
.... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
.... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.
.... destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
.... dischargeDisposition S 0..1 CodeableConcept Category 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 Reference(Location) Location the encounter takes place
.... status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
.... physicalType 0..1 CodeableConcept The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example): Physical form of the location.
.... period 0..1 Period Time period during which the patient was present at the location
... serviceProvider S 1..1 Reference(Organization - ePrescription) Organization primarily responsible for the Encounter.
... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Encounter.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Encounter.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.statusHistory.​status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base extensible ActEncounterCode 📦3.0.0 THO v7.0
Encounter.classHistory.​class Base extensible ActEncounterCode 📦3.0.0 THO v7.0
Encounter.type Base example Encounter type 📍4.0.1 FHIR Std.
Encounter.serviceType Base example Service type 📍4.0.1 FHIR Std.
Encounter.priority Base example ActPriority 📦3.0.0 THO v7.0
Encounter.participant.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Encounter.reasonCode Base preferred Encounter Reason Codes 📍4.0.1 FHIR Std.
Encounter.diagnosis.​use Base preferred DiagnosisRole 📍4.0.1 FHIR Std.
Encounter.hospitalization.​admitSource Base preferred Admit source 📍4.0.1 FHIR Std.
Encounter.hospitalization.​reAdmission Base example hl7VS-re-admissionIndicator 📦2.0.0 THO v7.0
Encounter.hospitalization.​dietPreference Base example Diet 📍4.0.1 FHIR Std.
Encounter.hospitalization.​specialCourtesy Base preferred Special courtesy 📍4.0.1 FHIR Std.
Encounter.hospitalization.​specialArrangement Base preferred Special arrangements 📍4.0.1 FHIR Std.
Encounter.hospitalization.​dischargeDisposition Base example Discharge disposition 📍4.0.1 FHIR Std.
Encounter.location.status Base required EncounterLocationStatus 📍4.0.1 FHIR Std.
Encounter.location.physicalType Base example Location type 📍4.0.1 FHIR Std.

Constraints

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

 

Other representations of profile: CSV, Excel, Schematron