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

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

Resource Profile: Profile_R2_Encounter_R4

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

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

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

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(4.0.1) 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
Constraints: ext-1
.... extension:indication 0..* Reference(Resource) DSTU2: Reason the encounter takes place (resource) additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... extension:dischargeDiagnosis 0..* Reference(Cross-version Profile for DSTU2.Condition for use in FHIR R4(0.1.0) | Condition) DSTU2: The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.hospitalization.dischargeDiagnosis
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... class Σ 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:class 0..1 code DSTU2: inpatient | outpatient | ambulatory | emergency + additional codes
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.class
Binding: R2EncounterClassForR4V3ActEncounterCode (0.1.0) (required): Classification of the encounter
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base extensible ActEncounterCode 📍3.0.0 THO v7.1

Constraints

Id Grade Path(s) Description Expression
dom-2 error Encounter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Encounter If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Encounter If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter A resource should have narrative for robust management text.`div`.exists()
ele-1 error Encounter.implicitRules, Encounter.extension, Encounter.extension:indication, Encounter.extension:dischargeDiagnosis, Encounter.modifierExtension, Encounter.status, Encounter.class, Encounter.class.extension, Encounter.class.extension:class All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Encounter.extension, Encounter.extension:indication, Encounter.extension:dischargeDiagnosis, Encounter.modifierExtension, Encounter.class.extension, Encounter.class.extension:class 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(4.0.1) An interaction during which services are provided to the patient
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.text
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:indication 0..* Reference(Resource) DSTU2: Reason the encounter takes place (resource) additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... extension:dischargeDiagnosis 0..* Reference(Cross-version Profile for DSTU2.Condition for use in FHIR R4(0.1.0) | Condition) DSTU2: The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.hospitalization.dischargeDiagnosis
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.identifier
... statusHistory
.... period
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:period 0..1 Period DSTU2: period additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.statusHistory.period
... class
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:class 0..1 code DSTU2: inpatient | outpatient | ambulatory | emergency + additional codes
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.class
Binding: R2EncounterClassForR4V3ActEncounterCode (0.1.0) (required): Classification of the encounter
... subject
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:patient 0..1 Reference(Resource) DSTU2: The patient present at the encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... episodeOfCare
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:episodeOfCare 0..* Reference(Resource) DSTU2: episodeOfCare additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... basedOn
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:incomingReferral 0..* Reference(Resource) DSTU2: The ReferralRequest that initiated this encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... participant
.... period
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:period 0..1 Period DSTU2: Period of time during the encounter participant was present additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.participant.period
.... individual
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:individual 0..1 Reference(Resource) DSTU2: individual additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... appointment
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:appointment 0..1 Reference(Resource) DSTU2: appointment additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... period
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:period 0..1 Period DSTU2: period additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.period
... diagnosis
.... condition
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:admittingDiagnosis 0..* Reference(Resource) DSTU2: The admitting diagnosis as reported by admitting practitioner additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... hospitalization
.... preAdmissionIdentifier
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:preAdmissionIdentifier 0..1 Identifier DSTU2: preAdmissionIdentifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.hospitalization.preAdmissionIdentifier
.... origin
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:origin 0..1 Reference(Resource) DSTU2: The location 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 Reference(Resource) DSTU2: Location to which the patient is discharged additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... location
.... location
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:location 0..1 Reference(Resource) DSTU2: location additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... period
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:period 0..1 Period DSTU2: period additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.location.period
... serviceProvider
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:serviceProvider 0..1 Reference(Resource) DSTU2: The custodian organization of this Encounter record additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... partOf
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:partOf 0..1 Reference(Resource) DSTU2: partOf additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter(4.0.1) 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
.... 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:meta 0..1 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... 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:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:indication 0..* Reference(Resource) DSTU2: Reason the encounter takes place (resource) additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... extension:dischargeDiagnosis 0..* Reference(Cross-version Profile for DSTU2.Condition for use in FHIR R4(0.1.0) | Condition) DSTU2: The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.hospitalization.dischargeDiagnosis
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
.... 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:identifier 0..* Identifier DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 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 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
.... 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
..... 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:period 1..1 Period DSTU2: period additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.statusHistory.period
Constraints: ext-1
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... class Σ 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (3.0.0) (extensible): Classification of the 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:class 0..1 code DSTU2: inpatient | outpatient | ambulatory | emergency + additional codes
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.class
Binding: R2EncounterClassForR4V3ActEncounterCode (0.1.0) (required): Classification of the encounter
Constraints: ext-1
.... system Σ 0..1 uri Identity of the terminology system
.... version Σ 0..1 string Version of the system - if relevant
.... code Σ 0..1 code Symbol in syntax defined by the system
.... display Σ 0..1 string Representation defined by the system
.... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... classHistory 0..* BackboneElement List of past encounter classes
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (3.0.0) (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.
... serviceType Σ 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter.
... subject Σ 0..1 Reference(Patient | Group) The patient or group present at the 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:patient 0..1 Reference(Resource) DSTU2: The patient present at the encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... episodeOfCare Σ 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
.... 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:episodeOfCare 0..1 Reference(Resource) DSTU2: episodeOfCare additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated 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:incomingReferral 0..1 Reference(Resource) DSTU2: The ReferralRequest that initiated this encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... 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 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 Σ 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
..... 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:period 0..1 Period DSTU2: Period of time during the encounter participant was present additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.participant.period
Constraints: ext-1
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... individual Σ 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson) Persons involved in the encounter other than the patient
..... 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:individual 0..1 Reference(Resource) DSTU2: individual additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled 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:appointment 0..1 Reference(Resource) DSTU2: appointment additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... period 0..1 Period The start and end time of the 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:period 0..1 Period DSTU2: period additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.period
Constraints: ext-1
.... start ΣC 0..1 dateTime Starting time with inclusive boundary
.... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... reasonCode Σ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
... reasonReference Σ 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
.... 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
.... condition Σ 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the 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:admittingDiagnosis 0..1 Reference(Resource) DSTU2: The admitting diagnosis as reported by admitting practitioner additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... use 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 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
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
..... 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:preAdmissionIdentifier 0..1 Identifier DSTU2: preAdmissionIdentifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.hospitalization.preAdmissionIdentifier
Constraints: ext-1
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
..... 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:origin 0..1 Reference(Resource) DSTU2: The location from which the patient came before admission additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... 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: Hl7VSReAdmissionIndicator (3.0.0) (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 | Organization) Location/organization to which the patient is discharged
..... 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:destination 0..1 Reference(Resource) DSTU2: Location to which the patient is discharged additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... 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 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
..... 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:location 0..1 Reference(Resource) DSTU2: location additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
.... physicalType 0..1 CodeableConcept The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example): Physical form of the location.
.... period 0..1 Period Time period during which the patient was present at the location
..... 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:period 0..1 Period DSTU2: period additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.location.period
Constraints: ext-1
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... serviceProvider 0..1 Reference(Organization) The organization (facility) responsible for 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:serviceProvider 0..1 Reference(Resource) DSTU2: The custodian organization of this Encounter record additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of
.... 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:partOf 0..1 Reference(Resource) DSTU2: partOf additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.meta.security Base extensible SecurityLabels . 📍4.0.1 tx.fhir.org
Encounter.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Encounter.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Encounter.text.status Base required NarrativeStatus 📍4.0.1 FHIR Std.
Encounter.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.statusHistory.​status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base extensible ActEncounterCode 📍3.0.0 THO v7.1
Encounter.classHistory.​class Base extensible ActEncounterCode 📍3.0.0 THO v7.1
Encounter.type Base example Encounter type 📍4.0.1 FHIR Std.
Encounter.serviceType Base example Service type 📍4.0.1 FHIR Std.
Encounter.priority Base example ActPriority 📍3.0.0 THO v7.1
Encounter.subject.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
Encounter.episodeOfCare.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
Encounter.basedOn.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
Encounter.participant.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Encounter.participant.​individual.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
Encounter.appointment.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
Encounter.reasonCode Base preferred Encounter Reason Codes 📍4.0.1 FHIR Std.
Encounter.diagnosis.​condition.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
Encounter.diagnosis.​use Base preferred DiagnosisRole 📍4.0.1 FHIR Std.
Encounter.hospitalization.​preAdmissionIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.hospitalization.​preAdmissionIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Encounter.hospitalization.​origin.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
Encounter.hospitalization.​admitSource Base preferred Admit source 📍4.0.1 FHIR Std.
Encounter.hospitalization.​reAdmission Base example hl7VS-re-admissionIndicator 📍3.0.0 THO v7.1
Encounter.hospitalization.​dietPreference Base example Diet 📍4.0.1 FHIR Std.
Encounter.hospitalization.​specialCourtesy Base preferred Special courtesy 📍4.0.1 FHIR Std.
Encounter.hospitalization.​specialArrangement Base preferred Special arrangements 📍4.0.1 FHIR Std.
Encounter.hospitalization.​destination.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
Encounter.hospitalization.​dischargeDisposition Base example Discharge disposition 📍4.0.1 FHIR Std.
Encounter.location.location.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
Encounter.location.status Base required EncounterLocationStatus 📍4.0.1 FHIR Std.
Encounter.location.physicalType Base example Location type 📍4.0.1 FHIR Std.
Encounter.serviceProvider.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
Encounter.partOf.type Base extensible ResourceType . 📍4.0.1 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Encounter If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter A resource should have narrative for robust management text.`div`.exists()
ele-1 error Encounter.meta, Encounter.meta.extension, Encounter.meta.extension:meta, Encounter.meta.versionId, Encounter.meta.lastUpdated, Encounter.meta.source, Encounter.meta.profile, Encounter.meta.security, Encounter.meta.tag, Encounter.implicitRules, Encounter.language, Encounter.text, Encounter.text.extension, Encounter.text.extension:text, Encounter.text.status, Encounter.text.div, Encounter.extension, Encounter.extension:indication, Encounter.extension:dischargeDiagnosis, Encounter.modifierExtension, Encounter.identifier, Encounter.identifier.extension, Encounter.identifier.extension:identifier, Encounter.identifier.use, Encounter.identifier.type, Encounter.identifier.system, Encounter.identifier.value, Encounter.identifier.period, Encounter.identifier.assigner, Encounter.status, Encounter.statusHistory, Encounter.statusHistory.extension, Encounter.statusHistory.modifierExtension, Encounter.statusHistory.status, Encounter.statusHistory.period, Encounter.statusHistory.period.extension, Encounter.statusHistory.period.extension:period, Encounter.statusHistory.period.start, Encounter.statusHistory.period.end, Encounter.class, Encounter.class.extension, Encounter.class.extension:class, Encounter.class.system, Encounter.class.version, Encounter.class.code, Encounter.class.display, Encounter.class.userSelected, Encounter.classHistory, Encounter.classHistory.extension, Encounter.classHistory.modifierExtension, Encounter.classHistory.class, Encounter.classHistory.period, Encounter.type, Encounter.serviceType, Encounter.priority, Encounter.subject, Encounter.subject.extension, Encounter.subject.extension:patient, Encounter.subject.reference, Encounter.subject.type, Encounter.subject.identifier, Encounter.subject.display, Encounter.episodeOfCare, Encounter.episodeOfCare.extension, Encounter.episodeOfCare.extension:episodeOfCare, Encounter.episodeOfCare.reference, Encounter.episodeOfCare.type, Encounter.episodeOfCare.identifier, Encounter.episodeOfCare.display, Encounter.basedOn, Encounter.basedOn.extension, Encounter.basedOn.extension:incomingReferral, Encounter.basedOn.reference, Encounter.basedOn.type, Encounter.basedOn.identifier, Encounter.basedOn.display, Encounter.participant, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant.type, Encounter.participant.period, Encounter.participant.period.extension, Encounter.participant.period.extension:period, Encounter.participant.period.start, Encounter.participant.period.end, Encounter.participant.individual, Encounter.participant.individual.extension, Encounter.participant.individual.extension:individual, Encounter.participant.individual.reference, Encounter.participant.individual.type, Encounter.participant.individual.identifier, Encounter.participant.individual.display, Encounter.appointment, Encounter.appointment.extension, Encounter.appointment.extension:appointment, Encounter.appointment.reference, Encounter.appointment.type, Encounter.appointment.identifier, Encounter.appointment.display, Encounter.period, Encounter.period.extension, Encounter.period.extension:period, Encounter.period.start, Encounter.period.end, Encounter.length, Encounter.reasonCode, Encounter.reasonReference, Encounter.diagnosis, Encounter.diagnosis.extension, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition, Encounter.diagnosis.condition.extension, Encounter.diagnosis.condition.extension:admittingDiagnosis, Encounter.diagnosis.condition.reference, Encounter.diagnosis.condition.type, Encounter.diagnosis.condition.identifier, Encounter.diagnosis.condition.display, Encounter.diagnosis.use, Encounter.diagnosis.rank, Encounter.account, Encounter.hospitalization, Encounter.hospitalization.extension, Encounter.hospitalization.modifierExtension, Encounter.hospitalization.preAdmissionIdentifier, Encounter.hospitalization.preAdmissionIdentifier.extension, Encounter.hospitalization.preAdmissionIdentifier.extension:preAdmissionIdentifier, Encounter.hospitalization.preAdmissionIdentifier.use, Encounter.hospitalization.preAdmissionIdentifier.type, Encounter.hospitalization.preAdmissionIdentifier.system, Encounter.hospitalization.preAdmissionIdentifier.value, Encounter.hospitalization.preAdmissionIdentifier.period, Encounter.hospitalization.preAdmissionIdentifier.assigner, Encounter.hospitalization.origin, Encounter.hospitalization.origin.extension, Encounter.hospitalization.origin.extension:origin, Encounter.hospitalization.origin.reference, Encounter.hospitalization.origin.type, Encounter.hospitalization.origin.identifier, Encounter.hospitalization.origin.display, Encounter.hospitalization.admitSource, Encounter.hospitalization.reAdmission, Encounter.hospitalization.dietPreference, Encounter.hospitalization.specialCourtesy, Encounter.hospitalization.specialArrangement, Encounter.hospitalization.destination, Encounter.hospitalization.destination.extension, Encounter.hospitalization.destination.extension:destination, Encounter.hospitalization.destination.reference, Encounter.hospitalization.destination.type, Encounter.hospitalization.destination.identifier, Encounter.hospitalization.destination.display, Encounter.hospitalization.dischargeDisposition, Encounter.location, Encounter.location.extension, Encounter.location.modifierExtension, Encounter.location.location, Encounter.location.location.extension, Encounter.location.location.extension:location, Encounter.location.location.reference, Encounter.location.location.type, Encounter.location.location.identifier, Encounter.location.location.display, Encounter.location.status, Encounter.location.physicalType, Encounter.location.period, Encounter.location.period.extension, Encounter.location.period.extension:period, Encounter.location.period.start, Encounter.location.period.end, Encounter.serviceProvider, Encounter.serviceProvider.extension, Encounter.serviceProvider.extension:serviceProvider, Encounter.serviceProvider.reference, Encounter.serviceProvider.type, Encounter.serviceProvider.identifier, Encounter.serviceProvider.display, Encounter.partOf, Encounter.partOf.extension, Encounter.partOf.extension:partOf, Encounter.partOf.reference, Encounter.partOf.type, Encounter.partOf.identifier, Encounter.partOf.display All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Encounter.meta.extension, Encounter.meta.extension:meta, Encounter.text.extension, Encounter.text.extension:text, Encounter.extension, Encounter.extension:indication, Encounter.extension:dischargeDiagnosis, Encounter.modifierExtension, Encounter.identifier.extension, Encounter.identifier.extension:identifier, Encounter.statusHistory.extension, Encounter.statusHistory.modifierExtension, Encounter.statusHistory.period.extension, Encounter.statusHistory.period.extension:period, Encounter.class.extension, Encounter.class.extension:class, Encounter.classHistory.extension, Encounter.classHistory.modifierExtension, Encounter.subject.extension, Encounter.subject.extension:patient, Encounter.episodeOfCare.extension, Encounter.episodeOfCare.extension:episodeOfCare, Encounter.basedOn.extension, Encounter.basedOn.extension:incomingReferral, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant.period.extension, Encounter.participant.period.extension:period, Encounter.participant.individual.extension, Encounter.participant.individual.extension:individual, Encounter.appointment.extension, Encounter.appointment.extension:appointment, Encounter.period.extension, Encounter.period.extension:period, Encounter.diagnosis.extension, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition.extension, Encounter.diagnosis.condition.extension:admittingDiagnosis, Encounter.hospitalization.extension, Encounter.hospitalization.modifierExtension, Encounter.hospitalization.preAdmissionIdentifier.extension, Encounter.hospitalization.preAdmissionIdentifier.extension:preAdmissionIdentifier, Encounter.hospitalization.origin.extension, Encounter.hospitalization.origin.extension:origin, Encounter.hospitalization.destination.extension, Encounter.hospitalization.destination.extension:destination, Encounter.location.extension, Encounter.location.modifierExtension, Encounter.location.location.extension, Encounter.location.location.extension:location, Encounter.location.period.extension, Encounter.location.period.extension:period, Encounter.serviceProvider.extension, Encounter.serviceProvider.extension:serviceProvider, Encounter.partOf.extension, Encounter.partOf.extension:partOf Must have either extensions or value[x], not both extension.exists() != value.exists()
txt-1 error Encounter.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Encounter.text.div The narrative SHALL have some non-whitespace content htmlChecks()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter(4.0.1) 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
Constraints: ext-1
.... extension:indication 0..* Reference(Resource) DSTU2: Reason the encounter takes place (resource) additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... extension:dischargeDiagnosis 0..* Reference(Cross-version Profile for DSTU2.Condition for use in FHIR R4(0.1.0) | Condition) DSTU2: The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.hospitalization.dischargeDiagnosis
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... class Σ 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:class 0..1 code DSTU2: inpatient | outpatient | ambulatory | emergency + additional codes
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.class
Binding: R2EncounterClassForR4V3ActEncounterCode (0.1.0) (required): Classification of the encounter
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base extensible ActEncounterCode 📍3.0.0 THO v7.1

