EncounterHistory
type: StructureDefinition
node role: treeRoot
id:
  v: EncounterHistory
meta:
  last updated:
    v: 2021-01-02T08:58:31.578+11:00
language:
  v: en
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition EncounterHistory Last updated: 2021-01-02 08:58:31+1100 Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> EncounterHistory 0..* DomainResource A record of significant events/milestones key data throughout the history of an Encounter Elements defined in Ancestors:id, meta, implicitRules, language, <a href="http://hl7.org/fhir/R5/domainresource.html" title="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.">text, contained, <a href="http://hl7.org/fhir/R5/domainresource.html" title="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 managable, 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.">extension, <a href="http://hl7.org/fhir/R5/domainresource.html" title="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 managable, 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. App…
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-category
    l: structuredefinition-category
  value: String
    v: Base.Management
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
    l: structuredefinition-standards-status
  value: Code
    v: trial-use
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
    l: structuredefinition-fmm
  value: Integer
    v: 0
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category
    l: structuredefinition-security-category
  value: Code
    v: patient
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
    l: structuredefinition-wg
  value: Code
    v: pa
extension:
  url:
    v: http://hl7.org/fhir/build/StructureDefinition/entered-in-error-status
    l: entered-in-error-status
  value: Code
    v: .status=entered-in-error
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/additional-resource
    l: additional-resource
  value: Boolean
    v: true
url:
  v: http://hl7.org/fhir/StructureDefinition/EncounterHistory
  l: EncounterHistory
identifier:
  system:
    v: urn:ietf:rfc:3986
    l: 3986
  value:
    v: urn:oid:2.16.840.1.113883.4.642.5.1784
version:
  v: 0.1.0
name:
  v: EncounterHistory
status:
  v: draft
date:
  v: 2021-01-02T08:58:31+11:00
publisher:
  v: HL7 International / Patient Administration
contact:
  name:
    v: HL7 International / Patient Administration
  telecom:
    system:
      v: url
    value:
      v: http://www.hl7.org/Special/committees/pa
contact:
  telecom:
    system:
      v: url
    value:
      v: http://www.hl7.org/Special/committees/pa
description:
  v: A record of significant events/milestones key data throughout the history of an Encounter
jurisdiction:
  coding:
    system:
      v: http://unstats.un.org/unsd/methods/m49/m49.htm
      l: m49.htm
    code:
      v: 001
    display:
      v: World
fhir version:
  v: 6.0.0-ballot3
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
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
    l: v3
  name:
    v: RIM Mapping
kind:
  v: resource
abstract:
  v: false
type:
  v: EncounterHistory
  l: EncounterHistory
base definition:
  v: http://hl7.org/fhir/StructureDefinition/DomainResource
  l: DomainResource
derivation:
  v: specialization
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
      l: snapshot-base-version
    value: String
      v: 6.0.0-ballot3
  element:
    id:
      v: EncounterHistory
    extension:
      url:
        v: http://hl7.org/fhir/build/StructureDefinition/svg
        l: http://hl7.org/fhir/build/StructureDefinition/svg
      value: Code
        v: 0,0
    path:
      v: EncounterHistory
    short:
      v: A record of significant events/milestones key data throughout the history of an Encounter
    definition:
      v: A record of significant events/milestones key data throughout the history of an Encounter, often tracked for specific purposes such as billing.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: DomainResource
      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()
      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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
      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()

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()
source:
  v: http://hl7.org/fhir/StructureDefinition/DomainResource
  l: DomainResource

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice
    l: elementdefinition-bestpractice
  value: Boolean
    v: true
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation
    l: elementdefinition-bestpractice-explanation
  value: 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.
key:
  v: dom-6
severity:
  v: warning
human:
  v: A resource should have narrative for robust management
expression:
  v: text.`div`.exists()
source:
  v: http://hl7.org/fhir/StructureDefinition/DomainResource
  l: DomainResource

v: false

v: false

v: false

identity:
  v: w5
map:
  v: workflow.encounter

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

id:
  v: EncounterHistory.id
path:
  v: EncounterHistory.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: Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
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
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: EncounterHistory.meta
path:
  v: EncounterHistory.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())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: EncounterHistory.implicitRules
path:
  v: EncounterHistory.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 its 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())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
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 its meaning or interpretation
is summary:
  v: true

id:
  v: EncounterHistory.language
path:
  v: EncounterHistory.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())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
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: Language
  strength:
    v: required
  description:
    v: IETF language tag for a human language
  value set:
    v: http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3
    l: http://hl7.org/fhir/ValueSet/all-languages
  additional:
    purpose:
      v: starter
    value set:
      v: http://hl7.org/fhir/ValueSet/languages|6.0.0-ballot3
      l: http://hl7.org/fhir/ValueSet/languages

id:
  v: EncounterHistory.text
path:
  v: EncounterHistory.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 a 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
condition:
  v: dom-6
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())
  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: Act.text?

id:
  v: EncounterHistory.contained
path:
  v: EncounterHistory.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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
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. Contained resources may be a resource type defined in the FHIR specification, or an [additional resource](http://build.fhir.org/resource.html#additional).
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
condition:
  v: dom-2
condition:
  v: dom-4
condition:
  v: dom-3
condition:
  v: dom-5
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: EncounterHistory.extension
path:
  v: EncounterHistory.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 resource. To make the use of extensions safe and managable, 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())
  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: N/A

id:
  v: EncounterHistory.modifierExtension
path:
  v: EncounterHistory.modifierExtension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
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 managable, 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://build.fhir.org/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())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
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: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: EncounterHistory.encounter
path:
  v: EncounterHistory.encounter
short:
  v: The Encounter associated with this set of historic values
definition:
  v: The Encounter associated with this set of historic values.
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: EncounterHistory.encounter
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy
      l: structuredefinition-hierarchy
    value: Boolean
      v: true
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Encounter
    l: Encounter

id:
  v: EncounterHistory.identifier
path:
  v: EncounterHistory.identifier
short:
  v: 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: EncounterHistory.identifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Identifier
    l: Identifier
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.identifier
mapping:
  identity:
    v: v2
  map:
    v: PV1-19

id:
  v: EncounterHistory.status
path:
  v: EncounterHistory.status
short:
  v: planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
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: EncounterHistory.status
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
    l: code
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
    l: encounter-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

id:
  v: EncounterHistory.class
path:
  v: EncounterHistory.class
short:
  v: 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: EncounterHistory.class
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
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

id:
  v: EncounterHistory.type
path:
  v: EncounterHistory.type
short:
  v: 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: 0
max:
  v: *
base:
  path:
    v: EncounterHistory.type
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: EncounterType
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/binding-definition
      l: binding-definition
    value: String
      v: The type of encounter.
  strength:
    v: example
  description:
    v: A specific code indicating type of service provided
  value set:
    v: http://hl7.org/fhir/ValueSet/encounter-type
    l: encounter-type
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.what[x]
mapping:
  identity:
    v: v2
  map:
    v: PV1-4 / PV1-18

id:
  v: EncounterHistory.serviceType
path:
  v: EncounterHistory.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: *
base:
  path:
    v: EncounterHistory.serviceType
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableReference
    l: CodeableReference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/HealthcareService
    l: HealthcareService
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: v2
  map:
    v: PV1-10

id:
  v: EncounterHistory.subject
path:
  v: EncounterHistory.subject
short:
  v: The patient or group related to this encounter
definition:
  v: The patient or group related to this encounter. In some use-cases the patient MAY not be present, such as a case meeting about a patient between several practitioners or a careteam.
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: 0
max:
  v: 1
base:
  path:
    v: EncounterHistory.subject
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Patient
    l: Patient
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Group
    l: Group
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.subject
mapping:
  identity:
    v: v2
  map:
    v: PID-3

id:
  v: EncounterHistory.subjectStatus
path:
  v: EncounterHistory.subjectStatus
short:
  v: The current status of the subject in relation to the Encounter
definition:
  v: The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EncounterHistory.subjectStatus
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: SubjectStatus
  strength:
    v: example
  description:
    v: Current status of the subject within the encounter.
  value set:
    v: http://hl7.org/fhir/ValueSet/encounter-subject-status
    l: encounter-subject-status

id:
  v: EncounterHistory.actualPeriod
path:
  v: EncounterHistory.actualPeriod
short:
  v: The actual start and end time associated with this set of values associated with the encounter
definition:
  v: The start and end time associated with this set of values associated with the encounter, may be different to the planned times for various reasons.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EncounterHistory.actualPeriod
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
    l: Period
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.done[x]
mapping:
  identity:
    v: v2
  map:
    v: PV1-44, PV1-45

id:
  v: EncounterHistory.plannedStartDate
path:
  v: EncounterHistory.plannedStartDate
short:
  v: The planned start date/time (or admission date) of the encounter
definition:
  v: The planned start date/time (or admission date) of the encounter.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EncounterHistory.plannedStartDate
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: dateTime
    l: dateTime
mapping:
  identity:
    v: v2
  map:
    v: PV2-8

id:
  v: EncounterHistory.plannedEndDate
path:
  v: EncounterHistory.plannedEndDate
short:
  v: The planned end date/time (or discharge date) of the encounter
definition:
  v: The planned end date/time (or discharge date) of the encounter.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EncounterHistory.plannedEndDate
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: dateTime
    l: dateTime
mapping:
  identity:
    v: v2
  map:
    v: PV2-9

id:
  v: EncounterHistory.length
path:
  v: EncounterHistory.length
short:
  v: Actual quantity of time the encounter lasted (less time absent)
definition:
  v: Actual quantity of time the encounter lasted. This excludes the time during leaves of absence. When missing it is the time in between the start and end values.
comment:
  v: If the precision on these values is low (e.g. to the day only) then this may be considered was an all day (or multi-day) encounter, unless the duration is included, where that amount of time occurred sometime during the interval. May differ from the time in `Encounter.period` due to leave of absence(s).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EncounterHistory.length
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Duration
    l: Duration
mapping:
  identity:
    v: v2
  map:
    v: (PV1-45 less PV1-44) iff ( (PV1-44 not empty) and (PV1-45 not empty) ); units in minutes or PV2-11 (which is actual length in days)

id:
  v: EncounterHistory.location
extension:
  url:
    v: http://hl7.org/fhir/build/StructureDefinition/svg
    l: http://hl7.org/fhir/build/StructureDefinition/svg
  value: Code
    v: 370,100
path:
  v: EncounterHistory.location
short:
  v: Location of the patient at this point in the encounter
definition:
  v: The location of the patient at this point in the encounter, the multiple cardinality permits de-normalizing the levels of the location hierarchy, such as site/ward/room/bed.
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: EncounterHistory.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 or both
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element

id:
  v: EncounterHistory.location.id
path:
  v: EncounterHistory.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: id
      l: id
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
condition:
  v: ele-1
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: EncounterHistory.location.extension
path:
  v: EncounterHistory.location.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 managable, 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())
  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: EncounterHistory.location.modifierExtension
path:
  v: EncounterHistory.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 managable, 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://build.fhir.org/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())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
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: EncounterHistory.location.location
path:
  v: EncounterHistory.location.location
short:
  v: Location the encounter takes place
definition:
  v: The location where the encounter takes place.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: EncounterHistory.location.location
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Location
    l: 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

id:
  v: EncounterHistory.location.form
path:
  v: EncounterHistory.location.form
short:
  v: The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual 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: EncounterHistory.location.form
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: LocationForm
  strength:
    v: example
  description:
    v: Physical form of the location.
  value set:
    v: http://hl7.org/fhir/ValueSet/location-form
    l: location-form

element:
  id:
    v: EncounterHistory
  extension:
    url:
      v: http://hl7.org/fhir/build/StructureDefinition/svg
      l: http://hl7.org/fhir/build/StructureDefinition/svg
    value: Code
      v: 0,0
  path:
    v: EncounterHistory
  short:
    v: A record of significant events/milestones key data throughout the history of an Encounter
  definition:
    v: A record of significant events/milestones key data throughout the history of an Encounter, often tracked for specific purposes such as billing.
  min:
    v: 0
  max:
    v: *
  mapping:
    identity:
      v: w5
    map:
      v: workflow.encounter
element:
  id:
    v: EncounterHistory.encounter
  path:
    v: EncounterHistory.encounter
  short:
    v: The Encounter associated with this set of historic values
  definition:
    v: The Encounter associated with this set of historic values.
  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
  type:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy
        l: structuredefinition-hierarchy
      value: Boolean
        v: true
    code:
      v: Reference
      l: Reference
    target profile:
      v: http://hl7.org/fhir/StructureDefinition/Encounter
      l: Encounter
element:
  id:
    v: EncounterHistory.identifier
  path:
    v: EncounterHistory.identifier
  short:
    v: Identifier(s) by which this encounter is known
  definition:
    v: Identifier(s) by which this encounter is known.
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: Identifier
      l: Identifier
  is summary:
    v: true
  mapping:
    identity:
      v: w5
    map:
      v: FiveWs.identifier
  mapping:
    identity:
      v: v2
    map:
      v: PV1-19
element:
  id:
    v: EncounterHistory.status
  path:
    v: EncounterHistory.status
  short:
    v: planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
  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
  type:
    code:
      v: code
      l: code
  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
      l: encounter-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
element:
  id:
    v: EncounterHistory.class
  path:
    v: EncounterHistory.class
  short:
    v: 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
  type:
    code:
      v: CodeableConcept
      l: CodeableConcept
  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
element:
  id:
    v: EncounterHistory.type
  path:
    v: EncounterHistory.type
  short:
    v: 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: 0
  max:
    v: *
  type:
    code:
      v: CodeableConcept
      l: CodeableConcept
  is summary:
    v: true
  binding:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
        l: elementdefinition-bindingName
      value: String
        v: EncounterType
    extension:
      url:
        v: http://hl7.org/fhir/tools/StructureDefinition/binding-definition
        l: binding-definition
      value: String

String
v: The type of encounter.

v: example

v: A specific code indicating type of service provided

identity:
  v: w5
map:
  v: FiveWs.what[x]

identity:
  v: v2
map:
  v: PV1-4 / PV1-18

id:
  v: EncounterHistory.serviceType
path:
  v: EncounterHistory.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: *
type:
  code:
    v: CodeableReference
    l: CodeableReference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/HealthcareService
    l: HealthcareService
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: v2
  map:
    v: PV1-10

id:
  v: EncounterHistory.subject
path:
  v: EncounterHistory.subject
short:
  v: The patient or group related to this encounter
definition:
  v: The patient or group related to this encounter. In some use-cases the patient MAY not be present, such as a case meeting about a patient between several practitioners or a careteam.
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: 0
max:
  v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Patient
    l: Patient
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Group
    l: Group
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.subject
mapping:
  identity:
    v: v2
  map:
    v: PID-3

id:
  v: EncounterHistory.subjectStatus
path:
  v: EncounterHistory.subjectStatus
short:
  v: The current status of the subject in relation to the Encounter
definition:
  v: The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status.
min:
  v: 0
max:
  v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: SubjectStatus
  strength:
    v: example
  description:
    v: Current status of the subject within the encounter.
  value set:
    v: http://hl7.org/fhir/ValueSet/encounter-subject-status
    l: encounter-subject-status

id:
  v: EncounterHistory.actualPeriod
path:
  v: EncounterHistory.actualPeriod
short:
  v: The actual start and end time associated with this set of values associated with the encounter
definition:
  v: The start and end time associated with this set of values associated with the encounter, may be different to the planned times for various reasons.
min:
  v: 0
max:
  v: 1
type:
  code:
    v: Period
    l: Period
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.done[x]
mapping:
  identity:
    v: v2
  map:
    v: PV1-44, PV1-45

id:
  v: EncounterHistory.plannedStartDate
path:
  v: EncounterHistory.plannedStartDate
short:
  v: The planned start date/time (or admission date) of the encounter
definition:
  v: The planned start date/time (or admission date) of the encounter.
min:
  v: 0
max:
  v: 1
type:
  code:
    v: dateTime
    l: dateTime
mapping:
  identity:
    v: v2
  map:
    v: PV2-8

id:
  v: EncounterHistory.plannedEndDate
path:
  v: EncounterHistory.plannedEndDate
short:
  v: The planned end date/time (or discharge date) of the encounter
definition:
  v: The planned end date/time (or discharge date) of the encounter.
min:
  v: 0
max:
  v: 1
type:
  code:
    v: dateTime
    l: dateTime
mapping:
  identity:
    v: v2
  map:
    v: PV2-9

id:
  v: EncounterHistory.length
path:
  v: EncounterHistory.length
short:
  v: Actual quantity of time the encounter lasted (less time absent)
definition:
  v: Actual quantity of time the encounter lasted. This excludes the time during leaves of absence. When missing it is the time in between the start and end values.
comment:
  v: If the precision on these values is low (e.g. to the day only) then this may be considered was an all day (or multi-day) encounter, unless the duration is included, where that amount of time occurred sometime during the interval. May differ from the time in `Encounter.period` due to leave of absence(s).
min:
  v: 0
max:
  v: 1
type:
  code:
    v: Duration
    l: Duration
mapping:
  identity:
    v: v2
  map:
    v: (PV1-45 less PV1-44) iff ( (PV1-44 not empty) and (PV1-45 not empty) ); units in minutes or PV2-11 (which is actual length in days)

id:
  v: EncounterHistory.location
extension:
  url:
    v: http://hl7.org/fhir/build/StructureDefinition/svg
    l: http://hl7.org/fhir/build/StructureDefinition/svg
  value: Code
    v: 370,100
path:
  v: EncounterHistory.location
short:
  v: Location of the patient at this point in the encounter
definition:
  v: The location of the patient at this point in the encounter, the multiple cardinality permits de-normalizing the levels of the location hierarchy, such as site/ward/room/bed.
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: *
type:
  code:
    v: BackboneElement
    l: BackboneElement

id:
  v: EncounterHistory.location.location
path:
  v: EncounterHistory.location.location
short:
  v: Location the encounter takes place
definition:
  v: The location where the encounter takes place.
min:
  v: 1
max:
  v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Location
    l: 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

id:
  v: EncounterHistory.location.form
path:
  v: EncounterHistory.location.form
short:
  v: The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual 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
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: LocationForm
  strength:
    v: example
  description:
    v: Physical form of the location.
  value set:
    v: http://hl7.org/fhir/ValueSet/location-form
    l: location-form