FHIR Implementation Guide for ABDM
6.5.0 - active India flag

Banner

FHIR Implementation Guide for ABDM - Local Development build (v6.5.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Encounter

Official URL: https://nrces.in/ndhm/fhir/r4/StructureDefinition/Encounter Version: 6.5.0
Draft as of 2020-08-17 Computable Name: Encounter

This profile sets minimum expectations for the Encounter resource to record, search, and fetch basic encounter information for an individual patient.

This profile sets minimum expectations for the Encounter resource to record, search, and fetch basic encounter information for an individual patient. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Examples

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier SΣ 0..* Identifier Identifier(s) by which this encounter is known
ele-1: All FHIR elements must have a @value or children
... class SΣ 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.


ele-1: All FHIR elements must have a @value or children
... type SΣ 0..* CodeableConcept Specific type of encounter
Binding: EncounterTypes (example)
ele-1: All FHIR elements must have a @value or children
.... coding SΣ 0..* Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
..... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
..... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
..... display Σ 1..1 string Representation defined by the system
ele-1: All FHIR elements must have a @value or children
.... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... serviceType SΣ 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.


ele-1: All FHIR elements must have a @value or children
.... coding SΣ 0..* Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
..... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
..... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
..... display Σ 1..1 string Representation defined by the system
ele-1: All FHIR elements must have a @value or children
.... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.


ele-1: All FHIR elements must have a @value or children
.... coding SΣ 0..* Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
..... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
..... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
..... display Σ 1..1 string Representation defined by the system
ele-1: All FHIR elements must have a @value or children
.... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... subject Σ 0..1 Reference(Group | Patient) The patient or group present at the encounter
ele-1: All FHIR elements must have a @value or children
... basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
ele-1: All FHIR elements must have a @value or children
... participant Σ 0..* BackboneElement List of participants involved in the encounter
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... type Σ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.


ele-1: All FHIR elements must have a @value or children
..... coding SΣ 0..* Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
...... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
...... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
...... display Σ 1..1 string Representation defined by the system
ele-1: All FHIR elements must have a @value or children
..... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
.... individual Σ 0..1 Reference(RelatedPerson | Practitioner | PractitionerRole) Persons involved in the encounter other than the patient
ele-1: All FHIR elements must have a @value or children
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
ele-1: All FHIR elements must have a @value or children
... period S 0..1 Period The start and end time of the encounter
ele-1: All FHIR elements must have a @value or children
... reasonCode Σ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.


ele-1: All FHIR elements must have a @value or children
.... coding SΣ 0..* Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
..... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://snomed.info/sct
..... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
..... display Σ 1..1 string Representation defined by the system
ele-1: All FHIR elements must have a @value or children
.... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... reasonReference Σ 0..* Reference(ImmunizationRecommendation | Condition | Procedure | Observation) Reason the encounter takes place (reference)
ele-1: All FHIR elements must have a @value or children
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... condition Σ 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
ele-1: All FHIR elements must have a @value or children
.... use 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: Diagnosis Use (preferred)
ele-1: All FHIR elements must have a @value or children
..... coding SΣ 0..* Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
...... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://snomed.info/sct
...... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
...... display Σ 1..1 string Representation defined by the system
ele-1: All FHIR elements must have a @value or children
..... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... hospitalization S 0..1 BackboneElement Details about the admission to a healthcare service
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
ele-1: All FHIR elements must have a @value or children
.... destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
ele-1: All FHIR elements must have a @value or children
... serviceProvider 0..1 Reference(Organization) The organization (facility) responsible for this encounter
ele-1: All FHIR elements must have a @value or children
... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typeexampleEncounterTypes
https://nrces.in/ndhm/fhir/r4/ValueSet/ndhm-encounter-type
from this IG
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Encounter.priorityexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Encounter.diagnosis.usepreferredDiagnosisUse
https://nrces.in/ndhm/fhir/r4/ValueSet/ndhm-diagnosis-use
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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-4errorEncounterIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter Encounter
... identifier S 0..* Identifier Identifier(s) by which this encounter is known
... status S 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
... class S 1..1 Coding Classification of patient encounter
.... coding S 0..* Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
..... code 1..1 code Symbol in syntax defined by the system
..... display 1..1 string Representation defined by the system
.... text S 0..1 string Plain text representation of the concept
... serviceType S 0..1 CodeableConcept Specific type of service
.... coding S 0..* Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
..... code 1..1 code Symbol in syntax defined by the system
..... display 1..1 string Representation defined by the system
.... text S 0..1 string Plain text representation of the concept
... priority
.... coding S 0..* Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
..... code 1..1 code Symbol in syntax defined by the system
..... display 1..1 string Representation defined by the system
.... text S 0..1 string Plain text representation of the concept
... subject 0..1 Reference(Group | Patient) The patient or group present at the encounter
... basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
... participant
.... type
..... coding S 0..* Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
...... code 1..1 code Symbol in syntax defined by the system
...... display 1..1 string Representation defined by the system
..... text S 0..1 string Plain text representation of the concept
.... individual 0..1 Reference(RelatedPerson | Practitioner | PractitionerRole) Persons involved in the encounter other than the patient
... appointment 0..* Reference(Appointment) The appointment that scheduled this encounter
... period S 0..1 Period The start and end time of the encounter
... reasonCode
.... coding S 0..* Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
..... display 1..1 string Representation defined by the system
.... text S 0..1 string Plain text representation of the concept
... reasonReference 0..* Reference(ImmunizationRecommendation | Condition | Procedure | Observation) Reason the encounter takes place (reference)
... diagnosis
.... 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: Diagnosis Use (preferred)
..... coding S 0..* Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
...... display 1..1 string Representation defined by the system
..... text S 0..1 string Plain text representation of the concept
... hospitalization S 0..1 BackboneElement Details about the admission to a healthcare service
.... origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
.... destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
... serviceProvider 0..1 Reference(Organization) The organization (facility) responsible for this encounter
... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Encounter.typeexampleEncounterTypes
https://nrces.in/ndhm/fhir/r4/ValueSet/ndhm-encounter-type
from this IG
Encounter.diagnosis.usepreferredDiagnosisUse
https://nrces.in/ndhm/fhir/r4/ValueSet/ndhm-diagnosis-use
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Identifier(s) by which this encounter is known
... status ?!SΣ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.

... statusHistory 0..* BackboneElement List of past encounter statuses
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.

.... period 1..1 Period The time that the episode was in the specified status
... class SΣ 1..1 Coding Classification of patient encounter
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 SΣ 0..* CodeableConcept Specific type of encounter
Binding: EncounterTypes (example)
.... 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 SΣ 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 Σ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
..... display Σ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 0..1 string Plain text representation of the concept
... serviceType SΣ 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.

.... 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 SΣ 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 Σ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
..... display Σ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 0..1 string Plain text representation of the concept
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency 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
.... coding SΣ 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 Σ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
..... display Σ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 0..1 string Plain text representation of the concept
... subject Σ 0..1 Reference(Group | Patient) The patient or group present at the encounter
... episodeOfCare Σ 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
... basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
... participant Σ 0..* BackboneElement List of participants 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.


..... 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 SΣ 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 Σ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 1..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text SΣ 0..1 string Plain text representation of the concept
.... period 0..1 Period Period of time during the encounter that the participant participated
.... individual Σ 0..1 Reference(RelatedPerson | Practitioner | PractitionerRole) Persons involved in the encounter other than the patient
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
... period S 0..1 Period The start and 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.


.... 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 SΣ 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 Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
..... display Σ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 0..1 string Plain text representation of the concept
... reasonReference Σ 0..* Reference(ImmunizationRecommendation | Condition | Procedure | Observation) 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: Diagnosis Use (preferred)
..... 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 SΣ 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 Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 1..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text SΣ 0..1 string Plain text representation of the concept
.... 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 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
.... admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.

.... reAdmission 0..1 CodeableConcept The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.

.... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.


.... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.


.... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.


.... destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
.... dischargeDisposition 0..1 CodeableConcept Category or kind of location after discharge
Binding: DischargeDisposition (example): Discharge Disposition.

... location 0..* BackboneElement List of locations where the patient has been
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location 1..1 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 0..1 Reference(Organization) The organization (facility) responsible for this encounter
... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typeexampleEncounterTypes
https://nrces.in/ndhm/fhir/r4/ValueSet/ndhm-encounter-type
from this IG
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Encounter.priorityexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Encounter.diagnosis.usepreferredDiagnosisUse
https://nrces.in/ndhm/fhir/r4/ValueSet/ndhm-diagnosis-use
from this IG
Encounter.hospitalization.admitSourcepreferredAdmitSource
http://hl7.org/fhir/ValueSet/encounter-admit-source
from the FHIR Standard
Encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreferenceexampleDiet
http://hl7.org/fhir/ValueSet/encounter-diet
from the FHIR Standard
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
http://hl7.org/fhir/ValueSet/encounter-special-courtesy
from the FHIR Standard
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
http://hl7.org/fhir/ValueSet/encounter-special-arrangements
from the FHIR Standard
Encounter.hospitalization.dischargeDispositionexampleDischargeDisposition
http://hl7.org/fhir/ValueSet/encounter-discharge-disposition
from the FHIR Standard
Encounter.location.statusrequiredEncounterLocationStatus
http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1
from the FHIR Standard
Encounter.location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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-4errorEncounterIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier SΣ 0..* Identifier Identifier(s) by which this encounter is known
ele-1: All FHIR elements must have a @value or children
... class SΣ 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.


ele-1: All FHIR elements must have a @value or children
... type SΣ 0..* CodeableConcept Specific type of encounter
Binding: EncounterTypes (example)
ele-1: All FHIR elements must have a @value or children
.... coding SΣ 0..* Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
..... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
..... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
..... display Σ 1..1 string Representation defined by the system
ele-1: All FHIR elements must have a @value or children
.... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... serviceType SΣ 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.


ele-1: All FHIR elements must have a @value or children
.... coding SΣ 0..* Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
..... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
..... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
..... display Σ 1..1 string Representation defined by the system
ele-1: All FHIR elements must have a @value or children
.... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.


ele-1: All FHIR elements must have a @value or children
.... coding SΣ 0..* Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
..... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
..... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
..... display Σ 1..1 string Representation defined by the system
ele-1: All FHIR elements must have a @value or children
.... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... subject Σ 0..1 Reference(Group | Patient) The patient or group present at the encounter
ele-1: All FHIR elements must have a @value or children
... basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
ele-1: All FHIR elements must have a @value or children
... participant Σ 0..* BackboneElement List of participants involved in the encounter
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... type Σ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.


ele-1: All FHIR elements must have a @value or children
..... coding SΣ 0..* Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
...... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
...... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
...... display Σ 1..1 string Representation defined by the system
ele-1: All FHIR elements must have a @value or children
..... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
.... individual Σ 0..1 Reference(RelatedPerson | Practitioner | PractitionerRole) Persons involved in the encounter other than the patient
ele-1: All FHIR elements must have a @value or children
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
ele-1: All FHIR elements must have a @value or children
... period S 0..1 Period The start and end time of the encounter
ele-1: All FHIR elements must have a @value or children
... reasonCode Σ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.


ele-1: All FHIR elements must have a @value or children
.... coding SΣ 0..* Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
..... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://snomed.info/sct
..... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
..... display Σ 1..1 string Representation defined by the system
ele-1: All FHIR elements must have a @value or children
.... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... reasonReference Σ 0..* Reference(ImmunizationRecommendation | Condition | Procedure | Observation) Reason the encounter takes place (reference)
ele-1: All FHIR elements must have a @value or children
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... condition Σ 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
ele-1: All FHIR elements must have a @value or children
.... use 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: Diagnosis Use (preferred)
ele-1: All FHIR elements must have a @value or children
..... coding SΣ 0..* Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
...... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://snomed.info/sct
...... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
...... display Σ 1..1 string Representation defined by the system
ele-1: All FHIR elements must have a @value or children
..... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... hospitalization S 0..1 BackboneElement Details about the admission to a healthcare service
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
ele-1: All FHIR elements must have a @value or children
.... destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
ele-1: All FHIR elements must have a @value or children
... serviceProvider 0..1 Reference(Organization) The organization (facility) responsible for this encounter
ele-1: All FHIR elements must have a @value or children
... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typeexampleEncounterTypes
https://nrces.in/ndhm/fhir/r4/ValueSet/ndhm-encounter-type
from this IG
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Encounter.priorityexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Encounter.diagnosis.usepreferredDiagnosisUse
https://nrces.in/ndhm/fhir/r4/ValueSet/ndhm-diagnosis-use
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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-4errorEncounterIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter Encounter
... identifier S 0..* Identifier Identifier(s) by which this encounter is known
... status S 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
... class S 1..1 Coding Classification of patient encounter
.... coding S 0..* Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
..... code 1..1 code Symbol in syntax defined by the system
..... display 1..1 string Representation defined by the system
.... text S 0..1 string Plain text representation of the concept
... serviceType S 0..1 CodeableConcept Specific type of service
.... coding S 0..* Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
..... code 1..1 code Symbol in syntax defined by the system
..... display 1..1 string Representation defined by the system
.... text S 0..1 string Plain text representation of the concept
... priority
.... coding S 0..* Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
..... code 1..1 code Symbol in syntax defined by the system
..... display 1..1 string Representation defined by the system
.... text S 0..1 string Plain text representation of the concept
... subject 0..1 Reference(Group | Patient) The patient or group present at the encounter
... basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
... participant
.... type
..... coding S 0..* Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
...... code 1..1 code Symbol in syntax defined by the system
...... display 1..1 string Representation defined by the system
..... text S 0..1 string Plain text representation of the concept
.... individual 0..1 Reference(RelatedPerson | Practitioner | PractitionerRole) Persons involved in the encounter other than the patient
... appointment 0..* Reference(Appointment) The appointment that scheduled this encounter
... period S 0..1 Period The start and end time of the encounter
... reasonCode
.... coding S 0..* Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
..... display 1..1 string Representation defined by the system
.... text S 0..1 string Plain text representation of the concept
... reasonReference 0..* Reference(ImmunizationRecommendation | Condition | Procedure | Observation) Reason the encounter takes place (reference)
... diagnosis
.... 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: Diagnosis Use (preferred)
..... coding S 0..* Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
...... display 1..1 string Representation defined by the system
..... text S 0..1 string Plain text representation of the concept
... hospitalization S 0..1 BackboneElement Details about the admission to a healthcare service
.... origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
.... destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
... serviceProvider 0..1 Reference(Organization) The organization (facility) responsible for this encounter
... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Encounter.typeexampleEncounterTypes
https://nrces.in/ndhm/fhir/r4/ValueSet/ndhm-encounter-type
from this IG
Encounter.diagnosis.usepreferredDiagnosisUse
https://nrces.in/ndhm/fhir/r4/ValueSet/ndhm-diagnosis-use
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Identifier(s) by which this encounter is known
... status ?!SΣ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.

... statusHistory 0..* BackboneElement List of past encounter statuses
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.

.... period 1..1 Period The time that the episode was in the specified status
... class SΣ 1..1 Coding Classification of patient encounter
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 SΣ 0..* CodeableConcept Specific type of encounter
Binding: EncounterTypes (example)
.... 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 SΣ 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 Σ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
..... display Σ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 0..1 string Plain text representation of the concept
... serviceType SΣ 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.

.... 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 SΣ 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 Σ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
..... display Σ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 0..1 string Plain text representation of the concept
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency 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
.... coding SΣ 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 Σ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
..... display Σ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 0..1 string Plain text representation of the concept
... subject Σ 0..1 Reference(Group | Patient) The patient or group present at the encounter
... episodeOfCare Σ 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
... basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
... participant Σ 0..* BackboneElement List of participants 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.


..... 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 SΣ 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 Σ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 1..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text SΣ 0..1 string Plain text representation of the concept
.... period 0..1 Period Period of time during the encounter that the participant participated
.... individual Σ 0..1 Reference(RelatedPerson | Practitioner | PractitionerRole) Persons involved in the encounter other than the patient
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
... period S 0..1 Period The start and 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.


.... 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 SΣ 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 Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
..... display Σ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 0..1 string Plain text representation of the concept
... reasonReference Σ 0..* Reference(ImmunizationRecommendation | Condition | Procedure | Observation) 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: Diagnosis Use (preferred)
..... 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 SΣ 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 Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 1..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text SΣ 0..1 string Plain text representation of the concept
.... 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 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
.... admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.

.... reAdmission 0..1 CodeableConcept The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.

.... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.


.... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.


.... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.


.... destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
.... dischargeDisposition 0..1 CodeableConcept Category or kind of location after discharge
Binding: DischargeDisposition (example): Discharge Disposition.

... location 0..* BackboneElement List of locations where the patient has been
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location 1..1 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 0..1 Reference(Organization) The organization (facility) responsible for this encounter
... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typeexampleEncounterTypes
https://nrces.in/ndhm/fhir/r4/ValueSet/ndhm-encounter-type
from this IG
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Encounter.priorityexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Encounter.diagnosis.usepreferredDiagnosisUse
https://nrces.in/ndhm/fhir/r4/ValueSet/ndhm-diagnosis-use
from this IG
Encounter.hospitalization.admitSourcepreferredAdmitSource
http://hl7.org/fhir/ValueSet/encounter-admit-source
from the FHIR Standard
Encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreferenceexampleDiet
http://hl7.org/fhir/ValueSet/encounter-diet
from the FHIR Standard
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
http://hl7.org/fhir/ValueSet/encounter-special-courtesy
from the FHIR Standard
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
http://hl7.org/fhir/ValueSet/encounter-special-arrangements
from the FHIR Standard
Encounter.hospitalization.dischargeDispositionexampleDischargeDisposition
http://hl7.org/fhir/ValueSet/encounter-discharge-disposition
from the FHIR Standard
Encounter.location.statusrequiredEncounterLocationStatus
http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1
from the FHIR Standard
Encounter.location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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-4errorEncounterIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron