US Quality Core Implementation Guide
1.0.0-ballot - STU 1 - ballot United States of America flag

US Quality Core Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 1.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/fhir-us-quality-core/ and changes regularly. See the Directory of published versions

Resource Profile: US Quality Core Encounter

Official URL: http://hl7.org/fhir/us/quality-core/StructureDefinition/us-quality-core-encounter Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 4 Computable Name: USQualityCoreEncounter
Other Identifiers: OID:2.16.840.1.113883.4.642.40.78.42.17

Profile of Encounter for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

USCDI+ Quality Element Support Expectations

Systems are expected to support this profile as part of implementing USCDI+ Quality V2 in FHIR and meeting the conformance requirements of this guide.

The following elements are specifically relevant to USCDI+ Quality V2 data classes and elements. Systems are expected to support these elements as applicable to their role in US Quality Core data exchange. See the Must Support section of this guide for more information. These elements are flagged as (USCDI+ Quality) in the formal profile views.

USCDI+ Quality Elements:

Profile element Description USCDI+ Quality Data Element(s)
diagnosis The list of diagnosis relevant to this encounter Encounter Information: Encounter Diagnosis
diagnosis.extension:diagnosisPresentOnAdmission onAdmission Encounter Information: Present on Admission
diagnosis.rank Ranking of the diagnosis (for each role type) Encounter Information: Diagnosis Rank
diagnosis.use Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Encounter Information: Encounter Diagnosis Role
hospitalization Details about the admission to a healthcare service Encounter Information: Encounter Disposition
hospitalization.dischargeDisposition Category or kind of location after discharge Encounter Information: Encounter Disposition
identifier Identifier(s) by which this encounter is known Encounter Information: Encounter Identifier
identifier.system The namespace for the identifier value Encounter Information: Encounter Identifier
identifier.value The value that is unique Encounter Information: Encounter Identifier
location List of locations where the patient has been Encounter Information: Encounter Location
location.location Location the encounter takes place Encounter Information: Encounter Location
period The start and end time of the encounter Encounter Information: Encounter Time
priority Indicates the urgency of the encounter Encounter Information: Encounter Diagnosis
status planned | arrived | triaged | in-progress | onleave | finished | cancelled + Encounter Information: Encounter Status
type Specific type of encounter Encounter Information: Encounter Type

Because this profile is derived directly or indirectly from US Core, systems are also expected to support the Must Support and Additional USCDI requirements specified by the US Core profile this profile inherits from. For more information about those requirements, refer to the US Core Encounter Profile. The Formal Views section also provides the formal summary, definitions, terminology requirements, and mandatory element requirements.

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(9.0.0) An interaction during which services are provided to the patient
... meta SΣ 0..1 Meta Metadata about the resource
.... lastUpdated SΣ 0..1 instant When the resource last changed
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... 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
... identifier SΣ 0..* Identifier (USCDI+ Quality) Identifier(s) by which this encounter is known
.... 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+ Quality) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string (USCDI+ Quality) The value that is unique
Example General: 123456
... status ?!SΣ 1..1 code (USCDI+ Quality) planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
... class SΣ 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.
... type SΣ 1..* CodeableConcept (USCDI+ Quality) Specific type of encounter
Binding: Encounter Type . (extensible): Valueset to describe the Encounter Type
... priority 0..1 CodeableConcept (USCDI+ Quality) Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.
... subject SΣ 1..1 Reference(US Quality Core Patient) The patient or group present at the encounter
... participant SΣ 0..* BackboneElement List of participants involved in the encounter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
.... period S 0..1 Period Period of time during the encounter that the participant participated
.... individual SΣ 0..1 Reference(US Quality Core Practitioner | US Quality Core PractitionerRole | US Quality Core RelatedPerson) Persons involved in the encounter other than the patient
... period S 0..1 Period (USCDI+ Quality) The start and end time of the encounter
... reasonCode SΣ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
... reasonReference SΣ 0..* Reference(US Quality Core Condition Problems Health Concerns S | US Quality Core Condition Encounter Diagnosis S | US Quality Core Procedure | US Quality Core Simple Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis Σ 0..* BackboneElement (USCDI+ Quality) The list of diagnosis relevant to this encounter
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:diagnosisPresentOnAdmission S 0..1 CodeableConcept (USCDI+ Quality) onAdmission
URL: http://hl7.org/fhir/us/quality-core/StructureDefinition/us-quality-core-diagnosis-present-on-admission
Binding: US Quality Core Present On Admission Codes (required): Indicator of whether the Encounter diagnosis was present at the time of admission
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition Σ 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
.... use 0..1 CodeableConcept (USCDI+ Quality) 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 (USCDI+ Quality) Ranking of the diagnosis (for each role type)
... hospitalization S 0..1 BackboneElement (USCDI+ Quality) Details about the admission to a healthcare service
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... origin 0..1 Reference(US Quality Core Location | US Quality Core Location) The location/organization from which the patient came before admission
.... destination 0..1 Reference(US Quality Core Location | US Quality Core Location) Location/organization to which the patient is discharged
.... dischargeDisposition S 0..1 CodeableConcept (USCDI+ Quality) Category or kind of location after discharge
Binding: Clinical Discharge Disposition (extensible)
... location S 0..* BackboneElement (USCDI+ Quality) List of locations where the patient has been
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location S 1..1 Reference(US Quality Core Location) (USCDI+ Quality) Location the encounter takes place
... serviceProvider S 0..1 Reference(US Quality Core Organization) The organization (facility) responsible for this encounter
... partOf 0..1 Reference(US Quality Core Encounter) Another Encounter this encounter is part of

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.2
Encounter.type Base extensible Encounter Type . ⏿20250510 tx.fhir.org
Encounter.priority Base example ActPriority 📦3.0.0 THO v7.2
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.​dischargeDisposition Base extensible Clinical Discharge Disposition 📦2.0.0 THO v7.2

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* USCoreEncounterProfile(9.0.0) An interaction during which services are provided to the patient
... identifier 0..* Identifier (USCDI+ Quality) Identifier(s) by which this encounter is known
.... system 1..1 uri (USCDI+ Quality) The namespace for the identifier value
.... value 1..1 string (USCDI+ Quality) The value that is unique
... status 1..1 code (USCDI+ Quality) planned | arrived | triaged | in-progress | onleave | finished | cancelled +
... type 1..* CodeableConcept (USCDI+ Quality) Specific type of encounter
... subject 1..1 Reference(US Quality Core Patient) The patient or group present at the encounter
... participant
.... individual 0..1 Reference(US Quality Core Practitioner | US Quality Core PractitionerRole | US Quality Core RelatedPerson) Persons involved in the encounter other than the patient
... period 0..1 Period (USCDI+ Quality) The start and end time of the encounter
... reasonReference 0..* Reference(US Quality Core Condition Problems Health Concerns | US Quality Core Condition Encounter Diagnosis | US Quality Core Procedure | US Quality Core Simple Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis 0..* BackboneElement (USCDI+ Quality) The list of diagnosis relevant to this encounter
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:diagnosisPresentOnAdmission S 0..1 CodeableConcept (USCDI+ Quality) onAdmission
URL: http://hl7.org/fhir/us/quality-core/StructureDefinition/us-quality-core-diagnosis-present-on-admission
Binding: US Quality Core Present On Admission Codes (required): Indicator of whether the Encounter diagnosis was present at the time of admission
.... use 0..1 CodeableConcept (USCDI+ Quality) Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
.... rank 0..1 positiveInt (USCDI+ Quality) Ranking of the diagnosis (for each role type)
... hospitalization 0..1 BackboneElement (USCDI+ Quality) Details about the admission to a healthcare service
.... origin 0..1 Reference(US Quality Core Location | US Quality Core Location) The location/organization from which the patient came before admission
.... destination 0..1 Reference(US Quality Core Location | US Quality Core Location) Location/organization to which the patient is discharged
.... dischargeDisposition 0..1 CodeableConcept (USCDI+ Quality) Category or kind of location after discharge
Binding: Clinical Discharge Disposition (extensible)
... location 0..* BackboneElement (USCDI+ Quality) List of locations where the patient has been
.... location 1..1 Reference(US Quality Core Location) (USCDI+ Quality) Location the encounter takes place
... serviceProvider 0..1 Reference(US Quality Core Organization) The organization (facility) responsible for this encounter
... partOf 0..1 Reference(US Quality Core Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Encounter.hospitalization.​dischargeDisposition Base extensible Clinical Discharge Disposition 📦2.0.0 THO v7.2
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* USCoreEncounterProfile(9.0.0) An interaction during which services are provided to the patient
... id Σ 0..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier (USCDI+ Quality) Identifier(s) by which this encounter is known
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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+ Quality) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string (USCDI+ Quality) 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+ Quality) planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
... statusHistory 0..* BackboneElement List of past encounter statuses
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
.... period 1..1 Period The time that the episode was in the specified status
... class SΣ 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.
... classHistory 0..* BackboneElement List of past encounter classes
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.
.... period 1..1 Period The time that the episode was in the specified class
... type SΣ 1..* CodeableConcept (USCDI+ Quality) Specific type of encounter
Binding: Encounter Type . (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 (USCDI+ Quality) Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.
... subject SΣ 1..1 Reference(US Quality Core Patient) The patient or group present at the encounter
... episodeOfCare Σ 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
... basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
... participant SΣ 0..* BackboneElement List of participants involved in the encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
.... period S 0..1 Period Period of time during the encounter that the participant participated
.... individual SΣ 0..1 Reference(US Quality Core Practitioner | US Quality Core PractitionerRole | US Quality Core RelatedPerson) 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+ Quality) The start and end time of the encounter
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... reasonCode SΣ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
... reasonReference SΣ 0..* Reference(US Quality Core Condition Problems Health Concerns S | US Quality Core Condition Encounter Diagnosis S | US Quality Core Procedure | US Quality Core Simple Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis Σ 0..* BackboneElement (USCDI+ Quality) The list of diagnosis relevant to this encounter
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:diagnosisPresentOnAdmission S 0..1 CodeableConcept (USCDI+ Quality) onAdmission
URL: http://hl7.org/fhir/us/quality-core/StructureDefinition/us-quality-core-diagnosis-present-on-admission
Binding: US Quality Core Present On Admission Codes (required): Indicator of whether the Encounter diagnosis was present at the time of admission
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition Σ 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
.... use 0..1 CodeableConcept (USCDI+ Quality) 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 (USCDI+ Quality) 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+ Quality) Details about the admission to a healthcare service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin 0..1 Reference(US Quality Core Location | US Quality Core Location) The location/organization from which the patient came before admission
.... admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.
.... reAdmission 0..1 CodeableConcept The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
.... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
.... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
.... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.
.... destination 0..1 Reference(US Quality Core Location | US Quality Core Location) Location/organization to which the patient is discharged
.... dischargeDisposition S 0..1 CodeableConcept (USCDI+ Quality) Category or kind of location after discharge
Binding: Clinical Discharge Disposition (extensible)
... location S 0..* BackboneElement (USCDI+ Quality) List of locations where the patient has been
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location S 1..1 Reference(US Quality Core Location) (USCDI+ Quality) Location the encounter takes place
.... status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
.... physicalType 0..1 CodeableConcept The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example): Physical form of the location.
.... period 0..1 Period Time period during which the patient was present at the location
... serviceProvider S 0..1 Reference(US Quality Core Organization) The organization (facility) responsible for this encounter
... partOf 0..1 Reference(US Quality Core 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.2
Encounter.classHistory.​class Base extensible ActEncounterCode 📦3.0.0 THO v7.2
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.2
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.2
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 extensible Clinical Discharge Disposition 📦2.0.0 THO v7.2
Encounter.location.status Base required EncounterLocationStatus 📍4.0.1 FHIR Std.
Encounter.location.physicalType Base example Location type 📍4.0.1 FHIR Std.

Constraints

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

Summary

Must-Support: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Maturity: 4

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* USCoreEncounterProfile(9.0.0) An interaction during which services are provided to the patient
... meta SΣ 0..1 Meta Metadata about the resource
.... lastUpdated SΣ 0..1 instant When the resource last changed
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... 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
... identifier SΣ 0..* Identifier (USCDI+ Quality) Identifier(s) by which this encounter is known
.... 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+ Quality) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string (USCDI+ Quality) The value that is unique
Example General: 123456
... status ?!SΣ 1..1 code (USCDI+ Quality) planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
... class SΣ 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.
... type SΣ 1..* CodeableConcept (USCDI+ Quality) Specific type of encounter
Binding: Encounter Type . (extensible): Valueset to describe the Encounter Type
... priority 0..1 CodeableConcept (USCDI+ Quality) Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.
... subject SΣ 1..1 Reference(US Quality Core Patient) The patient or group present at the encounter
... participant SΣ 0..* BackboneElement List of participants involved in the encounter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
.... period S 0..1 Period Period of time during the encounter that the participant participated
.... individual SΣ 0..1 Reference(US Quality Core Practitioner | US Quality Core PractitionerRole | US Quality Core RelatedPerson) Persons involved in the encounter other than the patient
... period S 0..1 Period (USCDI+ Quality) The start and end time of the encounter
... reasonCode SΣ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
... reasonReference SΣ 0..* Reference(US Quality Core Condition Problems Health Concerns S | US Quality Core Condition Encounter Diagnosis S | US Quality Core Procedure | US Quality Core Simple Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis Σ 0..* BackboneElement (USCDI+ Quality) The list of diagnosis relevant to this encounter
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:diagnosisPresentOnAdmission S 0..1 CodeableConcept (USCDI+ Quality) onAdmission
URL: http://hl7.org/fhir/us/quality-core/StructureDefinition/us-quality-core-diagnosis-present-on-admission
Binding: US Quality Core Present On Admission Codes (required): Indicator of whether the Encounter diagnosis was present at the time of admission
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition Σ 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
.... use 0..1 CodeableConcept (USCDI+ Quality) 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 (USCDI+ Quality) Ranking of the diagnosis (for each role type)
... hospitalization S 0..1 BackboneElement (USCDI+ Quality) Details about the admission to a healthcare service
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... origin 0..1 Reference(US Quality Core Location | US Quality Core Location) The location/organization from which the patient came before admission
.... destination 0..1 Reference(US Quality Core Location | US Quality Core Location) Location/organization to which the patient is discharged
.... dischargeDisposition S 0..1 CodeableConcept (USCDI+ Quality) Category or kind of location after discharge
Binding: Clinical Discharge Disposition (extensible)
... location S 0..* BackboneElement (USCDI+ Quality) List of locations where the patient has been
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location S 1..1 Reference(US Quality Core Location) (USCDI+ Quality) Location the encounter takes place
... serviceProvider S 0..1 Reference(US Quality Core Organization) The organization (facility) responsible for this encounter
... partOf 0..1 Reference(US Quality Core Encounter) Another Encounter this encounter is part of

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.2
Encounter.type Base extensible Encounter Type . ⏿20250510 tx.fhir.org
Encounter.priority Base example ActPriority 📦3.0.0 THO v7.2
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.​dischargeDisposition Base extensible Clinical Discharge Disposition 📦2.0.0 THO v7.2

Constraints

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

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* USCoreEncounterProfile(9.0.0) An interaction during which services are provided to the patient
... identifier 0..* Identifier (USCDI+ Quality) Identifier(s) by which this encounter is known
.... system 1..1 uri (USCDI+ Quality) The namespace for the identifier value
.... value 1..1 string (USCDI+ Quality) The value that is unique
... status 1..1 code (USCDI+ Quality) planned | arrived | triaged | in-progress | onleave | finished | cancelled +
... type 1..* CodeableConcept (USCDI+ Quality) Specific type of encounter
... subject 1..1 Reference(US Quality Core Patient) The patient or group present at the encounter
... participant
.... individual 0..1 Reference(US Quality Core Practitioner | US Quality Core PractitionerRole | US Quality Core RelatedPerson) Persons involved in the encounter other than the patient
... period 0..1 Period (USCDI+ Quality) The start and end time of the encounter
... reasonReference 0..* Reference(US Quality Core Condition Problems Health Concerns | US Quality Core Condition Encounter Diagnosis | US Quality Core Procedure | US Quality Core Simple Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis 0..* BackboneElement (USCDI+ Quality) The list of diagnosis relevant to this encounter
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:diagnosisPresentOnAdmission S 0..1 CodeableConcept (USCDI+ Quality) onAdmission
URL: http://hl7.org/fhir/us/quality-core/StructureDefinition/us-quality-core-diagnosis-present-on-admission
Binding: US Quality Core Present On Admission Codes (required): Indicator of whether the Encounter diagnosis was present at the time of admission
.... use 0..1 CodeableConcept (USCDI+ Quality) Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
.... rank 0..1 positiveInt (USCDI+ Quality) Ranking of the diagnosis (for each role type)
... hospitalization 0..1 BackboneElement (USCDI+ Quality) Details about the admission to a healthcare service
.... origin 0..1 Reference(US Quality Core Location | US Quality Core Location) The location/organization from which the patient came before admission
.... destination 0..1 Reference(US Quality Core Location | US Quality Core Location) Location/organization to which the patient is discharged
.... dischargeDisposition 0..1 CodeableConcept (USCDI+ Quality) Category or kind of location after discharge
Binding: Clinical Discharge Disposition (extensible)
... location 0..* BackboneElement (USCDI+ Quality) List of locations where the patient has been
.... location 1..1 Reference(US Quality Core Location) (USCDI+ Quality) Location the encounter takes place
... serviceProvider 0..1 Reference(US Quality Core Organization) The organization (facility) responsible for this encounter
... partOf 0..1 Reference(US Quality Core Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Encounter.hospitalization.​dischargeDisposition Base extensible Clinical Discharge Disposition 📦2.0.0 THO v7.2

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* USCoreEncounterProfile(9.0.0) An interaction during which services are provided to the patient
... id Σ 0..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier (USCDI+ Quality) Identifier(s) by which this encounter is known
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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+ Quality) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string (USCDI+ Quality) 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+ Quality) planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
... statusHistory 0..* BackboneElement List of past encounter statuses
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
.... period 1..1 Period The time that the episode was in the specified status
... class SΣ 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.
... classHistory 0..* BackboneElement List of past encounter classes
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.
.... period 1..1 Period The time that the episode was in the specified class
... type SΣ 1..* CodeableConcept (USCDI+ Quality) Specific type of encounter
Binding: Encounter Type . (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 (USCDI+ Quality) Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.
... subject SΣ 1..1 Reference(US Quality Core Patient) The patient or group present at the encounter
... episodeOfCare Σ 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
... basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
... participant SΣ 0..* BackboneElement List of participants involved in the encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
.... period S 0..1 Period Period of time during the encounter that the participant participated
.... individual SΣ 0..1 Reference(US Quality Core Practitioner | US Quality Core PractitionerRole | US Quality Core RelatedPerson) 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+ Quality) The start and end time of the encounter
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... reasonCode SΣ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
... reasonReference SΣ 0..* Reference(US Quality Core Condition Problems Health Concerns S | US Quality Core Condition Encounter Diagnosis S | US Quality Core Procedure | US Quality Core Simple Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis Σ 0..* BackboneElement (USCDI+ Quality) The list of diagnosis relevant to this encounter
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:diagnosisPresentOnAdmission S 0..1 CodeableConcept (USCDI+ Quality) onAdmission
URL: http://hl7.org/fhir/us/quality-core/StructureDefinition/us-quality-core-diagnosis-present-on-admission
Binding: US Quality Core Present On Admission Codes (required): Indicator of whether the Encounter diagnosis was present at the time of admission
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition Σ 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
.... use 0..1 CodeableConcept (USCDI+ Quality) 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 (USCDI+ Quality) 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+ Quality) Details about the admission to a healthcare service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin 0..1 Reference(US Quality Core Location | US Quality Core Location) The location/organization from which the patient came before admission
.... admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.
.... reAdmission 0..1 CodeableConcept The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
.... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
.... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
.... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.
.... destination 0..1 Reference(US Quality Core Location | US Quality Core Location) Location/organization to which the patient is discharged
.... dischargeDisposition S 0..1 CodeableConcept (USCDI+ Quality) Category or kind of location after discharge
Binding: Clinical Discharge Disposition (extensible)
... location S 0..* BackboneElement (USCDI+ Quality) List of locations where the patient has been
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location S 1..1 Reference(US Quality Core Location) (USCDI+ Quality) Location the encounter takes place
.... status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
.... physicalType 0..1 CodeableConcept The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example): Physical form of the location.
.... period 0..1 Period Time period during which the patient was present at the location
... serviceProvider S 0..1 Reference(US Quality Core Organization) The organization (facility) responsible for this encounter
... partOf 0..1 Reference(US Quality Core 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.2
Encounter.classHistory.​class Base extensible ActEncounterCode 📦3.0.0 THO v7.2
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.2
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.2
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 extensible Clinical Discharge Disposition 📦2.0.0 THO v7.2
Encounter.location.status Base required EncounterLocationStatus 📍4.0.1 FHIR Std.
Encounter.location.physicalType Base example Location type 📍4.0.1 FHIR Std.

Constraints

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

Summary

Must-Support: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Element Conformance Indicators by Profile Layer

Badges identify the profile layer where each conformance indicator is first introduced. Indicators introduced in an earlier layer remain applicable in later derived profiles.

Element conformance indicators organized by the profile layer where they are first introduced
Profile element FHIR US Core US Quality Core
meta Must Support
meta.lastUpdated Must Support
extension:interpreterRequired Additional USCDI
identifier Must Support USCDI+ Quality
identifier.system Mandatory Must Support USCDI+ Quality
identifier.value Mandatory Must Support USCDI+ Quality
status Mandatory Must Support USCDI+ Quality
statusHistory.status Mandatory
statusHistory.period Mandatory
class Mandatory Must Support
classHistory.class Mandatory
classHistory.period Mandatory
type Mandatory Must Support USCDI+ Quality
priority USCDI+ Quality
subject Mandatory Must Support
participant Must Support
participant.type Must Support
participant.period Must Support
participant.individual Must Support
period Must Support USCDI+ Quality
reasonCode Must Support
reasonReference Must Support
diagnosis USCDI+ Quality
diagnosis.extension:diagnosisPresentOnAdmission Must Support USCDI+ Quality
diagnosis.condition Mandatory
diagnosis.use USCDI+ Quality
diagnosis.rank USCDI+ Quality
hospitalization Must Support USCDI+ Quality
hospitalization.dischargeDisposition Must Support USCDI+ Quality
location Must Support USCDI+ Quality
location.location Mandatory Must Support USCDI+ Quality
serviceProvider Must Support

Cardinality note: “Mandatory” means the element has a minimum cardinality greater than zero. For nested elements, the cardinality indicator applies when the containing element is present.

Mandatory US Quality Core Server Search Parameters

The searches below are the focused set identified by US Quality Core as needed to retrieve USCDI+ Quality data for quality measurement and reporting. See the US Core FHIR RESTful Search API Requirements for detailed information on requirements by search parameter type.

Because this profile derives directly or indirectly from US Core, servers SHALL also support all mandatory searches described in the US Core Server CapabilityStatement requirements for Encounter. When possible, this guide reuses mandatory searches from US Core and notes them with the EXISTING US CORE REQUIREMENT flag. While US Quality Core may restate US Core requirements to highlight searches directly relevant to USCDI+ Quality data access, US Core requirements not restated here remain applicable.

See the US Quality Core Server CapabilityStatement for complete requirements for the underlying Encounter resource and Search Requirement Selection for how this focused set was selected.

Servers supporting this profile SHALL support the following search parameters and search parameter combinations:

  1. SHALL support searching for a Encounter resource by id using the _id search parameter. EXISTING US CORE REQUIREMENT

    • Including optional support for OR search on _id (e.g._id=[id],[id],...).

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

    Example:

    GET [base]/Encounter?_id=example

    Implementation Notes: Fetches a bundle of US Quality Core Encounter resources matching the specified search criteria. See how to search by token.

    Rationale for inclusion: Supports retrieval of a known Encounter resource by id.

  2. SHALL support searching for all Encounter resources for a patient using the patient search parameter. EXISTING US CORE REQUIREMENT

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

    Example:

    GET [base]/Encounter?patient=Patient/example

    Implementation Notes: Fetches a bundle of US Quality Core Encounter resources matching the specified search criteria. See how to search by reference.

    Rationale for inclusion: Supports patient-scoped retrieval of Encounter resources for USCDI+ Quality workflows.

  3. SHALL support searching for all Encounter resources for a patient using the combination of the patient and type search parameters.

    • Including optional support for OR search on type (e.g.type={system|}[search_code],{system|}[search_code],...).

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

    Example:

    GET [base]/Encounter?patient=Patient/example&type=http://www.ama-assn.org/go/cpt|99223

    Implementation Notes: Fetches a bundle of US Quality Core Encounter resources matching the specified search criteria. See how to search by reference and how to search by token.

    Rationale for inclusion: Supports patient-scoped retrieval of Encounter resources filtered by type for USCDI+ Quality workflows.

  4. SHALL support searching for all Encounter resources for a patient using the combination of the patient and date search parameters. EXISTING US CORE REQUIREMENT

    • 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]

    Example:

    GET [base]/Encounter?patient=Patient/example&date=ge2020-01-01T00:00:00Z

    Implementation Notes: Fetches a bundle of US Quality Core Encounter resources matching the specified search criteria. See how to search by reference and how to search by date.

    Rationale for inclusion: Supports patient-scoped retrieval of Encounter resources filtered by date so quality workflows can constrain results to relevant reporting periods.