Constraints

Id Grade Path(s) Description Expression
dom-2 error Encounter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Encounter If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Encounter If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter A resource should have narrative for robust management text.`div`.exists()
ele-1 error Encounter.implicitRules, Encounter.extension, Encounter.extension:indication, Encounter.extension:dischargeDiagnosis, Encounter.modifierExtension, Encounter.status, Encounter.class, Encounter.class.extension, Encounter.class.extension:class All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Encounter.extension, Encounter.extension:indication, Encounter.extension:dischargeDiagnosis, Encounter.modifierExtension, Encounter.class.extension, Encounter.class.extension:class 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(4.0.1) An interaction during which services are provided to the patient
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.text
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:indication 0..* Reference(Resource) DSTU2: Reason the encounter takes place (resource) additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... extension:dischargeDiagnosis 0..* Reference(Cross-version Profile for DSTU2.Condition for use in FHIR R4(0.1.0) | Condition) DSTU2: The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.hospitalization.dischargeDiagnosis
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.identifier
... statusHistory
.... period
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:period 0..1 Period DSTU2: period additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.statusHistory.period
... class
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:class 0..1 code DSTU2: inpatient | outpatient | ambulatory | emergency + additional codes
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.class
Binding: R2EncounterClassForR4V3ActEncounterCode (0.1.0) (required): Classification of the encounter
... subject
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:patient 0..1 Reference(Resource) DSTU2: The patient present at the encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... episodeOfCare
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:episodeOfCare 0..* Reference(Resource) DSTU2: episodeOfCare additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... basedOn
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:incomingReferral 0..* Reference(Resource) DSTU2: The ReferralRequest that initiated this encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... participant
.... period
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:period 0..1 Period DSTU2: Period of time during the encounter participant was present additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.participant.period
.... individual
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:individual 0..1 Reference(Resource) DSTU2: individual additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... appointment
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:appointment 0..1 Reference(Resource) DSTU2: appointment additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... period
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:period 0..1 Period DSTU2: period additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.period
... diagnosis
.... condition
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:admittingDiagnosis 0..* Reference(Resource) DSTU2: The admitting diagnosis as reported by admitting practitioner additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... hospitalization
.... preAdmissionIdentifier
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:preAdmissionIdentifier 0..1 Identifier DSTU2: preAdmissionIdentifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.hospitalization.preAdmissionIdentifier
.... origin
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:origin 0..1 Reference(Resource) DSTU2: The location 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 Reference(Resource) DSTU2: Location to which the patient is discharged additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... location
.... location
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:location 0..1 Reference(Resource) DSTU2: location additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... period
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:period 0..1 Period DSTU2: period additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.location.period
... serviceProvider
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:serviceProvider 0..1 Reference(Resource) DSTU2: The custodian organization of this Encounter record additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... partOf
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:partOf 0..1 Reference(Resource) DSTU2: partOf additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter(4.0.1) 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
.... 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:meta 0..1 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... 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:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:indication 0..* Reference(Resource) DSTU2: Reason the encounter takes place (resource) additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... extension:dischargeDiagnosis 0..* Reference(Cross-version Profile for DSTU2.Condition for use in FHIR R4(0.1.0) | Condition) DSTU2: The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.hospitalization.dischargeDiagnosis
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
.... 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:identifier 0..* Identifier DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 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 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
.... 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
..... 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:period 1..1 Period DSTU2: period additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.statusHistory.period
Constraints: ext-1
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... class Σ 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (3.0.0) (extensible): Classification of the 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:class 0..1 code DSTU2: inpatient | outpatient | ambulatory | emergency + additional codes
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.class
Binding: R2EncounterClassForR4V3ActEncounterCode (0.1.0) (required): Classification of the encounter
Constraints: ext-1
.... system Σ 0..1 uri Identity of the terminology system
.... version Σ 0..1 string Version of the system - if relevant
.... code Σ 0..1 code Symbol in syntax defined by the system
.... display Σ 0..1 string Representation defined by the system
.... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... classHistory 0..* BackboneElement List of past encounter classes
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (3.0.0) (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.
... serviceType Σ 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter.
... subject Σ 0..1 Reference(Patient | Group) The patient or group present at the 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:patient 0..1 Reference(Resource) DSTU2: The patient present at the encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... episodeOfCare Σ 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
.... 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:episodeOfCare 0..1 Reference(Resource) DSTU2: episodeOfCare additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated 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:incomingReferral 0..1 Reference(Resource) DSTU2: The ReferralRequest that initiated this encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... 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 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 Σ 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
..... 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:period 0..1 Period DSTU2: Period of time during the encounter participant was present additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.participant.period
Constraints: ext-1
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... individual Σ 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson) Persons involved in the encounter other than the patient
..... 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:individual 0..1 Reference(Resource) DSTU2: individual additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled 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:appointment 0..1 Reference(Resource) DSTU2: appointment additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... period 0..1 Period The start and end time of the 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:period 0..1 Period DSTU2: period additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.period
Constraints: ext-1
.... start ΣC 0..1 dateTime Starting time with inclusive boundary
.... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... reasonCode Σ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
... reasonReference Σ 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
.... 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
.... condition Σ 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the 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:admittingDiagnosis 0..1 Reference(Resource) DSTU2: The admitting diagnosis as reported by admitting practitioner additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... use 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 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
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
..... 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:preAdmissionIdentifier 0..1 Identifier DSTU2: preAdmissionIdentifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.hospitalization.preAdmissionIdentifier
Constraints: ext-1
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
..... 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:origin 0..1 Reference(Resource) DSTU2: The location from which the patient came before admission additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... 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: Hl7VSReAdmissionIndicator (3.0.0) (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 | Organization) Location/organization to which the patient is discharged
..... 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:destination 0..1 Reference(Resource) DSTU2: Location to which the patient is discharged additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... 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 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
..... 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:location 0..1 Reference(Resource) DSTU2: location additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
.... physicalType 0..1 CodeableConcept The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example): Physical form of the location.
.... period 0..1 Period Time period during which the patient was present at the location
..... 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:period 0..1 Period DSTU2: period additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Encounter.location.period
Constraints: ext-1
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... serviceProvider 0..1 Reference(Organization) The organization (facility) responsible for 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:serviceProvider 0..1 Reference(Resource) DSTU2: The custodian organization of this Encounter record additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of
.... 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:partOf 0..1 Reference(Resource) DSTU2: partOf additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.meta.security Base extensible SecurityLabels . 📍4.0.1 tx.fhir.org
Encounter.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Encounter.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Encounter.text.status Base required NarrativeStatus 📍4.0.1 FHIR Std.
Encounter.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.statusHistory.​status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base extensible ActEncounterCode 📍3.0.0 THO v7.1
Encounter.classHistory.​class Base extensible ActEncounterCode 📍3.0.0 THO v7.1
Encounter.type Base example Encounter type 📍4.0.1 FHIR Std.
Encounter.serviceType Base example Service type 📍4.0.1 FHIR Std.
Encounter.priority Base example ActPriority 📍3.0.0 THO v7.1
Encounter.subject.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
Encounter.episodeOfCare.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
Encounter.basedOn.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
Encounter.participant.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Encounter.participant.​individual.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
Encounter.appointment.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
Encounter.reasonCode Base preferred Encounter Reason Codes 📍4.0.1 FHIR Std.
Encounter.diagnosis.​condition.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
Encounter.diagnosis.​use Base preferred DiagnosisRole 📍4.0.1 FHIR Std.
Encounter.hospitalization.​preAdmissionIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.hospitalization.​preAdmissionIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Encounter.hospitalization.​origin.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
Encounter.hospitalization.​admitSource Base preferred Admit source 📍4.0.1 FHIR Std.
Encounter.hospitalization.​reAdmission Base example hl7VS-re-admissionIndicator 📍3.0.0 THO v7.1
Encounter.hospitalization.​dietPreference Base example Diet 📍4.0.1 FHIR Std.
Encounter.hospitalization.​specialCourtesy Base preferred Special courtesy 📍4.0.1 FHIR Std.
Encounter.hospitalization.​specialArrangement Base preferred Special arrangements 📍4.0.1 FHIR Std.
Encounter.hospitalization.​destination.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
Encounter.hospitalization.​dischargeDisposition Base example Discharge disposition 📍4.0.1 FHIR Std.
Encounter.location.location.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
Encounter.location.status Base required EncounterLocationStatus 📍4.0.1 FHIR Std.
Encounter.location.physicalType Base example Location type 📍4.0.1 FHIR Std.
Encounter.serviceProvider.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
Encounter.partOf.type Base extensible ResourceType . 📍4.0.1 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Encounter If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter A resource should have narrative for robust management text.`div`.exists()
ele-1 error Encounter.meta, Encounter.meta.extension, Encounter.meta.extension:meta, Encounter.meta.versionId, Encounter.meta.lastUpdated, Encounter.meta.source, Encounter.meta.profile, Encounter.meta.security, Encounter.meta.tag, Encounter.implicitRules, Encounter.language, Encounter.text, Encounter.text.extension, Encounter.text.extension:text, Encounter.text.status, Encounter.text.div, Encounter.extension, Encounter.extension:indication, Encounter.extension:dischargeDiagnosis, Encounter.modifierExtension, Encounter.identifier, Encounter.identifier.extension, Encounter.identifier.extension:identifier, Encounter.identifier.use, Encounter.identifier.type, Encounter.identifier.system, Encounter.identifier.value, Encounter.identifier.period, Encounter.identifier.assigner, Encounter.status, Encounter.statusHistory, Encounter.statusHistory.extension, Encounter.statusHistory.modifierExtension, Encounter.statusHistory.status, Encounter.statusHistory.period, Encounter.statusHistory.period.extension, Encounter.statusHistory.period.extension:period, Encounter.statusHistory.period.start, Encounter.statusHistory.period.end, Encounter.class, Encounter.class.extension, Encounter.class.extension:class, Encounter.class.system, Encounter.class.version, Encounter.class.code, Encounter.class.display, Encounter.class.userSelected, Encounter.classHistory, Encounter.classHistory.extension, Encounter.classHistory.modifierExtension, Encounter.classHistory.class, Encounter.classHistory.period, Encounter.type, Encounter.serviceType, Encounter.priority, Encounter.subject, Encounter.subject.extension, Encounter.subject.extension:patient, Encounter.subject.reference, Encounter.subject.type, Encounter.subject.identifier, Encounter.subject.display, Encounter.episodeOfCare, Encounter.episodeOfCare.extension, Encounter.episodeOfCare.extension:episodeOfCare, Encounter.episodeOfCare.reference, Encounter.episodeOfCare.type, Encounter.episodeOfCare.identifier, Encounter.episodeOfCare.display, Encounter.basedOn, Encounter.basedOn.extension, Encounter.basedOn.extension:incomingReferral, Encounter.basedOn.reference, Encounter.basedOn.type, Encounter.basedOn.identifier, Encounter.basedOn.display, Encounter.participant, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant.type, Encounter.participant.period, Encounter.participant.period.extension, Encounter.participant.period.extension:period, Encounter.participant.period.start, Encounter.participant.period.end, Encounter.participant.individual, Encounter.participant.individual.extension, Encounter.participant.individual.extension:individual, Encounter.participant.individual.reference, Encounter.participant.individual.type, Encounter.participant.individual.identifier, Encounter.participant.individual.display, Encounter.appointment, Encounter.appointment.extension, Encounter.appointment.extension:appointment, Encounter.appointment.reference, Encounter.appointment.type, Encounter.appointment.identifier, Encounter.appointment.display, Encounter.period, Encounter.period.extension, Encounter.period.extension:period, Encounter.period.start, Encounter.period.end, Encounter.length, Encounter.reasonCode, Encounter.reasonReference, Encounter.diagnosis, Encounter.diagnosis.extension, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition, Encounter.diagnosis.condition.extension, Encounter.diagnosis.condition.extension:admittingDiagnosis, Encounter.diagnosis.condition.reference, Encounter.diagnosis.condition.type, Encounter.diagnosis.condition.identifier, Encounter.diagnosis.condition.display, Encounter.diagnosis.use, Encounter.diagnosis.rank, Encounter.account, Encounter.hospitalization, Encounter.hospitalization.extension, Encounter.hospitalization.modifierExtension, Encounter.hospitalization.preAdmissionIdentifier, Encounter.hospitalization.preAdmissionIdentifier.extension, Encounter.hospitalization.preAdmissionIdentifier.extension:preAdmissionIdentifier, Encounter.hospitalization.preAdmissionIdentifier.use, Encounter.hospitalization.preAdmissionIdentifier.type, Encounter.hospitalization.preAdmissionIdentifier.system, Encounter.hospitalization.preAdmissionIdentifier.value, Encounter.hospitalization.preAdmissionIdentifier.period, Encounter.hospitalization.preAdmissionIdentifier.assigner, Encounter.hospitalization.origin, Encounter.hospitalization.origin.extension, Encounter.hospitalization.origin.extension:origin, Encounter.hospitalization.origin.reference, Encounter.hospitalization.origin.type, Encounter.hospitalization.origin.identifier, Encounter.hospitalization.origin.display, Encounter.hospitalization.admitSource, Encounter.hospitalization.reAdmission, Encounter.hospitalization.dietPreference, Encounter.hospitalization.specialCourtesy, Encounter.hospitalization.specialArrangement, Encounter.hospitalization.destination, Encounter.hospitalization.destination.extension, Encounter.hospitalization.destination.extension:destination, Encounter.hospitalization.destination.reference, Encounter.hospitalization.destination.type, Encounter.hospitalization.destination.identifier, Encounter.hospitalization.destination.display, Encounter.hospitalization.dischargeDisposition, Encounter.location, Encounter.location.extension, Encounter.location.modifierExtension, Encounter.location.location, Encounter.location.location.extension, Encounter.location.location.extension:location, Encounter.location.location.reference, Encounter.location.location.type, Encounter.location.location.identifier, Encounter.location.location.display, Encounter.location.status, Encounter.location.physicalType, Encounter.location.period, Encounter.location.period.extension, Encounter.location.period.extension:period, Encounter.location.period.start, Encounter.location.period.end, Encounter.serviceProvider, Encounter.serviceProvider.extension, Encounter.serviceProvider.extension:serviceProvider, Encounter.serviceProvider.reference, Encounter.serviceProvider.type, Encounter.serviceProvider.identifier, Encounter.serviceProvider.display, Encounter.partOf, Encounter.partOf.extension, Encounter.partOf.extension:partOf, Encounter.partOf.reference, Encounter.partOf.type, Encounter.partOf.identifier, Encounter.partOf.display All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Encounter.meta.extension, Encounter.meta.extension:meta, Encounter.text.extension, Encounter.text.extension:text, Encounter.extension, Encounter.extension:indication, Encounter.extension:dischargeDiagnosis, Encounter.modifierExtension, Encounter.identifier.extension, Encounter.identifier.extension:identifier, Encounter.statusHistory.extension, Encounter.statusHistory.modifierExtension, Encounter.statusHistory.period.extension, Encounter.statusHistory.period.extension:period, Encounter.class.extension, Encounter.class.extension:class, Encounter.classHistory.extension, Encounter.classHistory.modifierExtension, Encounter.subject.extension, Encounter.subject.extension:patient, Encounter.episodeOfCare.extension, Encounter.episodeOfCare.extension:episodeOfCare, Encounter.basedOn.extension, Encounter.basedOn.extension:incomingReferral, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant.period.extension, Encounter.participant.period.extension:period, Encounter.participant.individual.extension, Encounter.participant.individual.extension:individual, Encounter.appointment.extension, Encounter.appointment.extension:appointment, Encounter.period.extension, Encounter.period.extension:period, Encounter.diagnosis.extension, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition.extension, Encounter.diagnosis.condition.extension:admittingDiagnosis, Encounter.hospitalization.extension, Encounter.hospitalization.modifierExtension, Encounter.hospitalization.preAdmissionIdentifier.extension, Encounter.hospitalization.preAdmissionIdentifier.extension:preAdmissionIdentifier, Encounter.hospitalization.origin.extension, Encounter.hospitalization.origin.extension:origin, Encounter.hospitalization.destination.extension, Encounter.hospitalization.destination.extension:destination, Encounter.location.extension, Encounter.location.modifierExtension, Encounter.location.location.extension, Encounter.location.location.extension:location, Encounter.location.period.extension, Encounter.location.period.extension:period, Encounter.serviceProvider.extension, Encounter.serviceProvider.extension:serviceProvider, Encounter.partOf.extension, Encounter.partOf.extension:partOf Must have either extensions or value[x], not both extension.exists() != value.exists()
txt-1 error Encounter.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Encounter.text.div The narrative SHALL have some non-whitespace content htmlChecks()

 

Other representations of profile: CSV, Excel, Schematron