CDC FHIR® IG: Anonymized Electronic Initial Case Reporting (eICR)
1.0.1 - release

CDC FHIR® IG: Anonymized Electronic Initial Case Reporting (eICR) - Local Development build (v1.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: eICR Anonymized Encounter

Official URL: http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-encounter | Version: 1.0.1
Active as of 2025-04-14 | Computable Name: EICRAnonymizedEncounter

This Encounter profile represents an anonymized eICR Encounter.

It is based on the eICR Encounter profile with further constraints to require masking of the subject and partcipant (responsible provider).

Usage:

- Refer to this Resource Profile: eICR Anonymized Composition
- Examples for this Resource Profile: Encounter/encounter-outpatient-anon

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Encounter |  | 0..* | EICREncounter | eICR Encounter dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
text | C | 0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children eicr-anon-text: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:dataAbsentReason | S | 1..1 | (Complex) | Use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] |  | 1..1 | code | Value of extension Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children Fixed Value: masked
status |  | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. ele-1: All FHIR elements must have a @value or children
div | C | 1..1 | xhtml | Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' ele-1: All FHIR elements must have a @value or children txt-1: 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 txt-2: The narrative SHALL have some non-whitespace content
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier | S Σ | 1..1 | Identifier | Identifier(s) by which this encounter is known ele-1: All FHIR elements must have a @value or children
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system | S Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
status | ?!S Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. ele-1: All FHIR elements must have a @value or children
class | S Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. ele-1: All FHIR elements must have a @value or children
type | S Σ | 1..* | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type ele-1: All FHIR elements must have a @value or children
subject | S Σ | 1..1 | Reference(eICR Anonymized Patient) | The subject is the anonymized Patient ele-1: All FHIR elements must have a @value or children
Slices for participant | S Σ | 0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by value:type ele-1: All FHIR elements must have a @value or children
participant:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type | S Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. ele-1: All FHIR elements must have a @value or children
period | S | 0..1 | Period | Period of time during the encounter that the participant participated ele-1: All FHIR elements must have a @value or children
individual | S Σ | 0..1 | Reference(US Core Practitioner Profile(4.0.0)) | Persons involved in the encounter other than the patient ele-1: All FHIR elements must have a @value or children
participant:sliceResponsibleProvider | S Σ | 0..1 | BackboneElement | Responsible provider ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type | S Σ | 1..1 | CodeableConcept | Responsible provider Binding: ParticipantType (extensible): Role of participant in encounter. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ATND
period | S | 0..1 | Period | Period of time during the encounter that the participant participated ele-1: All FHIR elements must have a @value or children
individual | S Σ | 1..1 | Reference(eICR Anonymized PractitionerRole) | Responsible Provider ele-1: All FHIR elements must have a @value or children
period | S | 1..1 | Period | The start and end time of the encounter ele-1: All FHIR elements must have a @value or children
start | S Σ C | 1..1 | dateTime | Starting time with inclusive boundary ele-1: All FHIR elements must have a @value or children
reasonCode | S Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. ele-1: All FHIR elements must have a @value or children
reasonReference | S Σ | 0..1 | Reference(US Core Condition Profile(4.0.0)) | Reason the encounter takes place (reference) ele-1: All FHIR elements must have a @value or children
diagnosis | S Σ | 0..* | BackboneElement | Encounter diagnosis ele-1: All FHIR elements must have a @value or children
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:sliceEncounterDiagnosisTrigger | S | 0..1 | (Complex) | Trigger Code Flag URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-trigger-code-flag-extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
condition | S Σ | 1..1 | Reference(US Public Health Condition) | The diagnosis or procedure relevant to the encounter ele-1: All FHIR elements must have a @value or children
use | S | 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. ele-1: All FHIR elements must have a @value or children
hospitalization | S | 0..1 | BackboneElement | Details about the admission to a healthcare service ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
dischargeDisposition | S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. ele-1: All FHIR elements must have a @value or children
location | S | 1..* | BackboneElement | Public health encounter location ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
location | S | 1..1 | Reference(US Public Health Location) | Location the encounter takes place ele-1: All FHIR elements must have a @value or children
serviceProvider | S | 0..1 | Reference(US Public Health Organization) | The organization (facility) responsible for this encounter ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Encounter.text.extension:dataAbsentReason.value[x] | required | Fixed Value: masked `http://hl7.org/fhir/ValueSet/data-absent-reason` from the FHIR Standard
Encounter.text.status | required | NarrativeStatus `http://hl7.org/fhir/ValueSet/narrative-status|4.0.1` from the FHIR Standard
Encounter.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Encounter.status | required | EncounterStatus `http://hl7.org/fhir/ValueSet/encounter-status|4.0.1` from the FHIR Standard
Encounter.class | extensible | ActEncounterCode `http://terminology.hl7.org/ValueSet/v3-ActEncounterCode`
Encounter.type | extensible | USCoreEncounterType `http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type`
Encounter.participant.type | extensible | ParticipantType `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Encounter.participant:sliceResponsibleProvider.type | extensible | Pattern: ATND `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Encounter.reasonCode | preferred | EncounterReasonCodes `http://hl7.org/fhir/ValueSet/encounter-reason` from the FHIR Standard
Encounter.diagnosis.use | preferred | DiagnosisRole `http://hl7.org/fhir/ValueSet/diagnosis-role` from the FHIR Standard
Encounter.hospitalization.dischargeDisposition | example | DischargeDisposition `http://hl7.org/fhir/ValueSet/encounter-discharge-disposition` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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() |
eicr-anon-text | error | Encounter.text | text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : exists() implies `div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>') |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | 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() |

This structure is derived from EICREncounter

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Encounter |  |  | EICREncounter |
text | C | 0..1 | Narrative | Text summary of the resource, for human interpretation eicr-anon-text: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
extension |  | 1..* | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:dataAbsentReason | S | 1..1 | (Complex) | Use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x] |  | 1..1 | code | Value of extension Fixed Value: masked
div |  | 1..1 | xhtml | Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
subject |  | 1..1 | Reference(eICR Anonymized Patient) | The subject is the anonymized Patient
Slices for participant |  |  |  | Content/Rules for all slices
participant:sliceResponsibleProvider |  | 0..1 | BackboneElement | Responsible provider
individual |  | 1..1 | Reference(eICR Anonymized PractitionerRole) | Responsible Provider
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
eicr-anon-text | error | Encounter.text | text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : exists() implies `div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>') |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Encounter |  | 0..* | EICREncounter | eICR Encounter
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: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text | C | 0..1 | Narrative | Text summary of the resource, for human interpretation eicr-anon-text: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:dataAbsentReason | S | 1..1 | (Complex) | Use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] |  | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
status |  | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative.
div | C | 1..1 | xhtml | Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' txt-1: 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 txt-2: The narrative SHALL have some non-whitespace content
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 1..1 | Identifier | Identifier(s) by which this encounter is known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
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 | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..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 | ?!S Σ | 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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
status |  | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
period |  | 1..1 | Period | The time that the episode was in the specified status
class | S Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter.
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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
class |  | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter.
period |  | 1..1 | Period | The time that the episode was in the specified class
type | S Σ | 1..* | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type
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 (example): Indicates the urgency of the encounter.
subject | S Σ | 1..1 | Reference(eICR Anonymized Patient) | The subject is the anonymized Patient
episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against
basedOn |  | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter
Slices for participant | S Σ | 0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by value:type
participant:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
period | S | 0..1 | Period | Period of time during the encounter that the participant participated
individual | S Σ | 0..1 | Reference(US Core Practitioner Profile(4.0.0) S | US Core PractitionerRole Profile(4.0.0) | RelatedPerson) | Persons involved in the encounter other than the patient
participant:sliceResponsibleProvider | S Σ | 0..1 | BackboneElement | Responsible provider
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S Σ | 1..1 | CodeableConcept | Responsible provider Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ATND
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
period | S | 0..1 | Period | Period of time during the encounter that the participant participated
individual | S Σ | 1..1 | Reference(eICR Anonymized PractitionerRole) | Responsible Provider
appointment | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter
period | S | 1..1 | Period | The start and end time of the encounter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
start | S Σ C | 1..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 | S Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
reasonReference | S Σ | 0..1 | Reference(US Core Condition Profile(4.0.0) S | US Core Procedure Profile(4.0.0) | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference)
diagnosis | S Σ | 0..* | BackboneElement | Encounter diagnosis
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:sliceEncounterDiagnosisTrigger | S | 0..1 | (Complex) | Trigger Code Flag URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-trigger-code-flag-extension
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
condition | S Σ | 1..1 | Reference(US Public Health Condition) | The diagnosis or procedure relevant to the encounter
use | S | 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 | S | 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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
preAdmissionIdentifier |  | 0..1 | Identifier | Pre-admission identifier
origin |  | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission
admitSource |  | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted.
reAdmission |  | 0..1 | CodeableConcept | 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: hl7VS-re-admissionIndicator (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
dischargeDisposition | S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition.
location | S | 1..* | BackboneElement | Public health encounter location
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
location | S | 1..1 | Reference(US Public Health Location) | Location the encounter takes place
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
serviceProvider | S | 0..1 | Reference(US Public Health Organization) | The organization (facility) responsible for this encounter
partOf |  | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Encounter.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Encounter.text.extension:dataAbsentReason.value[x] | required | Fixed Value: masked `http://hl7.org/fhir/ValueSet/data-absent-reason` from the FHIR Standard
Encounter.text.status | required | NarrativeStatus `http://hl7.org/fhir/ValueSet/narrative-status|4.0.1` from the FHIR Standard
Encounter.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Encounter.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
Encounter.status | required | EncounterStatus `http://hl7.org/fhir/ValueSet/encounter-status|4.0.1` from the FHIR Standard
Encounter.statusHistory.status | required | EncounterStatus `http://hl7.org/fhir/ValueSet/encounter-status|4.0.1` from the FHIR Standard
Encounter.class | extensible | ActEncounterCode `http://terminology.hl7.org/ValueSet/v3-ActEncounterCode`
Encounter.classHistory.class | extensible | ActEncounterCode `http://terminology.hl7.org/ValueSet/v3-ActEncounterCode`
Encounter.type | extensible | USCoreEncounterType `http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type`
Encounter.serviceType | example | ServiceType `http://hl7.org/fhir/ValueSet/service-type` from the FHIR Standard
Encounter.priority | example | ActPriority `http://terminology.hl7.org/ValueSet/v3-ActPriority`
Encounter.participant.type | extensible | ParticipantType `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Encounter.participant:sliceResponsibleProvider.type | extensible | Pattern: ATND `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Encounter.reasonCode | preferred | EncounterReasonCodes `http://hl7.org/fhir/ValueSet/encounter-reason` from the FHIR Standard
Encounter.diagnosis.use | preferred | DiagnosisRole `http://hl7.org/fhir/ValueSet/diagnosis-role` from the FHIR Standard
Encounter.hospitalization.admitSource | preferred | AdmitSource `http://hl7.org/fhir/ValueSet/encounter-admit-source` from the FHIR Standard
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicator `http://terminology.hl7.org/ValueSet/v2-0092`
Encounter.hospitalization.dietPreference | example | Diet `http://hl7.org/fhir/ValueSet/encounter-diet` from the FHIR Standard
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesy `http://hl7.org/fhir/ValueSet/encounter-special-courtesy` from the FHIR Standard
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangements `http://hl7.org/fhir/ValueSet/encounter-special-arrangements` from the FHIR Standard
Encounter.hospitalization.dischargeDisposition | example | DischargeDisposition `http://hl7.org/fhir/ValueSet/encounter-discharge-disposition` from the FHIR Standard
Encounter.location.status | required | EncounterLocationStatus `http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1` from the FHIR Standard
Encounter.location.physicalType | example | LocationType `http://hl7.org/fhir/ValueSet/location-physical-type` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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() |
eicr-anon-text | error | Encounter.text | text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : exists() implies `div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>') |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | 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() |

This structure is derived from EICREncounter

Summary

Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 1 element
Fixed: 1 element

Structures

This structure refers to these other structures:

- eICR Anonymized Patient (http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-patient)
- eICR Anonymized PractitionerRole (http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-practitionerrole)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/data-absent-reason

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Encounter |  | 0..* | EICREncounter | eICR Encounter dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
text | C | 0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children eicr-anon-text: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:dataAbsentReason | S | 1..1 | (Complex) | Use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] |  | 1..1 | code | Value of extension Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children Fixed Value: masked
status |  | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. ele-1: All FHIR elements must have a @value or children
div | C | 1..1 | xhtml | Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' ele-1: All FHIR elements must have a @value or children txt-1: 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 txt-2: The narrative SHALL have some non-whitespace content
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier | S Σ | 1..1 | Identifier | Identifier(s) by which this encounter is known ele-1: All FHIR elements must have a @value or children
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system | S Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
status | ?!S Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. ele-1: All FHIR elements must have a @value or children
class | S Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. ele-1: All FHIR elements must have a @value or children
type | S Σ | 1..* | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type ele-1: All FHIR elements must have a @value or children
subject | S Σ | 1..1 | Reference(eICR Anonymized Patient) | The subject is the anonymized Patient ele-1: All FHIR elements must have a @value or children
Slices for participant | S Σ | 0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by value:type ele-1: All FHIR elements must have a @value or children
participant:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type | S Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. ele-1: All FHIR elements must have a @value or children
period | S | 0..1 | Period | Period of time during the encounter that the participant participated ele-1: All FHIR elements must have a @value or children
individual | S Σ | 0..1 | Reference(US Core Practitioner Profile(4.0.0)) | Persons involved in the encounter other than the patient ele-1: All FHIR elements must have a @value or children
participant:sliceResponsibleProvider | S Σ | 0..1 | BackboneElement | Responsible provider ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type | S Σ | 1..1 | CodeableConcept | Responsible provider Binding: ParticipantType (extensible): Role of participant in encounter. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ATND
period | S | 0..1 | Period | Period of time during the encounter that the participant participated ele-1: All FHIR elements must have a @value or children
individual | S Σ | 1..1 | Reference(eICR Anonymized PractitionerRole) | Responsible Provider ele-1: All FHIR elements must have a @value or children
period | S | 1..1 | Period | The start and end time of the encounter ele-1: All FHIR elements must have a @value or children
start | S Σ C | 1..1 | dateTime | Starting time with inclusive boundary ele-1: All FHIR elements must have a @value or children
reasonCode | S Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. ele-1: All FHIR elements must have a @value or children
reasonReference | S Σ | 0..1 | Reference(US Core Condition Profile(4.0.0)) | Reason the encounter takes place (reference) ele-1: All FHIR elements must have a @value or children
diagnosis | S Σ | 0..* | BackboneElement | Encounter diagnosis ele-1: All FHIR elements must have a @value or children
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:sliceEncounterDiagnosisTrigger | S | 0..1 | (Complex) | Trigger Code Flag URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-trigger-code-flag-extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
condition | S Σ | 1..1 | Reference(US Public Health Condition) | The diagnosis or procedure relevant to the encounter ele-1: All FHIR elements must have a @value or children
use | S | 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. ele-1: All FHIR elements must have a @value or children
hospitalization | S | 0..1 | BackboneElement | Details about the admission to a healthcare service ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
dischargeDisposition | S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. ele-1: All FHIR elements must have a @value or children
location | S | 1..* | BackboneElement | Public health encounter location ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
location | S | 1..1 | Reference(US Public Health Location) | Location the encounter takes place ele-1: All FHIR elements must have a @value or children
serviceProvider | S | 0..1 | Reference(US Public Health Organization) | The organization (facility) responsible for this encounter ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Encounter.text.extension:dataAbsentReason.value[x] | required | Fixed Value: masked `http://hl7.org/fhir/ValueSet/data-absent-reason` from the FHIR Standard
Encounter.text.status | required | NarrativeStatus `http://hl7.org/fhir/ValueSet/narrative-status|4.0.1` from the FHIR Standard
Encounter.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Encounter.status | required | EncounterStatus `http://hl7.org/fhir/ValueSet/encounter-status|4.0.1` from the FHIR Standard
Encounter.class | extensible | ActEncounterCode `http://terminology.hl7.org/ValueSet/v3-ActEncounterCode`
Encounter.type | extensible | USCoreEncounterType `http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type`
Encounter.participant.type | extensible | ParticipantType `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Encounter.participant:sliceResponsibleProvider.type | extensible | Pattern: ATND `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Encounter.reasonCode | preferred | EncounterReasonCodes `http://hl7.org/fhir/ValueSet/encounter-reason` from the FHIR Standard
Encounter.diagnosis.use | preferred | DiagnosisRole `http://hl7.org/fhir/ValueSet/diagnosis-role` from the FHIR Standard
Encounter.hospitalization.dischargeDisposition | example | DischargeDisposition `http://hl7.org/fhir/ValueSet/encounter-discharge-disposition` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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() |
eicr-anon-text | error | Encounter.text | text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : exists() implies `div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>') |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | 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() |

Differential View

This structure is derived from EICREncounter

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Encounter |  |  | EICREncounter |
text | C | 0..1 | Narrative | Text summary of the resource, for human interpretation eicr-anon-text: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
extension |  | 1..* | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:dataAbsentReason | S | 1..1 | (Complex) | Use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x] |  | 1..1 | code | Value of extension Fixed Value: masked
div |  | 1..1 | xhtml | Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
subject |  | 1..1 | Reference(eICR Anonymized Patient) | The subject is the anonymized Patient
Slices for participant |  |  |  | Content/Rules for all slices
participant:sliceResponsibleProvider |  | 0..1 | BackboneElement | Responsible provider
individual |  | 1..1 | Reference(eICR Anonymized PractitionerRole) | Responsible Provider
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
eicr-anon-text | error | Encounter.text | text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : exists() implies `div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>') |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Encounter |  | 0..* | EICREncounter | eICR Encounter
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: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text | C | 0..1 | Narrative | Text summary of the resource, for human interpretation eicr-anon-text: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:dataAbsentReason | S | 1..1 | (Complex) | Use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] |  | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
status |  | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative.
div | C | 1..1 | xhtml | Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' txt-1: 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 txt-2: The narrative SHALL have some non-whitespace content
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 1..1 | Identifier | Identifier(s) by which this encounter is known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
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 | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..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 | ?!S Σ | 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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
status |  | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
period |  | 1..1 | Period | The time that the episode was in the specified status
class | S Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter.
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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
class |  | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter.
period |  | 1..1 | Period | The time that the episode was in the specified class
type | S Σ | 1..* | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type
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 (example): Indicates the urgency of the encounter.
subject | S Σ | 1..1 | Reference(eICR Anonymized Patient) | The subject is the anonymized Patient
episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against
basedOn |  | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter
Slices for participant | S Σ | 0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by value:type
participant:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
period | S | 0..1 | Period | Period of time during the encounter that the participant participated
individual | S Σ | 0..1 | Reference(US Core Practitioner Profile(4.0.0) S | US Core PractitionerRole Profile(4.0.0) | RelatedPerson) | Persons involved in the encounter other than the patient
participant:sliceResponsibleProvider | S Σ | 0..1 | BackboneElement | Responsible provider
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S Σ | 1..1 | CodeableConcept | Responsible provider Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ATND
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
period | S | 0..1 | Period | Period of time during the encounter that the participant participated
individual | S Σ | 1..1 | Reference(eICR Anonymized PractitionerRole) | Responsible Provider
appointment | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter
period | S | 1..1 | Period | The start and end time of the encounter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
start | S Σ C | 1..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 | S Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
reasonReference | S Σ | 0..1 | Reference(US Core Condition Profile(4.0.0) S | US Core Procedure Profile(4.0.0) | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference)
diagnosis | S Σ | 0..* | BackboneElement | Encounter diagnosis
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:sliceEncounterDiagnosisTrigger | S | 0..1 | (Complex) | Trigger Code Flag URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-trigger-code-flag-extension
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
condition | S Σ | 1..1 | Reference(US Public Health Condition) | The diagnosis or procedure relevant to the encounter
use | S | 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 | S | 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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
preAdmissionIdentifier |  | 0..1 | Identifier | Pre-admission identifier
origin |  | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission
admitSource |  | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted.
reAdmission |  | 0..1 | CodeableConcept | 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: hl7VS-re-admissionIndicator (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
dischargeDisposition | S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition.
location | S | 1..* | BackboneElement | Public health encounter location
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
location | S | 1..1 | Reference(US Public Health Location) | Location the encounter takes place
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
serviceProvider | S | 0..1 | Reference(US Public Health Organization) | The organization (facility) responsible for this encounter
partOf |  | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Encounter.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Encounter.text.extension:dataAbsentReason.value[x] | required | Fixed Value: masked `http://hl7.org/fhir/ValueSet/data-absent-reason` from the FHIR Standard
Encounter.text.status | required | NarrativeStatus `http://hl7.org/fhir/ValueSet/narrative-status|4.0.1` from the FHIR Standard
Encounter.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Encounter.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
Encounter.status | required | EncounterStatus `http://hl7.org/fhir/ValueSet/encounter-status|4.0.1` from the FHIR Standard
Encounter.statusHistory.status | required | EncounterStatus `http://hl7.org/fhir/ValueSet/encounter-status|4.0.1` from the FHIR Standard
Encounter.class | extensible | ActEncounterCode `http://terminology.hl7.org/ValueSet/v3-ActEncounterCode`
Encounter.classHistory.class | extensible | ActEncounterCode `http://terminology.hl7.org/ValueSet/v3-ActEncounterCode`
Encounter.type | extensible | USCoreEncounterType `http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type`
Encounter.serviceType | example | ServiceType `http://hl7.org/fhir/ValueSet/service-type` from the FHIR Standard
Encounter.priority | example | ActPriority `http://terminology.hl7.org/ValueSet/v3-ActPriority`
Encounter.participant.type | extensible | ParticipantType `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Encounter.participant:sliceResponsibleProvider.type | extensible | Pattern: ATND `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Encounter.reasonCode | preferred | EncounterReasonCodes `http://hl7.org/fhir/ValueSet/encounter-reason` from the FHIR Standard
Encounter.diagnosis.use | preferred | DiagnosisRole `http://hl7.org/fhir/ValueSet/diagnosis-role` from the FHIR Standard
Encounter.hospitalization.admitSource | preferred | AdmitSource `http://hl7.org/fhir/ValueSet/encounter-admit-source` from the FHIR Standard
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicator `http://terminology.hl7.org/ValueSet/v2-0092`
Encounter.hospitalization.dietPreference | example | Diet `http://hl7.org/fhir/ValueSet/encounter-diet` from the FHIR Standard
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesy `http://hl7.org/fhir/ValueSet/encounter-special-courtesy` from the FHIR Standard
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangements `http://hl7.org/fhir/ValueSet/encounter-special-arrangements` from the FHIR Standard
Encounter.hospitalization.dischargeDisposition | example | DischargeDisposition `http://hl7.org/fhir/ValueSet/encounter-discharge-disposition` from the FHIR Standard
Encounter.location.status | required | EncounterLocationStatus `http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1` from the FHIR Standard
Encounter.location.physicalType | example | LocationType `http://hl7.org/fhir/ValueSet/location-physical-type` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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() |
eicr-anon-text | error | Encounter.text | text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : exists() implies `div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>') |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | 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() |

This structure is derived from EICREncounter

Summary

Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 1 element
Fixed: 1 element

Structures

This structure refers to these other structures:

- eICR Anonymized Patient (http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-patient)
- eICR Anonymized PractitionerRole (http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-practitionerrole)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/data-absent-reason

Other representations of profile: CSV, Excel, Schematron