Interweave Implementation Guide
0.1.0 - ci-build

Interweave Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: CareConnect-Encounter-1 - Detailed Descriptions

Draft as of 2018-11-05

Definitions for the CareConnect-Encounter-1 resource profile.

Guidance on how to interpret the contents of this table can be found here.

1. Encounter
2. Encounter.extension
SlicingThis element introduces a set of slices on Encounter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3. Encounter.extension:encounterTransport
SliceNameencounterTransport
Control0..?
TypeExtension(Extension-CareConnect-EncounterTransport-1) (Complex Extension)
4. Encounter.extension:outcomeOfAttendance
SliceNameoutcomeOfAttendance
Control0..?
TypeExtension(Extension-CareConnect-OutcomeOfAttendance-1) (Extension Type: CodeableConcept)
5. Encounter.extension:emergencyCareDischargeStatus
SliceNameemergencyCareDischargeStatus
Control0..?
TypeExtension(Extension-CareConnect-EmergencyCareDischargeStatus-1) (Extension Type: CodeableConcept)
6. Encounter.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..?
7. Encounter.identifier.system
Control1..?
8. Encounter.identifier.value
Control1..?
9. Encounter.identifier.assigner
Control0..?
TypeReference(CareConnect-Organization-1)
10. Encounter.class
Definition

Classification of the encounter.

inpatient | outpatient | ambulatory | emergency +.

11. Encounter.classHistory
Control0..?
12. Encounter.classHistory.class
Definition

Classification of the encounter.

inpatient | outpatient | ambulatory | emergency +.

13. Encounter.type
Control0..?
14. Encounter.type.coding
Control0..1
SlicingThis element introduces a set of slices on Encounter.type.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
15. Encounter.type.coding:snomedCT
SliceNamesnomedCT
Control0..?
BindingThe codes SHALL be taken from Care Connect Encounter Type; other codes may be used where these codes are not suitable A code from the SNOMED Clinical Terminology UK coding system that describes an encounter between a care professional and the patient (or patient's record)
16. Encounter.type.coding:snomedCT.extension
Control0..?
SlicingThis element introduces a set of slices on Encounter.type.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
17. Encounter.type.coding:snomedCT.extension:snomedCTDescriptionID
SliceNamesnomedCTDescriptionID
Control0..?
TypeExtension(Extension-coding-sctdescid) (Complex Extension)
18. Encounter.type.coding:snomedCT.system
Control1..?
Fixed Valuehttp://snomed.info/sct
19. Encounter.type.coding:snomedCT.code
Control1..?
20. Encounter.type.coding:snomedCT.display
Control1..?
21. Encounter.subject
TypeReference(Group|CareConnectPatient1|Patient)
22. Encounter.participant
Control0..?
23. Encounter.participant.individual
TypeReference(RelatedPerson|CareConnect-Practitioner-1|Practitioner)
24. Encounter.reason
Control0..?
25. Encounter.reason.coding
Control0..?
SlicingThis element introduces a set of slices on Encounter.reason.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
26. Encounter.reason.coding:snomedCT
SliceNamesnomedCT
Control0..1
27. Encounter.reason.coding:snomedCT.extension
Control0..?
SlicingThis element introduces a set of slices on Encounter.reason.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
28. Encounter.reason.coding:snomedCT.extension:snomedCTDescriptionID
SliceNamesnomedCTDescriptionID
Control0..?
TypeExtension(Extension-coding-sctdescid) (Complex Extension)
29. Encounter.reason.coding:snomedCT.system
Control1..?
Fixed Valuehttp://snomed.info/sct
30. Encounter.reason.coding:snomedCT.code
Control1..?
31. Encounter.reason.coding:snomedCT.display
Control1..?
32. Encounter.diagnosis
Control0..?
33. Encounter.diagnosis.condition
TypeReference(CareConnect-Procedure-1|CareConnect-Condition-1|Condition|Procedure)
34. Encounter.hospitalization
Control0..?
35. Encounter.hospitalization.extension
SlicingThis element introduces a set of slices on Encounter.hospitalization.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
36. Encounter.hospitalization.extension:admissionMethod
SliceNameadmissionMethod
Control0..?
TypeExtension(Extension-CareConnect-AdmissionMethod-1) (Extension Type: CodeableConcept)
37. Encounter.hospitalization.extension:dischargeMethod
SliceNamedischargeMethod
Control0..?
TypeExtension(Extension-CareConnect-DischargeMethod-1) (Extension Type: CodeableConcept)
38. Encounter.hospitalization.preAdmissionIdentifier
Control0..?
39. Encounter.hospitalization.preAdmissionIdentifier.system
Control1..?
40. Encounter.hospitalization.preAdmissionIdentifier.value
Control1..?
41. Encounter.hospitalization.preAdmissionIdentifier.assigner
Control0..?
TypeReference(CareConnect-Organization-1)
42. Encounter.hospitalization.origin
TypeReference(CareConnect-Location-1|Location)
43. Encounter.hospitalization.admitSource
BindingThe codes SHOULD be taken from NHS Data Model and Dictionary Source Of AdmissionThe codes SHOULD be taken from AdmitSource

The source of admission to a Hospital Provider Spell or a Nursing Episode when the Patient is in a Hospital Site or a Care Home.

From where the patient was admitted.

44. Encounter.hospitalization.reAdmission
Control0..?
45. Encounter.hospitalization.reAdmission.coding
Control0..?
SlicingThis element introduces a set of slices on Encounter.hospitalization.reAdmission.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
46. Encounter.hospitalization.reAdmission.coding:snomedCT
SliceNamesnomedCT
Control0..1
47. Encounter.hospitalization.reAdmission.coding:snomedCT.extension
Control0..?
SlicingThis element introduces a set of slices on Encounter.hospitalization.reAdmission.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
48. Encounter.hospitalization.reAdmission.coding:snomedCT.extension:snomedCTDescriptionID
SliceNamesnomedCTDescriptionID
Control0..?
TypeExtension(Extension-coding-sctdescid) (Complex Extension)
49. Encounter.hospitalization.reAdmission.coding:snomedCT.system
Control1..?
Fixed Valuehttp://snomed.info/sct
50. Encounter.hospitalization.reAdmission.coding:snomedCT.code
Control1..?
51. Encounter.hospitalization.reAdmission.coding:snomedCT.display
Control1..?
52. Encounter.hospitalization.dietPreference
53. Encounter.hospitalization.destination
TypeReference(CareConnect-Location-1|Location)
54. Encounter.hospitalization.dischargeDisposition
BindingFor example codes, see NHS Data Model and Dictionary Discharge DestinationFor example codes, see DischargeDisposition

The destination of a Patient on completion of a Hospital Provider Spell, or a note that the Patient died or was a still birth.

Discharge Disposition

55. Encounter.location
Control0..?
56. Encounter.location.location
TypeReference(CareConnect-Location-1|Location)
57. Encounter.serviceProvider
TypeReference(CareConnect-Organization-1|Organization)
58. Encounter.partOf
TypeReference(CareConnect-Encounter-1|Encounter)

Guidance on how to interpret the contents of this table can be found here.

1. 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
InvariantsDefined on this element
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty())
dom-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 (: contained.where(('#'+id in %resource.descendants().reference).not()).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())
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.

Control0..1
Typeuri
Is Modifiertrue
Summarytrue
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.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

3. Encounter.extension
Definition

An Extension

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

SlicingThis element introduces a set of slices on Encounter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. Encounter.extension:encounterTransport
SliceNameencounterTransport
Definition

Encounter transport.

May be used to represent additional information that is not part of the basic definition of the resource. 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..1* This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-EncounterTransport-1) (Complex Extension)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
5. Encounter.extension:outcomeOfAttendance
SliceNameoutcomeOfAttendance
Definition

Optional Extension Element - found in all resources.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-OutcomeOfAttendance-1) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
6. Encounter.extension:emergencyCareDischargeStatus
SliceNameemergencyCareDischargeStatus
Definition

Optional Extension Element - found in all resources.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-EmergencyCareDischargeStatus-1) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
7. 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.

8. Encounter.status
Definition

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

Control1..1
BindingThe codes SHALL be taken from EncounterStatus

Current state of the encounter

Typecode
Is Modifiertrue
Summarytrue
Comments

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

This element is labeled as a modifier because the status contains codes that mark the encounter as not currently valid.

9. Encounter.class
Definition

Classification of the encounter.

inpatient | outpatient | ambulatory | emergency +.

Control0..1
BindingThe codes SHALL be taken from ActEncounterCode; other codes may be used where these codes are not suitable

Classification of the encounter

TypeCoding
Summarytrue
10. Encounter.subject
Definition

The patient ro group present at the encounter.

Control0..1
TypeReference(Group|CareConnectPatient1|Patient)
Summarytrue
Alternate Namespatient
Comments

While the encounter is always about the patient, the patient may 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).

11. 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(CareConnect-Organization-1|Organization)
12. Encounter.partOf
Definition

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

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

Guidance on how to interpret the contents of this table can be found here.

1. 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
2. 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
Summarytrue
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.

3. 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
Summarytrue
4. 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
Summarytrue
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.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

5. Encounter.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable A human language
Additional BindingsPurpose
AllLanguagesMax Binding
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).

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

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

8. Encounter.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on Encounter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
9. Encounter.extension:encounterTransport
SliceNameencounterTransport
Definition

Encounter transport.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-EncounterTransport-1) (Complex Extension)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. Encounter.extension:outcomeOfAttendance
SliceNameoutcomeOfAttendance
Definition

Optional Extension Element - found in all resources.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-OutcomeOfAttendance-1) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
11. Encounter.extension:emergencyCareDischargeStatus
SliceNameemergencyCareDischargeStatus
Definition

Optional Extension Element - found in all resources.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-EmergencyCareDischargeStatus-1) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
12. 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.

13. Encounter.identifier
Definition

Identifier(s) by which this encounter is known.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
14. Encounter.identifier.id
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
15. Encounter.identifier.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.

SlicingThis element introduces a set of slices on Encounter.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
16. Encounter.identifier.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Typecode
Is Modifiertrue
Summarytrue
Requirements

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

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

17. Encounter.identifier.type
Definition

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

Control0..1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
TypeCodeableConcept
Summarytrue
Requirements

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

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

18. Encounter.identifier.system
Definition

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

Control1..1
Typeuri
Summarytrue
Requirements

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

Example
General:http://www.acme.com/identifiers/patient
19. Encounter.identifier.value
Definition

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

Control1..1
Typestring
Summarytrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Example
General:123456
20. Encounter.identifier.period
Definition

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

Control0..1
TypePeriod
Summarytrue
21. Encounter.identifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(CareConnect-Organization-1)
Summarytrue
Comments

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

22. Encounter.status
Definition

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

Control1..1
BindingThe codes SHALL be taken from EncounterStatus Current state of the encounte
Typecode
Is Modifiertrue
Summarytrue
Comments

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

This element is labeled as a modifier because the status contains codes that mark the encounter as not currently valid.

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
24. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
25. 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.

26. 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
Summarytrue
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.

27. Encounter.statusHistory.status
Definition

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

Control1..1
BindingThe codes SHALL be taken from EncounterStatus Current state of the encounte
Typecode
28. Encounter.statusHistory.period
Definition

The time that the episode was in the specified status.

Control1..1
TypePeriod
29. Encounter.class
Definition

Classification of the encounter.

Control0..1
BindingThe codes SHALL be taken from ActEncounterCode; other codes may be used where these codes are not suitable Classification of the encounte
TypeCoding
Summarytrue
30. 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 transisions 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 kindof discharge from emergency to inpatient.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
31. Encounter.classHistory.id
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
32. Encounter.classHistory.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.

33. Encounter.classHistory.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element 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
Summarytrue
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.

34. Encounter.classHistory.class
Definition

Classification of the encounter.

Control1..1
BindingThe codes SHALL be taken from ActEncounterCode; other codes may be used where these codes are not suitable Classification of the encounte
TypeCoding
35. Encounter.classHistory.period
Definition

The time that the episode was in the specified class.

Control1..1
TypePeriod
36. Encounter.type
Definition

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

Control0..*
BindingFor example codes, see EncounterType The type of encounte
TypeCodeableConcept
Summarytrue
Comments

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

37. Encounter.type.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
XML RepresentationIn the XML format, this property is represented as an attribute.
38. Encounter.type.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.

SlicingThis element introduces a set of slices on Encounter.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
39. Encounter.type.coding
Definition

A reference to a code defined by a terminology system.

Control0..1
TypeCoding
Summarytrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

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

SlicingThis element introduces a set of slices on Encounter.type.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
40. Encounter.type.coding:snomedCT
SliceNamesnomedCT
Definition

A reference to a code defined by a terminology system.

Control0..*
BindingThe codes SHALL be taken from Care Connect Encounter Type; other codes may be used where these codes are not suitable A code from the SNOMED Clinical Terminology UK coding system that describes an encounter between a care professional and the patient (or patient's record)
TypeCoding
Summarytrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

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

41. Encounter.type.coding:snomedCT.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
XML RepresentationIn the XML format, this property is represented as an attribute.
42. Encounter.type.coding:snomedCT.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on Encounter.type.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
43. Encounter.type.coding:snomedCT.extension:snomedCTDescriptionID
SliceNamesnomedCTDescriptionID
Definition

The SNOMED CT Description ID for the display.

Control0..*
TypeExtension(Extension-coding-sctdescid) (Complex Extension)
44. Encounter.type.coding:snomedCT.system
Definition

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

Control1..1
Typeuri
Summarytrue
Requirements

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

Comments

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

Fixed Valuehttp://snomed.info/sct
45. Encounter.type.coding:snomedCT.version
Definition

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

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
Comments

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

46. Encounter.type.coding:snomedCT.code
Definition

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

Control1..1
Typecode
Summarytrue
Requirements

Need to refer to a particular code in the system.

47. Encounter.type.coding:snomedCT.display
Definition

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

Control1..1
Typestring
Summarytrue
Requirements

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

48. Encounter.type.coding:snomedCT.userSelected
Definition

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

Control0..1
Typeboolean
Summarytrue
Requirements

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

Comments

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

49. Encounter.type.text
Definition

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

Control0..1
Typestring
Summarytrue
Requirements

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

Comments

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

50. Encounter.priority
Definition

Indicates the urgency of the encounter.

Control0..1
BindingFor example codes, see ActPriority Indicates the urgency of the encounter
TypeCodeableConcept
51. Encounter.subject
Definition

The patient ro group present at the encounter.

Control0..1
TypeReference(Group|CareConnectPatient1)
Summarytrue
Alternate Namespatient
Comments

While the encounter is always about the patient, the patient may 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).

52. 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)
Summarytrue
53. Encounter.incomingReferral
Definition

The referral request this encounter satisfies (incoming referral).

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

The list of people responsible for providing the service.

Control0..*
TypeBackboneElement
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
55. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
56. Encounter.participant.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.

57. 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
Summarytrue
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.

58. Encounter.participant.type
Definition

Role of participant in encounter.

Control0..*
BindingThe codes SHALL be taken from ParticipantType; other codes may be used where these codes are not suitable Role of participant in encounte
TypeCodeableConcept
Summarytrue
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.

59. Encounter.participant.period
Definition

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

Control0..1
TypePeriod
60. Encounter.participant.individual
Definition

Persons involved in the encounter other than the patient.

Control0..1
TypeReference(RelatedPerson|CareConnect-Practitioner-1)
Summarytrue
61. Encounter.appointment
Definition

The appointment that scheduled this encounter.

Control0..1
TypeReference(Appointment)
Summarytrue
62. 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.

63. Encounter.length
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.

64. Encounter.reason
Definition

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

Control0..*
BindingThe codes SHOULD be taken from Encounter Reason Codes Reason why the encounter takes place
TypeCodeableConcept
Summarytrue
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).

65. Encounter.reason.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
XML RepresentationIn the XML format, this property is represented as an attribute.
66. Encounter.reason.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.

SlicingThis element introduces a set of slices on Encounter.reason.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
67. Encounter.reason.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Summarytrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

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

SlicingThis element introduces a set of slices on Encounter.reason.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
68. Encounter.reason.coding:snomedCT
SliceNamesnomedCT
Definition

A reference to a code defined by a terminology system.

Control0..1
TypeCoding
Summarytrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

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

69. Encounter.reason.coding:snomedCT.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
XML RepresentationIn the XML format, this property is represented as an attribute.
70. Encounter.reason.coding:snomedCT.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on Encounter.reason.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
71. Encounter.reason.coding:snomedCT.extension:snomedCTDescriptionID
SliceNamesnomedCTDescriptionID
Definition

The SNOMED CT Description ID for the display.

Control0..*
TypeExtension(Extension-coding-sctdescid) (Complex Extension)
72. Encounter.reason.coding:snomedCT.system
Definition

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

Control1..1
Typeuri
Summarytrue
Requirements

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

Comments

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

Fixed Valuehttp://snomed.info/sct
73. Encounter.reason.coding:snomedCT.version
Definition

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

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
Comments

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

74. Encounter.reason.coding:snomedCT.code
Definition

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

Control1..1
Typecode
Summarytrue
Requirements

Need to refer to a particular code in the system.

75. Encounter.reason.coding:snomedCT.display
Definition

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

Control1..1
Typestring
Summarytrue
Requirements

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

76. Encounter.reason.coding:snomedCT.userSelected
Definition

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

Control0..1
Typeboolean
Summarytrue
Requirements

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

Comments

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

77. Encounter.reason.text
Definition

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

Control0..1
Typestring
Summarytrue
Requirements

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

Comments

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

78. Encounter.diagnosis
Definition

The list of diagnosis relevant to this encounter.

Control0..*
TypeBackboneElement
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
79. 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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
80. Encounter.diagnosis.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.

81. Encounter.diagnosis.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element 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
Summarytrue
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.

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

Control1..1
TypeReference(CareConnect-Procedure-1|CareConnect-Condition-1)
Alternate NamesAdmission diagnosis, discharge diagnosis, indication
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).

83. Encounter.diagnosis.role
Definition

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

Control0..1
BindingThe codes SHOULD be taken from DiagnosisRole The type of diagnosis this condition represent
TypeCodeableConcept
84. Encounter.diagnosis.rank
Definition

Ranking of the diagnosis (for each role type).

Control0..1
TypepositiveInt
85. 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.

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
87. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
88. Encounter.hospitalization.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on Encounter.hospitalization.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
89. Encounter.hospitalization.extension:admissionMethod
SliceNameadmissionMethod
Definition

Optional Extension Element - found in all resources.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-AdmissionMethod-1) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
90. Encounter.hospitalization.extension:dischargeMethod
SliceNamedischargeMethod
Definition

Optional Extension Element - found in all resources.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-DischargeMethod-1) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
91. 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
Summarytrue
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.

92. Encounter.hospitalization.preAdmissionIdentifier
Definition

Pre-admission identifier.

Control0..1
TypeIdentifier
93. Encounter.hospitalization.preAdmissionIdentifier.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
XML RepresentationIn the XML format, this property is represented as an attribute.
94. Encounter.hospitalization.preAdmissionIdentifier.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.

SlicingThis element introduces a set of slices on Encounter.hospitalization.preAdmissionIdentifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
95. Encounter.hospitalization.preAdmissionIdentifier.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Typecode
Is Modifiertrue
Summarytrue
Requirements

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

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

96. Encounter.hospitalization.preAdmissionIdentifier.type
Definition

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

Control0..1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
TypeCodeableConcept
Summarytrue
Requirements

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

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

97. Encounter.hospitalization.preAdmissionIdentifier.system
Definition

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

Control1..1
Typeuri
Summarytrue
Requirements

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

Example
General:http://www.acme.com/identifiers/patient
98. Encounter.hospitalization.preAdmissionIdentifier.value
Definition

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

Control1..1
Typestring
Summarytrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Example
General:123456
99. Encounter.hospitalization.preAdmissionIdentifier.period
Definition

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

Control0..1
TypePeriod
Summarytrue
100. Encounter.hospitalization.preAdmissionIdentifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(CareConnect-Organization-1)
Summarytrue
Comments

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

101. Encounter.hospitalization.origin
Definition

The location from which the patient came before admission.

Control0..1
TypeReference(CareConnect-Location-1)
102. Encounter.hospitalization.admitSource
Definition

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

Control0..1
BindingThe codes SHOULD be taken from NHS Data Model and Dictionary Source Of Admission The source of admission to a Hospital Provider Spell or a Nursing Episode when the Patient is in a Hospital Site or a Care Home
TypeCodeableConcept
103. Encounter.hospitalization.reAdmission
Definition

Whether this hospitalization is a readmission and why if known.

Control0..1
BindingFor example codes, see v2 Re-Admission Indicator The reason for re-admission of this hospitalization encounter
TypeCodeableConcept
104. Encounter.hospitalization.reAdmission.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
XML RepresentationIn the XML format, this property is represented as an attribute.
105. Encounter.hospitalization.reAdmission.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.

SlicingThis element introduces a set of slices on Encounter.hospitalization.reAdmission.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
106. Encounter.hospitalization.reAdmission.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Summarytrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

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

SlicingThis element introduces a set of slices on Encounter.hospitalization.reAdmission.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
107. Encounter.hospitalization.reAdmission.coding:snomedCT
SliceNamesnomedCT
Definition

A reference to a code defined by a terminology system.

Control0..1
TypeCoding
Summarytrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

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

108. Encounter.hospitalization.reAdmission.coding:snomedCT.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
XML RepresentationIn the XML format, this property is represented as an attribute.
109. Encounter.hospitalization.reAdmission.coding:snomedCT.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on Encounter.hospitalization.reAdmission.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
110. Encounter.hospitalization.reAdmission.coding:snomedCT.extension:snomedCTDescriptionID
SliceNamesnomedCTDescriptionID
Definition

The SNOMED CT Description ID for the display.

Control0..*
TypeExtension(Extension-coding-sctdescid) (Complex Extension)
111. Encounter.hospitalization.reAdmission.coding:snomedCT.system
Definition

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

Control1..1
Typeuri
Summarytrue
Requirements

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

Comments

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

Fixed Valuehttp://snomed.info/sct
112. Encounter.hospitalization.reAdmission.coding:snomedCT.version
Definition

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

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
Comments

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

113. Encounter.hospitalization.reAdmission.coding:snomedCT.code
Definition

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

Control1..1
Typecode
Summarytrue
Requirements

Need to refer to a particular code in the system.

114. Encounter.hospitalization.reAdmission.coding:snomedCT.display
Definition

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

Control1..1
Typestring
Summarytrue
Requirements

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

115. Encounter.hospitalization.reAdmission.coding:snomedCT.userSelected
Definition

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

Control0..1
Typeboolean
Summarytrue
Requirements

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

Comments

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

116. Encounter.hospitalization.reAdmission.text
Definition

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

Control0..1
Typestring
Summarytrue
Requirements

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

Comments

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

117. Encounter.hospitalization.dietPreference
Definition

Diet preferences reported by the patient.

Control0..*
BindingThe codes SHALL be taken from Diet; other codes may be used where these codes are not suitable
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).

118. Encounter.hospitalization.specialCourtesy
Definition

Special courtesies (VIP, board member).

Control0..*
BindingThe codes SHOULD be taken from SpecialCourtesy Special courtesie
TypeCodeableConcept
119. 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.

Control0..*
BindingThe codes SHOULD be taken from SpecialArrangements Special arrangement
TypeCodeableConcept
120. Encounter.hospitalization.destination
Definition

Location to which the patient is discharged.

Control0..1
TypeReference(CareConnect-Location-1)
121. Encounter.hospitalization.dischargeDisposition
Definition

Category or kind of location after discharge.

Control0..1
BindingFor example codes, see NHS Data Model and Dictionary Discharge Destination The destination of a Patient on completion of a Hospital Provider Spell, or a note that the Patient died or was a still birth
TypeCodeableConcept
122. 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".

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
123. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
124. Encounter.location.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.

125. 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
Summarytrue
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.

126. Encounter.location.location
Definition

The location where the encounter takes place.

Control1..1
TypeReference(CareConnect-Location-1)
127. 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 codes SHALL be taken from EncounterLocationStatus The status of the location
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.

128. Encounter.location.period
Definition

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

Control0..1
TypePeriod
129. 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(CareConnect-Organization-1)
130. Encounter.partOf
Definition

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

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