Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build United States of America

This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: PlannedEncounter - Detailed Descriptions

Active as of 2023-01-16

Definitions for the 2.16.840.1.113883.10.20.22.4.40 resource profile.

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

1. Encounter
2. Encounter.classCode
Requirements

SHALL contain exactly one [1..1] @classCode="ENC" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-8564).

Pattern ValueENC
3. Encounter.moodCode
BindingThe codes SHALL be taken from Planned moodCode (Act/Encounter/Procedure)For codes, see (unbound)
Requirements

SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (Act/Encounter/Procedure) urn:oid:2.16.840.1.113883.11.20.9.23 STATIC 2014-09-01 (CONF:1098-8565).

4. Encounter.templateId
SlicingThis element introduces a set of slices on Encounter.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ root,
5. Encounter.templateId:primary
SliceNameprimary
Control1..1
Requirements

SHALL contain exactly one [1..1] templateId (CONF:1098-30437) such that it

6. Encounter.templateId:primary.root
Control1..1
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.40" (CONF:1098-30438).

Pattern Value2.16.840.1.113883.10.20.22.4.40
7. Encounter.templateId:primary.extension
Control1..1
Requirements

SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32553).

Pattern Value2014-06-09
8. Encounter.id
Control10..*
Requirements

SHALL contain at least one [1..*] id (CONF:1098-8567).

9. Encounter.code
BindingThe codes SHOULD be taken from Encounter PlannedThe codes SHALL be taken from ActEncounterCode; other codes may be used where these codes are not suitable
Requirements

SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Encounter Planned urn:oid:2.16.840.1.113883.11.20.9.52 DYNAMIC (CONF:1098-31032).

10. Encounter.statusCode
Control10..1
Requirements

SHALL contain exactly one [1..1] statusCode (CONF:1098-30439).

11. Encounter.statusCode.code
Control1..1
Requirements

This statusCode SHALL contain exactly one [1..1] @code="active" Active (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-31880).

Pattern Valueactive
12. Encounter.effectiveTime
Requirements

SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-30440).

13. Encounter.performer
SlicingThis element introduces a set of slices on Encounter.performer. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ Encounter.assignedEntity
14. Encounter.performer
Requirements

MAY contain zero or more [0..*] performer (CONF:1098-30442) such that it

15. Encounter.performer.assignedEntity
Control1..1
Requirements

SHALL contain exactly one [1..1] assignedEntity (CONF:1098-31874).

16. Encounter.author
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author(AuthorParticipation)
Requirements

SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-32045).

17. Encounter.participant
SlicingThis element introduces a set of slices on Encounter.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ typeCode
  • value @ typeCode,
18. Encounter.participant:location
SliceNamelocation
Control0..*
Requirements

MAY contain zero or more [0..*] participant (CONF:1098-30443) such that it

19. Encounter.participant:location.typeCode
Control1..1
Requirements

SHALL contain exactly one [1..1] @typeCode="LOC" Location (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90) (CONF:1098-31875).

Pattern ValueLOC
20. Encounter.participant:location.participantRole
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ParticipantRole(ServiceDeliveryLocation)
Requirements

SHALL contain exactly one [1..1] Service Delivery Location (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.32) (CONF:1098-31876).

21. Encounter.entryRelationship
SlicingThis element introduces a set of slices on Encounter.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ observation
22. Encounter.entryRelationship:priorityPreference
SliceNamepriorityPreference
Control0..1
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1098-31033) such that it

23. Encounter.entryRelationship:priorityPreference.typeCode
Control1..1
Requirements

SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31034).

Pattern ValueREFR
24. Encounter.entryRelationship:priorityPreference.observation
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(PriorityPreference)
Requirements

SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:1098-31035).

25. Encounter.entryRelationship:indication
SliceNameindication
Control0..*
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1098-31877) such that it

26. Encounter.entryRelationship:indication.typeCode
Control1..1
Requirements

SHALL contain exactly one [1..1] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31878).

Pattern ValueRSON
27. Encounter.entryRelationship:indication.observation
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(Indication)
Requirements

SHALL contain exactly one [1..1] Indication (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.19:2014-06-09) (CONF:1098-31879).

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

1. Encounter
Definition

Base definition for all types defined in FHIR type system.

Control10..1*
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
2. Encounter.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @classCode="ENC" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-8564).

Fixed ValueENC
Pattern ValueENC
3. Encounter.moodCode
Control1..1
BindingThe codes SHALL be taken from Planned moodCode (Act/Encounter/Procedure)
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (Act/Encounter/Procedure) urn:oid:2.16.840.1.113883.11.20.9.23 STATIC 2014-09-01 (CONF:1098-8565).

4. Encounter.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
SlicingThis element introduces a set of slices on Encounter.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ root,
5. Encounter.templateId:primary
SliceNameprimary
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain exactly one [1..1] templateId (CONF:1098-30437) such that it

6. Encounter.templateId:primary.root
Definition

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.40" (CONF:1098-30438).

Pattern Value2.16.840.1.113883.10.20.22.4.40
7. Encounter.templateId:primary.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32553).

Pattern Value2014-06-09
8. Encounter.id
Definition

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

Control10..*1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IIid
Requirements

SHALL contain at least one [1..*] id (CONF:1098-8567).

Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

9. Encounter.code
Control0..1
BindingThe codes SHOULD be taken from Encounter Planned
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Requirements

SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Encounter Planned urn:oid:2.16.840.1.113883.11.20.9.52 DYNAMIC (CONF:1098-31032).

10. Encounter.statusCode
Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

SHALL contain exactly one [1..1] statusCode (CONF:1098-30439).

11. Encounter.statusCode.code
Definition

The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This statusCode SHALL contain exactly one [1..1] @code="active" Active (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-31880).

Pattern Valueactive
12. Encounter.statusCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
13. Encounter.statusCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
14. Encounter.statusCode.codeSystemVersion
Definition

If applicable, a version descriptor defined specifically for the given code system.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
15. Encounter.statusCode.displayName
Definition

A name or title for the code, under which the sending system shows the code value to its users.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
16. Encounter.statusCode.originalText
Definition

The text or phrase used as the basis for the coding.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
17. Encounter.statusCode.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
18. Encounter.statusCode.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
19. Encounter.effectiveTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-30440).

20. Encounter.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
SlicingThis element introduces a set of slices on Encounter.performer. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ Encounter.assignedEntity
21. Encounter.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
Requirements

MAY contain zero or more [0..*] performer (CONF:1098-30442) such that it

22. Encounter.performer.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

SHALL contain exactly one [1..1] assignedEntity (CONF:1098-31874).

23. Encounter.author
Definition

Base definition for all types defined in FHIR type system.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author(AuthorParticipation)
Requirements

SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-32045).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. Encounter.participant
Definition

The list of people responsible for providing the service.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2BackboneElement
Comments

Any Patient or Group present in the participation.actor must also be the subject, though the subject may be absent from the participation.actor for cases where the patient (or group) is not present, such as during a case review conference.

SlicingThis element introduces a set of slices on Encounter.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ typeCode
  • value @ typeCode,
25. Encounter.participant:location
SliceNamelocation
Definition

The list of people responsible for providing the service.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2BackboneElement
Requirements

MAY contain zero or more [0..*] participant (CONF:1098-30443) such that it

Comments

Any Patient or Group present in the participation.actor must also be the subject, though the subject may be absent from the participation.actor for cases where the patient (or group) is not present, such as during a case review conference.

26. Encounter.participant:location.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="LOC" Location (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90) (CONF:1098-31875).

Pattern ValueLOC
27. Encounter.participant:location.participantRole
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ParticipantRole(ServiceDeliveryLocation)
Requirements

SHALL contain exactly one [1..1] Service Delivery Location (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.32) (CONF:1098-31876).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. Encounter.entryRelationship
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
enc-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
SlicingThis element introduces a set of slices on Encounter.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ observation
29. Encounter.entryRelationship.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
30. Encounter.entryRelationship.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
31. Encounter.entryRelationship:priorityPreference
SliceNamepriorityPreference
Control0..1
TypeElement
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1098-31033) such that it

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
enc-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
32. Encounter.entryRelationship:priorityPreference.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31034).

Pattern ValueREFR
33. Encounter.entryRelationship:priorityPreference.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
34. Encounter.entryRelationship:priorityPreference.observation
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(PriorityPreference)
Requirements

SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:1098-31035).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. Encounter.entryRelationship:priorityPreference.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
36. Encounter.entryRelationship:priorityPreference.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
37. Encounter.entryRelationship:priorityPreference.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
38. Encounter.entryRelationship:priorityPreference.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
39. Encounter.entryRelationship:priorityPreference.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
40. Encounter.entryRelationship:priorityPreference.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
41. Encounter.entryRelationship:priorityPreference.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
42. Encounter.entryRelationship:priorityPreference.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
43. Encounter.entryRelationship:indication
SliceNameindication
Control0..*
TypeElement
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1098-31877) such that it

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
enc-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
44. Encounter.entryRelationship:indication.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31878).

Pattern ValueRSON
45. Encounter.entryRelationship:indication.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
46. Encounter.entryRelationship:indication.observation
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(Indication)
Requirements

SHALL contain exactly one [1..1] Indication (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.19:2014-06-09) (CONF:1098-31879).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
47. Encounter.entryRelationship:indication.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
48. Encounter.entryRelationship:indication.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
49. Encounter.entryRelationship:indication.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
50. Encounter.entryRelationship:indication.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
51. Encounter.entryRelationship:indication.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
52. Encounter.entryRelationship:indication.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
53. Encounter.entryRelationship:indication.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
54. Encounter.entryRelationship:indication.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act

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

1. Encounter
Definition

Base definition for all types defined in FHIR type system.

Control1..1
2. Encounter.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @classCode="ENC" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-8564).

Fixed ValueENC
Pattern ValueENC
3. Encounter.moodCode
Control1..1
BindingThe codes SHALL be taken from Planned moodCode (Act/Encounter/Procedure)
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (Act/Encounter/Procedure) urn:oid:2.16.840.1.113883.11.20.9.23 STATIC 2014-09-01 (CONF:1098-8565).

4. Encounter.realmCode
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
5. Encounter.typeId
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
6. Encounter.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
SlicingThis element introduces a set of slices on Encounter.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ root,
7. Encounter.templateId:primary
SliceNameprimary
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain exactly one [1..1] templateId (CONF:1098-30437) such that it

8. Encounter.templateId:primary.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
9. Encounter.templateId:primary.assigningAuthorityName
Definition

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
10. Encounter.templateId:primary.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
11. Encounter.templateId:primary.root
Definition

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.40" (CONF:1098-30438).

Pattern Value2.16.840.1.113883.10.20.22.4.40
12. Encounter.templateId:primary.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32553).

Pattern Value2014-06-09
13. Encounter.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain at least one [1..*] id (CONF:1098-8567).

14. Encounter.code
Control0..1
BindingThe codes SHOULD be taken from Encounter Planned
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Requirements

SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Encounter Planned urn:oid:2.16.840.1.113883.11.20.9.52 DYNAMIC (CONF:1098-31032).

15. Encounter.text
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
16. Encounter.statusCode
Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

SHALL contain exactly one [1..1] statusCode (CONF:1098-30439).

17. Encounter.statusCode.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
18. Encounter.statusCode.code
Definition

The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

This statusCode SHALL contain exactly one [1..1] @code="active" Active (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-31880).

Pattern Valueactive
19. Encounter.statusCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
20. Encounter.statusCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
21. Encounter.statusCode.codeSystemVersion
Definition

If applicable, a version descriptor defined specifically for the given code system.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
22. Encounter.statusCode.displayName
Definition

A name or title for the code, under which the sending system shows the code value to its users.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
23. Encounter.statusCode.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet.
24. Encounter.statusCode.sdtcValueSetVersion
Definition

The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion.
25. Encounter.statusCode.originalText
Definition

The text or phrase used as the basis for the coding.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
26. Encounter.statusCode.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
27. Encounter.statusCode.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
28. Encounter.effectiveTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-30440).

29. Encounter.dischargeDispositionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.
30. Encounter.priorityCode
Control0..1
BindingThe codes SHALL be taken from ActPriority; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
31. Encounter.subject
Control0..1
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. Encounter.subject.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.
Summaryfalse
33. Encounter.subject.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Encounter.subject.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
34. Encounter.subject.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetSubject
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueSBJ
Fixed ValueSBJ
35. Encounter.subject.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueOP
Fixed ValueOP
36. Encounter.subject.awarenessCode
Control0..1
BindingThe codes SHALL be taken from TargetAwareness; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
37. Encounter.subject.relatedSubject
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
38. Encounter.specimen
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Specimen
39. Encounter.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
SlicingThis element introduces a set of slices on Encounter.performer. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ Encounter.assignedEntity
40. Encounter.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
Requirements

MAY contain zero or more [0..*] performer (CONF:1098-30442) such that it

41. Encounter.performer.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
42. Encounter.performer.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationPhysicalPerformer
Typecode(cs)
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValuePRF
43. Encounter.performer.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
44. Encounter.performer.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
45. Encounter.performer.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
46. Encounter.performer.functionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.
47. Encounter.performer.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
48. Encounter.performer.modeCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
49. Encounter.performer.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

SHALL contain exactly one [1..1] assignedEntity (CONF:1098-31874).

50. Encounter.author
Definition

Base definition for all types defined in FHIR type system.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author(AuthorParticipation)
Requirements

SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-32045).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
51. Encounter.informant
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
52. Encounter.informant.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.
Summaryfalse
53. Encounter.informant.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Encounter.informant.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
54. Encounter.informant.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationInformationGenerator
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINF
Fixed ValueINF
55. Encounter.informant.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueOP
Fixed ValueOP
56. Encounter.informant.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
57. Encounter.informant.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
58. Encounter.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
SlicingThis element introduces a set of slices on Encounter.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ typeCode
  • value @ typeCode,
59. Encounter.participant:location
SliceNamelocation
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
Requirements

MAY contain zero or more [0..*] participant (CONF:1098-30443) such that it

60. Encounter.participant:location.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
61. Encounter.participant:location.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="LOC" Location (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90) (CONF:1098-31875).

Pattern ValueLOC
62. Encounter.participant:location.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueOP
63. Encounter.participant:location.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
64. Encounter.participant:location.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
65. Encounter.participant:location.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
66. Encounter.participant:location.sdtcFunctionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name functionCode.
67. Encounter.participant:location.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
68. Encounter.participant:location.awarenessCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
69. Encounter.participant:location.participantRole
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ParticipantRole(ServiceDeliveryLocation)
Requirements

SHALL contain exactly one [1..1] Service Delivery Location (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.32) (CONF:1098-31876).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
70. Encounter.entryRelationship
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
enc-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
SlicingThis element introduces a set of slices on Encounter.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ observation
71. Encounter.entryRelationship.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.
Summaryfalse
72. Encounter.entryRelationship.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Encounter.entryRelationship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
73. Encounter.entryRelationship.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
74. Encounter.entryRelationship.inversionInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
75. Encounter.entryRelationship.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
76. Encounter.entryRelationship.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
77. Encounter.entryRelationship.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
78. Encounter.entryRelationship.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
79. Encounter.entryRelationship.observation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
80. Encounter.entryRelationship.regionOfInterest
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
81. Encounter.entryRelationship.observationMedia
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
82. Encounter.entryRelationship.substanceAdministration
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
83. Encounter.entryRelationship.supply
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
84. Encounter.entryRelationship.procedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
85. Encounter.entryRelationship.encounter
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
86. Encounter.entryRelationship.organizer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
87. Encounter.entryRelationship.act
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
88. Encounter.entryRelationship:priorityPreference
SliceNamepriorityPreference
Control0..1
TypeElement
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1098-31033) such that it

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
enc-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
89. Encounter.entryRelationship:priorityPreference.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.
Summaryfalse
90. Encounter.entryRelationship:priorityPreference.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Encounter.entryRelationship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
91. Encounter.entryRelationship:priorityPreference.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31034).

Pattern ValueREFR
92. Encounter.entryRelationship:priorityPreference.inversionInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
93. Encounter.entryRelationship:priorityPreference.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
94. Encounter.entryRelationship:priorityPreference.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
95. Encounter.entryRelationship:priorityPreference.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
96. Encounter.entryRelationship:priorityPreference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
97. Encounter.entryRelationship:priorityPreference.observation
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(PriorityPreference)
Requirements

SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:1098-31035).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
98. Encounter.entryRelationship:priorityPreference.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
99. Encounter.entryRelationship:priorityPreference.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
100. Encounter.entryRelationship:priorityPreference.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
101. Encounter.entryRelationship:priorityPreference.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
102. Encounter.entryRelationship:priorityPreference.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
103. Encounter.entryRelationship:priorityPreference.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
104. Encounter.entryRelationship:priorityPreference.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
105. Encounter.entryRelationship:priorityPreference.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
106. Encounter.entryRelationship:indication
SliceNameindication
Control0..*
TypeElement
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1098-31877) such that it

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
enc-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
107. Encounter.entryRelationship:indication.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.
Summaryfalse
108. Encounter.entryRelationship:indication.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Encounter.entryRelationship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
109. Encounter.entryRelationship:indication.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31878).

Pattern ValueRSON
110. Encounter.entryRelationship:indication.inversionInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
111. Encounter.entryRelationship:indication.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
112. Encounter.entryRelationship:indication.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
113. Encounter.entryRelationship:indication.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
114. Encounter.entryRelationship:indication.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
115. Encounter.entryRelationship:indication.observation
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(Indication)
Requirements

SHALL contain exactly one [1..1] Indication (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.19:2014-06-09) (CONF:1098-31879).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
116. Encounter.entryRelationship:indication.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
117. Encounter.entryRelationship:indication.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
118. Encounter.entryRelationship:indication.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
119. Encounter.entryRelationship:indication.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
120. Encounter.entryRelationship:indication.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
121. Encounter.entryRelationship:indication.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
122. Encounter.entryRelationship:indication.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
123. Encounter.entryRelationship:indication.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
124. Encounter.reference
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
125. Encounter.reference.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.
Summaryfalse
126. Encounter.reference.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Encounter.reference.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
127. Encounter.reference.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
128. Encounter.reference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
129. Encounter.reference.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
130. Encounter.reference.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
131. Encounter.reference.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
132. Encounter.reference.externalDocument
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
133. Encounter.precondition
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition