QI-Core Implementation Guide
6.0.0 - STU6 United States of America flag

QI-Core Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 6.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-qi-core/ and changes regularly. See the Directory of published versions

Resource Profile: QICore Encounter

Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-encounter Version: 6.0.0
Active as of 2018-08-22 Computable Name: QICoreEncounter

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

Usage

The following example illustrates accessing an inpatient encounter:

define "Ophthalmology Encounter Codes":
  [Encounter: class in "Inpatient Encounter Classes"] InpatientEncounter
    where InpatientEncounter.type in "Ophthalmology Encounter Codes"

See the patterns page for implementation and usage patterns.

Examples

Inpatient Admission for Appendicitis

Usage:

Formal Views of Profile Content

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

This structure is derived from USCoreEncounterProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter USCoreEncounterProfile
... subject 1..1Reference(QICore Patient)(QI-Core)(USCDI) The patient or group present at the encounter
... participant 0..*BackboneElement(QI-Core)(USCDI) List of participants involved in the encounter
.... individual 0..1Reference(QICore Practitioner | QICore PractitionerRole | QICore RelatedPerson)(QI-Core)(USCDI) Persons involved in the encounter other than the patient
... reasonReference Σ0..*Reference(QICore Condition Problems Health Concerns | QICore Condition Encounter Diagnosis | QICore Procedure | QICore Simple Observation | QICore ImmunizationRecommendation)(QI-Core)(USCDI) Reason the encounter takes place (reference)
.... origin 0..1Reference(QICore Location)The location/organization from which the patient came before admission
.... destination 0..1Reference(QICore Location)Location/organization to which the patient is discharged
.... dischargeDisposition 0..1CodeableConcept(QI-Core)(USCDI) Category or kind of location after discharge
Binding: Clinical Discharge Disposition (extensible)
... location 0..*BackboneElement(QI-Core)(USCDI) List of locations where the patient has been
.... location 1..1Reference(QICore Location)(QI-Core)(USCDI) Location the encounter takes place
.... period 0..1Period(QI-Core) Time period during which the patient was present at the location
... serviceProvider 0..1Reference(QICore Organization)(QI-Core)(USCDI) The organization (facility) responsible for this encounter
... partOf 0..1Reference(QICore Encounter)Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Encounter.hospitalization.dischargeDispositionextensibleClinicalDischargeDisposition
http://terminology.hl7.org/ValueSet/clinical-discharge-disposition
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*USCoreEncounterProfileAn interaction during which services are provided to the patient
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*Identifier(USCDI) Identifier(s) by which this encounter is known
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system SΣ1..1uri(USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1string(USCDI) The value that is unique
Example General: 123456
... class SΣ1..1Coding(USCDI) Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.

... type SΣ1..*CodeableConcept(USCDI) Specific type of encounter
Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type


... subject SΣ1..1Reference(QICore Patient)(QI-Core)(USCDI) The patient or group present at the encounter
... participant SΣ0..*BackboneElement(QI-Core)(USCDI) List of participants involved in the encounter
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type SΣ0..*CodeableConcept(USCDI) Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.


.... period S0..1Period(USCDI) Period of time during the encounter that the participant participated
.... individual SΣ0..1Reference(QICore Practitioner | QICore PractitionerRole | QICore RelatedPerson)(QI-Core)(USCDI) Persons involved in the encounter other than the patient
... period S0..1Period(USCDI) The start and end time of the encounter
... reasonCode SΣ0..*CodeableConcept(USCDI) Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.


... reasonReference SΣ0..*Reference(QICore Condition Problems Health Concerns | QICore Condition Encounter Diagnosis | QICore Procedure | QICore Simple Observation | QICore ImmunizationRecommendation)(QI-Core)(USCDI) Reason the encounter takes place (reference)
... hospitalization S0..1BackboneElement(QI-Core)(USCDI) Details about the admission to a healthcare service
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... origin 0..1Reference(QICore Location)The location/organization from which the patient came before admission
.... destination 0..1Reference(QICore Location)Location/organization to which the patient is discharged
.... dischargeDisposition S0..1CodeableConcept(QI-Core)(USCDI) Category or kind of location after discharge
Binding: Clinical Discharge Disposition (extensible)
... location S0..*BackboneElement(QI-Core)(USCDI) List of locations where the patient has been
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... location S1..1Reference(QICore Location)(QI-Core)(USCDI) Location the encounter takes place
.... period 0..1Period(QI-Core) Time period during which the patient was present at the location
... serviceProvider S0..1Reference(QICore Organization)(QI-Core)(USCDI) The organization (facility) responsible for this encounter
... partOf 0..1Reference(QICore Encounter)Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typeextensibleUSCoreEncounterType
http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Encounter.hospitalization.dischargeDispositionextensibleClinicalDischargeDisposition
http://terminology.hl7.org/ValueSet/clinical-discharge-disposition

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorEncounterIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*USCoreEncounterProfileAn interaction during which services are provided to the patient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*Identifier(USCDI) Identifier(s) by which this encounter is known
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription 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..1uri(USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1string(USCDI) The value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!SΣ1..1code(USCDI) planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.

... statusHistory 0..*BackboneElementList of past encounter statuses
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... status 1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.

.... period 1..1PeriodThe time that the episode was in the specified status
... class SΣ1..1Coding(USCDI) Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.

... classHistory 0..*BackboneElementList of past encounter classes
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... class 1..1Codinginpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.

.... period 1..1PeriodThe time that the episode was in the specified class
... type SΣ1..*CodeableConcept(USCDI) Specific type of encounter
Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type


... serviceType Σ0..1CodeableConceptSpecific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.

... priority 0..1CodeableConceptIndicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.

... subject SΣ1..1Reference(QICore Patient)(QI-Core)(USCDI) The patient or group present at the encounter
... episodeOfCare Σ0..*Reference(EpisodeOfCare)Episode(s) of care that this encounter should be recorded against
... basedOn 0..*Reference(ServiceRequest)The ServiceRequest that initiated this encounter
... participant SΣ0..*BackboneElement(QI-Core)(USCDI) List of participants involved in the encounter
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type SΣ0..*CodeableConcept(USCDI) Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.


.... period S0..1Period(USCDI) Period of time during the encounter that the participant participated
.... individual SΣ0..1Reference(QICore Practitioner | QICore PractitionerRole | QICore RelatedPerson)(QI-Core)(USCDI) Persons involved in the encounter other than the patient
... appointment Σ0..*Reference(Appointment)The appointment that scheduled this encounter
... period S0..1Period(USCDI) The start and end time of the encounter
... length 0..1DurationQuantity of time the encounter lasted (less time absent)
... reasonCode SΣ0..*CodeableConcept(USCDI) Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.


... reasonReference SΣ0..*Reference(QICore Condition Problems Health Concerns | QICore Condition Encounter Diagnosis | QICore Procedure | QICore Simple Observation | QICore ImmunizationRecommendation)(QI-Core)(USCDI) Reason the encounter takes place (reference)
... diagnosis Σ0..*BackboneElementThe list of diagnosis relevant to this encounter
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... condition Σ1..1Reference(Condition | Procedure)The diagnosis or procedure relevant to the encounter
.... use 0..1CodeableConceptRole that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.

.... rank 0..1positiveIntRanking 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 S0..1BackboneElement(QI-Core)(USCDI) Details about the admission to a healthcare service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier 0..1IdentifierPre-admission identifier
.... origin 0..1Reference(QICore Location)The location/organization from which the patient came before admission
.... admitSource 0..1CodeableConceptFrom where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.

.... reAdmission 0..1CodeableConceptThe 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..*CodeableConceptDiet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.


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


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


.... destination 0..1Reference(QICore Location)Location/organization to which the patient is discharged
.... dischargeDisposition S0..1CodeableConcept(QI-Core)(USCDI) Category or kind of location after discharge
Binding: Clinical Discharge Disposition (extensible)
... location S0..*BackboneElement(QI-Core)(USCDI) List of locations where the patient has been
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... location S1..1Reference(QICore Location)(QI-Core)(USCDI) Location the encounter takes place
.... status 0..1codeplanned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.

.... physicalType 0..1CodeableConceptThe 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..1Period(QI-Core) Time period during which the patient was present at the location
... serviceProvider S0..1Reference(QICore Organization)(QI-Core)(USCDI) The organization (facility) responsible for this encounter
... partOf 0..1Reference(QICore Encounter)Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Encounter.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Encounter.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typeextensibleUSCoreEncounterType
http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Encounter.priorityexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Encounter.diagnosis.usepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
from the FHIR Standard
Encounter.hospitalization.admitSourcepreferredAdmitSource
http://hl7.org/fhir/ValueSet/encounter-admit-source
from the FHIR Standard
Encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreferenceexampleDiet
http://hl7.org/fhir/ValueSet/encounter-diet
from the FHIR Standard
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
http://hl7.org/fhir/ValueSet/encounter-special-courtesy
from the FHIR Standard
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
http://hl7.org/fhir/ValueSet/encounter-special-arrangements
from the FHIR Standard
Encounter.hospitalization.dischargeDispositionextensibleClinicalDischargeDisposition
http://terminology.hl7.org/ValueSet/clinical-discharge-disposition
Encounter.location.statusrequiredEncounterLocationStatus
http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1
from the FHIR Standard
Encounter.location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard

Constraints

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

Differential View

This structure is derived from USCoreEncounterProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter USCoreEncounterProfile
... subject 1..1Reference(QICore Patient)(QI-Core)(USCDI) The patient or group present at the encounter
... participant 0..*BackboneElement(QI-Core)(USCDI) List of participants involved in the encounter
.... individual 0..1Reference(QICore Practitioner | QICore PractitionerRole | QICore RelatedPerson)(QI-Core)(USCDI) Persons involved in the encounter other than the patient
... reasonReference Σ0..*Reference(QICore Condition Problems Health Concerns | QICore Condition Encounter Diagnosis | QICore Procedure | QICore Simple Observation | QICore ImmunizationRecommendation)(QI-Core)(USCDI) Reason the encounter takes place (reference)
.... origin 0..1Reference(QICore Location)The location/organization from which the patient came before admission
.... destination 0..1Reference(QICore Location)Location/organization to which the patient is discharged
.... dischargeDisposition 0..1CodeableConcept(QI-Core)(USCDI) Category or kind of location after discharge
Binding: Clinical Discharge Disposition (extensible)
... location 0..*BackboneElement(QI-Core)(USCDI) List of locations where the patient has been
.... location 1..1Reference(QICore Location)(QI-Core)(USCDI) Location the encounter takes place
.... period 0..1Period(QI-Core) Time period during which the patient was present at the location
... serviceProvider 0..1Reference(QICore Organization)(QI-Core)(USCDI) The organization (facility) responsible for this encounter
... partOf 0..1Reference(QICore Encounter)Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Encounter.hospitalization.dischargeDispositionextensibleClinicalDischargeDisposition
http://terminology.hl7.org/ValueSet/clinical-discharge-disposition

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*USCoreEncounterProfileAn interaction during which services are provided to the patient
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*Identifier(USCDI) Identifier(s) by which this encounter is known
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system SΣ1..1uri(USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1string(USCDI) The value that is unique
Example General: 123456
... class SΣ1..1Coding(USCDI) Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.

... type SΣ1..*CodeableConcept(USCDI) Specific type of encounter
Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type


... subject SΣ1..1Reference(QICore Patient)(QI-Core)(USCDI) The patient or group present at the encounter
... participant SΣ0..*BackboneElement(QI-Core)(USCDI) List of participants involved in the encounter
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type SΣ0..*CodeableConcept(USCDI) Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.


.... period S0..1Period(USCDI) Period of time during the encounter that the participant participated
.... individual SΣ0..1Reference(QICore Practitioner | QICore PractitionerRole | QICore RelatedPerson)(QI-Core)(USCDI) Persons involved in the encounter other than the patient
... period S0..1Period(USCDI) The start and end time of the encounter
... reasonCode SΣ0..*CodeableConcept(USCDI) Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.


... reasonReference SΣ0..*Reference(QICore Condition Problems Health Concerns | QICore Condition Encounter Diagnosis | QICore Procedure | QICore Simple Observation | QICore ImmunizationRecommendation)(QI-Core)(USCDI) Reason the encounter takes place (reference)
... hospitalization S0..1BackboneElement(QI-Core)(USCDI) Details about the admission to a healthcare service
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... origin 0..1Reference(QICore Location)The location/organization from which the patient came before admission
.... destination 0..1Reference(QICore Location)Location/organization to which the patient is discharged
.... dischargeDisposition S0..1CodeableConcept(QI-Core)(USCDI) Category or kind of location after discharge
Binding: Clinical Discharge Disposition (extensible)
... location S0..*BackboneElement(QI-Core)(USCDI) List of locations where the patient has been
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... location S1..1Reference(QICore Location)(QI-Core)(USCDI) Location the encounter takes place
.... period 0..1Period(QI-Core) Time period during which the patient was present at the location
... serviceProvider S0..1Reference(QICore Organization)(QI-Core)(USCDI) The organization (facility) responsible for this encounter
... partOf 0..1Reference(QICore Encounter)Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typeextensibleUSCoreEncounterType
http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Encounter.hospitalization.dischargeDispositionextensibleClinicalDischargeDisposition
http://terminology.hl7.org/ValueSet/clinical-discharge-disposition

Constraints

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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*USCoreEncounterProfileAn interaction during which services are provided to the patient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*Identifier(USCDI) Identifier(s) by which this encounter is known
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription 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..1uri(USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1string(USCDI) The value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!SΣ1..1code(USCDI) planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.

... statusHistory 0..*BackboneElementList of past encounter statuses
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... status 1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.

.... period 1..1PeriodThe time that the episode was in the specified status
... class SΣ1..1Coding(USCDI) Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.

... classHistory 0..*BackboneElementList of past encounter classes
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... class 1..1Codinginpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.

.... period 1..1PeriodThe time that the episode was in the specified class
... type SΣ1..*CodeableConcept(USCDI) Specific type of encounter
Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type


... serviceType Σ0..1CodeableConceptSpecific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.

... priority 0..1CodeableConceptIndicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.

... subject SΣ1..1Reference(QICore Patient)(QI-Core)(USCDI) The patient or group present at the encounter
... episodeOfCare Σ0..*Reference(EpisodeOfCare)Episode(s) of care that this encounter should be recorded against
... basedOn 0..*Reference(ServiceRequest)The ServiceRequest that initiated this encounter
... participant SΣ0..*BackboneElement(QI-Core)(USCDI) List of participants involved in the encounter
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type SΣ0..*CodeableConcept(USCDI) Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.


.... period S0..1Period(USCDI) Period of time during the encounter that the participant participated
.... individual SΣ0..1Reference(QICore Practitioner | QICore PractitionerRole | QICore RelatedPerson)(QI-Core)(USCDI) Persons involved in the encounter other than the patient
... appointment Σ0..*Reference(Appointment)The appointment that scheduled this encounter
... period S0..1Period(USCDI) The start and end time of the encounter
... length 0..1DurationQuantity of time the encounter lasted (less time absent)
... reasonCode SΣ0..*CodeableConcept(USCDI) Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.


... reasonReference SΣ0..*Reference(QICore Condition Problems Health Concerns | QICore Condition Encounter Diagnosis | QICore Procedure | QICore Simple Observation | QICore ImmunizationRecommendation)(QI-Core)(USCDI) Reason the encounter takes place (reference)
... diagnosis Σ0..*BackboneElementThe list of diagnosis relevant to this encounter
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... condition Σ1..1Reference(Condition | Procedure)The diagnosis or procedure relevant to the encounter
.... use 0..1CodeableConceptRole that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.

.... rank 0..1positiveIntRanking 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 S0..1BackboneElement(QI-Core)(USCDI) Details about the admission to a healthcare service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier 0..1IdentifierPre-admission identifier
.... origin 0..1Reference(QICore Location)The location/organization from which the patient came before admission
.... admitSource 0..1CodeableConceptFrom where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.

.... reAdmission 0..1CodeableConceptThe 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..*CodeableConceptDiet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.


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


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


.... destination 0..1Reference(QICore Location)Location/organization to which the patient is discharged
.... dischargeDisposition S0..1CodeableConcept(QI-Core)(USCDI) Category or kind of location after discharge
Binding: Clinical Discharge Disposition (extensible)
... location S0..*BackboneElement(QI-Core)(USCDI) List of locations where the patient has been
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... location S1..1Reference(QICore Location)(QI-Core)(USCDI) Location the encounter takes place
.... status 0..1codeplanned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.

.... physicalType 0..1CodeableConceptThe 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..1Period(QI-Core) Time period during which the patient was present at the location
... serviceProvider S0..1Reference(QICore Organization)(QI-Core)(USCDI) The organization (facility) responsible for this encounter
... partOf 0..1Reference(QICore Encounter)Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Encounter.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Encounter.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Encounter.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
Encounter.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typeextensibleUSCoreEncounterType
http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Encounter.priorityexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Encounter.diagnosis.usepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
from the FHIR Standard
Encounter.hospitalization.admitSourcepreferredAdmitSource
http://hl7.org/fhir/ValueSet/encounter-admit-source
from the FHIR Standard
Encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreferenceexampleDiet
http://hl7.org/fhir/ValueSet/encounter-diet
from the FHIR Standard
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
http://hl7.org/fhir/ValueSet/encounter-special-courtesy
from the FHIR Standard
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
http://hl7.org/fhir/ValueSet/encounter-special-arrangements
from the FHIR Standard
Encounter.hospitalization.dischargeDispositionextensibleClinicalDischargeDisposition
http://terminology.hl7.org/ValueSet/clinical-discharge-disposition
Encounter.location.statusrequiredEncounterLocationStatus
http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1
from the FHIR Standard
Encounter.location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard

Constraints

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

 

Other representations of profile: CSV, Excel, Schematron