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: EncounterActivity - Detailed Descriptions

Active as of 2023-01-16

Definitions for the 2.16.840.1.113883.10.20.22.4.49 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:1198-8710).

Pattern ValueENC
3. Encounter.moodCode
Requirements

SHALL contain exactly one [1..1] @moodCode="EVN" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1198-8711).

Pattern ValueEVN
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:1198-8712) 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.49" (CONF:1198-26353).

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

SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32546).

Pattern Value2015-08-01
8. Encounter.id
Control10..*
Requirements

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

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

SHALL contain exactly one [1..1] code, which SHOULD be selected from ValueSet EncounterTypeCode urn:oid:2.16.840.1.113883.3.88.12.80.32 DYNAMIC (CONF:1198-8714).

10. Encounter.code.originalText
Control0..1
Requirements

This code SHOULD contain zero or one [0..1] originalText (CONF:1198-8719).

11. Encounter.code.originalText.reference
Control0..1
Requirements

The originalText, if present, SHOULD contain zero or one [0..1] reference (CONF:1198-15970).

12. Encounter.code.originalText.reference.value
Control0..1
Requirements

The reference, if present, SHOULD contain zero or one [0..1] @value (CONF:1198-15971).

InvariantsDefined on this element
1198-15972: This reference/@value **SHALL** begin with a '#' and **SHALL** point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:1198-15972). (: null)
13. Encounter.code.translation
Control0..1
Requirements

This code MAY contain zero or one [0..1] translation (CONF:1198-32323).

14. Encounter.effectiveTime
Control10..1
Requirements

SHALL contain exactly one [1..1] effectiveTime (CONF:1198-8715).

15. Encounter.dischargeDispositionCode
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.
Requirements

MAY contain zero or one [0..1] sdtc:dischargeDispositionCode (CONF:1198-32176).

InvariantsDefined on this element
1198-32177: This sdtc:dischargeDispositionCode **SHOULD** contain exactly [0..1] *code*, which **SHOULD** be selected from ValueSet 2.16.840.1.113883.3.88.12.80.33 NUBC UB-04 FL17-Patient Status (code system 2.16.840.1.113883.6.301.5) *DYNAMIC* or, if access to NUBC is unavailable, from CodeSystem 2.16.840.1.113883.12.112 HL7 Discharge Disposition (CONF:1198-32177). (: null)
1198-32377: This sdtc:dischargeDispositionCode **SHOULD** contain exactly [0..1] *codeSystem*, which **SHOULD** be either CodeSystem: NUBC 2.16.840.1.113883.6.301.5 *OR* CodeSystem: HL7 Discharge Disposition 2.16.840.1.113883.12.112 (CONF:1198-32377). (: null)
16. Encounter.performer
Requirements

MAY contain zero or more [0..*] performer (CONF:1198-8725).

17. Encounter.performer.assignedEntity
Control1..1
Requirements

The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-8726).

18. Encounter.performer.assignedEntity.code
Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Requirements

This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1198-8727).

19. 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 @ participantRole
  • value @ participantRole,
20. Encounter.participant:location
SliceNamelocation
Control0..*
Requirements

SHOULD contain zero or more [0..*] participant (CONF:1198-8738) such that it

21. 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 STATIC) (CONF:1198-8740).

Pattern ValueLOC
22. 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:1198-14903).

23. 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:
  • value @ act
24. Encounter.entryRelationship:indication
SliceNameindication
Control0..*
Requirements

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

25. 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 STATIC) (CONF:1198-8723).

Pattern ValueRSON
26. 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:1198-14899).

27. Encounter.entryRelationship:diagnosis
SliceNamediagnosis
Control0..*
Requirements

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

28. Encounter.entryRelationship:diagnosis.act
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act(EncounterDiagnosis)
Requirements

SHALL contain exactly one [1..1] Encounter Diagnosis (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.80:2015-08-01) (CONF:1198-15973).

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:1198-8710).

Fixed ValueENC
Pattern ValueENC
3. Encounter.moodCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @moodCode="EVN" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1198-8711).

Pattern ValueEVN
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:1198-8712) 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.49" (CONF:1198-26353).

Pattern Value2.16.840.1.113883.10.20.22.4.49
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="2015-08-01" (CONF:1198-32546).

Pattern Value2015-08-01
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:1198-8713).

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
Control1..1
BindingThe codes SHOULD be taken from EncounterTypeCode
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Requirements

SHALL contain exactly one [1..1] code, which SHOULD be selected from ValueSet EncounterTypeCode urn:oid:2.16.840.1.113883.3.88.12.80.32 DYNAMIC (CONF:1198-8714).

10. Encounter.code.originalText
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
Requirements

This code SHOULD contain zero or one [0..1] originalText (CONF:1198-8719).

11. Encounter.code.originalText.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/fhir/cda/StructureDefinition/TEL
Requirements

The originalText, if present, SHOULD contain zero or one [0..1] reference (CONF:1198-15970).

12. Encounter.code.originalText.reference.value
Control0..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

The reference, if present, SHOULD contain zero or one [0..1] @value (CONF:1198-15971).

InvariantsDefined on this element
1198-15972: This reference/@value **SHALL** begin with a '#' and **SHALL** point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:1198-15972). (: null)
13. Encounter.code.translation
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
Requirements

This code MAY contain zero or one [0..1] translation (CONF:1198-32323).

14. Encounter.effectiveTime
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

SHALL contain exactly one [1..1] effectiveTime (CONF:1198-8715).

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

MAY contain zero or one [0..1] sdtc:dischargeDispositionCode (CONF:1198-32176).

InvariantsDefined on this element
1198-32177: This sdtc:dischargeDispositionCode **SHOULD** contain exactly [0..1] *code*, which **SHOULD** be selected from ValueSet 2.16.840.1.113883.3.88.12.80.33 NUBC UB-04 FL17-Patient Status (code system 2.16.840.1.113883.6.301.5) *DYNAMIC* or, if access to NUBC is unavailable, from CodeSystem 2.16.840.1.113883.12.112 HL7 Discharge Disposition (CONF:1198-32177). (: null)
1198-32377: This sdtc:dischargeDispositionCode **SHOULD** contain exactly [0..1] *codeSystem*, which **SHOULD** be either CodeSystem: NUBC 2.16.840.1.113883.6.301.5 *OR* CodeSystem: HL7 Discharge Disposition 2.16.840.1.113883.12.112 (CONF:1198-32377). (: null)
16. Encounter.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
Requirements

MAY contain zero or more [0..*] performer (CONF:1198-8725).

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

The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-8726).

18. Encounter.performer.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
Fixed ValueASSIGNED
19. Encounter.performer.assignedEntity.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
20. Encounter.performer.assignedEntity.code
Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1198-8727).

21. 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 @ participantRole
  • value @ participantRole,
22. Encounter.participant:location
SliceNamelocation
Definition

The list of people responsible for providing the service.

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

SHOULD contain zero or more [0..*] participant (CONF:1198-8738) 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.

23. 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 STATIC) (CONF:1198-8740).

Pattern ValueLOC
24. 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:1198-14903).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. 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:
  • value @ act
26. Encounter.entryRelationship.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
27. Encounter.entryRelationship.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
28. Encounter.entryRelationship:indication
SliceNameindication
Control0..*
TypeElement
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1198-8722) 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)
29. 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 STATIC) (CONF:1198-8723).

Pattern ValueRSON
30. Encounter.entryRelationship:indication.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
31. 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:1198-14899).

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

MAY contain zero or more [0..*] entryRelationship (CONF:1198-15492) 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)
41. Encounter.entryRelationship:diagnosis.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
42. Encounter.entryRelationship:diagnosis.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
43. Encounter.entryRelationship:diagnosis.observation
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
44. Encounter.entryRelationship:diagnosis.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
45. Encounter.entryRelationship:diagnosis.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
46. Encounter.entryRelationship:diagnosis.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
47. Encounter.entryRelationship:diagnosis.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
48. Encounter.entryRelationship:diagnosis.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
49. Encounter.entryRelationship:diagnosis.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
50. Encounter.entryRelationship:diagnosis.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
51. Encounter.entryRelationship:diagnosis.act
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act(EncounterDiagnosis)
Requirements

SHALL contain exactly one [1..1] Encounter Diagnosis (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.80:2015-08-01) (CONF:1198-15973).

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

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:1198-8710).

Fixed ValueENC
Pattern ValueENC
3. Encounter.moodCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

SHALL contain exactly one [1..1] @moodCode="EVN" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1198-8711).

Pattern ValueEVN
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:1198-8712) 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.49" (CONF:1198-26353).

Pattern Value2.16.840.1.113883.10.20.22.4.49
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="2015-08-01" (CONF:1198-32546).

Pattern Value2015-08-01
13. Encounter.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

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

SHALL contain exactly one [1..1] code, which SHOULD be selected from ValueSet EncounterTypeCode urn:oid:2.16.840.1.113883.3.88.12.80.32 DYNAMIC (CONF:1198-8714).

15. Encounter.code.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.
16. Encounter.code.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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
17. Encounter.code.codeSystem
Definition

Specifies the code system that defines the code.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
18. Encounter.code.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
19. Encounter.code.codeSystemVersion
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
20. Encounter.code.displayName
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
21. Encounter.code.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.
22. Encounter.code.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.
23. Encounter.code.originalText
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
Requirements

This code SHOULD contain zero or one [0..1] originalText (CONF:1198-8719).

24. Encounter.code.originalText.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.
25. Encounter.code.originalText.charset
Definition

For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 [].

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
26. Encounter.code.originalText.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
XML RepresentationIn the XML format, this property is represented as an attribute.
27. Encounter.code.originalText.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
XML RepresentationIn the XML format, this property is represented as an attribute.
28. Encounter.code.originalText.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
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
29. Encounter.code.originalText.language
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
30. Encounter.code.originalText.mediaType
Definition

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

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
31. Encounter.code.originalText.representation
Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
32. Encounter.code.originalText.data[x]
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.)

Control0..1
TypeChoice of: string, base64Binary
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
33. Encounter.code.originalText.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/fhir/cda/StructureDefinition/TEL
Requirements

The originalText, if present, SHOULD contain zero or one [0..1] reference (CONF:1198-15970).

34. Encounter.code.originalText.reference.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.
35. Encounter.code.originalText.reference.value
Control0..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

The reference, if present, SHOULD contain zero or one [0..1] @value (CONF:1198-15971).

InvariantsDefined on this element
1198-15972: This reference/@value **SHALL** begin with a '#' and **SHALL** point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:1198-15972). (: )
36. Encounter.code.originalText.reference.useablePeriod
Definition

Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.

Control0..*
TypeChoice of: http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
XML RepresentationThe type of this property is determined using the xsi:type attribute.
37. Encounter.code.originalText.reference.use
Definition

One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.

Control0..*
BindingThe codes SHALL be taken from AddressUse
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
38. Encounter.code.originalText.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/fhir/cda/StructureDefinition/ED
39. Encounter.code.qualifier
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
40. Encounter.code.translation
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
Requirements

This code MAY contain zero or one [0..1] translation (CONF:1198-32323).

41. Encounter.text
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
42. Encounter.statusCode
Control0..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
43. Encounter.effectiveTime
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

SHALL contain exactly one [1..1] effectiveTime (CONF:1198-8715).

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

MAY contain zero or one [0..1] sdtc:dischargeDispositionCode (CONF:1198-32176).

InvariantsDefined on this element
1198-32177: This sdtc:dischargeDispositionCode **SHOULD** contain exactly [0..1] *code*, which **SHOULD** be selected from ValueSet 2.16.840.1.113883.3.88.12.80.33 NUBC UB-04 FL17-Patient Status (code system 2.16.840.1.113883.6.301.5) *DYNAMIC* or, if access to NUBC is unavailable, from CodeSystem 2.16.840.1.113883.12.112 HL7 Discharge Disposition (CONF:1198-32177). (: )
1198-32377: This sdtc:dischargeDispositionCode **SHOULD** contain exactly [0..1] *codeSystem*, which **SHOULD** be either CodeSystem: NUBC 2.16.840.1.113883.6.301.5 *OR* CodeSystem: HL7 Discharge Disposition 2.16.840.1.113883.12.112 (CONF:1198-32377). (: )
45. 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
46. 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()))
47. 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
48. 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
49. 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
50. 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
51. 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
52. Encounter.subject.relatedSubject
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
53. Encounter.specimen
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Specimen
54. Encounter.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
Requirements

MAY contain zero or more [0..*] performer (CONF:1198-8725).

55. 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.
56. 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
57. 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
58. 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
59. 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
60. 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.
61. Encounter.performer.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
62. Encounter.performer.modeCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
63. Encounter.performer.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Requirements

The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-8726).

64. Encounter.performer.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
Fixed ValueASSIGNED
65. Encounter.performer.assignedEntity.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.performer.assignedEntity.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
67. Encounter.performer.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy.
68. Encounter.performer.assignedEntity.code
Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1198-8727).

69. Encounter.performer.assignedEntity.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
70. Encounter.performer.assignedEntity.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
71. Encounter.performer.assignedEntity.assignedPerson
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
72. Encounter.performer.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
73. Encounter.author
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author
74. 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()))
75. 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
76. 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
77. 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
78. 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
79. Encounter.informant.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
80. Encounter.informant.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
81. 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 @ participantRole
  • value @ participantRole,
82. Encounter.participant:location
SliceNamelocation
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
Requirements

SHOULD contain zero or more [0..*] participant (CONF:1198-8738) such that it

83. 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.
84. 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 STATIC) (CONF:1198-8740).

Pattern ValueLOC
85. 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
86. 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
87. 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
88. 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
89. 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.
90. Encounter.participant:location.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
91. Encounter.participant:location.awarenessCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
92. 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:1198-14903).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
93. 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:
  • value @ act
94. 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
95. 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
96. Encounter.entryRelationship.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
97. Encounter.entryRelationship.inversionInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
98. Encounter.entryRelationship.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
99. Encounter.entryRelationship.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
100. Encounter.entryRelationship.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
101. Encounter.entryRelationship.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
102. Encounter.entryRelationship.observation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
103. Encounter.entryRelationship.regionOfInterest
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
104. Encounter.entryRelationship.observationMedia
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
105. Encounter.entryRelationship.substanceAdministration
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
106. Encounter.entryRelationship.supply
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
107. Encounter.entryRelationship.procedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
108. Encounter.entryRelationship.encounter
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
109. Encounter.entryRelationship.organizer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
110. Encounter.entryRelationship.act
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
111. Encounter.entryRelationship:indication
SliceNameindication
Control0..*
TypeElement
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1198-8722) 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)
112. 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
113. 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
114. 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 STATIC) (CONF:1198-8723).

Pattern ValueRSON
115. Encounter.entryRelationship:indication.inversionInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
116. Encounter.entryRelationship:indication.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
117. Encounter.entryRelationship:indication.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
118. Encounter.entryRelationship:indication.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
119. Encounter.entryRelationship:indication.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
120. 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:1198-14899).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
121. Encounter.entryRelationship:indication.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
122. Encounter.entryRelationship:indication.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
123. Encounter.entryRelationship:indication.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
124. Encounter.entryRelationship:indication.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
125. Encounter.entryRelationship:indication.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
126. Encounter.entryRelationship:indication.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
127. Encounter.entryRelationship:indication.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
128. Encounter.entryRelationship:indication.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
129. Encounter.entryRelationship:diagnosis
SliceNamediagnosis
Control0..*
TypeElement
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1198-15492) 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)
130. Encounter.entryRelationship:diagnosis.id
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
131. Encounter.entryRelationship:diagnosis.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
132. Encounter.entryRelationship:diagnosis.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
133. Encounter.entryRelationship:diagnosis.inversionInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
134. Encounter.entryRelationship:diagnosis.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
135. Encounter.entryRelationship:diagnosis.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
136. Encounter.entryRelationship:diagnosis.negationInd
Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
137. Encounter.entryRelationship:diagnosis.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
138. Encounter.entryRelationship:diagnosis.observation
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
139. Encounter.entryRelationship:diagnosis.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
140. Encounter.entryRelationship:diagnosis.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
141. Encounter.entryRelationship:diagnosis.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
142. Encounter.entryRelationship:diagnosis.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
143. Encounter.entryRelationship:diagnosis.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
144. Encounter.entryRelationship:diagnosis.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
145. Encounter.entryRelationship:diagnosis.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
146. Encounter.entryRelationship:diagnosis.act
Definition

Base definition for all types defined in FHIR type system.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act(EncounterDiagnosis)
Requirements

SHALL contain exactly one [1..1] Encounter Diagnosis (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.80:2015-08-01) (CONF:1198-15973).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
147. 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()))
148. 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
149. 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
150. Encounter.reference.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
151. Encounter.reference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
152. Encounter.reference.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
153. Encounter.reference.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
154. Encounter.reference.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
155. Encounter.reference.externalDocument
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
156. Encounter.precondition
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition