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
| 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.
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 EMRs don't model discrete encounters the way FHIR expects. Instead, they organize clinical data around:
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.
Temporal Dynamics:
Documentation Patterns:
Economic Drivers:
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Encounter | Polaris Encounter Core Constraints: encounter-has-polaris-id |
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
SΣ | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
S | 0..1 | Narrative | Narrative This profile does not constrain the narrative in regard to content, language, or traceability to data elements |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..* | Identifier | Business identifier(s) for encounter Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Polaris Encounter ID |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Polaris encounter identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-encounter-identifier Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The actual Polaris encounter ID value: unique in source system Example General: 123456 |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Source EMR encounter identifier |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() |
?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled Binding: EncounterStatus (required) |
![]() ![]() |
SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (required) |
![]() ![]() |
SΣ | 0..* | CodeableConcept | Encounter type with raw code support Binding: EncounterType (example): The type of encounter. |
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Standard encounter type code |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Standard terminology system URI |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Source EMR encounter type code |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-type-raw-code |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | EMR-specific encounter type code |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | EMR's display text for this type |
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Service type with raw code support Binding: ServiceType (example): Broad categorization of the service that is to be provided. |
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Standard service type code |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Standard terminology system URI |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Source EMR service type code |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-servicetype-raw-code |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | EMR-specific service type code |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | EMR's display text for this service type |
![]() ![]() |
SΣ | 1..1 | Reference(Polaris Patient Core) | The patient present at the encounter |
![]() ![]() |
SΣ | 0..* | BackboneElement | List of participants involved in the encounter |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. |
![]() ![]() ![]() |
S | 0..1 | Period | Period of participation |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(Polaris PractitionerRole Core) | Persons involved in the encounter |
![]() ![]() |
S | 1..1 | Period | The start and end time of the encounter |
![]() ![]() ![]() |
SΣC | 1..1 | dateTime | When the encounter started |
![]() ![]() ![]() |
SΣC | 0..1 | dateTime | When the encounter ended (if finished) |
![]() ![]() |
SΣ | 0..* | CodeableConcept | Encounter reason with raw code support Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Standard reason code |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Standard terminology system URI |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Source EMR reason code |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-reasoncode-raw-code |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | EMR-specific reason code |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | EMR's display text for this reason |
![]() ![]() |
SΣ | 0..* | BackboneElement | The list of diagnoses relevant to this encounter |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Polaris Condition Core) | The diagnosis or condition relevant to the encounter |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Role of diagnosis in encounter (e.g., admission, billing, discharge) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. |
![]() ![]() ![]() |
S | 0..1 | positiveInt | Ranking of the diagnosis (primary, secondary, etc.) |
![]() ![]() |
S | 0..* | BackboneElement | List of locations where the encounter occurred |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 1..1 | Reference(Polaris Location Core) | Location the encounter takes place |
![]() ![]() ![]() |
S | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. |
![]() ![]() ![]() |
S | 0..1 | Period | Time period during which the patient was at location |
![]() ![]() |
S | 0..1 | Reference(Polaris Organization Core) | The organization providing the service |
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Polaris organization identifier reference |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Encounter.identifier:polarisId.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Encounter.identifier:rawCode.use | required | Pattern Value: secondaryhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-statusFrom the FHIR Standard | |
| Encounter.class | required | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
| Encounter.type | example | EncounterTypehttp://hl7.org/fhir/ValueSet/encounter-typeFrom the FHIR Standard | |
| Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-typeFrom the FHIR Standard | |
| Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typeFrom the FHIR Standard | |
| Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonFrom the FHIR Standard | |
| Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-roleFrom the FHIR Standard | |
| Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| encounter-has-polaris-id | error | Encounter | Must 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-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Encounter
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Encounter | Polaris Encounter Core Constraints: encounter-has-polaris-id |
![]() ![]() |
||||
![]() ![]() ![]() |
S | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from |
![]() ![]() |
S | 0..1 | Narrative | Narrative |
![]() ![]() |
S | 1..* | Identifier | Business identifier(s) for encounter Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() |
S | 1..1 | Identifier | Polaris Encounter ID |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
![]() ![]() ![]() ![]() |
1..1 | uri | Polaris encounter identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-encounter-identifier | |
![]() ![]() ![]() ![]() |
1..1 | string | The actual Polaris encounter ID value: unique in source system | |
![]() ![]() ![]() |
S | 0..* | Identifier | Source EMR encounter identifier |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: secondary | |
![]() ![]() ![]() ![]() |
1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-raw-code | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() |
S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled Binding: EncounterStatus (required) |
![]() ![]() |
S | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (required) |
![]() ![]() |
S | 0..* | CodeableConcept | Encounter type with raw code support |
![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system | |
![]() ![]() ![]() ![]() |
S | 0..* | Coding | Standard encounter type code |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Standard terminology system URI | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() |
S | 0..* | Coding | Source EMR encounter type code |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-type-raw-code | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | EMR-specific encounter type code | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | EMR's display text for this type | |
![]() ![]() |
S | 0..1 | CodeableConcept | Service type with raw code support |
![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system | |
![]() ![]() ![]() ![]() |
S | 0..* | Coding | Standard service type code |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Standard terminology system URI | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() |
S | 0..* | Coding | Source EMR service type code |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-servicetype-raw-code | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | EMR-specific service type code | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | EMR's display text for this service type | |
![]() ![]() |
S | 1..1 | Reference(Polaris Patient Core) | The patient present at the encounter |
![]() ![]() |
S | 0..* | BackboneElement | List of participants involved in the encounter |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Role of participant in encounter |
![]() ![]() ![]() |
S | 0..1 | Period | Period of participation |
![]() ![]() ![]() |
S | 0..1 | Reference(Polaris PractitionerRole Core) | Persons involved in the encounter |
![]() ![]() |
S | 1..1 | Period | The start and end time of the encounter |
![]() ![]() ![]() |
S | 1..1 | dateTime | When the encounter started |
![]() ![]() ![]() |
S | 0..1 | dateTime | When the encounter ended (if finished) |
![]() ![]() |
S | 0..* | CodeableConcept | Encounter reason with raw code support |
![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system | |
![]() ![]() ![]() ![]() |
S | 0..* | Coding | Standard reason code |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Standard terminology system URI | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() |
S | 0..* | Coding | Source EMR reason code |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-reasoncode-raw-code | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | EMR-specific reason code | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | EMR's display text for this reason | |
![]() ![]() |
S | 0..* | BackboneElement | The list of diagnoses relevant to this encounter |
![]() ![]() ![]() |
S | 1..1 | Reference(Polaris Condition Core) | The diagnosis or condition relevant to the encounter |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Role of diagnosis in encounter (e.g., admission, billing, discharge) |
![]() ![]() ![]() |
S | 0..1 | positiveInt | Ranking of the diagnosis (primary, secondary, etc.) |
![]() ![]() |
S | 0..* | BackboneElement | List of locations where the encounter occurred |
![]() ![]() ![]() |
S | 1..1 | Reference(Polaris Location Core) | Location the encounter takes place |
![]() ![]() ![]() |
S | 0..1 | code | planned | active | reserved | completed |
![]() ![]() ![]() |
S | 0..1 | Period | Time period during which the patient was at location |
![]() ![]() |
S | 0..1 | Reference(Polaris Organization Core) | The organization providing the service |
![]() ![]() ![]() |
S | 0..1 | Identifier | Polaris organization identifier reference |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-statusFrom the FHIR Standard | |
| Encounter.class | required | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode |
| Id | Grade | Path(s) | Details | Requirements |
| encounter-has-polaris-id | error | Encounter | Must 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$')) |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Encounter | Polaris Encounter Core Constraints: encounter-has-polaris-id | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
SΣ | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
S | 0..1 | Narrative | Narrative This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..* | Identifier | Business identifier(s) for encounter Slice: Unordered, Open by pattern:system | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Polaris Encounter ID | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Polaris encounter identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-encounter-identifier Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The actual Polaris encounter ID value: unique in source system Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Source EMR encounter identifier | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled Binding: EncounterStatus (required) | ||||
![]() ![]() |
0..* | BackboneElement | List of past encounter statuses | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
![]() ![]() ![]() |
1..1 | Period | The time that the episode was in the specified status | |||||
![]() ![]() |
SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (required) | ||||
![]() ![]() |
0..* | BackboneElement | List of past encounter classes | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
![]() ![]() ![]() |
1..1 | Period | The time that the episode was in the specified class | |||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Encounter type with raw code support Binding: EncounterType (example): The type of encounter. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Standard encounter type code | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Standard terminology system URI | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Source EMR encounter type code | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-type-raw-code | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | EMR-specific encounter type code | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | EMR's display text for this type | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Service type with raw code support Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Standard service type code | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Standard terminology system URI | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Source EMR service type code | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-servicetype-raw-code | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | EMR-specific service type code | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | EMR's display text for this service type | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
![]() ![]() |
SΣ | 1..1 | Reference(Polaris Patient Core) | The patient present at the encounter | ||||
![]() ![]() |
Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
![]() ![]() |
0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
![]() ![]() |
SΣ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
![]() ![]() ![]() |
S | 0..1 | Period | Period of participation | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(Polaris PractitionerRole Core) | Persons involved in the encounter | ||||
![]() ![]() |
Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
![]() ![]() |
S | 1..1 | Period | The start and end time of the encounter | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 1..1 | dateTime | When the encounter started | ||||
![]() ![]() ![]() |
SΣC | 0..1 | dateTime | When the encounter ended (if finished) | ||||
![]() ![]() |
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Encounter reason with raw code support Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Standard reason code | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Standard terminology system URI | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Source EMR reason code | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-reasoncode-raw-code | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | EMR-specific reason code | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | EMR's display text for this reason | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
![]() ![]() |
SΣ | 0..* | BackboneElement | The list of diagnoses relevant to this encounter | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Polaris Condition Core) | The diagnosis or condition relevant to the encounter | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Role of diagnosis in encounter (e.g., admission, billing, discharge) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | ||||
![]() ![]() ![]() |
S | 0..1 | positiveInt | Ranking of the diagnosis (primary, secondary, etc.) | ||||
![]() ![]() |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
![]() ![]() |
0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | Identifier | Pre-admission identifier | |||||
![]() ![]() ![]() |
0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
![]() ![]() ![]() |
0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | |||||
![]() ![]() |
S | 0..* | BackboneElement | List of locations where the encounter occurred | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
S | 1..1 | Reference(Polaris Location Core) | Location the encounter takes place | ||||
![]() ![]() ![]() |
S | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | ||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
S | 0..1 | Period | Time period during which the patient was at location | ||||
![]() ![]() |
S | 0..1 | Reference(Polaris Organization Core) | The organization providing the service | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Polaris organization identifier reference | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Encounter.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard | ||||
| Encounter.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard | ||||
| Encounter.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Encounter.identifier:polarisId.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Encounter.identifier:polarisId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Encounter.identifier:rawCode.use | required | Pattern Value: secondaryhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Encounter.identifier:rawCode.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-statusFrom the FHIR Standard | ||||
| Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1From the FHIR Standard | ||||
| Encounter.class | required | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
| Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
| Encounter.type | example | EncounterTypehttp://hl7.org/fhir/ValueSet/encounter-typeFrom the FHIR Standard | ||||
| Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-typeFrom the FHIR Standard | ||||
| Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | ||||
| Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typeFrom the FHIR Standard | ||||
| Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonFrom the FHIR Standard | ||||
| Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-roleFrom the FHIR Standard | ||||
| Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-sourceFrom the FHIR Standard | ||||
| Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | ||||
| Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-dietFrom the FHIR Standard | ||||
| Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesyFrom the FHIR Standard | ||||
| Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangementsFrom the FHIR Standard | ||||
| Encounter.hospitalization.dischargeDisposition | example | DischargeDispositionhttp://hl7.org/fhir/ValueSet/encounter-discharge-dispositionFrom the FHIR Standard | ||||
| Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1From the FHIR Standard | ||||
| Encounter.location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-typeFrom the FHIR Standard | ||||
| Encounter.serviceProvider.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| encounter-has-polaris-id | error | Encounter | Must 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-1 | error | **ALL** extensions | Must 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:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Encounter | Polaris Encounter Core Constraints: encounter-has-polaris-id |
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
SΣ | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
S | 0..1 | Narrative | Narrative This profile does not constrain the narrative in regard to content, language, or traceability to data elements |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..* | Identifier | Business identifier(s) for encounter Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Polaris Encounter ID |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Polaris encounter identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-encounter-identifier Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The actual Polaris encounter ID value: unique in source system Example General: 123456 |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Source EMR encounter identifier |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() |
?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled Binding: EncounterStatus (required) |
![]() ![]() |
SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (required) |
![]() ![]() |
SΣ | 0..* | CodeableConcept | Encounter type with raw code support Binding: EncounterType (example): The type of encounter. |
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Standard encounter type code |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Standard terminology system URI |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Source EMR encounter type code |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-type-raw-code |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | EMR-specific encounter type code |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | EMR's display text for this type |
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Service type with raw code support Binding: ServiceType (example): Broad categorization of the service that is to be provided. |
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Standard service type code |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Standard terminology system URI |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Source EMR service type code |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-servicetype-raw-code |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | EMR-specific service type code |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | EMR's display text for this service type |
![]() ![]() |
SΣ | 1..1 | Reference(Polaris Patient Core) | The patient present at the encounter |
![]() ![]() |
SΣ | 0..* | BackboneElement | List of participants involved in the encounter |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. |
![]() ![]() ![]() |
S | 0..1 | Period | Period of participation |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(Polaris PractitionerRole Core) | Persons involved in the encounter |
![]() ![]() |
S | 1..1 | Period | The start and end time of the encounter |
![]() ![]() ![]() |
SΣC | 1..1 | dateTime | When the encounter started |
![]() ![]() ![]() |
SΣC | 0..1 | dateTime | When the encounter ended (if finished) |
![]() ![]() |
SΣ | 0..* | CodeableConcept | Encounter reason with raw code support Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Standard reason code |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Standard terminology system URI |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Source EMR reason code |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-reasoncode-raw-code |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | EMR-specific reason code |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | EMR's display text for this reason |
![]() ![]() |
SΣ | 0..* | BackboneElement | The list of diagnoses relevant to this encounter |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Polaris Condition Core) | The diagnosis or condition relevant to the encounter |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Role of diagnosis in encounter (e.g., admission, billing, discharge) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. |
![]() ![]() ![]() |
S | 0..1 | positiveInt | Ranking of the diagnosis (primary, secondary, etc.) |
![]() ![]() |
S | 0..* | BackboneElement | List of locations where the encounter occurred |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 1..1 | Reference(Polaris Location Core) | Location the encounter takes place |
![]() ![]() ![]() |
S | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. |
![]() ![]() ![]() |
S | 0..1 | Period | Time period during which the patient was at location |
![]() ![]() |
S | 0..1 | Reference(Polaris Organization Core) | The organization providing the service |
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Polaris organization identifier reference |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Encounter.identifier:polarisId.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Encounter.identifier:rawCode.use | required | Pattern Value: secondaryhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-statusFrom the FHIR Standard | |
| Encounter.class | required | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
| Encounter.type | example | EncounterTypehttp://hl7.org/fhir/ValueSet/encounter-typeFrom the FHIR Standard | |
| Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-typeFrom the FHIR Standard | |
| Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typeFrom the FHIR Standard | |
| Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonFrom the FHIR Standard | |
| Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-roleFrom the FHIR Standard | |
| Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| encounter-has-polaris-id | error | Encounter | Must 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-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from Encounter
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Encounter | Polaris Encounter Core Constraints: encounter-has-polaris-id |
![]() ![]() |
||||
![]() ![]() ![]() |
S | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from |
![]() ![]() |
S | 0..1 | Narrative | Narrative |
![]() ![]() |
S | 1..* | Identifier | Business identifier(s) for encounter Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() |
S | 1..1 | Identifier | Polaris Encounter ID |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
![]() ![]() ![]() ![]() |
1..1 | uri | Polaris encounter identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-encounter-identifier | |
![]() ![]() ![]() ![]() |
1..1 | string | The actual Polaris encounter ID value: unique in source system | |
![]() ![]() ![]() |
S | 0..* | Identifier | Source EMR encounter identifier |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: secondary | |
![]() ![]() ![]() ![]() |
1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-raw-code | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() |
S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled Binding: EncounterStatus (required) |
![]() ![]() |
S | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (required) |
![]() ![]() |
S | 0..* | CodeableConcept | Encounter type with raw code support |
![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system | |
![]() ![]() ![]() ![]() |
S | 0..* | Coding | Standard encounter type code |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Standard terminology system URI | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() |
S | 0..* | Coding | Source EMR encounter type code |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-type-raw-code | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | EMR-specific encounter type code | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | EMR's display text for this type | |
![]() ![]() |
S | 0..1 | CodeableConcept | Service type with raw code support |
![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system | |
![]() ![]() ![]() ![]() |
S | 0..* | Coding | Standard service type code |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Standard terminology system URI | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() |
S | 0..* | Coding | Source EMR service type code |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-servicetype-raw-code | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | EMR-specific service type code | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | EMR's display text for this service type | |
![]() ![]() |
S | 1..1 | Reference(Polaris Patient Core) | The patient present at the encounter |
![]() ![]() |
S | 0..* | BackboneElement | List of participants involved in the encounter |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Role of participant in encounter |
![]() ![]() ![]() |
S | 0..1 | Period | Period of participation |
![]() ![]() ![]() |
S | 0..1 | Reference(Polaris PractitionerRole Core) | Persons involved in the encounter |
![]() ![]() |
S | 1..1 | Period | The start and end time of the encounter |
![]() ![]() ![]() |
S | 1..1 | dateTime | When the encounter started |
![]() ![]() ![]() |
S | 0..1 | dateTime | When the encounter ended (if finished) |
![]() ![]() |
S | 0..* | CodeableConcept | Encounter reason with raw code support |
![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system | |
![]() ![]() ![]() ![]() |
S | 0..* | Coding | Standard reason code |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Standard terminology system URI | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() |
S | 0..* | Coding | Source EMR reason code |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-reasoncode-raw-code | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | EMR-specific reason code | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | EMR's display text for this reason | |
![]() ![]() |
S | 0..* | BackboneElement | The list of diagnoses relevant to this encounter |
![]() ![]() ![]() |
S | 1..1 | Reference(Polaris Condition Core) | The diagnosis or condition relevant to the encounter |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Role of diagnosis in encounter (e.g., admission, billing, discharge) |
![]() ![]() ![]() |
S | 0..1 | positiveInt | Ranking of the diagnosis (primary, secondary, etc.) |
![]() ![]() |
S | 0..* | BackboneElement | List of locations where the encounter occurred |
![]() ![]() ![]() |
S | 1..1 | Reference(Polaris Location Core) | Location the encounter takes place |
![]() ![]() ![]() |
S | 0..1 | code | planned | active | reserved | completed |
![]() ![]() ![]() |
S | 0..1 | Period | Time period during which the patient was at location |
![]() ![]() |
S | 0..1 | Reference(Polaris Organization Core) | The organization providing the service |
![]() ![]() ![]() |
S | 0..1 | Identifier | Polaris organization identifier reference |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-statusFrom the FHIR Standard | |
| Encounter.class | required | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode |
| Id | Grade | Path(s) | Details | Requirements |
| encounter-has-polaris-id | error | Encounter | Must 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Encounter | Polaris Encounter Core Constraints: encounter-has-polaris-id | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
SΣ | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
S | 0..1 | Narrative | Narrative This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..* | Identifier | Business identifier(s) for encounter Slice: Unordered, Open by pattern:system | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Polaris Encounter ID | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Polaris encounter identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-encounter-identifier Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The actual Polaris encounter ID value: unique in source system Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Source EMR encounter identifier | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled Binding: EncounterStatus (required) | ||||
![]() ![]() |
0..* | BackboneElement | List of past encounter statuses | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
![]() ![]() ![]() |
1..1 | Period | The time that the episode was in the specified status | |||||
![]() ![]() |
SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (required) | ||||
![]() ![]() |
0..* | BackboneElement | List of past encounter classes | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
![]() ![]() ![]() |
1..1 | Period | The time that the episode was in the specified class | |||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Encounter type with raw code support Binding: EncounterType (example): The type of encounter. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Standard encounter type code | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Standard terminology system URI | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Source EMR encounter type code | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-type-raw-code | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | EMR-specific encounter type code | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | EMR's display text for this type | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Service type with raw code support Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Standard service type code | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Standard terminology system URI | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Source EMR service type code | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-servicetype-raw-code | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | EMR-specific service type code | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | EMR's display text for this service type | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
![]() ![]() |
SΣ | 1..1 | Reference(Polaris Patient Core) | The patient present at the encounter | ||||
![]() ![]() |
Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
![]() ![]() |
0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
![]() ![]() |
SΣ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
![]() ![]() ![]() |
S | 0..1 | Period | Period of participation | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(Polaris PractitionerRole Core) | Persons involved in the encounter | ||||
![]() ![]() |
Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
![]() ![]() |
S | 1..1 | Period | The start and end time of the encounter | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 1..1 | dateTime | When the encounter started | ||||
![]() ![]() ![]() |
SΣC | 0..1 | dateTime | When the encounter ended (if finished) | ||||
![]() ![]() |
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Encounter reason with raw code support Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Standard reason code | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Standard terminology system URI | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Source EMR reason code | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-encounter-reasoncode-raw-code | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | EMR-specific reason code | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | EMR's display text for this reason | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
![]() ![]() |
SΣ | 0..* | BackboneElement | The list of diagnoses relevant to this encounter | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Polaris Condition Core) | The diagnosis or condition relevant to the encounter | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Role of diagnosis in encounter (e.g., admission, billing, discharge) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | ||||
![]() ![]() ![]() |
S | 0..1 | positiveInt | Ranking of the diagnosis (primary, secondary, etc.) | ||||
![]() ![]() |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
![]() ![]() |
0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | Identifier | Pre-admission identifier | |||||
![]() ![]() ![]() |
0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
![]() ![]() ![]() |
0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | |||||
![]() ![]() |
S | 0..* | BackboneElement | List of locations where the encounter occurred | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
S | 1..1 | Reference(Polaris Location Core) | Location the encounter takes place | ||||
![]() ![]() ![]() |
S | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | ||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
S | 0..1 | Period | Time period during which the patient was at location | ||||
![]() ![]() |
S | 0..1 | Reference(Polaris Organization Core) | The organization providing the service | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Polaris organization identifier reference | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Encounter.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard | ||||
| Encounter.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard | ||||
| Encounter.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Encounter.identifier:polarisId.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Encounter.identifier:polarisId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Encounter.identifier:rawCode.use | required | Pattern Value: secondaryhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Encounter.identifier:rawCode.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-statusFrom the FHIR Standard | ||||
| Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1From the FHIR Standard | ||||
| Encounter.class | required | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
| Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
| Encounter.type | example | EncounterTypehttp://hl7.org/fhir/ValueSet/encounter-typeFrom the FHIR Standard | ||||
| Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-typeFrom the FHIR Standard | ||||
| Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | ||||
| Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typeFrom the FHIR Standard | ||||
| Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonFrom the FHIR Standard | ||||
| Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-roleFrom the FHIR Standard | ||||
| Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-sourceFrom the FHIR Standard | ||||
| Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | ||||
| Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-dietFrom the FHIR Standard | ||||
| Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesyFrom the FHIR Standard | ||||
| Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangementsFrom the FHIR Standard | ||||
| Encounter.hospitalization.dischargeDisposition | example | DischargeDispositionhttp://hl7.org/fhir/ValueSet/encounter-discharge-dispositionFrom the FHIR Standard | ||||
| Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1From the FHIR Standard | ||||
| Encounter.location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-typeFrom the FHIR Standard | ||||
| Encounter.serviceProvider.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| encounter-has-polaris-id | error | Encounter | Must 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-1 | error | **ALL** extensions | Must 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:
Other representations of profile: CSV, Excel, Schematron