0.3.0 - Second STU ballot

This page is part of a downloaded copy of this specification. This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v0.3.0: STU 1 Ballot 2) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

## StructureDefinition: EncounterSTU3

The official URL for this profile is:

    http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-encounter-stu3

### Formal Views of Profile Content

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

- Text Summary
- Differential Table
- Snapshot Table
- All

This structure is derived from Encounter

Summary

Mandatory: 3 elements (1 nested mandatory element)
Must-Support: 17 elements

Structures

This structure refers to these other structures:

- http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-patient-stu3
- http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-practitioner-stu3
- http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-appointment-stu3
- http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition
- http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-location-stu3
- unable to summarise profile http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-Encounter-stu3 (no profile found)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/ext-insurance

This structure is derived from Encounter

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Encounter |  | 0..* |  |
ext-insurance |  | 0..* | Reference(CoverageSTU3) | Insurance URL: http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/ext-insurance
identifier | S | 0..* | Identifier |
status | S | 1..1 | code |
class | S | 1..1 | Coding |
type | S | 1..* | CodeableConcept |
subject | S | 1..1 | Reference(PatientSTU3) |
participant | S | 0..* | BackboneElement |
individual | S | 0..1 | Reference(PractitionerSTU3) |
appointment | S | 0..1 | Reference(AppointmentSTU3) |
period | S | 0..1 | Period |
length | S | 0..1 | Duration |
reason | S | 0..* | CodeableConcept |
diagnosis | S | 0..* | BackboneElement |
condition | S | 1..1 | Reference(US Core Condition Profile | US Core Procedure Profile) |
hospitalization | S | 0..1 | BackboneElement |
dischargeDisposition | S | 0..1 | CodeableConcept |
location | S | 0..* | BackboneElement |
location | S | 1..1 | Reference(LocationSTU3) |
partOf |  | 0..1 | Reference(http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-Encounter-stu3) |
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Encounter | I | 0..* |  | An interaction during which services are provided to the patient
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
ext-insurance | I | 0..* | Reference(CoverageSTU3) | Insurance URL: http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/ext-insurance
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | Identifier(s) by which this encounter is known
status | ?!S Σ | 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 | S Σ | 1..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 | S Σ | 1..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example)
priority |  | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example)
subject | S Σ | 1..1 | Reference(PatientSTU3) | 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 | S Σ 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 | S Σ | 0..1 | Reference(PractitionerSTU3) | Persons involved in the encounter other than the patient
appointment | S Σ | 0..1 | Reference(AppointmentSTU3) | The appointment that scheduled this encounter
period | S | 0..1 | Period | The start and end time of the encounter
length | S | 0..1 | Duration | Quantity of time the encounter lasted (less time absent)
reason | S Σ | 0..* | CodeableConcept | Reason the encounter takes place (code) Binding: Encounter Reason Codes (preferred)
diagnosis | S Σ 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 | S | 1..1 | Reference(US Core Condition Profile | US Core Procedure Profile) | 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 | S 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 | S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example)
location | S 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 | S | 1..1 | Reference(LocationSTU3) | 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(http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-Encounter-stu3) | Another Encounter this encounter is part of
Documentation for this format

This structure is derived from Encounter

Summary

Mandatory: 3 elements (1 nested mandatory element)
Must-Support: 17 elements

Structures

This structure refers to these other structures:

- http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-patient-stu3
- http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-practitioner-stu3
- http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-appointment-stu3
- http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition
- http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-location-stu3
- unable to summarise profile http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-Encounter-stu3 (no profile found)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/ext-insurance

Differential View

This structure is derived from Encounter

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Encounter |  | 0..* |  |
ext-insurance |  | 0..* | Reference(CoverageSTU3) | Insurance URL: http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/ext-insurance
identifier | S | 0..* | Identifier |
status | S | 1..1 | code |
class | S | 1..1 | Coding |
type | S | 1..* | CodeableConcept |
subject | S | 1..1 | Reference(PatientSTU3) |
participant | S | 0..* | BackboneElement |
individual | S | 0..1 | Reference(PractitionerSTU3) |
appointment | S | 0..1 | Reference(AppointmentSTU3) |
period | S | 0..1 | Period |
length | S | 0..1 | Duration |
reason | S | 0..* | CodeableConcept |
diagnosis | S | 0..* | BackboneElement |
condition | S | 1..1 | Reference(US Core Condition Profile | US Core Procedure Profile) |
hospitalization | S | 0..1 | BackboneElement |
dischargeDisposition | S | 0..1 | CodeableConcept |
location | S | 0..* | BackboneElement |
location | S | 1..1 | Reference(LocationSTU3) |
partOf |  | 0..1 | Reference(http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-Encounter-stu3) |
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Encounter | I | 0..* |  | An interaction during which services are provided to the patient
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
ext-insurance | I | 0..* | Reference(CoverageSTU3) | Insurance URL: http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/ext-insurance
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | Identifier(s) by which this encounter is known
status | ?!S Σ | 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 | S Σ | 1..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 | S Σ | 1..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example)
priority |  | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example)
subject | S Σ | 1..1 | Reference(PatientSTU3) | 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 | S Σ 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 | S Σ | 0..1 | Reference(PractitionerSTU3) | Persons involved in the encounter other than the patient
appointment | S Σ | 0..1 | Reference(AppointmentSTU3) | The appointment that scheduled this encounter
period | S | 0..1 | Period | The start and end time of the encounter
length | S | 0..1 | Duration | Quantity of time the encounter lasted (less time absent)
reason | S Σ | 0..* | CodeableConcept | Reason the encounter takes place (code) Binding: Encounter Reason Codes (preferred)
diagnosis | S Σ 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 | S | 1..1 | Reference(US Core Condition Profile | US Core Procedure Profile) | 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 | S 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 | S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example)
location | S 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 | S | 1..1 | Reference(LocationSTU3) | 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(http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-Encounter-stu3) | Another Encounter this encounter is part of
Documentation for this format

Other representations of profile: Schematron

### Terminology Bindings

Path | Conformance | ValueSet
Encounter.status | required | EncounterStatus
Encounter.class | extensible | ActEncounterCode
Encounter.type | example | EncounterType
Encounter.reason | preferred | Encounter Reason Codes
Encounter.hospitalization.dischargeDisposition | example | DischargeDisposition

### Constraints

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.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |
ext-1 | Encounter.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | Encounter.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |
ext-1 | Encounter.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
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()) |