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

Resource Profile: PPVEncounter - Detailed Descriptions

Draft as of 2026-05-04

Definitions for the PPVEncounter resource profile.

Guidance on how to interpret the contents of this table can be foundhere

0. Encounter
Definition

This is basic constraint on Encounter for use in US Core resources.


An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

ShortAn interaction during which services are provided to the patient
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate NamesVisit
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
ppv-virtual-encounter-type: 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())
ppv-source-type-tag: 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-source-system-tag: 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-encounter-type: 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: 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-virtual-encounter-service: 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())
2. Encounter.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control10..1
Typeidstring
Is Modifierfalse
Summarytrue
4. Encounter.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control10..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Encounter.meta.tag
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

ShortTags applied to this resource
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Control20..*
BindingFor example codes, see CommonTagshttp://hl7.org/fhir/ValueSet/common-tags|4.0.1
(example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Encounter.meta.tag. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ system
  • 8. Encounter.meta.tag:sourceType
    Slice NamesourceType
    Definition

    Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

    ShortTags applied to this resource
    Comments

    The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

    Control10..1*
    BindingFor example codes, see CommonTagshttp://hl7.org/fhir/ValueSet/common-tags|4.0.1
    (example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)

    Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

    TypeCoding
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. Encounter.meta.tag:sourceType.system
    Definition

    The identification of the code system that defines the meaning of the symbol in the code.

    ShortIdentity of the terminology system
    Comments

    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

    Control10..1
    Typeuri
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Need to be unambiguous about the source of the definition of the symbol.

    Pattern Valuehttp://onemedical.com/terminology/source-type
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. Encounter.meta.tag:sourceType.code
    Definition

    A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

    ShortSymbol in syntax defined by the system
    Control10..1
    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Need to refer to a particular code in the system.

    Pattern Valueone-medical-collected
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. Encounter.meta.tag:sourceType.display
    Definition

    A representation of the meaning of the code in the system, following the rules of the system.

    ShortRepresentation defined by the system
    Control10..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

    Pattern ValueOne Medical Collected
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. Encounter.meta.tag:sourceSystem
    Slice NamesourceSystem
    Definition

    Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

    ShortTags applied to this resource
    Comments

    The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

    Control10..1*
    BindingFor example codes, see CommonTagshttp://hl7.org/fhir/ValueSet/common-tags|4.0.1
    (example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)

    Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

    TypeCoding
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. Encounter.meta.tag:sourceSystem.system
    Definition

    The identification of the code system that defines the meaning of the symbol in the code.

    ShortIdentity of the terminology system
    Comments

    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

    Control10..1
    Typeuri
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Need to be unambiguous about the source of the definition of the symbol.

    Pattern Valuehttp://onemedical.com/terminology/source-system
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. Encounter.meta.tag:sourceSystem.code
    Definition

    A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

    ShortSymbol in syntax defined by the system
    Control10..1
    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Need to refer to a particular code in the system.

    Pattern Valueppv
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. Encounter.meta.tag:sourceSystem.display
    Definition

    A representation of the meaning of the code in the system, following the rules of the system.

    ShortRepresentation defined by the system
    Control10..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

    Pattern ValueOne Medical Pay-per-visit
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    24. Encounter.implicitRules
    Definition

    A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

    ShortA set of rules under which this content was created
    Comments

    Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

    Control0..1
    Typeuri
    Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    26. Encounter.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Summaryfalse
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    28. Encounter.identifier
    Definition

    Identifier(s) by which this encounter is known.

    ShortIdentifier(s) by which this encounter is known
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..*
    TypeIdentifier
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    30. Encounter.identifier.use
    Definition

    The purpose of this identifier.

    Shortusual | official | temp | secondary | old (If known)
    Comments

    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

    Control0..1
    BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

    Identifies the purpose for this identifier, if known .

    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    32. Encounter.identifier.system
    Definition

    Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

    ShortThe namespace for the identifier value
    Comments

    Identifier.system is always case sensitive.

    Control10..1
    Typeuri
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

    There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

    ExampleGeneral: http://www.acme.com/identifiers/patient
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    34. Encounter.identifier.value
    Definition

    The portion of the identifier typically relevant to the user and which is unique within the context of the system.

    ShortThe value that is unique
    Comments

    If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

    Control10..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    ExampleGeneral: 123456
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    36. Encounter.status
    Definition

    planned | arrived | triaged | in-progress | onleave | finished | cancelled +.

    Shortplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
    Comments

    Note that internal business rules will determine the appropriate transitions that may occur between statuses (and also classes).

    Control1..1
    BindingThe codes SHALL be taken from EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1
    (required to http://hl7.org/fhir/ValueSet/encounter-status|4.0.1)

    Current state of the encounter.

    Typecode
    Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Pattern Valuefinished
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    38. Encounter.class
    Definition

    Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.

    ShortClassification of patient encounter
    Control1..1
    BindingUnless not suitable, these codes SHALL be taken from ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode
    (extensible to http://terminology.hl7.org/ValueSet/v3-ActEncounterCode)

    Classification of the encounter.

    TypeCoding
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. Encounter.class.system
    Definition

    The identification of the code system that defines the meaning of the symbol in the code.

    ShortIdentity of the terminology system
    Comments

    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

    Control0..1
    Typeuri
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Need to be unambiguous about the source of the definition of the symbol.

    Pattern Valuehttp://onemedical.com/terminology
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    42. Encounter.class.code
    Definition

    A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

    ShortSymbol in syntax defined by the system
    Control0..1
    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Need to refer to a particular code in the system.

    Pattern ValueVR
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    44. Encounter.class.display
    Definition

    A representation of the meaning of the code in the system, following the rules of the system.

    ShortRepresentation defined by the system
    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

    Pattern Valuephone, video, or asynchronous
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    46. Encounter.type
    Definition

    Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).

    ShortSpecific type of encounter
    Comments

    Since there are many ways to further classify encounters, this element is 0..*.

    Control40..*
    BindingUnless not suitable, these codes SHALL be taken from For example codes, see US Core Encounter Typehttp://hl7.org/fhir/ValueSet/encounter-type|4.0.1
    (extensible to http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type)

    Valueset to describe the Encounter Type


    The type of encounter.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingThis element introduces a set of slices on Encounter.type. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ coding.system
    • 48. Encounter.type:encounterType
      Slice NameencounterType
      Definition

      Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).

      ShortSpecific type of encounter
      Comments

      Since there are many ways to further classify encounters, this element is 0..*.

      Control10..1*
      BindingUnless not suitable, these codes SHALL be taken from For example codes, see US Core Encounter Typehttp://hl7.org/fhir/ValueSet/encounter-type|4.0.1
      (extensible to http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type)

      Valueset to describe the Encounter Type


      The type of encounter.

      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      50. Encounter.type:encounterType.coding
      Definition

      A reference to a code defined by a terminology system.

      ShortCode defined by a terminology system
      Comments

      Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

      Control10..1*
      TypeCoding
      Is Modifierfalse
      Summarytrue
      Requirements

      Allows for alternative encodings within a code system, and translations to other code systems.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      52. Encounter.type:encounterType.coding.system
      Definition

      The identification of the code system that defines the meaning of the symbol in the code.

      ShortIdentity of the terminology system
      Comments

      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

      Control10..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Need to be unambiguous about the source of the definition of the symbol.

      Pattern Valuehttp://snomed.info/sct
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      54. Encounter.type:encounterType.coding.code
      Definition

      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

      ShortSymbol in syntax defined by the system
      Control10..1
      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Need to refer to a particular code in the system.

      Pattern Value185347001
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      56. Encounter.type:encounterType.coding.display
      Definition

      A representation of the meaning of the code in the system, following the rules of the system.

      ShortRepresentation defined by the system
      Control10..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

      Pattern ValueEncounter for problem
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      58. Encounter.type:virtualEncounterType
      Slice NamevirtualEncounterType
      Definition

      The type of virtual encounter. Valid code/display pairs: video/Video, messaging/Messaging.


      Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).

      ShortVirtual encounter typeSpecific type of encounter
      Comments

      Since there are many ways to further classify encounters, this element is 0..*.

      Control10..1*
      BindingUnless not suitable, these codes SHALL be taken from For example codes, see US Core Encounter Typehttp://hl7.org/fhir/ValueSet/encounter-type|4.0.1
      (extensible to http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type)

      Valueset to describe the Encounter Type


      The type of encounter.

      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      60. Encounter.type:virtualEncounterType.coding
      Definition

      A reference to a code defined by a terminology system.

      ShortCode defined by a terminology system
      Comments

      Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

      Control10..1*
      TypeCoding
      Is Modifierfalse
      Summarytrue
      Requirements

      Allows for alternative encodings within a code system, and translations to other code systems.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      62. Encounter.type:virtualEncounterType.coding.system
      Definition

      The identification of the code system that defines the meaning of the symbol in the code.

      ShortIdentity of the terminology system
      Comments

      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

      Control10..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Need to be unambiguous about the source of the definition of the symbol.

      Pattern Valuehttps://onemedical.com/terminology#virtual-encounter-type
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      64. Encounter.type:virtualEncounterType.coding.code
      Definition

      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

      ShortSymbol in syntax defined by the system: video | messaging
      Control10..1
      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Need to refer to a particular code in the system.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      66. Encounter.type:virtualEncounterType.coding.display
      Definition

      A representation of the meaning of the code in the system, following the rules of the system.

      ShortRepresentation defined by the system: Video | Messaging
      Control10..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      68. Encounter.type:schedulingType
      Slice NameschedulingType
      Definition

      Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).

      ShortSpecific type of encounter
      Comments

      Since there are many ways to further classify encounters, this element is 0..*.

      Control10..1*
      BindingUnless not suitable, these codes SHALL be taken from For example codes, see US Core Encounter Typehttp://hl7.org/fhir/ValueSet/encounter-type|4.0.1
      (extensible to http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type)

      Valueset to describe the Encounter Type


      The type of encounter.

      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      70. Encounter.type:schedulingType.coding
      Definition

      A reference to a code defined by a terminology system.

      ShortCode defined by a terminology system
      Comments

      Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

      Control10..1*
      TypeCoding
      Is Modifierfalse
      Summarytrue
      Requirements

      Allows for alternative encodings within a code system, and translations to other code systems.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      72. Encounter.type:schedulingType.coding.system
      Definition

      The identification of the code system that defines the meaning of the symbol in the code.

      ShortIdentity of the terminology system
      Comments

      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

      Control10..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Need to be unambiguous about the source of the definition of the symbol.

      Pattern Valuehttps://onemedical.com/terminology#scheduling-type
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      74. Encounter.type:schedulingType.coding.code
      Definition

      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

      ShortSymbol in syntax defined by the system
      Control10..1
      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Need to refer to a particular code in the system.

      Pattern Valueon-demand
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      76. Encounter.type:schedulingType.coding.display
      Definition

      A representation of the meaning of the code in the system, following the rules of the system.

      ShortRepresentation defined by the system
      Control10..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

      Pattern ValueOn-Demand
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      78. Encounter.type:virtualEncounterService
      Slice NamevirtualEncounterService
      Definition

      Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).

      ShortSpecific type of encounter
      Comments

      Since there are many ways to further classify encounters, this element is 0..*.

      Control10..1*
      BindingUnless not suitable, these codes SHALL be taken from For example codes, see US Core Encounter Typehttp://hl7.org/fhir/ValueSet/encounter-type|4.0.1
      (extensible to http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type)

      Valueset to describe the Encounter Type


      The type of encounter.

      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      80. Encounter.type:virtualEncounterService.coding
      Definition

      A reference to a code defined by a terminology system.

      ShortCode defined by a terminology system
      Comments

      Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

      Control10..1*
      TypeCoding
      Is Modifierfalse
      Summarytrue
      Requirements

      Allows for alternative encodings within a code system, and translations to other code systems.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      82. Encounter.type:virtualEncounterService.coding.system
      Definition

      The identification of the code system that defines the meaning of the symbol in the code.

      ShortIdentity of the terminology system
      Comments

      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

      Control10..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Need to be unambiguous about the source of the definition of the symbol.

      Pattern Valuehttps://onemedical.com/terminology#virtual-encounter-service
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      84. Encounter.type:virtualEncounterService.coding.code
      Definition

      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

      ShortSymbol in syntax defined by the system
      Control10..1
      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Need to refer to a particular code in the system.

      Pattern Valueppv
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      86. Encounter.type:virtualEncounterService.coding.display
      Definition

      A representation of the meaning of the code in the system, following the rules of the system.

      ShortRepresentation defined by the system
      Control10..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

      Pattern ValueOne Medical Pay-per-visit
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      88. Encounter.subject
      Definition

      The patient or group present at the encounter.

      ShortThe patient or group present at the encounter
      Comments

      While the encounter is always about the patient, the patient might not actually be known in all contexts of use, and there may be a group of patients that could be anonymous (such as in a group therapy for Alcoholics Anonymous - where the recording of the encounter could be used for billing on the number of people/staff and not important to the context of the specific patients) or alternately in veterinary care a herd of sheep receiving treatment (where the animals are not individually tracked).

      Control10..1
      TypeReference(PPVPatient, Patient, Group)
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Alternate Namespatient
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      90. Encounter.participant
      Definition

      The list of people responsible for providing the service.

      ShortList of participants involved in the encounter
      Control0..*
      TypeBackboneElement
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      92. Encounter.participant.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content, modifiers
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      94. Encounter.participant.type
      Definition

      Role of participant in encounter.

      ShortRole of participant in encounter
      Comments

      The participant type indicates how an individual participates in an encounter. It includes non-practitioner participants, and for practitioners this is to describe the action type in the context of this encounter (e.g. Admitting Dr, Attending Dr, Translator, Consulting Dr). This is different to the practitioner roles which are functional roles, derived from terms of employment, education, licensing, etc.

      Control0..*
      BindingUnless not suitable, these codes SHALL be taken from ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type|4.0.1
      (extensible to http://hl7.org/fhir/ValueSet/encounter-participant-type)

      Role of participant in encounter.

      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      96. Encounter.participant.period
      Definition

      The period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period.

      ShortPeriod of time during the encounter that the participant participated
      Control0..1
      TypePeriod
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      98. Encounter.participant.individual
      Definition

      Persons involved in the encounter other than the patient.

      ShortPersons involved in the encounter other than the patient
      Control10..1
      TypeReference(US Core Practitioner Profile, US Core PractitionerRole Profile, RelatedPerson, Practitioner, PractitionerRole, RelatedPerson)
      Is Modifierfalse
      Must Supporttrue
      Must Support TypesReference(US Core Practitioner Profile)
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      100. Encounter.period
      Definition

      The start and end time of the encounter.

      ShortThe start and end time of the encounter
      Comments

      If not (yet) known, the end of the Period may be omitted.

      Control0..1
      TypePeriod
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      102. Encounter.reasonCode
      Definition

      Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.

      ShortCoded reason the encounter takes place
      Comments

      For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).

      Control0..*
      BindingThe codes SHOULD be taken from EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason|4.0.1
      (preferred to http://hl7.org/fhir/ValueSet/encounter-reason)

      Reason why the encounter takes place.

      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Alternate NamesIndication, Admission diagnosis
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      104. Encounter.reasonReference
      Definition

      Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.

      ShortReason the encounter takes place (reference)
      Comments

      For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).

      Control0..1*
      TypeReference(US Core Condition Profile, US Core Procedure Profile, Observation, ImmunizationRecommendation, Condition, Procedure, Observation, ImmunizationRecommendation)
      Is Modifierfalse
      Must Supporttrue
      Must Support TypesReference(US Core Condition Profile)
      Summarytrue
      Alternate NamesIndication, Admission diagnosis
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      106. Encounter.hospitalization
      Definition

      Details about the admission to a healthcare service.

      ShortDetails about the admission to a healthcare service
      Comments

      An Encounter may cover more than just the inpatient stay. Contexts such as outpatients, community clinics, and aged care facilities are also included.

      The duration recorded in the period of this encounter covers the entire scope of this hospitalization record.

      Control0..1
      TypeBackboneElement
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      108. Encounter.hospitalization.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content, modifiers
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      110. Encounter.hospitalization.dischargeDisposition
      Definition

      Category or kind of location after discharge.

      ShortCategory or kind of location after discharge
      Control0..1
      BindingFor example codes, see DischargeDispositionhttp://hl7.org/fhir/ValueSet/encounter-discharge-disposition|4.0.1
      (example to http://hl7.org/fhir/ValueSet/encounter-discharge-disposition)

      Discharge Disposition.

      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      112. Encounter.location
      Definition

      List of locations where the patient has been during this encounter.

      ShortList of locations where the patient has been
      Comments

      Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type "kind" such as "client's home" and an encounter.class = "virtual".

      Control0..1*
      TypeBackboneElement
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      114. Encounter.location.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content, modifiers
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      116. Encounter.location.location
      Definition

      The location where the encounter takes place.

      ShortLocation the encounter takes place
      Control1..1
      TypeReference(Location, Location)
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      118. Encounter.serviceProvider
      Definition

      The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.

      ShortThe organization (facility) responsible for this encounter
      Control0..1
      TypeReference(US Core Organization Profile, Organization)
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

      Guidance on how to interpret the contents of this table can be foundhere

      0. Encounter
      Invariantsppv-virtual-encounter-type: 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())
      ppv-source-type-tag: 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-source-system-tag: 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-encounter-type: 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: 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-virtual-encounter-service: 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())
      2. Encounter.id
      Control1..?
      4. Encounter.meta
      Control1..?
      6. Encounter.meta.tag
      Control2..?
      SlicingThis element introduces a set of slices on Encounter.meta.tag. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ system
      • 8. Encounter.meta.tag:sourceType
        Slice NamesourceType
        Control1..1
        10. Encounter.meta.tag:sourceType.system
        Control1..?
        Pattern Valuehttp://onemedical.com/terminology/source-type
        12. Encounter.meta.tag:sourceType.code
        Control1..?
        Pattern Valueone-medical-collected
        14. Encounter.meta.tag:sourceType.display
        Control1..?
        Pattern ValueOne Medical Collected
        16. Encounter.meta.tag:sourceSystem
        Slice NamesourceSystem
        Control1..1
        18. Encounter.meta.tag:sourceSystem.system
        Control1..?
        Pattern Valuehttp://onemedical.com/terminology/source-system
        20. Encounter.meta.tag:sourceSystem.code
        Control1..?
        Pattern Valueppv
        22. Encounter.meta.tag:sourceSystem.display
        Control1..?
        Pattern ValueOne Medical Pay-per-visit
        24. Encounter.status
        Pattern Valuefinished
        26. Encounter.class
        28. Encounter.class.system
        Pattern Valuehttp://onemedical.com/terminology
        30. Encounter.class.code
        Pattern ValueVR
        32. Encounter.class.display
        Pattern Valuephone, video, or asynchronous
        34. Encounter.type
        Control4..?
        SlicingThis element introduces a set of slices on Encounter.type. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ coding.system
        • 36. Encounter.type:encounterType
          Slice NameencounterType
          Control1..1
          38. Encounter.type:encounterType.coding
          Control1..1
          40. Encounter.type:encounterType.coding.system
          Control1..?
          Pattern Valuehttp://snomed.info/sct
          42. Encounter.type:encounterType.coding.code
          Control1..?
          Pattern Value185347001
          44. Encounter.type:encounterType.coding.display
          Control1..?
          Pattern ValueEncounter for problem
          46. Encounter.type:virtualEncounterType
          Slice NamevirtualEncounterType
          Definition

          The type of virtual encounter. Valid code/display pairs: video/Video, messaging/Messaging.

          ShortVirtual encounter type
          Control1..1
          48. Encounter.type:virtualEncounterType.coding
          Control1..1
          50. Encounter.type:virtualEncounterType.coding.system
          Control1..?
          Pattern Valuehttps://onemedical.com/terminology#virtual-encounter-type
          52. Encounter.type:virtualEncounterType.coding.code
          ShortSymbol in syntax defined by the system: video | messaging
          Control1..?
          54. Encounter.type:virtualEncounterType.coding.display
          ShortRepresentation defined by the system: Video | Messaging
          Control1..?
          56. Encounter.type:schedulingType
          Slice NameschedulingType
          Control1..1
          58. Encounter.type:schedulingType.coding
          Control1..1
          60. Encounter.type:schedulingType.coding.system
          Control1..?
          Pattern Valuehttps://onemedical.com/terminology#scheduling-type
          62. Encounter.type:schedulingType.coding.code
          Control1..?
          Pattern Valueon-demand
          64. Encounter.type:schedulingType.coding.display
          Control1..?
          Pattern ValueOn-Demand
          66. Encounter.type:virtualEncounterService
          Slice NamevirtualEncounterService
          Control1..1
          68. Encounter.type:virtualEncounterService.coding
          Control1..1
          70. Encounter.type:virtualEncounterService.coding.system
          Control1..?
          Pattern Valuehttps://onemedical.com/terminology#virtual-encounter-service
          72. Encounter.type:virtualEncounterService.coding.code
          Control1..?
          Pattern Valueppv
          74. Encounter.type:virtualEncounterService.coding.display
          Control1..?
          Pattern ValueOne Medical Pay-per-visit
          76. Encounter.subject
          TypeReference(PPVPatient)
          78. Encounter.participant
          80. Encounter.participant.individual
          Control1..?
          82. Encounter.location
          Control0..1

          Guidance on how to interpret the contents of this table can be foundhere

          0. Encounter
          Definition

          This is basic constraint on Encounter for use in US Core resources.

          ShortAn interaction during which services are provided to the patient
          Control0..*
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Alternate NamesVisit
          Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
          dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
          dom-6: A resource should have narrative for robust management (text.`div`.exists())
          ppv-virtual-encounter-type: 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())
          ppv-source-type-tag: 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-source-system-tag: 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-encounter-type: 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: 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-virtual-encounter-service: 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())
          2. Encounter.id
          Definition

          The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

          ShortLogical id of this artifact
          Comments

          The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

          Control1..1
          Typeid
          Is Modifierfalse
          Summarytrue
          4. Encounter.meta
          Definition

          The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

          ShortMetadata about the resource
          Control1..1
          TypeMeta
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          6. Encounter.meta.id
          Definition

          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

          ShortUnique id for inter-element referencing
          Control0..1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          8. Encounter.meta.extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          ShortAdditional content defined by implementations
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          SlicingThis element introduces a set of slices on Encounter.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 10. Encounter.meta.versionId
            Definition

            The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

            ShortVersion specific identifier
            Comments

            The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

            Control0..1
            Typeid
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            12. Encounter.meta.lastUpdated
            Definition

            When the resource last changed - e.g. when the version changed.

            ShortWhen the resource version last changed
            Comments

            This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

            Control0..1
            Typeinstant
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            14. Encounter.meta.source
            Definition

            A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

            ShortIdentifies where the resource comes from
            Comments

            In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

            This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

            Control0..1
            Typeuri
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            16. Encounter.meta.profile
            Definition

            A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

            ShortProfiles this resource claims to conform to
            Comments

            It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

            Control0..*
            Typecanonical(StructureDefinition)
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            18. Encounter.meta.security
            Definition

            Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

            ShortSecurity Labels applied to this resource
            Comments

            The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

            Control0..*
            BindingUnless not suitable, these codes SHALL be taken from All Security Labels
            (extensible to http://hl7.org/fhir/ValueSet/security-labels|4.0.1)

            Security Labels from the Healthcare Privacy and Security Classification System.

            TypeCoding
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            20. Encounter.meta.tag
            Definition

            Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

            ShortTags applied to this resource
            Comments

            The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

            Control2..*
            BindingFor example codes, see CommonTags
            (example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)

            Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

            TypeCoding
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            SlicingThis element introduces a set of slices on Encounter.meta.tag. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ system
            • 22. Encounter.meta.tag:sourceType
              Slice NamesourceType
              Definition

              Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

              ShortTags applied to this resource
              Comments

              The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

              Control1..1
              BindingFor example codes, see CommonTags
              (example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)

              Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

              TypeCoding
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              24. Encounter.meta.tag:sourceType.id
              Definition

              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

              ShortUnique id for inter-element referencing
              Control0..1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              26. Encounter.meta.tag:sourceType.extension
              Definition

              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              ShortAdditional content defined by implementations
              Comments

              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              SlicingThis element introduces a set of slices on Encounter.meta.tag.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 28. Encounter.meta.tag:sourceType.system
                Definition

                The identification of the code system that defines the meaning of the symbol in the code.

                ShortIdentity of the terminology system
                Comments

                The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                Control1..1
                Typeuri
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Requirements

                Need to be unambiguous about the source of the definition of the symbol.

                Pattern Valuehttp://onemedical.com/terminology/source-type
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                30. Encounter.meta.tag:sourceType.version
                Definition

                The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                ShortVersion of the system - if relevant
                Comments

                Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                NoteThis is a business version Id, not a resource version Id (see discussion)
                Control0..1
                Typestring
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                32. Encounter.meta.tag:sourceType.code
                Definition

                A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                ShortSymbol in syntax defined by the system
                Control1..1
                Typecode
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Requirements

                Need to refer to a particular code in the system.

                Pattern Valueone-medical-collected
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                34. Encounter.meta.tag:sourceType.display
                Definition

                A representation of the meaning of the code in the system, following the rules of the system.

                ShortRepresentation defined by the system
                Control1..1
                Typestring
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Requirements

                Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                Pattern ValueOne Medical Collected
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                36. Encounter.meta.tag:sourceType.userSelected
                Definition

                Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                ShortIf this coding was chosen directly by the user
                Comments

                Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                Control0..1
                Typeboolean
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Requirements

                This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                38. Encounter.meta.tag:sourceSystem
                Slice NamesourceSystem
                Definition

                Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

                ShortTags applied to this resource
                Comments

                The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

                Control1..1
                BindingFor example codes, see CommonTags
                (example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)

                Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

                TypeCoding
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                40. Encounter.meta.tag:sourceSystem.id
                Definition

                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                ShortUnique id for inter-element referencing
                Control0..1
                Typestring
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                42. Encounter.meta.tag:sourceSystem.extension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                ShortAdditional content defined by implementations
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                SlicingThis element introduces a set of slices on Encounter.meta.tag.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 44. Encounter.meta.tag:sourceSystem.system
                  Definition

                  The identification of the code system that defines the meaning of the symbol in the code.

                  ShortIdentity of the terminology system
                  Comments

                  The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                  Control1..1
                  Typeuri
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  Need to be unambiguous about the source of the definition of the symbol.

                  Pattern Valuehttp://onemedical.com/terminology/source-system
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  46. Encounter.meta.tag:sourceSystem.version
                  Definition

                  The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                  ShortVersion of the system - if relevant
                  Comments

                  Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                  NoteThis is a business version Id, not a resource version Id (see discussion)
                  Control0..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  48. Encounter.meta.tag:sourceSystem.code
                  Definition

                  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                  ShortSymbol in syntax defined by the system
                  Control1..1
                  Typecode
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  Need to refer to a particular code in the system.

                  Pattern Valueppv
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  50. Encounter.meta.tag:sourceSystem.display
                  Definition

                  A representation of the meaning of the code in the system, following the rules of the system.

                  ShortRepresentation defined by the system
                  Control1..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                  Pattern ValueOne Medical Pay-per-visit
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  52. Encounter.meta.tag:sourceSystem.userSelected
                  Definition

                  Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                  ShortIf this coding was chosen directly by the user
                  Comments

                  Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                  Control0..1
                  Typeboolean
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  54. Encounter.implicitRules
                  Definition

                  A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                  ShortA set of rules under which this content was created
                  Comments

                  Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

                  Control0..1
                  Typeuri
                  Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  56. Encounter.language
                  Definition

                  The base language in which the resource is written.

                  ShortLanguage of the resource content
                  Comments

                  Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

                  Control0..1
                  BindingThe codes SHOULD be taken from CommonLanguages
                  (preferred to http://hl7.org/fhir/ValueSet/languages)

                  A human language.

                  Additional BindingsPurpose
                  AllLanguagesMax Binding
                  Typecode
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  58. Encounter.text
                  Definition

                  A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

                  ShortText summary of the resource, for human interpretation
                  Comments

                  Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

                  Control0..1
                  TypeNarrative
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesnarrative, html, xhtml, display
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  60. Encounter.contained
                  Definition

                  These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

                  ShortContained, inline Resources
                  Comments

                  This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

                  Control0..*
                  TypeResource
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesinline resources, anonymous resources, contained resources
                  62. Encounter.extension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  ShortAdditional content defined by implementations
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  64. Encounter.modifierExtension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                  ShortExtensions that cannot be ignored
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control0..*
                  TypeExtension
                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                  Summaryfalse
                  Requirements

                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  66. Encounter.identifier
                  Definition

                  Identifier(s) by which this encounter is known.

                  ShortIdentifier(s) by which this encounter is known
                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Control0..*
                  TypeIdentifier
                  Is Modifierfalse
                  Must Supporttrue
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  68. Encounter.identifier.id
                  Definition

                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  ShortUnique id for inter-element referencing
                  Control0..1
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  70. Encounter.identifier.extension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  ShortAdditional content defined by implementations
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  SlicingThis element introduces a set of slices on Encounter.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 72. Encounter.identifier.use
                    Definition

                    The purpose of this identifier.

                    Shortusual | official | temp | secondary | old (If known)
                    Comments

                    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                    Control0..1
                    BindingThe codes SHALL be taken from IdentifierUse
                    (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                    Identifies the purpose for this identifier, if known .

                    Typecode
                    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

                    Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    74. Encounter.identifier.type
                    Definition

                    A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                    ShortDescription of identifier
                    Comments

                    This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                    Control0..1
                    BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                    (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

                    A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Summarytrue
                    Requirements

                    Allows users to make use of identifiers when the identifier system is not known.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    76. Encounter.identifier.system
                    Definition

                    Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                    ShortThe namespace for the identifier value
                    Comments

                    Identifier.system is always case sensitive.

                    Control1..1
                    Typeuri
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supporttrue
                    Summarytrue
                    Requirements

                    There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                    ExampleGeneral: http://www.acme.com/identifiers/patient
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    78. Encounter.identifier.value
                    Definition

                    The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                    ShortThe value that is unique
                    Comments

                    If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                    Control1..1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supporttrue
                    Summarytrue
                    ExampleGeneral: 123456
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    80. Encounter.identifier.period
                    Definition

                    Time period during which identifier is/was valid for use.

                    ShortTime period when id is/was valid for use
                    Control0..1
                    TypePeriod
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    82. Encounter.identifier.assigner
                    Definition

                    Organization that issued/manages the identifier.

                    ShortOrganization that issued id (may be just text)
                    Comments

                    The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                    Control0..1
                    TypeReference(Organization)
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    84. Encounter.status
                    Definition

                    planned | arrived | triaged | in-progress | onleave | finished | cancelled +.

                    Shortplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
                    Comments

                    Note that internal business rules will determine the appropriate transitions that may occur between statuses (and also classes).

                    Control1..1
                    BindingThe codes SHALL be taken from EncounterStatus
                    (required to http://hl7.org/fhir/ValueSet/encounter-status|4.0.1)

                    Current state of the encounter.

                    Typecode
                    Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supporttrue
                    Summarytrue
                    Pattern Valuefinished
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    86. Encounter.statusHistory
                    Definition

                    The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.

                    ShortList of past encounter statuses
                    Comments

                    The current status is always found in the current version of the resource, not the status history.

                    Control0..*
                    TypeBackboneElement
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    88. Encounter.statusHistory.id
                    Definition

                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    90. Encounter.statusHistory.extension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortAdditional content defined by implementations
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesextensions, user content
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    92. Encounter.statusHistory.modifierExtension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                    Summarytrue
                    Requirements

                    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                    Alternate Namesextensions, user content, modifiers
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    94. Encounter.statusHistory.status
                    Definition

                    planned | arrived | triaged | in-progress | onleave | finished | cancelled +.

                    Shortplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
                    Control1..1
                    BindingThe codes SHALL be taken from EncounterStatus
                    (required to http://hl7.org/fhir/ValueSet/encounter-status|4.0.1)

                    Current state of the encounter.

                    Typecode
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    96. Encounter.statusHistory.period
                    Definition

                    The time that the episode was in the specified status.

                    ShortThe time that the episode was in the specified status
                    Control1..1
                    TypePeriod
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    98. Encounter.class
                    Definition

                    Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.

                    ShortClassification of patient encounter
                    Control1..1
                    BindingUnless not suitable, these codes SHALL be taken from ActEncounterCode
                    (extensible to http://terminology.hl7.org/ValueSet/v3-ActEncounterCode)

                    Classification of the encounter.

                    TypeCoding
                    Is Modifierfalse
                    Must Supporttrue
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    100. Encounter.class.id
                    Definition

                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    102. Encounter.class.extension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortAdditional content defined by implementations
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesextensions, user content
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    SlicingThis element introduces a set of slices on Encounter.class.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 104. Encounter.class.system
                      Definition

                      The identification of the code system that defines the meaning of the symbol in the code.

                      ShortIdentity of the terminology system
                      Comments

                      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                      Control0..1
                      Typeuri
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Need to be unambiguous about the source of the definition of the symbol.

                      Pattern Valuehttp://onemedical.com/terminology
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      106. Encounter.class.version
                      Definition

                      The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                      ShortVersion of the system - if relevant
                      Comments

                      Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                      NoteThis is a business version Id, not a resource version Id (see discussion)
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      108. Encounter.class.code
                      Definition

                      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                      ShortSymbol in syntax defined by the system
                      Control0..1
                      Typecode
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Need to refer to a particular code in the system.

                      Pattern ValueVR
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      110. Encounter.class.display
                      Definition

                      A representation of the meaning of the code in the system, following the rules of the system.

                      ShortRepresentation defined by the system
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                      Pattern Valuephone, video, or asynchronous
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      112. Encounter.class.userSelected
                      Definition

                      Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                      ShortIf this coding was chosen directly by the user
                      Comments

                      Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                      Control0..1
                      Typeboolean
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      114. Encounter.classHistory
                      Definition

                      The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient.

                      ShortList of past encounter classes
                      Control0..*
                      TypeBackboneElement
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      116. Encounter.classHistory.id
                      Definition

                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                      ShortUnique id for inter-element referencing
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      118. Encounter.classHistory.extension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                      ShortAdditional content defined by implementations
                      Comments

                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                      Control0..*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Alternate Namesextensions, user content
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      120. Encounter.classHistory.modifierExtension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                      ShortExtensions that cannot be ignored even if unrecognized
                      Comments

                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                      Control0..*
                      TypeExtension
                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                      Summarytrue
                      Requirements

                      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                      Alternate Namesextensions, user content, modifiers
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      122. Encounter.classHistory.class
                      Definition

                      inpatient | outpatient | ambulatory | emergency +.

                      Shortinpatient | outpatient | ambulatory | emergency +
                      Control1..1
                      BindingUnless not suitable, these codes SHALL be taken from ActEncounterCode
                      (extensible to http://terminology.hl7.org/ValueSet/v3-ActEncounterCode)

                      Classification of the encounter.

                      TypeCoding
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      124. Encounter.classHistory.period
                      Definition

                      The time that the episode was in the specified class.

                      ShortThe time that the episode was in the specified class
                      Control1..1
                      TypePeriod
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      126. Encounter.type
                      Definition

                      Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).

                      ShortSpecific type of encounter
                      Comments

                      Since there are many ways to further classify encounters, this element is 0..*.

                      Control4..*
                      BindingUnless not suitable, these codes SHALL be taken from US Core Encounter Type
                      (extensible to http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type)

                      Valueset to describe the Encounter Type

                      TypeCodeableConcept
                      Is Modifierfalse
                      Must Supporttrue
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      SlicingThis element introduces a set of slices on Encounter.type. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ coding.system
                      • 128. Encounter.type:encounterType
                        Slice NameencounterType
                        Definition

                        Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).

                        ShortSpecific type of encounter
                        Comments

                        Since there are many ways to further classify encounters, this element is 0..*.

                        Control1..1
                        BindingUnless not suitable, these codes SHALL be taken from US Core Encounter Type
                        (extensible to http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type)

                        Valueset to describe the Encounter Type

                        TypeCodeableConcept
                        Is Modifierfalse
                        Must Supporttrue
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        130. Encounter.type:encounterType.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        132. Encounter.type:encounterType.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        ShortAdditional content defined by implementations
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        SlicingThis element introduces a set of slices on Encounter.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 134. Encounter.type:encounterType.coding
                          Definition

                          A reference to a code defined by a terminology system.

                          ShortCode defined by a terminology system
                          Comments

                          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                          Control1..1
                          TypeCoding
                          Is Modifierfalse
                          Summarytrue
                          Requirements

                          Allows for alternative encodings within a code system, and translations to other code systems.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          136. Encounter.type:encounterType.coding.id
                          Definition

                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                          ShortUnique id for inter-element referencing
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          138. Encounter.type:encounterType.coding.extension
                          Definition

                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                          ShortAdditional content defined by implementations
                          Comments

                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                          Control0..*
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Alternate Namesextensions, user content
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          SlicingThis element introduces a set of slices on Encounter.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 140. Encounter.type:encounterType.coding.system
                            Definition

                            The identification of the code system that defines the meaning of the symbol in the code.

                            ShortIdentity of the terminology system
                            Comments

                            The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                            Control1..1
                            Typeuri
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            Need to be unambiguous about the source of the definition of the symbol.

                            Pattern Valuehttp://snomed.info/sct
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            142. Encounter.type:encounterType.coding.version
                            Definition

                            The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                            ShortVersion of the system - if relevant
                            Comments

                            Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                            NoteThis is a business version Id, not a resource version Id (see discussion)
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            144. Encounter.type:encounterType.coding.code
                            Definition

                            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                            ShortSymbol in syntax defined by the system
                            Control1..1
                            Typecode
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            Need to refer to a particular code in the system.

                            Pattern Value185347001
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            146. Encounter.type:encounterType.coding.display
                            Definition

                            A representation of the meaning of the code in the system, following the rules of the system.

                            ShortRepresentation defined by the system
                            Control1..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                            Pattern ValueEncounter for problem
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            148. Encounter.type:encounterType.coding.userSelected
                            Definition

                            Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                            ShortIf this coding was chosen directly by the user
                            Comments

                            Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                            Control0..1
                            Typeboolean
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            150. Encounter.type:encounterType.text
                            Definition

                            A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                            ShortPlain text representation of the concept
                            Comments

                            Very often the text is the same as a displayName of one of the codings.

                            Control0..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            152. Encounter.type:virtualEncounterType
                            Slice NamevirtualEncounterType
                            Definition

                            The type of virtual encounter. Valid code/display pairs: video/Video, messaging/Messaging.

                            ShortVirtual encounter type
                            Comments

                            Since there are many ways to further classify encounters, this element is 0..*.

                            Control1..1
                            BindingUnless not suitable, these codes SHALL be taken from US Core Encounter Type
                            (extensible to http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type)

                            Valueset to describe the Encounter Type

                            TypeCodeableConcept
                            Is Modifierfalse
                            Must Supporttrue
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            154. Encounter.type:virtualEncounterType.id
                            Definition

                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                            ShortUnique id for inter-element referencing
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            156. Encounter.type:virtualEncounterType.extension
                            Definition

                            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                            ShortAdditional content defined by implementations
                            Comments

                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                            Control0..*
                            TypeExtension
                            Is Modifierfalse
                            Summaryfalse
                            Alternate Namesextensions, user content
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            SlicingThis element introduces a set of slices on Encounter.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 158. Encounter.type:virtualEncounterType.coding
                              Definition

                              A reference to a code defined by a terminology system.

                              ShortCode defined by a terminology system
                              Comments

                              Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                              Control1..1
                              TypeCoding
                              Is Modifierfalse
                              Summarytrue
                              Requirements

                              Allows for alternative encodings within a code system, and translations to other code systems.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              160. Encounter.type:virtualEncounterType.coding.id
                              Definition

                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                              ShortUnique id for inter-element referencing
                              Control0..1
                              Typestring
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              162. Encounter.type:virtualEncounterType.coding.extension
                              Definition

                              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                              ShortAdditional content defined by implementations
                              Comments

                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                              Control0..*
                              TypeExtension
                              Is Modifierfalse
                              Summaryfalse
                              Alternate Namesextensions, user content
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              SlicingThis element introduces a set of slices on Encounter.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 164. Encounter.type:virtualEncounterType.coding.system
                                Definition

                                The identification of the code system that defines the meaning of the symbol in the code.

                                ShortIdentity of the terminology system
                                Comments

                                The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                Control1..1
                                Typeuri
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Requirements

                                Need to be unambiguous about the source of the definition of the symbol.

                                Pattern Valuehttps://onemedical.com/terminology#virtual-encounter-type
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                166. Encounter.type:virtualEncounterType.coding.version
                                Definition

                                The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                ShortVersion of the system - if relevant
                                Comments

                                Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                NoteThis is a business version Id, not a resource version Id (see discussion)
                                Control0..1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                168. Encounter.type:virtualEncounterType.coding.code
                                Definition

                                A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                ShortSymbol in syntax defined by the system: video | messaging
                                Control1..1
                                Typecode
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Requirements

                                Need to refer to a particular code in the system.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                170. Encounter.type:virtualEncounterType.coding.display
                                Definition

                                A representation of the meaning of the code in the system, following the rules of the system.

                                ShortRepresentation defined by the system: Video | Messaging
                                Control1..1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Requirements

                                Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                172. Encounter.type:virtualEncounterType.coding.userSelected
                                Definition

                                Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                ShortIf this coding was chosen directly by the user
                                Comments

                                Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                Control0..1
                                Typeboolean
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Requirements

                                This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                174. Encounter.type:virtualEncounterType.text
                                Definition

                                A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                ShortPlain text representation of the concept
                                Comments

                                Very often the text is the same as a displayName of one of the codings.

                                Control0..1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Requirements

                                The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                176. Encounter.type:schedulingType
                                Slice NameschedulingType
                                Definition

                                Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).

                                ShortSpecific type of encounter
                                Comments

                                Since there are many ways to further classify encounters, this element is 0..*.

                                Control1..1
                                BindingUnless not suitable, these codes SHALL be taken from US Core Encounter Type
                                (extensible to http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type)

                                Valueset to describe the Encounter Type

                                TypeCodeableConcept
                                Is Modifierfalse
                                Must Supporttrue
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                178. Encounter.type:schedulingType.id
                                Definition

                                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                ShortUnique id for inter-element referencing
                                Control0..1
                                Typestring
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                180. Encounter.type:schedulingType.extension
                                Definition

                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                ShortAdditional content defined by implementations
                                Comments

                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                Control0..*
                                TypeExtension
                                Is Modifierfalse
                                Summaryfalse
                                Alternate Namesextensions, user content
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                SlicingThis element introduces a set of slices on Encounter.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 182. Encounter.type:schedulingType.coding
                                  Definition

                                  A reference to a code defined by a terminology system.

                                  ShortCode defined by a terminology system
                                  Comments

                                  Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                  Control1..1
                                  TypeCoding
                                  Is Modifierfalse
                                  Summarytrue
                                  Requirements

                                  Allows for alternative encodings within a code system, and translations to other code systems.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  184. Encounter.type:schedulingType.coding.id
                                  Definition

                                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                  ShortUnique id for inter-element referencing
                                  Control0..1
                                  Typestring
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  186. Encounter.type:schedulingType.coding.extension
                                  Definition

                                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                  ShortAdditional content defined by implementations
                                  Comments

                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                  Control0..*
                                  TypeExtension
                                  Is Modifierfalse
                                  Summaryfalse
                                  Alternate Namesextensions, user content
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  SlicingThis element introduces a set of slices on Encounter.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 188. Encounter.type:schedulingType.coding.system
                                    Definition

                                    The identification of the code system that defines the meaning of the symbol in the code.

                                    ShortIdentity of the terminology system
                                    Comments

                                    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                    Control1..1
                                    Typeuri
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Requirements

                                    Need to be unambiguous about the source of the definition of the symbol.

                                    Pattern Valuehttps://onemedical.com/terminology#scheduling-type
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    190. Encounter.type:schedulingType.coding.version
                                    Definition

                                    The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                    ShortVersion of the system - if relevant
                                    Comments

                                    Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                    NoteThis is a business version Id, not a resource version Id (see discussion)
                                    Control0..1
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    192. Encounter.type:schedulingType.coding.code
                                    Definition

                                    A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                    ShortSymbol in syntax defined by the system
                                    Control1..1
                                    Typecode
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Requirements

                                    Need to refer to a particular code in the system.

                                    Pattern Valueon-demand
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    194. Encounter.type:schedulingType.coding.display
                                    Definition

                                    A representation of the meaning of the code in the system, following the rules of the system.

                                    ShortRepresentation defined by the system
                                    Control1..1
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Requirements

                                    Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                    Pattern ValueOn-Demand
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    196. Encounter.type:schedulingType.coding.userSelected
                                    Definition

                                    Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                    ShortIf this coding was chosen directly by the user
                                    Comments

                                    Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                    Control0..1
                                    Typeboolean
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Requirements

                                    This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    198. Encounter.type:schedulingType.text
                                    Definition

                                    A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                    ShortPlain text representation of the concept
                                    Comments

                                    Very often the text is the same as a displayName of one of the codings.

                                    Control0..1
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Requirements

                                    The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    200. Encounter.type:virtualEncounterService
                                    Slice NamevirtualEncounterService
                                    Definition

                                    Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).

                                    ShortSpecific type of encounter
                                    Comments

                                    Since there are many ways to further classify encounters, this element is 0..*.

                                    Control1..1
                                    BindingUnless not suitable, these codes SHALL be taken from US Core Encounter Type
                                    (extensible to http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type)

                                    Valueset to describe the Encounter Type

                                    TypeCodeableConcept
                                    Is Modifierfalse
                                    Must Supporttrue
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    202. Encounter.type:virtualEncounterService.id
                                    Definition

                                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                    ShortUnique id for inter-element referencing
                                    Control0..1
                                    Typestring
                                    Is Modifierfalse
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    Summaryfalse
                                    204. Encounter.type:virtualEncounterService.extension
                                    Definition

                                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                    ShortAdditional content defined by implementations
                                    Comments

                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                    Control0..*
                                    TypeExtension
                                    Is Modifierfalse
                                    Summaryfalse
                                    Alternate Namesextensions, user content
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                    SlicingThis element introduces a set of slices on Encounter.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 206. Encounter.type:virtualEncounterService.coding
                                      Definition

                                      A reference to a code defined by a terminology system.

                                      ShortCode defined by a terminology system
                                      Comments

                                      Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                      Control1..1
                                      TypeCoding
                                      Is Modifierfalse
                                      Summarytrue
                                      Requirements

                                      Allows for alternative encodings within a code system, and translations to other code systems.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      208. Encounter.type:virtualEncounterService.coding.id
                                      Definition

                                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                      ShortUnique id for inter-element referencing
                                      Control0..1
                                      Typestring
                                      Is Modifierfalse
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      Summaryfalse
                                      210. Encounter.type:virtualEncounterService.coding.extension
                                      Definition

                                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                      ShortAdditional content defined by implementations
                                      Comments

                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                      Control0..*
                                      TypeExtension
                                      Is Modifierfalse
                                      Summaryfalse
                                      Alternate Namesextensions, user content
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      SlicingThis element introduces a set of slices on Encounter.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 212. Encounter.type:virtualEncounterService.coding.system
                                        Definition

                                        The identification of the code system that defines the meaning of the symbol in the code.

                                        ShortIdentity of the terminology system
                                        Comments

                                        The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                        Control1..1
                                        Typeuri
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Requirements

                                        Need to be unambiguous about the source of the definition of the symbol.

                                        Pattern Valuehttps://onemedical.com/terminology#virtual-encounter-service
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        214. Encounter.type:virtualEncounterService.coding.version
                                        Definition

                                        The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                        ShortVersion of the system - if relevant
                                        Comments

                                        Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                        NoteThis is a business version Id, not a resource version Id (see discussion)
                                        Control0..1
                                        Typestring
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        216. Encounter.type:virtualEncounterService.coding.code
                                        Definition

                                        A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                        ShortSymbol in syntax defined by the system
                                        Control1..1
                                        Typecode
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Requirements

                                        Need to refer to a particular code in the system.

                                        Pattern Valueppv
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        218. Encounter.type:virtualEncounterService.coding.display
                                        Definition

                                        A representation of the meaning of the code in the system, following the rules of the system.

                                        ShortRepresentation defined by the system
                                        Control1..1
                                        Typestring
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Requirements

                                        Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                        Pattern ValueOne Medical Pay-per-visit
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        220. Encounter.type:virtualEncounterService.coding.userSelected
                                        Definition

                                        Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                        ShortIf this coding was chosen directly by the user
                                        Comments

                                        Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                        Control0..1
                                        Typeboolean
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Requirements

                                        This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        222. Encounter.type:virtualEncounterService.text
                                        Definition

                                        A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                        ShortPlain text representation of the concept
                                        Comments

                                        Very often the text is the same as a displayName of one of the codings.

                                        Control0..1
                                        Typestring
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Requirements

                                        The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        224. Encounter.serviceType
                                        Definition

                                        Broad categorization of the service that is to be provided (e.g. cardiology).

                                        ShortSpecific type of service
                                        Control0..1
                                        BindingFor example codes, see ServiceType
                                        (example to http://hl7.org/fhir/ValueSet/service-type)

                                        Broad categorization of the service that is to be provided.

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summarytrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        226. Encounter.priority
                                        Definition

                                        Indicates the urgency of the encounter.

                                        ShortIndicates the urgency of the encounter
                                        Control0..1
                                        BindingFor example codes, see ActPriority
                                        (example to http://terminology.hl7.org/ValueSet/v3-ActPriority)

                                        Indicates the urgency of the encounter.

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        228. Encounter.subject
                                        Definition

                                        The patient or group present at the encounter.

                                        ShortThe patient or group present at the encounter
                                        Comments

                                        While the encounter is always about the patient, the patient might not actually be known in all contexts of use, and there may be a group of patients that could be anonymous (such as in a group therapy for Alcoholics Anonymous - where the recording of the encounter could be used for billing on the number of people/staff and not important to the context of the specific patients) or alternately in veterinary care a herd of sheep receiving treatment (where the animals are not individually tracked).

                                        Control1..1
                                        TypeReference(PPVPatient)
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Summarytrue
                                        Alternate Namespatient
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        230. Encounter.episodeOfCare
                                        Definition

                                        Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).

                                        ShortEpisode(s) of care that this encounter should be recorded against
                                        Control0..*
                                        TypeReference(EpisodeOfCare)
                                        Is Modifierfalse
                                        Summarytrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        232. Encounter.basedOn
                                        Definition

                                        The request this encounter satisfies (e.g. incoming referral or procedure request).

                                        ShortThe ServiceRequest that initiated this encounter
                                        Control0..*
                                        TypeReference(ServiceRequest)
                                        Is Modifierfalse
                                        Summaryfalse
                                        Alternate NamesincomingReferral
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        234. Encounter.participant
                                        Definition

                                        The list of people responsible for providing the service.

                                        ShortList of participants involved in the encounter
                                        Control0..*
                                        TypeBackboneElement
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Summarytrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        236. Encounter.participant.id
                                        Definition

                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                        ShortUnique id for inter-element referencing
                                        Control0..1
                                        Typestring
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        238. Encounter.participant.extension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                        ShortAdditional content defined by implementations
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                        Control0..*
                                        TypeExtension
                                        Is Modifierfalse
                                        Summaryfalse
                                        Alternate Namesextensions, user content
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        240. Encounter.participant.modifierExtension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                        ShortExtensions that cannot be ignored even if unrecognized
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                        Control0..*
                                        TypeExtension
                                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                        Summarytrue
                                        Requirements

                                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                        Alternate Namesextensions, user content, modifiers
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        242. Encounter.participant.type
                                        Definition

                                        Role of participant in encounter.

                                        ShortRole of participant in encounter
                                        Comments

                                        The participant type indicates how an individual participates in an encounter. It includes non-practitioner participants, and for practitioners this is to describe the action type in the context of this encounter (e.g. Admitting Dr, Attending Dr, Translator, Consulting Dr). This is different to the practitioner roles which are functional roles, derived from terms of employment, education, licensing, etc.

                                        Control0..*
                                        BindingUnless not suitable, these codes SHALL be taken from ParticipantType
                                        (extensible to http://hl7.org/fhir/ValueSet/encounter-participant-type)

                                        Role of participant in encounter.

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Summarytrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        244. Encounter.participant.period
                                        Definition

                                        The period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period.

                                        ShortPeriod of time during the encounter that the participant participated
                                        Control0..1
                                        TypePeriod
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        246. Encounter.participant.individual
                                        Definition

                                        Persons involved in the encounter other than the patient.

                                        ShortPersons involved in the encounter other than the patient
                                        Control1..1
                                        TypeReference(US Core Practitioner Profile, US Core PractitionerRole Profile, RelatedPerson)
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Must Support TypesReference(US Core Practitioner Profile)
                                        Summarytrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        248. Encounter.appointment
                                        Definition

                                        The appointment that scheduled this encounter.

                                        ShortThe appointment that scheduled this encounter
                                        Control0..*
                                        TypeReference(Appointment)
                                        Is Modifierfalse
                                        Summarytrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        250. Encounter.period
                                        Definition

                                        The start and end time of the encounter.

                                        ShortThe start and end time of the encounter
                                        Comments

                                        If not (yet) known, the end of the Period may be omitted.

                                        Control0..1
                                        TypePeriod
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        252. Encounter.length
                                        Definition

                                        Quantity of time the encounter lasted. This excludes the time during leaves of absence.

                                        ShortQuantity of time the encounter lasted (less time absent)
                                        Comments

                                        May differ from the time the Encounter.period lasted because of leave of absence.

                                        Control0..1
                                        TypeDuration
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        254. Encounter.reasonCode
                                        Definition

                                        Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.

                                        ShortCoded reason the encounter takes place
                                        Comments

                                        For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).

                                        Control0..*
                                        BindingThe codes SHOULD be taken from EncounterReasonCodes
                                        (preferred to http://hl7.org/fhir/ValueSet/encounter-reason)

                                        Reason why the encounter takes place.

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Summarytrue
                                        Alternate NamesIndication, Admission diagnosis
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        256. Encounter.reasonReference
                                        Definition

                                        Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.

                                        ShortReason the encounter takes place (reference)
                                        Comments

                                        For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).

                                        Control0..1
                                        TypeReference(US Core Condition Profile, US Core Procedure Profile, Observation, ImmunizationRecommendation)
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Must Support TypesReference(US Core Condition Profile)
                                        Summarytrue
                                        Alternate NamesIndication, Admission diagnosis
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        258. Encounter.diagnosis
                                        Definition

                                        The list of diagnosis relevant to this encounter.

                                        ShortThe list of diagnosis relevant to this encounter
                                        Control0..*
                                        TypeBackboneElement
                                        Is Modifierfalse
                                        Summarytrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        260. Encounter.diagnosis.id
                                        Definition

                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                        ShortUnique id for inter-element referencing
                                        Control0..1
                                        Typestring
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        262. Encounter.diagnosis.extension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                        ShortAdditional content defined by implementations
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                        Control0..*
                                        TypeExtension
                                        Is Modifierfalse
                                        Summaryfalse
                                        Alternate Namesextensions, user content
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        264. Encounter.diagnosis.modifierExtension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                        ShortExtensions that cannot be ignored even if unrecognized
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                        Control0..*
                                        TypeExtension
                                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                        Summarytrue
                                        Requirements

                                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                        Alternate Namesextensions, user content, modifiers
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        266. Encounter.diagnosis.condition
                                        Definition

                                        Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.

                                        ShortThe diagnosis or procedure relevant to the encounter
                                        Comments

                                        For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).

                                        Control1..1
                                        TypeReference(Condition, Procedure)
                                        Is Modifierfalse
                                        Summarytrue
                                        Alternate NamesAdmission diagnosis, discharge diagnosis, indication
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        268. Encounter.diagnosis.use
                                        Definition

                                        Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …).

                                        ShortRole that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
                                        Control0..1
                                        BindingThe codes SHOULD be taken from DiagnosisRole
                                        (preferred to http://hl7.org/fhir/ValueSet/diagnosis-role)

                                        The type of diagnosis this condition represents.

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        270. Encounter.diagnosis.rank
                                        Definition

                                        Ranking of the diagnosis (for each role type).

                                        ShortRanking of the diagnosis (for each role type)
                                        Control0..1
                                        TypepositiveInt
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        272. Encounter.account
                                        Definition

                                        The set of accounts that may be used for billing for this Encounter.

                                        ShortThe set of accounts that may be used for billing for this Encounter
                                        Comments

                                        The billing system may choose to allocate billable items associated with the Encounter to different referenced Accounts based on internal business rules.

                                        Control0..*
                                        TypeReference(Account)
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        274. Encounter.hospitalization
                                        Definition

                                        Details about the admission to a healthcare service.

                                        ShortDetails about the admission to a healthcare service
                                        Comments

                                        An Encounter may cover more than just the inpatient stay. Contexts such as outpatients, community clinics, and aged care facilities are also included.

                                        The duration recorded in the period of this encounter covers the entire scope of this hospitalization record.

                                        Control0..1
                                        TypeBackboneElement
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        276. Encounter.hospitalization.id
                                        Definition

                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                        ShortUnique id for inter-element referencing
                                        Control0..1
                                        Typestring
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        278. Encounter.hospitalization.extension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                        ShortAdditional content defined by implementations
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                        Control0..*
                                        TypeExtension
                                        Is Modifierfalse
                                        Summaryfalse
                                        Alternate Namesextensions, user content
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        280. Encounter.hospitalization.modifierExtension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                        ShortExtensions that cannot be ignored even if unrecognized
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                        Control0..*
                                        TypeExtension
                                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                        Summarytrue
                                        Requirements

                                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                        Alternate Namesextensions, user content, modifiers
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        282. Encounter.hospitalization.preAdmissionIdentifier
                                        Definition

                                        Pre-admission identifier.

                                        ShortPre-admission identifier
                                        Control0..1
                                        TypeIdentifier
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        284. Encounter.hospitalization.origin
                                        Definition

                                        The location/organization from which the patient came before admission.

                                        ShortThe location/organization from which the patient came before admission
                                        Control0..1
                                        TypeReference(Location, Organization)
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        286. Encounter.hospitalization.admitSource
                                        Definition

                                        From where patient was admitted (physician referral, transfer).

                                        ShortFrom where patient was admitted (physician referral, transfer)
                                        Control0..1
                                        BindingThe codes SHOULD be taken from AdmitSource
                                        (preferred to http://hl7.org/fhir/ValueSet/encounter-admit-source)

                                        From where the patient was admitted.

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        288. Encounter.hospitalization.reAdmission
                                        Definition

                                        Whether this hospitalization is a readmission and why if known.

                                        ShortThe type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
                                        Control0..1
                                        BindingFor example codes, see hl7VS-re-admissionIndicator
                                        (example to http://terminology.hl7.org/ValueSet/v2-0092)

                                        The reason for re-admission of this hospitalization encounter.

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        290. Encounter.hospitalization.dietPreference
                                        Definition

                                        Diet preferences reported by the patient.

                                        ShortDiet preferences reported by the patient
                                        Comments

                                        For example, a patient may request both a dairy-free and nut-free diet preference (not mutually exclusive).

                                        Control0..*
                                        BindingFor example codes, see Diet
                                        (example to http://hl7.org/fhir/ValueSet/encounter-diet)

                                        Medical, cultural or ethical food preferences to help with catering requirements.

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summaryfalse
                                        Requirements

                                        Used to track patient's diet restrictions and/or preference. For a complete description of the nutrition needs of a patient during their stay, one should use the nutritionOrder resource which links to Encounter.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        292. Encounter.hospitalization.specialCourtesy
                                        Definition

                                        Special courtesies (VIP, board member).

                                        ShortSpecial courtesies (VIP, board member)
                                        Control0..*
                                        BindingThe codes SHOULD be taken from SpecialCourtesy
                                        (preferred to http://hl7.org/fhir/ValueSet/encounter-special-courtesy)

                                        Special courtesies.

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        294. Encounter.hospitalization.specialArrangement
                                        Definition

                                        Any special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things.

                                        ShortWheelchair, translator, stretcher, etc.
                                        Control0..*
                                        BindingThe codes SHOULD be taken from SpecialArrangements
                                        (preferred to http://hl7.org/fhir/ValueSet/encounter-special-arrangements)

                                        Special arrangements.

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        296. Encounter.hospitalization.destination
                                        Definition

                                        Location/organization to which the patient is discharged.

                                        ShortLocation/organization to which the patient is discharged
                                        Control0..1
                                        TypeReference(Location, Organization)
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        298. Encounter.hospitalization.dischargeDisposition
                                        Definition

                                        Category or kind of location after discharge.

                                        ShortCategory or kind of location after discharge
                                        Control0..1
                                        BindingFor example codes, see DischargeDisposition
                                        (example to http://hl7.org/fhir/ValueSet/encounter-discharge-disposition)

                                        Discharge Disposition.

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        300. Encounter.location
                                        Definition

                                        List of locations where the patient has been during this encounter.

                                        ShortList of locations where the patient has been
                                        Comments

                                        Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type "kind" such as "client's home" and an encounter.class = "virtual".

                                        Control0..1
                                        TypeBackboneElement
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        302. Encounter.location.id
                                        Definition

                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                        ShortUnique id for inter-element referencing
                                        Control0..1
                                        Typestring
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        304. Encounter.location.extension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                        ShortAdditional content defined by implementations
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                        Control0..*
                                        TypeExtension
                                        Is Modifierfalse
                                        Summaryfalse
                                        Alternate Namesextensions, user content
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        306. Encounter.location.modifierExtension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                        ShortExtensions that cannot be ignored even if unrecognized
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                        Control0..*
                                        TypeExtension
                                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                        Summarytrue
                                        Requirements

                                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                        Alternate Namesextensions, user content, modifiers
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        308. Encounter.location.location
                                        Definition

                                        The location where the encounter takes place.

                                        ShortLocation the encounter takes place
                                        Control1..1
                                        TypeReference(Location)
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        310. Encounter.location.status
                                        Definition

                                        The status of the participants' presence at the specified location during the period specified. If the participant is no longer at the location, then the period will have an end date/time.

                                        Shortplanned | active | reserved | completed
                                        Comments

                                        When the patient is no longer active at a location, then the period end date is entered, and the status may be changed to completed.

                                        Control0..1
                                        BindingThe codes SHALL be taken from EncounterLocationStatus
                                        (required to http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1)

                                        The status of the location.

                                        Typecode
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        312. Encounter.location.physicalType
                                        Definition

                                        This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query.

                                        ShortThe physical type of the location (usually the level in the location hierachy - bed room ward etc.)
                                        Comments

                                        This information is de-normalized from the Location resource to support the easier understanding of the encounter resource and processing in messaging or query.

                                        There may be many levels in the hierachy, and this may only pic specific levels that are required for a specific usage scenario.

                                        Control0..1
                                        BindingFor example codes, see LocationType
                                        (example to http://hl7.org/fhir/ValueSet/location-physical-type)

                                        Physical form of the location.

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        314. Encounter.location.period
                                        Definition

                                        Time period during which the patient was present at the location.

                                        ShortTime period during which the patient was present at the location
                                        Control0..1
                                        TypePeriod
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        316. Encounter.serviceProvider
                                        Definition

                                        The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.

                                        ShortThe organization (facility) responsible for this encounter
                                        Control0..1
                                        TypeReference(US Core Organization Profile)
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        318. Encounter.partOf
                                        Definition

                                        Another Encounter of which this encounter is a part of (administratively or in time).

                                        ShortAnother Encounter this encounter is part of
                                        Comments

                                        This is also used for associating a child's encounter back to the mother's encounter.

                                        Refer to the Notes section in the Patient resource for further details.

                                        Control0..1
                                        TypeReference(Encounter)
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))