The official URL for this profile is:
http://hl7.org/fhir/us/sw/StructureDefinition/cimi-encounter-Encounter
A description of an interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
This profile builds on Encounter.
This profile was published on Fri Aug 17 00:00:00 EDT 2018 as a draft by HL7 Patient Care and Clinical Information Modeling Initiative Work Groups.
View the corresponding EncounterModel logical model.
Summary
Mandatory: 0 element (1 nested mandatory element)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
SW Mapping Source
This structure represents the following SW mapping definition:
cimi.encounter.Encounter maps to Encounter: PersonOfRecord maps to subject EncounterType maps to type Status maps to status TimePeriod maps to period
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | I | 0..* | SW Encounter Profile | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
cimi-core-Recorded-extension | 0..1 | (Complex) | SW Recorded Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/cimi-core-Recorded-extension | |
cimi-core-Signed-extension | 0..1 | (Complex) | SW Signed Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/cimi-core-Signed-extension | |
cimi-core-AdditionalText-extension | 0..1 | string | SW AdditionalText Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/cimi-core-AdditionalText-extension | |
cimi-encounter-EncounterClass-extension | 0..1 | CodeableConcept | SW EncounterClass Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/cimi-encounter-EncounterClass-extension | |
cimi-element-PartOf-extension | 0..1 | (Complex) | SW PartOf Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/cimi-element-PartOf-extension | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
cimi-core-Independent-extension | 1..1 | (Complex) | SW Independent Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/cimi-core-Independent-extension | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://hl7.org/fhir/us/sw/StructureDefinition/cimi-core-Independent-extension" | |
url | 1..1 | uri | "http://hl7.org/fhir/us/sw/StructureDefinition/cimi-element-PartOf-extension" | |
cimi-encounter-Diagnosis-extension | 0..* | (Complex) | SW Diagnosis Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/cimi-encounter-Diagnosis-extension | |
cimi-statement-ClinicalNote-extension | 0..1 | Reference(SW ClinicalNote Profile) | SW ClinicalNote Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/cimi-statement-ClinicalNote-extension | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Identifier(s) by which this encounter is known |
status | ?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required) |
statusHistory | I | 0..* | BackboneElement | List of past encounter statuses |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
status | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required) | |
period | 1..1 | Period | The time that the episode was in the specified status | |
class | Σ | 0..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible) |
classHistory | I | 0..* | BackboneElement | List of past encounter classes |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
class | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible) | |
period | 1..1 | Period | The time that the episode was in the specified class | |
type | Σ | 0..* | CodeableConcept | Specific type of encounter Binding: ActEncounterCode (extensible) |
priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example) | |
subject | Σ | 0..1 | Reference(US Core Patient Profile) | The patient ro group present at the encounter |
episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against |
incomingReferral | 0..* | Reference(ReferralRequest) | The ReferralRequest that initiated this encounter | |
participant | ΣI | 0..* | BackboneElement | List of participants involved in the encounter |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
type | Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible) |
period | 0..1 | Period | Period of time during the encounter that the participant participated | |
individual | Σ | 0..1 | Reference(Practitioner | RelatedPerson) | Persons involved in the encounter other than the patient |
appointment | Σ | 0..1 | Reference(Appointment) | The appointment that scheduled this encounter |
period | 0..1 | Period | The start and end time of the encounter | |
length | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |
reason | Σ | 0..* | CodeableConcept | Reason the encounter takes place (code) Binding: Encounter Reason Codes (preferred) |
diagnosis | ΣI | 0..* | BackboneElement | The list of diagnosis relevant to this encounter |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
condition | 1..1 | Reference(Condition | Procedure) | Reason the encounter takes place (resource) | |
role | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred) | |
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 | I | 0..1 | BackboneElement | Details about the admission to a healthcare service |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |
origin | 0..1 | Reference(Location) | The location from which the patient came before admission | |
admitSource | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred) | |
reAdmission | 0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: v2 Re-Admission Indicator (example) | |
dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example) | |
specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred) | |
specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred) | |
destination | 0..1 | Reference(Location) | Location to which the patient is discharged | |
dischargeDisposition | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example) | |
location | I | 0..* | BackboneElement | List of locations where the patient has been |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
location | 1..1 | Reference(Location) | Location the encounter takes place | |
status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required) | |
period | 0..1 | Period | Time period during which the patient was present at the location | |
serviceProvider | 0..1 | Reference(Organization) | The custodian organization of this Encounter record | |
partOf | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |
Documentation for this format |
Summary
Mandatory: 0 element (1 nested mandatory element)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
SW Mapping Source
This structure represents the following SW mapping definition:
cimi.encounter.Encounter maps to Encounter: PersonOfRecord maps to subject EncounterType maps to type Status maps to status TimePeriod maps to period
Differential View
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | I | 0..* | SW Encounter Profile | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
cimi-core-Recorded-extension | 0..1 | (Complex) | SW Recorded Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/cimi-core-Recorded-extension | |
cimi-core-Signed-extension | 0..1 | (Complex) | SW Signed Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/cimi-core-Signed-extension | |
cimi-core-AdditionalText-extension | 0..1 | string | SW AdditionalText Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/cimi-core-AdditionalText-extension | |
cimi-encounter-EncounterClass-extension | 0..1 | CodeableConcept | SW EncounterClass Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/cimi-encounter-EncounterClass-extension | |
cimi-element-PartOf-extension | 0..1 | (Complex) | SW PartOf Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/cimi-element-PartOf-extension | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
cimi-core-Independent-extension | 1..1 | (Complex) | SW Independent Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/cimi-core-Independent-extension | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://hl7.org/fhir/us/sw/StructureDefinition/cimi-core-Independent-extension" | |
url | 1..1 | uri | "http://hl7.org/fhir/us/sw/StructureDefinition/cimi-element-PartOf-extension" | |
cimi-encounter-Diagnosis-extension | 0..* | (Complex) | SW Diagnosis Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/cimi-encounter-Diagnosis-extension | |
cimi-statement-ClinicalNote-extension | 0..1 | Reference(SW ClinicalNote Profile) | SW ClinicalNote Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/cimi-statement-ClinicalNote-extension | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Identifier(s) by which this encounter is known |
status | ?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required) |
statusHistory | I | 0..* | BackboneElement | List of past encounter statuses |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
status | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required) | |
period | 1..1 | Period | The time that the episode was in the specified status | |
class | Σ | 0..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible) |
classHistory | I | 0..* | BackboneElement | List of past encounter classes |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
class | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible) | |
period | 1..1 | Period | The time that the episode was in the specified class | |
type | Σ | 0..* | CodeableConcept | Specific type of encounter Binding: ActEncounterCode (extensible) |
priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example) | |
subject | Σ | 0..1 | Reference(US Core Patient Profile) | The patient ro group present at the encounter |
episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against |
incomingReferral | 0..* | Reference(ReferralRequest) | The ReferralRequest that initiated this encounter | |
participant | ΣI | 0..* | BackboneElement | List of participants involved in the encounter |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
type | Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible) |
period | 0..1 | Period | Period of time during the encounter that the participant participated | |
individual | Σ | 0..1 | Reference(Practitioner | RelatedPerson) | Persons involved in the encounter other than the patient |
appointment | Σ | 0..1 | Reference(Appointment) | The appointment that scheduled this encounter |
period | 0..1 | Period | The start and end time of the encounter | |
length | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |
reason | Σ | 0..* | CodeableConcept | Reason the encounter takes place (code) Binding: Encounter Reason Codes (preferred) |
diagnosis | ΣI | 0..* | BackboneElement | The list of diagnosis relevant to this encounter |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
condition | 1..1 | Reference(Condition | Procedure) | Reason the encounter takes place (resource) | |
role | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred) | |
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 | I | 0..1 | BackboneElement | Details about the admission to a healthcare service |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |
origin | 0..1 | Reference(Location) | The location from which the patient came before admission | |
admitSource | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred) | |
reAdmission | 0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: v2 Re-Admission Indicator (example) | |
dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example) | |
specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred) | |
specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred) | |
destination | 0..1 | Reference(Location) | Location to which the patient is discharged | |
dischargeDisposition | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example) | |
location | I | 0..* | BackboneElement | List of locations where the patient has been |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
location | 1..1 | Reference(Location) | Location the encounter takes place | |
status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required) | |
period | 0..1 | Period | Time period during which the patient was present at the location | |
serviceProvider | 0..1 | Reference(Organization) | The custodian organization of this Encounter record | |
partOf | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron
Path | Name | Conformance | ValueSet |
Encounter.language | Common Languages | extensible | Common Languages |
Encounter.status | EncounterStatus | required | EncounterStatus |
Encounter.statusHistory.status | EncounterStatus | required | EncounterStatus |
Encounter.class | ActEncounterCode | extensible | ActEncounterCode |
Encounter.classHistory.class | ActEncounterCode | extensible | ActEncounterCode |
Encounter.type | ActEncounterCode | extensible | ActEncounterCode |
Encounter.priority | v3 Code System ActPriority | example | v3 Code System ActPriority |
Encounter.participant.type | ParticipantType | extensible | ParticipantType |
Encounter.reason | Encounter Reason Codes | preferred | Encounter Reason Codes |
Encounter.diagnosis.role | DiagnosisRole | preferred | DiagnosisRole |
Encounter.hospitalization.admitSource | AdmitSource | preferred | AdmitSource |
Encounter.hospitalization.reAdmission | v2 Re-Admission Indicator | example | v2 Re-Admission Indicator |
Encounter.hospitalization.dietPreference | Diet | example | Diet |
Encounter.hospitalization.specialCourtesy | SpecialCourtesy | preferred | SpecialCourtesy |
Encounter.hospitalization.specialArrangement | SpecialArrangements | preferred | SpecialArrangements |
Encounter.hospitalization.dischargeDisposition | DischargeDisposition | example | DischargeDisposition |
Encounter.location.status | EncounterLocationStatus | required | EncounterLocationStatus |
Id | Path | Details | Requirements |
dom-2 | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-1 | Encounter | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-4 | 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-3 | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
ele-1 | Encounter.statusHistory | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | Encounter.classHistory | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | Encounter.participant | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | Encounter.diagnosis | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | Encounter.hospitalization | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | Encounter.location | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |