One Medical FHIR Implementation Guide
0.1.0 - ci-build
One Medical FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir-ig.onemedical.io/StructureDefinition/PPVEncounter | Version: 0.1.0 | |||
| Draft as of 2026-05-04 | Computable Name: PPVEncounter | |||
A OM PPV encounter
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..* | USCoreEncounterProfile(4.0.0) | An interaction during which services are provided to the patient Constraints: ppv-virtual-encounter-type, ppv-source-type-tag, ppv-source-system-tag, ppv-encounter-type, ppv-scheduling-type, ppv-virtual-encounter-service |
![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact |
![]() ![]() |
Σ | 1..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
Σ | 2..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
![]() ![]() ![]() ![]() |
Σ | 1..1 | 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". |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://onemedical.com/terminology/source-type |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: one-medical-collected |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system Required Pattern: One Medical Collected |
![]() ![]() ![]() ![]() |
Σ | 1..1 | 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". |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://onemedical.com/terminology/source-system |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: ppv |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system Required Pattern: One Medical Pay-per-visit |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known |
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() |
SΣ | 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): Current state of the encounter. Required Pattern: finished |
![]() ![]() |
SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. |
![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://onemedical.com/terminology |
![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: VR |
![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system Required Pattern: phone, video, or asynchronous |
![]() ![]() |
SΣ | 4..* | CodeableConcept | Specific type of encounter Slice: Unordered, Open by value:coding.system Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: 185347001 |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system Required Pattern: Encounter for problem |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Virtual encounter type Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://onemedical.com/terminology#virtual-encounter-type |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system: video | messaging |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system: Video | Messaging |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://onemedical.com/terminology#scheduling-type |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: on-demand |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system Required Pattern: On-Demand |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://onemedical.com/terminology#virtual-encounter-service |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: ppv |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system Required Pattern: One Medical Pay-per-visit |
![]() ![]() |
SΣ | 1..1 | Reference(PPVPatient) | The patient or group 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 time during the encounter that the participant participated |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Practitioner Profile(4.0.0) S | US Core PractitionerRole Profile(4.0.0) | RelatedPerson) | Persons involved in the encounter other than the patient |
![]() ![]() |
S | 0..1 | Period | The start and end time of the encounter |
![]() ![]() |
SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
![]() ![]() |
SΣ | 0..1 | Reference(US Core Condition Profile(4.0.0) S | US Core Procedure Profile(4.0.0) | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) |
![]() ![]() |
S | 0..1 | BackboneElement | Details about the admission to a healthcare service |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. |
![]() ![]() |
S | 0..1 | BackboneElement | List of locations where the patient has been |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 1..1 | Reference(Location) | Location the encounter takes place |
![]() ![]() |
S | 0..1 | Reference(US Core Organization Profile(4.0.0)) | The organization (facility) responsible for this encounter |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Encounter.meta.tag:sourceType | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Encounter.meta.tag:sourceSystem | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Encounter.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.1 |
| Encounter.type | Base | extensible | US Core Encounter Type | 📦4.0.0 | US Core v4.0 |
| Encounter.type:encounterType | Base | extensible | US Core Encounter Type | 📦4.0.0 | US Core v4.0 |
| Encounter.type:virtualEncounterType | Base | extensible | US Core Encounter Type | 📦4.0.0 | US Core v4.0 |
| Encounter.type:schedulingType | Base | extensible | US Core Encounter Type | 📦4.0.0 | US Core v4.0 |
| Encounter.type:virtualEncounterService | Base | extensible | US Core Encounter Type | 📦4.0.0 | US Core v4.0 |
| Encounter.participant.type | Base | extensible | Participant type | 📦4.0.1 | FHIR Std. |
| Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📦4.0.1 | FHIR Std. |
| Encounter.hospitalization.dischargeDisposition | Base | example | Discharge disposition | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Encounter | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ppv-encounter-type | error | Encounter | type must contain an encounterType coding with system http://snomed.info/sct, code 185347001, and display Encounter for problem |
type.where(coding.where(system='http://snomed.info/sct' and code='185347001' and display='Encounter for problem').exists()).exists()
|
| ppv-scheduling-type | error | Encounter | type must contain a schedulingType coding with system https://onemedical.com/terminology#scheduling-type, code on-demand, and display On-Demand |
type.where(coding.where(system='https://onemedical.com/terminology#scheduling-type' and code='on-demand' and display='On-Demand').exists()).exists()
|
| ppv-source-system-tag | error | Encounter | meta.tag must contain a sourceSystem tag with system http://onemedical.com/terminology/source-system, code ppv, and display One Medical Pay-per-visit |
meta.tag.where(system='http://onemedical.com/terminology/source-system' and code='ppv' and display='One Medical Pay-per-visit').exists()
|
| ppv-source-type-tag | error | Encounter | meta.tag must contain a sourceType tag with system http://onemedical.com/terminology/source-type, code one-medical-collected, and display One Medical Collected |
meta.tag.where(system='http://onemedical.com/terminology/source-type' and code='one-medical-collected' and display='One Medical Collected').exists()
|
| ppv-virtual-encounter-service | error | Encounter | type must contain a virtualEncounterService coding with system https://onemedical.com/terminology#virtual-encounter-service, code ppv, and display One Medical Pay-per-visit |
type.where(coding.where(system='https://onemedical.com/terminology#virtual-encounter-service' and code='ppv' and display='One Medical Pay-per-visit').exists()).exists()
|
| ppv-virtual-encounter-type | error | Encounter | virtualEncounterType coding/display must be video/Video or messaging/Messaging |
type.where(coding.system='https://onemedical.com/terminology#virtual-encounter-type').coding.where((code='video' and display='Video') or (code='messaging' and display='Messaging')).exists()
|
This structure is derived from USCoreEncounterProfile
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | USCoreEncounterProfile(4.0.0) | An interaction during which services are provided to the patient Constraints: ppv-virtual-encounter-type, ppv-source-type-tag, ppv-source-system-tag, ppv-encounter-type, ppv-scheduling-type, ppv-virtual-encounter-service |
![]() ![]() |
1..1 | id | Logical id of this artifact | |
![]() ![]() |
1..1 | Meta | Metadata about the resource | |
![]() ![]() ![]() |
2..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() |
1..1 | Coding | Tags applied to this resource | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://onemedical.com/terminology/source-type | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: one-medical-collected | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Required Pattern: One Medical Collected | |
![]() ![]() ![]() ![]() |
1..1 | Coding | Tags applied to this resource | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://onemedical.com/terminology/source-system | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: ppv | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Required Pattern: One Medical Pay-per-visit | |
![]() ![]() |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Required Pattern: finished | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://onemedical.com/terminology | |
![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system Required Pattern: VR | |
![]() ![]() ![]() |
0..1 | string | Representation defined by the system Required Pattern: phone, video, or asynchronous | |
![]() ![]() |
4..* | CodeableConcept | Specific type of encounter Slice: Unordered, Open by value:coding.system | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Specific type of encounter | |
![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: 185347001 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Required Pattern: Encounter for problem | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Virtual encounter type | |
![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: https://onemedical.com/terminology#virtual-encounter-type | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system: video | messaging | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system: Video | Messaging | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Specific type of encounter | |
![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: https://onemedical.com/terminology#scheduling-type | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: on-demand | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Required Pattern: On-Demand | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Specific type of encounter | |
![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: https://onemedical.com/terminology#virtual-encounter-service | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: ppv | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Required Pattern: One Medical Pay-per-visit | |
![]() ![]() |
1..1 | Reference(PPVPatient) | The patient or group present at the encounter | |
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | Reference(US Core Practitioner Profile(4.0.0) | US Core PractitionerRole Profile(4.0.0) | RelatedPerson) | Persons involved in the encounter other than the patient | |
![]() ![]() |
0..1 | BackboneElement | List of locations where the patient has been | |
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| ppv-encounter-type | error | Encounter | type must contain an encounterType coding with system http://snomed.info/sct, code 185347001, and display Encounter for problem |
type.where(coding.where(system='http://snomed.info/sct' and code='185347001' and display='Encounter for problem').exists()).exists()
|
| ppv-scheduling-type | error | Encounter | type must contain a schedulingType coding with system https://onemedical.com/terminology#scheduling-type, code on-demand, and display On-Demand |
type.where(coding.where(system='https://onemedical.com/terminology#scheduling-type' and code='on-demand' and display='On-Demand').exists()).exists()
|
| ppv-source-system-tag | error | Encounter | meta.tag must contain a sourceSystem tag with system http://onemedical.com/terminology/source-system, code ppv, and display One Medical Pay-per-visit |
meta.tag.where(system='http://onemedical.com/terminology/source-system' and code='ppv' and display='One Medical Pay-per-visit').exists()
|
| ppv-source-type-tag | error | Encounter | meta.tag must contain a sourceType tag with system http://onemedical.com/terminology/source-type, code one-medical-collected, and display One Medical Collected |
meta.tag.where(system='http://onemedical.com/terminology/source-type' and code='one-medical-collected' and display='One Medical Collected').exists()
|
| ppv-virtual-encounter-service | error | Encounter | type must contain a virtualEncounterService coding with system https://onemedical.com/terminology#virtual-encounter-service, code ppv, and display One Medical Pay-per-visit |
type.where(coding.where(system='https://onemedical.com/terminology#virtual-encounter-service' and code='ppv' and display='One Medical Pay-per-visit').exists()).exists()
|
| ppv-virtual-encounter-type | error | Encounter | virtualEncounterType coding/display must be video/Video or messaging/Messaging |
type.where(coding.system='https://onemedical.com/terminology#virtual-encounter-type').coding.where((code='video' and display='Video') or (code='messaging' and display='Messaging')).exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | USCoreEncounterProfile(4.0.0) | An interaction during which services are provided to the patient Constraints: ppv-virtual-encounter-type, ppv-source-type-tag, ppv-source-system-tag, ppv-encounter-type, ppv-scheduling-type, ppv-virtual-encounter-service | ||||
![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 1..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 | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes 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. | ||||
![]() ![]() ![]() |
Σ | 2..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | 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 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://onemedical.com/terminology/source-type | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: one-medical-collected | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system Required Pattern: One Medical Collected | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | 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 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://onemedical.com/terminology/source-system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: ppv | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system Required Pattern: One Medical Pay-per-visit | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() |
?!Σ | 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.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
![]() ![]() ![]() |
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 . | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
SΣ | 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): Current state of the encounter. Required Pattern: finished | ||||
![]() ![]() |
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 (extensible): Classification 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 | |||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://onemedical.com/terminology | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: VR | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system Required Pattern: phone, video, or asynchronous | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() |
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Σ | 4..* | CodeableConcept | Specific type of encounter Slice: Unordered, Open by value:coding.system Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
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 | Identity of the terminology system Required Pattern: http://snomed.info/sct | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: 185347001 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system Required Pattern: Encounter for problem | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Virtual encounter type Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
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 | Identity of the terminology system Required Pattern: https://onemedical.com/terminology#virtual-encounter-type | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system: video | messaging | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system: Video | Messaging | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
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 | Identity of the terminology system Required Pattern: https://onemedical.com/terminology#scheduling-type | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: on-demand | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system Required Pattern: On-Demand | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
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 | Identity of the terminology system Required Pattern: https://onemedical.com/terminology#virtual-encounter-service | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: ppv | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system Required Pattern: One Medical Pay-per-visit | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
![]() ![]() |
0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
![]() ![]() |
SΣ | 1..1 | Reference(PPVPatient) | The patient or group 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 time during the encounter that the participant participated | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Practitioner Profile(4.0.0) S | US Core PractitionerRole Profile(4.0.0) | RelatedPerson) | Persons involved in the encounter other than the patient | ||||
![]() ![]() |
Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
![]() ![]() |
S | 0..1 | Period | The start and end time of the encounter | ||||
![]() ![]() |
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
![]() ![]() |
SΣ | 0..1 | Reference(US Core Condition Profile(4.0.0) S | US Core Procedure Profile(4.0.0) | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | The list of diagnosis 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 | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
![]() ![]() |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
![]() ![]() |
S | 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 | |||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | ||||
![]() ![]() |
S | 0..1 | BackboneElement | List of locations where the patient has been | ||||
![]() ![]() ![]() |
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(Location) | Location the encounter takes place | ||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..1 | Period | Time period during which the patient was present at the location | |||||
![]() ![]() |
S | 0..1 | Reference(US Core Organization Profile(4.0.0)) | The organization (facility) responsible for this encounter | ||||
![]() ![]() |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Encounter.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Encounter.meta.tag:sourceType | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Encounter.meta.tag:sourceSystem | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Encounter.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Encounter.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Encounter.identifier.type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std. |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.statusHistory.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.1 |
| Encounter.classHistory.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.1 |
| Encounter.type | Base | extensible | US Core Encounter Type | 📦4.0.0 | US Core v4.0 |
| Encounter.type:encounterType | Base | extensible | US Core Encounter Type | 📦4.0.0 | US Core v4.0 |
| Encounter.type:virtualEncounterType | Base | extensible | US Core Encounter Type | 📦4.0.0 | US Core v4.0 |
| Encounter.type:schedulingType | Base | extensible | US Core Encounter Type | 📦4.0.0 | US Core v4.0 |
| Encounter.type:virtualEncounterService | Base | extensible | US Core Encounter Type | 📦4.0.0 | US Core v4.0 |
| Encounter.serviceType | Base | example | Service type | 📦4.0.1 | FHIR Std. |
| Encounter.priority | Base | example | ActPriority | 📦3.0.0 | THO v7.1 |
| Encounter.participant.type | Base | extensible | Participant type | 📦4.0.1 | FHIR Std. |
| Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📦4.0.1 | FHIR Std. |
| Encounter.diagnosis.use | Base | preferred | DiagnosisRole | 📦4.0.1 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | preferred | Admit source | 📦4.0.1 | FHIR Std. |
| Encounter.hospitalization.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📦3.0.0 | THO v7.1 |
| Encounter.hospitalization.dietPreference | Base | example | Diet | 📦4.0.1 | FHIR Std. |
| Encounter.hospitalization.specialCourtesy | Base | preferred | Special courtesy | 📦4.0.1 | FHIR Std. |
| Encounter.hospitalization.specialArrangement | Base | preferred | Special arrangements | 📦4.0.1 | FHIR Std. |
| Encounter.hospitalization.dischargeDisposition | Base | example | Discharge disposition | 📦4.0.1 | FHIR Std. |
| Encounter.location.status | Base | required | EncounterLocationStatus | 📍4.0.1 | FHIR Std. |
| Encounter.location.physicalType | Base | example | Location type | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Encounter | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ppv-encounter-type | error | Encounter | type must contain an encounterType coding with system http://snomed.info/sct, code 185347001, and display Encounter for problem |
type.where(coding.where(system='http://snomed.info/sct' and code='185347001' and display='Encounter for problem').exists()).exists()
|
| ppv-scheduling-type | error | Encounter | type must contain a schedulingType coding with system https://onemedical.com/terminology#scheduling-type, code on-demand, and display On-Demand |
type.where(coding.where(system='https://onemedical.com/terminology#scheduling-type' and code='on-demand' and display='On-Demand').exists()).exists()
|
| ppv-source-system-tag | error | Encounter | meta.tag must contain a sourceSystem tag with system http://onemedical.com/terminology/source-system, code ppv, and display One Medical Pay-per-visit |
meta.tag.where(system='http://onemedical.com/terminology/source-system' and code='ppv' and display='One Medical Pay-per-visit').exists()
|
| ppv-source-type-tag | error | Encounter | meta.tag must contain a sourceType tag with system http://onemedical.com/terminology/source-type, code one-medical-collected, and display One Medical Collected |
meta.tag.where(system='http://onemedical.com/terminology/source-type' and code='one-medical-collected' and display='One Medical Collected').exists()
|
| ppv-virtual-encounter-service | error | Encounter | type must contain a virtualEncounterService coding with system https://onemedical.com/terminology#virtual-encounter-service, code ppv, and display One Medical Pay-per-visit |
type.where(coding.where(system='https://onemedical.com/terminology#virtual-encounter-service' and code='ppv' and display='One Medical Pay-per-visit').exists()).exists()
|
| ppv-virtual-encounter-type | error | Encounter | virtualEncounterType coding/display must be video/Video or messaging/Messaging |
type.where(coding.system='https://onemedical.com/terminology#virtual-encounter-type').coding.where((code='video' and display='Video') or (code='messaging' and display='Messaging')).exists()
|
This structure is derived from USCoreEncounterProfile
Summary
Mandatory: 30 elements(1 nested mandatory element)
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..* | USCoreEncounterProfile(4.0.0) | An interaction during which services are provided to the patient Constraints: ppv-virtual-encounter-type, ppv-source-type-tag, ppv-source-system-tag, ppv-encounter-type, ppv-scheduling-type, ppv-virtual-encounter-service |
![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact |
![]() ![]() |
Σ | 1..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
Σ | 2..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
![]() ![]() ![]() ![]() |
Σ | 1..1 | 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". |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://onemedical.com/terminology/source-type |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: one-medical-collected |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system Required Pattern: One Medical Collected |
![]() ![]() ![]() ![]() |
Σ | 1..1 | 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". |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://onemedical.com/terminology/source-system |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: ppv |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system Required Pattern: One Medical Pay-per-visit |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known |
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() |
SΣ | 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): Current state of the encounter. Required Pattern: finished |
![]() ![]() |
SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. |
![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://onemedical.com/terminology |
![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: VR |
![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system Required Pattern: phone, video, or asynchronous |
![]() ![]() |
SΣ | 4..* | CodeableConcept | Specific type of encounter Slice: Unordered, Open by value:coding.system Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: 185347001 |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system Required Pattern: Encounter for problem |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Virtual encounter type Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://onemedical.com/terminology#virtual-encounter-type |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system: video | messaging |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system: Video | Messaging |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://onemedical.com/terminology#scheduling-type |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: on-demand |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system Required Pattern: On-Demand |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://onemedical.com/terminology#virtual-encounter-service |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: ppv |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system Required Pattern: One Medical Pay-per-visit |
![]() ![]() |
SΣ | 1..1 | Reference(PPVPatient) | The patient or group 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 time during the encounter that the participant participated |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Practitioner Profile(4.0.0) S | US Core PractitionerRole Profile(4.0.0) | RelatedPerson) | Persons involved in the encounter other than the patient |
![]() ![]() |
S | 0..1 | Period | The start and end time of the encounter |
![]() ![]() |
SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
![]() ![]() |
SΣ | 0..1 | Reference(US Core Condition Profile(4.0.0) S | US Core Procedure Profile(4.0.0) | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) |
![]() ![]() |
S | 0..1 | BackboneElement | Details about the admission to a healthcare service |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. |
![]() ![]() |
S | 0..1 | BackboneElement | List of locations where the patient has been |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 1..1 | Reference(Location) | Location the encounter takes place |
![]() ![]() |
S | 0..1 | Reference(US Core Organization Profile(4.0.0)) | The organization (facility) responsible for this encounter |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Encounter.meta.tag:sourceType | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Encounter.meta.tag:sourceSystem | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Encounter.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.1 |
| Encounter.type | Base | extensible | US Core Encounter Type | 📦4.0.0 | US Core v4.0 |
| Encounter.type:encounterType | Base | extensible | US Core Encounter Type | 📦4.0.0 | US Core v4.0 |
| Encounter.type:virtualEncounterType | Base | extensible | US Core Encounter Type | 📦4.0.0 | US Core v4.0 |
| Encounter.type:schedulingType | Base | extensible | US Core Encounter Type | 📦4.0.0 | US Core v4.0 |
| Encounter.type:virtualEncounterService | Base | extensible | US Core Encounter Type | 📦4.0.0 | US Core v4.0 |
| Encounter.participant.type | Base | extensible | Participant type | 📦4.0.1 | FHIR Std. |
| Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📦4.0.1 | FHIR Std. |
| Encounter.hospitalization.dischargeDisposition | Base | example | Discharge disposition | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Encounter | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ppv-encounter-type | error | Encounter | type must contain an encounterType coding with system http://snomed.info/sct, code 185347001, and display Encounter for problem |
type.where(coding.where(system='http://snomed.info/sct' and code='185347001' and display='Encounter for problem').exists()).exists()
|
| ppv-scheduling-type | error | Encounter | type must contain a schedulingType coding with system https://onemedical.com/terminology#scheduling-type, code on-demand, and display On-Demand |
type.where(coding.where(system='https://onemedical.com/terminology#scheduling-type' and code='on-demand' and display='On-Demand').exists()).exists()
|
| ppv-source-system-tag | error | Encounter | meta.tag must contain a sourceSystem tag with system http://onemedical.com/terminology/source-system, code ppv, and display One Medical Pay-per-visit |
meta.tag.where(system='http://onemedical.com/terminology/source-system' and code='ppv' and display='One Medical Pay-per-visit').exists()
|
| ppv-source-type-tag | error | Encounter | meta.tag must contain a sourceType tag with system http://onemedical.com/terminology/source-type, code one-medical-collected, and display One Medical Collected |
meta.tag.where(system='http://onemedical.com/terminology/source-type' and code='one-medical-collected' and display='One Medical Collected').exists()
|
| ppv-virtual-encounter-service | error | Encounter | type must contain a virtualEncounterService coding with system https://onemedical.com/terminology#virtual-encounter-service, code ppv, and display One Medical Pay-per-visit |
type.where(coding.where(system='https://onemedical.com/terminology#virtual-encounter-service' and code='ppv' and display='One Medical Pay-per-visit').exists()).exists()
|
| ppv-virtual-encounter-type | error | Encounter | virtualEncounterType coding/display must be video/Video or messaging/Messaging |
type.where(coding.system='https://onemedical.com/terminology#virtual-encounter-type').coding.where((code='video' and display='Video') or (code='messaging' and display='Messaging')).exists()
|
Differential View
This structure is derived from USCoreEncounterProfile
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | USCoreEncounterProfile(4.0.0) | An interaction during which services are provided to the patient Constraints: ppv-virtual-encounter-type, ppv-source-type-tag, ppv-source-system-tag, ppv-encounter-type, ppv-scheduling-type, ppv-virtual-encounter-service |
![]() ![]() |
1..1 | id | Logical id of this artifact | |
![]() ![]() |
1..1 | Meta | Metadata about the resource | |
![]() ![]() ![]() |
2..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() |
1..1 | Coding | Tags applied to this resource | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://onemedical.com/terminology/source-type | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: one-medical-collected | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Required Pattern: One Medical Collected | |
![]() ![]() ![]() ![]() |
1..1 | Coding | Tags applied to this resource | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://onemedical.com/terminology/source-system | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: ppv | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Required Pattern: One Medical Pay-per-visit | |
![]() ![]() |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Required Pattern: finished | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://onemedical.com/terminology | |
![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system Required Pattern: VR | |
![]() ![]() ![]() |
0..1 | string | Representation defined by the system Required Pattern: phone, video, or asynchronous | |
![]() ![]() |
4..* | CodeableConcept | Specific type of encounter Slice: Unordered, Open by value:coding.system | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Specific type of encounter | |
![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: 185347001 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Required Pattern: Encounter for problem | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Virtual encounter type | |
![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: https://onemedical.com/terminology#virtual-encounter-type | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system: video | messaging | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system: Video | Messaging | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Specific type of encounter | |
![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: https://onemedical.com/terminology#scheduling-type | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: on-demand | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Required Pattern: On-Demand | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Specific type of encounter | |
![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: https://onemedical.com/terminology#virtual-encounter-service | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: ppv | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Required Pattern: One Medical Pay-per-visit | |
![]() ![]() |
1..1 | Reference(PPVPatient) | The patient or group present at the encounter | |
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | Reference(US Core Practitioner Profile(4.0.0) | US Core PractitionerRole Profile(4.0.0) | RelatedPerson) | Persons involved in the encounter other than the patient | |
![]() ![]() |
0..1 | BackboneElement | List of locations where the patient has been | |
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| ppv-encounter-type | error | Encounter | type must contain an encounterType coding with system http://snomed.info/sct, code 185347001, and display Encounter for problem |
type.where(coding.where(system='http://snomed.info/sct' and code='185347001' and display='Encounter for problem').exists()).exists()
|
| ppv-scheduling-type | error | Encounter | type must contain a schedulingType coding with system https://onemedical.com/terminology#scheduling-type, code on-demand, and display On-Demand |
type.where(coding.where(system='https://onemedical.com/terminology#scheduling-type' and code='on-demand' and display='On-Demand').exists()).exists()
|
| ppv-source-system-tag | error | Encounter | meta.tag must contain a sourceSystem tag with system http://onemedical.com/terminology/source-system, code ppv, and display One Medical Pay-per-visit |
meta.tag.where(system='http://onemedical.com/terminology/source-system' and code='ppv' and display='One Medical Pay-per-visit').exists()
|
| ppv-source-type-tag | error | Encounter | meta.tag must contain a sourceType tag with system http://onemedical.com/terminology/source-type, code one-medical-collected, and display One Medical Collected |
meta.tag.where(system='http://onemedical.com/terminology/source-type' and code='one-medical-collected' and display='One Medical Collected').exists()
|
| ppv-virtual-encounter-service | error | Encounter | type must contain a virtualEncounterService coding with system https://onemedical.com/terminology#virtual-encounter-service, code ppv, and display One Medical Pay-per-visit |
type.where(coding.where(system='https://onemedical.com/terminology#virtual-encounter-service' and code='ppv' and display='One Medical Pay-per-visit').exists()).exists()
|
| ppv-virtual-encounter-type | error | Encounter | virtualEncounterType coding/display must be video/Video or messaging/Messaging |
type.where(coding.system='https://onemedical.com/terminology#virtual-encounter-type').coding.where((code='video' and display='Video') or (code='messaging' and display='Messaging')).exists()
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | USCoreEncounterProfile(4.0.0) | An interaction during which services are provided to the patient Constraints: ppv-virtual-encounter-type, ppv-source-type-tag, ppv-source-system-tag, ppv-encounter-type, ppv-scheduling-type, ppv-virtual-encounter-service | ||||
![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 1..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 | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes 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. | ||||
![]() ![]() ![]() |
Σ | 2..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | 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 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://onemedical.com/terminology/source-type | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: one-medical-collected | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system Required Pattern: One Medical Collected | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | 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 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://onemedical.com/terminology/source-system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: ppv | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system Required Pattern: One Medical Pay-per-visit | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() |
?!Σ | 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.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
![]() ![]() ![]() |
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 . | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
SΣ | 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): Current state of the encounter. Required Pattern: finished | ||||
![]() ![]() |
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 (extensible): Classification 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 | |||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://onemedical.com/terminology | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: VR | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system Required Pattern: phone, video, or asynchronous | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() |
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Σ | 4..* | CodeableConcept | Specific type of encounter Slice: Unordered, Open by value:coding.system Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
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 | Identity of the terminology system Required Pattern: http://snomed.info/sct | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: 185347001 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system Required Pattern: Encounter for problem | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Virtual encounter type Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
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 | Identity of the terminology system Required Pattern: https://onemedical.com/terminology#virtual-encounter-type | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system: video | messaging | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system: Video | Messaging | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
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 | Identity of the terminology system Required Pattern: https://onemedical.com/terminology#scheduling-type | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: on-demand | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system Required Pattern: On-Demand | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
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 | Identity of the terminology system Required Pattern: https://onemedical.com/terminology#virtual-encounter-service | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: ppv | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Representation defined by the system Required Pattern: One Medical Pay-per-visit | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
![]() ![]() |
0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
![]() ![]() |
SΣ | 1..1 | Reference(PPVPatient) | The patient or group 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 time during the encounter that the participant participated | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Practitioner Profile(4.0.0) S | US Core PractitionerRole Profile(4.0.0) | RelatedPerson) | Persons involved in the encounter other than the patient | ||||
![]() ![]() |
Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
![]() ![]() |
S | 0..1 | Period | The start and end time of the encounter | ||||
![]() ![]() |
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
![]() ![]() |
SΣ | 0..1 | Reference(US Core Condition Profile(4.0.0) S | US Core Procedure Profile(4.0.0) | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | The list of diagnosis 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 | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
![]() ![]() |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
![]() ![]() |
S | 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 | |||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | ||||
![]() ![]() |
S | 0..1 | BackboneElement | List of locations where the patient has been | ||||
![]() ![]() ![]() |
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(Location) | Location the encounter takes place | ||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..1 | Period | Time period during which the patient was present at the location | |||||
![]() ![]() |
S | 0..1 | Reference(US Core Organization Profile(4.0.0)) | The organization (facility) responsible for this encounter | ||||
![]() ![]() |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Encounter.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Encounter.meta.tag:sourceType | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Encounter.meta.tag:sourceSystem | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Encounter.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Encounter.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Encounter.identifier.type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std. |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.statusHistory.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.1 |
| Encounter.classHistory.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.1 |
| Encounter.type | Base | extensible | US Core Encounter Type | 📦4.0.0 | US Core v4.0 |
| Encounter.type:encounterType | Base | extensible | US Core Encounter Type | 📦4.0.0 | US Core v4.0 |
| Encounter.type:virtualEncounterType | Base | extensible | US Core Encounter Type | 📦4.0.0 | US Core v4.0 |
| Encounter.type:schedulingType | Base | extensible | US Core Encounter Type | 📦4.0.0 | US Core v4.0 |
| Encounter.type:virtualEncounterService | Base | extensible | US Core Encounter Type | 📦4.0.0 | US Core v4.0 |
| Encounter.serviceType | Base | example | Service type | 📦4.0.1 | FHIR Std. |
| Encounter.priority | Base | example | ActPriority | 📦3.0.0 | THO v7.1 |
| Encounter.participant.type | Base | extensible | Participant type | 📦4.0.1 | FHIR Std. |
| Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📦4.0.1 | FHIR Std. |
| Encounter.diagnosis.use | Base | preferred | DiagnosisRole | 📦4.0.1 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | preferred | Admit source | 📦4.0.1 | FHIR Std. |
| Encounter.hospitalization.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📦3.0.0 | THO v7.1 |
| Encounter.hospitalization.dietPreference | Base | example | Diet | 📦4.0.1 | FHIR Std. |
| Encounter.hospitalization.specialCourtesy | Base | preferred | Special courtesy | 📦4.0.1 | FHIR Std. |
| Encounter.hospitalization.specialArrangement | Base | preferred | Special arrangements | 📦4.0.1 | FHIR Std. |
| Encounter.hospitalization.dischargeDisposition | Base | example | Discharge disposition | 📦4.0.1 | FHIR Std. |
| Encounter.location.status | Base | required | EncounterLocationStatus | 📍4.0.1 | FHIR Std. |
| Encounter.location.physicalType | Base | example | Location type | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Encounter | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ppv-encounter-type | error | Encounter | type must contain an encounterType coding with system http://snomed.info/sct, code 185347001, and display Encounter for problem |
type.where(coding.where(system='http://snomed.info/sct' and code='185347001' and display='Encounter for problem').exists()).exists()
|
| ppv-scheduling-type | error | Encounter | type must contain a schedulingType coding with system https://onemedical.com/terminology#scheduling-type, code on-demand, and display On-Demand |
type.where(coding.where(system='https://onemedical.com/terminology#scheduling-type' and code='on-demand' and display='On-Demand').exists()).exists()
|
| ppv-source-system-tag | error | Encounter | meta.tag must contain a sourceSystem tag with system http://onemedical.com/terminology/source-system, code ppv, and display One Medical Pay-per-visit |
meta.tag.where(system='http://onemedical.com/terminology/source-system' and code='ppv' and display='One Medical Pay-per-visit').exists()
|
| ppv-source-type-tag | error | Encounter | meta.tag must contain a sourceType tag with system http://onemedical.com/terminology/source-type, code one-medical-collected, and display One Medical Collected |
meta.tag.where(system='http://onemedical.com/terminology/source-type' and code='one-medical-collected' and display='One Medical Collected').exists()
|
| ppv-virtual-encounter-service | error | Encounter | type must contain a virtualEncounterService coding with system https://onemedical.com/terminology#virtual-encounter-service, code ppv, and display One Medical Pay-per-visit |
type.where(coding.where(system='https://onemedical.com/terminology#virtual-encounter-service' and code='ppv' and display='One Medical Pay-per-visit').exists()).exists()
|
| ppv-virtual-encounter-type | error | Encounter | virtualEncounterType coding/display must be video/Video or messaging/Messaging |
type.where(coding.system='https://onemedical.com/terminology#virtual-encounter-type').coding.where((code='video' and display='Video') or (code='messaging' and display='Messaging')).exists()
|
This structure is derived from USCoreEncounterProfile
Summary
Mandatory: 30 elements(1 nested mandatory element)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron