us-quality-core-encounter
type: StructureDefinition
node role: treeRoot
id:
  v: us-quality-core-encounter
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition us-quality-core-encounter Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> Encounter 0..* USCoreEncounterProfile(6.1.0) An interaction during which services are provided to the patient #xD; identifier 0..* Identifier (USCDI+ Quality) (USCDI) Identifier(s) by which this encounter is known #xD; system 1..1 uri (USCDI+ Quality) (USCDI) The namespace for the identifier value #xD; value 1..1 string (USCDI+ Quality) (USCDI) The value that is unique #xD; status 1..1 code (USCDI+ Quality) (USCDI) planned | arrived | triaged | in-progress | onleave | finished | cancelled + #xD; class 1..1 Coding (USCDI) Classification of patient encounter #xD; type 1..* CodeableConcept (USCDI+ Quality) (USCDI) Specific type of encounter #xD; priority 0..1 CodeableConcept (USCDI+ Quality) Indicates the urgency of the encounter #xD; subject 1..1 Reference(US Quality Core Patient) (USCDI) The patient or group present at the encounter #xD; participant 0..* BackboneElement (USCDI) List of participants involved in the encounter #xD; individual 0..1 Reference(US Quality Core Practitioner | US Quality Core PractitionerRole | US Quality Core RelatedPerson) (USCDI) Persons involved in the encounter other than the patient #xD; period 0..1 Period (USCDI+ Quality) (USCDI) The start and end time of the encounter #xD; reasonCode 0..* CodeableConcept (USCDI) Coded reason the encounter takes place #xD; reasonReference Σ 0..* Reference(US Quality Core Condition Problems Health Concerns | US Quality Core Condition Encounter Diagnosis | US Quality Core Procedure | US Quality Core Simple Observation | US Quality Core ImmunizationRecommendation) (USCDI) Reason the encounter takes place (reference) #xD; diagnosis 0..* BackboneElement (USCDI+ Quality) The list of diagnosis relevant to this encounter #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url Constraints: ele-1, ext-1 …
url:
  v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-encounter
  l: us-quality-core-encounter
version:
  v: 0.5.0
name:
  v: USQualityCoreEncounter
title:
  v: US Quality Core Encounter
status:
  v: active
experimental:
  v: false
date:
  v: 2026-06-05
publisher:
  v: Office of the National Coordinator for Health Information Technology (ONC)
contact:
  name:
    v: Office of the National Coordinator for Health Information Technology (ONC)
  telecom:
    system:
      v: url
    value:
      v: https://www.healthit.gov/feedback
description:
  v: Profile of Encounter for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
      l: 3166
    code:
      v: US
    display:
      v: United States of America
  text:
    v: USA
fhir version:
  v: 4.0.1
mapping:
  identity:
    v: workflow
  uri:
    v: http://hl7.org/fhir/workflow
    l: workflow
  name:
    v: Workflow Pattern
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
    l: v3
  name:
    v: RIM Mapping
mapping:
  identity:
    v: w5
  uri:
    v: http://hl7.org/fhir/fivews
    l: fivews
  name:
    v: FiveWs Pattern Mapping
mapping:
  identity:
    v: v2
  uri:
    v: http://hl7.org/v2
    l: v2
  name:
    v: HL7 v2 Mapping
kind:
  v: resource
abstract:
  v: false
type:
  v: Encounter
  l: Encounter
base definition:
  v: http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter|6.1.0
  l: http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter
derivation:
  v: constraint
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
      l: snapshot-base-version
    value: String
      v: 6.1.0
  element:
    id:
      v: Encounter
    path:
      v: Encounter
    short:
      v: An interaction during which services are provided to the patient
    definition:
      v: \-
    comment:
      v: \-
    alias:
      v: Visit
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Encounter
      min:
        v: 0
      max:
        v: *
    constraint:
      key:
        v: dom-2
      severity:
        v: error
      human:
        v: If the resource is contained in another resource, it SHALL NOT contain nested Resources
      expression:
        v: contained.contained.empty()
      xpath:
        v: not(parent::f:contained and f:contained)
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        l: DomainResource
    constraint:
      key:
        v: dom-3
      severity:
        v: error
      human:
        v: 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
      expression:
        v: 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()
      xpath:
        v: not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        l: DomainResource
    constraint:
      key:
        v: dom-4
      severity:
        v: error
      human:
        v: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
      expression:
        v: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
      xpath:
        v: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        l: DomainResource
    constraint:
      key:
        v: dom-5
      severity:
        v: error
      human:
        v: If a resource is contained in another resource, it SHALL NOT have a security label
      expression:
        v: contained.meta.security.empty()
      xpath:
        v: not(exists(f:contained/*/f:meta/f:security))
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        l: DomainResource
    constraint:
      extension:
        value: Boolean
      extension:
        value: Markdown
      key:
        v: dom-6
      severity:
        v: warning
      human:
        v: A resource should have narrative for robust management
      expression:
        v: text.`div`.exists()
      xpath:
        v: exists(f:text/h:div)
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        l: DomainResource
    must support:
      v: false
    is modifier:
      v: false

Boolean
v: true

Markdown
v: When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.

v: false

identity:
  v: rim
map:
  v: Entity. Role, or Act

identity:
  v: workflow
map:
  v: Event

identity:
  v: rim
map:
  v: Encounter[@moodCode='EVN']

id:
  v: Encounter.id
path:
  v: Encounter.id
short:
  v: Logical id of this artifact
definition:
  v: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
comment:
  v: The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: id
      l: id
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
is modifier:
  v: false
is summary:
  v: true

id:
  v: Encounter.meta
path:
  v: Encounter.meta
short:
  v: Metadata about the resource
definition:
  v: 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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.meta
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Meta
    l: Meta
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true

id:
  v: Encounter.implicitRules
path:
  v: Encounter.implicitRules
short:
  v: A set of rules under which this content was created
definition:
  v: 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.
comment:
  v: 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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.implicitRules
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: true
is modifier reason:
  v: 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
is summary:
  v: true

id:
  v: Encounter.language
path:
  v: Encounter.language
short:
  v: Language of the resource content
definition:
  v: The base language in which the resource is written.
comment:
  v: 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).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
      l: elementdefinition-maxValueSet
    value: Canonical
      v: http://hl7.org/fhir/ValueSet/all-languages
      l: all-languages
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: Language
  strength:
    v: preferred
  description:
    v: A human language.
  value set:
    v: http://hl7.org/fhir/ValueSet/languages
    l: languages

id:
  v: Encounter.text
path:
  v: Encounter.text
short:
  v: Text summary of the resource, for human interpretation
definition:
  v: 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.
comment:
  v: 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.
alias:
  v: narrative
alias:
  v: html
alias:
  v: xhtml
alias:
  v: display
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.text
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Narrative
    l: Narrative
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: Act.text?

id:
  v: Encounter.contained
path:
  v: Encounter.contained
short:
  v: Contained, inline Resources
definition:
  v: 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.
comment:
  v: 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.
alias:
  v: inline resources
alias:
  v: anonymous resources
alias:
  v: contained resources
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.contained
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Resource
    l: Resource
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Encounter.extension
path:
  v: Encounter.extension
short:
  v: Additional content defined by implementations
definition:
  v: 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.
comment:
  v: 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.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Encounter.modifierExtension
path:
  v: Encounter.modifierExtension
short:
  v: Extensions that cannot be ignored
definition:
  v: 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).
comment:
  v: 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.
requirements:
  v: 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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Encounter.identifier
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/uscdiplusquality
    l: uscdiplusquality
  value: Boolean
    v: true
path:
  v: Encounter.identifier
short:
  v: (USCDI+ Quality) (USCDI) Identifier(s) by which this encounter is known
definition:
  v: Identifier(s) by which this encounter is known.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Encounter.identifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Identifier
    l: Identifier
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Event.identifier
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.identifier
mapping:
  identity:
    v: v2
  map:
    v: PV1-19
mapping:
  identity:
    v: rim
  map:
    v: .id

id:
  v: Encounter.identifier.id
path:
  v: Encounter.identifier.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: string
      l: string
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Encounter.identifier.extension
path:
  v: Encounter.identifier.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Additional content defined by implementations
definition:
  v: 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.
comment:
  v: 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.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Encounter.identifier.use
path:
  v: Encounter.identifier.use
short:
  v: usual | official | temp | secondary | old (If known)
definition:
  v: The purpose of this identifier.
comment:
  v: Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
requirements:
  v: Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Identifier.use
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: true
is modifier reason:
  v: This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: IdentifierUse
  strength:
    v: required
  description:
    v: Identifies the purpose for this identifier, if known .
  value set:
    v: http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    l: http://hl7.org/fhir/ValueSet/identifier-use
mapping:
  identity:
    v: v2
  map:
    v: N/A
mapping:
  identity:
    v: rim
  map:
    v: Role.code or implied by context

id:
  v: Encounter.identifier.type
path:
  v: Encounter.identifier.type
short:
  v: Description of identifier
definition:
  v: A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
comment:
  v: 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.
requirements:
  v: Allows users to make use of identifiers when the identifier system is not known.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Identifier.type
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: IdentifierType
  strength:
    v: extensible
  description:
    v: A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
  value set:
    v: http://hl7.org/fhir/ValueSet/identifier-type
    l: identifier-type
mapping:
  identity:
    v: v2
  map:
    v: CX.5
mapping:
  identity:
    v: rim
  map:
    v: Role.code or implied by context

id:
  v: Encounter.identifier.system
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/uscdiplusquality
    l: uscdiplusquality
  value: Boolean
    v: true
path:
  v: Encounter.identifier.system
short:
  v: (USCDI+ Quality) (USCDI) The namespace for the identifier value
definition:
  v: Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
comment:
  v: Identifier.system is always case sensitive.
requirements:
  v: 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.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Identifier.system
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
example:
  label:
    v: General
  value: Uri
    v: http://www.acme.com/identifiers/patient
    l: patient
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: CX.4 / EI-2-4
mapping:
  identity:
    v: rim
  map:
    v: II.root or Role.id.root
mapping:
  identity:
    v: servd
  map:
    v: ./IdentifierType

id:
  v: Encounter.identifier.value
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/uscdiplusquality
    l: uscdiplusquality
  value: Boolean
    v: true
path:
  v: Encounter.identifier.value
short:
  v: (USCDI+ Quality) (USCDI) The value that is unique
definition:
  v: The portion of the identifier typically relevant to the user and which is unique within the context of the system.
comment:
  v: 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](http://hl7.org/fhir/R4/extension-rendered-value.html). 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.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Identifier.value
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
example:
  label:
    v: General
  value: String
    v: 123456
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: CX.1 / EI.1
mapping:
  identity:
    v: rim
  map:
    v: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
mapping:
  identity:
    v: servd
  map:
    v: ./Value

id:
  v: Encounter.identifier.period
path:
  v: Encounter.identifier.period
short:
  v: Time period when id is/was valid for use
definition:
  v: Time period during which identifier is/was valid for use.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Identifier.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
    l: Period
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: CX.7 + CX.8
mapping:
  identity:
    v: rim
  map:
    v: Role.effectiveTime or implied by context
mapping:
  identity:
    v: servd
  map:
    v: ./StartDate and ./EndDate

id:
  v: Encounter.identifier.assigner
path:
  v: Encounter.identifier.assigner
short:
  v: Organization that issued id (may be just text)
definition:
  v: Organization that issued/manages the identifier.
comment:
  v: 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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Identifier.assigner
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    l: Organization
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: CX.4 / (CX.4,CX.9,CX.10)
mapping:
  identity:
    v: rim
  map:
    v: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
mapping:
  identity:
    v: servd
  map:
    v: ./IdentifierIssuingAuthority

id:
  v: Encounter.status
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/uscdiplusquality
    l: uscdiplusquality
  value: Boolean
    v: true
path:
  v: Encounter.status
short:
  v: (USCDI+ Quality) (USCDI) planned | arrived | triaged | in-progress | onleave | finished | cancelled +
definition:
  v: planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
comment:
  v: Note that internal business rules will determine the appropriate transitions that may occur between statuses (and also classes).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Encounter.status
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
    l: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is modifier:
  v: true
is modifier reason:
  v: 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
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: EncounterStatus
  strength:
    v: required
  description:
    v: Current state of the encounter.
  value set:
    v: http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
    l: http://hl7.org/fhir/ValueSet/encounter-status
mapping:
  identity:
    v: workflow
  map:
    v: Event.status
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.status
mapping:
  identity:
    v: v2
  map:
    v: No clear equivalent in HL7 v2; active/finished could be inferred from PV1-44, PV1-45, PV2-24; inactive could be inferred from PV2-16
mapping:
  identity:
    v: rim
  map:
    v: .statusCode

id:
  v: Encounter.statusHistory
path:
  v: Encounter.statusHistory
short:
  v: List of past encounter statuses
definition:
  v: 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.
comment:
  v: The current status is always found in the current version of the resource, not the status history.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Encounter.statusHistory
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
    l: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Encounter.statusHistory.id
path:
  v: Encounter.statusHistory.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: string
      l: string
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Encounter.statusHistory.extension
path:
  v: Encounter.statusHistory.extension
short:
  v: Additional content defined by implementations
definition:
  v: 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.
comment:
  v: 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.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Encounter.statusHistory.modifierExtension
path:
  v: Encounter.statusHistory.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: 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).
comment:
  v: 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.
requirements:
  v: 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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Encounter.statusHistory.status
path:
  v: Encounter.statusHistory.status
short:
  v: planned | arrived | triaged | in-progress | onleave | finished | cancelled +
definition:
  v: planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Encounter.statusHistory.status
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
    l: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: EncounterStatus
  strength:
    v: required
  description:
    v: Current state of the encounter.
  value set:
    v: http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
    l: http://hl7.org/fhir/ValueSet/encounter-status
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Encounter.statusHistory.period
path:
  v: Encounter.statusHistory.period
short:
  v: The time that the episode was in the specified status
definition:
  v: The time that the episode was in the specified status.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Encounter.statusHistory.period
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Period
    l: Period
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Encounter.class
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
path:
  v: Encounter.class
short:
  v: (USCDI) Classification of patient encounter
definition:
  v: Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Encounter.class
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Coding
    l: Coding
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: EncounterClass
  strength:
    v: extensible
  description:
    v: Classification of the encounter.
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
    l: v3-ActEncounterCode
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.class
mapping:
  identity:
    v: v2
  map:
    v: PV1-2
mapping:
  identity:
    v: rim
  map:
    v: .inboundRelationship[typeCode=SUBJ].source[classCode=LIST].code

id:
  v: Encounter.classHistory
path:
  v: Encounter.classHistory
short:
  v: List of past encounter classes
definition:
  v: 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.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Encounter.classHistory
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
    l: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Encounter.classHistory.id
path:
  v: Encounter.classHistory.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: string
      l: string
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Encounter.classHistory.extension
path:
  v: Encounter.classHistory.extension
short:
  v: Additional content defined by implementations
definition:
  v: 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.
comment:
  v: 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.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Encounter.classHistory.modifierExtension
path:
  v: Encounter.classHistory.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: 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).
comment:
  v: 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.
requirements:
  v: 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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Encounter.classHistory.class
path:
  v: Encounter.classHistory.class
short:
  v: inpatient | outpatient | ambulatory | emergency +
definition:
  v: inpatient | outpatient | ambulatory | emergency +.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Encounter.classHistory.class
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Coding
    l: Coding
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: EncounterClass
  strength:
    v: extensible
  description:
    v: Classification of the encounter.
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
    l: v3-ActEncounterCode
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Encounter.classHistory.period
path:
  v: Encounter.classHistory.period
short:
  v: The time that the episode was in the specified class
definition:
  v: The time that the episode was in the specified class.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Encounter.classHistory.period
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Period
    l: Period
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Encounter.type
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/uscdiplusquality
    l: uscdiplusquality
  value: Boolean
    v: true
path:
  v: Encounter.type
short:
  v: (USCDI+ Quality) (USCDI) Specific type of encounter
definition:
  v: Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
comment:
  v: Since there are many ways to further classify encounters, this element is 0..*.
min:
  v: 1
max:
  v: *
base:
  path:
    v: Encounter.type
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
binding:
  strength:
    v: extensible
  description:
    v: Valueset to describe the Encounter Type
  value set:
    v: http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type
    l: us-core-encounter-type
mapping:
  identity:
    v: workflow
  map:
    v: Event.code
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.class
mapping:
  identity:
    v: v2
  map:
    v: PV1-4 / PV1-18
mapping:
  identity:
    v: rim
  map:
    v: .code

id:
  v: Encounter.serviceType
path:
  v: Encounter.serviceType
short:
  v: Specific type of service
definition:
  v: Broad categorization of the service that is to be provided (e.g. cardiology).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Encounter.serviceType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: EncounterServiceType
  strength:
    v: example
  description:
    v: Broad categorization of the service that is to be provided.
  value set:
    v: http://hl7.org/fhir/ValueSet/service-type
    l: service-type
mapping:
  identity:
    v: workflow
  map:
    v: Event.code
mapping:
  identity:
    v: v2
  map:
    v: PV1-10
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Encounter.priority
extension:
  url:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/uscdiplusquality
    l: uscdiplusquality
  value: Boolean
    v: true
path:
  v: Encounter.priority
short:
  v: (USCDI+ Quality) Indicates the urgency of the encounter
definition:
  v: Indicates the urgency of the encounter.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Encounter.priority
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: Priority
  strength:
    v: example
  description:
    v: Indicates the urgency of the encounter.
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-ActPriority
    l: v3-ActPriority
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.grade
mapping:
  identity:
    v: v2
  map:
    v: PV2-25
mapping:
  identity:
    v: rim
  map:
    v: .priorityCode

id:
  v: Encounter.subject
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
path:
  v: Encounter.subject
short:
  v: (USCDI) The patient or group present at the encounter
definition:
  v: The patient or group present at the encounter.
comment:
  v: 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).
alias:
  v: patient
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Encounter.subject
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-patient
    l: us-quality-core-patient
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Event.subject
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.subject[x]
mapping:
  identity:
    v: v2
  map:
    v: PID-3
mapping:
  identity:
    v: rim
  map:
    v: .participation[typeCode=SBJ]/role[classCode=PAT]
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.subject

id:
  v: Encounter.episodeOfCare
path:
  v: Encounter.episodeOfCare
short:
  v: Episode(s) of care that this encounter should be recorded against
definition:
  v: 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).
min:
  v: 0
max:
  v: *
base:
  path:
    v: Encounter.episodeOfCare
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/EpisodeOfCare
    l: EpisodeOfCare
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Event.context
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.context
mapping:
  identity:
    v: v2
  map:
    v: PV1-54, PV1-53
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Encounter.basedOn
path:
  v: Encounter.basedOn
short:
  v: The ServiceRequest that initiated this encounter
definition:
  v: The request this encounter satisfies (e.g. incoming referral or procedure request).
alias:
  v: incomingReferral
min:
  v: 0
max:
  v: *
base:
  path:
    v: Encounter.basedOn
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/ServiceRequest
    l: ServiceRequest
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: workflow
  map:
    v: Event.basedOn
mapping:
  identity:
    v: rim
  map:
    v: .reason.ClinicalDocument

id:
  v: Encounter.participant
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
path:
  v: Encounter.participant
short:
  v: (USCDI) List of participants involved in the encounter
definition:
  v: The list of people responsible for providing the service.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Encounter.participant
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
    l: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Event.performer
mapping:
  identity:
    v: v2
  map:
    v: ROL
mapping:
  identity:
    v: rim
  map:
    v: .participation[typeCode=PFM]

id:
  v: Encounter.participant.id
path:
  v: Encounter.participant.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: string
      l: string
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Encounter.participant.extension
path:
  v: Encounter.participant.extension
short:
  v: Additional content defined by implementations
definition:
  v: 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.
comment:
  v: 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.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Encounter.participant.modifierExtension
path:
  v: Encounter.participant.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: 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).
comment:
  v: 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.
requirements:
  v: 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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Encounter.participant.type
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
path:
  v: Encounter.participant.type
short:
  v: (USCDI) Role of participant in encounter
definition:
  v: Role of participant in encounter.
comment:
  v: 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.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Encounter.participant.type
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ParticipantType
  strength:
    v: extensible
  description:
    v: Role of participant in encounter.
  value set:
    v: http://hl7.org/fhir/ValueSet/encounter-participant-type
    l: encounter-participant-type
mapping:
  identity:
    v: workflow
  map:
    v: Event.performer.function
mapping:
  identity:
    v: v2
  map:
    v: ROL-3 (or maybe PRT-4)
mapping:
  identity:
    v: rim
  map:
    v: .functionCode

id:
  v: Encounter.participant.period
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
path:
  v: Encounter.participant.period
short:
  v: (USCDI) Period of time during the encounter that the participant participated
definition:
  v: 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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Encounter.participant.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
    l: Period
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: ROL-5, ROL-6 (or maybe PRT-5)
mapping:
  identity:
    v: rim
  map:
    v: .time

id:
  v: Encounter.participant.individual
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
path:
  v: Encounter.participant.individual
short:
  v: (USCDI) Persons involved in the encounter other than the patient
definition:
  v: Persons involved in the encounter other than the patient.
comment:
  v: Should include us-quality-core-relatedperson as a possible participant, but USCore-Encounter only allows USCore-Practitioner.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Encounter.participant.individual
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-practitioner
    l: us-quality-core-practitioner
  target profile:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-practitionerrole
    l: us-quality-core-practitionerrole
  target profile:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-relatedperson
    l: us-quality-core-relatedperson
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Event.performer.actor
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.who
mapping:
  identity:
    v: v2
  map:
    v: ROL-4
mapping:
  identity:
    v: rim
  map:
    v: .role

id:
  v: Encounter.appointment
path:
  v: Encounter.appointment
short:
  v: The appointment that scheduled this encounter
definition:
  v: The appointment that scheduled this encounter.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Encounter.appointment
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Appointment
    l: Appointment
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Event.basedOn
mapping:
  identity:
    v: v2
  map:
    v: SCH-1 / SCH-2
mapping:
  identity:
    v: rim
  map:
    v: .outboundRelationship[typeCode=FLFS].target[classCode=ENC, moodCode=APT]

id:
  v: Encounter.period
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/uscdiplusquality
    l: uscdiplusquality
  value: Boolean
    v: true
path:
  v: Encounter.period
short:
  v: (USCDI+ Quality) (USCDI) The start and end time of the encounter
definition:
  v: The start and end time of the encounter.
comment:
  v: If not (yet) known, the end of the Period may be omitted.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Encounter.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
    l: Period
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: workflow
  map:
    v: Event.occurrence[x]
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.done[x]
mapping:
  identity:
    v: v2
  map:
    v: PV1-44, PV1-45
mapping:
  identity:
    v: rim
  map:
    v: .effectiveTime (low & high)

id:
  v: Encounter.length
path:
  v: Encounter.length
short:
  v: Quantity of time the encounter lasted (less time absent)
definition:
  v: Quantity of time the encounter lasted. This excludes the time during leaves of absence.
comment:
  v: May differ from the time the Encounter.period lasted because of leave of absence.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Encounter.length
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Duration
    l: Duration
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: workflow
  map:
    v: Event.occurrence[x]
mapping:
  identity:
    v: v2
  map:
    v: (PV1-45 less PV1-44) iff ( (PV1-44 not empty) and (PV1-45 not empty) ); units in minutes
mapping:
  identity:
    v: rim
  map:
    v: .lengthOfStayQuantity

id:
  v: Encounter.reasonCode
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
path:
  v: Encounter.reasonCode
short:
  v: (USCDI) Coded reason the encounter takes place
definition:
  v: Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
comment:
  v: 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).
alias:
  v: Indication
alias:
  v: Admission diagnosis
min:
  v: 0
max:
  v: *
base:
  path:
    v: Encounter.reasonCode
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: EncounterReason
  strength:
    v: preferred
  description:
    v: Reason why the encounter takes place.
  value set:
    v: http://hl7.org/fhir/ValueSet/encounter-reason
    l: encounter-reason
mapping:
  identity:
    v: workflow
  map:
    v: Event.reasonCode
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.why[x]
mapping:
  identity:
    v: v2
  map:
    v: EVN-4 / PV2-3 (note: PV2-3 is nominally constrained to inpatient admissions; HL7 v2 makes no vocabulary suggestions for PV2-3; would not expect PV2 segment or PV2-3 to be in use in all implementations )
mapping:
  identity:
    v: rim
  map:
    v: .reasonCode

id:
  v: Encounter.reasonReference
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
path:
  v: Encounter.reasonReference
short:
  v: (USCDI) Reason the encounter takes place (reference)
definition:
  v: Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
comment:
  v: 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).
alias:
  v: Indication
alias:
  v: Admission diagnosis
min:
  v: 0
max:
  v: *
base:
  path:
    v: Encounter.reasonReference
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-condition-problems-health-concerns
    l: us-quality-core-condition-problems-health-concerns
  target profile:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-condition-encounter-diagnosis
    l: us-quality-core-condition-encounter-diagnosis
  target profile:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-procedure
    l: us-quality-core-procedure
  target profile:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-simple-observation
    l: us-quality-core-simple-observation
  target profile:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-immunizationrecommendation
    l: us-quality-core-immunizationrecommendation
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Event.reasonCode
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.why[x]
mapping:
  identity:
    v: v2
  map:
    v: EVN-4 / PV2-3 (note: PV2-3 is nominally constrained to inpatient admissions; HL7 v2 makes no vocabulary suggestions for PV2-3; would not expect PV2 segment or PV2-3 to be in use in all implementations )
mapping:
  identity:
    v: rim
  map:
    v: .reasonCode

id:
  v: Encounter.diagnosis
extension:
  url:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/uscdiplusquality
    l: uscdiplusquality
  value: Boolean
    v: true
path:
  v: Encounter.diagnosis
short:
  v: (USCDI+ Quality) The list of diagnosis relevant to this encounter
definition:
  v: The list of diagnosis relevant to this encounter.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Encounter.diagnosis
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
    l: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: .outboundRelationship[typeCode=RSON]

id:
  v: Encounter.diagnosis.id
path:
  v: Encounter.diagnosis.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: string
      l: string
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Encounter.diagnosis.extension
path:
  v: Encounter.diagnosis.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  ordered:
    v: false
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: Encounter.diagnosis.extension:diagnosisPresentOnAdmission
extension:
  url:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/uscdiplusquality
    l: uscdiplusquality
  value: Boolean
    v: true
path:
  v: Encounter.diagnosis.extension
slice name:
  v: diagnosisPresentOnAdmission
short:
  v: (USCDI+ Quality) onAdmission
definition:
  v: Indicator of whether the Encounter diagnosis was present at the time of admission.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-encounter-diagnosisPresentOnAdmission
    l: us-quality-core-encounter-diagnosisPresentOnAdmission
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
must support:
  v: true
is modifier:
  v: false
is summary:
  v: false

id:
  v: Encounter.diagnosis.modifierExtension
path:
  v: Encounter.diagnosis.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: 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).
comment:
  v: 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.
requirements:
  v: 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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Encounter.diagnosis.condition
path:
  v: Encounter.diagnosis.condition
short:
  v: The diagnosis or procedure relevant to the encounter
definition:
  v: 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.
comment:
  v: 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).
alias:
  v: Admission diagnosis
alias:
  v: discharge diagnosis
alias:
  v: indication
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Encounter.diagnosis.condition
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Condition
    l: Condition
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Procedure
    l: Procedure
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Event.reasonReference
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.why[x]
mapping:
  identity:
    v: v2
  map:
    v: Resources that would commonly referenced at Encounter.indication would be Condition and/or Procedure. These most closely align with DG1/PRB and PR1 respectively.
mapping:
  identity:
    v: rim
  map:
    v: .outboundRelationship[typeCode=RSON].target

id:
  v: Encounter.diagnosis.use
path:
  v: Encounter.diagnosis.use
short:
  v: Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
definition:
  v: Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Encounter.diagnosis.use
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: DiagnosisRole
  strength:
    v: preferred
  description:
    v: The type of diagnosis this condition represents.
  value set:
    v: http://hl7.org/fhir/ValueSet/diagnosis-role
    l: diagnosis-role
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Encounter.diagnosis.rank
path:
  v: Encounter.diagnosis.rank
short:
  v: Ranking of the diagnosis (for each role type)
definition:
  v: Ranking of the diagnosis (for each role type).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Encounter.diagnosis.rank
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: positiveInt
    l: positiveInt
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: .outboundRelationship[typeCode=RSON].priority

id:
  v: Encounter.account
path:
  v: Encounter.account
short:
  v: The set of accounts that may be used for billing for this Encounter
definition:
  v: The set of accounts that may be used for billing for this Encounter.
comment:
  v: The billing system may choose to allocate billable items associated with the Encounter to different referenced Accounts based on internal business rules.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Encounter.account
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Account
    l: Account
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: .pertains.A_Account

id:
  v: Encounter.hospitalization
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/uscdiplusquality
    l: uscdiplusquality
  value: Boolean
    v: true
path:
  v: Encounter.hospitalization
short:
  v: (USCDI+ Quality) (USCDI) Details about the admission to a healthcare service
definition:
  v: Details about the admission to a healthcare service.
comment:
  v: 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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Encounter.hospitalization
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: BackboneElement
    l: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: .outboundRelationship[typeCode=COMP].target[classCode=ENC, moodCode=EVN]

id:
  v: Encounter.hospitalization.id
path:
  v: Encounter.hospitalization.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: string
      l: string
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Encounter.hospitalization.extension
path:
  v: Encounter.hospitalization.extension
short:
  v: Additional content defined by implementations
definition:
  v: 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.
comment:
  v: 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.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Encounter.hospitalization.modifierExtension
path:
  v: Encounter.hospitalization.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: 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).
comment:
  v: 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.
requirements:
  v: 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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Encounter.hospitalization.preAdmissionIdentifier
path:
  v: Encounter.hospitalization.preAdmissionIdentifier
short:
  v: Pre-admission identifier
definition:
  v: Pre-admission identifier.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Encounter.hospitalization.preAdmissionIdentifier
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Identifier
    l: Identifier
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: PV1-5
mapping:
  identity:
    v: rim
  map:
    v: .id

id:
  v: Encounter.hospitalization.origin
path:
  v: Encounter.hospitalization.origin
short:
  v: The location/organization from which the patient came before admission
definition:
  v: The location/organization from which the patient came before admission.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Encounter.hospitalization.origin
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-location
    l: us-quality-core-location
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: .participation[typeCode=ORG].role

id:
  v: Encounter.hospitalization.admitSource
path:
  v: Encounter.hospitalization.admitSource
short:
  v: From where patient was admitted (physician referral, transfer)
definition:
  v: From where patient was admitted (physician referral, transfer).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Encounter.hospitalization.admitSource
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: AdmitSource
  strength:
    v: preferred
  description:
    v: From where the patient was admitted.
  value set:
    v: http://hl7.org/fhir/ValueSet/encounter-admit-source
    l: encounter-admit-source
mapping:
  identity:
    v: v2
  map:
    v: PV1-14
mapping:
  identity:
    v: rim
  map:
    v: .admissionReferralSourceCode

id:
  v: Encounter.hospitalization.reAdmission
path:
  v: Encounter.hospitalization.reAdmission
short:
  v: The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
definition:
  v: Whether this hospitalization is a readmission and why if known.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Encounter.hospitalization.reAdmission
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ReAdmissionType
  strength:
    v: example
  description:
    v: The reason for re-admission of this hospitalization encounter.
  value set:
    v: http://terminology.hl7.org/ValueSet/v2-0092
    l: v2-0092
mapping:
  identity:
    v: v2
  map:
    v: PV1-13
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Encounter.hospitalization.dietPreference
path:
  v: Encounter.hospitalization.dietPreference
short:
  v: Diet preferences reported by the patient
definition:
  v: Diet preferences reported by the patient.
comment:
  v: For example, a patient may request both a dairy-free and nut-free diet preference (not mutually exclusive).
requirements:
  v: 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.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Encounter.hospitalization.dietPreference
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: PatientDiet
  strength:
    v: example
  description:
    v: Medical, cultural or ethical food preferences to help with catering requirements.
  value set:
    v: http://hl7.org/fhir/ValueSet/encounter-diet
    l: encounter-diet
mapping:
  identity:
    v: v2
  map:
    v: PV1-38
mapping:
  identity:
    v: rim
  map:
    v: .outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=EVN, code="diet"]

id:
  v: Encounter.hospitalization.specialCourtesy
path:
  v: Encounter.hospitalization.specialCourtesy
short:
  v: Special courtesies (VIP, board member)
definition:
  v: Special courtesies (VIP, board member).
min:
  v: 0
max:
  v: *
base:
  path:
    v: Encounter.hospitalization.specialCourtesy
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: Courtesies
  strength:
    v: preferred
  description:
    v: Special courtesies.
  value set:
    v: http://hl7.org/fhir/ValueSet/encounter-special-courtesy
    l: encounter-special-courtesy
mapping:
  identity:
    v: v2
  map:
    v: PV1-16
mapping:
  identity:
    v: rim
  map:
    v: .specialCourtesiesCode

id:
  v: Encounter.hospitalization.specialArrangement
path:
  v: Encounter.hospitalization.specialArrangement
short:
  v: Wheelchair, translator, stretcher, etc.
definition:
  v: Any special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Encounter.hospitalization.specialArrangement
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: Arrangements
  strength:
    v: preferred
  description:
    v: Special arrangements.
  value set:
    v: http://hl7.org/fhir/ValueSet/encounter-special-arrangements
    l: encounter-special-arrangements
mapping:
  identity:
    v: v2
  map:
    v: PV1-15 / OBR-30 / OBR-43
mapping:
  identity:
    v: rim
  map:
    v: .specialArrangementCode

id:
  v: Encounter.hospitalization.destination
path:
  v: Encounter.hospitalization.destination
short:
  v: Location/organization to which the patient is discharged
definition:
  v: Location/organization to which the patient is discharged.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Encounter.hospitalization.destination
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-location
    l: us-quality-core-location
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: PV1-37
mapping:
  identity:
    v: rim
  map:
    v: .participation[typeCode=DST]

id:
  v: Encounter.hospitalization.dischargeDisposition
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/uscdiplusquality
    l: uscdiplusquality
  value: Boolean
    v: true
path:
  v: Encounter.hospitalization.dischargeDisposition
short:
  v: (USCDI+ Quality) (USCDI) Category or kind of location after discharge
definition:
  v: Category or kind of location after discharge.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Encounter.hospitalization.dischargeDisposition
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: false
binding:
  strength:
    v: extensible
  value set:
    v: http://terminology.hl7.org/ValueSet/clinical-discharge-disposition
    l: clinical-discharge-disposition
mapping:
  identity:
    v: v2
  map:
    v: PV1-36
mapping:
  identity:
    v: rim
  map:
    v: .dischargeDispositionCode

id:
  v: Encounter.location
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/uscdiplusquality
    l: uscdiplusquality
  value: Boolean
    v: true
path:
  v: Encounter.location
short:
  v: (USCDI+ Quality) (USCDI) List of locations where the patient has been
definition:
  v: List of locations where the patient has been during this encounter.
comment:
  v: 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".
min:
  v: 0
max:
  v: *
base:
  path:
    v: Encounter.location
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
    l: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: .participation[typeCode=LOC]

id:
  v: Encounter.location.id
path:
  v: Encounter.location.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: string
      l: string
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Encounter.location.extension
path:
  v: Encounter.location.extension
short:
  v: Additional content defined by implementations
definition:
  v: 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.
comment:
  v: 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.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Encounter.location.modifierExtension
path:
  v: Encounter.location.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: 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).
comment:
  v: 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.
requirements:
  v: 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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Encounter.location.location
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/uscdiplusquality
    l: uscdiplusquality
  value: Boolean
    v: true
path:
  v: Encounter.location.location
short:
  v: (USCDI+ Quality) (USCDI) Location the encounter takes place
definition:
  v: The location where the encounter takes place.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Encounter.location.location
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-location
    l: us-quality-core-location
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: workflow
  map:
    v: Event.location
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.where[x]
mapping:
  identity:
    v: v2
  map:
    v: PV1-3 / PV1-6 / PV1-11 / PV1-42 / PV1-43
mapping:
  identity:
    v: rim
  map:
    v: .role

id:
  v: Encounter.location.status
path:
  v: Encounter.location.status
short:
  v: planned | active | reserved | completed
definition:
  v: 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.
comment:
  v: 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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Encounter.location.status
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: EncounterLocationStatus
  strength:
    v: required
  description:
    v: The status of the location.
  value set:
    v: http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1
    l: http://hl7.org/fhir/ValueSet/encounter-location-status
mapping:
  identity:
    v: rim
  map:
    v: .role.statusCode

id:
  v: Encounter.location.physicalType
path:
  v: Encounter.location.physicalType
short:
  v: The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
definition:
  v: This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query.
comment:
  v: 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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Encounter.location.physicalType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: PhysicalType
  strength:
    v: example
  description:
    v: Physical form of the location.
  value set:
    v: http://hl7.org/fhir/ValueSet/location-physical-type
    l: location-physical-type

id:
  v: Encounter.location.period
path:
  v: Encounter.location.period
short:
  v: Time period during which the patient was present at the location
definition:
  v: Time period during which the patient was present at the location.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Encounter.location.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
    l: Period
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: .time

id:
  v: Encounter.serviceProvider
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
path:
  v: Encounter.serviceProvider
short:
  v: (USCDI) The organization (facility) responsible for this encounter
definition:
  v: 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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Encounter.serviceProvider
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-organization
    l: us-quality-core-organization
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: workflow
  map:
    v: Event.performer.actor
mapping:
  identity:
    v: v2
  map:
    v: PL.6 & PL.1
mapping:
  identity:
    v: rim
  map:
    v: .particiaption[typeCode=PFM].role

id:
  v: Encounter.partOf
path:
  v: Encounter.partOf
short:
  v: Another Encounter this encounter is part of
definition:
  v: Another Encounter of which this encounter is a part of (administratively or in time).
comment:
  v: 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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Encounter.partOf
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-encounter
    l: us-quality-core-encounter
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: workflow
  map:
    v: Event.partOf
mapping:
  identity:
    v: rim
  map:
    v: .inboundRelationship[typeCode=COMP].source[classCode=COMP, moodCode=EVN]

element:
  id:
    v: Encounter
  path:
    v: Encounter
element:
  id:
    v: Encounter.identifier
  extension:
    url:
      v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
      l: uscdi-requirement
    value: Boolean
      v: true
  extension:
    url:
      v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/uscdiplusquality
      l: uscdiplusquality
    value: Boolean
      v: true
  path:
    v: Encounter.identifier
  short:
    v: (USCDI+ Quality) (USCDI) Identifier(s) by which this encounter is known
element:
  id:
    v: Encounter.identifier.system
  extension:
    url:
      v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
      l: uscdi-requirement
    value: Boolean
      v: true
  extension:
    url:
      v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/uscdiplusquality
      l: uscdiplusquality
    value: Boolean
      v: true
  path:
    v: Encounter.identifier.system
  short:
    v: (USCDI+ Quality) (USCDI) The namespace for the identifier value
element:
  id:
    v: Encounter.identifier.value
  extension:
    url:
      v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
      l: uscdi-requirement
    value: Boolean
      v: true
  extension:
    url:
      v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/uscdiplusquality
      l: uscdiplusquality
    value: Boolean
      v: true
  path:
    v: Encounter.identifier.value
  short:
    v: (USCDI+ Quality) (USCDI) The value that is unique
element:
  id:
    v: Encounter.status
  extension:
    url:
      v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
      l: uscdi-requirement
    value: Boolean
      v: true
  extension:
    url:
      v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/uscdiplusquality
      l: uscdiplusquality
    value: Boolean
      v: true
  path:
    v: Encounter.status
  short:
    v: (USCDI+ Quality) (USCDI) planned | arrived | triaged | in-progress | onleave | finished | cancelled +
element:
  id:
    v: Encounter.class
  extension:
    url:
      v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
      l: uscdi-requirement
    value: Boolean
      v: true
  path:
    v: Encounter.class
  short:
    v: (USCDI) Classification of patient encounter
element:
  id:
    v: Encounter.type
  extension:
    url:
      v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
      l: uscdi-requirement
    value: Boolean
      v: true
  extension:
    url:
      v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/uscdiplusquality
      l: uscdiplusquality
    value: Boolean
      v: true
  path:
    v: Encounter.type
  short:
    v: (USCDI+ Quality) (USCDI) Specific type of encounter
element:
  id:
    v: Encounter.priority
  extension:
    url:
      v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/uscdiplusquality
      l: uscdiplusquality
    value: Boolean
      v: true
  path:
    v: Encounter.priority
  short:
    v: (USCDI+ Quality) Indicates the urgency of the encounter
element:
  id:
    v: Encounter.subject
  extension:
    url:
      v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
      l: uscdi-requirement
    value: Boolean
      v: true
  path:
    v: Encounter.subject
  short:
    v: (USCDI) The patient or group present at the encounter
  type:
    code:
      v: Reference
      l: Reference
    target profile:
      v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-patient
      l: us-quality-core-patient
element:
  id:
    v: Encounter.participant
  extension:
    url:
      v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
      l: uscdi-requirement
    value: Boolean
      v: true
  path:
    v: Encounter.participant
  short:
    v: (USCDI) List of participants involved in the encounter
element:
  id:
    v: Encounter.participant.individual
  extension:
    url:
      v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
      l: uscdi-requirement
    value: Boolean
      v: true
  path:
    v: Encounter.participant.individual
  short:
    v: (USCDI) Persons involved in the encounter other than the patient
  comment:
    v: Should include us-quality-core-relatedperson as a possible participant, but USCore-Encounter only allows USCore-Practitioner.
  type:
    code:
      v: Reference
      l: Reference
    target profile:
      v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-practitioner
      l: us-quality-core-practitioner
    target profile:
      v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-practitionerrole
      l: us-quality-core-practitionerrole
    target profile:
      v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-relatedperson
      l: us-quality-core-relatedperson
element:
  id:
    v: Encounter.period
  extension:
    url:
      v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
      l: uscdi-requirement
    value: Boolean
      v: true
  extension:
    url:
      v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/uscdiplusquality
      l: uscdiplusquality
    value: Boolean
      v: true

v: Encounter.period

v: (USCDI+ Quality) (USCDI) The start and end time of the encounter

id:
  v: Encounter.reasonCode
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
path:
  v: Encounter.reasonCode
short:
  v: (USCDI) Coded reason the encounter takes place

id:
  v: Encounter.reasonReference
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
path:
  v: Encounter.reasonReference
short:
  v: (USCDI) Reason the encounter takes place (reference)
min:
  v: 0
max:
  v: *
base:
  path:
    v: Encounter.reasonReference
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-condition-problems-health-concerns
    l: us-quality-core-condition-problems-health-concerns
  target profile:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-condition-encounter-diagnosis
    l: us-quality-core-condition-encounter-diagnosis
  target profile:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-procedure
    l: us-quality-core-procedure
  target profile:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-simple-observation
    l: us-quality-core-simple-observation
  target profile:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-immunizationrecommendation
    l: us-quality-core-immunizationrecommendation
is modifier:
  v: false
is summary:
  v: true

id:
  v: Encounter.diagnosis
extension:
  url:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/uscdiplusquality
    l: uscdiplusquality
  value: Boolean
    v: true
path:
  v: Encounter.diagnosis
short:
  v: (USCDI+ Quality) The list of diagnosis relevant to this encounter

id:
  v: Encounter.diagnosis.extension
path:
  v: Encounter.diagnosis.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  ordered:
    v: false
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
is modifier:
  v: false
is summary:
  v: false

id:
  v: Encounter.diagnosis.extension:diagnosisPresentOnAdmission
extension:
  url:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/uscdiplusquality
    l: uscdiplusquality
  value: Boolean
    v: true
path:
  v: Encounter.diagnosis.extension
slice name:
  v: diagnosisPresentOnAdmission
short:
  v: (USCDI+ Quality) onAdmission
definition:
  v: Indicator of whether the Encounter diagnosis was present at the time of admission.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-encounter-diagnosisPresentOnAdmission
    l: us-quality-core-encounter-diagnosisPresentOnAdmission
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
must support:
  v: true
is modifier:
  v: false

id:
  v: Encounter.diagnosis.use
path:
  v: Encounter.diagnosis.use
short:
  v: Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)

id:
  v: Encounter.diagnosis.rank
path:
  v: Encounter.diagnosis.rank
short:
  v: Ranking of the diagnosis (for each role type)

id:
  v: Encounter.hospitalization
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/uscdiplusquality
    l: uscdiplusquality
  value: Boolean
    v: true
path:
  v: Encounter.hospitalization
short:
  v: (USCDI+ Quality) (USCDI) Details about the admission to a healthcare service

id:
  v: Encounter.hospitalization.origin
path:
  v: Encounter.hospitalization.origin
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-location
    l: us-quality-core-location
must support:
  v: false

id:
  v: Encounter.hospitalization.destination
path:
  v: Encounter.hospitalization.destination
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-location
    l: us-quality-core-location
must support:
  v: false

id:
  v: Encounter.hospitalization.dischargeDisposition
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/uscdiplusquality
    l: uscdiplusquality
  value: Boolean
    v: true
path:
  v: Encounter.hospitalization.dischargeDisposition
short:
  v: (USCDI+ Quality) (USCDI) Category or kind of location after discharge
definition:
  v: Category or kind of location after discharge.
binding:
  strength:
    v: extensible
  value set:
    v: http://terminology.hl7.org/ValueSet/clinical-discharge-disposition
    l: clinical-discharge-disposition

id:
  v: Encounter.location
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/uscdiplusquality
    l: uscdiplusquality
  value: Boolean
    v: true
path:
  v: Encounter.location
short:
  v: (USCDI+ Quality) (USCDI) List of locations where the patient has been

id:
  v: Encounter.location.location
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
extension:
  url:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/uscdiplusquality
    l: uscdiplusquality
  value: Boolean
    v: true
path:
  v: Encounter.location.location
short:
  v: (USCDI+ Quality) (USCDI) Location the encounter takes place
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-location
    l: us-quality-core-location

id:
  v: Encounter.location.period
path:
  v: Encounter.location.period
short:
  v: Time period during which the patient was present at the location

id:
  v: Encounter.serviceProvider
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
path:
  v: Encounter.serviceProvider
short:
  v: (USCDI) The organization (facility) responsible for this encounter
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-organization
    l: us-quality-core-organization

id:
  v: Encounter.partOf
path:
  v: Encounter.partOf
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://fhir.org/guides/onc/us-quality-core/StructureDefinition/us-quality-core-encounter
    l: us-quality-core-encounter
must support:
  v: false