US Core Implementation Guide
10.0.0-ballot - STU 10 Ballot United States of America flag

US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 10.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions

Resource Profile: US Core Encounter Profile

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter Version: 10.0.0-ballot
Standards status: Trial-use Maturity Level: 5 Computable Name: USCoreEncounterProfile
Other Identifiers: OID:2.16.840.1.113883.4.642.40.2.42.24

The US Core Encounter Profile inherits from the FHIR Encounter resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the Encounter resource to record, search, and fetch basic encounter information for an individual patient. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

US Core Maturity: 5

Example Usage Scenarios:

The following are example usage scenarios for this profile:

  • Query for a specific patient encounter
  • Query for recent patient encounters
  • Record or update an encounter

Mandatory and Must Support Data Elements

The following data elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.

Each Encounter Must Have:

  1. A status
  2. A classification such as inpatient, outpatient, or emergency
  3. An encounter type
  4. A patient

Each Encounter Must Support:

  1. A timestamp when the resource last changed1
  2. An encounter identifier
  3. Providers involved in the encounter
  4. When the encounter occurred
  5. Reason for the visit
  6. The discharge disposition
  7. Where the encounter occurred

Additional USCDI Requirements:

These Additional USCDI Requirements elements are not Mandatory or Must Support but are required for ONC Health IT certification testing and are included in the formal definition of the profile and the Encounter examples.

  1. Interpreter Needed flag2
  2. The appointment that scheduled the encounter

1,2 see guidance below

Profile Specific Implementation Guidance

This section provides detailed implementation guidance for the US Core Profile to support implementation and certification.

  • To search for an encounter diagnosis, query for Condition resources that reference the Encounter of interest and have a category of encounter-diagnosis. An example search is shown in the Condition Quick Start section.
  • The Encounter resource can represent a reason using a code with Encounter.reasonCode or a reference with Encounter.reasonReference to Condition or other resources.
    • Although both are marked as Must Support, Servers are not required to support both a code and a reference, but they SHALL support at least one of these elements.§
    • The Client application SHALL support both elements.§,§
    • If Encounter.reasonReference references an Observation, it SHOULD conform to a US Core Observation if applicable.§ For example, a laboratory result SHOULD conform to the US Core Laboratory Result Observation Profile.
  • This profile supports where the encounter occurred. The location address can be represented by the Location referenced by Encounter.location.location or indirectly through the Organization referenced by Encounter.serviceProvider.
    • Although both are marked as Must Support, Servers are not required to support both Encounter.location.location and Encounter.serviceProvider, but they SHALL support at least one of these elements.§
    • The Client application SHALL support both elements.§,§
  • The following US Core Profiles indirectly reference the location/facility through references to US Core Encounter:

    If the event facility/location differs from the Encounter.location, systems SHOULD reference it directly:§

    • Systems SHALL use the location element for all resources where the element is available.§
    • Systems MAY use the standard Event Location Extension for US Core DiagnosticReport Profile for Laboratory Results Reporting and US Core Observation Clinical Result Profile.§
  • 2Servers SHOULD and Certifying Systems SHALL use the US Core Interpreter Needed Extension on this profile or the US Core Patient Profile to communicate whether a patient needs an interpreter.§,§
    • Although the extension is marked as an Additional USCDI Requirements on both US Core Patient and US Core Encounter Profiles, Certifying Systems are not required to support the extension on both profiles, but SHALL support the extension on at least one.§ The certifying Client application SHALL support the extension on both profiles.§
    • Systems SHOULD designate the patient's preferred language in the Patient.communication.preferred element.§
  • 1See the US Core General Guidance page for Searching Using lastUpdated. Updates to .meta.lastUpdated SHOULD reflect:
    • New encounters/visits§
    • Changes in the status of encounters, including events that trigger the same status (e.g., in-progress → in-progress).§ These status changes correspond to events that can initiate HL7 V2 ADT messages.
  • For the USCDI Adverse Events Data Class, Encounter.hospitalization.dischargeDisposition records an outcome such as hospitalization or death, which can be what the USCDI Adverse Event Outcome describes. Adverse events are recorded as ordinary clinical events and are not tagged as adverse events; see the Adverse Events: Clinical Records and Patient Safety Reporting page.

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 9.0.0:

  • The data elements list has changed
  • Formal Views of Profile Content

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

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Encounter 0..* Encounter An interaction during which services are provided to the patient
    Encounter.meta This element must be supported. This element is included in summaries. 0..1 Meta Metadata about the resource
    Encounter.meta.lastUpdated This element must be supported. This element is included in summaries. 0..1 instant When the resource last changed
    Encounter.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Encounter.Slices for extension Content/Rules for all slices
    Encounter.Slices for extension.extension:interpreterRequired 0..1 Coding 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Whether the patient needs an interpreter
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed
    Binding: Answer Set with Yes No and Unknowns (required): Answer Set with Yes No and Unknowns
    Encounter.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Encounter.identifier This element must be supported. This element is included in summaries. 0..* Identifier Identifier(s) by which this encounter is known
    Encounter.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    Encounter.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    Encounter.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
    Example General: 123456
    Encounter.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
    Binding: EncounterStatus (required): Current state of the encounter.
    Encounter.class This element must be supported. This element is included in summaries. 1..1 Coding Classification of patient encounter
    Binding: ActEncounterCode (extensible): Classification of the encounter.
    Encounter.type This element must be supported. This element is included in summaries. 1..* CodeableConcept Specific type of encounter
    Binding: Encounter Type (extensible): Valueset to describe the Encounter Type
    Encounter.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile This type must be supported. | Group) The patient or group present at the encounter
    Encounter.participant This element must be supported. This element is included in summaries. 0..* BackboneElement List of participants involved in the encounter
    Encounter.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Encounter.participant.type This element must be supported. This element is included in summaries. 0..* CodeableConcept Role of participant in encounter
    Binding: ParticipantType (extensible): Role of participant in encounter.
    Encounter.participant.period This element must be supported. 0..1 Period Period of time during the encounter that the participant participated
    Encounter.participant.individual This element must be supported. This element is included in summaries. 0..1 Reference(US Core Practitioner Profile This type must be supported. | US Core PractitionerRole Profile | US Core RelatedPerson Profile) Persons involved in the encounter other than the patient
    Encounter.appointment This element is included in summaries. 0..* Reference(US Core Appointment Profile) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The appointment that scheduled this encounter
    Encounter.period This element must be supported. 0..1 Period The start and end time of the encounter
    Encounter.reasonCode This element must be supported. This element is included in summaries. 0..* CodeableConcept Coded reason the encounter takes place
    Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
    Encounter.reasonReference This element must be supported. This element is included in summaries. 0..* Reference(US Core Condition Problems and Health Concerns Profile This type must be supported. | US Core Condition Encounter Diagnosis Profile This type must be supported. | US Core Procedure Profile | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
    Encounter.hospitalization This element must be supported. 0..1 BackboneElement Details about the admission to a healthcare service
    Encounter.hospitalization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Encounter.hospitalization.dischargeDisposition This element must be supported. 0..1 CodeableConcept Category or kind of location after discharge
    Binding: USEncounterDischargeDisposition (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17
    Encounter.location This element must be supported. 0..* BackboneElement List of locations where the patient has been
    Encounter.location.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Encounter.location.location This element must be supported. 1..1 Reference(US Core Location Profile) Location the encounter takes place
    Encounter.serviceProvider This element must be supported. 0..1 Reference(US Core Organization Profile) 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 v7.4
    Encounter.type Base extensible Encounter Type ⏿20250510 tx.fhir.org
    Encounter.participant.​type Base extensible Participant type 📍4.0.1 FHIR Std.
    Encounter.reasonCode Base preferred Encounter Reason Codes 📍4.0.1 FHIR Std.
    Encounter.hospitalization.​dischargeDisposition Base preferred USEncounterDischargeDisposition 📦5.0.0 THO v7.4

    Constraints

    Id Grade Path(s) Description Expression

    This structure is derived from Encounter

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Encounter 0..* Encounter An interaction during which services are provided to the patient
    Encounter.meta This element must be supported. 0..1 Meta Metadata about the resource
    Encounter.meta.lastUpdated This element must be supported. 0..1 instant When the resource last changed
    Encounter.Slices for extension Content/Rules for all slices
    Encounter.Slices for extension.extension:interpreterRequired 0..1 Coding 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Whether the patient needs an interpreter
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed
    Binding: Answer Set with Yes No and Unknowns (required): Answer Set with Yes No and Unknowns
    Encounter.identifier This element must be supported. 0..* Identifier Identifier(s) by which this encounter is known
    Encounter.identifier.system This element must be supported. 1..1 uri The namespace for the identifier value
    Encounter.identifier.value This element must be supported. 1..1 string The value that is unique
    Encounter.status This element must be supported. 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
    Encounter.class This element must be supported. 1..1 Coding Classification of patient encounter
    Encounter.type This element must be supported. 1..* CodeableConcept Specific type of encounter
    Binding: Encounter Type (extensible): Valueset to describe the Encounter Type
    Encounter.subject This element must be supported. 1..1 Reference(US Core Patient Profile This type must be supported. | Group) The patient or group present at the encounter
    Encounter.participant This element must be supported. 0..* BackboneElement List of participants involved in the encounter
    Encounter.participant.type This element must be supported. 0..* CodeableConcept Role of participant in encounter
    Encounter.participant.period This element must be supported. 0..1 Period Period of time during the encounter that the participant participated
    Encounter.participant.individual This element must be supported. 0..1 Reference(US Core Practitioner Profile This type must be supported. | US Core PractitionerRole Profile | US Core RelatedPerson Profile) Persons involved in the encounter other than the patient
    Encounter.appointment 0..* Reference(US Core Appointment Profile) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The appointment that scheduled this encounter
    Encounter.period This element must be supported. 0..1 Period The start and end time of the encounter
    Encounter.reasonCode This element must be supported. 0..* CodeableConcept Coded reason the encounter takes place
    Encounter.reasonReference This element must be supported. 0..* Reference(US Core Condition Problems and Health Concerns Profile This type must be supported. | US Core Condition Encounter Diagnosis Profile This type must be supported. | US Core Procedure Profile | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
    Encounter.hospitalization This element must be supported. 0..1 BackboneElement Details about the admission to a healthcare service
    Encounter.hospitalization.dischargeDisposition This element must be supported. 0..1 CodeableConcept Category or kind of location after discharge
    Binding: USEncounterDischargeDisposition (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17
    Encounter.location This element must be supported. 0..* BackboneElement List of locations where the patient has been
    Encounter.location.location This element must be supported. 1..1 Reference(US Core Location Profile) Location the encounter takes place
    Encounter.serviceProvider This element must be supported. 0..1 Reference(US Core Organization Profile) The organization (facility) responsible for this encounter

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Encounter.type Base extensible Encounter Type ⏿20250510 tx.fhir.org
    Encounter.hospitalization.​dischargeDisposition Base preferred USEncounterDischargeDisposition 📦5.0.0 THO v7.4
    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Encounter 0..* Encounter An interaction during which services are provided to the patient
    Encounter.id This element is included in summaries. 0..1 id Logical id of this artifact
    Encounter.meta This element must be supported. This element is included in summaries. 0..1 Meta Metadata about the resource
    Encounter.meta.id 0..1 string Unique id for inter-element referencing
    Encounter.meta.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Encounter.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
    Encounter.meta.lastUpdated This element must be supported. This element is included in summaries. 0..1 instant When the resource last changed
    Encounter.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
    Encounter.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
    Encounter.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
    Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
    Encounter.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
    Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
    Encounter.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Encounter.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    Encounter.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
    Encounter.contained 0..* Resource Contained, inline Resources
    Encounter.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    Encounter.Slices for extension.extension:interpreterRequired 0..1 Coding 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Whether the patient needs an interpreter
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed
    Binding: Answer Set with Yes No and Unknowns (required): Answer Set with Yes No and Unknowns
    Encounter.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Encounter.identifier This element must be supported. This element is included in summaries. 0..* Identifier Identifier(s) by which this encounter is known
    Encounter.identifier.id 0..1 string Unique id for inter-element referencing
    Encounter.identifier.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Encounter.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    Encounter.identifier.type This element is included in summaries. 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.
    Encounter.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    Encounter.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
    Example General: 123456
    Encounter.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
    Encounter.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
    Encounter.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
    Binding: EncounterStatus (required): Current state of the encounter.
    Encounter.statusHistory 0..* BackboneElement List of past encounter statuses
    Encounter.statusHistory.id 0..1 string Unique id for inter-element referencing
    Encounter.statusHistory.extension 0..* Extension Additional content defined by implementations
    Encounter.statusHistory.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Encounter.statusHistory.status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
    Binding: EncounterStatus (required): Current state of the encounter.
    Encounter.statusHistory.period 1..1 Period The time that the episode was in the specified status
    Encounter.class This element must be supported. This element is included in summaries. 1..1 Coding Classification of patient encounter
    Binding: ActEncounterCode (extensible): Classification of the encounter.
    Encounter.classHistory 0..* BackboneElement List of past encounter classes
    Encounter.classHistory.id 0..1 string Unique id for inter-element referencing
    Encounter.classHistory.extension 0..* Extension Additional content defined by implementations
    Encounter.classHistory.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Encounter.classHistory.class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
    Binding: ActEncounterCode (extensible): Classification of the encounter.
    Encounter.classHistory.period 1..1 Period The time that the episode was in the specified class
    Encounter.type This element must be supported. This element is included in summaries. 1..* CodeableConcept Specific type of encounter
    Binding: Encounter Type (extensible): Valueset to describe the Encounter Type
    Encounter.serviceType This element is included in summaries. 0..1 CodeableConcept Specific type of service
    Binding: ServiceType (example): Broad categorization of the service that is to be provided.
    Encounter.priority 0..1 CodeableConcept Indicates the urgency of the encounter
    Binding: ActPriority (example): Indicates the urgency of the encounter.
    Encounter.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile This type must be supported. | Group) The patient or group present at the encounter
    Encounter.episodeOfCare This element is included in summaries. 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
    Encounter.basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
    Encounter.participant This element must be supported. This element is included in summaries. 0..* BackboneElement List of participants involved in the encounter
    Encounter.participant.id 0..1 string Unique id for inter-element referencing
    Encounter.participant.extension 0..* Extension Additional content defined by implementations
    Encounter.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Encounter.participant.type This element must be supported. This element is included in summaries. 0..* CodeableConcept Role of participant in encounter
    Binding: ParticipantType (extensible): Role of participant in encounter.
    Encounter.participant.period This element must be supported. 0..1 Period Period of time during the encounter that the participant participated
    Encounter.participant.individual This element must be supported. This element is included in summaries. 0..1 Reference(US Core Practitioner Profile This type must be supported. | US Core PractitionerRole Profile | US Core RelatedPerson Profile) Persons involved in the encounter other than the patient
    Encounter.appointment This element is included in summaries. 0..* Reference(US Core Appointment Profile) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The appointment that scheduled this encounter
    Encounter.period This element must be supported. 0..1 Period The start and end time of the encounter
    Encounter.length 0..1 Duration Quantity of time the encounter lasted (less time absent)
    Encounter.reasonCode This element must be supported. This element is included in summaries. 0..* CodeableConcept Coded reason the encounter takes place
    Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
    Encounter.reasonReference This element must be supported. This element is included in summaries. 0..* Reference(US Core Condition Problems and Health Concerns Profile This type must be supported. | US Core Condition Encounter Diagnosis Profile This type must be supported. | US Core Procedure Profile | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
    Encounter.diagnosis This element is included in summaries. 0..* BackboneElement The list of diagnosis relevant to this encounter
    Encounter.diagnosis.id 0..1 string Unique id for inter-element referencing
    Encounter.diagnosis.extension 0..* Extension Additional content defined by implementations
    Encounter.diagnosis.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Encounter.diagnosis.condition This element is included in summaries. 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
    Encounter.diagnosis.use 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
    Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
    Encounter.diagnosis.rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
    Encounter.account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
    Encounter.hospitalization This element must be supported. 0..1 BackboneElement Details about the admission to a healthcare service
    Encounter.hospitalization.id 0..1 string Unique id for inter-element referencing
    Encounter.hospitalization.extension 0..* Extension Additional content defined by implementations
    Encounter.hospitalization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Encounter.hospitalization.preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
    Encounter.hospitalization.origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
    Encounter.hospitalization.admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
    Binding: AdmitSource (preferred): From where the patient was admitted.
    Encounter.hospitalization.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.
    Encounter.hospitalization.dietPreference 0..* CodeableConcept Diet preferences reported by the patient
    Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
    Encounter.hospitalization.specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
    Binding: SpecialCourtesy (preferred): Special courtesies.
    Encounter.hospitalization.specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
    Binding: SpecialArrangements (preferred): Special arrangements.
    Encounter.hospitalization.destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
    Encounter.hospitalization.dischargeDisposition This element must be supported. 0..1 CodeableConcept Category or kind of location after discharge
    Binding: USEncounterDischargeDisposition (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17
    Encounter.location This element must be supported. 0..* BackboneElement List of locations where the patient has been
    Encounter.location.id 0..1 string Unique id for inter-element referencing
    Encounter.location.extension 0..* Extension Additional content defined by implementations
    Encounter.location.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Encounter.location.location This element must be supported. 1..1 Reference(US Core Location Profile) Location the encounter takes place
    Encounter.location.status 0..1 code planned | active | reserved | completed
    Binding: EncounterLocationStatus (required): The status of the location.
    Encounter.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.
    Encounter.location.period 0..1 Period Time period during which the patient was present at the location
    Encounter.serviceProvider This element must be supported. 0..1 Reference(US Core Organization Profile) The organization (facility) responsible for this encounter
    Encounter.partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Encounter.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
    Encounter.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
    Encounter.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Encounter.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 v7.4
    Encounter.classHistory.​class Base extensible ActEncounterCode 📦3.0.0 THO v7.4
    Encounter.type Base extensible Encounter Type ⏿20250510 tx.fhir.org
    Encounter.serviceType Base example Service type 📍4.0.1 FHIR Std.
    Encounter.priority Base example ActPriority 📦3.0.0 THO v7.4
    Encounter.participant.​type Base extensible Participant type 📍4.0.1 FHIR Std.
    Encounter.reasonCode Base preferred Encounter Reason Codes 📍4.0.1 FHIR Std.
    Encounter.diagnosis.​use Base preferred DiagnosisRole 📍4.0.1 FHIR Std.
    Encounter.hospitalization.​admitSource Base preferred Admit source 📍4.0.1 FHIR Std.
    Encounter.hospitalization.​reAdmission Base example hl7VS-re-admissionIndicator 📦3.0.0 THO v7.4
    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 USEncounterDischargeDisposition 📦5.0.0 THO v7.4
    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

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Encounter 0..* Encounter An interaction during which services are provided to the patient
    Encounter.meta This element must be supported. This element is included in summaries. 0..1 Meta Metadata about the resource
    Encounter.meta.lastUpdated This element must be supported. This element is included in summaries. 0..1 instant When the resource last changed
    Encounter.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Encounter.Slices for extension Content/Rules for all slices
    Encounter.Slices for extension.extension:interpreterRequired 0..1 Coding 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Whether the patient needs an interpreter
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed
    Binding: Answer Set with Yes No and Unknowns (required): Answer Set with Yes No and Unknowns
    Encounter.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Encounter.identifier This element must be supported. This element is included in summaries. 0..* Identifier Identifier(s) by which this encounter is known
    Encounter.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    Encounter.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    Encounter.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
    Example General: 123456
    Encounter.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
    Binding: EncounterStatus (required): Current state of the encounter.
    Encounter.class This element must be supported. This element is included in summaries. 1..1 Coding Classification of patient encounter
    Binding: ActEncounterCode (extensible): Classification of the encounter.
    Encounter.type This element must be supported. This element is included in summaries. 1..* CodeableConcept Specific type of encounter
    Binding: Encounter Type (extensible): Valueset to describe the Encounter Type
    Encounter.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile This type must be supported. | Group) The patient or group present at the encounter
    Encounter.participant This element must be supported. This element is included in summaries. 0..* BackboneElement List of participants involved in the encounter
    Encounter.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Encounter.participant.type This element must be supported. This element is included in summaries. 0..* CodeableConcept Role of participant in encounter
    Binding: ParticipantType (extensible): Role of participant in encounter.
    Encounter.participant.period This element must be supported. 0..1 Period Period of time during the encounter that the participant participated
    Encounter.participant.individual This element must be supported. This element is included in summaries. 0..1 Reference(US Core Practitioner Profile This type must be supported. | US Core PractitionerRole Profile | US Core RelatedPerson Profile) Persons involved in the encounter other than the patient
    Encounter.appointment This element is included in summaries. 0..* Reference(US Core Appointment Profile) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The appointment that scheduled this encounter
    Encounter.period This element must be supported. 0..1 Period The start and end time of the encounter
    Encounter.reasonCode This element must be supported. This element is included in summaries. 0..* CodeableConcept Coded reason the encounter takes place
    Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
    Encounter.reasonReference This element must be supported. This element is included in summaries. 0..* Reference(US Core Condition Problems and Health Concerns Profile This type must be supported. | US Core Condition Encounter Diagnosis Profile This type must be supported. | US Core Procedure Profile | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
    Encounter.hospitalization This element must be supported. 0..1 BackboneElement Details about the admission to a healthcare service
    Encounter.hospitalization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Encounter.hospitalization.dischargeDisposition This element must be supported. 0..1 CodeableConcept Category or kind of location after discharge
    Binding: USEncounterDischargeDisposition (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17
    Encounter.location This element must be supported. 0..* BackboneElement List of locations where the patient has been
    Encounter.location.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Encounter.location.location This element must be supported. 1..1 Reference(US Core Location Profile) Location the encounter takes place
    Encounter.serviceProvider This element must be supported. 0..1 Reference(US Core Organization Profile) 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 v7.4
    Encounter.type Base extensible Encounter Type ⏿20250510 tx.fhir.org
    Encounter.participant.​type Base extensible Participant type 📍4.0.1 FHIR Std.
    Encounter.reasonCode Base preferred Encounter Reason Codes 📍4.0.1 FHIR Std.
    Encounter.hospitalization.​dischargeDisposition Base preferred USEncounterDischargeDisposition 📦5.0.0 THO v7.4

    Constraints

    Id Grade Path(s) Description Expression

    Differential View

    This structure is derived from Encounter

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Encounter 0..* Encounter An interaction during which services are provided to the patient
    Encounter.meta This element must be supported. 0..1 Meta Metadata about the resource
    Encounter.meta.lastUpdated This element must be supported. 0..1 instant When the resource last changed
    Encounter.Slices for extension Content/Rules for all slices
    Encounter.Slices for extension.extension:interpreterRequired 0..1 Coding 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Whether the patient needs an interpreter
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed
    Binding: Answer Set with Yes No and Unknowns (required): Answer Set with Yes No and Unknowns
    Encounter.identifier This element must be supported. 0..* Identifier Identifier(s) by which this encounter is known
    Encounter.identifier.system This element must be supported. 1..1 uri The namespace for the identifier value
    Encounter.identifier.value This element must be supported. 1..1 string The value that is unique
    Encounter.status This element must be supported. 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
    Encounter.class This element must be supported. 1..1 Coding Classification of patient encounter
    Encounter.type This element must be supported. 1..* CodeableConcept Specific type of encounter
    Binding: Encounter Type (extensible): Valueset to describe the Encounter Type
    Encounter.subject This element must be supported. 1..1 Reference(US Core Patient Profile This type must be supported. | Group) The patient or group present at the encounter
    Encounter.participant This element must be supported. 0..* BackboneElement List of participants involved in the encounter
    Encounter.participant.type This element must be supported. 0..* CodeableConcept Role of participant in encounter
    Encounter.participant.period This element must be supported. 0..1 Period Period of time during the encounter that the participant participated
    Encounter.participant.individual This element must be supported. 0..1 Reference(US Core Practitioner Profile This type must be supported. | US Core PractitionerRole Profile | US Core RelatedPerson Profile) Persons involved in the encounter other than the patient
    Encounter.appointment 0..* Reference(US Core Appointment Profile) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The appointment that scheduled this encounter
    Encounter.period This element must be supported. 0..1 Period The start and end time of the encounter
    Encounter.reasonCode This element must be supported. 0..* CodeableConcept Coded reason the encounter takes place
    Encounter.reasonReference This element must be supported. 0..* Reference(US Core Condition Problems and Health Concerns Profile This type must be supported. | US Core Condition Encounter Diagnosis Profile This type must be supported. | US Core Procedure Profile | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
    Encounter.hospitalization This element must be supported. 0..1 BackboneElement Details about the admission to a healthcare service
    Encounter.hospitalization.dischargeDisposition This element must be supported. 0..1 CodeableConcept Category or kind of location after discharge
    Binding: USEncounterDischargeDisposition (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17
    Encounter.location This element must be supported. 0..* BackboneElement List of locations where the patient has been
    Encounter.location.location This element must be supported. 1..1 Reference(US Core Location Profile) Location the encounter takes place
    Encounter.serviceProvider This element must be supported. 0..1 Reference(US Core Organization Profile) The organization (facility) responsible for this encounter

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Encounter.type Base extensible Encounter Type ⏿20250510 tx.fhir.org
    Encounter.hospitalization.​dischargeDisposition Base preferred USEncounterDischargeDisposition 📦5.0.0 THO v7.4

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Encounter 0..* Encounter An interaction during which services are provided to the patient
    Encounter.id This element is included in summaries. 0..1 id Logical id of this artifact
    Encounter.meta This element must be supported. This element is included in summaries. 0..1 Meta Metadata about the resource
    Encounter.meta.id 0..1 string Unique id for inter-element referencing
    Encounter.meta.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Encounter.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
    Encounter.meta.lastUpdated This element must be supported. This element is included in summaries. 0..1 instant When the resource last changed
    Encounter.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
    Encounter.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
    Encounter.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
    Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
    Encounter.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
    Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
    Encounter.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Encounter.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    Encounter.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
    Encounter.contained 0..* Resource Contained, inline Resources
    Encounter.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    Encounter.Slices for extension.extension:interpreterRequired 0..1 Coding 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Whether the patient needs an interpreter
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed
    Binding: Answer Set with Yes No and Unknowns (required): Answer Set with Yes No and Unknowns
    Encounter.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Encounter.identifier This element must be supported. This element is included in summaries. 0..* Identifier Identifier(s) by which this encounter is known
    Encounter.identifier.id 0..1 string Unique id for inter-element referencing
    Encounter.identifier.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Encounter.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    Encounter.identifier.type This element is included in summaries. 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.
    Encounter.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    Encounter.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
    Example General: 123456
    Encounter.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
    Encounter.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
    Encounter.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
    Binding: EncounterStatus (required): Current state of the encounter.
    Encounter.statusHistory 0..* BackboneElement List of past encounter statuses
    Encounter.statusHistory.id 0..1 string Unique id for inter-element referencing
    Encounter.statusHistory.extension 0..* Extension Additional content defined by implementations
    Encounter.statusHistory.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Encounter.statusHistory.status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
    Binding: EncounterStatus (required): Current state of the encounter.
    Encounter.statusHistory.period 1..1 Period The time that the episode was in the specified status
    Encounter.class This element must be supported. This element is included in summaries. 1..1 Coding Classification of patient encounter
    Binding: ActEncounterCode (extensible): Classification of the encounter.
    Encounter.classHistory 0..* BackboneElement List of past encounter classes
    Encounter.classHistory.id 0..1 string Unique id for inter-element referencing
    Encounter.classHistory.extension 0..* Extension Additional content defined by implementations
    Encounter.classHistory.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Encounter.classHistory.class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
    Binding: ActEncounterCode (extensible): Classification of the encounter.
    Encounter.classHistory.period 1..1 Period The time that the episode was in the specified class
    Encounter.type This element must be supported. This element is included in summaries. 1..* CodeableConcept Specific type of encounter
    Binding: Encounter Type (extensible): Valueset to describe the Encounter Type
    Encounter.serviceType This element is included in summaries. 0..1 CodeableConcept Specific type of service
    Binding: ServiceType (example): Broad categorization of the service that is to be provided.
    Encounter.priority 0..1 CodeableConcept Indicates the urgency of the encounter
    Binding: ActPriority (example): Indicates the urgency of the encounter.
    Encounter.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile This type must be supported. | Group) The patient or group present at the encounter
    Encounter.episodeOfCare This element is included in summaries. 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
    Encounter.basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
    Encounter.participant This element must be supported. This element is included in summaries. 0..* BackboneElement List of participants involved in the encounter
    Encounter.participant.id 0..1 string Unique id for inter-element referencing
    Encounter.participant.extension 0..* Extension Additional content defined by implementations
    Encounter.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Encounter.participant.type This element must be supported. This element is included in summaries. 0..* CodeableConcept Role of participant in encounter
    Binding: ParticipantType (extensible): Role of participant in encounter.
    Encounter.participant.period This element must be supported. 0..1 Period Period of time during the encounter that the participant participated
    Encounter.participant.individual This element must be supported. This element is included in summaries. 0..1 Reference(US Core Practitioner Profile This type must be supported. | US Core PractitionerRole Profile | US Core RelatedPerson Profile) Persons involved in the encounter other than the patient
    Encounter.appointment This element is included in summaries. 0..* Reference(US Core Appointment Profile) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The appointment that scheduled this encounter
    Encounter.period This element must be supported. 0..1 Period The start and end time of the encounter
    Encounter.length 0..1 Duration Quantity of time the encounter lasted (less time absent)
    Encounter.reasonCode This element must be supported. This element is included in summaries. 0..* CodeableConcept Coded reason the encounter takes place
    Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
    Encounter.reasonReference This element must be supported. This element is included in summaries. 0..* Reference(US Core Condition Problems and Health Concerns Profile This type must be supported. | US Core Condition Encounter Diagnosis Profile This type must be supported. | US Core Procedure Profile | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
    Encounter.diagnosis This element is included in summaries. 0..* BackboneElement The list of diagnosis relevant to this encounter
    Encounter.diagnosis.id 0..1 string Unique id for inter-element referencing
    Encounter.diagnosis.extension 0..* Extension Additional content defined by implementations
    Encounter.diagnosis.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Encounter.diagnosis.condition This element is included in summaries. 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
    Encounter.diagnosis.use 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
    Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
    Encounter.diagnosis.rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
    Encounter.account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
    Encounter.hospitalization This element must be supported. 0..1 BackboneElement Details about the admission to a healthcare service
    Encounter.hospitalization.id 0..1 string Unique id for inter-element referencing
    Encounter.hospitalization.extension 0..* Extension Additional content defined by implementations
    Encounter.hospitalization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Encounter.hospitalization.preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
    Encounter.hospitalization.origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
    Encounter.hospitalization.admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
    Binding: AdmitSource (preferred): From where the patient was admitted.
    Encounter.hospitalization.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.
    Encounter.hospitalization.dietPreference 0..* CodeableConcept Diet preferences reported by the patient
    Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
    Encounter.hospitalization.specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
    Binding: SpecialCourtesy (preferred): Special courtesies.
    Encounter.hospitalization.specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
    Binding: SpecialArrangements (preferred): Special arrangements.
    Encounter.hospitalization.destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
    Encounter.hospitalization.dischargeDisposition This element must be supported. 0..1 CodeableConcept Category or kind of location after discharge
    Binding: USEncounterDischargeDisposition (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17
    Encounter.location This element must be supported. 0..* BackboneElement List of locations where the patient has been
    Encounter.location.id 0..1 string Unique id for inter-element referencing
    Encounter.location.extension 0..* Extension Additional content defined by implementations
    Encounter.location.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Encounter.location.location This element must be supported. 1..1 Reference(US Core Location Profile) Location the encounter takes place
    Encounter.location.status 0..1 code planned | active | reserved | completed
    Binding: EncounterLocationStatus (required): The status of the location.
    Encounter.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.
    Encounter.location.period 0..1 Period Time period during which the patient was present at the location
    Encounter.serviceProvider This element must be supported. 0..1 Reference(US Core Organization Profile) The organization (facility) responsible for this encounter
    Encounter.partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Encounter.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
    Encounter.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
    Encounter.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Encounter.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 v7.4
    Encounter.classHistory.​class Base extensible ActEncounterCode 📦3.0.0 THO v7.4
    Encounter.type Base extensible Encounter Type ⏿20250510 tx.fhir.org
    Encounter.serviceType Base example Service type 📍4.0.1 FHIR Std.
    Encounter.priority Base example ActPriority 📦3.0.0 THO v7.4
    Encounter.participant.​type Base extensible Participant type 📍4.0.1 FHIR Std.
    Encounter.reasonCode Base preferred Encounter Reason Codes 📍4.0.1 FHIR Std.
    Encounter.diagnosis.​use Base preferred DiagnosisRole 📍4.0.1 FHIR Std.
    Encounter.hospitalization.​admitSource Base preferred Admit source 📍4.0.1 FHIR Std.
    Encounter.hospitalization.​reAdmission Base example hl7VS-re-admissionIndicator 📦3.0.0 THO v7.4
    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 USEncounterDischargeDisposition 📦5.0.0 THO v7.4
    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

     

    Other representations of profile: CSV, Excel, Schematron

    Notes:


    Quick Start


    Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the US Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only US Core Profiles (Profile Only Support) are not required to support these interactions. See the US Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.

    • See the Scopes Format section for a description of the SMART scopes syntax.
    • See the Search Syntax section for a description of the US Core search syntax.
    • See the General Requirements section for additional rules and expectations when a Server requires status parameters.
    • See the General Guidance section for additional guidance on searching for multiple patients.

    US Core Scopes

    Servers providing access to encounter data SHALL support these US Core SMART Scopes:


    Mandatory Search Parameters:

    The following search parameters and search parameter combinations SHALL be supported:

    1. SHALL support both read Encounter by id AND Encounter search using the _id search parameter

      GET [base]/Encounter?_id=[id]' or 'GET [base]/Encounter/[id]

      Examples:

      1. GET [base]/Encounter/12354

      2. GET [base]/Encounter?_id=12354

      Implementation Notes: Fetches a single US Core Encounter Profile or a search Bundle containing an US Core Encounter Profile resource matching the id (see Parameters for all resources).

    2. SHALL support searching for all encounters for a patient using the patient search parameter

      GET [base]/Encounter?patient={Patient/}[id]

      Example:

      1. GET [base]/Encounter?patient=Patient/1137192

      Implementation Notes: Fetches a bundle of all US Core Encounter Profile resources for the specified patient ( see how to search by reference).

    3. SHALL support searching for all encounters for a patient by date using the combination of the patient and date search parameters

      • Including optional support for AND search on date (e.g.date=[date]&date=[date]&...)

      • Including support for these date comparators: "gt", "lt", "ge", "le"

      GET [base]/Encounter?patient={Patient/}[id]&date={gt|lt|ge|le}[dateTime]{&date={gt|lt|ge|le}[dateTime]&...}

      Example:

      1. GET [base]/Encounter?patient=Patient/1137192&date=ge2019-01-01T00:00:00Z

      Implementation Notes: Fetches a bundle of all US Core Encounter Profile resources matching the specified date and patient ( see how to search by reference and how to search by date).

    Optional Search Parameters:

    The following search parameters and search parameter combinations SHOULD be supported

    1. SHOULD support searching for an encounter by an identifier using the identifier search parameter

      GET [base]/Encounter?identifier={system|}[search_code]

      Example:

      1. GET [base]/Encounter?identifier=http://hospital.smarthealthit.org|1032702

      Implementation Notes: Fetches a bundle containing any US Core Encounter Profile resources matching the identifier ( see how to search by token).

    2. SHOULD support searching for all encounter for a patient by encounter class using the combination of the patient and class search parameters

      GET [base]/Encounter?patient={Patient/}[id]&class={system|}[search_code]

      Example:

      1. GET [base]/Encounter?patient=Patient/1137192&class= http://terminology.hl7.org/CodeSystem/v3-ActCode code|AMB

      Implementation Notes: Fetches a bundle of all US Core Encounter Profile resources matching the specified class and patient ( see how to search by reference and how to search by token).

    3. SHOULD support searching for all encounter for a patient by encounter type using the combination of the patient and type search parameters

      GET [base]/Encounter?patient={Patient/}[id]&type={system|}[search_code]

      Example:

      1. GET [base]/Encounter?patient=Patient/1137192&type=http://www.ama-assn.org/go/cpt code|99201

      Implementation Notes: Fetches a bundle of all US Core Encounter Profile resources matching the specified patient and type ( see how to search by reference and how to search by token).

    4. SHOULD support searching for all encounter for a patient by encounter type using the combination of the patient and location search parameters

      GET [base]/Encounter?patient={Patient/}[id]&location={Type/}[id]

      Example:

      1. GET [base]/Encounter?patient=Patient/1137192&location=Location/hospital

      Implementation Notes: Fetches a bundle of all US Core Encounter Profile resources matching the specified patient and location ( see how to search by reference).

    5. SHOULD support searching using the combination of the patient and _lastUpdated search parameters

      • Including optional support for AND search on _lastUpdated (e.g._lastUpdated=[date]&_lastUpdated=[date]&...)

      • Including support for these _lastUpdated comparators: "gt", "lt", "ge", "le"

      GET [base]/Encounter?patient={Patient/}[id]&_lastUpdated=[dateTime]

      Example:

      1. GET [base]/Encounter?patient=Patient/1137192&_lastUpdated=ge2024-01-01T00:00:00Z

      Implementation Notes: Fetches a bundle of all US Core Encounter Profile resources for the specified patient and _lastUpdated. See the US Core General Guidance page for Searching Using lastUpdated. ( see how to search by reference and how to search by date).

    6. SHOULD support searching for all encounters for a patient by status (for example, all finished encounters) using the combination of the patient and status search parameters

      GET [base]/Encounter?patient={Patient/}[id]&status={system|}[search_code]

      Example:

      1. GET [base]/Encounter?patient=Patient/1137192&status=finished

      Implementation Notes: Fetches a bundle of all US Core Encounter Profile resources matching the specified patient and status ( see how to search by reference and how to search by token).

    7. SHOULD support searching for all encounter for a patient by status (for example, all finished encounters) using the combination of the patient and discharge-disposition search parameters

      GET [base]/Encounter?patient={Patient/}[id]&discharge-disposition={system|}[search_code]

      Example:

      1. GET [base]/Encounter?patient=Patient/1137192&discharge-disposition=01

      Implementation Notes: Fetches a bundle of all US Core Encounter Profile resources matching the specified patient and discharge-disposition ( see how to search by reference and how to search by token).