Extensions for Using Data Elements from FHIR R4 in FHIR R5
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R4 in FHIR R5 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R4_Encounter_R5

Official URL: http://hl7.org/fhir/4.0/StructureDefinition/profile-Encounter Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R4_Encounter_R5

This cross-version profile allows R4 Encounter content to be represented via FHIR R5 Encounter resources.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter(5.0.0) An interaction during which services are provided to the patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:statusHistory 0..* (Complex) R4: List of past encounter statuses (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.statusHistory
Constraints: ext-1
.... extension:classHistory 0..* (Complex) R4: List of past encounter classes (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.classHistory
Constraints: ext-1
... status ?!Σ 1..1 code planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
Binding: EncounterStatus . (required): Current state of the encounter.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:status 0..1 code R4: planned | arrived | triaged | in-progress | onleave | finished | cancelled +
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.status
Binding: R4EncounterStatusForR5 (0.1.0) (required): Current state of the encounter.
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.status Base required Encounter Status . 📍5.0.0 tx.fhir.org

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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Encounter If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter A resource should have narrative for robust management text.`div`.exists()
ele-1 error Encounter.implicitRules, Encounter.extension, Encounter.extension:statusHistory, Encounter.extension:classHistory, Encounter.modifierExtension, Encounter.status, Encounter.status.extension, Encounter.status.extension:status All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Encounter.extension, Encounter.extension:statusHistory, Encounter.extension:classHistory, Encounter.modifierExtension, Encounter.status.extension, Encounter.status.extension:status Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter(5.0.0) An interaction during which services are provided to the patient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:statusHistory 0..* (Complex) R4: List of past encounter statuses (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.statusHistory
.... extension:classHistory 0..* (Complex) R4: List of past encounter classes (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.classHistory
... status
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:status 0..1 code R4: planned | arrived | triaged | in-progress | onleave | finished | cancelled +
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.status
Binding: R4EncounterStatusForR5 (0.1.0) (required): Current state of the encounter.
... reason
.... value
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:reasonReference 0..* Reference(Cross-version Profile for R4.Procedure for use in FHIR R5(0.1.0) | Procedure | Cross-version Profile for R4.Observation for use in FHIR R5(0.1.0) | Observation | Cross-version Profile for R4.ImmunizationRecommendation for use in FHIR R5(0.1.0) | ImmunizationRecommendation) R4: Reason the encounter takes place (reference) additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.reasonReference
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:rank 0..1 positiveInt R4: Ranking of the diagnosis (for each role type) (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.diagnosis.rank
.... condition
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:condition 1..1 Reference(Cross-version Profile for R4.Procedure for use in FHIR R5(0.1.0) | Procedure) R4: The diagnosis or procedure relevant to the encounter additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.diagnosis.condition
... admission
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:dietPreference 0..* CodeableConcept R4: Diet preferences reported by the patient (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.hospitalization.dietPreference
Binding: EncounterDiet (example): Medical, cultural or ethical food preferences to help with catering requirements.
..... extension:specialCourtesy 0..* CodeableConcept R4: Special courtesies (VIP, board member) (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.hospitalization.specialCourtesy
Binding: SpecialCourtesy (preferred): Special courtesies.
..... extension:specialArrangement 0..* CodeableConcept R4: Wheelchair, translator, stretcher, etc. (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.hospitalization.specialArrangement
Binding: SpecialArrangements (preferred): Special arrangements.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter(5.0.0) An interaction during which services are provided to the patient
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... 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
Constraints: ext-1
.... extension:statusHistory 0..* (Complex) R4: List of past encounter statuses (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.statusHistory
Constraints: ext-1
.... extension:classHistory 0..* (Complex) R4: List of past encounter classes (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.classHistory
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Identifier(s) by which this encounter is known
... status ?!Σ 1..1 code planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
Binding: EncounterStatus . (required): Current state of the encounter.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:status 0..1 code R4: planned | arrived | triaged | in-progress | onleave | finished | cancelled +
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.status
Binding: R4EncounterStatusForR5 (0.1.0) (required): Current state of the encounter.
Constraints: ext-1
.... value 0..1 code Primitive value for code
... class Σ 0..* CodeableConcept Classification of patient encounter context - e.g. Inpatient, outpatient
Binding: EncounterClass (2.0.1) (preferred): Classification of the encounter.
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter.
... type Σ 0..* CodeableConcept Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...)
Binding: EncounterType (example): A specific code indicating type of service provided
... serviceType Σ 0..* CodeableReference(HealthcareService) Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
... subject Σ 0..1 Reference(Patient | Group) The patient or group related to this encounter
... subjectStatus 0..1 CodeableConcept The current status of the subject in relation to the Encounter
Binding: EncounterSubjectStatus (example): Current status of the subject within the encounter.
... episodeOfCare Σ 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
... basedOn 0..* Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest) The request that initiated this encounter
... careTeam 0..* Reference(CareTeam) The group(s) that are allocated to participate in this encounter
... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of
... serviceProvider 0..1 Reference(Organization) The organization (facility) responsible for this encounter
... participant ΣC 0..* BackboneElement List of participants involved in the encounter
Constraints: enc-1, enc-2
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... type ΣC 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
.... period 0..1 Period Period of time during the encounter that the participant participated
.... actor ΣC 0..1 Reference(Patient | Group | RelatedPerson | Practitioner | PractitionerRole | Device | HealthcareService) The individual, device, or service participating in the encounter
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
... virtualService 0..* VirtualServiceDetail Connection details of a virtual service (e.g. conference call)
... actualPeriod 0..1 Period The actual start and end time of the encounter
... plannedStartDate 0..1 dateTime The planned start date/time (or admission date) of the encounter
... plannedEndDate 0..1 dateTime The planned end date/time (or discharge date) of the encounter
... length 0..1 Duration Actual quantity of time the encounter lasted (less time absent)
... reason Σ 0..* BackboneElement The list of medical reasons that are expected to be addressed during the episode of care
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... use Σ 0..* CodeableConcept What the reason value should be used for/as
Binding: EncounterReasonUse (example)
.... value Σ 0..* CodeableReference(Condition | DiagnosticReport | Observation | ImmunizationRecommendation | Procedure) Reason the encounter takes place (core or reference)
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:reasonReference 0..* Reference(Cross-version Profile for R4.Procedure for use in FHIR R5(0.1.0) | Procedure | Cross-version Profile for R4.Observation for use in FHIR R5(0.1.0) | Observation | Cross-version Profile for R4.ImmunizationRecommendation for use in FHIR R5(0.1.0) | ImmunizationRecommendation) R4: Reason the encounter takes place (reference) additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.reasonReference
Constraints: ext-1
..... concept Σ 0..1 CodeableConcept Reference to a concept (by class)
..... reference Σ 0..1 Reference() Reference to a resource (by instance)
... diagnosis Σ 0..* BackboneElement 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
Constraints: ext-1
..... extension:rank 0..1 positiveInt R4: Ranking of the diagnosis (for each role type) (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.diagnosis.rank
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... condition Σ 0..* CodeableReference(Condition) The diagnosis relevant to the encounter
Binding: ConditionProblemDiagnosisCodes (example)
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:condition 1..1 Reference(Cross-version Profile for R4.Procedure for use in FHIR R5(0.1.0) | Procedure) R4: The diagnosis or procedure relevant to the encounter additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.diagnosis.condition
Constraints: ext-1
..... concept Σ 0..1 CodeableConcept Reference to a concept (by class)
..... reference Σ 0..1 Reference() Reference to a resource (by instance)
.... use 0..* CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: EncounterDiagnosisUse (preferred): The type of diagnosis this condition represents.
... account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: EncounterDiet (example): Medical, cultural or ethical food preferences to help with catering requirements.
... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc
Binding: SpecialArrangements (preferred): Special arrangements.
... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
... admission 0..1 BackboneElement Details about the admission to a healthcare service
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:dietPreference 0..* CodeableConcept R4: Diet preferences reported by the patient (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.hospitalization.dietPreference
Binding: EncounterDiet (example): Medical, cultural or ethical food preferences to help with catering requirements.
Constraints: ext-1
..... extension:specialCourtesy 0..* CodeableConcept R4: Special courtesies (VIP, board member) (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.hospitalization.specialCourtesy
Binding: SpecialCourtesy (preferred): Special courtesies.
Constraints: ext-1
..... extension:specialArrangement 0..* CodeableConcept R4: Wheelchair, translator, stretcher, etc. (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.hospitalization.specialArrangement
Binding: SpecialArrangements (preferred): Special arrangements.
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
.... admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.
.... reAdmission 0..1 CodeableConcept Indicates that the patient is being re-admitted
Binding: Hl7VSReAdmissionIndicator (3.0.0) (example): The reason for re-admission of this admission encounter.
.... destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
.... dischargeDisposition 0..1 CodeableConcept Category or kind of location after discharge
Binding: DischargeDisposition (example): Discharge Disposition.
... location 0..* BackboneElement List of locations where the patient has been
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... location 1..1 Reference(Location) Location the encounter takes place
.... status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
.... form 0..1 CodeableConcept The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.)
Binding: LocationForm (example): Physical form of the location.
.... period 0..1 Period Time period during which the patient was present at the location

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.language Base required All Languages 📍5.0.0 FHIR Std.
Encounter.status Base required Encounter Status . 📍5.0.0 tx.fhir.org
Encounter.class Base preferred Encounter class 📍2.0.1 THO v7.1
Encounter.priority Base example ActPriority 📍3.0.0 THO v7.1
Encounter.type Base example Encounter Type 📍5.0.0 FHIR Std.
Encounter.serviceType Base example Service Type 📍5.0.0 FHIR Std.
Encounter.subjectStatus Base example Encounter Subject Status 📍5.0.0 FHIR Std.
Encounter.participant.​type Base extensible Participant Type 📍5.0.0 FHIR Std.
Encounter.reason.use Base example Encounter Reason Use 📍5.0.0 FHIR Std.
Encounter.reason.value Base preferred Encounter Reason Codes 📍5.0.0 FHIR Std.
Encounter.diagnosis.​condition Base example Condition/Problem/Diagnosis Codes 📍5.0.0 FHIR Std.
Encounter.diagnosis.​use Base preferred Encounter Diagnosis Use 📍5.0.0 FHIR Std.
Encounter.dietPreference Base example Diet 📍5.0.0 FHIR Std.
Encounter.specialArrangement Base preferred Special Arrangements 📍5.0.0 FHIR Std.
Encounter.specialCourtesy Base preferred Special Courtesy 📍5.0.0 FHIR Std.
Encounter.admission.​admitSource Base preferred Admit Source 📍5.0.0 FHIR Std.
Encounter.admission.​reAdmission Base example hl7VS-re-admissionIndicator 📍3.0.0 THO v7.1
Encounter.admission.​dischargeDisposition Base example Discharge Disposition 📍5.0.0 FHIR Std.
Encounter.location.status Base required Encounter Location Status 📍5.0.0 FHIR Std.
Encounter.location.form Base example Location Form 📍5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Encounter If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter A resource should have narrative for robust management text.`div`.exists()
ele-1 error Encounter.meta, Encounter.implicitRules, Encounter.language, Encounter.text, Encounter.extension, Encounter.extension:statusHistory, Encounter.extension:classHistory, Encounter.modifierExtension, Encounter.identifier, Encounter.status, Encounter.status.extension, Encounter.status.extension:status, Encounter.class, Encounter.priority, Encounter.type, Encounter.serviceType, Encounter.subject, Encounter.subjectStatus, Encounter.episodeOfCare, Encounter.basedOn, Encounter.careTeam, Encounter.partOf, Encounter.serviceProvider, Encounter.participant, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant.type, Encounter.participant.period, Encounter.participant.actor, Encounter.appointment, Encounter.virtualService, Encounter.actualPeriod, Encounter.plannedStartDate, Encounter.plannedEndDate, Encounter.length, Encounter.reason, Encounter.reason.extension, Encounter.reason.modifierExtension, Encounter.reason.use, Encounter.reason.value, Encounter.reason.value.extension, Encounter.reason.value.extension:reasonReference, Encounter.reason.value.concept, Encounter.reason.value.reference, Encounter.diagnosis, Encounter.diagnosis.extension, Encounter.diagnosis.extension:rank, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition, Encounter.diagnosis.condition.extension, Encounter.diagnosis.condition.extension:condition, Encounter.diagnosis.condition.concept, Encounter.diagnosis.condition.reference, Encounter.diagnosis.use, Encounter.account, Encounter.dietPreference, Encounter.specialArrangement, Encounter.specialCourtesy, Encounter.admission, Encounter.admission.extension, Encounter.admission.extension:dietPreference, Encounter.admission.extension:specialCourtesy, Encounter.admission.extension:specialArrangement, Encounter.admission.modifierExtension, Encounter.admission.preAdmissionIdentifier, Encounter.admission.origin, Encounter.admission.admitSource, Encounter.admission.reAdmission, Encounter.admission.destination, Encounter.admission.dischargeDisposition, Encounter.location, Encounter.location.extension, Encounter.location.modifierExtension, Encounter.location.location, Encounter.location.status, Encounter.location.form, Encounter.location.period All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
enc-1 error Encounter.participant A type must be provided when no explicit actor is specified actor.exists() or type.exists()
enc-2 error Encounter.participant A type cannot be provided for a patient or group participant actor.exists(resolve() is Patient or resolve() is Group) implies type.exists().not()
ext-1 error Encounter.extension, Encounter.extension:statusHistory, Encounter.extension:classHistory, Encounter.modifierExtension, Encounter.status.extension, Encounter.status.extension:status, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.reason.extension, Encounter.reason.modifierExtension, Encounter.reason.value.extension, Encounter.reason.value.extension:reasonReference, Encounter.diagnosis.extension, Encounter.diagnosis.extension:rank, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition.extension, Encounter.diagnosis.condition.extension:condition, Encounter.admission.extension, Encounter.admission.extension:dietPreference, Encounter.admission.extension:specialCourtesy, Encounter.admission.extension:specialArrangement, Encounter.admission.modifierExtension, Encounter.location.extension, Encounter.location.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter(5.0.0) An interaction during which services are provided to the patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:statusHistory 0..* (Complex) R4: List of past encounter statuses (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.statusHistory
Constraints: ext-1
.... extension:classHistory 0..* (Complex) R4: List of past encounter classes (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.classHistory
Constraints: ext-1
... status ?!Σ 1..1 code planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
Binding: EncounterStatus . (required): Current state of the encounter.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:status 0..1 code R4: planned | arrived | triaged | in-progress | onleave | finished | cancelled +
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.status
Binding: R4EncounterStatusForR5 (0.1.0) (required): Current state of the encounter.
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.status Base required Encounter Status . 📍5.0.0 tx.fhir.org

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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Encounter If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter A resource should have narrative for robust management text.`div`.exists()
ele-1 error Encounter.implicitRules, Encounter.extension, Encounter.extension:statusHistory, Encounter.extension:classHistory, Encounter.modifierExtension, Encounter.status, Encounter.status.extension, Encounter.status.extension:status All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Encounter.extension, Encounter.extension:statusHistory, Encounter.extension:classHistory, Encounter.modifierExtension, Encounter.status.extension, Encounter.status.extension:status Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter(5.0.0) An interaction during which services are provided to the patient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:statusHistory 0..* (Complex) R4: List of past encounter statuses (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.statusHistory
.... extension:classHistory 0..* (Complex) R4: List of past encounter classes (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.classHistory
... status
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:status 0..1 code R4: planned | arrived | triaged | in-progress | onleave | finished | cancelled +
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.status
Binding: R4EncounterStatusForR5 (0.1.0) (required): Current state of the encounter.
... reason
.... value
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:reasonReference 0..* Reference(Cross-version Profile for R4.Procedure for use in FHIR R5(0.1.0) | Procedure | Cross-version Profile for R4.Observation for use in FHIR R5(0.1.0) | Observation | Cross-version Profile for R4.ImmunizationRecommendation for use in FHIR R5(0.1.0) | ImmunizationRecommendation) R4: Reason the encounter takes place (reference) additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.reasonReference
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:rank 0..1 positiveInt R4: Ranking of the diagnosis (for each role type) (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.diagnosis.rank
.... condition
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:condition 1..1 Reference(Cross-version Profile for R4.Procedure for use in FHIR R5(0.1.0) | Procedure) R4: The diagnosis or procedure relevant to the encounter additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.diagnosis.condition
... admission
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:dietPreference 0..* CodeableConcept R4: Diet preferences reported by the patient (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.hospitalization.dietPreference
Binding: EncounterDiet (example): Medical, cultural or ethical food preferences to help with catering requirements.
..... extension:specialCourtesy 0..* CodeableConcept R4: Special courtesies (VIP, board member) (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.hospitalization.specialCourtesy
Binding: SpecialCourtesy (preferred): Special courtesies.
..... extension:specialArrangement 0..* CodeableConcept R4: Wheelchair, translator, stretcher, etc. (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.hospitalization.specialArrangement
Binding: SpecialArrangements (preferred): Special arrangements.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter(5.0.0) An interaction during which services are provided to the patient
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... 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
Constraints: ext-1
.... extension:statusHistory 0..* (Complex) R4: List of past encounter statuses (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.statusHistory
Constraints: ext-1
.... extension:classHistory 0..* (Complex) R4: List of past encounter classes (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.classHistory
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Identifier(s) by which this encounter is known
... status ?!Σ 1..1 code planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
Binding: EncounterStatus . (required): Current state of the encounter.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:status 0..1 code R4: planned | arrived | triaged | in-progress | onleave | finished | cancelled +
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.status
Binding: R4EncounterStatusForR5 (0.1.0) (required): Current state of the encounter.
Constraints: ext-1
.... value 0..1 code Primitive value for code
... class Σ 0..* CodeableConcept Classification of patient encounter context - e.g. Inpatient, outpatient
Binding: EncounterClass (2.0.1) (preferred): Classification of the encounter.
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter.
... type Σ 0..* CodeableConcept Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...)
Binding: EncounterType (example): A specific code indicating type of service provided
... serviceType Σ 0..* CodeableReference(HealthcareService) Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
... subject Σ 0..1 Reference(Patient | Group) The patient or group related to this encounter
... subjectStatus 0..1 CodeableConcept The current status of the subject in relation to the Encounter
Binding: EncounterSubjectStatus (example): Current status of the subject within the encounter.
... episodeOfCare Σ 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
... basedOn 0..* Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest) The request that initiated this encounter
... careTeam 0..* Reference(CareTeam) The group(s) that are allocated to participate in this encounter
... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of
... serviceProvider 0..1 Reference(Organization) The organization (facility) responsible for this encounter
... participant ΣC 0..* BackboneElement List of participants involved in the encounter
Constraints: enc-1, enc-2
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... type ΣC 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
.... period 0..1 Period Period of time during the encounter that the participant participated
.... actor ΣC 0..1 Reference(Patient | Group | RelatedPerson | Practitioner | PractitionerRole | Device | HealthcareService) The individual, device, or service participating in the encounter
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
... virtualService 0..* VirtualServiceDetail Connection details of a virtual service (e.g. conference call)
... actualPeriod 0..1 Period The actual start and end time of the encounter
... plannedStartDate 0..1 dateTime The planned start date/time (or admission date) of the encounter
... plannedEndDate 0..1 dateTime The planned end date/time (or discharge date) of the encounter
... length 0..1 Duration Actual quantity of time the encounter lasted (less time absent)
... reason Σ 0..* BackboneElement The list of medical reasons that are expected to be addressed during the episode of care
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... use Σ 0..* CodeableConcept What the reason value should be used for/as
Binding: EncounterReasonUse (example)
.... value Σ 0..* CodeableReference(Condition | DiagnosticReport | Observation | ImmunizationRecommendation | Procedure) Reason the encounter takes place (core or reference)
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:reasonReference 0..* Reference(Cross-version Profile for R4.Procedure for use in FHIR R5(0.1.0) | Procedure | Cross-version Profile for R4.Observation for use in FHIR R5(0.1.0) | Observation | Cross-version Profile for R4.ImmunizationRecommendation for use in FHIR R5(0.1.0) | ImmunizationRecommendation) R4: Reason the encounter takes place (reference) additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.reasonReference
Constraints: ext-1
..... concept Σ 0..1 CodeableConcept Reference to a concept (by class)
..... reference Σ 0..1 Reference() Reference to a resource (by instance)
... diagnosis Σ 0..* BackboneElement 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
Constraints: ext-1
..... extension:rank 0..1 positiveInt R4: Ranking of the diagnosis (for each role type) (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.diagnosis.rank
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... condition Σ 0..* CodeableReference(Condition) The diagnosis relevant to the encounter
Binding: ConditionProblemDiagnosisCodes (example)
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:condition 1..1 Reference(Cross-version Profile for R4.Procedure for use in FHIR R5(0.1.0) | Procedure) R4: The diagnosis or procedure relevant to the encounter additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.diagnosis.condition
Constraints: ext-1
..... concept Σ 0..1 CodeableConcept Reference to a concept (by class)
..... reference Σ 0..1 Reference() Reference to a resource (by instance)
.... use 0..* CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: EncounterDiagnosisUse (preferred): The type of diagnosis this condition represents.
... account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: EncounterDiet (example): Medical, cultural or ethical food preferences to help with catering requirements.
... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc
Binding: SpecialArrangements (preferred): Special arrangements.
... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
... admission 0..1 BackboneElement Details about the admission to a healthcare service
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:dietPreference 0..* CodeableConcept R4: Diet preferences reported by the patient (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.hospitalization.dietPreference
Binding: EncounterDiet (example): Medical, cultural or ethical food preferences to help with catering requirements.
Constraints: ext-1
..... extension:specialCourtesy 0..* CodeableConcept R4: Special courtesies (VIP, board member) (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.hospitalization.specialCourtesy
Binding: SpecialCourtesy (preferred): Special courtesies.
Constraints: ext-1
..... extension:specialArrangement 0..* CodeableConcept R4: Wheelchair, translator, stretcher, etc. (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.hospitalization.specialArrangement
Binding: SpecialArrangements (preferred): Special arrangements.
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
.... admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.
.... reAdmission 0..1 CodeableConcept Indicates that the patient is being re-admitted
Binding: Hl7VSReAdmissionIndicator (3.0.0) (example): The reason for re-admission of this admission encounter.
.... destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
.... dischargeDisposition 0..1 CodeableConcept Category or kind of location after discharge
Binding: DischargeDisposition (example): Discharge Disposition.
... location 0..* BackboneElement List of locations where the patient has been
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... location 1..1 Reference(Location) Location the encounter takes place
.... status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
.... form 0..1 CodeableConcept The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.)
Binding: LocationForm (example): Physical form of the location.
.... period 0..1 Period Time period during which the patient was present at the location

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.language Base required All Languages 📍5.0.0 FHIR Std.
Encounter.status Base required Encounter Status . 📍5.0.0 tx.fhir.org
Encounter.class Base preferred Encounter class 📍2.0.1 THO v7.1
Encounter.priority Base example ActPriority 📍3.0.0 THO v7.1
Encounter.type Base example Encounter Type 📍5.0.0 FHIR Std.
Encounter.serviceType Base example Service Type 📍5.0.0 FHIR Std.
Encounter.subjectStatus Base example Encounter Subject Status 📍5.0.0 FHIR Std.
Encounter.participant.​type Base extensible Participant Type 📍5.0.0 FHIR Std.
Encounter.reason.use Base example Encounter Reason Use 📍5.0.0 FHIR Std.
Encounter.reason.value Base preferred Encounter Reason Codes 📍5.0.0 FHIR Std.
Encounter.diagnosis.​condition Base example Condition/Problem/Diagnosis Codes 📍5.0.0 FHIR Std.
Encounter.diagnosis.​use Base preferred Encounter Diagnosis Use 📍5.0.0 FHIR Std.
Encounter.dietPreference Base example Diet 📍5.0.0 FHIR Std.
Encounter.specialArrangement Base preferred Special Arrangements 📍5.0.0 FHIR Std.
Encounter.specialCourtesy Base preferred Special Courtesy 📍5.0.0 FHIR Std.
Encounter.admission.​admitSource Base preferred Admit Source 📍5.0.0 FHIR Std.
Encounter.admission.​reAdmission Base example hl7VS-re-admissionIndicator 📍3.0.0 THO v7.1
Encounter.admission.​dischargeDisposition Base example Discharge Disposition 📍5.0.0 FHIR Std.
Encounter.location.status Base required Encounter Location Status 📍5.0.0 FHIR Std.
Encounter.location.form Base example Location Form 📍5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Encounter If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter A resource should have narrative for robust management text.`div`.exists()
ele-1 error Encounter.meta, Encounter.implicitRules, Encounter.language, Encounter.text, Encounter.extension, Encounter.extension:statusHistory, Encounter.extension:classHistory, Encounter.modifierExtension, Encounter.identifier, Encounter.status, Encounter.status.extension, Encounter.status.extension:status, Encounter.class, Encounter.priority, Encounter.type, Encounter.serviceType, Encounter.subject, Encounter.subjectStatus, Encounter.episodeOfCare, Encounter.basedOn, Encounter.careTeam, Encounter.partOf, Encounter.serviceProvider, Encounter.participant, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant.type, Encounter.participant.period, Encounter.participant.actor, Encounter.appointment, Encounter.virtualService, Encounter.actualPeriod, Encounter.plannedStartDate, Encounter.plannedEndDate, Encounter.length, Encounter.reason, Encounter.reason.extension, Encounter.reason.modifierExtension, Encounter.reason.use, Encounter.reason.value, Encounter.reason.value.extension, Encounter.reason.value.extension:reasonReference, Encounter.reason.value.concept, Encounter.reason.value.reference, Encounter.diagnosis, Encounter.diagnosis.extension, Encounter.diagnosis.extension:rank, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition, Encounter.diagnosis.condition.extension, Encounter.diagnosis.condition.extension:condition, Encounter.diagnosis.condition.concept, Encounter.diagnosis.condition.reference, Encounter.diagnosis.use, Encounter.account, Encounter.dietPreference, Encounter.specialArrangement, Encounter.specialCourtesy, Encounter.admission, Encounter.admission.extension, Encounter.admission.extension:dietPreference, Encounter.admission.extension:specialCourtesy, Encounter.admission.extension:specialArrangement, Encounter.admission.modifierExtension, Encounter.admission.preAdmissionIdentifier, Encounter.admission.origin, Encounter.admission.admitSource, Encounter.admission.reAdmission, Encounter.admission.destination, Encounter.admission.dischargeDisposition, Encounter.location, Encounter.location.extension, Encounter.location.modifierExtension, Encounter.location.location, Encounter.location.status, Encounter.location.form, Encounter.location.period All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
enc-1 error Encounter.participant A type must be provided when no explicit actor is specified actor.exists() or type.exists()
enc-2 error Encounter.participant A type cannot be provided for a patient or group participant actor.exists(resolve() is Patient or resolve() is Group) implies type.exists().not()
ext-1 error Encounter.extension, Encounter.extension:statusHistory, Encounter.extension:classHistory, Encounter.modifierExtension, Encounter.status.extension, Encounter.status.extension:status, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.reason.extension, Encounter.reason.modifierExtension, Encounter.reason.value.extension, Encounter.reason.value.extension:reasonReference, Encounter.diagnosis.extension, Encounter.diagnosis.extension:rank, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition.extension, Encounter.diagnosis.condition.extension:condition, Encounter.admission.extension, Encounter.admission.extension:dietPreference, Encounter.admission.extension:specialCourtesy, Encounter.admission.extension:specialArrangement, Encounter.admission.modifierExtension, Encounter.location.extension, Encounter.location.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron