eICR Encounter - Electronic Case Reporting (eCR) v3.0.0-ballot

Electronic Case Reporting (eCR), published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/case-reporting/ and changes regularly. See the Directory of published versions

Resource Profile: eICR Encounter

Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-encounter	Version: 3.0.0-ballot	Highlight text changes?
Standards status: Trial-use	Maturity Level: 3	Computable Name: EICREncounter
Other Identifiers: OID:2.16.840.1.113883.4.642.40.46.42.6

This Encounter profile represents the encounter related to the event. It is based on the US Public Health Encounter profile.

This profile is based on and further constrains the US Public Health Encounter profile.

A trigger on an encounter diagnosis is indicated by the eICR Trigger Code Flag Extension in the diagnosis.

Where a trigger occurs outside of an encounter set Encounter.class to "PHC2237”, system=”2.16.840.1.114222.4.5.274” (External Encounter) and omit period, participant, location, and serviceProvider. In this case, the responsible provider and facility information is contained in the eICR Composition.author.

Data Element	Note
Encounter.participant:sliceResponsibleProvider.individual[PractitionerRole]	Provider: Provider responsible for the patient's care when the case was triggered.
Encounter.participant:sliceResponsibleProvider.individual[PractitionerRole].practitioner[Practitioner].identifier	Provider Id: Identifier of the provider responsible for the patient's care when the case was triggered
Encounter.participant:sliceResponsibleProvider.individual[PractitionerRole].location[Location].address	Provider Address: Address of the provider responsible for the patient's care when the case was triggered
Encounter.participant:sliceResponsibleProvider.individual[PractitionerRole].telecom	Provider Telecom: A telecom address (phone, email, fax, etc.) for the provider responsible for the patient's care when the case was triggered
Encounter.participant:sliceResponsibleProvider.individual[PractitionerRole].practitioner[Practitioner].name	Provider Name: Name of the provider responsible for the patient's care when the case was triggered
Encounter.participant:sliceResponsibleProvider.individual[PractitionerRole].organization[Organization]	Provider Facility/Office: The office or facility of the provider responsible for the patient's care when the case was triggered (where care was provided to the patient)
Encounter.participant:sliceResponsibleProvider.individual[PractitionerRole].organization[Organization].name	Provider Facility/Office Name: The name of the office or facility of the provider responsible for the patient's care when the case was triggered (where care was provided to the patient)
Encounter.participant:sliceResponsibleProvider.individual[PractitionerRole].organization[Organization].address	Provider Facility/Office Address: The address of the office or facility of the provider responsible for the patient's care when the case was triggered (where care was provided to the patient)
Encounter.participant:sliceResponsibleProvider.individual[PractitionerRole].organization[Organization].telecom	Provider Facility/Office Address: The telecom of the office or facility of the provider responsible for the patient's care when the case was triggered (where care was provided to the patient)
Encounter.location.location[Location]	Facility: The facility in which care was provided when the case was triggered
Encounter.location.location[Location].name	Facility Name: The name of the facility in which care was provided when the case was triggered
Encounter.location.location[Location].identifier	Facility Id: Identification code for the facility in which care was provided when the case was triggered
Encounter.location.location[Location].type	Facility Type: The type of facility in which care was provided when the case was triggered
Encounter.location.location[Location].address	Facility Address: The physical location of the facility in which care was provided when the case was triggered
Encounter.serviceProvider[Organization]	Healthcare Organization: The umbrella organization under which the facility where care was provided operates
Encounter.serviceProvider[Organization].identifier	Healthcare Organization Id: Identification code for the umbrella organization under which the facility where care was provided operates
Encounter.serviceProvider[Organization].name	Healthcare Organization Contact Name: The contact name for the for the umbrella organization under which the facility where care was provided operates
Encounter.serviceProvider[Organization].telecom	Healthcare Organization Contact Telecom: A contact telecom address (phone, email, fax, etc.) for the umbrella organization under which the facility where care was provided operates
Encounter.serviceProvider[Organization].address	Healthcare Organization Contact Address: The contact address for the umbrella organization under which the facility where care was provided operates

Usages:

Refer to this Profile: eICR Composition and RR Composition
Examples for this Profile: Encounter/encounter-eicr-eve-everywoman-completed-inpatient, Encounter/encounter-eicr-eve-everywoman-current-inpatient and Encounter/encounter-eicr-eve-everywoman-outpatient

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

Key Elements Table
Differential Table
Snapshot Table
Statistics/References
All

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Encounter		0..*	USPublicHealthEncounter	eICR Encounter
Encounter.implicitRules	This element is a modifier element. This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Encounter.modifierExtension	This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Encounter.identifier	This element must be supported. This element is included in summaries.	1..*	Identifier	(USCDI+) Encounter Identifier
Encounter.identifier.use	This element is a modifier element. This element is included in summaries.	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Encounter.identifier.system	This element must be supported. This element is included in summaries.	1..1	uri	(USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Encounter.identifier.value	This element must be supported. This element is included in summaries.	1..1	string	(USCDI) The value that is unique Example General: 123456
Encounter.status	This element is a modifier element. This element must be supported. This element is included in summaries.	1..1	code	(USCDI+) Encounter Status Binding: EncounterStatus (required): Current state of the encounter.
Encounter.class	This element must be supported. This element is included in summaries.	1..1	Coding	(USCDI) Classification of patient encounter Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
Encounter.type	This element must be supported. This element is included in summaries.	1..*	CodeableConcept	(USCDI+) Encounter Type Binding: USCoreEncounterType (6.1.0) (extensible): Valueset to describe the Encounter Type
Encounter.subject	This element must be supported. This element is included in summaries.	1..1	Reference(US Public Health Patient \| US Core Patient Profile(6.1.0))	(USCDI) The patient or group present at the encounter
Encounter.Slices for participant	This element must be supported. This element is included in summaries.	0..*	BackboneElement	(USCDI) List of participants involved in the encounter Slice: Unordered, Open by type:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for participant.participant:All Slices				Content/Rules for all slices
Encounter.Slices for participant.participant:All Slices.modifierExtension	This element is a modifier element. This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.Slices for participant.participant:All Slices.type	This element must be supported. This element is included in summaries.	0..*	CodeableConcept	(USCDI) Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
Encounter.Slices for participant.participant:All Slices.period	This element must be supported.	0..1	Period	(USCDI) Period of time during the encounter that the participant participated
Encounter.Slices for participant.participant:All Slices.individual	This element must be supported. This element is included in summaries.	0..1	Reference(US Core Practitioner Profile(6.1.0) This type must be supported. \| US Core PractitionerRole Profile(6.1.0) \| US Core RelatedPerson Profile(6.1.0))	(USCDI) Persons involved in the encounter other than the patient
Encounter.Slices for participant.participant:responsibleProvider	This element must be supported. This element is included in summaries.	0..1	BackboneElement	Responsible provider
Encounter.Slices for participant.participant:responsibleProvider.modifierExtension	This element is a modifier element. This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.Slices for participant.participant:responsibleProvider.type	This element must be supported. This element is included in summaries.	1..1	CodeableConcept	(USCDI) Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: `{ "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", "code" : "ATND" } ] }`
Encounter.Slices for participant.participant:responsibleProvider.period	This element must be supported.	0..1	Period	(USCDI) Period of time during the encounter that the participant participated
Encounter.Slices for participant.participant:responsibleProvider.individual	This element must be supported. This element is included in summaries.	1..1	Reference(US Public Health PractitionerRole)	(USCDI) Persons involved in the encounter other than the patient
Encounter.period	This element must be supported.	1..1	Period	(USCDI) The start and end time of the encounter
Encounter.period.start	This element must be supported. This element is included in summaries. C	1..1	dateTime	(USCDI+) Admission Date/Time (Visit Start Date/Time)
Encounter.reasonCode	This element must be supported. This element is included in summaries.	0..*	CodeableConcept	(USCDI+) Reason for the Encounter Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
Encounter.Slices for reasonReference	This element must be supported. This element is included in summaries.	0..*	Reference(US Core Condition Problems and Health Concerns Profile(6.1.0) This type must be supported. \| US Core Condition Encounter Diagnosis Profile(6.1.0) This type must be supported. \| US Core Procedure Profile(6.1.0) \| Observation \| ImmunizationRecommendation)	(USCDI+) Reason for the Encounter Slice: Unordered, Open by profile:$this.resolve() Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for reasonReference.reasonReference:chiefComplaint	This element must be supported. This element is included in summaries.	0..1	Reference(US Public Health Chief Complaint Observation)	(USCDI+) Chief Complaint
Encounter.diagnosis	This element must be supported. This element is included in summaries.	0..*	BackboneElement	(USCDI+) Encounter Diagnosis, (USCDI+) Chief Complaint (when diagnosis.use='CC')
Encounter.diagnosis.Slices for extension	This element must be supported.	0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.diagnosis.Slices for extension.extension:sliceEncounterDiagnosisTrigger	This element must be supported.	0..1	(Complex)	Trigger Code Flag URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-trigger-code-flag-extension
Encounter.diagnosis.modifierExtension	This element is a modifier element. This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.diagnosis.condition	This element must be supported. This element is included in summaries.	1..1	Reference(US Public Health Condition Encounter Diagnosis)	The diagnosis or procedure relevant to the encounter
Encounter.diagnosis.use	This element must be supported.	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.
Encounter.hospitalization	This element must be supported.	0..1	BackboneElement	(USCDI) Details about the admission to a healthcare service
Encounter.hospitalization.modifierExtension	This element is a modifier element. This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.hospitalization.dischargeDisposition	This element must be supported.	0..1	CodeableConcept	(USCDI+) Encounter Disposition Binding: USCoreDischargeDisposition (6.1.0) (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17
Encounter.location	This element must be supported.	1..*	BackboneElement	(USCDI) List of locations where the patient has been
Encounter.location.modifierExtension	This element is a modifier element. This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.location.location	This element must be supported.	1..1	Reference(US Public Health Location)	(USCDI+) Encounter Location
Encounter.serviceProvider	This element must be supported.	0..1	Reference(US Public Health Organization)	(USCDI) The organization (facility) responsible for this encounter
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Encounter.identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Encounter.status	Base	required	EncounterStatus	📍4.0.1	FHIR Std.
Encounter.class	Base	extensible	ActEncounterCode	📍3.0.0	THO v7.5
Encounter.type	Base	extensible	US Core Encounter Type	📍6.1.0	US Core v6.1
Encounter.participant.type	Base	extensible	Participant type	📦4.0.1	FHIR Std.
Encounter.participant:responsibleProvider.type	Base	extensible	Participant type	📦4.0.1	FHIR Std.
Encounter.reasonCode	Base	preferred	Encounter Reason Codes	📦4.0.1	FHIR Std.
Encounter.diagnosis.use	Base	preferred	DiagnosisRole	📦4.0.1	FHIR Std.
Encounter.hospitalization.dischargeDisposition	Base	preferred	US Core Discharge Disposition	📍6.1.0	US Core v6.1

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Encounter	If the resource is contained in another resource, it SHALL NOT contain nested Resources	`contained.contained.empty()`
dom-3	error	Encounter	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	`contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	`contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a security label	`contained.meta.security.empty()`
dom-6	best practice	Encounter	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	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()`

This structure is derived from USPublicHealthEncounter

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Encounter		0..*	USPublicHealthEncounter	eICR Encounter
Encounter.identifier		1..*	Identifier	(USCDI+) Encounter Identifier
Encounter.period		1..1	Period	(USCDI) The start and end time of the encounter
Encounter.period.start	This element must be supported.	1..1	dateTime	(USCDI+) Admission Date/Time (Visit Start Date/Time)
Encounter.diagnosis
Encounter.diagnosis.Slices for extension	This element must be supported.	0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.diagnosis.Slices for extension.extension:sliceEncounterDiagnosisTrigger	This element must be supported.	0..1	(Complex)	Trigger Code Flag URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-trigger-code-flag-extension
Documentation for this format

Description & Constraints Filter:

Encounter 0..* USPublicHealthEncounter eICR Encounter

Encounter.id This element is included in summaries. 0..1 id Logical id of this artifact

Encounter.meta This element is included in summaries. 0..1 Meta Metadata about the resource

Encounter.implicitRules This element is a modifier element. This element is included in summaries. 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

Encounter.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements

Encounter.contained 0..* Resource Contained, inline Resources

Encounter.extension 0..* Extension Additional content defined by implementations

Encounter.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored

Encounter.identifier This element must be supported. This element is included in summaries. 1..* Identifier (USCDI+) Encounter Identifier

Encounter.identifier.id 0..1 string Unique id for inter-element referencing

Encounter.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

Encounter.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

Encounter.identifier.type This element is included in summaries. 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.

Encounter.identifier.system This element must be supported. This element is included in summaries. 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient

Encounter.identifier.value This element must be supported. This element is included in summaries. 1..1 string (USCDI) The value that is unique
Example General: 123456

Encounter.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use

Encounter.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)

Encounter.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code (USCDI+) Encounter Status
Binding: EncounterStatus (required): Current state of the encounter.

Encounter.statusHistory 0..* BackboneElement List of past encounter statuses

Encounter.statusHistory.id 0..1 string Unique id for inter-element referencing

Encounter.statusHistory.extension 0..* Extension Additional content defined by implementations

Encounter.statusHistory.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

Encounter.statusHistory.period 1..1 Period The time that the episode was in the specified status

Encounter.class This element must be supported. This element is included in summaries. 1..1 Coding (USCDI) Classification of patient encounter
Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.

Encounter.classHistory 0..* BackboneElement List of past encounter classes

Encounter.classHistory.id 0..1 string Unique id for inter-element referencing

Encounter.classHistory.extension 0..* Extension Additional content defined by implementations

Encounter.classHistory.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

Encounter.classHistory.class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.

Encounter.classHistory.period 1..1 Period The time that the episode was in the specified class

Encounter.type This element must be supported. This element is included in summaries. 1..* CodeableConcept (USCDI+) Encounter Type
Binding: USCoreEncounterType (6.1.0) (extensible): Valueset to describe the Encounter Type

Encounter.serviceType This element is included in summaries. 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.

Encounter.priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter.

Encounter.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Public Health Patient | US Core Patient Profile(6.1.0)) (USCDI) The patient or group present at the encounter

Encounter.episodeOfCare This element is included in summaries. 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against

Encounter.basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter

Encounter.Slices for participant This element must be supported. This element is included in summaries. 0..* BackboneElement (USCDI) List of participants involved in the encounter
Slice: Unordered, Open by type:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

Encounter.Slices for participant.participant:All Slices Content/Rules for all slices

Encounter.Slices for participant.participant:All Slices.id 0..1 string Unique id for inter-element referencing

Encounter.Slices for participant.participant:All Slices.extension 0..* Extension Additional content defined by implementations

Encounter.Slices for participant.participant:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

Encounter.Slices for participant.participant:All Slices.type This element must be supported. This element is included in summaries. 0..* CodeableConcept (USCDI) Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.

Encounter.Slices for participant.participant:All Slices.period This element must be supported. 0..1 Period (USCDI) Period of time during the encounter that the participant participated

Encounter.Slices for participant.participant:All Slices.individual This element must be supported. This element is included in summaries. 0..1 Reference(US Core Practitioner Profile(6.1.0) This type must be supported. | US Core PractitionerRole Profile(6.1.0) | US Core RelatedPerson Profile(6.1.0)) (USCDI) Persons involved in the encounter other than the patient

Encounter.Slices for participant.participant:responsibleProvider This element must be supported. This element is included in summaries. 0..1 BackboneElement Responsible provider

Encounter.Slices for participant.participant:responsibleProvider.id 0..1 string Unique id for inter-element referencing

Encounter.Slices for participant.participant:responsibleProvider.extension 0..* Extension Additional content defined by implementations

Encounter.Slices for participant.participant:responsibleProvider.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

type

1..1

CodeableConcept

(USCDI) Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.

Required Pattern:

{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
      "code" : "ATND"
    }
  ]
}

Encounter.Slices for participant.participant:responsibleProvider.period This element must be supported. 0..1 Period (USCDI) Period of time during the encounter that the participant participated

Encounter.Slices for participant.participant:responsibleProvider.individual This element must be supported. This element is included in summaries. 1..1 Reference(US Public Health PractitionerRole) (USCDI) Persons involved in the encounter other than the patient

Encounter.appointment This element is included in summaries. 0..* Reference(Appointment) The appointment that scheduled this encounter

Encounter.period This element must be supported. 1..1 Period (USCDI) The start and end time of the encounter

Encounter.period.id 0..1 string Unique id for inter-element referencing

Encounter.period.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

Encounter.period.start This element must be supported. This element is included in summaries. C 1..1 dateTime (USCDI+) Admission Date/Time (Visit Start Date/Time)

Encounter.period.end This element is included in summaries. C 0..1 dateTime Discharge Date/Time (Visit End Date/Time)

Encounter.length 0..1 Duration Quantity of time the encounter lasted (less time absent)

Encounter.reasonCode This element must be supported. This element is included in summaries. 0..* CodeableConcept (USCDI+) Reason for the Encounter
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.

Encounter.Slices for reasonReference This element must be supported. This element is included in summaries. 0..* Reference(US Core Condition Problems and Health Concerns Profile(6.1.0) This type must be supported. | US Core Condition Encounter Diagnosis Profile(6.1.0) This type must be supported. | US Core Procedure Profile(6.1.0) | Observation | ImmunizationRecommendation) (USCDI+) Reason for the Encounter
Slice: Unordered, Open by profile:$this.resolve()

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

Encounter.Slices for reasonReference.reasonReference:chiefComplaint This element must be supported. This element is included in summaries. 0..1 Reference(US Public Health Chief Complaint Observation) (USCDI+) Chief Complaint

Encounter.diagnosis This element must be supported. This element is included in summaries. 0..* BackboneElement (USCDI+) Encounter Diagnosis, (USCDI+) Chief Complaint (when diagnosis.use='CC')

Encounter.diagnosis.id 0..1 string Unique id for inter-element referencing

Encounter.diagnosis.Slices for extension This element must be supported. 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

Encounter.diagnosis.Slices for extension.extension:sliceEncounterDiagnosisTrigger This element must be supported. 0..1 (Complex) Trigger Code Flag
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-trigger-code-flag-extension

Encounter.diagnosis.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

Encounter.diagnosis.condition This element must be supported. This element is included in summaries. 1..1 Reference(US Public Health Condition Encounter Diagnosis) The diagnosis or procedure relevant to the encounter

Encounter.diagnosis.use This element must be supported. 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.

Encounter.diagnosis.rank 0..1 positiveInt Ranking of the diagnosis (for each role type)

Encounter.account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter

Encounter.hospitalization This element must be supported. 0..1 BackboneElement (USCDI) Details about the admission to a healthcare service

Encounter.hospitalization.id 0..1 string Unique id for inter-element referencing

Encounter.hospitalization.extension 0..* Extension Additional content defined by implementations

Encounter.hospitalization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

Encounter.hospitalization.preAdmissionIdentifier 0..1 Identifier Pre-admission identifier

Encounter.hospitalization.origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission

Encounter.hospitalization.admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.

Encounter.hospitalization.reAdmission 0..1 CodeableConcept The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: Hl7VSReAdmissionIndicator (3.0.0) (example): The reason for re-admission of this hospitalization encounter.

Encounter.hospitalization.dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.

Encounter.hospitalization.specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.

Encounter.hospitalization.specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.

Encounter.hospitalization.destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged

Encounter.hospitalization.dischargeDisposition This element must be supported. 0..1 CodeableConcept (USCDI+) Encounter Disposition
Binding: USCoreDischargeDisposition (6.1.0) (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17

Encounter.location This element must be supported. 1..* BackboneElement (USCDI) List of locations where the patient has been

Encounter.location.id 0..1 string Unique id for inter-element referencing

Encounter.location.extension 0..* Extension Additional content defined by implementations

Encounter.location.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized

Encounter.location.location This element must be supported. 1..1 Reference(US Public Health Location) (USCDI+) Encounter Location

Encounter.location.status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.

Encounter.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.

Encounter.location.period 0..1 Period Time period during which the patient was present at the location

Encounter.serviceProvider This element must be supported. 0..1 Reference(US Public Health Organization) (USCDI) The organization (facility) responsible for this encounter

Encounter.partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Encounter.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Encounter.identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Encounter.identifier.type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Encounter.status	Base	required	EncounterStatus	📍4.0.1	FHIR Std.
Encounter.statusHistory.status	Base	required	EncounterStatus	📍4.0.1	FHIR Std.
Encounter.class	Base	extensible	ActEncounterCode	📍3.0.0	THO v7.5
Encounter.classHistory.class	Base	extensible	ActEncounterCode	📍3.0.0	THO v7.5
Encounter.type	Base	extensible	US Core Encounter Type	📍6.1.0	US Core v6.1
Encounter.serviceType	Base	example	Service type	📦4.0.1	FHIR Std.
Encounter.priority	Base	example	ActPriority	📍3.0.0	THO v7.5
Encounter.participant.type	Base	extensible	Participant type	📦4.0.1	FHIR Std.
Encounter.participant:responsibleProvider.type	Base	extensible	Participant type	📦4.0.1	FHIR Std.
Encounter.reasonCode	Base	preferred	Encounter Reason Codes	📦4.0.1	FHIR Std.
Encounter.diagnosis.use	Base	preferred	DiagnosisRole	📦4.0.1	FHIR Std.
Encounter.hospitalization.admitSource	Base	preferred	Admit source	📦4.0.1	FHIR Std.
Encounter.hospitalization.reAdmission	Base	example	hl7VS-re-admissionIndicator	📍3.0.0	THO v7.5
Encounter.hospitalization.dietPreference	Base	example	Diet	📦4.0.1	FHIR Std.
Encounter.hospitalization.specialCourtesy	Base	preferred	Special courtesy	📦4.0.1	FHIR Std.
Encounter.hospitalization.specialArrangement	Base	preferred	Special arrangements	📦4.0.1	FHIR Std.
Encounter.hospitalization.dischargeDisposition	Base	preferred	US Core Discharge Disposition	📍6.1.0	US Core v6.1
Encounter.location.status	Base	required	EncounterLocationStatus	📍4.0.1	FHIR Std.
Encounter.location.physicalType	Base	example	Location type	📦4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Encounter	If the resource is contained in another resource, it SHALL NOT contain nested Resources	`contained.contained.empty()`
dom-3	error	Encounter	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	`contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	`contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a security label	`contained.meta.security.empty()`
dom-6	best practice	Encounter	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	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()`

This structure is derived from USPublicHealthEncounter

Summary

Mandatory: 3 elements
Must-Support: 3 elements

Extensions

This structure refers to these extensions:

http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-trigger-code-flag-extension

Maturity: 3

Key Elements View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Encounter		0..*	USPublicHealthEncounter	eICR Encounter
Encounter.implicitRules	This element is a modifier element. This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Encounter.modifierExtension	This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Encounter.identifier	This element must be supported. This element is included in summaries.	1..*	Identifier	(USCDI+) Encounter Identifier
Encounter.identifier.use	This element is a modifier element. This element is included in summaries.	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Encounter.identifier.system	This element must be supported. This element is included in summaries.	1..1	uri	(USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Encounter.identifier.value	This element must be supported. This element is included in summaries.	1..1	string	(USCDI) The value that is unique Example General: 123456
Encounter.status	This element is a modifier element. This element must be supported. This element is included in summaries.	1..1	code	(USCDI+) Encounter Status Binding: EncounterStatus (required): Current state of the encounter.
Encounter.class	This element must be supported. This element is included in summaries.	1..1	Coding	(USCDI) Classification of patient encounter Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
Encounter.type	This element must be supported. This element is included in summaries.	1..*	CodeableConcept	(USCDI+) Encounter Type Binding: USCoreEncounterType (6.1.0) (extensible): Valueset to describe the Encounter Type
Encounter.subject	This element must be supported. This element is included in summaries.	1..1	Reference(US Public Health Patient \| US Core Patient Profile(6.1.0))	(USCDI) The patient or group present at the encounter
Encounter.Slices for participant	This element must be supported. This element is included in summaries.	0..*	BackboneElement	(USCDI) List of participants involved in the encounter Slice: Unordered, Open by type:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for participant.participant:All Slices				Content/Rules for all slices
Encounter.Slices for participant.participant:All Slices.modifierExtension	This element is a modifier element. This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.Slices for participant.participant:All Slices.type	This element must be supported. This element is included in summaries.	0..*	CodeableConcept	(USCDI) Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
Encounter.Slices for participant.participant:All Slices.period	This element must be supported.	0..1	Period	(USCDI) Period of time during the encounter that the participant participated
Encounter.Slices for participant.participant:All Slices.individual	This element must be supported. This element is included in summaries.	0..1	Reference(US Core Practitioner Profile(6.1.0) This type must be supported. \| US Core PractitionerRole Profile(6.1.0) \| US Core RelatedPerson Profile(6.1.0))	(USCDI) Persons involved in the encounter other than the patient
Encounter.Slices for participant.participant:responsibleProvider	This element must be supported. This element is included in summaries.	0..1	BackboneElement	Responsible provider
Encounter.Slices for participant.participant:responsibleProvider.modifierExtension	This element is a modifier element. This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.Slices for participant.participant:responsibleProvider.type	This element must be supported. This element is included in summaries.	1..1	CodeableConcept	(USCDI) Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: `{ "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", "code" : "ATND" } ] }`
Encounter.Slices for participant.participant:responsibleProvider.period	This element must be supported.	0..1	Period	(USCDI) Period of time during the encounter that the participant participated
Encounter.Slices for participant.participant:responsibleProvider.individual	This element must be supported. This element is included in summaries.	1..1	Reference(US Public Health PractitionerRole)	(USCDI) Persons involved in the encounter other than the patient
Encounter.period	This element must be supported.	1..1	Period	(USCDI) The start and end time of the encounter
Encounter.period.start	This element must be supported. This element is included in summaries. C	1..1	dateTime	(USCDI+) Admission Date/Time (Visit Start Date/Time)
Encounter.reasonCode	This element must be supported. This element is included in summaries.	0..*	CodeableConcept	(USCDI+) Reason for the Encounter Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
Encounter.Slices for reasonReference	This element must be supported. This element is included in summaries.	0..*	Reference(US Core Condition Problems and Health Concerns Profile(6.1.0) This type must be supported. \| US Core Condition Encounter Diagnosis Profile(6.1.0) This type must be supported. \| US Core Procedure Profile(6.1.0) \| Observation \| ImmunizationRecommendation)	(USCDI+) Reason for the Encounter Slice: Unordered, Open by profile:$this.resolve() Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for reasonReference.reasonReference:chiefComplaint	This element must be supported. This element is included in summaries.	0..1	Reference(US Public Health Chief Complaint Observation)	(USCDI+) Chief Complaint
Encounter.diagnosis	This element must be supported. This element is included in summaries.	0..*	BackboneElement	(USCDI+) Encounter Diagnosis, (USCDI+) Chief Complaint (when diagnosis.use='CC')
Encounter.diagnosis.Slices for extension	This element must be supported.	0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.diagnosis.Slices for extension.extension:sliceEncounterDiagnosisTrigger	This element must be supported.	0..1	(Complex)	Trigger Code Flag URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-trigger-code-flag-extension
Encounter.diagnosis.modifierExtension	This element is a modifier element. This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.diagnosis.condition	This element must be supported. This element is included in summaries.	1..1	Reference(US Public Health Condition Encounter Diagnosis)	The diagnosis or procedure relevant to the encounter
Encounter.diagnosis.use	This element must be supported.	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.
Encounter.hospitalization	This element must be supported.	0..1	BackboneElement	(USCDI) Details about the admission to a healthcare service
Encounter.hospitalization.modifierExtension	This element is a modifier element. This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.hospitalization.dischargeDisposition	This element must be supported.	0..1	CodeableConcept	(USCDI+) Encounter Disposition Binding: USCoreDischargeDisposition (6.1.0) (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17
Encounter.location	This element must be supported.	1..*	BackboneElement	(USCDI) List of locations where the patient has been
Encounter.location.modifierExtension	This element is a modifier element. This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.location.location	This element must be supported.	1..1	Reference(US Public Health Location)	(USCDI+) Encounter Location
Encounter.serviceProvider	This element must be supported.	0..1	Reference(US Public Health Organization)	(USCDI) The organization (facility) responsible for this encounter
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Encounter.identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Encounter.status	Base	required	EncounterStatus	📍4.0.1	FHIR Std.
Encounter.class	Base	extensible	ActEncounterCode	📍3.0.0	THO v7.5
Encounter.type	Base	extensible	US Core Encounter Type	📍6.1.0	US Core v6.1
Encounter.participant.type	Base	extensible	Participant type	📦4.0.1	FHIR Std.
Encounter.participant:responsibleProvider.type	Base	extensible	Participant type	📦4.0.1	FHIR Std.
Encounter.reasonCode	Base	preferred	Encounter Reason Codes	📦4.0.1	FHIR Std.
Encounter.diagnosis.use	Base	preferred	DiagnosisRole	📦4.0.1	FHIR Std.
Encounter.hospitalization.dischargeDisposition	Base	preferred	US Core Discharge Disposition	📍6.1.0	US Core v6.1

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Encounter	If the resource is contained in another resource, it SHALL NOT contain nested Resources	`contained.contained.empty()`
dom-3	error	Encounter	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	`contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	`contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a security label	`contained.meta.security.empty()`
dom-6	best practice	Encounter	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	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()`

Differential View

This structure is derived from USPublicHealthEncounter

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Encounter		0..*	USPublicHealthEncounter	eICR Encounter
Encounter.identifier		1..*	Identifier	(USCDI+) Encounter Identifier
Encounter.period		1..1	Period	(USCDI) The start and end time of the encounter
Encounter.period.start	This element must be supported.	1..1	dateTime	(USCDI+) Admission Date/Time (Visit Start Date/Time)
Encounter.diagnosis
Encounter.diagnosis.Slices for extension	This element must be supported.	0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.diagnosis.Slices for extension.extension:sliceEncounterDiagnosisTrigger	This element must be supported.	0..1	(Complex)	Trigger Code Flag URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-trigger-code-flag-extension
Documentation for this format

Snapshot ViewView