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

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

Resource Profile: Profile_R4_Encounter_R3

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_R3

This cross-version profile allows R4 Encounter content to be represented via FHIR STU3 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 An interaction during which services are provided to the patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:serviceType 0..1 CodeableConcept R4: Specific type of service (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.serviceType
.... extension:reasonReference 0..* Reference(Cross-version Profile for R4.Condition for use in FHIR STU3(0.1.0) | Condition | Cross-version Profile for R4.Procedure for use in FHIR STU3(0.1.0) | Procedure | Cross-version Profile for R4.Observation for use in FHIR STU3(0.1.0) | Observation | Cross-version Profile for R4.ImmunizationRecommendation for use in FHIR STU3(0.1.0) | ImmunizationRecommendation) R4: Reason the encounter takes place (reference) (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.reasonReference
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.status Base required EncounterStatus 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error Encounter If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions 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 An interaction during which services are provided to the patient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:serviceType 0..1 CodeableConcept R4: Specific type of service (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.serviceType
.... extension:reasonReference 0..* Reference(Cross-version Profile for R4.Condition for use in FHIR STU3(0.1.0) | Condition | Cross-version Profile for R4.Procedure for use in FHIR STU3(0.1.0) | Procedure | Cross-version Profile for R4.Observation for use in FHIR STU3(0.1.0) | Observation | Cross-version Profile for R4.ImmunizationRecommendation for use in FHIR STU3(0.1.0) | ImmunizationRecommendation) R4: Reason the encounter takes place (reference) (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.reasonReference
... incomingReferral
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:basedOn 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: The ServiceRequest that initiated this encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... participant
.... individual
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:individual 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: individual
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... origin
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:origin 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: The location/organization from which the patient came before admission additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... destination
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:destination 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: Location/organization to which the patient is discharged additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... location
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:physicalType 0..1 CodeableConcept R4: The physical type of the location (usually the level in the location hierachy - bed room ward etc.) (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.location.physicalType
Binding: LocationType (example): Physical form of the location.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter 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: Common Languages (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:serviceType 0..1 CodeableConcept R4: Specific type of service (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.serviceType
.... extension:reasonReference 0..* Reference(Cross-version Profile for R4.Condition for use in FHIR STU3(0.1.0) | Condition | Cross-version Profile for R4.Procedure for use in FHIR STU3(0.1.0) | Procedure | Cross-version Profile for R4.Observation for use in FHIR STU3(0.1.0) | Observation | Cross-version Profile for R4.ImmunizationRecommendation for use in FHIR STU3(0.1.0) | ImmunizationRecommendation) R4: Reason the encounter takes place (reference) (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.reasonReference
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Identifier(s) by which this encounter is known
... status ?!Σ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter
... statusHistory 0..* BackboneElement List of past encounter statuses
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter
.... period 1..1 Period The time that the episode was in the specified status
... class Σ 0..1 Coding ​inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode|2014-03-26 (extensible): Classification of the encounter
... classHistory 0..* BackboneElement List of past encounter classes
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... class 1..1 Coding ​inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode|2014-03-26 (extensible): Classification of the encounter
.... period 1..1 Period The time that the episode was in the specified class
... type Σ 0..* CodeableConcept Specific type of encounter
Binding: EncounterType (example): The type of encounter
... priority 0..1 CodeableConcept ​Indicates the urgency of the encounter
Binding: ActPriority|2016-11-11 (example): Indicates the urgency of the encounter.
... subject Σ 0..1 Reference(Patient | Group) The patient ro group present at the encounter
... episodeOfCare Σ 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
... incomingReferral 0..* Reference(ReferralRequest) The ReferralRequest that initiated this encounter
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:basedOn 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: The ServiceRequest that initiated this encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... participant Σ 0..* BackboneElement List of participants involved in the encounter
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... type Σ 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
.... individual Σ 0..1 Reference(Practitioner | RelatedPerson) Persons involved in the encounter other than the patient
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:individual 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: individual
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... appointment Σ 0..1 Reference(Appointment) The appointment that scheduled this encounter
... period 0..1 Period The start and end time of the encounter
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... reason Σ 0..* CodeableConcept Reason the encounter takes place (code)
Binding: Encounter Reason Codes (preferred): Reason why the encounter takes place.
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... condition 1..1 Reference(Condition | Procedure) Reason the encounter takes place (resource)
.... role 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents
.... rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
... account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
... hospitalization 0..1 BackboneElement Details about the admission to a healthcare service
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin 0..1 Reference(Location) The location from which the patient came before admission
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:origin 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: The location/organization from which the patient came before admission additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.
.... reAdmission 0..1 CodeableConcept The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: v2 Re-Admission Indicator (example): The reason for re-admission of this hospitalization encounter.
.... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
.... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies
.... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements
.... destination 0..1 Reference(Location) Location to which the patient is discharged
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:destination 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: Location/organization to which the patient is discharged additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... 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 xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:physicalType 0..1 CodeableConcept R4: The physical type of the location (usually the level in the location hierachy - bed room ward etc.) (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.location.physicalType
Binding: LocationType (example): Physical form of the location.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... 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.
.... period 0..1 Period Time period during which the patient was present at the location
... serviceProvider 0..1 Reference(Organization) The custodian organization of this Encounter record
... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.language Base extensible Common Languages 📍3.0.2 FHIR Std.
Encounter.status Base required EncounterStatus 📍3.0.2 FHIR Std.
Encounter.statusHistory.​status Base required EncounterStatus 📍3.0.2 FHIR Std.
Encounter.class Base extensible ActEncounterCode . 📍2014-03-26 tx.fhir.org
Encounter.classHistory.​class Base extensible ActEncounterCode . 📍2014-03-26 tx.fhir.org
Encounter.type Base example EncounterType 📍3.0.2 FHIR Std.
Encounter.priority Base example v3 Code System ActPriority 📍2016-11-11 FHIR Std.
Encounter.participant.​type Base extensible ParticipantType 📍3.0.2 FHIR Std.
Encounter.reason Base preferred Encounter Reason Codes 📍3.0.2 FHIR Std.
Encounter.diagnosis.​role Base preferred DiagnosisRole 📍3.0.2 FHIR Std.
Encounter.hospitalization.​admitSource Base preferred AdmitSource 📍3.0.2 FHIR Std.
Encounter.hospitalization.​reAdmission Base example v2 Re-Admission Indicator 📍2.8.2 FHIR Std.
Encounter.hospitalization.​dietPreference Base example Diet 📍3.0.2 FHIR Std.
Encounter.hospitalization.​specialCourtesy Base preferred SpecialCourtesy 📍3.0.2 FHIR Std.
Encounter.hospitalization.​specialArrangement Base preferred SpecialArrangements 📍3.0.2 FHIR Std.
Encounter.hospitalization.​dischargeDisposition Base example DischargeDisposition 📍3.0.2 FHIR Std.
Encounter.location.status Base required EncounterLocationStatus 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error Encounter If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Encounter

Summary

Extensions

This structure refers to these extensions:

Maturity: 0

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:serviceType 0..1 CodeableConcept R4: Specific type of service (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.serviceType
.... extension:reasonReference 0..* Reference(Cross-version Profile for R4.Condition for use in FHIR STU3(0.1.0) | Condition | Cross-version Profile for R4.Procedure for use in FHIR STU3(0.1.0) | Procedure | Cross-version Profile for R4.Observation for use in FHIR STU3(0.1.0) | Observation | Cross-version Profile for R4.ImmunizationRecommendation for use in FHIR STU3(0.1.0) | ImmunizationRecommendation) R4: Reason the encounter takes place (reference) (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.reasonReference
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.status Base required EncounterStatus 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error Encounter If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions 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 An interaction during which services are provided to the patient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:serviceType 0..1 CodeableConcept R4: Specific type of service (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.serviceType
.... extension:reasonReference 0..* Reference(Cross-version Profile for R4.Condition for use in FHIR STU3(0.1.0) | Condition | Cross-version Profile for R4.Procedure for use in FHIR STU3(0.1.0) | Procedure | Cross-version Profile for R4.Observation for use in FHIR STU3(0.1.0) | Observation | Cross-version Profile for R4.ImmunizationRecommendation for use in FHIR STU3(0.1.0) | ImmunizationRecommendation) R4: Reason the encounter takes place (reference) (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.reasonReference
... incomingReferral
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:basedOn 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: The ServiceRequest that initiated this encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... participant
.... individual
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:individual 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: individual
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... origin
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:origin 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: The location/organization from which the patient came before admission additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... destination
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:destination 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: Location/organization to which the patient is discharged additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... location
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:physicalType 0..1 CodeableConcept R4: The physical type of the location (usually the level in the location hierachy - bed room ward etc.) (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.location.physicalType
Binding: LocationType (example): Physical form of the location.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter 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: Common Languages (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:serviceType 0..1 CodeableConcept R4: Specific type of service (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.serviceType
.... extension:reasonReference 0..* Reference(Cross-version Profile for R4.Condition for use in FHIR STU3(0.1.0) | Condition | Cross-version Profile for R4.Procedure for use in FHIR STU3(0.1.0) | Procedure | Cross-version Profile for R4.Observation for use in FHIR STU3(0.1.0) | Observation | Cross-version Profile for R4.ImmunizationRecommendation for use in FHIR STU3(0.1.0) | ImmunizationRecommendation) R4: Reason the encounter takes place (reference) (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.reasonReference
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Identifier(s) by which this encounter is known
... status ?!Σ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter
... statusHistory 0..* BackboneElement List of past encounter statuses
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter
.... period 1..1 Period The time that the episode was in the specified status
... class Σ 0..1 Coding ​inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode|2014-03-26 (extensible): Classification of the encounter
... classHistory 0..* BackboneElement List of past encounter classes
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... class 1..1 Coding ​inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode|2014-03-26 (extensible): Classification of the encounter
.... period 1..1 Period The time that the episode was in the specified class
... type Σ 0..* CodeableConcept Specific type of encounter
Binding: EncounterType (example): The type of encounter
... priority 0..1 CodeableConcept ​Indicates the urgency of the encounter
Binding: ActPriority|2016-11-11 (example): Indicates the urgency of the encounter.
... subject Σ 0..1 Reference(Patient | Group) The patient ro group present at the encounter
... episodeOfCare Σ 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
... incomingReferral 0..* Reference(ReferralRequest) The ReferralRequest that initiated this encounter
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:basedOn 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: The ServiceRequest that initiated this encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... participant Σ 0..* BackboneElement List of participants involved in the encounter
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... type Σ 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
.... individual Σ 0..1 Reference(Practitioner | RelatedPerson) Persons involved in the encounter other than the patient
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:individual 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: individual
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... appointment Σ 0..1 Reference(Appointment) The appointment that scheduled this encounter
... period 0..1 Period The start and end time of the encounter
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... reason Σ 0..* CodeableConcept Reason the encounter takes place (code)
Binding: Encounter Reason Codes (preferred): Reason why the encounter takes place.
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... condition 1..1 Reference(Condition | Procedure) Reason the encounter takes place (resource)
.... role 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents
.... rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
... account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
... hospitalization 0..1 BackboneElement Details about the admission to a healthcare service
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin 0..1 Reference(Location) The location from which the patient came before admission
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:origin 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: The location/organization from which the patient came before admission additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.
.... reAdmission 0..1 CodeableConcept The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: v2 Re-Admission Indicator (example): The reason for re-admission of this hospitalization encounter.
.... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
.... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies
.... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements
.... destination 0..1 Reference(Location) Location to which the patient is discharged
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:destination 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: Location/organization to which the patient is discharged additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... 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 xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:physicalType 0..1 CodeableConcept R4: The physical type of the location (usually the level in the location hierachy - bed room ward etc.) (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Encounter.location.physicalType
Binding: LocationType (example): Physical form of the location.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... 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.
.... period 0..1 Period Time period during which the patient was present at the location
... serviceProvider 0..1 Reference(Organization) The custodian organization of this Encounter record
... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.language Base extensible Common Languages 📍3.0.2 FHIR Std.
Encounter.status Base required EncounterStatus 📍3.0.2 FHIR Std.
Encounter.statusHistory.​status Base required EncounterStatus 📍3.0.2 FHIR Std.
Encounter.class Base extensible ActEncounterCode . 📍2014-03-26 tx.fhir.org
Encounter.classHistory.​class Base extensible ActEncounterCode . 📍2014-03-26 tx.fhir.org
Encounter.type Base example EncounterType 📍3.0.2 FHIR Std.
Encounter.priority Base example v3 Code System ActPriority 📍2016-11-11 FHIR Std.
Encounter.participant.​type Base extensible ParticipantType 📍3.0.2 FHIR Std.
Encounter.reason Base preferred Encounter Reason Codes 📍3.0.2 FHIR Std.
Encounter.diagnosis.​role Base preferred DiagnosisRole 📍3.0.2 FHIR Std.
Encounter.hospitalization.​admitSource Base preferred AdmitSource 📍3.0.2 FHIR Std.
Encounter.hospitalization.​reAdmission Base example v2 Re-Admission Indicator 📍2.8.2 FHIR Std.
Encounter.hospitalization.​dietPreference Base example Diet 📍3.0.2 FHIR Std.
Encounter.hospitalization.​specialCourtesy Base preferred SpecialCourtesy 📍3.0.2 FHIR Std.
Encounter.hospitalization.​specialArrangement Base preferred SpecialArrangements 📍3.0.2 FHIR Std.
Encounter.hospitalization.​dischargeDisposition Base example DischargeDisposition 📍3.0.2 FHIR Std.
Encounter.location.status Base required EncounterLocationStatus 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error Encounter If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Encounter

Summary

Extensions

This structure refers to these extensions:

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron