US Public Health Profiles Library
​2.0.0 - United States of America flag

US Public Health Profiles Library, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ph-library/ and changes regularly. See the Directory of published versions

Resource Profile: US Public Health Encounter

Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-encounter Version: 2.0.0
Standards status: Trial-use Active as of 2025-10-23 Maturity Level: 3 Computable Name: USPublicHealthEncounter
Other Identifiers: OID:2.16.840.1.113883.4.642.40.58.42.23

This profile represents the encounter related to a public health event.

It is based on the US Core Encounter profile and further constrains it as follows:

Represented USCDI+ Data Elements

Use Case Data Class Data Element Name
Case Reporting Intake Assessment Chief Complaint
Case Reporting Encounter Information Admission Date/Time
Case Reporting Encounter Information Encounter Diagnosis
Case Reporting Encounter Information Encounter Disposition
Case Reporting Encounter Information Encounter Identifier
Case Reporting Encounter Information Encounter Location
Case Reporting Encounter Information Encounter Status
Case Reporting Encounter Information Encounter Type
Case Reporting Patient Demographics Reason for the Encounter

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* USCoreEncounterProfile(6.1.0) US Public Health Encounter
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier SΣ 0..* Identifier (USCDI+) Encounter Identifier
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system SΣ 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string (USCDI) The value that is unique
Example General: 123456
... class SΣ 1..1 Coding (USCDI) Classification of patient encounter
Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
... type SΣ 1..* CodeableConcept (USCDI+) Encounter Type
Binding: USCoreEncounterType (6.1.0) (extensible): Valueset to describe the Encounter Type
... subject SΣ 1..1 Reference(US Public Health Patient(2.0.0) | US Core Patient Profile(6.1.0)) (USCDI) The patient or group present at the encounter
... Slices for participant SΣ 0..* BackboneElement (USCDI) List of participants involved in the encounter
Slice: Unordered, Open by type:type
.... participant:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... type SΣ 0..* CodeableConcept (USCDI) Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
..... period S 0..1 Period (USCDI) Period of time during the encounter that the participant participated
..... individual SΣ 0..1 Reference(US Core Practitioner Profile(6.1.0) S | US Core PractitionerRole Profile(6.1.0) | US Core RelatedPerson Profile(6.1.0)) (USCDI) Persons involved in the encounter other than the patient
.... participant:responsibleProvider SΣ 0..1 BackboneElement Responsible provider
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... type SΣ 1..1 CodeableConcept (USCDI) Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ATND
....... display 0..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
..... period S 0..1 Period (USCDI) Period of time during the encounter that the participant participated
..... individual SΣ 1..1 Reference(US Public Health PractitionerRole(2.0.0)) (USCDI) Persons involved in the encounter other than the patient
... period S 0..1 Period (USCDI) The start and end time of the encounter
.... start ΣC 0..1 dateTime (USCDI+) Admission Date/Time (Visit Start Date/Time)
.... end ΣC 0..1 dateTime Discharge Date/Time (Visit End Date/Time)
... reasonCode SΣ 0..* CodeableConcept (USCDI+) Reason for the Encounter
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
... Slices for reasonReference SΣ 0..* Reference(US Core Condition Problems and Health Concerns Profile(6.1.0) S | US Core Condition Encounter Diagnosis Profile(6.1.0) S | US Core Procedure Profile(6.1.0) | Observation | ImmunizationRecommendation) (USCDI+) Reason for the Encounter
Slice: Unordered, Open by profile:$this.resolve()
.... reasonReference:chiefComplaint SΣ 0..1 Reference(US Public Health Chief Complaint Observation(2.0.0)) (USCDI+) Chief Complaint
... diagnosis SΣ 0..* BackboneElement (USCDI+) Encounter Diagnosis, (USCDI+) Chief Complaint (when diagnosis.use='CC')
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... condition SΣ 1..1 Reference(US Public Health Condition Encounter Diagnosis(2.0.0)) The diagnosis or procedure relevant to the encounter
.... use S 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.
... hospitalization S 0..1 BackboneElement (USCDI) Details about the admission to a healthcare service
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... dischargeDisposition S 0..1 CodeableConcept (USCDI+) Encounter Disposition
Binding: USCoreDischargeDisposition (6.1.0) (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17
... location S 1..* BackboneElement (USCDI) List of locations where the patient has been
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... location S 1..1 Reference(US Public Health Location(2.0.0)) (USCDI+) Encounter Location
... serviceProvider S 0..1 Reference(US Public Health Organization(2.0.0)) (USCDI) The organization (facility) responsible for this encounter

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base extensible ActEncounterCode 📍3.0.0 THO v6.5
Encounter.type Base extensible US Core Encounter Type 📍6.1.0 US Core v6.1
Encounter.participant.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Encounter.participant:responsibleProvider.​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.​dischargeDisposition Base preferred US Core Discharge Disposition 📍6.1.0 US Core v6.1

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 Encounter.implicitRules, Encounter.modifierExtension, Encounter.identifier, Encounter.identifier.use, Encounter.identifier.system, Encounter.identifier.value, Encounter.status, Encounter.class, Encounter.type, Encounter.subject, Encounter.participant, Encounter.participant.modifierExtension, Encounter.participant.type, Encounter.participant.period, Encounter.participant.individual, Encounter.participant:responsibleProvider, Encounter.participant:responsibleProvider.modifierExtension, Encounter.participant:responsibleProvider.type, Encounter.participant:responsibleProvider.period, Encounter.participant:responsibleProvider.individual, Encounter.period, Encounter.period.start, Encounter.period.end, Encounter.reasonCode, Encounter.reasonReference, Encounter.reasonReference:chiefComplaint, Encounter.diagnosis, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition, Encounter.diagnosis.use, Encounter.hospitalization, Encounter.hospitalization.modifierExtension, Encounter.hospitalization.dischargeDisposition, Encounter.location, Encounter.location.modifierExtension, Encounter.location.location, Encounter.serviceProvider All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Encounter.modifierExtension, Encounter.participant.modifierExtension, Encounter.participant:responsibleProvider.modifierExtension, Encounter.diagnosis.modifierExtension, Encounter.hospitalization.modifierExtension, Encounter.location.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* USCoreEncounterProfile(6.1.0) US Public Health Encounter
... identifier 0..* Identifier (USCDI+) Encounter Identifier
... status 1..1 code (USCDI+) Encounter Status
... type 1..* CodeableConcept (USCDI+) Encounter Type
... Slices for participant 0..* BackboneElement (USCDI) List of participants involved in the encounter
Slice: Unordered, Open by type:type
.... participant:responsibleProvider S 0..1 BackboneElement Responsible provider
..... type 1..1 CodeableConcept (USCDI) Role of participant in encounter
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ATND
..... individual 1..1 Reference(US Public Health PractitionerRole(2.0.0)) (USCDI) Persons involved in the encounter other than the patient
... period
.... start 0..1 dateTime (USCDI+) Admission Date/Time (Visit Start Date/Time)
.... end 0..1 dateTime Discharge Date/Time (Visit End Date/Time)
... reasonCode 0..* CodeableConcept (USCDI+) Reason for the Encounter
... Slices for reasonReference 0..* Reference(US Core Condition Problems and Health Concerns Profile(6.1.0) | US Core Condition Encounter Diagnosis Profile(6.1.0) | US Core Procedure Profile(6.1.0) | Observation | ImmunizationRecommendation) (USCDI+) Reason for the Encounter
Slice: Unordered, Open by profile:$this.resolve()
.... reasonReference:chiefComplaint S 0..1 Reference(US Public Health Chief Complaint Observation(2.0.0)) (USCDI+) Chief Complaint
... diagnosis S 0..* BackboneElement (USCDI+) Encounter Diagnosis, (USCDI+) Chief Complaint (when diagnosis.use='CC')
.... condition S 1..1 Reference(US Public Health Condition Encounter Diagnosis(2.0.0)) The diagnosis or procedure relevant to the encounter
.... use S 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
... hospitalization
.... dischargeDisposition 0..1 CodeableConcept (USCDI+) Encounter Disposition
... location 1..* BackboneElement (USCDI) List of locations where the patient has been
.... location 1..1 Reference(US Public Health Location(2.0.0)) (USCDI+) Encounter Location
... serviceProvider 0..1 Reference(US Public Health Organization(2.0.0)) (USCDI) The organization (facility) responsible for this encounter

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* USCoreEncounterProfile(6.1.0) US Public Health Encounter
... 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
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
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier SΣ 0..* Identifier (USCDI+) Encounter Identifier
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system SΣ 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string (USCDI) The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code (USCDI+) Encounter Status
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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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 (USCDI) Classification of patient encounter
Binding: ActEncounterCode (3.0.0) (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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
.... period 1..1 Period The time that the episode was in the specified class
... type SΣ 1..* CodeableConcept (USCDI+) Encounter Type
Binding: USCoreEncounterType (6.1.0) (extensible): Valueset to describe the Encounter Type
... serviceType Σ 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter.
... subject SΣ 1..1 Reference(US Public Health Patient(2.0.0) | US Core Patient Profile(6.1.0)) (USCDI) 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
... Slices for participant SΣ 0..* BackboneElement (USCDI) List of participants involved in the encounter
Slice: Unordered, Open by type:type
.... participant:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... type SΣ 0..* CodeableConcept (USCDI) Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
..... period S 0..1 Period (USCDI) Period of time during the encounter that the participant participated
..... individual SΣ 0..1 Reference(US Core Practitioner Profile(6.1.0) S | US Core PractitionerRole Profile(6.1.0) | US Core RelatedPerson Profile(6.1.0)) (USCDI) Persons involved in the encounter other than the patient
.... participant:responsibleProvider SΣ 0..1 BackboneElement Responsible provider
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... type SΣ 1..1 CodeableConcept (USCDI) Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ATND
....... display 0..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
..... period S 0..1 Period (USCDI) Period of time during the encounter that the participant participated
..... individual SΣ 1..1 Reference(US Public Health PractitionerRole(2.0.0)) (USCDI) Persons involved in the encounter other than the patient
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
... period S 0..1 Period (USCDI) 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
Constraints: ext-1
.... start ΣC 0..1 dateTime (USCDI+) Admission Date/Time (Visit Start Date/Time)
.... end ΣC 0..1 dateTime Discharge Date/Time (Visit End Date/Time)
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... reasonCode SΣ 0..* CodeableConcept (USCDI+) Reason for the Encounter
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
... Slices for reasonReference SΣ 0..* Reference(US Core Condition Problems and Health Concerns Profile(6.1.0) S | US Core Condition Encounter Diagnosis Profile(6.1.0) S | US Core Procedure Profile(6.1.0) | Observation | ImmunizationRecommendation) (USCDI+) Reason for the Encounter
Slice: Unordered, Open by profile:$this.resolve()
.... reasonReference:chiefComplaint SΣ 0..1 Reference(US Public Health Chief Complaint Observation(2.0.0)) (USCDI+) Chief Complaint
... diagnosis SΣ 0..* BackboneElement (USCDI+) Encounter Diagnosis, (USCDI+) Chief Complaint (when diagnosis.use='CC')
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... condition SΣ 1..1 Reference(US Public Health Condition Encounter Diagnosis(2.0.0)) The diagnosis or procedure relevant to the encounter
.... use S 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 (USCDI) 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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: Hl7VSReAdmissionIndicator (2.0.0) (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 S 0..1 CodeableConcept (USCDI+) Encounter Disposition
Binding: USCoreDischargeDisposition (6.1.0) (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17
... location S 1..* BackboneElement (USCDI) 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... location S 1..1 Reference(US Public Health Location(2.0.0)) (USCDI+) Encounter Location
.... 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 0..1 Reference(US Public Health Organization(2.0.0)) (USCDI) 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

Path Status Usage ValueSet Version Source
Encounter.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Encounter.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.identifier.​type Base extensible IdentifierType 📍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 v6.5
Encounter.classHistory.​class Base extensible ActEncounterCode 📍3.0.0 THO v6.5
Encounter.type Base extensible US Core Encounter Type 📍6.1.0 US Core v6.1
Encounter.serviceType Base example Service type 📍4.0.1 FHIR Std.
Encounter.priority Base example ActPriority 📍3.0.0 THO v6.5
Encounter.participant.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Encounter.participant:responsibleProvider.​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 v6.5
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 preferred US Core Discharge Disposition 📍6.1.0 US Core v6.1
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 Encounter.meta, Encounter.implicitRules, Encounter.language, Encounter.text, Encounter.extension, Encounter.modifierExtension, Encounter.identifier, Encounter.identifier.extension, Encounter.identifier.use, Encounter.identifier.type, Encounter.identifier.system, Encounter.identifier.value, Encounter.identifier.period, Encounter.identifier.assigner, Encounter.status, Encounter.statusHistory, Encounter.statusHistory.extension, Encounter.statusHistory.modifierExtension, Encounter.statusHistory.status, Encounter.statusHistory.period, Encounter.class, Encounter.classHistory, Encounter.classHistory.extension, Encounter.classHistory.modifierExtension, Encounter.classHistory.class, Encounter.classHistory.period, Encounter.type, Encounter.serviceType, Encounter.priority, Encounter.subject, Encounter.episodeOfCare, Encounter.basedOn, Encounter.participant, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant.type, Encounter.participant.period, Encounter.participant.individual, Encounter.participant:responsibleProvider, Encounter.participant:responsibleProvider.extension, Encounter.participant:responsibleProvider.modifierExtension, Encounter.participant:responsibleProvider.type, Encounter.participant:responsibleProvider.period, Encounter.participant:responsibleProvider.individual, Encounter.appointment, Encounter.period, Encounter.period.extension, Encounter.period.start, Encounter.period.end, Encounter.length, Encounter.reasonCode, Encounter.reasonReference, Encounter.reasonReference:chiefComplaint, Encounter.diagnosis, Encounter.diagnosis.extension, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition, Encounter.diagnosis.use, Encounter.diagnosis.rank, Encounter.account, Encounter.hospitalization, Encounter.hospitalization.extension, Encounter.hospitalization.modifierExtension, Encounter.hospitalization.preAdmissionIdentifier, Encounter.hospitalization.origin, Encounter.hospitalization.admitSource, Encounter.hospitalization.reAdmission, Encounter.hospitalization.dietPreference, Encounter.hospitalization.specialCourtesy, Encounter.hospitalization.specialArrangement, Encounter.hospitalization.destination, Encounter.hospitalization.dischargeDisposition, Encounter.location, Encounter.location.extension, Encounter.location.modifierExtension, Encounter.location.location, Encounter.location.status, Encounter.location.physicalType, Encounter.location.period, Encounter.serviceProvider, Encounter.partOf All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Encounter.extension, Encounter.modifierExtension, Encounter.identifier.extension, Encounter.statusHistory.extension, Encounter.statusHistory.modifierExtension, Encounter.classHistory.extension, Encounter.classHistory.modifierExtension, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant:responsibleProvider.extension, Encounter.participant:responsibleProvider.modifierExtension, Encounter.period.extension, Encounter.diagnosis.extension, Encounter.diagnosis.modifierExtension, Encounter.hospitalization.extension, Encounter.hospitalization.modifierExtension, Encounter.location.extension, Encounter.location.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* USCoreEncounterProfile(6.1.0) US Public Health Encounter
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier SΣ 0..* Identifier (USCDI+) Encounter Identifier
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system SΣ 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string (USCDI) The value that is unique
Example General: 123456
... class SΣ 1..1 Coding (USCDI) Classification of patient encounter
Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
... type SΣ 1..* CodeableConcept (USCDI+) Encounter Type
Binding: USCoreEncounterType (6.1.0) (extensible): Valueset to describe the Encounter Type
... subject SΣ 1..1 Reference(US Public Health Patient(2.0.0) | US Core Patient Profile(6.1.0)) (USCDI) The patient or group present at the encounter
... Slices for participant SΣ 0..* BackboneElement (USCDI) List of participants involved in the encounter
Slice: Unordered, Open by type:type
.... participant:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... type SΣ 0..* CodeableConcept (USCDI) Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
..... period S 0..1 Period (USCDI) Period of time during the encounter that the participant participated
..... individual SΣ 0..1 Reference(US Core Practitioner Profile(6.1.0) S | US Core PractitionerRole Profile(6.1.0) | US Core RelatedPerson Profile(6.1.0)) (USCDI) Persons involved in the encounter other than the patient
.... participant:responsibleProvider SΣ 0..1 BackboneElement Responsible provider
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... type SΣ 1..1 CodeableConcept (USCDI) Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ATND
....... display 0..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
..... period S 0..1 Period (USCDI) Period of time during the encounter that the participant participated
..... individual SΣ 1..1 Reference(US Public Health PractitionerRole(2.0.0)) (USCDI) Persons involved in the encounter other than the patient
... period S 0..1 Period (USCDI) The start and end time of the encounter
.... start ΣC 0..1 dateTime (USCDI+) Admission Date/Time (Visit Start Date/Time)
.... end ΣC 0..1 dateTime Discharge Date/Time (Visit End Date/Time)
... reasonCode SΣ 0..* CodeableConcept (USCDI+) Reason for the Encounter
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
... Slices for reasonReference SΣ 0..* Reference(US Core Condition Problems and Health Concerns Profile(6.1.0) S | US Core Condition Encounter Diagnosis Profile(6.1.0) S | US Core Procedure Profile(6.1.0) | Observation | ImmunizationRecommendation) (USCDI+) Reason for the Encounter
Slice: Unordered, Open by profile:$this.resolve()
.... reasonReference:chiefComplaint SΣ 0..1 Reference(US Public Health Chief Complaint Observation(2.0.0)) (USCDI+) Chief Complaint
... diagnosis SΣ 0..* BackboneElement (USCDI+) Encounter Diagnosis, (USCDI+) Chief Complaint (when diagnosis.use='CC')
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... condition SΣ 1..1 Reference(US Public Health Condition Encounter Diagnosis(2.0.0)) The diagnosis or procedure relevant to the encounter
.... use S 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.
... hospitalization S 0..1 BackboneElement (USCDI) Details about the admission to a healthcare service
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... dischargeDisposition S 0..1 CodeableConcept (USCDI+) Encounter Disposition
Binding: USCoreDischargeDisposition (6.1.0) (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17
... location S 1..* BackboneElement (USCDI) List of locations where the patient has been
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... location S 1..1 Reference(US Public Health Location(2.0.0)) (USCDI+) Encounter Location
... serviceProvider S 0..1 Reference(US Public Health Organization(2.0.0)) (USCDI) The organization (facility) responsible for this encounter

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base extensible ActEncounterCode 📍3.0.0 THO v6.5
Encounter.type Base extensible US Core Encounter Type 📍6.1.0 US Core v6.1
Encounter.participant.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Encounter.participant:responsibleProvider.​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.​dischargeDisposition Base preferred US Core Discharge Disposition 📍6.1.0 US Core v6.1

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 Encounter.implicitRules, Encounter.modifierExtension, Encounter.identifier, Encounter.identifier.use, Encounter.identifier.system, Encounter.identifier.value, Encounter.status, Encounter.class, Encounter.type, Encounter.subject, Encounter.participant, Encounter.participant.modifierExtension, Encounter.participant.type, Encounter.participant.period, Encounter.participant.individual, Encounter.participant:responsibleProvider, Encounter.participant:responsibleProvider.modifierExtension, Encounter.participant:responsibleProvider.type, Encounter.participant:responsibleProvider.period, Encounter.participant:responsibleProvider.individual, Encounter.period, Encounter.period.start, Encounter.period.end, Encounter.reasonCode, Encounter.reasonReference, Encounter.reasonReference:chiefComplaint, Encounter.diagnosis, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition, Encounter.diagnosis.use, Encounter.hospitalization, Encounter.hospitalization.modifierExtension, Encounter.hospitalization.dischargeDisposition, Encounter.location, Encounter.location.modifierExtension, Encounter.location.location, Encounter.serviceProvider All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Encounter.modifierExtension, Encounter.participant.modifierExtension, Encounter.participant:responsibleProvider.modifierExtension, Encounter.diagnosis.modifierExtension, Encounter.hospitalization.modifierExtension, Encounter.location.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* USCoreEncounterProfile(6.1.0) US Public Health Encounter
... identifier 0..* Identifier (USCDI+) Encounter Identifier
... status 1..1 code (USCDI+) Encounter Status
... type 1..* CodeableConcept (USCDI+) Encounter Type
... Slices for participant 0..* BackboneElement (USCDI) List of participants involved in the encounter
Slice: Unordered, Open by type:type
.... participant:responsibleProvider S 0..1 BackboneElement Responsible provider
..... type 1..1 CodeableConcept (USCDI) Role of participant in encounter
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ATND
..... individual 1..1 Reference(US Public Health PractitionerRole(2.0.0)) (USCDI) Persons involved in the encounter other than the patient
... period
.... start 0..1 dateTime (USCDI+) Admission Date/Time (Visit Start Date/Time)
.... end 0..1 dateTime Discharge Date/Time (Visit End Date/Time)
... reasonCode 0..* CodeableConcept (USCDI+) Reason for the Encounter
... Slices for reasonReference 0..* Reference(US Core Condition Problems and Health Concerns Profile(6.1.0) | US Core Condition Encounter Diagnosis Profile(6.1.0) | US Core Procedure Profile(6.1.0) | Observation | ImmunizationRecommendation) (USCDI+) Reason for the Encounter
Slice: Unordered, Open by profile:$this.resolve()
.... reasonReference:chiefComplaint S 0..1 Reference(US Public Health Chief Complaint Observation(2.0.0)) (USCDI+) Chief Complaint
... diagnosis S 0..* BackboneElement (USCDI+) Encounter Diagnosis, (USCDI+) Chief Complaint (when diagnosis.use='CC')
.... condition S 1..1 Reference(US Public Health Condition Encounter Diagnosis(2.0.0)) The diagnosis or procedure relevant to the encounter
.... use S 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
... hospitalization
.... dischargeDisposition 0..1 CodeableConcept (USCDI+) Encounter Disposition
... location 1..* BackboneElement (USCDI) List of locations where the patient has been
.... location 1..1 Reference(US Public Health Location(2.0.0)) (USCDI+) Encounter Location
... serviceProvider 0..1 Reference(US Public Health Organization(2.0.0)) (USCDI) The organization (facility) responsible for this encounter

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* USCoreEncounterProfile(6.1.0) US Public Health Encounter
... 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
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
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier SΣ 0..* Identifier (USCDI+) Encounter Identifier
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system SΣ 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string (USCDI) The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code (USCDI+) Encounter Status
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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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 (USCDI) Classification of patient encounter
Binding: ActEncounterCode (3.0.0) (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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
.... period 1..1 Period The time that the episode was in the specified class
... type SΣ 1..* CodeableConcept (USCDI+) Encounter Type
Binding: USCoreEncounterType (6.1.0) (extensible): Valueset to describe the Encounter Type
... serviceType Σ 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter.
... subject SΣ 1..1 Reference(US Public Health Patient(2.0.0) | US Core Patient Profile(6.1.0)) (USCDI) 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
... Slices for participant SΣ 0..* BackboneElement (USCDI) List of participants involved in the encounter
Slice: Unordered, Open by type:type
.... participant:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... type SΣ 0..* CodeableConcept (USCDI) Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
..... period S 0..1 Period (USCDI) Period of time during the encounter that the participant participated
..... individual SΣ 0..1 Reference(US Core Practitioner Profile(6.1.0) S | US Core PractitionerRole Profile(6.1.0) | US Core RelatedPerson Profile(6.1.0)) (USCDI) Persons involved in the encounter other than the patient
.... participant:responsibleProvider SΣ 0..1 BackboneElement Responsible provider
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... type SΣ 1..1 CodeableConcept (USCDI) Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ATND
....... display 0..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
..... period S 0..1 Period (USCDI) Period of time during the encounter that the participant participated
..... individual SΣ 1..1 Reference(US Public Health PractitionerRole(2.0.0)) (USCDI) Persons involved in the encounter other than the patient
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
... period S 0..1 Period (USCDI) 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
Constraints: ext-1
.... start ΣC 0..1 dateTime (USCDI+) Admission Date/Time (Visit Start Date/Time)
.... end ΣC 0..1 dateTime Discharge Date/Time (Visit End Date/Time)
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... reasonCode SΣ 0..* CodeableConcept (USCDI+) Reason for the Encounter
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
... Slices for reasonReference SΣ 0..* Reference(US Core Condition Problems and Health Concerns Profile(6.1.0) S | US Core Condition Encounter Diagnosis Profile(6.1.0) S | US Core Procedure Profile(6.1.0) | Observation | ImmunizationRecommendation) (USCDI+) Reason for the Encounter
Slice: Unordered, Open by profile:$this.resolve()
.... reasonReference:chiefComplaint SΣ 0..1 Reference(US Public Health Chief Complaint Observation(2.0.0)) (USCDI+) Chief Complaint
... diagnosis SΣ 0..* BackboneElement (USCDI+) Encounter Diagnosis, (USCDI+) Chief Complaint (when diagnosis.use='CC')
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... condition SΣ 1..1 Reference(US Public Health Condition Encounter Diagnosis(2.0.0)) The diagnosis or procedure relevant to the encounter
.... use S 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 (USCDI) 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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: Hl7VSReAdmissionIndicator (2.0.0) (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 S 0..1 CodeableConcept (USCDI+) Encounter Disposition
Binding: USCoreDischargeDisposition (6.1.0) (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17
... location S 1..* BackboneElement (USCDI) 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... location S 1..1 Reference(US Public Health Location(2.0.0)) (USCDI+) Encounter Location
.... 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 0..1 Reference(US Public Health Organization(2.0.0)) (USCDI) 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

Path Status Usage ValueSet Version Source
Encounter.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Encounter.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.identifier.​type Base extensible IdentifierType 📍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 v6.5
Encounter.classHistory.​class Base extensible ActEncounterCode 📍3.0.0 THO v6.5
Encounter.type Base extensible US Core Encounter Type 📍6.1.0 US Core v6.1
Encounter.serviceType Base example Service type 📍4.0.1 FHIR Std.
Encounter.priority Base example ActPriority 📍3.0.0 THO v6.5
Encounter.participant.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Encounter.participant:responsibleProvider.​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 v6.5
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 preferred US Core Discharge Disposition 📍6.1.0 US Core v6.1
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 Encounter.meta, Encounter.implicitRules, Encounter.language, Encounter.text, Encounter.extension, Encounter.modifierExtension, Encounter.identifier, Encounter.identifier.extension, Encounter.identifier.use, Encounter.identifier.type, Encounter.identifier.system, Encounter.identifier.value, Encounter.identifier.period, Encounter.identifier.assigner, Encounter.status, Encounter.statusHistory, Encounter.statusHistory.extension, Encounter.statusHistory.modifierExtension, Encounter.statusHistory.status, Encounter.statusHistory.period, Encounter.class, Encounter.classHistory, Encounter.classHistory.extension, Encounter.classHistory.modifierExtension, Encounter.classHistory.class, Encounter.classHistory.period, Encounter.type, Encounter.serviceType, Encounter.priority, Encounter.subject, Encounter.episodeOfCare, Encounter.basedOn, Encounter.participant, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant.type, Encounter.participant.period, Encounter.participant.individual, Encounter.participant:responsibleProvider, Encounter.participant:responsibleProvider.extension, Encounter.participant:responsibleProvider.modifierExtension, Encounter.participant:responsibleProvider.type, Encounter.participant:responsibleProvider.period, Encounter.participant:responsibleProvider.individual, Encounter.appointment, Encounter.period, Encounter.period.extension, Encounter.period.start, Encounter.period.end, Encounter.length, Encounter.reasonCode, Encounter.reasonReference, Encounter.reasonReference:chiefComplaint, Encounter.diagnosis, Encounter.diagnosis.extension, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition, Encounter.diagnosis.use, Encounter.diagnosis.rank, Encounter.account, Encounter.hospitalization, Encounter.hospitalization.extension, Encounter.hospitalization.modifierExtension, Encounter.hospitalization.preAdmissionIdentifier, Encounter.hospitalization.origin, Encounter.hospitalization.admitSource, Encounter.hospitalization.reAdmission, Encounter.hospitalization.dietPreference, Encounter.hospitalization.specialCourtesy, Encounter.hospitalization.specialArrangement, Encounter.hospitalization.destination, Encounter.hospitalization.dischargeDisposition, Encounter.location, Encounter.location.extension, Encounter.location.modifierExtension, Encounter.location.location, Encounter.location.status, Encounter.location.physicalType, Encounter.location.period, Encounter.serviceProvider, Encounter.partOf All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Encounter.extension, Encounter.modifierExtension, Encounter.identifier.extension, Encounter.statusHistory.extension, Encounter.statusHistory.modifierExtension, Encounter.classHistory.extension, Encounter.classHistory.modifierExtension, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant:responsibleProvider.extension, Encounter.participant:responsibleProvider.modifierExtension, Encounter.period.extension, Encounter.diagnosis.extension, Encounter.diagnosis.modifierExtension, Encounter.hospitalization.extension, Encounter.hospitalization.modifierExtension, Encounter.location.extension, Encounter.location.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron