Consolidated CDA
3.0.0-ballot - ballot United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions

Logical Model: PlannedEncounter - Detailed Descriptions

Draft as of 2023-12-21

Definitions for the PlannedEncounter logical model.

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

0. Encounter
Logical ContainerClinicalDocument (CDA Class)
ValidationInstances of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-code: SHOULD contain code (code.exists())
should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
should-author: SHOULD contain author (author.exists())
2. Encounter.templateId
Control1..?
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 @ extension
4. Encounter.templateId:planned-enc
Slice Nameplanned-enc
Control1..1
6. Encounter.templateId:planned-enc.root
Control1..?
Pattern Value2.16.840.1.113883.10.20.22.4.40
8. Encounter.templateId:planned-enc.extension
Control1..?
Pattern Value2014-06-09
10. Encounter.classCode
Comments

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

12. Encounter.moodCode
Comments

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

BindingThe codes SHALL be taken from Planned moodCode (Act/Encounter/Procedure)
14. Encounter.id
Comments

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

Control1..?
16. Encounter.code
ShortRecords the type of encounter ordered or recommended.
Comments

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

BindingThe codes SHOULD be taken from Encounter Planned
18. Encounter.text
ShortSHOULD reference the portion of section narrative text corresponding to this entry
20. Encounter.text.reference
Invariantsvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative (value.exists() implies value.startsWith('#'))
22. Encounter.statusCode
Comments

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

Control1..?
24. Encounter.statusCode.code
Comments

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

Control1..?
Fixed Valueactive
26. Encounter.effectiveTime
Comments

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

28. Encounter.performer
ShortPerformers represent clinicians who are responsible for assessing and treating the patient.
Comments

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

30. Encounter.performer.assignedEntity
Comments

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

32. Encounter.author
ShortThe author in a planned encounter represents the clinician who is requesting or planning the encounter.
Comments

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

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
34. Encounter.participant
ShortThis location participation captures where the planned or ordered encounter may take place.
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
36. Encounter.participant:location
Slice Namelocation
Comments

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

Control0..*
38. Encounter.participant:location.typeCode
Comments

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

Fixed ValueLOC
40. Encounter.participant:location.participantRole
Comments

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

Typehttp://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole(Service Delivery Location)
42. Encounter.entryRelationship
ShortThe following entryRelationship captures the reason for the planned or ordered encounter
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
44. Encounter.entryRelationship:priorityPreference
Slice NamepriorityPreference
ShortThe following entryRelationship represents the priority that a patient or a provider places on the encounter.
Comments

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

Control0..1
46. Encounter.entryRelationship:priorityPreference.typeCode
Comments

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

Fixed ValueREFR
48. Encounter.entryRelationship:priorityPreference.observation
Comments

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

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Priority Preference)
50. Encounter.entryRelationship:indication
Slice Nameindication
Comments

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

Control0..*
52. Encounter.entryRelationship:indication.typeCode
Comments

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

Fixed ValueRSON
54. Encounter.entryRelationship:indication.observation
Comments

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

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Indication)

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

0. Encounter
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.


Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control10..1*
Is Modifierfalse
Logical ContainerClinicalDocument (CDA Class)
ValidationInstances of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-code: SHOULD contain code (code.exists())
should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
should-author: SHOULD contain author (author.exists())
2. 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

Control1..*
Typehttp://hl7.org/cda/stds/core/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 @ extension
4. Encounter.templateId:planned-enc
Slice Nameplanned-enc
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/cda/stds/core/StructureDefinition/II
6. Encounter.templateId:planned-enc.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(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Pattern Value2.16.840.1.113883.10.20.22.4.40
8. Encounter.templateId:planned-enc.extension
Definition

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

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
Pattern Value2014-06-09
10. Encounter.classCode
Comments

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

Control1..1
BindingThe codes SHALL be taken from ActClass (2.0.0)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueENC
12. Encounter.moodCode
Comments

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

Control1..1
BindingThe codes SHALL be taken from Planned moodCode (Act/Encounter/Procedure)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
14. Encounter.id
Definition

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

ShortLogical id of this artifact
Comments

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


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.

Control10..*1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IIid
Is Modifierfalse
16. Encounter.code
ShortRecords the type of encounter ordered or recommended.
Comments

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

Control0..1
BindingThe codes SHOULD be taken from Encounter Planned
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
18. Encounter.text
Definition

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

ShortSHOULD reference the portion of section narrative text corresponding to this entryText summary of the resource, for human interpretation
Comments

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

Control0..1
This element is affected by the following invariants: dom-6
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EDNarrative
Is Modifierfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Encounter.text.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
LabelReference
Invariantsvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative (value.exists() implies value.startsWith('#'))
22. Encounter.statusCode
Comments

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

Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
24. 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.

Comments

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

Control1..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode
Fixed Valueactive
26. Encounter.statusCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System
28. Encounter.statusCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System Name
30. Encounter.statusCode.codeSystemVersion
Definition

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

Control0..0
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System Version
32. 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(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplay Name
34. Encounter.statusCode.originalText
Definition

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

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
LabelOriginal Text
36. Encounter.statusCode.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
LabelQualifier
38. Encounter.statusCode.translation
Definition

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

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelTranslation
40. Encounter.effectiveTime
Comments

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

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
42. Encounter.performer
ShortPerformers represent clinicians who are responsible for assessing and treating the patient.
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
44. Encounter.performer.assignedEntity
Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
46. Encounter.author
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

ShortThe author in a planned encounter represents the clinician who is requesting or planning the encounter.
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
Is Modifierfalse
48. Encounter.participant
Definition

The list of people responsible for providing the service.

ShortThis location participation captures where the planned or ordered encounter may take place.List of participants involved in the encounter
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.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2BackboneElement
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
enc-1: A type must be provided when no explicit actor is specified (actor.exists() or type.exists())
enc-2: A type cannot be provided for a patient or group participant (actor.exists(resolve() is Patient or resolve() is Group) implies type.exists().not())
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
50. Encounter.participant:location
Slice Namelocation
Definition

The list of people responsible for providing the service.

ShortList of participants involved in the encounter
Comments

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


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.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2BackboneElement
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
enc-1: A type must be provided when no explicit actor is specified (actor.exists() or type.exists())
enc-2: A type cannot be provided for a patient or group participant (actor.exists(resolve() is Patient or resolve() is Group) implies type.exists().not())
52. Encounter.participant:location.typeCode
Comments

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

Control1..1
BindingThe codes SHALL be taken from ParticipationType
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueLOC
54. Encounter.participant:location.participantRole
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

ShortBase for all types and resources
Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole(Service Delivery Location)
Is Modifierfalse
Invariantsrole-choice: playingDevice and playingEntity are mutually exclusive ((playingDevice | playingEntity).count() <= 1)
should-addr: SHOULD contain addr (addr.exists())
should-telecom: SHOULD contain telecom (telecom.exists())
56. Encounter.entryRelationship
ShortThe following entryRelationship captures the reason for the planned or ordered encounter
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/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
58. Encounter.entryRelationship:priorityPreference
Slice NamepriorityPreference
ShortThe following entryRelationship represents the priority that a patient or a provider places on the encounter.
Comments

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

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
60. Encounter.entryRelationship:priorityPreference.typeCode
Comments

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

Control1..1
BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueREFR
62. Encounter.entryRelationship:priorityPreference.observation
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

ShortBase for all types and resources
Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Priority Preference)
Is Modifierfalse
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
should-author: SHOULD contain author (author.exists())
64. Encounter.entryRelationship:indication
Slice Nameindication
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
66. Encounter.entryRelationship:indication.typeCode
Comments

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

Control1..1
BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueRSON
68. Encounter.entryRelationship:indication.observation
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

ShortBase for all types and resources
Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Indication)
Is Modifierfalse
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())

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

0. Encounter
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

ShortBase for all types and resources
Control1..1
Is Modifierfalse
Logical ContainerClinicalDocument (CDA Class)
ValidationInstances of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-code: SHOULD contain code (code.exists())
should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
should-author: SHOULD contain author (author.exists())
2. Encounter.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 CDANullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
4. Encounter.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/cda/stds/core/StructureDefinition/CS
6. Encounter.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/cda/stds/core/StructureDefinition/II
8. Encounter.typeId.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 CDANullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
10. Encounter.typeId.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(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelAssigning Authority Name
12. Encounter.typeId.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(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplayable
14. Encounter.typeId.root
Definition

Identifies the type as an HL7 Registered model

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Fixed Value2.16.840.1.113883.1.3
16. Encounter.typeId.extension
Definition

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

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
18. 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

Control1..*
Typehttp://hl7.org/cda/stds/core/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 @ extension
20. Encounter.templateId:planned-enc
Slice Nameplanned-enc
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/cda/stds/core/StructureDefinition/II
22. Encounter.templateId:planned-enc.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 CDANullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
24. Encounter.templateId:planned-enc.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(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelAssigning Authority Name
26. Encounter.templateId:planned-enc.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(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplayable
28. Encounter.templateId:planned-enc.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(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Pattern Value2.16.840.1.113883.10.20.22.4.40
30. Encounter.templateId:planned-enc.extension
Definition

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

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
Pattern Value2014-06-09
32. Encounter.classCode
Comments

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

Control1..1
BindingThe codes SHALL be taken from ActClass (2.0.0)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueENC
34. Encounter.moodCode
Comments

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

Control1..1
BindingThe codes SHALL be taken from Planned moodCode (Act/Encounter/Procedure)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
36. Encounter.id
Comments

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

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
38. Encounter.code
ShortRecords the type of encounter ordered or recommended.
Comments

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

Control0..1
BindingThe codes SHOULD be taken from Encounter Planned
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
40. Encounter.text
ShortSHOULD reference the portion of section narrative text corresponding to this entry
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
42. Encounter.text.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 CDANullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
44. Encounter.text.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..1
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCompression
46. Encounter.text.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..1
Typebase64Binary(bin: Binary Data)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelIntegrity Check
48. Encounter.text.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..1
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm (2.0.0)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelIntegrity Check Algorithm
50. Encounter.text.language
Definition

For character based information the language property specifies the human language of the text.

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelLanguage
52. Encounter.text.mediaType
Definition

Identifies the type of the encapsulated data and identifies a method to interpret or render the data.

Control0..1
BindingFor example codes, see MediaType
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelMedia Type
54. Encounter.text.representation
Control0..1
BindingThe codes SHALL be taken from Binary Data Encoding Value Set
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
56. Encounter.text.xmlText
Definition

Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)

ShortAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
Comments

This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as unadorned text.
58. Encounter.text.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
LabelReference
Invariantsvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative (value.exists() implies value.startsWith('#'))
60. Encounter.text.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
LabelThumbnail
62. Encounter.statusCode
Comments

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

Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
64. 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 CDANullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
66. 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.

Comments

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

Control1..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode
Fixed Valueactive
68. Encounter.statusCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System
70. Encounter.statusCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System Name
72. Encounter.statusCode.codeSystemVersion
Definition

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

Control0..0
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System Version
74. 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(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplay Name
76. 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(oid: ISO Object Identifier)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn 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 namevalueSet.
78. 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(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn 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 namevalueSetVersion.
80. Encounter.statusCode.originalText
Definition

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

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
LabelOriginal Text
82. Encounter.statusCode.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
LabelQualifier
84. Encounter.statusCode.translation
Definition

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

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelTranslation
86. Encounter.effectiveTime
Comments

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

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
88. Encounter.sdtcDischargeDispositionCode
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedischargeDispositionCode.
90. Encounter.priorityCode
Control0..1
BindingFor example codes, see ActPriority
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
92. Encounter.subject
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
94. Encounter.specimen
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
96. Encounter.performer
ShortPerformers represent clinicians who are responsible for assessing and treating the patient.
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
98. 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 CDANullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
100. 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/cda/stds/core/StructureDefinition/CS
102. 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/cda/stds/core/StructureDefinition/II
104. Encounter.performer.typeId.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 CDANullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
106. Encounter.performer.typeId.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(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelAssigning Authority Name
108. Encounter.performer.typeId.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(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplayable
110. Encounter.performer.typeId.root
Definition

Identifies the type as an HL7 Registered model

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Fixed Value2.16.840.1.113883.1.3
112. Encounter.performer.typeId.extension
Definition

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

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
114. 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/cda/stds/core/StructureDefinition/II
116. Encounter.performer.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationPhysicalPerformer
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValuePRF
118. Encounter.performer.sdtcFunctionCode
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namefunctionCode.
120. Encounter.performer.time
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
122. Encounter.performer.modeCode
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
124. Encounter.performer.assignedEntity
Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
126. Encounter.author
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

ShortThe author in a planned encounter represents the clinician who is requesting or planning the encounter.
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
Is Modifierfalse
128. Encounter.informant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
130. Encounter.participant
ShortThis location participation captures where the planned or ordered encounter may take place.
Control0..*
Typehttp://hl7.org/cda/stds/core/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
132. Encounter.participant:location
Slice Namelocation
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
134. 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 CDANullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
136. 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/cda/stds/core/StructureDefinition/CS
138. 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/cda/stds/core/StructureDefinition/II
140. Encounter.participant:location.typeId.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 CDANullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
142. Encounter.participant:location.typeId.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(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelAssigning Authority Name
144. Encounter.participant:location.typeId.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(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplayable
146. Encounter.participant:location.typeId.root
Definition

Identifies the type as an HL7 Registered model

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Fixed Value2.16.840.1.113883.1.3
148. Encounter.participant:location.typeId.extension
Definition

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

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
150. 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/cda/stds/core/StructureDefinition/II
152. Encounter.participant:location.typeCode
Comments

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

Control1..1
BindingThe codes SHALL be taken from ParticipationType
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueLOC
154. Encounter.participant:location.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueOP
156. Encounter.participant:location.sdtcFunctionCode
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namefunctionCode.
158. Encounter.participant:location.time
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
160. Encounter.participant:location.awarenessCode
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
162. Encounter.participant:location.participantRole
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

ShortBase for all types and resources
Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole(Service Delivery Location)
Is Modifierfalse
Invariantsrole-choice: playingDevice and playingEntity are mutually exclusive ((playingDevice | playingEntity).count() <= 1)
should-addr: SHOULD contain addr (addr.exists())
should-telecom: SHOULD contain telecom (telecom.exists())
164. Encounter.entryRelationship
ShortThe following entryRelationship captures the reason for the planned or ordered encounter
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/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
166. Encounter.entryRelationship:priorityPreference
Slice NamepriorityPreference
ShortThe following entryRelationship represents the priority that a patient or a provider places on the encounter.
Comments

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

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
168. Encounter.entryRelationship:priorityPreference.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 CDANullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
170. Encounter.entryRelationship:priorityPreference.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/cda/stds/core/StructureDefinition/CS
172. Encounter.entryRelationship:priorityPreference.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/cda/stds/core/StructureDefinition/II
174. Encounter.entryRelationship:priorityPreference.typeId.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 CDANullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
176. Encounter.entryRelationship:priorityPreference.typeId.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(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelAssigning Authority Name
178. Encounter.entryRelationship:priorityPreference.typeId.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(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplayable
180. Encounter.entryRelationship:priorityPreference.typeId.root
Definition

Identifies the type as an HL7 Registered model

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Fixed Value2.16.840.1.113883.1.3
182. Encounter.entryRelationship:priorityPreference.typeId.extension
Definition

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

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
184. Encounter.entryRelationship:priorityPreference.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/cda/stds/core/StructureDefinition/II
186. Encounter.entryRelationship:priorityPreference.typeCode
Comments

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

Control1..1
BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueREFR
188. Encounter.entryRelationship:priorityPreference.inversionInd
Definition

The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
190. Encounter.entryRelationship:priorityPreference.contextConductionInd
Definition

The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Default Valuetrue
192. Encounter.entryRelationship:priorityPreference.negationInd
Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
194. Encounter.entryRelationship:priorityPreference.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
196. Encounter.entryRelationship:priorityPreference.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
198. Encounter.entryRelationship:priorityPreference.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
200. Encounter.entryRelationship:priorityPreference.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
202. Encounter.entryRelationship:priorityPreference.observation
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

ShortBase for all types and resources
Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Priority Preference)
Is Modifierfalse
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
should-author: SHOULD contain author (author.exists())
204. Encounter.entryRelationship:priorityPreference.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
206. Encounter.entryRelationship:priorityPreference.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
208. Encounter.entryRelationship:priorityPreference.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
210. Encounter.entryRelationship:priorityPreference.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
212. Encounter.entryRelationship:priorityPreference.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
214. Encounter.entryRelationship:priorityPreference.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
216. Encounter.entryRelationship:indication
Slice Nameindication
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
218. Encounter.entryRelationship:indication.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 CDANullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
220. Encounter.entryRelationship:indication.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/cda/stds/core/StructureDefinition/CS
222. Encounter.entryRelationship:indication.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/cda/stds/core/StructureDefinition/II
224. Encounter.entryRelationship:indication.typeId.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 CDANullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
226. Encounter.entryRelationship:indication.typeId.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(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelAssigning Authority Name
228. Encounter.entryRelationship:indication.typeId.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(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplayable
230. Encounter.entryRelationship:indication.typeId.root
Definition

Identifies the type as an HL7 Registered model

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Fixed Value2.16.840.1.113883.1.3
232. Encounter.entryRelationship:indication.typeId.extension
Definition

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

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
234. Encounter.entryRelationship:indication.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/cda/stds/core/StructureDefinition/II
236. Encounter.entryRelationship:indication.typeCode
Comments

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

Control1..1
BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueRSON
238. Encounter.entryRelationship:indication.inversionInd
Definition

The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
240. Encounter.entryRelationship:indication.contextConductionInd
Definition

The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Default Valuetrue
242. Encounter.entryRelationship:indication.negationInd
Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
244. Encounter.entryRelationship:indication.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
246. Encounter.entryRelationship:indication.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
248. Encounter.entryRelationship:indication.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
250. Encounter.entryRelationship:indication.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
252. Encounter.entryRelationship:indication.observation
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

ShortBase for all types and resources
Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Indication)
Is Modifierfalse
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
254. Encounter.entryRelationship:indication.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
256. Encounter.entryRelationship:indication.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
258. Encounter.entryRelationship:indication.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
260. Encounter.entryRelationship:indication.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
262. Encounter.entryRelationship:indication.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
264. Encounter.entryRelationship:indication.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
266. Encounter.reference
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
268. Encounter.precondition
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
270. Encounter.sdtcPrecondition2
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition2
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameprecondition2.
272. Encounter.sdtcInFulfillmentOf1
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameinFulfillmentOf1.