HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
1.1.0 - STU 2 Ballot

This page is part of the electronic Case Reporting (eCR) (v1.1.0: STU 2 on FHIR R4 Ballot 1) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

Resource Profile: US Public Health Encounter

Defining URL:http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-encounter
Version:1.1.0
Name:USPublicHealthEncounter
Title:US Public Health Encounter
Status:Active as of 2020-12-16T19:27:50+00:00
Definition:

This Encounter profile represents the encounter related to the event.

Publisher:HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm)
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-encounter

Contained in the Encounter.participant is the provider in charge of care (represented by the PractitionerRole.Practitioner) and the provider facility (represented by the PractitionerRole.Organization). The location (facility) in which care was provided when the case was triggered is contained in the encounter.location.

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 use code=”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.

Formal Views of Profile Content

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

This structure is derived from Encounter

Summary

Mandatory: 2 elements (3 nested mandatory elements)
Must-Support: 24 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Encounter.participant is sliced based on the value of type:type

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*EncountereICR Encounter
... identifier S0..1IdentifierIdentifier(s) by which this encounter is known
.... system S1..1uriThe namespace for the identifier value
.... value S1..1stringThe value that is unique
... status S1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
... class S1..1CodingClass of encounter
.... data-absent-reason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

... subject S1..1Reference(US Public Health Patient)The patient or group present at the encounter
... participant S0..*(Slice Definition)List of participants involved in the encounter
Slice: Unordered, Open by type:type
.... participant:sliceResponsibleProvider S0..1BackboneElementResponsible provider
..... type S1..*CodeableConceptResponsible provider
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: ATND
..... period S0..1PeriodPeriod of time during the encounter that the participant participated
..... individual 0..1Reference(US Public Health PractitionerRole)Responsible Provider
... period S0..1PeriodPatient encounter start and end times
.... start S0..1dateTimeEncounter start.
.... end S0..1dateTimeEncounter end.
... diagnosis S0..*BackboneElementEncounter diagnosis
.... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... eicr-trigger-code-flag-extension S0..1(Complex)eICR Trigger Code Flag
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-trigger-code-flag-extension
.... condition S1..1Reference(eICR Condition)The diagnosis or procedure relevant to the encounter
.... use S0..1CodeableConceptRole that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
... hospitalization S0..1BackboneElementDetails about the admission to a healthcare service
... location S0..*BackboneElementeICR encounter location
.... location S1..1Reference(US Public Health Location)Location the encounter takes place
... serviceProvider S0..1Reference(US Public Health Organization)The organization (facility) responsible for this encounter

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*EncountereICR Encounter
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..1IdentifierIdentifier(s) by which this encounter is known
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!SΣ1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.

... statusHistory 0..*BackboneElementList of past encounter statuses
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... status 1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.

.... period 1..1PeriodThe time that the episode was in the specified status
... class SΣ1..1CodingClass of encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.

... classHistory 0..*BackboneElementList of past encounter classes
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... class 1..1Codinginpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.

.... period 1..1PeriodThe time that the episode was in the specified class
... type SΣ1..1CodeableConceptType of encounter
Binding: US Core Encounter Type (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... data-absent-reason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Slice: Unordered, Open by value:url
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
... serviceType Σ0..1CodeableConceptSpecific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.

... priority 0..1CodeableConceptIndicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.

... subject SΣ1..1Reference(US Public Health Patient)The patient or group present at the encounter
... 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
... participant SΣ0..*(Slice Definition)List of participants involved in the encounter
Slice: Unordered, Open by type:type
.... participant:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ0..*CodeableConceptRole of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.


..... period 0..1PeriodPeriod of time during the encounter that the participant participated
..... individual Σ0..1Reference(Practitioner | PractitionerRole | RelatedPerson)Persons involved in the encounter other than the patient
.... participant:sliceResponsibleProvider SΣ0..1BackboneElementResponsible provider
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type SΣ1..*CodeableConceptResponsible provider
Binding: ParticipantType (extensible): Role of participant in encounter.



Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: ATND
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... period S0..1PeriodPeriod of time during the encounter that the participant participated
..... individual Σ0..1Reference(US Public Health PractitionerRole)Responsible Provider
... appointment Σ0..*Reference(Appointment)The appointment that scheduled this encounter
... period S0..1PeriodPatient encounter start and end times
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣI0..1dateTimeEncounter start.
.... end SΣI0..1dateTimeEncounter end.
... length 0..1DurationQuantity of time the encounter lasted (less time absent)
... reasonCode Σ0..*CodeableConceptCoded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.


... reasonReference Σ0..*Reference(Condition | Procedure | Observation | ImmunizationRecommendation)Reason the encounter takes place (reference)
... diagnosis SΣ0..*BackboneElementEncounter diagnosis
.... id 0..1stringUnique id for inter-element referencing
.... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... eicr-trigger-code-flag-extension S0..1(Complex)eICR Trigger Code Flag
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-trigger-code-flag-extension
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... condition SΣ1..1Reference(eICR Condition)The diagnosis or procedure relevant to the encounter
.... use S0..1CodeableConceptRole that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.

.... rank 0..1positiveIntRanking 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 S0..1BackboneElementDetails about the admission to a healthcare service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier 0..1IdentifierPre-admission identifier
.... origin 0..1Reference(Location | Organization)The location/organization from which the patient came before admission
.... admitSource 0..1CodeableConceptFrom where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.

.... reAdmission 0..1CodeableConceptThe 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..*CodeableConceptDiet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.


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


.... specialArrangement 0..*CodeableConceptWheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.


.... destination 0..1Reference(Location | Organization)Location/organization to which the patient is discharged
.... dischargeDisposition 0..1CodeableConceptCategory or kind of location after discharge
Binding: DischargeDisposition (example): Discharge Disposition.

... location S0..*BackboneElementeICR encounter location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... location S1..1Reference(US Public Health Location)Location the encounter takes place
.... status 0..1codeplanned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.

.... physicalType 0..1CodeableConceptThe 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..1PeriodTime period during which the patient was present at the location
... serviceProvider S0..1Reference(US Public Health Organization)The organization (facility) responsible for this encounter
... partOf 0..1Reference(Encounter)Another Encounter this encounter is part of

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*EncountereICR Encounter
... identifier Σ0..1IdentifierIdentifier(s) by which this encounter is known
.... system Σ1..1uriThe namespace for the identifier value
.... value Σ1..1stringThe value that is unique
... status ?!Σ1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.

... class Σ1..1CodingClass of encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.

.... data-absent-reason 0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Slice: Unordered, Open by value:url
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


... subject Σ1..1Reference(US Public Health Patient)The patient or group present at the encounter
... participant Σ0..*(Slice Definition)List of participants involved in the encounter
Slice: Unordered, Open by type:type
.... participant:sliceResponsibleProvider Σ0..1BackboneElementResponsible provider
..... type Σ1..*CodeableConceptResponsible provider
Binding: ParticipantType (extensible): Role of participant in encounter.



Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: ATND
..... period 0..1PeriodPeriod of time during the encounter that the participant participated
... period 0..1PeriodPatient encounter start and end times
.... start ΣI0..1dateTimeEncounter start.
.... end ΣI0..1dateTimeEncounter end.
... diagnosis Σ0..*BackboneElementEncounter diagnosis
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... eicr-trigger-code-flag-extension 0..1(Complex)eICR Trigger Code Flag
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-trigger-code-flag-extension
.... condition Σ1..1Reference(eICR Condition)The diagnosis or procedure relevant to the encounter
.... use 0..1CodeableConceptRole that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.

... hospitalization 0..1BackboneElementDetails about the admission to a healthcare service
... location 0..*BackboneElementeICR encounter location
.... location 1..1Reference(US Public Health Location)Location the encounter takes place
... serviceProvider 0..1Reference(US Public Health Organization)The organization (facility) responsible for this encounter

doco Documentation for this format

This structure is derived from Encounter

Summary

Mandatory: 2 elements (3 nested mandatory elements)
Must-Support: 24 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Encounter.participant is sliced based on the value of type:type

Differential View

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*EncountereICR Encounter
... identifier S0..1IdentifierIdentifier(s) by which this encounter is known
.... system S1..1uriThe namespace for the identifier value
.... value S1..1stringThe value that is unique
... status S1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
... class S1..1CodingClass of encounter
.... data-absent-reason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

... subject S1..1Reference(US Public Health Patient)The patient or group present at the encounter
... participant S0..*(Slice Definition)List of participants involved in the encounter
Slice: Unordered, Open by type:type
.... participant:sliceResponsibleProvider S0..1BackboneElementResponsible provider
..... type S1..*CodeableConceptResponsible provider
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: ATND
..... period S0..1PeriodPeriod of time during the encounter that the participant participated
..... individual 0..1Reference(US Public Health PractitionerRole)Responsible Provider
... period S0..1PeriodPatient encounter start and end times
.... start S0..1dateTimeEncounter start.
.... end S0..1dateTimeEncounter end.
... diagnosis S0..*BackboneElementEncounter diagnosis
.... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... eicr-trigger-code-flag-extension S0..1(Complex)eICR Trigger Code Flag
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-trigger-code-flag-extension
.... condition S1..1Reference(eICR Condition)The diagnosis or procedure relevant to the encounter
.... use S0..1CodeableConceptRole that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
... hospitalization S0..1BackboneElementDetails about the admission to a healthcare service
... location S0..*BackboneElementeICR encounter location
.... location S1..1Reference(US Public Health Location)Location the encounter takes place
... serviceProvider S0..1Reference(US Public Health Organization)The organization (facility) responsible for this encounter

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*EncountereICR Encounter
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..1IdentifierIdentifier(s) by which this encounter is known
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!SΣ1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.

... statusHistory 0..*BackboneElementList of past encounter statuses
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... status 1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.

.... period 1..1PeriodThe time that the episode was in the specified status
... class SΣ1..1CodingClass of encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.

... classHistory 0..*BackboneElementList of past encounter classes
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... class 1..1Codinginpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.

.... period 1..1PeriodThe time that the episode was in the specified class
... type SΣ1..1CodeableConceptType of encounter
Binding: US Core Encounter Type (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... data-absent-reason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Slice: Unordered, Open by value:url
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
... serviceType Σ0..1CodeableConceptSpecific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.

... priority 0..1CodeableConceptIndicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.

... subject SΣ1..1Reference(US Public Health Patient)The patient or group present at the encounter
... 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
... participant SΣ0..*(Slice Definition)List of participants involved in the encounter
Slice: Unordered, Open by type:type
.... participant:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ0..*CodeableConceptRole of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.


..... period 0..1PeriodPeriod of time during the encounter that the participant participated
..... individual Σ0..1Reference(Practitioner | PractitionerRole | RelatedPerson)Persons involved in the encounter other than the patient
.... participant:sliceResponsibleProvider SΣ0..1BackboneElementResponsible provider
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type SΣ1..*CodeableConceptResponsible provider
Binding: ParticipantType (extensible): Role of participant in encounter.



Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: ATND
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... period S0..1PeriodPeriod of time during the encounter that the participant participated
..... individual Σ0..1Reference(US Public Health PractitionerRole)Responsible Provider
... appointment Σ0..*Reference(Appointment)The appointment that scheduled this encounter
... period S0..1PeriodPatient encounter start and end times
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣI0..1dateTimeEncounter start.
.... end SΣI0..1dateTimeEncounter end.
... length 0..1DurationQuantity of time the encounter lasted (less time absent)
... reasonCode Σ0..*CodeableConceptCoded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.


... reasonReference Σ0..*Reference(Condition | Procedure | Observation | ImmunizationRecommendation)Reason the encounter takes place (reference)
... diagnosis SΣ0..*BackboneElementEncounter diagnosis
.... id 0..1stringUnique id for inter-element referencing
.... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... eicr-trigger-code-flag-extension S0..1(Complex)eICR Trigger Code Flag
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-trigger-code-flag-extension
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... condition SΣ1..1Reference(eICR Condition)The diagnosis or procedure relevant to the encounter
.... use S0..1CodeableConceptRole that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.

.... rank 0..1positiveIntRanking 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 S0..1BackboneElementDetails about the admission to a healthcare service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier 0..1IdentifierPre-admission identifier
.... origin 0..1Reference(Location | Organization)The location/organization from which the patient came before admission
.... admitSource 0..1CodeableConceptFrom where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.

.... reAdmission 0..1CodeableConceptThe 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..*CodeableConceptDiet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.


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


.... specialArrangement 0..*CodeableConceptWheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.


.... destination 0..1Reference(Location | Organization)Location/organization to which the patient is discharged
.... dischargeDisposition 0..1CodeableConceptCategory or kind of location after discharge
Binding: DischargeDisposition (example): Discharge Disposition.

... location S0..*BackboneElementeICR encounter location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... location S1..1Reference(US Public Health Location)Location the encounter takes place
.... status 0..1codeplanned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.

.... physicalType 0..1CodeableConceptThe 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..1PeriodTime period during which the patient was present at the location
... serviceProvider S0..1Reference(US Public Health Organization)The organization (facility) responsible for this encounter
... partOf 0..1Reference(Encounter)Another Encounter this encounter is part of

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
Encounter.languagepreferredCommonLanguages
Max Binding: AllLanguages
Encounter.identifier.userequiredIdentifierUse
Encounter.identifier.typeextensibleIdentifier Type Codes
Encounter.statusrequiredEncounterStatus
Encounter.statusHistory.statusrequiredEncounterStatus
Encounter.classextensibleActEncounterCode
Encounter.classHistory.classextensibleActEncounterCode
Encounter.typeextensibleUSCoreEncounterType
Encounter.serviceTypeexampleServiceType
Encounter.priorityexampleActPriority
Encounter.participant.typeextensibleParticipantType
Encounter.participant:sliceResponsibleProvider.typeextensiblePattern: ATND
Encounter.reasonCodepreferredEncounterReasonCodes
Encounter.diagnosis.usepreferredDiagnosisRole
Encounter.hospitalization.admitSourcepreferredAdmitSource
Encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
Encounter.hospitalization.dietPreferenceexampleDiet
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
Encounter.hospitalization.dischargeDispositionexampleDischargeDisposition
Encounter.location.statusrequiredEncounterLocationStatus
Encounter.location.physicalTypeexampleLocationType

Constraints

IdPathDetailsRequirements
dom-2EncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3EncounterIf 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-4EncounterIf 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-5EncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6EncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1Encounter.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Encounter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Encounter.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Encounter.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Encounter.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.identifier.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Encounter.identifier.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Encounter.identifier.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.identifier.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.identifier.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.identifier.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.identifier.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.identifier.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.statusHistoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.statusHistory.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Encounter.statusHistory.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Encounter.statusHistory.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Encounter.statusHistory.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Encounter.statusHistory.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.statusHistory.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.classAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.classHistoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.classHistory.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Encounter.classHistory.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Encounter.classHistory.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Encounter.classHistory.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Encounter.classHistory.classAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.classHistory.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.type.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Encounter.type.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Encounter.type.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.type.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.serviceTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.priorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.episodeOfCareAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.basedOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.participantAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.participant.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Encounter.participant.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Encounter.participant.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Encounter.participant.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Encounter.participant.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.participant.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.participant.individualAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.participant:sliceResponsibleProviderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.participant:sliceResponsibleProvider.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Encounter.participant:sliceResponsibleProvider.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Encounter.participant:sliceResponsibleProvider.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Encounter.participant:sliceResponsibleProvider.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Encounter.participant:sliceResponsibleProvider.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.participant:sliceResponsibleProvider.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.participant:sliceResponsibleProvider.individualAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.appointmentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.period.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Encounter.period.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Encounter.period.startAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.period.endAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.lengthAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.reasonCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.reasonReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.diagnosisAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.diagnosis.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Encounter.diagnosis.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Encounter.diagnosis.extension:sliceEncounterDiagnosisTriggerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Encounter.diagnosis.extension:sliceEncounterDiagnosisTriggerMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Encounter.diagnosis.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Encounter.diagnosis.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Encounter.diagnosis.conditionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.diagnosis.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.diagnosis.rankAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.accountAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.hospitalizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.hospitalization.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Encounter.hospitalization.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Encounter.hospitalization.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Encounter.hospitalization.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Encounter.hospitalization.preAdmissionIdentifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.hospitalization.originAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.hospitalization.admitSourceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.hospitalization.reAdmissionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.hospitalization.dietPreferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.hospitalization.specialCourtesyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.hospitalization.specialArrangementAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.hospitalization.destinationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.hospitalization.dischargeDispositionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.locationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.location.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Encounter.location.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Encounter.location.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Encounter.location.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Encounter.location.locationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.location.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.location.physicalTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.location.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.serviceProviderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Encounter.partOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())