NHDR Implementation Guide Release 1.0
0.1.0 - ci-build

NHDR Implementation Guide Release 1.0, published by NHDR. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/PROJ-PHILHEALTH-EA-NHDR/PhilHealth-NHDR-IG-Review/ and changes regularly. See the Directory of published versions

Resource Profile: PH_Encounter - Detailed Descriptions

Page standards status: Draft

Definitions for the PH-Encounter resource profile.

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

0. Encounter
Definition

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

ShortAn interaction during which services are provided to the patient
Control0..*
Is Modifierfalse
Summaryfalse
Alternate NamesVisit
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Encounter.implicitRules
Definition

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

ShortA set of rules under which this content was created
Comments

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

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

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

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

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

A human language.

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

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

ShortText summary of the resource, for human interpretation
Comments

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

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

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

ShortContained, inline Resources
Comments

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

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

An Extension


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.

ShortExtensionAdditional content defined by implementations
Comments

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

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

    Age of the patient in years.

    ShortAge in Years
    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(Age in Years) (Extension Type: integer)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    14. Encounter.extension:ageMonths
    Slice NameageMonths
    Definition

    Age of the patient in months.

    ShortAge in Months
    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(Age in Months) (Extension Type: integer)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    16. Encounter.extension:ageDays
    Slice NameageDays
    Definition

    Age of the patient in days.

    ShortAge in Days
    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(Age in Days) (Extension Type: integer)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    18. Encounter.extension:patientClassification
    Slice NamepatientClassification
    Definition

    Classification of patient.

    ShortPatient Classification
    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(Patient Classification) (Extension Type: string)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    20. Encounter.extension:interviewer
    Slice Nameinterviewer
    Definition

    Name of the interviewer at first point of contact.

    ShortInterviewer
    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(Interviewer) (Extension Type: HumanName)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    22. Encounter.extension:investigatorName
    Slice NameinvestigatorName
    Definition

    Name of the investigator/assessor.

    ShortInvestigator
    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(Investigator) (Extension Type: HumanName)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    24. Encounter.extension:dateInterview
    Slice NamedateInterview
    Definition

    Date of interview.

    ShortDate of Interview
    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(Date of Interview) (Extension Type: dateTime)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    26. Encounter.extension:dateInvestigation
    Slice NamedateInvestigation
    Definition

    Date of investigation.

    ShortDate of Investigation
    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(Date of Investigation) (Extension Type: dateTime)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    28. Encounter.extension:reporterName
    Slice NamereporterName
    Definition

    Name of the reporter of the encounter.

    ShortReporter
    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(Reporter) (Extension Type: HumanName)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    30. Encounter.extension:illnessClass
    Slice NameillnessClass
    Definition

    Classification of illness.

    ShortIllness Class
    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(Illness Class) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    32. Encounter.modifierExtension
    Definition

    An Extension


    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).

    ShortExtensionExtensions that cannot be ignored
    Comments

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

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

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

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

    Identifier(s) by which this encounter is known.

    ShortIdentifier(s) by which this encounter is known
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..*
    TypeIdentifier(PIN - PhilHealth Identification Number, COVID Data Identification, COVID Patient Identification)
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    36. Encounter.status
    Definition

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

    ShortNHDR will only use "triaged", "in-progress", "cancelled", and "finished".planned | arrived | triaged | in-progress | onleave | finished | cancelled +
    Comments

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

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

    Current state of the encounter.

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

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

    ShortList of past encounter statuses
    Comments

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

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

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

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

    Classification of the encounter.

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

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

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

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

    ShortSpecific type of encounter
    Comments

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

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

    The type of encounter.

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

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

    ShortSpecific type of service
    Control0..1
    BindingThe codes SHALL be taken from For example codes, see Service Typehttp://hl7.org/fhir/ValueSet/service-type
    (required to https://nhdr.gov.ph/fhir/ValueSet/ServiceTypeVS)
    TypeCodeableConcept
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    54. Encounter.priority
    Definition

    Indicates the urgency of the encounter.

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

    Indicates the urgency of the encounter.

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

    The patient or group present at the encounter.

    ShortThe patient or group present at the encounter
    Comments

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

    Control0..1
    TypeReference(PH Patient, Patient, Group)
    Is Modifierfalse
    Summarytrue
    Alternate Namespatient
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    58. Encounter.episodeOfCare
    Definition

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

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

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

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

    The list of people responsible for providing the service.

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

    The appointment that scheduled this encounter.

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

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

    ShortReason the encounter takes place (reference)
    Comments

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

    Control0..0*
    TypeReference(Condition, Procedure, Observation, ImmunizationRecommendation)
    Is Modifierfalse
    Summarytrue
    Alternate NamesIndication, Admission diagnosis
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    69. Encounter.account
    Definition

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

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

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

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

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

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

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

    ShortAnother Encounter this encounter is part of
    Comments

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

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

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

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

    0. Encounter
    2. Encounter.implicitRules
    Control0..0
    4. Encounter.language
    Control0..0
    6. Encounter.text
    Control0..0
    8. Encounter.contained
    Control0..0
    10. Encounter.extension
    SlicingThis element introduces a set of slices on Encounter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 12. Encounter.extension:ageYears
      Slice NameageYears
      Control0..*
      TypeExtension(Age in Years) (Extension Type: integer)
      14. Encounter.extension:ageMonths
      Slice NameageMonths
      Control0..*
      TypeExtension(Age in Months) (Extension Type: integer)
      16. Encounter.extension:ageDays
      Slice NameageDays
      Control0..*
      TypeExtension(Age in Days) (Extension Type: integer)
      18. Encounter.extension:patientClassification
      Slice NamepatientClassification
      Control0..*
      TypeExtension(Patient Classification) (Extension Type: string)
      20. Encounter.extension:interviewer
      Slice Nameinterviewer
      Control0..*
      TypeExtension(Interviewer) (Extension Type: HumanName)
      22. Encounter.extension:investigatorName
      Slice NameinvestigatorName
      Control0..*
      TypeExtension(Investigator) (Extension Type: HumanName)
      24. Encounter.extension:dateInterview
      Slice NamedateInterview
      Control0..*
      TypeExtension(Date of Interview) (Extension Type: dateTime)
      26. Encounter.extension:dateInvestigation
      Slice NamedateInvestigation
      Control0..*
      TypeExtension(Date of Investigation) (Extension Type: dateTime)
      28. Encounter.extension:reporterName
      Slice NamereporterName
      Control0..*
      TypeExtension(Reporter) (Extension Type: HumanName)
      30. Encounter.extension:illnessClass
      Slice NameillnessClass
      Control0..*
      TypeExtension(Illness Class) (Extension Type: CodeableConcept)
      32. Encounter.modifierExtension
      Control0..0
      34. Encounter.identifier
      NoteThis is a business identifier, not a resource identifier (see discussion)
      TypeIdentifier(PIN - PhilHealth Identification Number, COVID Data Identification, COVID Patient Identification)
      36. Encounter.status
      ShortNHDR will only use "triaged", "in-progress", "cancelled", and "finished".
      38. Encounter.statusHistory
      Control0..0
      40. Encounter.classHistory
      Control0..0
      42. Encounter.type
      Control0..0
      44. Encounter.serviceType
      BindingThe codes SHALL be taken from Service Type
      (required to https://nhdr.gov.ph/fhir/ValueSet/ServiceTypeVS)
      46. Encounter.priority
      Control0..0
      48. Encounter.subject
      TypeReference(PH Patient)
      50. Encounter.episodeOfCare
      Control0..0
      52. Encounter.basedOn
      Control0..0
      54. Encounter.participant
      Control0..0
      56. Encounter.appointment
      Control0..0
      58. Encounter.reasonReference
      Control0..0
      60. Encounter.diagnosis
      62. Encounter.diagnosis.id
      Control0..0
      64. Encounter.diagnosis.extension
      Control0..0
      66. Encounter.diagnosis.modifierExtension
      Control0..0
      68. Encounter.diagnosis.condition
      TypeReference(PH Condition, PH Procedure)
      70. Encounter.diagnosis.use
      Control0..0
      72. Encounter.diagnosis.rank
      Control0..0
      74. Encounter.account
      Control0..0
      76. Encounter.hospitalization
      78. Encounter.hospitalization.id
      Control0..0
      80. Encounter.hospitalization.extension
      Control0..0
      82. Encounter.hospitalization.modifierExtension
      Control0..0
      84. Encounter.hospitalization.preAdmissionIdentifier
      Control0..0
      86. Encounter.hospitalization.admitSource
      Control0..0
      88. Encounter.hospitalization.reAdmission
      Control0..0
      90. Encounter.hospitalization.dietPreference
      Control0..0
      92. Encounter.hospitalization.specialCourtesy
      Control0..0
      94. Encounter.hospitalization.specialArrangement
      Control0..0
      96. Encounter.hospitalization.destination
      TypeReference(Location, PH Organization)
      98. Encounter.hospitalization.dischargeDisposition
      BindingThe codes SHALL be taken from DischargeDisposition
      (required to http://hl7.org/fhir/ValueSet/encounter-discharge-disposition)
      100. Encounter.location
      102. Encounter.location.id
      Control0..0
      104. Encounter.location.extension
      Control0..0
      106. Encounter.location.modifierExtension
      Control0..0
      108. Encounter.location.status
      Control0..0
      110. Encounter.location.physicalType
      BindingThe codes SHALL be taken from LocationType
      (required to http://hl7.org/fhir/ValueSet/location-physical-type)
      112. Encounter.location.period
      Control0..0
      114. Encounter.serviceProvider
      TypeReference(PH Organization)
      116. Encounter.partOf
      Control0..0

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

      0. Encounter
      Definition

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

      ShortAn interaction during which services are provided to the patient
      Control0..*
      Is Modifierfalse
      Summaryfalse
      Alternate NamesVisit
      Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
      dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
      dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
      dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
      dom-6: A resource should have narrative for robust management (text.`div`.exists())
      2. Encounter.id
      Definition

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

      ShortLogical id of this artifact
      Comments

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

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

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

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

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

      ShortA set of rules under which this content was created
      Comments

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

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

      The base language in which the resource is written.

      ShortLanguage of the resource content
      Comments

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

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

      A human language.

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

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

      ShortText summary of the resource, for human interpretation
      Comments

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

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

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

      ShortContained, inline Resources
      Comments

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

      Control0..0
      TypeResource
      Is Modifierfalse
      Summaryfalse
      Alternate Namesinline resources, anonymous resources, contained resources
      14. Encounter.extension
      Definition

      An Extension

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

        Age of the patient in years.

        ShortAge in Years
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(Age in Years) (Extension Type: integer)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        18. Encounter.extension:ageMonths
        Slice NameageMonths
        Definition

        Age of the patient in months.

        ShortAge in Months
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(Age in Months) (Extension Type: integer)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        20. Encounter.extension:ageDays
        Slice NameageDays
        Definition

        Age of the patient in days.

        ShortAge in Days
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(Age in Days) (Extension Type: integer)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        22. Encounter.extension:patientClassification
        Slice NamepatientClassification
        Definition

        Classification of patient.

        ShortPatient Classification
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(Patient Classification) (Extension Type: string)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        24. Encounter.extension:interviewer
        Slice Nameinterviewer
        Definition

        Name of the interviewer at first point of contact.

        ShortInterviewer
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(Interviewer) (Extension Type: HumanName)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        26. Encounter.extension:investigatorName
        Slice NameinvestigatorName
        Definition

        Name of the investigator/assessor.

        ShortInvestigator
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(Investigator) (Extension Type: HumanName)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        28. Encounter.extension:dateInterview
        Slice NamedateInterview
        Definition

        Date of interview.

        ShortDate of Interview
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(Date of Interview) (Extension Type: dateTime)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        30. Encounter.extension:dateInvestigation
        Slice NamedateInvestigation
        Definition

        Date of investigation.

        ShortDate of Investigation
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(Date of Investigation) (Extension Type: dateTime)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        32. Encounter.extension:reporterName
        Slice NamereporterName
        Definition

        Name of the reporter of the encounter.

        ShortReporter
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(Reporter) (Extension Type: HumanName)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        34. Encounter.extension:illnessClass
        Slice NameillnessClass
        Definition

        Classification of illness.

        ShortIllness Class
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(Illness Class) (Extension Type: CodeableConcept)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        36. Encounter.modifierExtension
        Definition

        An Extension

        ShortExtension
        Control0..0
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        38. Encounter.identifier
        Definition

        Identifier(s) by which this encounter is known.

        ShortIdentifier(s) by which this encounter is known
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..*
        TypeIdentifier(PIN - PhilHealth Identification Number, COVID Data Identification, COVID Patient Identification)
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        40. Encounter.status
        Definition

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

        ShortNHDR will only use "triaged", "in-progress", "cancelled", and "finished".
        Comments

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

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

        Current state of the encounter.

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

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

        ShortList of past encounter statuses
        Comments

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

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

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

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

        Classification of the encounter.

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

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

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

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

        ShortSpecific type of encounter
        Comments

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

        Control0..0
        BindingFor example codes, see EncounterType
        (example to http://hl7.org/fhir/ValueSet/encounter-type)

        The type of encounter.

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

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

        ShortSpecific type of service
        Control0..1
        BindingThe codes SHALL be taken from Service Type
        (required to https://nhdr.gov.ph/fhir/ValueSet/ServiceTypeVS)
        TypeCodeableConcept
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        62. Encounter.priority
        Definition

        Indicates the urgency of the encounter.

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

        Indicates the urgency of the encounter.

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

        The patient or group present at the encounter.

        ShortThe patient or group present at the encounter
        Comments

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

        Control0..1
        TypeReference(PH Patient)
        Is Modifierfalse
        Summarytrue
        Alternate Namespatient
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        66. Encounter.episodeOfCare
        Definition

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

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

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

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

        The list of people responsible for providing the service.

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

        The appointment that scheduled this encounter.

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

        The start and end time of the encounter.

        ShortThe start and end time of the encounter
        Comments

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

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

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

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

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

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

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

        ShortCoded reason the encounter takes place
        Comments

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

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

        Reason why the encounter takes place.

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

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

        ShortReason the encounter takes place (reference)
        Comments

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

        Control0..0
        TypeReference(Condition, Procedure, Observation, ImmunizationRecommendation)
        Is Modifierfalse
        Summarytrue
        Alternate NamesIndication, Admission diagnosis
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        88. Encounter.diagnosis
        Definition

        The list of diagnosis relevant to this encounter.

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

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

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

        An Extension

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

        An Extension

        ShortExtension
        Control0..0
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        96. Encounter.diagnosis.condition
        Definition

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

        ShortThe diagnosis or procedure relevant to the encounter
        Comments

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

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

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

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

        The type of diagnosis this condition represents.

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

        Ranking of the diagnosis (for each role type).

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

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

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

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

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

        Details about the admission to a healthcare service.

        ShortDetails about the admission to a healthcare service
        Comments

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

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

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

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

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

        An Extension

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

        An Extension

        ShortExtension
        Control0..0
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        112. Encounter.hospitalization.preAdmissionIdentifier
        Definition

        Pre-admission identifier.

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

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

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

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

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

        From where the patient was admitted.

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

        Whether this hospitalization is a readmission and why if known.

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

        The reason for re-admission of this hospitalization encounter.

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

        Diet preferences reported by the patient.

        ShortDiet preferences reported by the patient
        Comments

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

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

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

        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Requirements

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

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

        Special courtesies (VIP, board member).

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

        Special courtesies.

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

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

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

        Special arrangements.

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

        Location/organization to which the patient is discharged.

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

        Category or kind of location after discharge.

        ShortCategory or kind of location after discharge
        Control0..1
        BindingThe codes SHALL be taken from DischargeDisposition
        (required to http://hl7.org/fhir/ValueSet/encounter-discharge-disposition)
        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        130. Encounter.location
        Definition

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

        ShortList of locations where the patient has been
        Comments

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

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

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

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

        An Extension

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

        An Extension

        ShortExtension
        Control0..0
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        138. Encounter.location.location
        Definition

        The location where the encounter takes place.

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

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

        Shortplanned | active | reserved | completed
        Comments

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

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

        The status of the location.

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

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

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

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

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

        Control0..1
        BindingThe codes SHALL be taken from LocationType
        (required to http://hl7.org/fhir/ValueSet/location-physical-type)
        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        144. Encounter.location.period
        Definition

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

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

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

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

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

        ShortAnother Encounter this encounter is part of
        Comments

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

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

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