Skip to content

Encounter Profile

Canonical../StructureDefinition/nexus-emr-core-encounter
Statusdraft · 1.26.0
BaseEncounter (constraint)
SourceFSH · JSON

Defines the Encounter resource constraints for the Nexus EMR project (CII), conforming to CA-Core+ requirements.

Elements / Snapshot

The full effective definition: base Encounter with this profile's constraints applied.

Element Flags Card. Type Description & Constraints
Encounter 0..* Nexus EMR Encounter Core
Invariants: dom-2, dom-3, dom-4, dom-5, dom-6, encounter-appointment-single-in-primary-care
id 0..1 http://hl7.org/fhirpath/System.String Logical id of this artifact i
meta 0..1 Meta Metadata about the resource
Invariants: ele-1
id 0..1 http://hl7.org/fhirpath/System.String Unique id for inter-element referencing
extension 0..* Extension Additional content defined by implementations i
Slicing: value:url (open)
Invariants: ele-1, ext-1
versionId 0..1 id Version specific identifier i
Invariants: ele-1
lastUpdated 0..1 instant When the resource version last changed i
Invariants: ele-1
source S 0..1 uri Identifies EMR instance & pipeline version the resource came from i
Invariants: ele-1
profile 0..* canonical Profiles this resource claims to conform to i
Invariants: ele-1
security 0..* Coding Security Labels applied to this resource i
Binding: security-labels (extensible)
Invariants: ele-1
tag 0..* Coding Tags applied to this resource i
Binding: common-tags (example)
Invariants: ele-1
implicitRules ?! 0..1 uri A set of rules under which this content was created i
Invariants: ele-1
language 0..1 code Language of the resource content i
Binding: languages (preferred)
Invariants: ele-1
text S 0..1 Narrative Narrative i
Invariants: ele-1
contained 0..* Resource Contained, inline Resources i
extension 0..* Extension Additional content defined by implementations i
Invariants: ele-1, ext-1
modifierExtension ?! 0..* Extension Extensions that cannot be ignored i
Invariants: ele-1, ext-1
identifier S 0..* Identifier Business identifier(s) for encounter i
Invariants: ele-1
id 0..1 http://hl7.org/fhirpath/System.String Unique id for inter-element referencing
extension 0..* Extension Additional content defined by implementations i
Slicing: value:url (open)
Invariants: ele-1, ext-1
use ?! 0..1 code usual | official | temp | secondary | old (If known) i
Binding: identifier-use (required)
Invariants: ele-1
type 0..1 CodeableConcept Description of identifier i
Binding: identifier-type (extensible)
Invariants: ele-1
system 1..1 uri The namespace for the identifier value i
Invariants: ele-1
value 1..1 string The value that is unique i
Invariants: ele-1
period 0..1 Period Time period when id is/was valid for use
Invariants: ele-1
assigner 0..1 Reference(Organization) Organization that issued id (may be just text) i
Invariants: ele-1
status S ?! 1..1 code Where the encounter is in its lifecycle i
Binding: encounter-status (required)
Invariants: ele-1
statusHistory 0..* BackboneElement List of past encounter statuses i
Invariants: ele-1
id 0..1 http://hl7.org/fhirpath/System.String Unique id for inter-element referencing
extension 0..* Extension Additional content defined by implementations i
Invariants: ele-1, ext-1
modifierExtension ?! 0..* Extension Extensions that cannot be ignored even if unrecognized i
Invariants: ele-1, ext-1
status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: encounter-status (required)
Invariants: ele-1
period 1..1 Period The time that the episode was in the specified status
Invariants: ele-1
class S 1..1 Coding Classification of patient encounter i
Binding: v3-ActEncounterCode (required)
Invariants: ele-1
classHistory 0..* BackboneElement List of past encounter classes
Invariants: ele-1
id 0..1 http://hl7.org/fhirpath/System.String Unique id for inter-element referencing
extension 0..* Extension Additional content defined by implementations i
Invariants: ele-1, ext-1
modifierExtension ?! 0..* Extension Extensions that cannot be ignored even if unrecognized i
Invariants: ele-1, ext-1
class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: v3-ActEncounterCode (extensible)
Invariants: ele-1
period 1..1 Period The time that the episode was in the specified class
Invariants: ele-1
type S 0..* CodeableConcept Encounter type with raw code support i
Binding: encounter-type (example)
Invariants: ele-1
serviceType S 0..1 CodeableConcept Service type with raw code support i
Binding: service-type (example)
Invariants: ele-1
priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: v3-ActPriority (example)
Invariants: ele-1
subject S 1..1 Reference(Patient Profile) The patient present at the encounter i
Invariants: ele-1
episodeOfCare 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
Invariants: ele-1
basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
Invariants: ele-1
participant S 0..1 BackboneElement List of participants involved in the encounter
Invariants: ele-1
id 0..1 http://hl7.org/fhirpath/System.String Unique id for inter-element referencing
extension 0..* Extension Additional content defined by implementations i
Invariants: ele-1, ext-1
modifierExtension ?! 0..* Extension Extensions that cannot be ignored even if unrecognized i
Invariants: ele-1, ext-1
type 0..* CodeableConcept Role of participant in encounter i
Binding: encounter-participant-type (extensible)
Invariants: ele-1
period 0..1 Period Period of participation
Invariants: ele-1
individual 0..1 Reference(PractitionerRole Profile | Practitioner Profile) Persons involved in the encounter
Invariants: ele-1
appointment S 0..* Reference(Appointment Profile) The appointment this encounter fulfils (1:1 in primary care) i
Invariants: ele-1
period S 1..1 Period The start and end time of the encounter i
Invariants: ele-1
id 0..1 http://hl7.org/fhirpath/System.String Unique id for inter-element referencing
extension 0..* Extension Additional content defined by implementations i
Slicing: value:url (open)
Invariants: ele-1, ext-1
start S 1..1 dateTime When the encounter started i
Invariants: ele-1
end S 0..1 dateTime When the encounter ended (if finished) i
Invariants: ele-1
length 0..1 Duration Quantity of time the encounter lasted (less time absent) i
Invariants: ele-1
reasonCode S 0..* CodeableConcept Encounter reason with raw code support i
Binding: encounter-reason (preferred)
Invariants: ele-1
reasonReference 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference) i
Invariants: ele-1
diagnosis S 0..* BackboneElement The list of diagnoses relevant to this encounter
Invariants: ele-1
id 0..1 http://hl7.org/fhirpath/System.String Unique id for inter-element referencing
extension 0..* Extension Additional content defined by implementations i
Invariants: ele-1, ext-1
modifierExtension ?! 0..* Extension Extensions that cannot be ignored even if unrecognized i
Invariants: ele-1, ext-1
condition S 1..1 Reference(Condition Profile) The diagnosis or condition relevant to the encounter i
Invariants: ele-1
use S 0..1 CodeableConcept Role of diagnosis in encounter (e.g., admission, billing, discharge)
Binding: diagnosis-role (preferred)
Invariants: ele-1
rank S 0..1 positiveInt Ranking of the diagnosis (primary, secondary, etc.)
Invariants: ele-1
account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter i
Invariants: ele-1
hospitalization 0..1 BackboneElement Details about the admission to a healthcare service i
Invariants: ele-1
id 0..1 http://hl7.org/fhirpath/System.String Unique id for inter-element referencing
extension 0..* Extension Additional content defined by implementations i
Invariants: ele-1, ext-1
modifierExtension ?! 0..* Extension Extensions that cannot be ignored even if unrecognized i
Invariants: ele-1, ext-1
preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
Invariants: ele-1
origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
Invariants: ele-1
admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: encounter-admit-source (preferred)
Invariants: ele-1
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: v2-0092 (example)
Invariants: ele-1
dietPreference 0..* CodeableConcept Diet preferences reported by the patient i
Binding: encounter-diet (example)
Invariants: ele-1
specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: encounter-special-courtesy (preferred)
Invariants: ele-1
specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: encounter-special-arrangements (preferred)
Invariants: ele-1
destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
Invariants: ele-1
dischargeDisposition 0..1 CodeableConcept Category or kind of location after discharge
Binding: encounter-discharge-disposition (example)
Invariants: ele-1
location S 0..* BackboneElement List of locations where the encounter occurred i
Invariants: ele-1
id 0..1 http://hl7.org/fhirpath/System.String Unique id for inter-element referencing
extension 0..* Extension Additional content defined by implementations i
Invariants: ele-1, ext-1
modifierExtension ?! 0..* Extension Extensions that cannot be ignored even if unrecognized i
Invariants: ele-1, ext-1
location S 1..1 Reference(Location Profile) Location the encounter takes place
Invariants: ele-1
status S 0..1 code planned | active | reserved | completed i
Binding: encounter-location-status (required)
Invariants: ele-1
physicalType 0..1 CodeableConcept The physical type of the location (usually the level in the location hierachy - bed room ward etc.) i
Binding: location-physical-type (example)
Invariants: ele-1
period S 0..1 Period Time period during which the patient was at location
Invariants: ele-1
serviceProvider S 0..1 Reference(Organization Profile) The organization providing the service i
Invariants: ele-1
id 0..1 http://hl7.org/fhirpath/System.String Unique id for inter-element referencing
extension 0..* Extension Additional content defined by implementations i
Slicing: value:url (open)
Invariants: ele-1, ext-1
reference 0..1 string Literal reference, Relative, internal or absolute URL i
Invariants: ele-1
type 0..1 uri Type the reference refers to (e.g. "Patient") i
Binding: resource-types (extensible)
Invariants: ele-1
identifier S 0..1 Identifier Nexus EMR organization identifier reference i
Invariants: ele-1
display 0..1 string Text alternative for the resource i
Invariants: ele-1
partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of i
Invariants: ele-1