Consolidated CDA Release 2.2
2.2 - CI Build Unknown state code 'US'

Consolidated CDA Release 2.2 - Local Development build (v2.2). See the Directory of published versions

Resource Profile: PlannedEncounter - Detailed Descriptions

Active as of 2023-05-30

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

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*
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.
Fixed ValueENC
3. Encounter.moodCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.

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.
Fixed ValueENC
3. Encounter.moodCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
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
7. Encounter.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
8. Encounter.code
Control0..1
BindingThe codes SHALL be taken from ActEncounterCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
9. Encounter.text
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
10. Encounter.statusCode
Control0..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
11. Encounter.effectiveTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
12. 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.
13. 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
14. 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()))
15. 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
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
16. 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
17. 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
18. 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
19. 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
20. Encounter.subject.relatedSubject
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
21. Encounter.specimen
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Specimen
22. Encounter.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
23. Encounter.author
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author
24. 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()))
25. 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
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
26. 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
27. 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
28. 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
29. Encounter.informant.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
30. Encounter.informant.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
31. Encounter.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
32. 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)
33. 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
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
34. 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
35. Encounter.entryRelationship.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
36. Encounter.entryRelationship.inversionInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
37. Encounter.entryRelationship.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
38. Encounter.entryRelationship.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
39. Encounter.entryRelationship.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
40. Encounter.entryRelationship.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
41. Encounter.entryRelationship.observation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
42. Encounter.entryRelationship.regionOfInterest
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
43. Encounter.entryRelationship.observationMedia
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
44. Encounter.entryRelationship.substanceAdministration
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
45. Encounter.entryRelationship.supply
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
46. Encounter.entryRelationship.procedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
47. Encounter.entryRelationship.encounter
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
48. Encounter.entryRelationship.organizer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
49. Encounter.entryRelationship.act
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
50. 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()))
51. 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
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
52. 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
53. Encounter.reference.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
54. Encounter.reference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
55. Encounter.reference.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
56. Encounter.reference.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
57. Encounter.reference.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
58. Encounter.reference.externalDocument
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
59. Encounter.precondition
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition