Polaris FHIR Implementation Guide
1.10.0 - ci-build

Polaris FHIR Implementation Guide - Local Development build (v1.10.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Polaris Encounter Profile Core

Official URL: https://fhir.apps.health/StructureDefinition/polaris-core-encounter Version: 1.10.0
Draft as of 2026-05-26 Computable Name: PolarisCoreEncounter

Defines the Encounter resource constraints for the Polaris project (CII), conforming to CA-Core+ requirements.

Polaris Core Encounter Profile

Overview

The Polaris Core Encounter profile represents a synthesized view of patient interactions in primary care EMR systems. Unlike hospital settings where encounters have clear admission/discharge boundaries, primary care "encounters" are typically artificial constructs assembled from various clinical activities that occurred on the same day.

Primary Care Reality

What Primary Care EMRs Actually Have

Primary care EMRs don't model discrete encounters the way FHIR expects. Instead, they organize clinical data around:

  • SOAP notes: Multiple notes per day for different issues, loosely timestamped
  • Appointment slots: Which may not match when the patient was actually seen (or may not exist for walk-ins)
  • Daily activity sheets: Everything that happened on a given day
  • Billing codes: The only reliably structured element with accurate timestamps
  • Scattered documents: Prescriptions, referrals, forms, lab reviews - all loosely associated with "today"

The Synthetic Encounter

In Polaris, Encounter resources are synthesized within the MedPlum repository by a specialized bot that heuristically groups all encounter-related records created on the same day. This allows Polaris to send hospital-style "Encounter" records to secondary use systems that expect them, even though primary care EMRs don't naturally organize data this way.

Key Differences from Hospital Care

Temporal Dynamics:

  • Primary care thinks in weeks to months ("see me in 3 months")
  • Patients are in the office for 15-30 minutes, not days
  • No bed management or real-time coordination needs
  • Activities span the entire day, not confined to visit times

Documentation Patterns:

  • Multiple unrelated issues in one visit
  • Phone calls and refills between patients
  • Forms completed after hours
  • Lab reviews during lunch

Economic Drivers:

  • Fee-for-service or capitation models
  • Billing drives the only reliable structure
  • Empty rooms are lost opportunity, not ongoing cost

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter C 0..* Encounter Polaris Encounter Core
Constraints: encounter-has-polaris-id
... meta Σ 0..1 Meta Metadata about the resource
.... source SΣ 0..1 uri Identifies EMR instance & pipeline version the resource came from
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text S 0..1 Narrative Narrative
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... Slices for identifier SΣ 1..* Identifier Business identifier(s) for encounter
Slice: Unordered, Open by pattern:system
.... identifier:polarisId SΣ 1..1 Identifier Polaris Encounter ID
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
..... system Σ 1..1 uri Polaris encounter identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-encounter-identifier
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The actual Polaris encounter ID value: unique in source system
Example General: 123456
.... identifier:rawCode SΣ 0..* Identifier Source EMR encounter identifier
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: secondary
..... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-raw-code
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!SΣ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled
Binding: EncounterStatus (required)
... class SΣ 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (required)
... type SΣ 0..* CodeableConcept Encounter type with raw code support
Binding: EncounterType (example): The type of encounter.
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard SΣ 0..* Coding Standard encounter type code
...... system Σ 1..1 uri Standard terminology system URI
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:rawCode SΣ 0..* Coding Source EMR encounter type code
...... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-type-raw-code
...... code Σ 1..1 code EMR-specific encounter type code
...... display Σ 1..1 string EMR's display text for this type
... serviceType SΣ 0..1 CodeableConcept Service type with raw code support
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard SΣ 0..* Coding Standard service type code
...... system Σ 1..1 uri Standard terminology system URI
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:rawCode SΣ 0..* Coding Source EMR service type code
...... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-servicetype-raw-code
...... code Σ 1..1 code EMR-specific service type code
...... display Σ 1..1 string EMR's display text for this service type
... subject SΣ 1..1 Reference(Polaris Patient Core) The patient present at the encounter
... participant SΣ 0..* BackboneElement List of participants involved in the encounter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
.... period S 0..1 Period Period of participation
.... individual SΣ 0..1 Reference(Polaris PractitionerRole Core) Persons involved in the encounter
... period S 1..1 Period The start and end time of the encounter
.... start SΣC 1..1 dateTime When the encounter started
.... end SΣC 0..1 dateTime When the encounter ended (if finished)
... reasonCode SΣ 0..* CodeableConcept Encounter reason with raw code support
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard SΣ 0..* Coding Standard reason code
...... system Σ 1..1 uri Standard terminology system URI
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:rawCode SΣ 0..* Coding Source EMR reason code
...... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-reasoncode-raw-code
...... code Σ 1..1 code EMR-specific reason code
...... display Σ 1..1 string EMR's display text for this reason
... diagnosis SΣ 0..* BackboneElement The list of diagnoses relevant to this encounter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition SΣ 1..1 Reference(Polaris Condition Core) The diagnosis or condition relevant to the encounter
.... use S 0..1 CodeableConcept Role of diagnosis in encounter (e.g., admission, billing, discharge)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
.... rank S 0..1 positiveInt Ranking of the diagnosis (primary, secondary, etc.)
... location S 0..* BackboneElement List of locations where the encounter occurred
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location S 1..1 Reference(Polaris Location Core) Location the encounter takes place
.... status S 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
.... period S 0..1 Period Time period during which the patient was at location
... serviceProvider S 0..1 Reference(Polaris Organization Core) The organization providing the service
.... identifier SΣ 0..1 Identifier Polaris organization identifier reference

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.identifier:polarisId.userequiredPattern Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Encounter.identifier:rawCode.userequiredPattern Value: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status
From the FHIR Standard
Encounter.classrequiredActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typeexampleEncounterType
http://hl7.org/fhir/ValueSet/encounter-type
From the FHIR Standard
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
From the FHIR Standard
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
From the FHIR Standard
Encounter.diagnosis.usepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
From the FHIR Standard
Encounter.location.statusrequiredEncounterLocationStatus
http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
encounter-has-polaris-iderrorEncounterMust have at least one identifier with a canonical Polaris system URI
: identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-encounter-identifier$'))
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter C 0..* Encounter Polaris Encounter Core
Constraints: encounter-has-polaris-id
... meta
.... source S 0..1 uri Identifies EMR instance & pipeline version the resource came from
... text S 0..1 Narrative Narrative
... Slices for identifier S 1..* Identifier Business identifier(s) for encounter
Slice: Unordered, Open by pattern:system
.... identifier:polarisId S 1..1 Identifier Polaris Encounter ID
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... system 1..1 uri Polaris encounter identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-encounter-identifier
..... value 1..1 string The actual Polaris encounter ID value: unique in source system
.... identifier:rawCode S 0..* Identifier Source EMR encounter identifier
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: secondary
..... system 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-raw-code
..... value 1..1 string The value that is unique
... class S 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (required)
... type S 0..* CodeableConcept Encounter type with raw code support
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard S 0..* Coding Standard encounter type code
...... system 1..1 uri Standard terminology system URI
...... code 1..1 code Symbol in syntax defined by the system
..... coding:rawCode S 0..* Coding Source EMR encounter type code
...... system 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-type-raw-code
...... code 1..1 code EMR-specific encounter type code
...... display 1..1 string EMR's display text for this type
... serviceType S 0..1 CodeableConcept Service type with raw code support
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard S 0..* Coding Standard service type code
...... system 1..1 uri Standard terminology system URI
...... code 1..1 code Symbol in syntax defined by the system
..... coding:rawCode S 0..* Coding Source EMR service type code
...... system 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-servicetype-raw-code
...... code 1..1 code EMR-specific service type code
...... display 1..1 string EMR's display text for this service type
... subject S 1..1 Reference(Polaris Patient Core) The patient present at the encounter
... participant S 0..* BackboneElement List of participants involved in the encounter
.... type S 0..* CodeableConcept Role of participant in encounter
.... period S 0..1 Period Period of participation
.... individual S 0..1 Reference(Polaris PractitionerRole Core) Persons involved in the encounter
... period S 1..1 Period The start and end time of the encounter
.... start S 1..1 dateTime When the encounter started
.... end S 0..1 dateTime When the encounter ended (if finished)
... reasonCode S 0..* CodeableConcept Encounter reason with raw code support
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard S 0..* Coding Standard reason code
...... system 1..1 uri Standard terminology system URI
...... code 1..1 code Symbol in syntax defined by the system
..... coding:rawCode S 0..* Coding Source EMR reason code
...... system 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-reasoncode-raw-code
...... code 1..1 code EMR-specific reason code
...... display 1..1 string EMR's display text for this reason
... diagnosis S 0..* BackboneElement The list of diagnoses relevant to this encounter
.... condition S 1..1 Reference(Polaris Condition Core) The diagnosis or condition relevant to the encounter
.... use S 0..1 CodeableConcept Role of diagnosis in encounter (e.g., admission, billing, discharge)
.... rank S 0..1 positiveInt Ranking of the diagnosis (primary, secondary, etc.)
... location S 0..* BackboneElement List of locations where the encounter occurred
.... location S 1..1 Reference(Polaris Location Core) Location the encounter takes place
.... status S 0..1 code planned | active | reserved | completed
.... period S 0..1 Period Time period during which the patient was at location
... serviceProvider S 0..1 Reference(Polaris Organization Core) The organization providing the service
.... identifier S 0..1 Identifier Polaris organization identifier reference

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status
From the FHIR Standard
Encounter.classrequiredActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode

Constraints

IdGradePath(s)DetailsRequirements
encounter-has-polaris-iderrorEncounterMust have at least one identifier with a canonical Polaris system URI
: identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-encounter-identifier$'))
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter C 0..* Encounter Polaris Encounter Core
Constraints: encounter-has-polaris-id
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source SΣ 0..1 uri Identifies EMR instance & pipeline version the resource came from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text S 0..1 Narrative Narrative
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier Business identifier(s) for encounter
Slice: Unordered, Open by pattern:system
.... identifier:polarisId SΣ 1..1 Identifier Polaris Encounter ID
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri Polaris encounter identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-encounter-identifier
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The actual Polaris encounter ID value: unique in source system
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:rawCode SΣ 0..* Identifier Source EMR encounter identifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: secondary
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-raw-code
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled
Binding: EncounterStatus (required)
... statusHistory 0..* BackboneElement List of past encounter statuses
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
.... period 1..1 Period The time that the episode was in the specified status
... class SΣ 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (required)
... classHistory 0..* BackboneElement List of past encounter classes
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.
.... period 1..1 Period The time that the episode was in the specified class
... type SΣ 0..* CodeableConcept Encounter type with raw code support
Binding: EncounterType (example): The type of encounter.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard SΣ 0..* Coding Standard encounter type code
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Standard terminology system URI
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:rawCode SΣ 0..* Coding Source EMR encounter type code
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-type-raw-code
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code EMR-specific encounter type code
...... display Σ 1..1 string EMR's display text for this type
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... serviceType SΣ 0..1 CodeableConcept Service type with raw code support
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard SΣ 0..* Coding Standard service type code
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Standard terminology system URI
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:rawCode SΣ 0..* Coding Source EMR service type code
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-servicetype-raw-code
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code EMR-specific service type code
...... display Σ 1..1 string EMR's display text for this service type
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.
... subject SΣ 1..1 Reference(Polaris Patient Core) The patient 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..* BackboneElement List of participants involved in the encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
.... period S 0..1 Period Period of participation
.... individual SΣ 0..1 Reference(Polaris PractitionerRole Core) Persons involved in the encounter
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
... period S 1..1 Period The start and end time of the encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC 1..1 dateTime When the encounter started
.... end SΣC 0..1 dateTime When the encounter ended (if finished)
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... reasonCode SΣ 0..* CodeableConcept Encounter reason with raw code support
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard SΣ 0..* Coding Standard reason code
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Standard terminology system URI
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:rawCode SΣ 0..* Coding Source EMR reason code
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-reasoncode-raw-code
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code EMR-specific reason code
...... display Σ 1..1 string EMR's display text for this reason
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... reasonReference Σ 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis SΣ 0..* BackboneElement The list of diagnoses relevant to this encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition SΣ 1..1 Reference(Polaris Condition Core) The diagnosis or condition relevant to the encounter
.... use S 0..1 CodeableConcept Role of diagnosis in encounter (e.g., admission, billing, discharge)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
.... rank S 0..1 positiveInt Ranking of the diagnosis (primary, secondary, etc.)
... account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
... hospitalization 0..1 BackboneElement Details about the admission to a healthcare service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
.... admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.
.... reAdmission 0..1 CodeableConcept The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
.... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
.... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
.... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.
.... destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
.... dischargeDisposition 0..1 CodeableConcept Category or kind of location after discharge
Binding: DischargeDisposition (example): Discharge Disposition.
... location S 0..* BackboneElement List of locations where the encounter occurred
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location S 1..1 Reference(Polaris Location Core) Location the encounter takes place
.... status S 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
.... physicalType 0..1 CodeableConcept The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example): Physical form of the location.
.... period S 0..1 Period Time period during which the patient was at location
... serviceProvider S 0..1 Reference(Polaris Organization Core) The organization providing the service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier SΣ 0..1 Identifier Polaris organization identifier reference
.... display Σ 0..1 string Text alternative for the resource
... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Encounter.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
Encounter.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Encounter.identifier:polarisId.userequiredPattern Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Encounter.identifier:polarisId.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Encounter.identifier:rawCode.userequiredPattern Value: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Encounter.identifier:rawCode.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status
From the FHIR Standard
Encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
From the FHIR Standard
Encounter.classrequiredActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typeexampleEncounterType
http://hl7.org/fhir/ValueSet/encounter-type
From the FHIR Standard
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
From the FHIR Standard
Encounter.priorityexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
From the FHIR Standard
Encounter.diagnosis.usepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
From the FHIR Standard
Encounter.hospitalization.admitSourcepreferredAdmitSource
http://hl7.org/fhir/ValueSet/encounter-admit-source
From the FHIR Standard
Encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreferenceexampleDiet
http://hl7.org/fhir/ValueSet/encounter-diet
From the FHIR Standard
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
http://hl7.org/fhir/ValueSet/encounter-special-courtesy
From the FHIR Standard
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
http://hl7.org/fhir/ValueSet/encounter-special-arrangements
From the FHIR Standard
Encounter.hospitalization.dischargeDispositionexampleDischargeDisposition
http://hl7.org/fhir/ValueSet/encounter-discharge-disposition
From the FHIR Standard
Encounter.location.statusrequiredEncounterLocationStatus
http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1
From the FHIR Standard
Encounter.location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
From the FHIR Standard
Encounter.serviceProvider.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
encounter-has-polaris-iderrorEncounterMust have at least one identifier with a canonical Polaris system URI
: identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-encounter-identifier$'))
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Encounter

Summary

Mandatory: 7 elements(17 nested mandatory elements)
Must-Support: 34 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Encounter.identifier
  • The element 1 is sliced based on the value of Encounter.type.coding
  • The element 1 is sliced based on the value of Encounter.serviceType.coding
  • The element 1 is sliced based on the value of Encounter.reasonCode.coding

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter C 0..* Encounter Polaris Encounter Core
Constraints: encounter-has-polaris-id
... meta Σ 0..1 Meta Metadata about the resource
.... source SΣ 0..1 uri Identifies EMR instance & pipeline version the resource came from
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text S 0..1 Narrative Narrative
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... Slices for identifier SΣ 1..* Identifier Business identifier(s) for encounter
Slice: Unordered, Open by pattern:system
.... identifier:polarisId SΣ 1..1 Identifier Polaris Encounter ID
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
..... system Σ 1..1 uri Polaris encounter identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-encounter-identifier
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The actual Polaris encounter ID value: unique in source system
Example General: 123456
.... identifier:rawCode SΣ 0..* Identifier Source EMR encounter identifier
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: secondary
..... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-raw-code
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!SΣ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled
Binding: EncounterStatus (required)
... class SΣ 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (required)
... type SΣ 0..* CodeableConcept Encounter type with raw code support
Binding: EncounterType (example): The type of encounter.
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard SΣ 0..* Coding Standard encounter type code
...... system Σ 1..1 uri Standard terminology system URI
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:rawCode SΣ 0..* Coding Source EMR encounter type code
...... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-type-raw-code
...... code Σ 1..1 code EMR-specific encounter type code
...... display Σ 1..1 string EMR's display text for this type
... serviceType SΣ 0..1 CodeableConcept Service type with raw code support
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard SΣ 0..* Coding Standard service type code
...... system Σ 1..1 uri Standard terminology system URI
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:rawCode SΣ 0..* Coding Source EMR service type code
...... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-servicetype-raw-code
...... code Σ 1..1 code EMR-specific service type code
...... display Σ 1..1 string EMR's display text for this service type
... subject SΣ 1..1 Reference(Polaris Patient Core) The patient present at the encounter
... participant SΣ 0..* BackboneElement List of participants involved in the encounter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
.... period S 0..1 Period Period of participation
.... individual SΣ 0..1 Reference(Polaris PractitionerRole Core) Persons involved in the encounter
... period S 1..1 Period The start and end time of the encounter
.... start SΣC 1..1 dateTime When the encounter started
.... end SΣC 0..1 dateTime When the encounter ended (if finished)
... reasonCode SΣ 0..* CodeableConcept Encounter reason with raw code support
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard SΣ 0..* Coding Standard reason code
...... system Σ 1..1 uri Standard terminology system URI
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:rawCode SΣ 0..* Coding Source EMR reason code
...... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-reasoncode-raw-code
...... code Σ 1..1 code EMR-specific reason code
...... display Σ 1..1 string EMR's display text for this reason
... diagnosis SΣ 0..* BackboneElement The list of diagnoses relevant to this encounter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition SΣ 1..1 Reference(Polaris Condition Core) The diagnosis or condition relevant to the encounter
.... use S 0..1 CodeableConcept Role of diagnosis in encounter (e.g., admission, billing, discharge)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
.... rank S 0..1 positiveInt Ranking of the diagnosis (primary, secondary, etc.)
... location S 0..* BackboneElement List of locations where the encounter occurred
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location S 1..1 Reference(Polaris Location Core) Location the encounter takes place
.... status S 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
.... period S 0..1 Period Time period during which the patient was at location
... serviceProvider S 0..1 Reference(Polaris Organization Core) The organization providing the service
.... identifier SΣ 0..1 Identifier Polaris organization identifier reference

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.identifier:polarisId.userequiredPattern Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Encounter.identifier:rawCode.userequiredPattern Value: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status
From the FHIR Standard
Encounter.classrequiredActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typeexampleEncounterType
http://hl7.org/fhir/ValueSet/encounter-type
From the FHIR Standard
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
From the FHIR Standard
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
From the FHIR Standard
Encounter.diagnosis.usepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
From the FHIR Standard
Encounter.location.statusrequiredEncounterLocationStatus
http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
encounter-has-polaris-iderrorEncounterMust have at least one identifier with a canonical Polaris system URI
: identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-encounter-identifier$'))
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter C 0..* Encounter Polaris Encounter Core
Constraints: encounter-has-polaris-id
... meta
.... source S 0..1 uri Identifies EMR instance & pipeline version the resource came from
... text S 0..1 Narrative Narrative
... Slices for identifier S 1..* Identifier Business identifier(s) for encounter
Slice: Unordered, Open by pattern:system
.... identifier:polarisId S 1..1 Identifier Polaris Encounter ID
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... system 1..1 uri Polaris encounter identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-encounter-identifier
..... value 1..1 string The actual Polaris encounter ID value: unique in source system
.... identifier:rawCode S 0..* Identifier Source EMR encounter identifier
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: secondary
..... system 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-raw-code
..... value 1..1 string The value that is unique
... class S 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (required)
... type S 0..* CodeableConcept Encounter type with raw code support
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard S 0..* Coding Standard encounter type code
...... system 1..1 uri Standard terminology system URI
...... code 1..1 code Symbol in syntax defined by the system
..... coding:rawCode S 0..* Coding Source EMR encounter type code
...... system 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-type-raw-code
...... code 1..1 code EMR-specific encounter type code
...... display 1..1 string EMR's display text for this type
... serviceType S 0..1 CodeableConcept Service type with raw code support
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard S 0..* Coding Standard service type code
...... system 1..1 uri Standard terminology system URI
...... code 1..1 code Symbol in syntax defined by the system
..... coding:rawCode S 0..* Coding Source EMR service type code
...... system 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-servicetype-raw-code
...... code 1..1 code EMR-specific service type code
...... display 1..1 string EMR's display text for this service type
... subject S 1..1 Reference(Polaris Patient Core) The patient present at the encounter
... participant S 0..* BackboneElement List of participants involved in the encounter
.... type S 0..* CodeableConcept Role of participant in encounter
.... period S 0..1 Period Period of participation
.... individual S 0..1 Reference(Polaris PractitionerRole Core) Persons involved in the encounter
... period S 1..1 Period The start and end time of the encounter
.... start S 1..1 dateTime When the encounter started
.... end S 0..1 dateTime When the encounter ended (if finished)
... reasonCode S 0..* CodeableConcept Encounter reason with raw code support
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard S 0..* Coding Standard reason code
...... system 1..1 uri Standard terminology system URI
...... code 1..1 code Symbol in syntax defined by the system
..... coding:rawCode S 0..* Coding Source EMR reason code
...... system 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-reasoncode-raw-code
...... code 1..1 code EMR-specific reason code
...... display 1..1 string EMR's display text for this reason
... diagnosis S 0..* BackboneElement The list of diagnoses relevant to this encounter
.... condition S 1..1 Reference(Polaris Condition Core) The diagnosis or condition relevant to the encounter
.... use S 0..1 CodeableConcept Role of diagnosis in encounter (e.g., admission, billing, discharge)
.... rank S 0..1 positiveInt Ranking of the diagnosis (primary, secondary, etc.)
... location S 0..* BackboneElement List of locations where the encounter occurred
.... location S 1..1 Reference(Polaris Location Core) Location the encounter takes place
.... status S 0..1 code planned | active | reserved | completed
.... period S 0..1 Period Time period during which the patient was at location
... serviceProvider S 0..1 Reference(Polaris Organization Core) The organization providing the service
.... identifier S 0..1 Identifier Polaris organization identifier reference

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status
From the FHIR Standard
Encounter.classrequiredActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode

Constraints

IdGradePath(s)DetailsRequirements
encounter-has-polaris-iderrorEncounterMust have at least one identifier with a canonical Polaris system URI
: identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-encounter-identifier$'))

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter C 0..* Encounter Polaris Encounter Core
Constraints: encounter-has-polaris-id
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source SΣ 0..1 uri Identifies EMR instance & pipeline version the resource came from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text S 0..1 Narrative Narrative
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier Business identifier(s) for encounter
Slice: Unordered, Open by pattern:system
.... identifier:polarisId SΣ 1..1 Identifier Polaris Encounter ID
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri Polaris encounter identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-encounter-identifier
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The actual Polaris encounter ID value: unique in source system
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:rawCode SΣ 0..* Identifier Source EMR encounter identifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: secondary
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-raw-code
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled
Binding: EncounterStatus (required)
... statusHistory 0..* BackboneElement List of past encounter statuses
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
.... period 1..1 Period The time that the episode was in the specified status
... class SΣ 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (required)
... classHistory 0..* BackboneElement List of past encounter classes
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.
.... period 1..1 Period The time that the episode was in the specified class
... type SΣ 0..* CodeableConcept Encounter type with raw code support
Binding: EncounterType (example): The type of encounter.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard SΣ 0..* Coding Standard encounter type code
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Standard terminology system URI
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:rawCode SΣ 0..* Coding Source EMR encounter type code
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-type-raw-code
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code EMR-specific encounter type code
...... display Σ 1..1 string EMR's display text for this type
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... serviceType SΣ 0..1 CodeableConcept Service type with raw code support
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard SΣ 0..* Coding Standard service type code
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Standard terminology system URI
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:rawCode SΣ 0..* Coding Source EMR service type code
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-servicetype-raw-code
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code EMR-specific service type code
...... display Σ 1..1 string EMR's display text for this service type
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.
... subject SΣ 1..1 Reference(Polaris Patient Core) The patient 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..* BackboneElement List of participants involved in the encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
.... period S 0..1 Period Period of participation
.... individual SΣ 0..1 Reference(Polaris PractitionerRole Core) Persons involved in the encounter
... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
... period S 1..1 Period The start and end time of the encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC 1..1 dateTime When the encounter started
.... end SΣC 0..1 dateTime When the encounter ended (if finished)
... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
... reasonCode SΣ 0..* CodeableConcept Encounter reason with raw code support
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard SΣ 0..* Coding Standard reason code
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Standard terminology system URI
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:rawCode SΣ 0..* Coding Source EMR reason code
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-reasoncode-raw-code
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code EMR-specific reason code
...... display Σ 1..1 string EMR's display text for this reason
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... reasonReference Σ 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
... diagnosis SΣ 0..* BackboneElement The list of diagnoses relevant to this encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition SΣ 1..1 Reference(Polaris Condition Core) The diagnosis or condition relevant to the encounter
.... use S 0..1 CodeableConcept Role of diagnosis in encounter (e.g., admission, billing, discharge)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
.... rank S 0..1 positiveInt Ranking of the diagnosis (primary, secondary, etc.)
... account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
... hospitalization 0..1 BackboneElement Details about the admission to a healthcare service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
.... origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
.... admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.
.... reAdmission 0..1 CodeableConcept The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
.... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
.... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
.... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.
.... destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
.... dischargeDisposition 0..1 CodeableConcept Category or kind of location after discharge
Binding: DischargeDisposition (example): Discharge Disposition.
... location S 0..* BackboneElement List of locations where the encounter occurred
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location S 1..1 Reference(Polaris Location Core) Location the encounter takes place
.... status S 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
.... physicalType 0..1 CodeableConcept The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example): Physical form of the location.
.... period S 0..1 Period Time period during which the patient was at location
... serviceProvider S 0..1 Reference(Polaris Organization Core) The organization providing the service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier SΣ 0..1 Identifier Polaris organization identifier reference
.... display Σ 0..1 string Text alternative for the resource
... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Encounter.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
Encounter.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Encounter.identifier:polarisId.userequiredPattern Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Encounter.identifier:polarisId.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Encounter.identifier:rawCode.userequiredPattern Value: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Encounter.identifier:rawCode.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status
From the FHIR Standard
Encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
From the FHIR Standard
Encounter.classrequiredActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typeexampleEncounterType
http://hl7.org/fhir/ValueSet/encounter-type
From the FHIR Standard
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
From the FHIR Standard
Encounter.priorityexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
From the FHIR Standard
Encounter.diagnosis.usepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
From the FHIR Standard
Encounter.hospitalization.admitSourcepreferredAdmitSource
http://hl7.org/fhir/ValueSet/encounter-admit-source
From the FHIR Standard
Encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreferenceexampleDiet
http://hl7.org/fhir/ValueSet/encounter-diet
From the FHIR Standard
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
http://hl7.org/fhir/ValueSet/encounter-special-courtesy
From the FHIR Standard
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
http://hl7.org/fhir/ValueSet/encounter-special-arrangements
From the FHIR Standard
Encounter.hospitalization.dischargeDispositionexampleDischargeDisposition
http://hl7.org/fhir/ValueSet/encounter-discharge-disposition
From the FHIR Standard
Encounter.location.statusrequiredEncounterLocationStatus
http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1
From the FHIR Standard
Encounter.location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
From the FHIR Standard
Encounter.serviceProvider.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
encounter-has-polaris-iderrorEncounterMust have at least one identifier with a canonical Polaris system URI
: identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-encounter-identifier$'))
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Encounter

Summary

Mandatory: 7 elements(17 nested mandatory elements)
Must-Support: 34 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Encounter.identifier
  • The element 1 is sliced based on the value of Encounter.type.coding
  • The element 1 is sliced based on the value of Encounter.serviceType.coding
  • The element 1 is sliced based on the value of Encounter.reasonCode.coding

 

Other representations of profile: CSV, Excel, Schematron