STU 2 Ballot

This page is part of the Quality Improvement Core Framework (v1.6.0: STU 2 Ballot 1) based on FHIR v1.6.0. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: qicore-encounter

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/qicore/StructureDefinition/qicore-encounter

This profile was published on Fri Feb 27 00:00:00 AEDT 2015 as a draft by Health Level Seven International (Clinical Quality Information - QICore).

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

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*
... status S1..1code
... class S0..1Coding
... type S0..*CodeableConceptBinding: 7.org/fhir/daf/ValueSet/daf-encounter-type (preferred)
... priority 0..1CodeableConceptBinding: SNOMED CT Priorities Codes (preferred)
... patient S0..1Reference(Profile qicore-patient)
... incomingReferral 0..*Reference(Profile qicore-referralrequest)
... participant 0..*BackboneElement
.... individual 0..1Reference(Profile qicore-practitioner | Profile qicore-relatedperson)
... period S0..1Period
... length S0..1Duration
... reason S0..*CodeableConceptBinding: 7.org/fhir/daf/ValueSet/daf-encounter-reason (preferred)
... hospitalization 0..1BackboneElement
.... origin 0..1Reference(Profile qicore-location)
.... admitSource S0..1CodeableConcept
.... reAdmission S0..1CodeableConcept
.... destination 0..1Reference(Profile qicore-location)
.... dischargeDisposition S0..1CodeableConcept
.... dischargeDiagnosis S0..*Reference(Condition)
... location 0..*BackboneElement
.... location 1..1Reference(Profile qicore-location)
.... period 0..1Period
... serviceProvider S0..1Reference(Profile qicore-organization)
... partOf 0..1Reference(Profile qicore-encounter)
... encounter-relatedCondition 0..*Reference(Condition)Other associated conditions
URL: http://hl7.org/fhir/StructureDefinition/encounter-relatedCondition
.... condition 1..1Reference(Condition)A condition related to this encounter
URL: condition
..... valueReference 1..1Reference(Profile qicore-condition)
.... role 1..1CodeableConceptThe role of the condition
URL: role
Binding: SNOMED CT Qualifier For Type of Diagnosis Codes (preferred)
... encounter-reasonCancelled 0..1CodeableConceptExplanation for cancellation
URL: http://hl7.org/fhir/StructureDefinition/encounter-reasonCancelled
Binding: Reasons for canceled or refused encounter codes (example)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter I0..*An interaction during which services are provided to the patient
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... 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: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... encounter-relatedCondition I0..*Reference(Condition)Extension
URL: http://hl7.org/fhir/StructureDefinition/encounter-relatedCondition
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..1ExtensionA condition related to this encounter
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"condition"
..... valueReference 1..1Reference(Condition)Detailed information about conditions, problems or diagnoses
.... extension 0..1ExtensionThe role of the condition
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"role"
..... valueCodeableConcept 1..1CodeableConceptValue of extension
.... condition 1..1Reference(Condition)Extension
URL: condition
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..1ExtensionA condition related to this encounter
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"condition"
...... valueReference 1..1Reference(Condition)Detailed information about conditions, problems or diagnoses
..... extension 0..1ExtensionThe role of the condition
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"role"
...... valueCodeableConcept 1..1CodeableConceptValue of extension
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/encounter-relatedCondition"
..... valueReference 1..1Reference(Profile qicore-condition)Detailed information about conditions, problems or diagnoses
.... role 1..1CodeableConceptExtension
URL: role
Binding: SNOMED CT Qualifier For Type of Diagnosis Codes (preferred)
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/encounter-relatedCondition"
.... valueReference 0..1Reference(Condition)Detailed information about conditions, problems or diagnoses
... encounter-reasonCancelled I0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/encounter-reasonCancelled
Binding: Reasons for canceled or refused encounter codes (example)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ∑0..*IdentifierIdentifier(s) by which this encounter is known
... status ?!S1..1codeplanned | arrived | in-progress | onleave | finished | cancelled | entered-in-error
Binding: EncounterStatus (required)
... statusHistory 0..*BackboneElementList of past encounter statuses
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... status 1..1codeplanned | arrived | in-progress | onleave | finished | cancelled | entered-in-error
Binding: EncounterStatus (required)
.... period 1..1PeriodThe time that the episode was in the specified status
... class S0..1Codinginpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible)
... type S0..*CodeableConceptSpecific type of encounter
Binding: 7.org/fhir/daf/ValueSet/daf-encounter-type (preferred)
... priority 0..1CodeableConceptIndicates the urgency of the encounter
Binding: SNOMED CT Priorities Codes (preferred)
... patient S0..1Reference(Profile qicore-patient)The patient present at the encounter
... episodeOfCare ∑0..*Reference(EpisodeOfCare)Episode(s) of care that this encounter should be recorded against
... incomingReferral 0..*Reference(Profile qicore-referralrequest)The ReferralRequest that initiated this encounter
... participant 0..*BackboneElementList of participants involved in the encounter
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... type ∑0..*CodeableConceptRole of participant in encounter
Binding: ParticipantType (extensible)
.... period 0..1PeriodPeriod of time during the encounter participant was present
.... individual 0..1Reference(Profile qicore-practitioner | Profile qicore-relatedperson)Persons involved in the encounter other than the patient
... appointment ∑0..1Reference(Appointment)The appointment that scheduled this encounter
... period S0..1PeriodThe start and end time of the encounter
... length S0..1DurationQuantity of time the encounter lasted (less time absent)
... reason S0..*CodeableConceptReason the encounter takes place (code)
Binding: 7.org/fhir/daf/ValueSet/daf-encounter-reason (preferred)
... indication 0..*Reference(Condition | Procedure)Reason the encounter takes place (resource)
... account 0..*Reference(Account)The set of accounts that may be used for billing for this Encounter
... hospitalization 0..1BackboneElementDetails about the admission to a healthcare service
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... preAdmissionIdentifier 0..1IdentifierPre-admission identifier
.... origin 0..1Reference(Profile qicore-location)The location from which the patient came before admission
.... admitSource S0..1CodeableConceptFrom where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred)
.... admittingDiagnosis 0..*Reference(Condition)The admitting diagnosis as reported by admitting practitioner
.... reAdmission S0..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: v2 Re-Admission Indicator (example)
.... dietPreference 0..*CodeableConceptDiet preferences reported by the patient
Binding: Diet (example)
.... specialCourtesy 0..*CodeableConceptSpecial courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred)
.... specialArrangement 0..*CodeableConceptWheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred)
.... destination 0..1Reference(Profile qicore-location)Location to which the patient is discharged
.... dischargeDisposition S0..1CodeableConceptCategory or kind of location after discharge
Binding: DischargeDisposition (example)
.... dischargeDiagnosis S0..*Reference(Condition)The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete
... location 0..*BackboneElementList of locations where the patient has been
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... location 1..1Reference(Profile qicore-location)Location the encounter takes place
.... status 0..1codeplanned | active | reserved | completed
Binding: EncounterLocationStatus (required)
.... period 0..1PeriodTime period during which the patient was present at the location
... serviceProvider S0..1Reference(Profile qicore-organization)The custodian organization of this Encounter record
... partOf 0..1Reference(Profile qicore-encounter)Another Encounter this encounter is part of

doco Documentation for this format

yet to be done: Xml template

yet to be done: Json template

Differential View

This structure is derived from StructureDefinition.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*
... status S1..1code
... class S0..1Coding
... type S0..*CodeableConceptBinding: 7.org/fhir/daf/ValueSet/daf-encounter-type (preferred)
... priority 0..1CodeableConceptBinding: SNOMED CT Priorities Codes (preferred)
... patient S0..1Reference(Profile qicore-patient)
... incomingReferral 0..*Reference(Profile qicore-referralrequest)
... participant 0..*BackboneElement
.... individual 0..1Reference(Profile qicore-practitioner | Profile qicore-relatedperson)
... period S0..1Period
... length S0..1Duration
... reason S0..*CodeableConceptBinding: 7.org/fhir/daf/ValueSet/daf-encounter-reason (preferred)
... hospitalization 0..1BackboneElement
.... origin 0..1Reference(Profile qicore-location)
.... admitSource S0..1CodeableConcept
.... reAdmission S0..1CodeableConcept
.... destination 0..1Reference(Profile qicore-location)
.... dischargeDisposition S0..1CodeableConcept
.... dischargeDiagnosis S0..*Reference(Condition)
... location 0..*BackboneElement
.... location 1..1Reference(Profile qicore-location)
.... period 0..1Period
... serviceProvider S0..1Reference(Profile qicore-organization)
... partOf 0..1Reference(Profile qicore-encounter)
... encounter-relatedCondition 0..*Reference(Condition)Other associated conditions
URL: http://hl7.org/fhir/StructureDefinition/encounter-relatedCondition
.... condition 1..1Reference(Condition)A condition related to this encounter
URL: condition
..... valueReference 1..1Reference(Profile qicore-condition)
.... role 1..1CodeableConceptThe role of the condition
URL: role
Binding: SNOMED CT Qualifier For Type of Diagnosis Codes (preferred)
... encounter-reasonCancelled 0..1CodeableConceptExplanation for cancellation
URL: http://hl7.org/fhir/StructureDefinition/encounter-reasonCancelled
Binding: Reasons for canceled or refused encounter codes (example)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter I0..*An interaction during which services are provided to the patient
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... 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: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... encounter-relatedCondition I0..*Reference(Condition)Extension
URL: http://hl7.org/fhir/StructureDefinition/encounter-relatedCondition
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..1ExtensionA condition related to this encounter
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"condition"
..... valueReference 1..1Reference(Condition)Detailed information about conditions, problems or diagnoses
.... extension 0..1ExtensionThe role of the condition
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"role"
..... valueCodeableConcept 1..1CodeableConceptValue of extension
.... condition 1..1Reference(Condition)Extension
URL: condition
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..1ExtensionA condition related to this encounter
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"condition"
...... valueReference 1..1Reference(Condition)Detailed information about conditions, problems or diagnoses
..... extension 0..1ExtensionThe role of the condition
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"role"
...... valueCodeableConcept 1..1CodeableConceptValue of extension
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/encounter-relatedCondition"
..... valueReference 1..1Reference(Profile qicore-condition)Detailed information about conditions, problems or diagnoses
.... role 1..1CodeableConceptExtension
URL: role
Binding: SNOMED CT Qualifier For Type of Diagnosis Codes (preferred)
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/encounter-relatedCondition"
.... valueReference 0..1Reference(Condition)Detailed information about conditions, problems or diagnoses
... encounter-reasonCancelled I0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/encounter-reasonCancelled
Binding: Reasons for canceled or refused encounter codes (example)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ∑0..*IdentifierIdentifier(s) by which this encounter is known
... status ?!S1..1codeplanned | arrived | in-progress | onleave | finished | cancelled | entered-in-error
Binding: EncounterStatus (required)
... statusHistory 0..*BackboneElementList of past encounter statuses
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... status 1..1codeplanned | arrived | in-progress | onleave | finished | cancelled | entered-in-error
Binding: EncounterStatus (required)
.... period 1..1PeriodThe time that the episode was in the specified status
... class S0..1Codinginpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible)
... type S0..*CodeableConceptSpecific type of encounter
Binding: 7.org/fhir/daf/ValueSet/daf-encounter-type (preferred)
... priority 0..1CodeableConceptIndicates the urgency of the encounter
Binding: SNOMED CT Priorities Codes (preferred)
... patient S0..1Reference(Profile qicore-patient)The patient present at the encounter
... episodeOfCare ∑0..*Reference(EpisodeOfCare)Episode(s) of care that this encounter should be recorded against
... incomingReferral 0..*Reference(Profile qicore-referralrequest)The ReferralRequest that initiated this encounter
... participant 0..*BackboneElementList of participants involved in the encounter
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... type ∑0..*CodeableConceptRole of participant in encounter
Binding: ParticipantType (extensible)
.... period 0..1PeriodPeriod of time during the encounter participant was present
.... individual 0..1Reference(Profile qicore-practitioner | Profile qicore-relatedperson)Persons involved in the encounter other than the patient
... appointment ∑0..1Reference(Appointment)The appointment that scheduled this encounter
... period S0..1PeriodThe start and end time of the encounter
... length S0..1DurationQuantity of time the encounter lasted (less time absent)
... reason S0..*CodeableConceptReason the encounter takes place (code)
Binding: 7.org/fhir/daf/ValueSet/daf-encounter-reason (preferred)
... indication 0..*Reference(Condition | Procedure)Reason the encounter takes place (resource)
... account 0..*Reference(Account)The set of accounts that may be used for billing for this Encounter
... hospitalization 0..1BackboneElementDetails about the admission to a healthcare service
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... preAdmissionIdentifier 0..1IdentifierPre-admission identifier
.... origin 0..1Reference(Profile qicore-location)The location from which the patient came before admission
.... admitSource S0..1CodeableConceptFrom where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred)
.... admittingDiagnosis 0..*Reference(Condition)The admitting diagnosis as reported by admitting practitioner
.... reAdmission S0..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: v2 Re-Admission Indicator (example)
.... dietPreference 0..*CodeableConceptDiet preferences reported by the patient
Binding: Diet (example)
.... specialCourtesy 0..*CodeableConceptSpecial courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred)
.... specialArrangement 0..*CodeableConceptWheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred)
.... destination 0..1Reference(Profile qicore-location)Location to which the patient is discharged
.... dischargeDisposition S0..1CodeableConceptCategory or kind of location after discharge
Binding: DischargeDisposition (example)
.... dischargeDiagnosis S0..*Reference(Condition)The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete
... location 0..*BackboneElementList of locations where the patient has been
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... location 1..1Reference(Profile qicore-location)Location the encounter takes place
.... status 0..1codeplanned | active | reserved | completed
Binding: EncounterLocationStatus (required)
.... period 0..1PeriodTime period during which the patient was present at the location
... serviceProvider S0..1Reference(Profile qicore-organization)The custodian organization of this Encounter record
... partOf 0..1Reference(Profile qicore-encounter)Another Encounter this encounter is part of

doco Documentation for this format

XML Template

yet to be done: Xml template

JSON Template

yet to be done: Json template

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
Encounter.languageCommon LanguagesextensibleCommon Languages
Encounter.extension.extension
http://hl7.org/fhir/StructureDefinition/encounter-relatedCondition#role		SNOMED CT Qualifier For Type of Diagnosis CodespreferredSNOMED CT Qualifier For Type of Diagnosis Codes
Encounter.extension
http://hl7.org/fhir/StructureDefinition/encounter-reasonCancelled		Reasons for canceled or refused encounter codesexampleReasons for canceled or refused encounter codes
Encounter.statusEncounterStatusrequiredEncounterStatus
Encounter.statusHistory.statusEncounterStatusrequiredEncounterStatus
Encounter.classActEncounterCodeextensibleActEncounterCode
Encounter.type?extpreferredhttp://hl7.org/fhir/daf/ValueSet/daf-encounter-type
Encounter.prioritySNOMED CT Priorities CodespreferredSNOMED CT Priorities Codes
Encounter.participant.typeParticipantTypeextensibleParticipantType
Encounter.reason?extpreferredhttp://hl7.org/fhir/daf/ValueSet/daf-encounter-reason
Encounter.hospitalization.admitSourceAdmitSourcepreferredAdmitSource
Encounter.hospitalization.reAdmissionv2 Re-Admission Indicatorexamplev2 Re-Admission Indicator
Encounter.hospitalization.dietPreferenceDietexampleDiet
Encounter.hospitalization.specialCourtesySpecialCourtesypreferredSpecialCourtesy
Encounter.hospitalization.specialArrangementSpecialArrangementspreferredSpecialArrangements
Encounter.hospitalization.dischargeDispositionDischargeDispositionexampleDischargeDisposition
Encounter.location.statusEncounterLocationStatusrequiredEncounterLocationStatus

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2EncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1EncounterIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4EncounterIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3EncounterIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
ele-1Encounter.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Encounter.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Encounter.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Encounter.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Encounter.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Encounter.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
.