- HSPC Implementation Guide

This page is part of the HSPC FHIR Implementation Guide (v0.1.0: Daft For Comment Draft) based on FHIR v1.9.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Profile hspc-ipencounter

Source: XML, JSON, Turtle

Differential

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*
... encounter-reasonCancelled Binding: HSPC Reason Cancelled value set. (preferred)
... class 0..1Coding
... priority 0..1CodeableConceptBinding: HSPC SNOMED Priorities (preferred)
... participant 0..*BackboneElement
.... type 0..*CodeableConceptBinding: v3 Code System ParticipationType (preferred)
.... Extension 0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaURL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: ???? (preferred)
... length 0..1Duration
.... system 0..1uriFixed Value: http://unitsofmeasure.org
.... code 0..1codeFixed Value: d
... reason 0..1CodeableConceptBinding: HSPC Encounter Reason (example)
... hospitalization 0..1BackboneElement
.... admitSource 0..1CodeableConceptBinding: HSPC Admission Source value set (example)
.... specialCourtesy Binding: v3 Code System EncounterSpecialCourtesy (preferred)
.... specialArrangement Binding: HSPC Special Arrangement value set (preferred)
.... dietPreference 0..*CodeableConceptBinding: HSPC Diet Type value set. (preferred)
.... Extension 0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaURL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: v2 Yes/no Indicator (preferred)
.... Extension 0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaURL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: v2 Yes/no Indicator (preferred)
... location BackboneElementSlice: Unordered, Open, by Encounter.location.location|flase|open
.... location 1..1Reference(Reference)
.... Extension 0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaURL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: HSPC Patient Arrival Status (preferred)
... location 0..1BackboneElement
.... location 1..1Reference(Reference)
.... Extension 0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaURL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: HSPC Service Delivery Location Condition value set (preferred)
... Extension 0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaURL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: v2 Confidentiality (preferred)
... Extension 0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaURL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: ???? (preferred)
... Extension 0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaURL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: HSPC VIP Level (preferred)
... Extension 0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaURL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: v2 Ambulatory Status (preferred)
... Extension 0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaURL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: HSPC Departure Transport Mode value set (preferred)
... Extension 0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaURL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: HSPC Arrival Transport Mode value set (preferred)
... Extension 0..*base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaURL: http://hl7.org/fhir/StructureDefinition/Extension
... Extension 0..*base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaURL: http://hl7.org/fhir/StructureDefinition/Extension
... Extension 0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaURL: http://hl7.org/fhir/StructureDefinition/Extension

doco Documentation for this format

Snapshot

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*An interaction during which services are provided to the patient
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Extension I0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaExtension
URL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: v2 Confidentiality (preferred)
ext-1: Must have either extensions or value[x], not both
... Extension I0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaExtension
URL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: ???? (preferred)
ext-1: Must have either extensions or value[x], not both
... Extension I0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaExtension
URL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: HSPC VIP Level (preferred)
ext-1: Must have either extensions or value[x], not both
... Extension I0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaExtension
URL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: v2 Ambulatory Status (preferred)
ext-1: Must have either extensions or value[x], not both
... Extension I0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaExtension
URL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: HSPC Departure Transport Mode value set (preferred)
ext-1: Must have either extensions or value[x], not both
... Extension I0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaExtension
URL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: HSPC Arrival Transport Mode value set (preferred)
ext-1: Must have either extensions or value[x], not both
... Extension I0..*base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaExtension
URL: http://hl7.org/fhir/StructureDefinition/Extension
ext-1: Must have either extensions or value[x], not both
... Extension I0..*base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaExtension
URL: http://hl7.org/fhir/StructureDefinition/Extension
ext-1: Must have either extensions or value[x], not both
... Extension I0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaExtension
URL: http://hl7.org/fhir/StructureDefinition/Extension
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ∑0..*IdentifierIdentifier(s) by which this encounter is known
... status ?! ∑1..1codeplanned | arrived | in-progress | onleave | finished | cancelled | entered-in-error
Binding: EncounterStatus (required)
... statusHistory 0..*BackboneElementList of past encounter statuses
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... status 1..1codeplanned | arrived | in-progress | onleave | finished | cancelled | entered-in-error
Binding: EncounterStatus (required)
.... period 1..1PeriodThe time that the episode was in the specified status
... class 0..1CodingA reference to a code defined by a terminology system
Binding: ActEncounterCode (extensible)
... type ∑0..*CodeableConceptSpecific type of encounter
Binding: EncounterType (example)
... priority 0..1CodeableConceptIndicates the urgency of the encounter
Binding: HSPC SNOMED Priorities (preferred)
... patient ∑0..1Reference(Patient)The patient present at the encounter
... episodeOfCare ∑0..*Reference(EpisodeOfCare)Episode(s) of care that this encounter should be recorded against
... incomingReferral 0..*Reference(ReferralRequest)The ReferralRequest that initiated this encounter
... participant 0..*BackboneElementList of participants involved in the encounter
.... id 0..1stringxml:id (or equivalent in JSON)
.... Extension I0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaExtension
URL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: ???? (preferred)
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... type 0..*CodeableConceptRole of participant in encounter
Binding: v3 Code System ParticipationType (preferred)
.... period 0..1PeriodPeriod of time during the encounter participant was present
.... individual ∑0..1Reference(Practitioner | RelatedPerson)Persons involved in the encounter other than the patient
... appointment ∑0..1Reference(Appointment)The appointment that scheduled this encounter
... period 0..1PeriodThe start and end time of the encounter
... length 0..1DurationQuantity of time the encounter lasted (less time absent)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... value ∑0..1decimalNumerical value (with implicit precision)
.... comparator ?! ∑0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
.... unit ∑0..1stringUnit representation
.... system 0..1uriPrimitive Type uri
Fixed Value: http://unitsofmeasure.org
.... code 0..1codePrimitive Type code
Fixed Value: d
... reason 0..1CodeableConceptReason the encounter takes place (code)
Binding: HSPC Encounter Reason (example)
... indication 0..*Reference(Condition | Procedure)Reason the encounter takes place (resource)
... account 0..*Reference(Account)The set of accounts that may be used for billing for this Encounter
... hospitalization 0..1BackboneElementDetails about the admission to a healthcare service
.... id 0..1stringxml:id (or equivalent in JSON)
.... Extension I0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaExtension
URL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: v2 Yes/no Indicator (preferred)
ext-1: Must have either extensions or value[x], not both
.... Extension I0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaExtension
URL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: v2 Yes/no Indicator (preferred)
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... preAdmissionIdentifier 0..1IdentifierPre-admission identifier
.... origin 0..1Reference(Location)The location from which the patient came before admission
.... admitSource 0..1CodeableConceptFrom where patient was admitted (physician referral, transfer)
Binding: HSPC Admission Source value set (example)
.... admittingDiagnosis 0..*Reference(Condition)The admitting diagnosis as reported by admitting practitioner
.... reAdmission 0..1CodeableConceptThe type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: v2 Re-Admission Indicator (example)
.... dietPreference 0..*CodeableConceptDiet preferences reported by the patient
Binding: HSPC Diet Type value set. (preferred)
.... specialCourtesy 0..*CodeableConceptSpecial courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred)
.... specialArrangement 0..*CodeableConceptWheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred)
.... destination 0..1Reference(Location)Location to which the patient is discharged
.... dischargeDisposition 0..1CodeableConceptCategory or kind of location after discharge
Binding: DischargeDisposition (example)
.... dischargeDiagnosis 0..*Reference(Condition)The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete
... location BackboneElementList of locations where the patient has been
Slice: Unordered, Open, by Encounter.location.location|flase|open
... location 0..1BackboneElementList of locations where the patient has been
.... id 0..1stringxml:id (or equivalent in JSON)
.... Extension I0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaExtension
URL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: HSPC Patient Arrival Status (preferred)
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... location 1..1Reference(Reference)A reference from one resource to another
.... status 0..1codeplanned | active | reserved | completed
Binding: EncounterLocationStatus (required)
.... period 0..1PeriodTime period during which the patient was present at the location
... location 0..1BackboneElementList of locations where the patient has been
.... id 0..1stringxml:id (or equivalent in JSON)
.... Extension I0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaExtension
URL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: HSPC Service Delivery Location Condition value set (preferred)
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... location 1..1Reference(Reference)A reference from one resource to another
.... status 0..1codeplanned | active | reserved | completed
Binding: EncounterLocationStatus (required)
.... period 0..1PeriodTime period during which the patient was present at the location
... serviceProvider 0..1Reference(Organization)The custodian organization of this Encounter record
... partOf 0..1Reference(Encounter)Another Encounter this encounter is part of

doco Documentation for this format

Definitions

Encounter(HSPC Inpatient 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.

Control0..*
Alternate NamesVisit
Encounter.id
Definition

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

Control0..1
Typeid
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.

Encounter.meta
Definition

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

Control0..1
TypeMeta
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.

Control0..1
Typeuri
Is Modifiertrue
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 as much as possible.

Encounter.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable
Typecode
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).

Encounter.text
Definition

A human-readable narrative that contains a summary of the resource, and may 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.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
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 in formation is added later.

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.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained 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.

Encounter.extension
Definition

An Extension

Control0..*
TypeExtension
Encounter.extension (http://hl7.org/fhir/StructureDefinition/Extension)
Definition

Optional Extensions Element - found in all resources.

Control0..*
Type (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta)
InvariantsDefined on this element
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
Encounter.extension (http://hl7.org/fhir/StructureDefinition/Extension)
Definition

Optional Extensions Element - found in all resources.

Control0..*
Type (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta)
InvariantsDefined on this element
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
Encounter.extension (http://hl7.org/fhir/StructureDefinition/Extension)
Definition

Optional Extensions Element - found in all resources.

Control0..*
Type (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta)
InvariantsDefined on this element
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
Encounter.extension (http://hl7.org/fhir/StructureDefinition/Extension)
Definition

Optional Extensions Element - found in all resources.

Control0..*
Type (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta)
InvariantsDefined on this element
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
Encounter.extension (http://hl7.org/fhir/StructureDefinition/Extension)
Definition

Optional Extensions Element - found in all resources.

Control0..*
Type (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta)
InvariantsDefined on this element
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
Encounter.extension (http://hl7.org/fhir/StructureDefinition/Extension)
Definition

Optional Extensions Element - found in all resources.

Control0..*
Type (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta)
InvariantsDefined on this element
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
Encounter.extension (http://hl7.org/fhir/StructureDefinition/Extension)
Definition

Optional Extensions Element - found in all resources.

Control0..*
Type (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta)
InvariantsDefined on this element
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
Encounter.extension (http://hl7.org/fhir/StructureDefinition/Extension)
Definition

Optional Extensions Element - found in all resources.

Control0..*
Type (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta)
InvariantsDefined on this element
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
Encounter.extension (http://hl7.org/fhir/StructureDefinition/Extension)
Definition

Optional Extensions Element - found in all resources.

Control0..*
Type (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta)
InvariantsDefined on this element
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
Encounter.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
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.

Encounter.identifier
Definition

Identifier(s) by which this encounter is known.

Control0..*
TypeIdentifier
Encounter.status
Definition

planned | arrived | in-progress | onleave | finished | cancelled | entered-in-error.

Control1..1
BindingCurrent state of the encounter
The codes SHALL be taken from EncounterStatus
Typecode
Is Modifiertrue
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.

Control0..*
TypeBackboneElement
Comments

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

Encounter.statusHistory.id
Definition

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

Control0..1
Typestring
Encounter.statusHistory.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

Encounter.statusHistory.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
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.

Encounter.statusHistory.status
Definition

planned | arrived | in-progress | onleave | finished | cancelled | entered-in-error.

Control1..1
BindingCurrent state of the encounter
The codes SHALL be taken from EncounterStatus
Typecode
Encounter.statusHistory.period
Definition

The time that the episode was in the specified status.

Control1..1
TypePeriod
Encounter.class
Definition

A reference to a code defined by a terminology system.

Control0..1
BindingClassification of the encounter
The codes SHALL be taken from ActEncounterCode; other codes may be used where these codes are not suitable
TypeCoding(Coding)
Comments

Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.

Encounter.type
Definition

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

Control0..*
BindingThe type of encounter
For example codes, see EncounterType
TypeCodeableConcept
Comments

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

Encounter.priority
Definition

Indicates the urgency of the encounter.

Control0..1
TypeCodeableConcept
Encounter.patient
Definition

The patient present at the encounter.

Control0..1
TypeReference(Patient)
Alternate Namespatient
Comments

While the encounter is always about the patient, the patient may not actually be known in all contexts of use.

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

Control0..*
TypeReference(EpisodeOfCare)
Encounter.incomingReferral
Definition

The referral request this encounter satisfies (incoming referral).

Control0..*
TypeReference(ReferralRequest)
Encounter.participant
Definition

The list of people responsible for providing the service.

Control0..*
TypeBackboneElement
Encounter.participant.id
Definition

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

Control0..1
Typestring
Encounter.participant.extension (http://hl7.org/fhir/StructureDefinition/Extension)
Definition

Optional Extensions Element - found in all resources.

Control0..*
Type (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta)
InvariantsDefined on this element
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
Encounter.participant.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
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.

Encounter.participant.type
Definition

Role of participant in encounter.

Control0..*
BindingA set of codes that are used to describe how an entity participates in an encounter
The codes SHOULD be taken from v3 Code System ParticipationType
TypeCodeableConcept
Comments

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

Encounter.participant.period
Definition

The period of time that the specified participant was present during the encounter. These can overlap or be sub-sets of the overall encounters period.

Control0..1
TypePeriod
Encounter.participant.individual
Definition

Persons involved in the encounter other than the patient.

Control0..1
TypeChoice of: Reference(Practitioner), Reference(RelatedPerson)
Encounter.appointment
Definition

The appointment that scheduled this encounter.

Control0..1
TypeReference(Appointment)
Encounter.period
Definition

The start and end time of the encounter.

Control0..1
TypePeriod
Comments

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

Encounter.length(LengthOfStay)
Definition

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

Control0..1
TypeDuration
Comments

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

Encounter.length.id
Definition

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

Control0..1
Typestring
Encounter.length.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

Encounter.length.value
Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Control0..1
Typedecimal
Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Encounter.length.comparator
Definition

How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

Control0..1
BindingHow the Quantity should be understood and represented.
The codes SHALL be taken from QuantityComparator
Typecode
Is Modifiertrue
Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Comments

This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value.

Meaning if MissingIf there is no comparator, then there is no modification of the value
Encounter.length.unit
Definition

A human-readable form of the unit.

Control0..1
Typestring
Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Encounter.length.system
Definition

String of characters used to identify a name or a resource

Control0..1
Typeuri(uri)
Comments

see http://en.wikipedia.org/wiki/Uniformresourceidentifier

Fixed Valuehttp://unitsofmeasure.org
Encounter.length.code
Definition

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

Control0..1
Typecode(code)
Fixed Valued
Encounter.reason
Definition

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

Control0..1
TypeCodeableConcept
Alternate NamesIndication, Admission diagnosis
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).

Encounter.indication
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.

Control0..*
TypeChoice of: Reference(Condition), Reference(Procedure)
Alternate NamesAdmission diagnosis
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).

Encounter.account
Definition

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

Control0..*
TypeReference(Account)
Comments

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

Encounter.hospitalization
Definition

Details about the admission to a healthcare service.

Control0..1
TypeBackboneElement
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.

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.

Control0..1
Typestring
Encounter.hospitalization.extension
Definition

An Extension

Control0..*
TypeExtension
Encounter.hospitalization.extension (http://hl7.org/fhir/StructureDefinition/Extension)
Definition

Optional Extensions Element - found in all resources.

Control0..*
Type (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta)
InvariantsDefined on this element
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
Encounter.hospitalization.extension (http://hl7.org/fhir/StructureDefinition/Extension)
Definition

Optional Extensions Element - found in all resources.

Control0..*
Type (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta)
InvariantsDefined on this element
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
Encounter.hospitalization.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
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.

Encounter.hospitalization.preAdmissionIdentifier
Definition

Pre-admission identifier.

Control0..1
TypeIdentifier
Encounter.hospitalization.origin
Definition

The location from which the patient came before admission.

Control0..1
TypeReference(Location)
Encounter.hospitalization.admitSource
Definition

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

Control0..1
TypeCodeableConcept
Encounter.hospitalization.admittingDiagnosis
Definition

The admitting diagnosis field is used to record the diagnosis codes as reported by admitting practitioner. This could be different or in addition to the conditions reported as reason-condition(s) for the encounter.

Control0..*
TypeReference(Condition)
Encounter.hospitalization.reAdmission
Definition

Whether this hospitalization is a readmission and why if known.

Control0..1
BindingThe reason for re-admission of this hospitalization encounter.
For example codes, see v2 Re-Admission Indicator
TypeCodeableConcept
Encounter.hospitalization.dietPreference
Definition

Diet preferences reported by the patient.

Control0..*
TypeCodeableConcept
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.

Comments

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

Encounter.hospitalization.specialCourtesy
Definition

Special courtesies (VIP, board member).

Control0..*
BindingSpecial courtesies
The codes SHOULD be taken from SpecialCourtesy
TypeCodeableConcept
Encounter.hospitalization.specialArrangement
Definition

Wheelchair, translator, stretcher, etc.

Control0..*
BindingSpecial arrangements
The codes SHOULD be taken from SpecialArrangements
TypeCodeableConcept
Encounter.hospitalization.destination
Definition

Location to which the patient is discharged.

Control0..1
TypeReference(Location)
Encounter.hospitalization.dischargeDisposition
Definition

Category or kind of location after discharge.

Control0..1
BindingDischarge Disposition
For example codes, see DischargeDisposition
TypeCodeableConcept
Encounter.hospitalization.dischargeDiagnosis
Definition

The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete.

Control0..*
TypeReference(Condition)
Encounter.location
Definition

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

Control0..*
TypeBackboneElement
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".

Encounter.location(AssignedParticipatingLocation)
Definition

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

Control0..1
TypeBackboneElement
Alternate NamesAssignedParticipatingLocation
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".

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.

Control0..1
Typestring
Encounter.location.extension (http://hl7.org/fhir/StructureDefinition/Extension)
Definition

Optional Extensions Element - found in all resources.

Control0..*
Type (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta)
InvariantsDefined on this element
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
Encounter.location.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
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.

Encounter.location.location
Definition

A reference from one resource to another.

Control1..1
TypeReference(Reference)
Encounter.location.status
Definition

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

Control0..1
BindingThe status of the location.
The codes SHALL be taken from EncounterLocationStatus
Typecode
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.

Encounter.location.period
Definition

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

Control0..1
TypePeriod
Encounter.location(ServiceDeliveryLocation)
Definition

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

Control0..1
TypeBackboneElement
Alternate NamesServiceDeliveryLocationCondition
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".

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.

Control0..1
Typestring
Encounter.location.extension (http://hl7.org/fhir/StructureDefinition/Extension)
Definition

Optional Extensions Element - found in all resources.

Control0..*
Type (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta)
InvariantsDefined on this element
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
Encounter.location.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
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.

Encounter.location.location
Definition

A reference from one resource to another.

Control1..1
TypeReference(Reference)
Encounter.location.status
Definition

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

Control0..1
BindingThe status of the location.
The codes SHALL be taken from EncounterLocationStatus
Typecode
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.

Encounter.location.period
Definition

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

Control0..1
TypePeriod
Encounter.serviceProvider
Definition

An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.

Control0..1
TypeReference(Organization)
Encounter.partOf
Definition

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

Control0..1
TypeReference(Encounter)
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.