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

Active as of 2023-12-21

Definitions for the OperativeNote logical model.

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

0. ClinicalDocument
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.
2. ClinicalDocument.templateId
Control2..?
4. ClinicalDocument.templateId:operative-note
Slice Nameoperative-note
Control1..1
6. ClinicalDocument.templateId:operative-note.root
Control1..?
Pattern Value2.16.840.1.113883.10.20.22.1.7
8. ClinicalDocument.templateId:operative-note.extension
Control1..?
Pattern Value2024-05-01
10. ClinicalDocument.code
ShortThe Operative Note recommends use of a single document type code, 11504-8 "Provider-unspecified Operation Note", with further specification provided by author or performer, setting, or specialty data in the CDA header. Some of the LOINC codes in the Surgical Operation Note Document Type Code table are pre-coordinated with the practice setting or the training or professional level of the author. Use of pre-coordinated codes is not recommended because of potential conflict with other information in the header. When these codes are used, any coded values describing the author or performer of the service act or the practice setting must be consistent with the LOINC document type.
Comments

SHALL contain exactly one [1..1] code (CONF:1198-17187).

12. ClinicalDocument.code.code
Comments

This code SHALL contain exactly one [1..1] @code, which SHALL be selected from ValueSet SurgicalOperationNoteDocumentTypeCode http://hl7.org/fhir/ccda/ValueSet/2.16.840.1.113883.11.20.1.1 DYNAMIC (CONF:1198-17188).

Control1..?
BindingThe codes SHALL be taken from SurgicalOperationNoteDocumentTypeCode
14. ClinicalDocument.documentationOf
ShortA serviceEvent represents the main act, such as a colonoscopy or an appendectomy, being documented. A serviceEvent can further specialize the act inherent in the ClinicalDocument/code, such as where the ClinicalDocument/code is simply "Surgical Operation Note" and the procedure is "Appendectomy." serviceEvent is required in the Operative Note and it must be equivalent to or further specialize the value inherent in the ClinicalDocument/code; it shall not conflict with the value inherent in the ClinicalDocument/code, as such a conflict would create ambiguity. serviceEvent/effectiveTime can be used to indicate the time the actual event (as opposed to the encounter surrounding the event) took place. If the date and the duration of the procedure is known, serviceEvent/effectiveTime/low is used with a width element that describes the duration; no high element is used. However, if only the date is known, the date is placed in both the low and high elements.
Comments

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

Control1..?
16. ClinicalDocument.documentationOf.serviceEvent
Comments

Such documentationOfs SHALL contain exactly one [1..1] serviceEvent (CONF:1198-8493).

18. ClinicalDocument.documentationOf.serviceEvent.code
Comments

SHALL contain exactly one [1..1] code.

Control1..?
Binding

The value of Clinical Document /documentationOf/serviceEvent/code SHALL be from ICD-9-CM Procedures (codeSystem 2.16.840.1.113883.6.104), ICD-10-PCS (codeSystem 2.16.840.1.113883.6.4), CPT (codeSystem 2.16.840.1.113883.6.12), or values descending from 71388002 (Procedure) from the SNOMED CT (codeSystem 2.16.840.1.113883.6.96) ValueSet 2.16.840.1.113883.3.88.12.80.28 Procedure DYNAMIC (CONF:1198-8487).

Invariants1198-8487: The value of Clinical Document /documentationOf/serviceEvent/code SHALL be from ICD-9-CM Procedures (codeSystem 2.16.840.1.113883.6.104), ICD-10-PCS (codeSystem 2.16.840.1.113883.6.4), CPT (codeSystem 2.16.840.1.113883.6.12), or values descending from 71388002 (Procedure) from the SNOMED CT (codeSystem 2.16.840.1.113883.6.96) ValueSet 2.16.840.1.113883.3.88.12.80.28 Procedure DYNAMIC (CONF:1198-8487). (codeSystem = '2.16.840.1.113883.6.104' or codeSystem = '2.16.840.1.113883.6.4' or codeSystem = '2.16.840.1.113883.6.12' or (codeSystem = '2.16.840.1.113883.6.96' and code.memberOf('http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.80.28')))
20. ClinicalDocument.documentationOf.serviceEvent.effectiveTime
Comments

This serviceEvent SHALL contain exactly one [1..1] US Realm Date and Time (Interval) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:1198-8494).

Invariantswidth-or-high: Width and high are mutually exclusive. If width is known, high **SHALL NOT** be present. If with is not present, **SHALL** include high. ((width | high).count() = 1)
22. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low
ShortLow is required
Comments

The serviceEvent/effectiveTime SHALL be present with effectiveTime/low (CONF:1198-8488).

24. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.width
ShortRepresents the duration
Comments

When only the date and the length of the procedure are known a width element SHALL be present and the serviceEvent/effectiveTime/high SHALL NOT be present (CONF:1198-10060).

26. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high
ShortEquals low if only the date is known
Comments

If a width is not present, the serviceEvent/effectiveTime SHALL include effectiveTime/high (CONF:1198-10058).

28. ClinicalDocument.documentationOf.serviceEvent.performer
Control1..?
SlicingThis element introduces a set of slices on ClinicalDocument.documentationOf.serviceEvent.performer. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ typeCode
30. ClinicalDocument.documentationOf.serviceEvent.performer:performer1
Slice Nameperformer1
ShortThis performer represents clinicians who actually and principally carry out the serviceEvent. Typically, these are clinicians who have surgical privileges in their institutions such as Surgeons, Obstetrician/Gynecologists, and Family Practice Physicians. The performer may also be non-physician providers (NPPs) who have surgical privileges. There may be more than one primary performer in the case of complicated surgeries. There are occasionally co-surgeons. Usually they will be billing separately and will each dictate their own notes. An example may be spinal surgery , where a general surgeon and an orthopedic surgeon both are present and billing off the same Current Procedural Terminology (CPT) codes. Typically two Operative Notes are generated; however, each will list the other as a co-surgeon. Any assistants are identified as a secondary performer (SPRF) in a second performer participant.
Comments

This serviceEvent SHALL contain one or more [1..*] performer (CONF:1198-8489) such that it

Control1..*
32. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="PPRF" Primary performer (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1198-8495).

Fixed ValuePPRF
34. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode
Comments

MAY contain zero or one [0..1] functionCode, which SHOULD be selected from ValueSet Care Team Member Function urn:oid:2.16.840.1.113762.1.4.1099.30 DYNAMIC (CONF:1198-32963).

BindingThe codes SHOULD be taken from Care Team Member Function
36. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity
Comments

SHALL contain exactly one [1..1] assignedEntity (CONF:1198-10917).

Invariantsshould-code: SHOULD contain code (code.exists())
38. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.code
Comments

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

BindingThe codes SHALL be taken from Healthcare Provider Taxonomy
40. ClinicalDocument.documentationOf.serviceEvent.performer:performer2
Slice Nameperformer2
ShortThis performer represents any assistants
Comments

This serviceEvent MAY contain zero or more [0..*] performer (CONF:1198-32736) such that it

Control0..*
42. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="SPRF" Secondary performer (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90) (CONF:1198-32738).

Fixed ValueSPRF
44. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.functionCode
Comments

MAY contain zero or one [0..1] functionCode, which SHOULD be selected from ValueSet Care Team Member Function urn:oid:2.16.840.1.113762.1.4.1099.30 DYNAMIC (CONF:1198-32964).

BindingThe codes SHOULD be taken from Care Team Member Function
46. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity
Comments

SHALL contain exactly one [1..1] assignedEntity (CONF:1198-32737).

Invariantsshould-code: SHOULD contain code (code.exists())
48. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.code
Comments

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

BindingThe codes SHALL be taken from Healthcare Provider Taxonomy
50. ClinicalDocument.authorization
ShortAuthorization represents consent. Consent, if present, shall be represented by authorization/consent.
Comments

MAY contain zero or one [0..1] authorization (CONF:1198-32404).

Control0..1
52. ClinicalDocument.authorization.typeCode
Comments

The authorization, if present, SHALL contain exactly one [1..1] @typeCode="AUTH" authorized by (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1198-32408).

Control1..?
54. ClinicalDocument.authorization.consent
Comments

The authorization, if present, SHALL contain exactly one [1..1] consent (CONF:1198-32405).

56. ClinicalDocument.authorization.consent.classCode
Comments

This consent SHALL contain exactly one [1..1] @classCode="CONS" consent (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1198-32409).

Control1..?
58. ClinicalDocument.authorization.consent.moodCode
Comments

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

Control1..?
60. ClinicalDocument.authorization.consent.statusCode
Comments

This consent SHALL contain exactly one [1..1] statusCode (CONF:1198-32411).

62. ClinicalDocument.component
Comments

SHALL contain exactly one [1..1] component (CONF:1198-9585).

64. ClinicalDocument.component.structuredBody
Comments

This component SHALL contain exactly one [1..1] structuredBody (CONF:1198-30485).

Control1..?
66. ClinicalDocument.component.structuredBody.component
Control8..?
SlicingThis element introduces a set of slices on ClinicalDocument.component.structuredBody.component. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ section
68. ClinicalDocument.component.structuredBody.component:component1
Slice Namecomponent1
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30486).

Control1..1
70. ClinicalDocument.component.structuredBody.component:component1.section
Comments

This component SHALL contain exactly one [1..1] Anesthesia Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.25:2014-06-09) (CONF:1198-30487).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Anesthesia Section)
72. ClinicalDocument.component.structuredBody.component:component2
Slice Namecomponent2
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30488) such that it

Control1..1
74. ClinicalDocument.component.structuredBody.component:component2.section
Comments

SHALL contain exactly one [1..1] Complications Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.37:2024-05-01) (CONF:1198-30489).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Complications Section)
76. ClinicalDocument.component.structuredBody.component:component3
Slice Namecomponent3
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30490) such that it

Control1..1
78. ClinicalDocument.component.structuredBody.component:component3.section
Comments

SHALL contain exactly one [1..1] Preoperative Diagnosis Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.34:2024-05-01) (CONF:1198-30491).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Preoperative Diagnosis Section)
80. ClinicalDocument.component.structuredBody.component:component4
Slice Namecomponent4
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30492) such that it

Control1..1
82. ClinicalDocument.component.structuredBody.component:component4.section
Comments

SHALL contain exactly one [1..1] Procedure Estimated Blood Loss Section (identifier: urn:oid:2.16.840.1.113883.10.20.18.2.9) (CONF:1198-30493).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Procedure Estimated Blood Loss Section)
84. ClinicalDocument.component.structuredBody.component:component5
Slice Namecomponent5
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30494) such that it

Control1..1
86. ClinicalDocument.component.structuredBody.component:component5.section
Comments

SHALL contain exactly one [1..1] Procedure Findings Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.28:2024-05-01) (CONF:1198-30495).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Procedure Findings Section)
88. ClinicalDocument.component.structuredBody.component:component6
Slice Namecomponent6
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30496) such that it

Control1..1
90. ClinicalDocument.component.structuredBody.component:component6.section
Comments

SHALL contain exactly one [1..1] Procedure Specimens Taken Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.31) (CONF:1198-30497).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Procedure Specimens Taken Section)
92. ClinicalDocument.component.structuredBody.component:component7
Slice Namecomponent7
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30498) such that it

Control1..1
94. ClinicalDocument.component.structuredBody.component:component7.section
Comments

SHALL contain exactly one [1..1] Procedure Description Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.27) (CONF:1198-30499).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Procedure Description Section)
96. ClinicalDocument.component.structuredBody.component:component8
Slice Namecomponent8
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30500) such that it

Control1..1
98. ClinicalDocument.component.structuredBody.component:component8.section
Comments

SHALL contain exactly one [1..1] Postoperative Diagnosis Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.35) (CONF:1198-30501).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Postoperative Diagnosis Section)
100. ClinicalDocument.component.structuredBody.component:component9
Slice Namecomponent9
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30502) such that it

Control0..1
102. ClinicalDocument.component.structuredBody.component:component9.section
Comments

SHALL contain exactly one [1..1] Procedure Implants Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.40) (CONF:1198-30503).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Procedure Implants Section)
104. ClinicalDocument.component.structuredBody.component:component10
Slice Namecomponent10
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30504) such that it

Control0..1
106. ClinicalDocument.component.structuredBody.component:component10.section
Comments

SHALL contain exactly one [1..1] Operative Note Fluids Section (identifier: urn:oid:2.16.840.1.113883.10.20.7.12) (CONF:1198-30505).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Operative Note Fluids Section)
108. ClinicalDocument.component.structuredBody.component:component11
Slice Namecomponent11
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30506) such that it

Control0..1
110. ClinicalDocument.component.structuredBody.component:component11.section
Comments

SHALL contain exactly one [1..1] Operative Note Surgical Procedure Section (identifier: urn:oid:2.16.840.1.113883.10.20.7.14) (CONF:1198-30507).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Operative Note Surgical Procedure Section)
112. ClinicalDocument.component.structuredBody.component:component12
Slice Namecomponent12
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30508) such that it

Control0..1
114. ClinicalDocument.component.structuredBody.component:component12.section
Comments

SHALL contain exactly one [1..1] Plan of Treatment Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.10:2014-06-09) (CONF:1198-30509).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Plan of Treatment Section)
116. ClinicalDocument.component.structuredBody.component:component13
Slice Namecomponent13
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30510) such that it

Control0..1
118. ClinicalDocument.component.structuredBody.component:component13.section
Comments

SHALL contain exactly one [1..1] Planned Procedure Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.30:2014-06-09) (CONF:1198-30511).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Planned Procedure Section)
120. ClinicalDocument.component.structuredBody.component:component14
Slice Namecomponent14
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30512) such that it

Control0..1
122. ClinicalDocument.component.structuredBody.component:component14.section
Comments

SHALL contain exactly one [1..1] Procedure Disposition Section (identifier: urn:oid:2.16.840.1.113883.10.20.18.2.12) (CONF:1198-30513).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Procedure Disposition Section)
124. ClinicalDocument.component.structuredBody.component:component15
Slice Namecomponent15
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30514) such that it

Control0..1
126. ClinicalDocument.component.structuredBody.component:component15.section
Comments

SHALL contain exactly one [1..1] Procedure Indications Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.29:2014-06-09) (CONF:1198-30515).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Procedure Indications Section)
128. ClinicalDocument.component.structuredBody.component:component16
Slice Namecomponent16
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30516) such that it

Control0..1
130. ClinicalDocument.component.structuredBody.component:component16.section
Comments

SHALL contain exactly one [1..1] Surgical Drains Section (identifier: urn:oid:2.16.840.1.113883.10.20.7.13) (CONF:1198-30517).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Surgical Drains Section)
132. ClinicalDocument.component.structuredBody.component:component17
Slice Namecomponent17
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28942) such that it

Control0..1
134. ClinicalDocument.component.structuredBody.component:component17.section
Comments

SHALL contain exactly one [1..1] Advance Directives Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.21.1:2024-05-01).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Advance Directives Section)

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

0. ClinicalDocument
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.
Invariants4537-6380: If setId is present versionNumber **SHALL** be present (CONF:4537-6380). (setId.exists() implies versionNumber.exists())
4537-6387: If versionNumber is present setId **SHALL** be present (CONF:4537-6387). (versionNumber.exists() implies setId.exists())
should-legalAuthenticator: SHOULD contain legalAuthenticator (legalAuthenticator.exists())
should-relatedParticipant: Documents SHOULD contain a RelatedPerson participant (participant.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/RelatedPersonRelationshipAndNameParticipant').exists())
2. ClinicalDocument.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

Comments

SHALL contain exactly one [1..1] realmCode="US" (CONF:4537-16791).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
4. ClinicalDocument.realmCode.code
Definition

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

Control1..1
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
Pattern ValueUS
6. ClinicalDocument.realmCode.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
8. ClinicalDocument.realmCode.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
10. ClinicalDocument.realmCode.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
12. ClinicalDocument.realmCode.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
14. ClinicalDocument.realmCode.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
16. ClinicalDocument.realmCode.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
18. ClinicalDocument.realmCode.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
20. ClinicalDocument.typeId
Definition

ClinicalDocument.typeId is a technology-neutral explicit reference to this CDA, Release Two specification, and must be valued as follows: ClinicalDocument.typeId.root = "2.16.840.1.113883.1.3" (which is the OID for HL7 Registered models); ClinicalDocument.typeId.extension = "POCD_HD000040" (which is the unique identifier for the CDA, Release Two Hierarchical Description).

Comments

SHALL contain exactly one [1..1] typeId (CONF:4537-5361).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
22. ClinicalDocument.typeId.root
Definition

Identifies the type as an HL7 Registered model

Comments

This typeId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.1.3" (CONF:4537-5250).

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
24. ClinicalDocument.typeId.extension
Definition

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

Comments

This typeId SHALL contain exactly one [1..1] @extension="POCD_HD000040" (CONF:4537-5251).

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
Fixed ValuePOCD_HD000040
26. ClinicalDocument.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

Control2..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
SlicingThis element introduces a set of slices on ClinicalDocument.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
28. ClinicalDocument.templateId:us-realm
Slice Nameus-realm
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
30. ClinicalDocument.templateId:us-realm.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.1.1
32. ClinicalDocument.templateId:us-realm.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 Value2024-05-01
34. ClinicalDocument.templateId:operative-note
Slice Nameoperative-note
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
36. ClinicalDocument.templateId:operative-note.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.1.7
38. ClinicalDocument.templateId:operative-note.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 Value2024-05-01
40. ClinicalDocument.id
Short**SHALL** be a globally unique identifier for the document (CONF:4537-9991).
Comments

SHALL contain exactly one [1..1] id (CONF:4537-5363).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
42. ClinicalDocument.code
ShortThe Operative Note recommends use of a single document type code, 11504-8 "Provider-unspecified Operation Note", with further specification provided by author or performer, setting, or specialty data in the CDA header. Some of the LOINC codes in the Surgical Operation Note Document Type Code table are pre-coordinated with the practice setting or the training or professional level of the author. Use of pre-coordinated codes is not recommended because of potential conflict with other information in the header. When these codes are used, any coded values describing the author or performer of the service act or the practice setting must be consistent with the LOINC document type.
Comments

SHALL contain exactly one [1..1] code (CONF:1198-17187).

Control1..1
BindingFor example codes, see FHIRDocumentTypeCodes
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
Invariants4537-32948: This code **SHALL** be drawn from the LOINC document type ontology (LOINC codes where SCALE = DOC) (CONF:4537-32948). (codeSystem = '2.16.840.1.113883.6.1')
44. ClinicalDocument.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.

Comments

This code SHALL contain exactly one [1..1] @code, which SHALL be selected from ValueSet SurgicalOperationNoteDocumentTypeCode http://hl7.org/fhir/ccda/ValueSet/2.16.840.1.113883.11.20.1.1 DYNAMIC (CONF:1198-17188).

Control1..1
BindingThe codes SHALL be taken from SurgicalOperationNoteDocumentTypeCode
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
46. ClinicalDocument.code.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
48. ClinicalDocument.title
ShortThe title can either be a locally defined name or the displayName corresponding to clinicalDocument/code
Comments

SHALL contain exactly one [1..1] title (CONF:4537-5254).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ST
50. ClinicalDocument.effectiveTime
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5256).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time)
Is Modifierfalse
Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
52. ClinicalDocument.confidentialityCode
Comments

SHALL contain exactly one [1..1] confidentialityCode, which SHOULD be selected from ValueSet HL7 BasicConfidentialityKind urn:oid:2.16.840.1.113883.1.11.16926 DYNAMIC (CONF:4537-5259).

Control1..1
BindingThe codes SHOULD be taken from HL7 BasicConfidentialityKind
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
54. ClinicalDocument.confidentialityCode.nullFlavor
Definition

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

Comments

SHALL NOT contain [0..0] @nullFlavor.

Control0..0
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
56. ClinicalDocument.confidentialityCode.code
Definition

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

Control1..1
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
58. ClinicalDocument.confidentialityCode.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
60. ClinicalDocument.languageCode
Comments

SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet AllLanguages https://www.hl7.org/fhir/valueset-all-languages.html (OID 2.16.840.1.113883.4.642.3.21) DYNAMIC.

Control1..1
BindingThe codes SHALL be taken from AllLanguages
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
62. ClinicalDocument.recordTarget
ShortThe recordTarget records the administrative and demographic data of the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element
Comments

SHALL contain at least one [1..*] recordTarget (CONF:4537-5266).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RecordTarget
64. ClinicalDocument.recordTarget.patientRole
Comments

Such recordTargets SHALL contain exactly one [1..1] patientRole (CONF:4537-5267).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PatientRole
66. ClinicalDocument.recordTarget.patientRole.id
Comments

This patientRole SHALL contain at least one [1..*] id (CONF:4537-5268).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
68. ClinicalDocument.recordTarget.patientRole.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

Short(USCDI) Address
Comments

This patientRole SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5271).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
Is Modifierfalse
Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
70. ClinicalDocument.recordTarget.patientRole.telecom
Short(USCDI) Phone Number / Email
Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
Invariantsshould-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
72. ClinicalDocument.recordTarget.patientRole.telecom.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.

Comments

Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-5375).

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
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.
LabelUse Code
74. ClinicalDocument.recordTarget.patientRole.patient
Comments

This patientRole SHALL contain exactly one [1..1] patient (CONF:4537-5283).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Patient
Invariants4537-32993: If sdtc:deceasedInd="true", then sdtc:deceasedTime **SHALL** be present with either a @value or @nullFlavor=UNK (CONF:4537-32993). (sdtcDeceasedInd.exists(value='true') implies sdtcDeceasedTime.exists())
4537-21000: If sdtc:deceasedTime/@value is present, then sdtc:deceasedInd SHALL be present with value=true (sdtcDeceasedTime.value.exists() implies sdtcDeceasedInd.exists(value='true'))
should-maritalStatusCode: SHOULD contain maritalStatusCode (maritalStatusCode.exists())
should-us-languageCommunication: SHOULD contain languageCommunication (languageCommunication.exists())
76. ClinicalDocument.recordTarget.patientRole.patient.name
Definition

A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).


A name associated with the individual.

ShortBase for all types and resourcesA name associated with the patient
Comments

This patient SHALL contain at least one [1..*] US Realm Patient Name (PTN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1) (CONF:4537-5284).


A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. Animal names may be communicated as given names, and optionally may include a family name.

Control10..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PNHumanName(US Realm Patient Name (PTN.US.FIELDED))
Is Modifierfalse
Requirements

Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). (nullFlavor.exists() or item.family.count() = 1)
shall-given: SHALL contain at least one [1..*] given (CONF:81-7157). (nullFlavor.exists() or item.given.exists())
shall-max-suffix: There may be at most one suffix ((item.suffix.empty() or item.suffix.count() = 1))
81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278). (item.xmlText.empty())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. ClinicalDocument.recordTarget.patientRole.patient.administrativeGenderCode
Comments

This patient SHALL contain exactly one [1..1] administrativeGenderCode, which SHALL be selected from ValueSet Administrative Gender (HL7 V3) urn:oid:2.16.840.1.113883.1.11.1 DYNAMIC (CONF:4537-6394).

Control1..1
BindingThe codes SHALL be taken from Administrative Gender (HL7 V3)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
80. ClinicalDocument.recordTarget.patientRole.patient.birthTime
Short(USCDI) Date of Birth - **MAY** be precise to the minute (CONF:4537-32418) (For cases where information about newborn's time of birth needs to be captured)
Comments

This patient SHALL contain exactly one [1..1] birthTime (CONF:4537-5298).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
Invariantsts-shall-year: **SHALL** be precise to at least the year (nullFlavor.exists() or value.toString().length() >= 4)
ts-should-day: **SHOULD** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
82. ClinicalDocument.recordTarget.patientRole.patient.raceCode
Short(USCDI) Race
Comments

This patient SHALL contain exactly one [1..1] raceCode, which SHALL be selected from ValueSet Race Category Excluding Nulls urn:oid:2.16.840.1.113883.3.2074.1.1.3 DYNAMIC (CONF:4537-5322).

Control1..1
BindingThe codes SHALL be taken from Race Category Excluding Nulls
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
84. ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode
Short(USCDI) Ethnicity
Comments

This patient SHALL contain exactly one [1..1] ethnicGroupCode, which SHALL be selected from ValueSet Ethnicity urn:oid:2.16.840.1.114222.4.11.837 DYNAMIC (CONF:4537-5323).

Control1..1
BindingThe codes SHALL be taken from Ethnicity
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
86. ClinicalDocument.author
ShortThe author element represents the creator of the clinical document. The author may be a device or a person.
Comments

SHALL contain at least one [1..*] author (CONF:4537-5444).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
88. ClinicalDocument.author.time
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

ShortBase for all types and resources
Comments

Such authors SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5445).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time)
Is Modifierfalse
Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
90. ClinicalDocument.author.assignedAuthor
Comments

Such authors SHALL contain exactly one [1..1] assignedAuthor (CONF:4537-5448).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedAuthor
Invariants4537-16790: There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790). ((assignedPerson | assignedAuthoringDevice).count() = 1)
should-id-npi: SHOULD contain an id with root='2.16.840.1.113883.4.6' (NPI) (id.where(root = '2.16.840.1.113883.4.6'))
should-us-code: SHOULD contain code (code.exists())
92. ClinicalDocument.author.assignedAuthor.id
Comments

This assignedAuthor SHOULD contain zero or one [0..1] id (CONF:4537-32882) such that it, This assignedAuthor SHALL contain at least one [1..*] id (CONF:4537-5449).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
SlicingThis element introduces a set of slices on ClinicalDocument.author.assignedAuthor.id. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
94. ClinicalDocument.author.assignedAuthor.id:npi
Slice Namenpi
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
Invariantsshould-extension: SHOULD contain extension (extension.exists())
96. ClinicalDocument.author.assignedAuthor.id:npi.root
Definition

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

Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-32884).

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.4.6
98. ClinicalDocument.author.assignedAuthor.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

ShortBase for all types and resources
Comments

This assignedAuthor SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5452).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
Is Modifierfalse
Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
100. ClinicalDocument.author.assignedAuthor.telecom
Comments

This assignedAuthor SHALL contain at least one [1..*] telecom (CONF:4537-5428).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
Invariantsshould-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
102. ClinicalDocument.author.assignedAuthor.telecom.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.

Comments

Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7995).

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
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.
LabelUse Code
104. ClinicalDocument.informant
Comments

MAY contain zero or more [0..*] informant (CONF:4537-31355) such that it

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
SlicingThis element introduces a set of slices on ClinicalDocument.informant. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • exists @ relatedEntity
  • exists @ assignedEntity
106. ClinicalDocument.informant:provider
Slice Nameprovider
ShortThe informant element describes an information source for any content within the clinical document. This informant is constrained for use when the source of information is an assigned health care provider for the patient.
Comments

MAY contain zero or more [0..*] informant (CONF:4537-8001) such that it

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
108. ClinicalDocument.informant:provider.assignedEntity
Comments

SHALL contain exactly one [1..1] assignedEntity (CONF:4537-8002).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
110. ClinicalDocument.informant:provider.assignedEntity.id
ShortIf assignedEntity/id is a provider then this id, **SHOULD** include zero or one [0..1] id where id/@root ="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-9946).
Comments

This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-9945).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
112. ClinicalDocument.informant:provider.assignedEntity.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

ShortBase for all types and resources
Comments

This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-8220).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
Is Modifierfalse
Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
114. ClinicalDocument.informant:provider.assignedEntity.assignedPerson
Comments

This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-8221).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
116. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.name
Definition

A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).


A name associated with the person.

ShortBase for all types and resourcesA name associated with the person
Comments

This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-8222).


Person may have multiple names with different uses or applicable periods.

Control10..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PNHumanName(US Realm Person Name (PN.US.FIELDED))
Is Modifierfalse
Requirements

Need to be able to track the person by multiple names. Examples are your official name and a partner name.

Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists())
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
118. ClinicalDocument.informant:provider.relatedEntity
Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
120. ClinicalDocument.informant:non-provider
Slice Namenon-provider
ShortThe informant element describes an information source (who is not a provider) for any content within the clinical document. This informant would be used when the source of information has a personal relationship with the patient or is the patient.
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
122. ClinicalDocument.informant:non-provider.assignedEntity
Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
124. ClinicalDocument.informant:non-provider.relatedEntity
Comments

SHALL contain exactly one [1..1] relatedEntity (CONF:4537-31356).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
126. ClinicalDocument.custodian
ShortThe custodian element represents the organization that is in charge of maintaining and is entrusted with the care of the document.&#10;&#10;There is only one custodian per CDA document. Allowing that a CDA document may not represent the original form of the authenticated document, the custodian represents the steward of the original source document. The custodian may be the document originator, a health information exchange, or other responsible party.
Comments

SHALL contain exactly one [1..1] custodian (CONF:4537-5519).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Custodian
128. ClinicalDocument.custodian.assignedCustodian
Comments

This custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:4537-5520).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedCustodian
130. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization
Comments

This assignedCustodian SHALL contain exactly one [1..1] representedCustodianOrganization (CONF:4537-5521).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CustodianOrganization
132. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id
Comments

This representedCustodianOrganization SHALL contain at least one [1..*] id (CONF:4537-5522).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
134. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.name
Comments

This representedCustodianOrganization SHALL contain exactly one [1..1] name (CONF:4537-5524).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ON
136. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom
Comments

This representedCustodianOrganization SHALL contain exactly one [1..1] telecom (CONF:4537-5525).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
Invariantsshould-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
138. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.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.

Comments

This telecom SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7998).

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
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.
LabelUse Code
140. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

ShortBase for all types and resources
Comments

This representedCustodianOrganization SHALL contain exactly one [1..1] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5559).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
Is Modifierfalse
Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
142. ClinicalDocument.documentationOf
ShortA serviceEvent represents the main act, such as a colonoscopy or an appendectomy, being documented. A serviceEvent can further specialize the act inherent in the ClinicalDocument/code, such as where the ClinicalDocument/code is simply "Surgical Operation Note" and the procedure is "Appendectomy." serviceEvent is required in the Operative Note and it must be equivalent to or further specialize the value inherent in the ClinicalDocument/code; it shall not conflict with the value inherent in the ClinicalDocument/code, as such a conflict would create ambiguity. serviceEvent/effectiveTime can be used to indicate the time the actual event (as opposed to the encounter surrounding the event) took place. If the date and the duration of the procedure is known, serviceEvent/effectiveTime/low is used with a width element that describes the duration; no high element is used. However, if only the date is known, the date is placed in both the low and high elements.
Comments

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

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf
144. ClinicalDocument.documentationOf.serviceEvent
ShortA serviceEvent represents the main act being documented, such as a colonoscopy or a cardiac stress study. In a provision of healthcare serviceEvent, the care providers, PCP, or other longitudinal providers, are recorded within the serviceEvent. If the document is about a single encounter, the providers associated can be recorded in the componentOf/encompassingEncounter template.
Comments

Such documentationOfs SHALL contain exactly one [1..1] serviceEvent (CONF:1198-8493).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ServiceEvent
Invariantsshould-us-performer: SHOULD contain performer (performer.exists())
146. ClinicalDocument.documentationOf.serviceEvent.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
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.
Default ValueACT
148. ClinicalDocument.documentationOf.serviceEvent.code
Definition

Drawn from concept domain ActCode

Comments

SHALL contain exactly one [1..1] code.

Control1..1
Binding

The value of Clinical Document /documentationOf/serviceEvent/code SHALL be from ICD-9-CM Procedures (codeSystem 2.16.840.1.113883.6.104), ICD-10-PCS (codeSystem 2.16.840.1.113883.6.4), CPT (codeSystem 2.16.840.1.113883.6.12), or values descending from 71388002 (Procedure) from the SNOMED CT (codeSystem 2.16.840.1.113883.6.96) ValueSet 2.16.840.1.113883.3.88.12.80.28 Procedure DYNAMIC (CONF:1198-8487).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
Invariants1198-8487: The value of Clinical Document /documentationOf/serviceEvent/code SHALL be from ICD-9-CM Procedures (codeSystem 2.16.840.1.113883.6.104), ICD-10-PCS (codeSystem 2.16.840.1.113883.6.4), CPT (codeSystem 2.16.840.1.113883.6.12), or values descending from 71388002 (Procedure) from the SNOMED CT (codeSystem 2.16.840.1.113883.6.96) ValueSet 2.16.840.1.113883.3.88.12.80.28 Procedure DYNAMIC (CONF:1198-8487). (codeSystem = '2.16.840.1.113883.6.104' or codeSystem = '2.16.840.1.113883.6.4' or codeSystem = '2.16.840.1.113883.6.12' or (codeSystem = '2.16.840.1.113883.6.96' and code.memberOf('http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.80.28')))
150. ClinicalDocument.documentationOf.serviceEvent.effectiveTime
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

ShortBase for all types and resources
Comments

This serviceEvent SHALL contain exactly one [1..1] US Realm Date and Time (Interval) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:1198-8494).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval)
Is Modifierfalse
Invariantsivl-ts-center: Center cannot co-exist with low or high (center.empty() or (low.empty() and high.empty()))
ivl-value-shall: If a time interval contains @value, then it shall be precise to at least the day. (value.exists() implies value.toString().length() >= 10)
ivl-value-should: If a time interval contains @value, then it SHOULD contain a time component. (value.exists() implies value.toString().length() > 10)
width-or-high: Width and high are mutually exclusive. If width is known, high **SHALL NOT** be present. If with is not present, **SHALL** include high. ((width | high).count() = 1)
152. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low
Definition

This is the low limit of the interval.

ShortLow is required
Comments

The serviceEvent/effectiveTime SHALL be present with effectiveTime/low (CONF:1198-8488).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
LabelLow Boundary
Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
154. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.width
Definition

The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived.

ShortRepresents the duration
Comments

When only the date and the length of the procedure are known a width element SHALL be present and the serviceEvent/effectiveTime/high SHALL NOT be present (CONF:1198-10060).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQ
LabelWidth
156. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high
Definition

This is the high limit of the interval.

ShortEquals low if only the date is known
Comments

If a width is not present, the serviceEvent/effectiveTime SHALL include effectiveTime/high (CONF:1198-10058).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
LabelHigh Boundary
Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
158. ClinicalDocument.documentationOf.serviceEvent.performer
ShortThe performer participant represents clinicians who actually and principally carry out the serviceEvent. In a transfer of care this represents the healthcare providers involved in the current or pertinent historical care of the patient. Preferably, the patient's key healthcare care team members would be listed, particularly their primary physician and any active consulting physicians, therapists, and counselors.
Comments

This serviceEvent SHOULD contain zero or more [0..*] performer (CONF:4537-14839).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer1
SlicingThis element introduces a set of slices on ClinicalDocument.documentationOf.serviceEvent.performer. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ typeCode
160. ClinicalDocument.documentationOf.serviceEvent.performer.typeCode
Comments

The performer, if present, SHALL contain exactly one [1..1] @typeCode, which SHALL be selected from ValueSet x_ServiceEventPerformer urn:oid:2.16.840.1.113883.1.11.19601 STATIC (CONF:4537-14840).

Control1..1
BindingThe codes SHALL be taken from x_ServiceEventPerformer
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.
162. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity
Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Invariantsshould-us-code: SHOULD contain code (code.exists())
164. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id
Comments

This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-14846).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
166. ClinicalDocument.documentationOf.serviceEvent.performer:performer1
Slice Nameperformer1
ShortThis performer represents clinicians who actually and principally carry out the serviceEvent. Typically, these are clinicians who have surgical privileges in their institutions such as Surgeons, Obstetrician/Gynecologists, and Family Practice Physicians. The performer may also be non-physician providers (NPPs) who have surgical privileges. There may be more than one primary performer in the case of complicated surgeries. There are occasionally co-surgeons. Usually they will be billing separately and will each dictate their own notes. An example may be spinal surgery , where a general surgeon and an orthopedic surgeon both are present and billing off the same Current Procedural Terminology (CPT) codes. Typically two Operative Notes are generated; however, each will list the other as a co-surgeon. Any assistants are identified as a secondary performer (SPRF) in a second performer participant.
Comments

This serviceEvent SHALL contain one or more [1..*] performer (CONF:1198-8489) such that it

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer1
168. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="PPRF" Primary performer (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1198-8495).

Control1..1
BindingThe codes SHALL be taken from x_ServiceEventPerformer
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 ValuePPRF
170. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode
Comments

MAY contain zero or one [0..1] functionCode, which SHOULD be selected from ValueSet Care Team Member Function urn:oid:2.16.840.1.113762.1.4.1099.30 DYNAMIC (CONF:1198-32963).

Control0..1
BindingThe codes SHOULD be taken from Care Team Member Function
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
Invariantsshould-us-code: SHOULD contain code (code.exists())
172. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode.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
174. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity
Comments

SHALL contain exactly one [1..1] assignedEntity (CONF:1198-10917).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Invariantsshould-us-code: SHOULD contain code (code.exists())
should-code: SHOULD contain code (code.exists())
176. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.id
Comments

This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-14846).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
178. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.code
Comments

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

Control0..1
BindingThe codes SHALL be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
180. ClinicalDocument.documentationOf.serviceEvent.performer:performer2
Slice Nameperformer2
ShortThis performer represents any assistants
Comments

This serviceEvent MAY contain zero or more [0..*] performer (CONF:1198-32736) such that it

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer1
182. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="SPRF" Secondary performer (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90) (CONF:1198-32738).

Control1..1
BindingThe codes SHALL be taken from x_ServiceEventPerformer
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 ValueSPRF
184. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.functionCode
Comments

MAY contain zero or one [0..1] functionCode, which SHOULD be selected from ValueSet Care Team Member Function urn:oid:2.16.840.1.113762.1.4.1099.30 DYNAMIC (CONF:1198-32964).

Control0..1
BindingThe codes SHOULD be taken from Care Team Member Function
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
Invariantsshould-us-code: SHOULD contain code (code.exists())
186. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.functionCode.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
188. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity
Comments

SHALL contain exactly one [1..1] assignedEntity (CONF:1198-32737).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Invariantsshould-us-code: SHOULD contain code (code.exists())
should-code: SHOULD contain code (code.exists())
190. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.id
Comments

This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-14846).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
192. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.code
Comments

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

Control0..1
BindingThe codes SHALL be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
194. ClinicalDocument.authorization
ShortAuthorization represents consent. Consent, if present, shall be represented by authorization/consent.
Comments

MAY contain zero or one [0..1] authorization (CONF:1198-32404).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Authorization
196. ClinicalDocument.authorization.typeCode
Comments

The authorization, if present, SHALL contain exactly one [1..1] @typeCode="AUTH" authorized by (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1198-32408).

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 ValueAUTH
198. ClinicalDocument.authorization.consent
Comments

The authorization, if present, SHALL contain exactly one [1..1] consent (CONF:1198-32405).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Consent
200. ClinicalDocument.authorization.consent.classCode
Comments

This consent SHALL contain exactly one [1..1] @classCode="CONS" consent (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1198-32409).

Control1..1
BindingThe codes SHALL be taken from ActClass
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 ValueCONS
202. ClinicalDocument.authorization.consent.moodCode
Comments

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

Control1..1
BindingThe codes SHALL be taken from ActMood
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 ValueEVN
204. ClinicalDocument.authorization.consent.statusCode
Comments

This consent SHALL contain exactly one [1..1] statusCode (CONF:1198-32411).

Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
206. ClinicalDocument.authorization.consent.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="completed" Completed (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:4537-16798).

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 Valuecompleted
208. ClinicalDocument.authorization.consent.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
210. ClinicalDocument.authorization.consent.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
212. ClinicalDocument.authorization.consent.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
214. ClinicalDocument.authorization.consent.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
216. ClinicalDocument.authorization.consent.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
218. ClinicalDocument.authorization.consent.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
220. ClinicalDocument.authorization.consent.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
222. ClinicalDocument.component
Comments

SHALL contain exactly one [1..1] component (CONF:1198-9585).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Component
224. ClinicalDocument.component.structuredBody
Comments

This component SHALL contain exactly one [1..1] structuredBody (CONF:1198-30485).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/StructuredBody
226. ClinicalDocument.component.structuredBody.component
Control8..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
SlicingThis element introduces a set of slices on ClinicalDocument.component.structuredBody.component. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ section
228. ClinicalDocument.component.structuredBody.component.section
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section
230. ClinicalDocument.component.structuredBody.component:component1
Slice Namecomponent1
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30486).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
232. ClinicalDocument.component.structuredBody.component:component1.section
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

This component SHALL contain exactly one [1..1] Anesthesia Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.25:2014-06-09) (CONF:1198-30487).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Anesthesia Section)
Is Modifierfalse
234. ClinicalDocument.component.structuredBody.component:component2
Slice Namecomponent2
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30488) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
236. ClinicalDocument.component.structuredBody.component:component2.section
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] Complications Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.37:2024-05-01) (CONF:1198-30489).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Complications Section)
Is Modifierfalse
238. ClinicalDocument.component.structuredBody.component:component3
Slice Namecomponent3
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30490) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
240. ClinicalDocument.component.structuredBody.component:component3.section
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] Preoperative Diagnosis Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.34:2024-05-01) (CONF:1198-30491).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Preoperative Diagnosis Section)
Is Modifierfalse
Invariantsshould-preop-dx: SHOULD contain Preoperative Diagnosis (entry.where(act.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/PreoperativeDiagnosis')))
242. ClinicalDocument.component.structuredBody.component:component4
Slice Namecomponent4
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30492) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
244. ClinicalDocument.component.structuredBody.component:component4.section
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] Procedure Estimated Blood Loss Section (identifier: urn:oid:2.16.840.1.113883.10.20.18.2.9) (CONF:1198-30493).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Procedure Estimated Blood Loss Section)
Is Modifierfalse
246. ClinicalDocument.component.structuredBody.component:component5
Slice Namecomponent5
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30494) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
248. ClinicalDocument.component.structuredBody.component:component5.section
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] Procedure Findings Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.28:2024-05-01) (CONF:1198-30495).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Procedure Findings Section)
Is Modifierfalse
250. ClinicalDocument.component.structuredBody.component:component6
Slice Namecomponent6
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30496) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
252. ClinicalDocument.component.structuredBody.component:component6.section
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] Procedure Specimens Taken Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.31) (CONF:1198-30497).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Procedure Specimens Taken Section)
Is Modifierfalse
254. ClinicalDocument.component.structuredBody.component:component7
Slice Namecomponent7
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30498) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
256. ClinicalDocument.component.structuredBody.component:component7.section
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] Procedure Description Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.27) (CONF:1198-30499).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Procedure Description Section)
Is Modifierfalse
258. ClinicalDocument.component.structuredBody.component:component8
Slice Namecomponent8
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30500) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
260. ClinicalDocument.component.structuredBody.component:component8.section
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] Postoperative Diagnosis Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.35) (CONF:1198-30501).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Postoperative Diagnosis Section)
Is Modifierfalse
262. ClinicalDocument.component.structuredBody.component:component9
Slice Namecomponent9
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30502) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
264. ClinicalDocument.component.structuredBody.component:component9.section
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] Procedure Implants Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.40) (CONF:1198-30503).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Procedure Implants Section)
Is Modifierfalse
266. ClinicalDocument.component.structuredBody.component:component10
Slice Namecomponent10
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30504) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
268. ClinicalDocument.component.structuredBody.component:component10.section
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] Operative Note Fluids Section (identifier: urn:oid:2.16.840.1.113883.10.20.7.12) (CONF:1198-30505).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Operative Note Fluids Section)
Is Modifierfalse
270. ClinicalDocument.component.structuredBody.component:component11
Slice Namecomponent11
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30506) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
272. ClinicalDocument.component.structuredBody.component:component11.section
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] Operative Note Surgical Procedure Section (identifier: urn:oid:2.16.840.1.113883.10.20.7.14) (CONF:1198-30507).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Operative Note Surgical Procedure Section)
Is Modifierfalse
274. ClinicalDocument.component.structuredBody.component:component12
Slice Namecomponent12
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30508) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
276. ClinicalDocument.component.structuredBody.component:component12.section
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] Plan of Treatment Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.10:2014-06-09) (CONF:1198-30509).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Plan of Treatment Section)
Is Modifierfalse
278. ClinicalDocument.component.structuredBody.component:component13
Slice Namecomponent13
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30510) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
280. ClinicalDocument.component.structuredBody.component:component13.section
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] Planned Procedure Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.30:2014-06-09) (CONF:1198-30511).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Planned Procedure Section)
Is Modifierfalse
282. ClinicalDocument.component.structuredBody.component:component14
Slice Namecomponent14
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30512) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
284. ClinicalDocument.component.structuredBody.component:component14.section
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] Procedure Disposition Section (identifier: urn:oid:2.16.840.1.113883.10.20.18.2.12) (CONF:1198-30513).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Procedure Disposition Section)
Is Modifierfalse
286. ClinicalDocument.component.structuredBody.component:component15
Slice Namecomponent15
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30514) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
288. ClinicalDocument.component.structuredBody.component:component15.section
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] Procedure Indications Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.29:2014-06-09) (CONF:1198-30515).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Procedure Indications Section)
Is Modifierfalse
290. ClinicalDocument.component.structuredBody.component:component16
Slice Namecomponent16
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30516) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
292. ClinicalDocument.component.structuredBody.component:component16.section
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] Surgical Drains Section (identifier: urn:oid:2.16.840.1.113883.10.20.7.13) (CONF:1198-30517).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Surgical Drains Section)
Is Modifierfalse
294. ClinicalDocument.component.structuredBody.component:component17
Slice Namecomponent17
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28942) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
296. ClinicalDocument.component.structuredBody.component:component17.section
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] Advance Directives Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.21.1:2024-05-01).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Advance Directives Section)
Is Modifierfalse
Invariantsshall-adv-directive-organizer: SHALL contain at least one Advance Directive Organizer (nullFlavor.exists() or entry.where(organizer.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveOrganizer')))

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

0. ClinicalDocument
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.
Invariants4537-6380: If setId is present versionNumber **SHALL** be present (CONF:4537-6380). (setId.exists() implies versionNumber.exists())
4537-6387: If versionNumber is present setId **SHALL** be present (CONF:4537-6387). (versionNumber.exists() implies setId.exists())
should-legalAuthenticator: SHOULD contain legalAuthenticator (legalAuthenticator.exists())
should-relatedParticipant: Documents SHOULD contain a RelatedPerson participant (participant.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/RelatedPersonRelationshipAndNameParticipant').exists())
2. ClinicalDocument.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. ClinicalDocument.classCode
Control0..1
BindingFor example codes, see ActClass
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 ValueDOCCLIN
6. ClinicalDocument.moodCode
Control0..1
BindingThe codes SHALL be taken from ActMood
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 ValueEVN
8. ClinicalDocument.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

Comments

SHALL contain exactly one [1..1] realmCode="US" (CONF:4537-16791).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
10. ClinicalDocument.realmCode.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
12. ClinicalDocument.realmCode.code
Definition

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

Control1..1
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
Pattern ValueUS
14. ClinicalDocument.realmCode.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
16. ClinicalDocument.realmCode.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
18. ClinicalDocument.realmCode.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
20. ClinicalDocument.realmCode.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
22. ClinicalDocument.realmCode.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.
24. ClinicalDocument.realmCode.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.
26. ClinicalDocument.realmCode.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
28. ClinicalDocument.realmCode.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
30. ClinicalDocument.realmCode.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
32. ClinicalDocument.typeId
Definition

ClinicalDocument.typeId is a technology-neutral explicit reference to this CDA, Release Two specification, and must be valued as follows: ClinicalDocument.typeId.root = "2.16.840.1.113883.1.3" (which is the OID for HL7 Registered models); ClinicalDocument.typeId.extension = "POCD_HD000040" (which is the unique identifier for the CDA, Release Two Hierarchical Description).

Comments

SHALL contain exactly one [1..1] typeId (CONF:4537-5361).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
34. ClinicalDocument.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
36. ClinicalDocument.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
38. ClinicalDocument.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
40. ClinicalDocument.typeId.root
Definition

Identifies the type as an HL7 Registered model

Comments

This typeId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.1.3" (CONF:4537-5250).

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
42. ClinicalDocument.typeId.extension
Definition

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

Comments

This typeId SHALL contain exactly one [1..1] @extension="POCD_HD000040" (CONF:4537-5251).

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
Fixed ValuePOCD_HD000040
44. ClinicalDocument.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

Control2..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
SlicingThis element introduces a set of slices on ClinicalDocument.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
46. ClinicalDocument.templateId:us-realm
Slice Nameus-realm
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
48. ClinicalDocument.templateId:us-realm.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
50. ClinicalDocument.templateId:us-realm.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
52. ClinicalDocument.templateId:us-realm.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
54. ClinicalDocument.templateId:us-realm.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.1.1
56. ClinicalDocument.templateId:us-realm.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 Value2024-05-01
58. ClinicalDocument.templateId:operative-note
Slice Nameoperative-note
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
60. ClinicalDocument.templateId:operative-note.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
62. ClinicalDocument.templateId:operative-note.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
64. ClinicalDocument.templateId:operative-note.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
66. ClinicalDocument.templateId:operative-note.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.1.7
68. ClinicalDocument.templateId:operative-note.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 Value2024-05-01
70. ClinicalDocument.id
Short**SHALL** be a globally unique identifier for the document (CONF:4537-9991).
Comments

SHALL contain exactly one [1..1] id (CONF:4537-5363).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
72. ClinicalDocument.code
ShortThe Operative Note recommends use of a single document type code, 11504-8 "Provider-unspecified Operation Note", with further specification provided by author or performer, setting, or specialty data in the CDA header. Some of the LOINC codes in the Surgical Operation Note Document Type Code table are pre-coordinated with the practice setting or the training or professional level of the author. Use of pre-coordinated codes is not recommended because of potential conflict with other information in the header. When these codes are used, any coded values describing the author or performer of the service act or the practice setting must be consistent with the LOINC document type.
Comments

SHALL contain exactly one [1..1] code (CONF:1198-17187).

Control1..1
BindingFor example codes, see FHIRDocumentTypeCodes
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
Invariants4537-32948: This code **SHALL** be drawn from the LOINC document type ontology (LOINC codes where SCALE = DOC) (CONF:4537-32948). (codeSystem = '2.16.840.1.113883.6.1')
74. ClinicalDocument.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 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
76. ClinicalDocument.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.

Comments

This code SHALL contain exactly one [1..1] @code, which SHALL be selected from ValueSet SurgicalOperationNoteDocumentTypeCode http://hl7.org/fhir/ccda/ValueSet/2.16.840.1.113883.11.20.1.1 DYNAMIC (CONF:1198-17188).

Control1..1
BindingThe codes SHALL be taken from SurgicalOperationNoteDocumentTypeCode
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
78. ClinicalDocument.code.codeSystem
Definition

Specifies the code system that defines the code.

Control0..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.
LabelCode System
80. ClinicalDocument.code.codeSystemName
Definition

The common name of the coding system.

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.
LabelCode System Name
82. ClinicalDocument.code.codeSystemVersion
Definition

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

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.
LabelCode System Version
84. ClinicalDocument.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(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
86. ClinicalDocument.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(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.
88. ClinicalDocument.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(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.
90. ClinicalDocument.code.originalText
Definition

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

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
LabelOriginal Text
92. ClinicalDocument.code.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
94. ClinicalDocument.code.translation
Definition

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelTranslation
96. ClinicalDocument.title
ShortThe title can either be a locally defined name or the displayName corresponding to clinicalDocument/code
Comments

SHALL contain exactly one [1..1] title (CONF:4537-5254).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ST
98. ClinicalDocument.sdtcStatusCode
Definition

The statusCode extension attribute allows the implementer to identify a ClinicalDocument that is in other than the completed state. It was created to support the Structured Form Definition IG to identify that the document itself is an unfinished product currently being completed for a patient.

Control0..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namestatusCode.
100. ClinicalDocument.effectiveTime
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5256).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time)
Is Modifierfalse
Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
102. ClinicalDocument.confidentialityCode
Comments

SHALL contain exactly one [1..1] confidentialityCode, which SHOULD be selected from ValueSet HL7 BasicConfidentialityKind urn:oid:2.16.840.1.113883.1.11.16926 DYNAMIC (CONF:4537-5259).

Control1..1
BindingThe codes SHOULD be taken from HL7 BasicConfidentialityKind
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
104. ClinicalDocument.confidentialityCode.nullFlavor
Definition

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

Comments

SHALL NOT contain [0..0] @nullFlavor.

Control0..0
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. ClinicalDocument.confidentialityCode.code
Definition

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

Control1..1
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
108. ClinicalDocument.confidentialityCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..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.
LabelCode System
110. ClinicalDocument.confidentialityCode.codeSystemName
Definition

The common name of the coding system.

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.
LabelCode System Name
112. ClinicalDocument.confidentialityCode.codeSystemVersion
Definition

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

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.
LabelCode System Version
114. ClinicalDocument.confidentialityCode.displayName
Definition

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

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.
LabelDisplay Name
116. ClinicalDocument.confidentialityCode.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.
118. ClinicalDocument.confidentialityCode.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.
120. ClinicalDocument.confidentialityCode.originalText
Definition

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

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
LabelOriginal Text
122. ClinicalDocument.confidentialityCode.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
124. ClinicalDocument.confidentialityCode.translation
Definition

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelTranslation
126. ClinicalDocument.languageCode
Comments

SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet AllLanguages https://www.hl7.org/fhir/valueset-all-languages.html (OID 2.16.840.1.113883.4.642.3.21) DYNAMIC.

Control1..1
BindingThe codes SHALL be taken from AllLanguages
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
128. ClinicalDocument.setId
Comments

MAY contain zero or one [0..1] setId (CONF:4537-5261).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
130. ClinicalDocument.versionNumber
Comments

MAY contain zero or one [0..1] versionNumber (CONF:4537-5264).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
132. ClinicalDocument.copyTime
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
134. ClinicalDocument.recordTarget
ShortThe recordTarget records the administrative and demographic data of the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element
Comments

SHALL contain at least one [1..*] recordTarget (CONF:4537-5266).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RecordTarget
136. ClinicalDocument.recordTarget.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
138. ClinicalDocument.recordTarget.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
140. ClinicalDocument.recordTarget.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
142. ClinicalDocument.recordTarget.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
144. ClinicalDocument.recordTarget.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
146. ClinicalDocument.recordTarget.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
148. ClinicalDocument.recordTarget.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
150. ClinicalDocument.recordTarget.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
152. ClinicalDocument.recordTarget.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
154. ClinicalDocument.recordTarget.typeCode
Control0..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 ValueRCT
156. ClinicalDocument.recordTarget.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
158. ClinicalDocument.recordTarget.patientRole
Comments

Such recordTargets SHALL contain exactly one [1..1] patientRole (CONF:4537-5267).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PatientRole
160. ClinicalDocument.recordTarget.patientRole.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
162. ClinicalDocument.recordTarget.patientRole.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
164. ClinicalDocument.recordTarget.patientRole.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
166. ClinicalDocument.recordTarget.patientRole.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
168. ClinicalDocument.recordTarget.patientRole.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
170. ClinicalDocument.recordTarget.patientRole.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
172. ClinicalDocument.recordTarget.patientRole.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
174. ClinicalDocument.recordTarget.patientRole.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
176. ClinicalDocument.recordTarget.patientRole.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
178. ClinicalDocument.recordTarget.patientRole.classCode
Control0..1
BindingThe codes SHALL be taken from RoleClassRelationshipFormal
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 ValuePAT
180. ClinicalDocument.recordTarget.patientRole.id
Comments

This patientRole SHALL contain at least one [1..*] id (CONF:4537-5268).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
182. ClinicalDocument.recordTarget.patientRole.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
184. ClinicalDocument.recordTarget.patientRole.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

Short(USCDI) Address
Comments

This patientRole SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5271).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
Is Modifierfalse
Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
186. ClinicalDocument.recordTarget.patientRole.telecom
Short(USCDI) Phone Number / Email
Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
Invariantsshould-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
188. ClinicalDocument.recordTarget.patientRole.telecom.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
190. ClinicalDocument.recordTarget.patientRole.telecom.value
Control0..1
Typeurl(url: Universal Resource Locator)
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.
192. ClinicalDocument.recordTarget.patientRole.telecom.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/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelUseable Period
194. ClinicalDocument.recordTarget.patientRole.telecom.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.

Comments

Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-5375).

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
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.
LabelUse Code
196. ClinicalDocument.recordTarget.patientRole.patient
Comments

This patientRole SHALL contain exactly one [1..1] patient (CONF:4537-5283).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Patient
Invariants4537-32993: If sdtc:deceasedInd="true", then sdtc:deceasedTime **SHALL** be present with either a @value or @nullFlavor=UNK (CONF:4537-32993). (sdtcDeceasedInd.exists(value='true') implies sdtcDeceasedTime.exists())
4537-21000: If sdtc:deceasedTime/@value is present, then sdtc:deceasedInd SHALL be present with value=true (sdtcDeceasedTime.value.exists() implies sdtcDeceasedInd.exists(value='true'))
should-maritalStatusCode: SHOULD contain maritalStatusCode (maritalStatusCode.exists())
should-us-languageCommunication: SHOULD contain languageCommunication (languageCommunication.exists())
198. ClinicalDocument.recordTarget.patientRole.patient.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
200. ClinicalDocument.recordTarget.patientRole.patient.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
202. ClinicalDocument.recordTarget.patientRole.patient.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
204. ClinicalDocument.recordTarget.patientRole.patient.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
206. ClinicalDocument.recordTarget.patientRole.patient.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
208. ClinicalDocument.recordTarget.patientRole.patient.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
210. ClinicalDocument.recordTarget.patientRole.patient.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
212. ClinicalDocument.recordTarget.patientRole.patient.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
214. ClinicalDocument.recordTarget.patientRole.patient.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
216. ClinicalDocument.recordTarget.patientRole.patient.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
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 ValuePSN
218. ClinicalDocument.recordTarget.patientRole.patient.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
220. ClinicalDocument.recordTarget.patientRole.patient.id
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
222. ClinicalDocument.recordTarget.patientRole.patient.name
Definition

A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).

ShortBase for all types and resources
Comments

This patient SHALL contain at least one [1..*] US Realm Patient Name (PTN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1) (CONF:4537-5284).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Patient Name (PTN.US.FIELDED))
Is Modifierfalse
Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). (nullFlavor.exists() or item.family.count() = 1)
shall-given: SHALL contain at least one [1..*] given (CONF:81-7157). (nullFlavor.exists() or item.given.exists())
shall-max-suffix: There may be at most one suffix ((item.suffix.empty() or item.suffix.count() = 1))
81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278). (item.xmlText.empty())
224. ClinicalDocument.recordTarget.patientRole.patient.sdtcDesc
Definition

The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
226. ClinicalDocument.recordTarget.patientRole.patient.administrativeGenderCode
Comments

This patient SHALL contain exactly one [1..1] administrativeGenderCode, which SHALL be selected from ValueSet Administrative Gender (HL7 V3) urn:oid:2.16.840.1.113883.1.11.1 DYNAMIC (CONF:4537-6394).

Control1..1
BindingThe codes SHALL be taken from Administrative Gender (HL7 V3)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
228. ClinicalDocument.recordTarget.patientRole.patient.birthTime
Short(USCDI) Date of Birth - **MAY** be precise to the minute (CONF:4537-32418) (For cases where information about newborn's time of birth needs to be captured)
Comments

This patient SHALL contain exactly one [1..1] birthTime (CONF:4537-5298).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
Invariantsts-shall-year: **SHALL** be precise to at least the year (nullFlavor.exists() or value.toString().length() >= 4)
ts-should-day: **SHOULD** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
230. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedInd
Shortsdtc:deceasedInd
Comments

This patient MAY contain zero or one [0..1] sdtc:deceasedInd (CONF:4537-32990).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedeceasedInd.
232. ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime
Short(USCDI) Date of Death
Comments

This patient MAY contain zero or one [0..1] sdtc:deceasedTime (CONF:4537-32988).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedeceasedTime.
Invariantsshould-value-att: SHOULD contain @value (value.exists())
ts-shall-year: **SHALL** be precise to at least the year (nullFlavor.exists() or value.toString().length() >= 4)
ts-should-day: **SHOULD** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
234. ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namemultipleBirthInd.
236. ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthOrderNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT-POS
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namemultipleBirthOrderNumber.
238. ClinicalDocument.recordTarget.patientRole.patient.maritalStatusCode
Comments

This patient SHOULD contain zero or one [0..1] maritalStatusCode, which SHALL be selected from ValueSet Marital Status urn:oid:2.16.840.1.113883.1.11.12212 DYNAMIC (CONF:4537-5303).

Control0..1
BindingThe codes SHALL be taken from Marital Status
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
240. ClinicalDocument.recordTarget.patientRole.patient.religiousAffiliationCode
Comments

This patient MAY contain zero or one [0..1] religiousAffiliationCode, which SHALL be selected from ValueSet Religious Affiliation urn:oid:2.16.840.1.113883.1.11.19185 DYNAMIC (CONF:4537-5317).

Control0..1
BindingThe codes SHALL be taken from Religious Affiliation
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
242. ClinicalDocument.recordTarget.patientRole.patient.raceCode
Short(USCDI) Race
Comments

This patient SHALL contain exactly one [1..1] raceCode, which SHALL be selected from ValueSet Race Category Excluding Nulls urn:oid:2.16.840.1.113883.3.2074.1.1.3 DYNAMIC (CONF:4537-5322).

Control1..1
BindingThe codes SHALL be taken from Race Category Excluding Nulls
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
244. ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode
Short(USCDI) Race - The sdtc:raceCode is only used to record additional values when the patient has indicated multiple races or additional race detail beyond the five categories required for Meaningful Use Stage 2. The prefix sdtc: SHALL be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the additional raceCode elements.
Comments

This patient MAY contain zero or more [0..*] sdtc:raceCode, which SHALL be selected from ValueSet Race Value Set urn:oid:2.16.840.1.113883.1.11.14914 DYNAMIC (CONF:4537-7263).

Control0..*
BindingThe codes SHALL be taken from Race Value Set
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 nameraceCode.
246. ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode
Short(USCDI) Ethnicity
Comments

This patient SHALL contain exactly one [1..1] ethnicGroupCode, which SHALL be selected from ValueSet Ethnicity urn:oid:2.16.840.1.114222.4.11.837 DYNAMIC (CONF:4537-5323).

Control1..1
BindingThe codes SHALL be taken from Ethnicity
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
248. ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode
Short(USCDI) Ethnicity
Comments

This patient MAY contain zero or more [0..*] ethnicGroupCode, which SHALL be selected from ValueSet Detailed Ethnicity urn:oid:2.16.840.1.114222.4.11.877 DYNAMIC (CONF:4537-32901).

Control0..*
BindingThe codes SHALL be taken from Detailed Ethnicity
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 nameethnicGroupCode.
250. ClinicalDocument.recordTarget.patientRole.patient.guardian
Comments

This patient MAY contain zero or more [0..*] guardian (CONF:4537-5325).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Guardian
Invariantsshould-us-code: SHOULD contain code (code.exists())
should-us-addr: SHOULD contain addr (addr.exists())
should-us-telecom: SHOULD contain telecom (telecom.exists())
252. ClinicalDocument.recordTarget.patientRole.patient.guardian.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
254. ClinicalDocument.recordTarget.patientRole.patient.guardian.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
256. ClinicalDocument.recordTarget.patientRole.patient.guardian.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
258. ClinicalDocument.recordTarget.patientRole.patient.guardian.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
260. ClinicalDocument.recordTarget.patientRole.patient.guardian.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
262. ClinicalDocument.recordTarget.patientRole.patient.guardian.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
264. ClinicalDocument.recordTarget.patientRole.patient.guardian.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
266. ClinicalDocument.recordTarget.patientRole.patient.guardian.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
268. ClinicalDocument.recordTarget.patientRole.patient.guardian.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
270. ClinicalDocument.recordTarget.patientRole.patient.guardian.classCode
Control0..1
BindingThe codes SHALL be taken from RoleClassAgent
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 ValueGUARD
272. ClinicalDocument.recordTarget.patientRole.patient.guardian.id
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
274. ClinicalDocument.recordTarget.patientRole.patient.guardian.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
276. ClinicalDocument.recordTarget.patientRole.patient.guardian.code
Comments

The guardian, if present, SHOULD contain zero or one [0..1] code, which SHALL be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:4537-5326).

Control0..1
BindingThe codes SHALL be taken from Personal And Legal Relationship Role Type
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
278. ClinicalDocument.recordTarget.patientRole.patient.guardian.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

ShortBase for all types and resources
Comments

The guardian, if present, SHOULD contain zero or more [0..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5359).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
Is Modifierfalse
Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
280. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom
Comments

The guardian, if present, SHOULD contain zero or more [0..*] telecom (CONF:4537-5382).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
Invariantsshould-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
282. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.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
284. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.value
Control0..1
Typeurl(url: Universal Resource Locator)
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.
286. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.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/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelUseable Period
288. ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.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.

Comments

The telecom, if present, SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7993).

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
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.
LabelUse Code
290. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson
Comments

The guardian, if present, SHALL contain exactly one [1..1] guardianPerson (CONF:4537-5385).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
292. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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
294. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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
296. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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
298. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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
300. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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
302. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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
304. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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
306. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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
308. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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
310. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
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 ValuePSN
312. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
314. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name
Definition

A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).

ShortBase for all types and resources
Comments

This guardianPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5386).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifierfalse
Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists())
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty())
316. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcDesc
Definition

The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
318. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship
Definition

Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameasPatientRelationship.
320. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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
322. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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
324. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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
326. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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
328. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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
330. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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
332. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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
334. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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
336. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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
338. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.classCode
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.
Fixed ValuePRS
340. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.determinerCode
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.
Fixed ValueINSTANCE
342. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.code
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
344. ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianOrganization
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
346. ClinicalDocument.recordTarget.patientRole.patient.birthplace
Comments

This patient MAY contain zero or one [0..1] birthplace (CONF:4537-5395).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Birthplace
348. ClinicalDocument.recordTarget.patientRole.patient.birthplace.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
350. ClinicalDocument.recordTarget.patientRole.patient.birthplace.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
352. ClinicalDocument.recordTarget.patientRole.patient.birthplace.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
354. ClinicalDocument.recordTarget.patientRole.patient.birthplace.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
356. ClinicalDocument.recordTarget.patientRole.patient.birthplace.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
358. ClinicalDocument.recordTarget.patientRole.patient.birthplace.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
360. ClinicalDocument.recordTarget.patientRole.patient.birthplace.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
362. ClinicalDocument.recordTarget.patientRole.patient.birthplace.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
364. ClinicalDocument.recordTarget.patientRole.patient.birthplace.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
366. ClinicalDocument.recordTarget.patientRole.patient.birthplace.classCode
Control0..1
BindingThe codes SHALL be taken from RoleClassPassive
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 ValueBIRTHPL
368. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place
Comments

The birthplace, if present, SHALL contain exactly one [1..1] place (CONF:4537-5396).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Place
370. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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
372. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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
374. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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
376. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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
378. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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
380. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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
382. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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
384. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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
386. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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
388. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassPlace
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 ValuePLC
390. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
392. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.name
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EN
394. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr
Comments

This place SHALL contain exactly one [1..1] addr (CONF:4537-5397).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
Invariants4537-5402: If country is US, this addr **SHALL** contain exactly one [1..1] state, which **SHALL** be selected from ValueSet US Core USPS State *DYNAMIC* (CONF:4537-5402). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
4537-5403: If country is US, this addr **MAY** contain zero or one [0..1] postalCode, which **SHALL** be selected from ValueSet PostalCode urn:oid:2.16.840.1.113883.3.88.12.80.2 *DYNAMIC* (CONF:4537-5403). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.empty() or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
396. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.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
398. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.isNotOrdered
Definition

A boolean value specifying whether the order of the address parts is known or not. While the address parts are always a Sequence, the order in which they are presented may or may not be known. Where this matters, the isNotOrdered property can be used to convey this information.

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.
LabelIs Not Ordered
400. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.use
Definition

A set of codes advising a system or user which address in a set of like addresses to select for a given purpose.

Control0..*
BindingThe codes SHALL be taken from CDAPostalAddressUse
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.
LabelUse Code
402. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item
Definition

A series of items that constitute the address.

Control0..*
Typehttp://hl7.org/fhir/StructureDefinition/Base
Choice GroupThis is a repeating choice group that does not appear directly in the instance
InvariantsAD-1: Can only have only one of the possible item elements in each choice ((delimiter | country | state | county | city | postalCode | streetAddressLine | houseNumber | houseNumberNumeric | direction | streetName | streetNameBase | streetNameType | additionalLocator | unitID | unitType | careOf | censusTract | deliveryAddressLine | deliveryInstallationType | deliveryInstallationArea | deliveryInstallationQualifier | deliveryMode | deliveryModeIdentifier | buildingNumberSuffix | postBox | precinct | xmlText).count() = 1)
404. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter
Definition

Delimiters are printed without framing white space. If no value component is provided, the delimiter appears as a line break.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
406. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.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
408. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

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.
Fixed ValueTXT
410. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.mediaType
Definition

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

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.
LabelMedia Type
Fixed Valuetext/plain
412. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.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
414. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.xmlText
ShortAllows for mixed text content
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.
416. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.partType
Definition

Specifies the type of the address part

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.
Fixed ValueDEL
418. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country
Definition

Country

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
420. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.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
422. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

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.
Fixed ValueTXT
424. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.mediaType
Definition

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

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.
LabelMedia Type
Fixed Valuetext/plain
426. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.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
428. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.xmlText
ShortAllows for mixed text content
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.
430. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.partType
Definition

Specifies the type of the address part

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.
Fixed ValueCNT
432. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state
Definition

A sub-unit of a country with limited sovereignty in a federally organized country.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
434. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.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
436. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

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.
Fixed ValueTXT
438. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.mediaType
Definition

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

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.
LabelMedia Type
Fixed Valuetext/plain
440. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.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
442. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.xmlText
ShortAllows for mixed text content
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.
444. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.partType
Definition

Specifies the type of the address part

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.
Fixed ValueSTA
446. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county
Definition

A sub-unit of a state or province. (49 of the United States of America use the term "county;" Louisiana uses the term "parish".)

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
448. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.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
450. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

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.
Fixed ValueTXT
452. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.mediaType
Definition

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

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.
LabelMedia Type
Fixed Valuetext/plain
454. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.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
456. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.xmlText
ShortAllows for mixed text content
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.
458. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.partType
Definition

Specifies the type of the address part

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.
Fixed ValueCPA
460. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city
Definition

The name of the city, town, village, or other community or delivery center

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
462. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.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
464. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

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.
Fixed ValueTXT
466. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.mediaType
Definition

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

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.
LabelMedia Type
Fixed Valuetext/plain
468. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.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
470. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.xmlText
ShortAllows for mixed text content
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.
472. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.partType
Definition

Specifies the type of the address part

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.
Fixed ValueCTY
474. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode
Definition

A postal code designating a region defined by the postal service.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
476. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.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
478. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

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.
Fixed ValueTXT
480. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.mediaType
Definition

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

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.
LabelMedia Type
Fixed Valuetext/plain
482. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.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
484. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.xmlText
ShortAllows for mixed text content
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.
486. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.partType
Definition

Specifies the type of the address part

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.
Fixed ValueZIP
488. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine
Definition

Street address line

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
490. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.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
492. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

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.
Fixed ValueTXT
494. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.mediaType
Definition

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

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.
LabelMedia Type
Fixed Valuetext/plain
496. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.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
498. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.xmlText
ShortAllows for mixed text content
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.
500. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.partType
Definition

Specifies the type of the address part

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.
Fixed ValueSAL
502. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber
Definition

The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
504. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.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
506. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

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.
Fixed ValueTXT
508. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.mediaType
Definition

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

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.
LabelMedia Type
Fixed Valuetext/plain
510. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.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
512. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.xmlText
ShortAllows for mixed text content
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.
514. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.partType
Definition

Specifies the type of the address part

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.
Fixed ValueBNR
516. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric
Definition

The numeric portion of a building number

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
518. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.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
520. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

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.
Fixed ValueTXT
522. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.mediaType
Definition

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

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.
LabelMedia Type
Fixed Valuetext/plain
524. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.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
526. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.xmlText
ShortAllows for mixed text content
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.
528. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.partType
Definition

Specifies the type of the address part

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.
Fixed ValueBNN
530. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction
Definition

Direction (e.g., N, S, W, E)

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
532. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.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
534. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

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.
Fixed ValueTXT
536. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.mediaType
Definition

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

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.
LabelMedia Type
Fixed Valuetext/plain
538. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.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
540. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.xmlText
ShortAllows for mixed text content
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.
542. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.partType
Definition

Specifies the type of the address part

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.
Fixed ValueDIR
544. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName
Definition

Name of a roadway or artery recognized by a municipality (including street type and direction)

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
546. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.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
548. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

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.
Fixed ValueTXT
550. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.mediaType
Definition

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

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.
LabelMedia Type
Fixed Valuetext/plain
552. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.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
554. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.xmlText
ShortAllows for mixed text content
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.
556. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.partType
Definition

Specifies the type of the address part

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.
Fixed ValueSTR
558. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase
Definition

The base name of a roadway or artery recognized by a municipality (excluding street type and direction)

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
560. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.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
562. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

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.
Fixed ValueTXT
564. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.mediaType
Definition

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

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.
LabelMedia Type
Fixed Valuetext/plain
566. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.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
568. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.xmlText
ShortAllows for mixed text content
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.
570. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.partType
Definition

Specifies the type of the address part

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.
Fixed ValueSTB
572. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType
Definition

The designation given to the street. (e.g. Street, Avenue, Crescent, etc.)

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
574. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.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
576. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

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.
Fixed ValueTXT
578. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.mediaType
Definition

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

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.
LabelMedia Type
Fixed Valuetext/plain
580. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.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
582. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.xmlText
ShortAllows for mixed text content
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.
584. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.partType
Definition

Specifies the type of the address part

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.
Fixed ValueSTTYP
586. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator
Definition

This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
588. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.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
590. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

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.
Fixed ValueTXT
592. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.mediaType
Definition

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

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.
LabelMedia Type
Fixed Valuetext/plain
594. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.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
596. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.xmlText
ShortAllows for mixed text content
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.
598. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.partType
Definition

Specifies the type of the address part

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.
Fixed ValueADL
600. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID
Definition

The number or name of a specific unit contained within a building or complex, as assigned by that building or complex.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
602. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.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
604. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

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.
Fixed ValueTXT
606. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.mediaType
Definition

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

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.
LabelMedia Type
Fixed Valuetext/plain
608. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.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
610. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.xmlText
ShortAllows for mixed text content
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.
612. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.partType
Definition

Specifies the type of the address part

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.
Fixed ValueUNID
614. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType
Definition

Indicates the type of specific unit contained within a building or complex. E.g. Appartment, Floor

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
616. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.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
618. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

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.
Fixed ValueTXT
620. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.mediaType
Definition

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

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.
LabelMedia Type
Fixed Valuetext/plain
622. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.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
624. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.xmlText
ShortAllows for mixed text content
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.
626. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.partType
Definition

Specifies the type of the address part

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.
Fixed ValueUNIT
628. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf
Definition

The name of the party who will take receipt at the specified address, and will take on responsibility for ensuring delivery to the target recipient

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
630. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.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
632. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

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.
Fixed ValueTXT
634. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.mediaType
Definition

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

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.
LabelMedia Type
Fixed Valuetext/plain
636. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.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
638. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.xmlText
ShortAllows for mixed text content
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.
640. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.partType
Definition

Specifies the type of the address part

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.
Fixed ValueCAR
642. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract
Definition

A geographic sub-unit delineated for demographic purposes.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
644. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.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
646. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

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.
Fixed ValueTXT
648. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.mediaType
Definition

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

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.
LabelMedia Type
Fixed Valuetext/plain
650. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.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
652. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.xmlText
ShortAllows for mixed text content
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.
654. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.partType
Definition

Specifies the type of the address part

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.
Fixed ValueCEN
656. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine
Definition

A delivery address line is frequently used instead of breaking out delivery mode, delivery installation, etc. An address generally has only a delivery address line or a street address line, but not both.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
658. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.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
660. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

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.
Fixed ValueTXT
662. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.mediaType
Definition

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

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.
LabelMedia Type
Fixed Valuetext/plain
664. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.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
666. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.xmlText
ShortAllows for mixed text content
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.
668. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.partType
Definition

Specifies the type of the address part

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.
Fixed ValueDAL
670. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType
Definition

Indicates the type of delivery installation (the facility to which the mail will be delivered prior to final shipping via the delivery mode.) Example: post office, letter carrier depot, community mail center, station, etc.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
672. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.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
674. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

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.
Fixed ValueTXT
676. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.mediaType
Definition

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

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.
LabelMedia Type
Fixed Valuetext/plain
678. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.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
680. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.xmlText
ShortAllows for mixed text content
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.
682. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.partType
Definition

Specifies the type of the address part

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.
Fixed ValueDINST
684. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea
Definition

The location of the delivery installation, usually a town or city, and is only required if the area is different from the municipality. Area to which mail delivery service is provided from any postal facility or service such as an individual letter carrier, rural route, or postal route.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
686. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.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
688. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

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.
Fixed ValueTXT
690. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.mediaType
Definition

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

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.
LabelMedia Type
Fixed Valuetext/plain
692. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.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
694. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.xmlText
ShortAllows for mixed text content
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.
696. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.partType
Definition

Specifies the type of the address part

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.
Fixed ValueDINSTA
698. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier
Definition

A number, letter or name identifying a delivery installation. E.g., for Station A, the delivery installation qualifier would be 'A'.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
700. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.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
702. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

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.
Fixed ValueTXT
704. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.mediaType
Definition

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

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.
LabelMedia Type
Fixed Valuetext/plain
706. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.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
708. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.xmlText
ShortAllows for mixed text content
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.
710. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.partType
Definition

Specifies the type of the address part

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.
Fixed ValueDINSTQ
712. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode
Definition

Indicates the type of service offered, method of delivery. For example: post office box, rural route, general delivery, etc.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
714. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.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
716. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

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.
Fixed ValueTXT
718. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.mediaType
Definition

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

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.
LabelMedia Type
Fixed Valuetext/plain
720. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.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
722. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.xmlText
ShortAllows for mixed text content
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.
724. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.partType
Definition

Specifies the type of the address part

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.
Fixed ValueDMOD
726. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier
Definition

Represents the routing information such as a letter carrier route number. It is the identifying number of the designator (the box number or rural route number).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
728. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.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
730. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

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.
Fixed ValueTXT
732. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.mediaType
Definition

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

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.
LabelMedia Type
Fixed Valuetext/plain
734. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.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
736. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.xmlText
ShortAllows for mixed text content
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.
738. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.partType
Definition

Specifies the type of the address part

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.
Fixed ValueDMODID
740. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix
Definition

Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
742. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.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
744. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

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.
Fixed ValueTXT
746. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.mediaType
Definition

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

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.
LabelMedia Type
Fixed Valuetext/plain
748. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.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
750. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.xmlText
ShortAllows for mixed text content
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.
752. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.partType
Definition

Specifies the type of the address part

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.
Fixed ValueBNS
754. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox
Definition

A numbered box located in a post station.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
756. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.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
758. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

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.
Fixed ValueTXT
760. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.mediaType
Definition

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

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.
LabelMedia Type
Fixed Valuetext/plain
762. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.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
764. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.xmlText
ShortAllows for mixed text content
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.
766. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.partType
Definition

Specifies the type of the address part

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.
Fixed ValuePOB
768. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct
Definition

A subsection of a municipality

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ADXP
Invariantstext-null: xmlText and nullFlavor are mutually exclusive (one must be present) ((xmlText | nullFlavor).count() = 1)
770. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.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
772. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

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.
Fixed ValueTXT
774. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.mediaType
Definition

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

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.
LabelMedia Type
Fixed Valuetext/plain
776. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.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
778. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.xmlText
ShortAllows for mixed text content
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.
780. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.partType
Definition

Specifies the type of the address part

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.
Fixed ValuePRE
782. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.xmlText
ShortAllows for mixed text content
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.
784. ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.useablePeriod
Definition

A General Timing Specification (GTS) specifying the periods of time during which the address can be used. This is used to specify different addresses for different times of the week or year.

Control0..*
TypeChoice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelUseable Period
786. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication
Comments

This patient SHOULD contain zero or more [0..*] languageCommunication which SHALL be selected from ValueSet AllLanguages https://www.hl7.org/fhir/valueset-all-languages.html (OID 2.16.840.1.113883.4.642.3.21) DYNAMIC (CONF:XXX).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/LanguageCommunication
Invariantsshould-proficiencyLevelCode: SHOULD contain proficiencyLevelCode (proficiencyLevelCode.exists())
should-preferenceInd: SHOULD contain preferenceInd (preferenceInd.exists())
788. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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
790. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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
792. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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
794. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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
796. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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
798. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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
800. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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
802. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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
804. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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
806. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode
Control1..1
BindingThe codes SHALL be taken from AllLanguages
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
808. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.modeCode
Comments

The languageCommunication, if present, MAY contain zero or one [0..1] modeCode, which SHALL be selected from ValueSet LanguageAbilityMode urn:oid:2.16.840.1.113883.1.11.12249 DYNAMIC (CONF:4537-5409).

Control0..1
BindingThe codes SHALL be taken from LanguageAbilityMode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
810. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.proficiencyLevelCode
Comments

The languageCommunication, if present, SHOULD contain zero or one [0..1] proficiencyLevelCode, which SHALL be selected from ValueSet LanguageAbilityProficiency urn:oid:2.16.840.1.113883.1.11.12199 DYNAMIC (CONF:4537-9965).

Control0..1
BindingThe codes SHALL be taken from LanguageAbilityProficiency
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
812. ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd
Comments

The languageCommunication, if present, SHOULD contain zero or one [0..1] preferenceInd (CONF:4537-5414).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
814. ClinicalDocument.recordTarget.patientRole.providerOrganization
Comments

This patientRole MAY contain zero or one [0..1] providerOrganization (CONF:4537-5416).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
816. ClinicalDocument.recordTarget.patientRole.providerOrganization.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
818. ClinicalDocument.recordTarget.patientRole.providerOrganization.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
820. ClinicalDocument.recordTarget.patientRole.providerOrganization.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
822. ClinicalDocument.recordTarget.patientRole.providerOrganization.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
824. ClinicalDocument.recordTarget.patientRole.providerOrganization.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
826. ClinicalDocument.recordTarget.patientRole.providerOrganization.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
828. ClinicalDocument.recordTarget.patientRole.providerOrganization.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
830. ClinicalDocument.recordTarget.patientRole.providerOrganization.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
832. ClinicalDocument.recordTarget.patientRole.providerOrganization.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
834. ClinicalDocument.recordTarget.patientRole.providerOrganization.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassOrganization
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 ValueORG
836. ClinicalDocument.recordTarget.patientRole.providerOrganization.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
838. ClinicalDocument.recordTarget.patientRole.providerOrganization.id
Comments

The providerOrganization, if present, SHALL contain at least one [1..*] id (CONF:4537-5417).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
840. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.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
842. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.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
844. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.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
846. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.root
Definition

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

Comments

Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16820).

Control0..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
Invariantsshould-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6')
848. ClinicalDocument.recordTarget.patientRole.providerOrganization.id.extension
Definition

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

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.
LabelExtension
850. ClinicalDocument.recordTarget.patientRole.providerOrganization.name
Comments

The providerOrganization, if present, SHALL contain at least one [1..*] name (CONF:4537-5419).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ON
852. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom
Comments

The providerOrganization, if present, SHALL contain at least one [1..*] telecom (CONF:4537-5420).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
Invariantsshould-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
854. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.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
856. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.value
Control0..1
Typeurl(url: Universal Resource Locator)
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.
858. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.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/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelUseable Period
860. ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.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.

Comments

Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7994).

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
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.
LabelUse Code
862. ClinicalDocument.recordTarget.patientRole.providerOrganization.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

ShortBase for all types and resources
Comments

The providerOrganization, if present, SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5422).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
Is Modifierfalse
Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
864. ClinicalDocument.recordTarget.patientRole.providerOrganization.standardIndustryClassCode
Control0..1
BindingFor example codes, see OrganizationIndustryClassNAICS
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
866. ClinicalDocument.recordTarget.patientRole.providerOrganization.asOrganizationPartOf
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf
868. ClinicalDocument.author
ShortThe author element represents the creator of the clinical document. The author may be a device or a person.
Comments

SHALL contain at least one [1..*] author (CONF:4537-5444).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
870. ClinicalDocument.author.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
872. ClinicalDocument.author.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
874. ClinicalDocument.author.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
876. ClinicalDocument.author.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
878. ClinicalDocument.author.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
880. ClinicalDocument.author.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
882. ClinicalDocument.author.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
884. ClinicalDocument.author.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
886. ClinicalDocument.author.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
888. ClinicalDocument.author.typeCode
Control0..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 ValueAUT
890. ClinicalDocument.author.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
892. ClinicalDocument.author.functionCode
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
894. ClinicalDocument.author.time
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

ShortBase for all types and resources
Comments

Such authors SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5445).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time)
Is Modifierfalse
Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
896. ClinicalDocument.author.assignedAuthor
Comments

Such authors SHALL contain exactly one [1..1] assignedAuthor (CONF:4537-5448).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedAuthor
Invariants4537-16790: There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790). ((assignedPerson | assignedAuthoringDevice).count() = 1)
should-id-npi: SHOULD contain an id with root='2.16.840.1.113883.4.6' (NPI) (id.where(root = '2.16.840.1.113883.4.6'))
should-us-code: SHOULD contain code (code.exists())
898. ClinicalDocument.author.assignedAuthor.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
900. ClinicalDocument.author.assignedAuthor.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
902. ClinicalDocument.author.assignedAuthor.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
904. ClinicalDocument.author.assignedAuthor.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
906. ClinicalDocument.author.assignedAuthor.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
908. ClinicalDocument.author.assignedAuthor.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
910. ClinicalDocument.author.assignedAuthor.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
912. ClinicalDocument.author.assignedAuthor.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
914. ClinicalDocument.author.assignedAuthor.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
916. ClinicalDocument.author.assignedAuthor.classCode
Control0..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
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 ValueASSIGNED
918. ClinicalDocument.author.assignedAuthor.id
Comments

This assignedAuthor SHOULD contain zero or one [0..1] id (CONF:4537-32882) such that it, This assignedAuthor SHALL contain at least one [1..*] id (CONF:4537-5449).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
SlicingThis element introduces a set of slices on ClinicalDocument.author.assignedAuthor.id. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
920. ClinicalDocument.author.assignedAuthor.id:npi
Slice Namenpi
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
Invariantsshould-extension: SHOULD contain extension (extension.exists())
922. ClinicalDocument.author.assignedAuthor.id:npi.nullFlavor
Definition

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

ShortIf NPI is unknown, set @nullFlavor to UNK
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
924. ClinicalDocument.author.assignedAuthor.id:npi.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
926. ClinicalDocument.author.assignedAuthor.id:npi.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
928. ClinicalDocument.author.assignedAuthor.id:npi.root
Definition

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

Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-32884).

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.4.6
930. ClinicalDocument.author.assignedAuthor.id:npi.extension
Definition

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

Comments

SHOULD contain zero or one [0..1] @extension (CONF:4537-32885).

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.
LabelExtension
932. ClinicalDocument.author.assignedAuthor.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
934. ClinicalDocument.author.assignedAuthor.code
ShortOnly if this assignedAuthor is an assignedPerson should the assignedAuthor contain a code.
Comments

This assignedAuthor SHOULD contain zero or one [0..1] code (CONF:4537-16787).

Control0..1
BindingFor example codes, see v3 Code System RoleCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
936. ClinicalDocument.author.assignedAuthor.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 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
938. ClinicalDocument.author.assignedAuthor.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.

Comments

The code, if present, SHALL contain exactly one [1..1] @code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4537-16788).

Control1..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
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
940. ClinicalDocument.author.assignedAuthor.code.codeSystem
Definition

Specifies the code system that defines the code.

Control0..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.
LabelCode System
942. ClinicalDocument.author.assignedAuthor.code.codeSystemName
Definition

The common name of the coding system.

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.
LabelCode System Name
944. ClinicalDocument.author.assignedAuthor.code.codeSystemVersion
Definition

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

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.
LabelCode System Version
946. ClinicalDocument.author.assignedAuthor.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(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
948. ClinicalDocument.author.assignedAuthor.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(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.
950. ClinicalDocument.author.assignedAuthor.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(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.
952. ClinicalDocument.author.assignedAuthor.code.originalText
Definition

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

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
LabelOriginal Text
954. ClinicalDocument.author.assignedAuthor.code.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
956. ClinicalDocument.author.assignedAuthor.code.translation
Definition

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelTranslation
958. ClinicalDocument.author.assignedAuthor.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

ShortBase for all types and resources
Comments

This assignedAuthor SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5452).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
Is Modifierfalse
Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
960. ClinicalDocument.author.assignedAuthor.telecom
Comments

This assignedAuthor SHALL contain at least one [1..*] telecom (CONF:4537-5428).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
Invariantsshould-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
962. ClinicalDocument.author.assignedAuthor.telecom.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
964. ClinicalDocument.author.assignedAuthor.telecom.value
Control0..1
Typeurl(url: Universal Resource Locator)
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.
966. ClinicalDocument.author.assignedAuthor.telecom.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/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelUseable Period
968. ClinicalDocument.author.assignedAuthor.telecom.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.

Comments

Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7995).

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
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.
LabelUse Code
970. ClinicalDocument.author.assignedAuthor.assignedPerson
Comments

MAY contain assignedPerson

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
972. ClinicalDocument.author.assignedAuthor.assignedPerson.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
974. ClinicalDocument.author.assignedAuthor.assignedPerson.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
976. ClinicalDocument.author.assignedAuthor.assignedPerson.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
978. ClinicalDocument.author.assignedAuthor.assignedPerson.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
980. ClinicalDocument.author.assignedAuthor.assignedPerson.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
982. ClinicalDocument.author.assignedAuthor.assignedPerson.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
984. ClinicalDocument.author.assignedAuthor.assignedPerson.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
986. ClinicalDocument.author.assignedAuthor.assignedPerson.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
988. ClinicalDocument.author.assignedAuthor.assignedPerson.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
990. ClinicalDocument.author.assignedAuthor.assignedPerson.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
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 ValuePSN
992. ClinicalDocument.author.assignedAuthor.assignedPerson.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
994. ClinicalDocument.author.assignedAuthor.assignedPerson.name
Definition

A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).

ShortBase for all types and resources
Comments

The assignedPerson, if present, SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-16789).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifierfalse
Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists())
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty())
996. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcDesc
Definition

The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
998. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship
Definition

Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameasPatientRelationship.
1000. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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
1002. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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
1004. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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
1006. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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
1008. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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
1010. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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
1012. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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
1014. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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
1016. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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
1018. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.classCode
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.
Fixed ValuePRS
1020. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.determinerCode
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.
Fixed ValueINSTANCE
1022. ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.code
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
1024. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice
Comments

MAY contain assignedAuthoringDevice

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AuthoringDevice
1026. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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
1028. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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
1030. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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
1032. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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
1034. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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
1036. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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
1038. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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
1040. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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
1042. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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
1044. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassDevice
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 ValueDEV
1046. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
1048. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.code
Control0..1
BindingFor example codes, see EntityCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
1050. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.manufacturerModelName
Comments

The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] manufacturerModelName (CONF:4537-16784).

Control1..1
BindingFor example codes, see Manufacturer Model Name Example
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SC
1052. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.softwareName
Comments

The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] softwareName (CONF:4537-16785).

Control1..1
BindingFor example codes, see Software Name Example
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SC
1054. ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.asMaintainedEntity
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/MaintainedEntity
1056. ClinicalDocument.author.assignedAuthor.representedOrganization
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
1058. ClinicalDocument.dataEnterer
ShortThe dataEnterer element represents the person who transferred the content, written or dictated, into the clinical document. To clarify, an author provides the content found within the header or body of a document, subject to their own interpretation; a dataEnterer adds an author's information to the electronic system.
Comments

MAY contain zero or one [0..1] dataEnterer (CONF:4537-5441).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/DataEnterer
1060. ClinicalDocument.dataEnterer.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
1062. ClinicalDocument.dataEnterer.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
1064. ClinicalDocument.dataEnterer.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
1066. ClinicalDocument.dataEnterer.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
1068. ClinicalDocument.dataEnterer.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
1070. ClinicalDocument.dataEnterer.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
1072. ClinicalDocument.dataEnterer.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
1074. ClinicalDocument.dataEnterer.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
1076. ClinicalDocument.dataEnterer.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
1078. ClinicalDocument.dataEnterer.typeCode
Control0..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 ValueENT
1080. ClinicalDocument.dataEnterer.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
1082. ClinicalDocument.dataEnterer.time
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

ShortBase for all types and resources
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time)
Is Modifierfalse
Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
1084. ClinicalDocument.dataEnterer.assignedEntity
Comments

The dataEnterer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5442).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
1086. ClinicalDocument.dataEnterer.assignedEntity.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
1088. ClinicalDocument.dataEnterer.assignedEntity.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
1090. ClinicalDocument.dataEnterer.assignedEntity.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
1092. ClinicalDocument.dataEnterer.assignedEntity.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
1094. ClinicalDocument.dataEnterer.assignedEntity.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
1096. ClinicalDocument.dataEnterer.assignedEntity.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
1098. ClinicalDocument.dataEnterer.assignedEntity.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
1100. ClinicalDocument.dataEnterer.assignedEntity.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
1102. ClinicalDocument.dataEnterer.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/cda/stds/core/StructureDefinition/II
1104. ClinicalDocument.dataEnterer.assignedEntity.classCode
Control0..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
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 ValueASSIGNED
1106. ClinicalDocument.dataEnterer.assignedEntity.id
Comments

This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5443).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
1108. ClinicalDocument.dataEnterer.assignedEntity.id.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
1110. ClinicalDocument.dataEnterer.assignedEntity.id.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
1112. ClinicalDocument.dataEnterer.assignedEntity.id.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
1114. ClinicalDocument.dataEnterer.assignedEntity.id.root
Definition

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

Comments

Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16821).

Control0..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
Invariantsshould-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6')
1116. ClinicalDocument.dataEnterer.assignedEntity.id.extension
Definition

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

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.
LabelExtension
1118. ClinicalDocument.dataEnterer.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
1120. ClinicalDocument.dataEnterer.assignedEntity.code
Comments

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:4537-32173).

Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
1122. ClinicalDocument.dataEnterer.assignedEntity.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

ShortBase for all types and resources
Comments

This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5460).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
Is Modifierfalse
Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
1124. ClinicalDocument.dataEnterer.assignedEntity.telecom
Comments

This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5466).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
Invariantsshould-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
1126. ClinicalDocument.dataEnterer.assignedEntity.telecom.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
1128. ClinicalDocument.dataEnterer.assignedEntity.telecom.value
Control0..1
Typeurl(url: Universal Resource Locator)
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.
1130. ClinicalDocument.dataEnterer.assignedEntity.telecom.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/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelUseable Period
1132. ClinicalDocument.dataEnterer.assignedEntity.telecom.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.

Comments

Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7996).

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
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.
LabelUse Code
1134. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson
Comments

This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5469).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
1136. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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
1138. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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
1140. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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
1142. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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
1144. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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
1146. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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
1148. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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
1150. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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
1152. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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
1154. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
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 ValuePSN
1156. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
1158. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.name
Definition

A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).

ShortBase for all types and resources
Comments

This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5470).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifierfalse
Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists())
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty())
1160. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcDesc
Definition

The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
1162. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Definition

Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameasPatientRelationship.
1164. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1166. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1168. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1170. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1172. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1174. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1176. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1178. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1180. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1182. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode
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.
Fixed ValuePRS
1184. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode
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.
Fixed ValueINSTANCE
1186. ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
1188. ClinicalDocument.dataEnterer.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
1190. ClinicalDocument.dataEnterer.assignedEntity.sdtcPatient
Control0..1
Typehttp://hl7.org/fhir/StructureDefinition/Base
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namepatient.
1192. ClinicalDocument.dataEnterer.assignedEntity.sdtcPatient.id
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
1194. ClinicalDocument.informant
Comments

MAY contain zero or more [0..*] informant (CONF:4537-31355) such that it

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
SlicingThis element introduces a set of slices on ClinicalDocument.informant. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • exists @ relatedEntity
  • exists @ assignedEntity
1196. ClinicalDocument.informant:provider
Slice Nameprovider
ShortThe informant element describes an information source for any content within the clinical document. This informant is constrained for use when the source of information is an assigned health care provider for the patient.
Comments

MAY contain zero or more [0..*] informant (CONF:4537-8001) such that it

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
1198. ClinicalDocument.informant:provider.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
1200. ClinicalDocument.informant:provider.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
1202. ClinicalDocument.informant:provider.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
1204. ClinicalDocument.informant:provider.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
1206. ClinicalDocument.informant:provider.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
1208. ClinicalDocument.informant:provider.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
1210. ClinicalDocument.informant:provider.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
1212. ClinicalDocument.informant:provider.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
1214. ClinicalDocument.informant:provider.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
1216. ClinicalDocument.informant:provider.typeCode
Control0..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 ValueINF
1218. ClinicalDocument.informant:provider.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
1220. ClinicalDocument.informant:provider.assignedEntity
Comments

SHALL contain exactly one [1..1] assignedEntity (CONF:4537-8002).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
1222. ClinicalDocument.informant:provider.assignedEntity.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
1224. ClinicalDocument.informant:provider.assignedEntity.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
1226. ClinicalDocument.informant:provider.assignedEntity.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
1228. ClinicalDocument.informant:provider.assignedEntity.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
1230. ClinicalDocument.informant:provider.assignedEntity.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
1232. ClinicalDocument.informant:provider.assignedEntity.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
1234. ClinicalDocument.informant:provider.assignedEntity.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
1236. ClinicalDocument.informant:provider.assignedEntity.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
1238. ClinicalDocument.informant:provider.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/cda/stds/core/StructureDefinition/II
1240. ClinicalDocument.informant:provider.assignedEntity.classCode
Control0..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
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 ValueASSIGNED
1242. ClinicalDocument.informant:provider.assignedEntity.id
ShortIf assignedEntity/id is a provider then this id, **SHOULD** include zero or one [0..1] id where id/@root ="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-9946).
Comments

This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-9945).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
1244. ClinicalDocument.informant:provider.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
1246. ClinicalDocument.informant:provider.assignedEntity.code
Comments

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:4537-32174).

Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
1248. ClinicalDocument.informant:provider.assignedEntity.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

ShortBase for all types and resources
Comments

This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-8220).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
Is Modifierfalse
Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
1250. ClinicalDocument.informant:provider.assignedEntity.telecom
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
1252. ClinicalDocument.informant:provider.assignedEntity.assignedPerson
Comments

This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-8221).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
1254. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.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
1256. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.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
1258. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.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
1260. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.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
1262. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.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
1264. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.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
1266. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.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
1268. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.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
1270. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.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
1272. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
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 ValuePSN
1274. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
1276. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.name
Definition

A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).

ShortBase for all types and resources
Comments

This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-8222).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifierfalse
Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists())
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty())
1278. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcDesc
Definition

The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
1280. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Definition

Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameasPatientRelationship.
1282. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1284. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1286. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1288. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1290. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1292. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1294. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1296. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1298. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1300. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode
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.
Fixed ValuePRS
1302. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode
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.
Fixed ValueINSTANCE
1304. ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
1306. ClinicalDocument.informant:provider.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
1308. ClinicalDocument.informant:provider.assignedEntity.sdtcPatient
Control0..1
Typehttp://hl7.org/fhir/StructureDefinition/Base
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namepatient.
1310. ClinicalDocument.informant:provider.assignedEntity.sdtcPatient.id
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
1312. ClinicalDocument.informant:provider.relatedEntity
Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
1314. ClinicalDocument.informant:non-provider
Slice Namenon-provider
ShortThe informant element describes an information source (who is not a provider) for any content within the clinical document. This informant would be used when the source of information has a personal relationship with the patient or is the patient.
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
1316. ClinicalDocument.informant:non-provider.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
1318. ClinicalDocument.informant:non-provider.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
1320. ClinicalDocument.informant:non-provider.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
1322. ClinicalDocument.informant:non-provider.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
1324. ClinicalDocument.informant:non-provider.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
1326. ClinicalDocument.informant:non-provider.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
1328. ClinicalDocument.informant:non-provider.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
1330. ClinicalDocument.informant:non-provider.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
1332. ClinicalDocument.informant:non-provider.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
1334. ClinicalDocument.informant:non-provider.typeCode
Control0..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 ValueINF
1336. ClinicalDocument.informant:non-provider.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
1338. ClinicalDocument.informant:non-provider.assignedEntity
Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
1340. ClinicalDocument.informant:non-provider.relatedEntity
Comments

SHALL contain exactly one [1..1] relatedEntity (CONF:4537-31356).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity
1342. ClinicalDocument.custodian
ShortThe custodian element represents the organization that is in charge of maintaining and is entrusted with the care of the document.&#10;&#10;There is only one custodian per CDA document. Allowing that a CDA document may not represent the original form of the authenticated document, the custodian represents the steward of the original source document. The custodian may be the document originator, a health information exchange, or other responsible party.
Comments

SHALL contain exactly one [1..1] custodian (CONF:4537-5519).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Custodian
1344. ClinicalDocument.custodian.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
1346. ClinicalDocument.custodian.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
1348. ClinicalDocument.custodian.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
1350. ClinicalDocument.custodian.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
1352. ClinicalDocument.custodian.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
1354. ClinicalDocument.custodian.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
1356. ClinicalDocument.custodian.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
1358. ClinicalDocument.custodian.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
1360. ClinicalDocument.custodian.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
1362. ClinicalDocument.custodian.typeCode
Control0..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 ValueCST
1364. ClinicalDocument.custodian.assignedCustodian
Comments

This custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:4537-5520).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedCustodian
1366. ClinicalDocument.custodian.assignedCustodian.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
1368. ClinicalDocument.custodian.assignedCustodian.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
1370. ClinicalDocument.custodian.assignedCustodian.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
1372. ClinicalDocument.custodian.assignedCustodian.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
1374. ClinicalDocument.custodian.assignedCustodian.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
1376. ClinicalDocument.custodian.assignedCustodian.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
1378. ClinicalDocument.custodian.assignedCustodian.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
1380. ClinicalDocument.custodian.assignedCustodian.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
1382. ClinicalDocument.custodian.assignedCustodian.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
1384. ClinicalDocument.custodian.assignedCustodian.classCode
Control0..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
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 ValueASSIGNED
1386. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization
Comments

This assignedCustodian SHALL contain exactly one [1..1] representedCustodianOrganization (CONF:4537-5521).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CustodianOrganization
1388. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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
1390. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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
1392. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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
1394. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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
1396. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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
1398. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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
1400. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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
1402. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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
1404. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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
1406. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassOrganization
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 ValueORG
1408. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
1410. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id
Comments

This representedCustodianOrganization SHALL contain at least one [1..*] id (CONF:4537-5522).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
1412. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.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
1414. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.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
1416. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.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
1418. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.root
Definition

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

Comments

Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16822).

Control0..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
Invariantsshould-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6')
1420. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.extension
Definition

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

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.
LabelExtension
1422. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.name
Comments

This representedCustodianOrganization SHALL contain exactly one [1..1] name (CONF:4537-5524).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ON
1424. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom
Comments

This representedCustodianOrganization SHALL contain exactly one [1..1] telecom (CONF:4537-5525).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
Invariantsshould-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
1426. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.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
1428. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.value
Control0..1
Typeurl(url: Universal Resource Locator)
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.
1430. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.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/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelUseable Period
1432. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.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.

Comments

This telecom SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7998).

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
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.
LabelUse Code
1434. ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

ShortBase for all types and resources
Comments

This representedCustodianOrganization SHALL contain exactly one [1..1] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5559).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
Is Modifierfalse
Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
1436. ClinicalDocument.informationRecipient
ShortThe informationRecipient element records the intended recipient of the information at the time the document was created. In cases where the intended recipient of the document is the patient's health chart, set the receivedOrganization to the scoping organization for that chart.
Comments

MAY contain zero or more [0..*] informationRecipient (CONF:4537-5565).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient
1438. ClinicalDocument.informationRecipient.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
1440. ClinicalDocument.informationRecipient.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
1442. ClinicalDocument.informationRecipient.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
1444. ClinicalDocument.informationRecipient.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
1446. ClinicalDocument.informationRecipient.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
1448. ClinicalDocument.informationRecipient.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
1450. ClinicalDocument.informationRecipient.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
1452. ClinicalDocument.informationRecipient.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
1454. ClinicalDocument.informationRecipient.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
1456. ClinicalDocument.informationRecipient.typeCode
Control0..1
BindingThe codes SHALL be taken from XInformationRecipient (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.
Default ValuePRCP
1458. ClinicalDocument.informationRecipient.intendedRecipient
Comments

The informationRecipient, if present, SHALL contain exactly one [1..1] intendedRecipient (CONF:4537-5566).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IntendedRecipient
1460. ClinicalDocument.informationRecipient.intendedRecipient.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
1462. ClinicalDocument.informationRecipient.intendedRecipient.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
1464. ClinicalDocument.informationRecipient.intendedRecipient.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
1466. ClinicalDocument.informationRecipient.intendedRecipient.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
1468. ClinicalDocument.informationRecipient.intendedRecipient.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
1470. ClinicalDocument.informationRecipient.intendedRecipient.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
1472. ClinicalDocument.informationRecipient.intendedRecipient.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
1474. ClinicalDocument.informationRecipient.intendedRecipient.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
1476. ClinicalDocument.informationRecipient.intendedRecipient.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
1478. ClinicalDocument.informationRecipient.intendedRecipient.classCode
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.
Default ValueASSIGNED
1480. ClinicalDocument.informationRecipient.intendedRecipient.id
Comments

This intendedRecipient MAY contain zero or more [0..*] id (CONF:4537-32399).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
1482. ClinicalDocument.informationRecipient.intendedRecipient.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
1484. ClinicalDocument.informationRecipient.intendedRecipient.addr
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
1486. ClinicalDocument.informationRecipient.intendedRecipient.telecom
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
1488. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient
Comments

This intendedRecipient MAY contain zero or one [0..1] informationRecipient (CONF:4537-5567).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
1490. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.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
1492. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.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
1494. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.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
1496. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.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
1498. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.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
1500. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.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
1502. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.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
1504. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.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
1506. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.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
1508. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
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 ValuePSN
1510. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
1512. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name
Definition

A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).

ShortBase for all types and resources
Comments

The informationRecipient, if present, SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5568).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifierfalse
Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists())
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty())
1514. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcDesc
Definition

The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
1516. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship
Definition

Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameasPatientRelationship.
1518. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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
1520. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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
1522. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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
1524. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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
1526. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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
1528. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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
1530. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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
1532. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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
1534. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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
1536. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.classCode
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.
Fixed ValuePRS
1538. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.determinerCode
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.
Fixed ValueINSTANCE
1540. ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.code
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
1542. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization
Comments

This intendedRecipient MAY contain zero or one [0..1] receivedOrganization (CONF:4537-5577).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
1544. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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
1546. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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
1548. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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
1550. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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
1552. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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
1554. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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
1556. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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
1558. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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
1560. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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
1562. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassOrganization
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 ValueORG
1564. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
1566. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.id
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
1568. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.name
Comments

The receivedOrganization, if present, SHALL contain exactly one [1..1] name (CONF:4537-5578).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ON
1570. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.telecom
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
1572. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.addr
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
1574. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.standardIndustryClassCode
Control0..1
BindingFor example codes, see OrganizationIndustryClassNAICS
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
1576. ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.asOrganizationPartOf
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf
1578. ClinicalDocument.legalAuthenticator
ShortThe legalAuthenticator identifies the single person legally responsible for the document and must be present if the document has been legally authenticated. A clinical document that does not contain this element has not been legally authenticated. The act of legal authentication requires a certain privilege be granted to the legal authenticator depending upon local policy. Based on local practice, clinical documents may be released before legal authentication. All clinical documents have the potential for legal authentication, given the appropriate credentials. Local policies MAY choose to delegate the function of legal authentication to a device or system that generates the clinical document. In these cases, the legal authenticator is a person accepting responsibility for the document, not the generating device or system. Note that the legal authenticator, if present, must be a person.
Comments

SHOULD contain zero or one [0..1] legalAuthenticator (CONF:4537-5579).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator
1580. ClinicalDocument.legalAuthenticator.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
1582. ClinicalDocument.legalAuthenticator.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
1584. ClinicalDocument.legalAuthenticator.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
1586. ClinicalDocument.legalAuthenticator.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
1588. ClinicalDocument.legalAuthenticator.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
1590. ClinicalDocument.legalAuthenticator.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
1592. ClinicalDocument.legalAuthenticator.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
1594. ClinicalDocument.legalAuthenticator.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
1596. ClinicalDocument.legalAuthenticator.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
1598. ClinicalDocument.legalAuthenticator.typeCode
Control0..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 ValueLA
1600. ClinicalDocument.legalAuthenticator.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
1602. ClinicalDocument.legalAuthenticator.time
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

ShortBase for all types and resources
Comments

The legalAuthenticator, if present, SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5580).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time)
Is Modifierfalse
Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
1604. ClinicalDocument.legalAuthenticator.signatureCode
Comments

The legalAuthenticator, if present, SHALL contain exactly one [1..1] signatureCode (CONF:4537-5583).

Control1..1
BindingThe codes SHALL be taken from CDASignatureCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
Invariantssignature: CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'. (code.exists() implies code != 'X')
1606. ClinicalDocument.legalAuthenticator.signatureCode.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
1608. ClinicalDocument.legalAuthenticator.signatureCode.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 signatureCode SHALL contain exactly one [1..1] @code="S" (CodeSystem: HL7ParticipationSignature urn:oid:2.16.840.1.113883.5.89 STATIC) (CONF:4537-5584).

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
Pattern ValueS
1610. ClinicalDocument.legalAuthenticator.signatureCode.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
1612. ClinicalDocument.legalAuthenticator.signatureCode.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
1614. ClinicalDocument.legalAuthenticator.signatureCode.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
1616. ClinicalDocument.legalAuthenticator.signatureCode.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
1618. ClinicalDocument.legalAuthenticator.signatureCode.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.
1620. ClinicalDocument.legalAuthenticator.signatureCode.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.
1622. ClinicalDocument.legalAuthenticator.signatureCode.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
1624. ClinicalDocument.legalAuthenticator.signatureCode.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
1626. ClinicalDocument.legalAuthenticator.signatureCode.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
1628. ClinicalDocument.legalAuthenticator.sdtcSignatureText
Definition

A textual or multimedia depiction of the signature by which the participant endorses his or her participation in the Act as specified in the Participation.typeCode and that he or she agrees to assume the associated accountability.

ShortThe signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are: 1) Electronic signature: this attribute can represent virtually any electronic signature scheme. 2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc. The sdtc:signatureText extension provides a location in CDA for a textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. Details of what goes in the field are described in the HL7 CDA Digital Signature Standard balloted in Fall 2013.
Comments

The legalAuthenticator, if present, MAY contain zero or one [0..1] sdtc:signatureText (CONF:4537-30810).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namesignatureText.
1630. ClinicalDocument.legalAuthenticator.assignedEntity
Comments

The legalAuthenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5585).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
1632. ClinicalDocument.legalAuthenticator.assignedEntity.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
1634. ClinicalDocument.legalAuthenticator.assignedEntity.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
1636. ClinicalDocument.legalAuthenticator.assignedEntity.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
1638. ClinicalDocument.legalAuthenticator.assignedEntity.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
1640. ClinicalDocument.legalAuthenticator.assignedEntity.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
1642. ClinicalDocument.legalAuthenticator.assignedEntity.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
1644. ClinicalDocument.legalAuthenticator.assignedEntity.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
1646. ClinicalDocument.legalAuthenticator.assignedEntity.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
1648. ClinicalDocument.legalAuthenticator.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/cda/stds/core/StructureDefinition/II
1650. ClinicalDocument.legalAuthenticator.assignedEntity.classCode
Control0..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
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 ValueASSIGNED
1652. ClinicalDocument.legalAuthenticator.assignedEntity.id
Comments

This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5586).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
1654. ClinicalDocument.legalAuthenticator.assignedEntity.id.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
1656. ClinicalDocument.legalAuthenticator.assignedEntity.id.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
1658. ClinicalDocument.legalAuthenticator.assignedEntity.id.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
1660. ClinicalDocument.legalAuthenticator.assignedEntity.id.root
Definition

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

ShortMAY contain '2.16.840.1.113883.4.6' (NPI)
Comments

Such ids MAY contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16823).

Control0..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
1662. ClinicalDocument.legalAuthenticator.assignedEntity.id.extension
Definition

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

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.
LabelExtension
1664. ClinicalDocument.legalAuthenticator.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
1666. ClinicalDocument.legalAuthenticator.assignedEntity.code
Comments

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:4537-17000).

Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
1668. ClinicalDocument.legalAuthenticator.assignedEntity.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

ShortBase for all types and resources
Comments

This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5589).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
Is Modifierfalse
Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
1670. ClinicalDocument.legalAuthenticator.assignedEntity.telecom
Comments

This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5595).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
Invariantsshould-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
1672. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.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
1674. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.value
Control0..1
Typeurl(url: Universal Resource Locator)
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.
1676. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.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/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelUseable Period
1678. ClinicalDocument.legalAuthenticator.assignedEntity.telecom.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.

Comments

Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7999).

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
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.
LabelUse Code
1680. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson
Comments

This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5597).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
1682. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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
1684. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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
1686. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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
1688. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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
1690. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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
1692. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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
1694. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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
1696. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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
1698. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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
1700. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
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 ValuePSN
1702. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
1704. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name
Definition

A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).

ShortBase for all types and resources
Comments

This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5598).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifierfalse
Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists())
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty())
1706. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcDesc
Definition

The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
1708. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Definition

Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameasPatientRelationship.
1710. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1712. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1714. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1716. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1718. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1720. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1722. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1724. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1726. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1728. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode
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.
Fixed ValuePRS
1730. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode
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.
Fixed ValueINSTANCE
1732. ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
1734. ClinicalDocument.legalAuthenticator.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
1736. ClinicalDocument.legalAuthenticator.assignedEntity.sdtcPatient
Control0..1
Typehttp://hl7.org/fhir/StructureDefinition/Base
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namepatient.
1738. ClinicalDocument.legalAuthenticator.assignedEntity.sdtcPatient.id
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
1740. ClinicalDocument.authenticator
ShortThe authenticator identifies a participant or participants who attest to the accuracy of the information in the document.
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Authenticator
1742. ClinicalDocument.authenticator.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
1744. ClinicalDocument.authenticator.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
1746. ClinicalDocument.authenticator.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
1748. ClinicalDocument.authenticator.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
1750. ClinicalDocument.authenticator.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
1752. ClinicalDocument.authenticator.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
1754. ClinicalDocument.authenticator.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
1756. ClinicalDocument.authenticator.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
1758. ClinicalDocument.authenticator.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
1760. ClinicalDocument.authenticator.typeCode
Control0..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 ValueAUTHEN
1762. ClinicalDocument.authenticator.time
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5608).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS(US Realm Date and Time - Point in Time)
Is Modifierfalse
Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
1764. ClinicalDocument.authenticator.signatureCode
Comments

SHALL contain exactly one [1..1] signatureCode (CONF:4537-5610).

Control1..1
BindingThe codes SHALL be taken from CDASignatureCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
Invariantssignature: CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'. (code.exists() implies code != 'X')
1766. ClinicalDocument.authenticator.signatureCode.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
1768. ClinicalDocument.authenticator.signatureCode.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 signatureCode SHALL contain exactly one [1..1] @code="S" (CodeSystem: HL7ParticipationSignature urn:oid:2.16.840.1.113883.5.89 STATIC) (CONF:4537-5611).

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
Pattern ValueS
1770. ClinicalDocument.authenticator.signatureCode.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
1772. ClinicalDocument.authenticator.signatureCode.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
1774. ClinicalDocument.authenticator.signatureCode.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
1776. ClinicalDocument.authenticator.signatureCode.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
1778. ClinicalDocument.authenticator.signatureCode.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.
1780. ClinicalDocument.authenticator.signatureCode.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.
1782. ClinicalDocument.authenticator.signatureCode.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
1784. ClinicalDocument.authenticator.signatureCode.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
1786. ClinicalDocument.authenticator.signatureCode.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
1788. ClinicalDocument.authenticator.sdtcSignatureText
Definition

A textual or multimedia depiction of the signature by which the participant endorses his or her participation in the Act as specified in the Participation.typeCode and that he or she agrees to assume the associated accountability.

ShortThe signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are: 1) Electronic signature: this attribute can represent virtually any electronic signature scheme. 2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc. The sdtc:signatureText extension provides a location in CDA for a textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. Details of what goes in the field are described in the HL7 CDA Digital Signature Standard balloted in Fall of 2013.
Comments

MAY contain zero or one [0..1] sdtc:signatureText (CONF:4537-30811).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namesignatureText.
1790. ClinicalDocument.authenticator.assignedEntity
Comments

SHALL contain exactly one [1..1] assignedEntity (CONF:4537-5612).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
1792. ClinicalDocument.authenticator.assignedEntity.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
1794. ClinicalDocument.authenticator.assignedEntity.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
1796. ClinicalDocument.authenticator.assignedEntity.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
1798. ClinicalDocument.authenticator.assignedEntity.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
1800. ClinicalDocument.authenticator.assignedEntity.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
1802. ClinicalDocument.authenticator.assignedEntity.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
1804. ClinicalDocument.authenticator.assignedEntity.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
1806. ClinicalDocument.authenticator.assignedEntity.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
1808. ClinicalDocument.authenticator.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/cda/stds/core/StructureDefinition/II
1810. ClinicalDocument.authenticator.assignedEntity.classCode
Control0..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
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 ValueASSIGNED
1812. ClinicalDocument.authenticator.assignedEntity.id
Comments

This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5613).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
1814. ClinicalDocument.authenticator.assignedEntity.id.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
1816. ClinicalDocument.authenticator.assignedEntity.id.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
1818. ClinicalDocument.authenticator.assignedEntity.id.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
1820. ClinicalDocument.authenticator.assignedEntity.id.root
Definition

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

Comments

Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-16824).

Control0..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
Invariantsshould-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6')
1822. ClinicalDocument.authenticator.assignedEntity.id.extension
Definition

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

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.
LabelExtension
1824. ClinicalDocument.authenticator.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
1826. ClinicalDocument.authenticator.assignedEntity.code
Comments

This assignedEntity MAY contain zero or one [0..1] code (CONF:4537-16825).

Control0..1
BindingFor example codes, see v3 Code System RoleCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
1828. ClinicalDocument.authenticator.assignedEntity.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 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
1830. ClinicalDocument.authenticator.assignedEntity.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.

Comments

The code, if present, 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:4537-16826).

Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
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
1832. ClinicalDocument.authenticator.assignedEntity.code.codeSystem
Definition

Specifies the code system that defines the code.

Control0..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.
LabelCode System
1834. ClinicalDocument.authenticator.assignedEntity.code.codeSystemName
Definition

The common name of the coding system.

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.
LabelCode System Name
1836. ClinicalDocument.authenticator.assignedEntity.code.codeSystemVersion
Definition

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

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.
LabelCode System Version
1838. ClinicalDocument.authenticator.assignedEntity.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(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
1840. ClinicalDocument.authenticator.assignedEntity.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(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.
1842. ClinicalDocument.authenticator.assignedEntity.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(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.
1844. ClinicalDocument.authenticator.assignedEntity.code.originalText
Definition

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

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
LabelOriginal Text
1846. ClinicalDocument.authenticator.assignedEntity.code.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
1848. ClinicalDocument.authenticator.assignedEntity.code.translation
Definition

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelTranslation
1850. ClinicalDocument.authenticator.assignedEntity.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

ShortBase for all types and resources
Comments

This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5616).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
Is Modifierfalse
Invariantsshall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)
shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). (nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))
should-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
should-country: SHOULD contain country (nullFlavor.exists() or item.country.exists())
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) (item.xmlText.empty())
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). (nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))
shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ((item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1))
1852. ClinicalDocument.authenticator.assignedEntity.telecom
Comments

This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5622).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
Invariantsshould-use: SHOULD contain @use (nullFlavor.exists() or use.exists())
1854. ClinicalDocument.authenticator.assignedEntity.telecom.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
1856. ClinicalDocument.authenticator.assignedEntity.telecom.value
Control0..1
Typeurl(url: Universal Resource Locator)
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.
1858. ClinicalDocument.authenticator.assignedEntity.telecom.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/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelUseable Period
1860. ClinicalDocument.authenticator.assignedEntity.telecom.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.

Comments

Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-8000).

Control0..1
BindingThe codes SHALL be taken from Telecom Use (US Realm Header)
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.
LabelUse Code
1862. ClinicalDocument.authenticator.assignedEntity.assignedPerson
Comments

This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5624).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
1864. ClinicalDocument.authenticator.assignedEntity.assignedPerson.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
1866. ClinicalDocument.authenticator.assignedEntity.assignedPerson.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
1868. ClinicalDocument.authenticator.assignedEntity.assignedPerson.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
1870. ClinicalDocument.authenticator.assignedEntity.assignedPerson.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
1872. ClinicalDocument.authenticator.assignedEntity.assignedPerson.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
1874. ClinicalDocument.authenticator.assignedEntity.assignedPerson.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
1876. ClinicalDocument.authenticator.assignedEntity.assignedPerson.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
1878. ClinicalDocument.authenticator.assignedEntity.assignedPerson.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
1880. ClinicalDocument.authenticator.assignedEntity.assignedPerson.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
1882. ClinicalDocument.authenticator.assignedEntity.assignedPerson.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
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 ValuePSN
1884. ClinicalDocument.authenticator.assignedEntity.assignedPerson.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
1886. ClinicalDocument.authenticator.assignedEntity.assignedPerson.name
Definition

A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).

ShortBase for all types and resources
Comments

This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5625).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifierfalse
Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists())
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty())
1888. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcDesc
Definition

The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
1890. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Definition

Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameasPatientRelationship.
1892. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1894. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1896. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1898. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1900. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1902. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1904. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1906. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1908. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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
1910. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode
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.
Fixed ValuePRS
1912. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode
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.
Fixed ValueINSTANCE
1914. ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
1916. ClinicalDocument.authenticator.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
1918. ClinicalDocument.authenticator.assignedEntity.sdtcPatient
Control0..1
Typehttp://hl7.org/fhir/StructureDefinition/Base
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namepatient.
1920. ClinicalDocument.authenticator.assignedEntity.sdtcPatient.id
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
1922. ClinicalDocument.participant
ShortThe participant element identifies supporting entities, including parents, relatives, caregivers, insurance policyholders, guarantors, and others related in some way to the patient. A supporting person or organization is an individual or an organization with a relationship to the patient. A supporting person who is playing multiple roles would be recorded in multiple participants (e.g., emergency contact and next-of-kin).
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant1
Invariants4537-10006: **SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:4537-10006). (associatedEntity.associatedPerson.exists() or associatedEntity.scopingOrganization.exists())
4537-10007: When participant/@typeCode is *IND*, associatedEntity/@classCode **SHOULD** be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes *DYNAMIC* (CONF:4537-10007). (typeCode = 'IND' implies associatedEntity.classCode.memberOf('http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.33'))
1924. ClinicalDocument.participant.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
1926. ClinicalDocument.participant.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
1928. ClinicalDocument.participant.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
1930. ClinicalDocument.participant.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
1932. ClinicalDocument.participant.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
1934. ClinicalDocument.participant.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
1936. ClinicalDocument.participant.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
1938. ClinicalDocument.participant.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
1940. ClinicalDocument.participant.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
1942. ClinicalDocument.participant.typeCode
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.
1944. ClinicalDocument.participant.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
1946. ClinicalDocument.participant.functionCode
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
1948. ClinicalDocument.participant.time
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

ShortBase for all types and resources
Comments

MAY contain zero or one [0..1] time (CONF:4537-10004).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval)
Is Modifierfalse
Invariantsivl-ts-center: Center cannot co-exist with low or high (center.empty() or (low.empty() and high.empty()))
ivl-value-shall: If a time interval contains @value, then it shall be precise to at least the day. (value.exists() implies value.toString().length() >= 10)
ivl-value-should: If a time interval contains @value, then it SHOULD contain a time component. (value.exists() implies value.toString().length() > 10)
1950. ClinicalDocument.participant.associatedEntity
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssociatedEntity
1952. ClinicalDocument.inFulfillmentOf
ShortThe inFulfillmentOf element represents orders that are fulfilled by this document such as a radiologists' report of an x-ray.
Comments

MAY contain zero or more [0..*] inFulfillmentOf (CONF:4537-9952).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf
1954. ClinicalDocument.inFulfillmentOf.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
1956. ClinicalDocument.inFulfillmentOf.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
1958. ClinicalDocument.inFulfillmentOf.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
1960. ClinicalDocument.inFulfillmentOf.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
1962. ClinicalDocument.inFulfillmentOf.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
1964. ClinicalDocument.inFulfillmentOf.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
1966. ClinicalDocument.inFulfillmentOf.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
1968. ClinicalDocument.inFulfillmentOf.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
1970. ClinicalDocument.inFulfillmentOf.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
1972. ClinicalDocument.inFulfillmentOf.typeCode
Control0..1
BindingThe codes SHALL be taken from ActRelationshipFulfills (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 ValueFLFS
1974. ClinicalDocument.inFulfillmentOf.order
Comments

The inFulfillmentOf, if present, SHALL contain exactly one [1..1] order (CONF:4537-9953).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Order
1976. ClinicalDocument.inFulfillmentOf.order.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
1978. ClinicalDocument.inFulfillmentOf.order.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
1980. ClinicalDocument.inFulfillmentOf.order.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
1982. ClinicalDocument.inFulfillmentOf.order.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
1984. ClinicalDocument.inFulfillmentOf.order.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
1986. ClinicalDocument.inFulfillmentOf.order.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
1988. ClinicalDocument.inFulfillmentOf.order.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
1990. ClinicalDocument.inFulfillmentOf.order.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
1992. ClinicalDocument.inFulfillmentOf.order.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
1994. ClinicalDocument.inFulfillmentOf.order.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
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.
Default ValueACT
1996. ClinicalDocument.inFulfillmentOf.order.moodCode
Control0..1
BindingThe codes SHALL be taken from ActMoodIntent
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 ValueRQO
1998. ClinicalDocument.inFulfillmentOf.order.id
Comments

This order SHALL contain at least one [1..*] id (CONF:4537-9954).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
2000. ClinicalDocument.inFulfillmentOf.order.code
Control0..1
BindingFor example codes, see v3 Code System ActCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
2002. ClinicalDocument.inFulfillmentOf.order.priorityCode
Control0..1
BindingFor example codes, see ActPriority
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
2004. ClinicalDocument.documentationOf
ShortA serviceEvent represents the main act, such as a colonoscopy or an appendectomy, being documented. A serviceEvent can further specialize the act inherent in the ClinicalDocument/code, such as where the ClinicalDocument/code is simply "Surgical Operation Note" and the procedure is "Appendectomy." serviceEvent is required in the Operative Note and it must be equivalent to or further specialize the value inherent in the ClinicalDocument/code; it shall not conflict with the value inherent in the ClinicalDocument/code, as such a conflict would create ambiguity. serviceEvent/effectiveTime can be used to indicate the time the actual event (as opposed to the encounter surrounding the event) took place. If the date and the duration of the procedure is known, serviceEvent/effectiveTime/low is used with a width element that describes the duration; no high element is used. However, if only the date is known, the date is placed in both the low and high elements.
Comments

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

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf
2006. ClinicalDocument.documentationOf.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
2008. ClinicalDocument.documentationOf.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
2010. ClinicalDocument.documentationOf.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
2012. ClinicalDocument.documentationOf.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
2014. ClinicalDocument.documentationOf.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
2016. ClinicalDocument.documentationOf.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
2018. ClinicalDocument.documentationOf.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
2020. ClinicalDocument.documentationOf.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
2022. ClinicalDocument.documentationOf.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
2024. ClinicalDocument.documentationOf.typeCode
Control0..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 ValueDOC
2026. ClinicalDocument.documentationOf.serviceEvent
ShortA serviceEvent represents the main act being documented, such as a colonoscopy or a cardiac stress study. In a provision of healthcare serviceEvent, the care providers, PCP, or other longitudinal providers, are recorded within the serviceEvent. If the document is about a single encounter, the providers associated can be recorded in the componentOf/encompassingEncounter template.
Comments

Such documentationOfs SHALL contain exactly one [1..1] serviceEvent (CONF:1198-8493).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ServiceEvent
Invariantsshould-us-performer: SHOULD contain performer (performer.exists())
2028. ClinicalDocument.documentationOf.serviceEvent.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
2030. ClinicalDocument.documentationOf.serviceEvent.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
2032. ClinicalDocument.documentationOf.serviceEvent.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
2034. ClinicalDocument.documentationOf.serviceEvent.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
2036. ClinicalDocument.documentationOf.serviceEvent.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
2038. ClinicalDocument.documentationOf.serviceEvent.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
2040. ClinicalDocument.documentationOf.serviceEvent.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
2042. ClinicalDocument.documentationOf.serviceEvent.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
2044. ClinicalDocument.documentationOf.serviceEvent.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
2046. ClinicalDocument.documentationOf.serviceEvent.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
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.
Default ValueACT
2048. ClinicalDocument.documentationOf.serviceEvent.moodCode
Control0..1
BindingThe codes SHALL be taken from ActMood
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 ValueEVN
2050. ClinicalDocument.documentationOf.serviceEvent.id
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
2052. ClinicalDocument.documentationOf.serviceEvent.code
Definition

Drawn from concept domain ActCode

Comments

SHALL contain exactly one [1..1] code.

Control1..1
Binding

The value of Clinical Document /documentationOf/serviceEvent/code SHALL be from ICD-9-CM Procedures (codeSystem 2.16.840.1.113883.6.104), ICD-10-PCS (codeSystem 2.16.840.1.113883.6.4), CPT (codeSystem 2.16.840.1.113883.6.12), or values descending from 71388002 (Procedure) from the SNOMED CT (codeSystem 2.16.840.1.113883.6.96) ValueSet 2.16.840.1.113883.3.88.12.80.28 Procedure DYNAMIC (CONF:1198-8487).

Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
Invariants1198-8487: The value of Clinical Document /documentationOf/serviceEvent/code SHALL be from ICD-9-CM Procedures (codeSystem 2.16.840.1.113883.6.104), ICD-10-PCS (codeSystem 2.16.840.1.113883.6.4), CPT (codeSystem 2.16.840.1.113883.6.12), or values descending from 71388002 (Procedure) from the SNOMED CT (codeSystem 2.16.840.1.113883.6.96) ValueSet 2.16.840.1.113883.3.88.12.80.28 Procedure DYNAMIC (CONF:1198-8487). (codeSystem = '2.16.840.1.113883.6.104' or codeSystem = '2.16.840.1.113883.6.4' or codeSystem = '2.16.840.1.113883.6.12' or (codeSystem = '2.16.840.1.113883.6.96' and code.memberOf('http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.80.28')))
2054. ClinicalDocument.documentationOf.serviceEvent.effectiveTime
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

ShortBase for all types and resources
Comments

This serviceEvent SHALL contain exactly one [1..1] US Realm Date and Time (Interval) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:1198-8494).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval)
Is Modifierfalse
Invariantsivl-ts-center: Center cannot co-exist with low or high (center.empty() or (low.empty() and high.empty()))
ivl-value-shall: If a time interval contains @value, then it shall be precise to at least the day. (value.exists() implies value.toString().length() >= 10)
ivl-value-should: If a time interval contains @value, then it SHOULD contain a time component. (value.exists() implies value.toString().length() > 10)
width-or-high: Width and high are mutually exclusive. If width is known, high **SHALL NOT** be present. If with is not present, **SHALL** include high. ((width | high).count() = 1)
2056. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.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
2058. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.value
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

ShortEither @value or low/high should be present, but not both
Control0..1
TypedateTime(ts: Point in Time)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Date FormatYYYYMMDDHHMMSS.UUUU[+|-ZZzz]
XML FormatIn the XML format, this property is represented as an attribute.
2060. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.operator
Definition

A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.

Control0..1
BindingThe codes SHALL be taken from SetOperator
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.
Default ValueI
2062. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low
Definition

This is the low limit of the interval.

ShortLow is required
Comments

The serviceEvent/effectiveTime SHALL be present with effectiveTime/low (CONF:1198-8488).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
LabelLow Boundary
Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
2064. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.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
2066. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.value
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

Control0..1
TypedateTime(ts: Point in Time)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Date FormatYYYYMMDDHHMMSS.UUUU[+|-ZZzz]
XML FormatIn the XML format, this property is represented as an attribute.
2068. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.inclusive
Definition

Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open).

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
2070. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.center
Definition

The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
LabelCentral Value
2072. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.width
Definition

The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived.

ShortRepresents the duration
Comments

When only the date and the length of the procedure are known a width element SHALL be present and the serviceEvent/effectiveTime/high SHALL NOT be present (CONF:1198-10060).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQ
LabelWidth
2074. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high
Definition

This is the high limit of the interval.

ShortEquals low if only the date is known
Comments

If a width is not present, the serviceEvent/effectiveTime SHALL include effectiveTime/high (CONF:1198-10058).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
LabelHigh Boundary
Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
2076. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.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
2078. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.value
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

Control0..1
TypedateTime(ts: Point in Time)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Date FormatYYYYMMDDHHMMSS.UUUU[+|-ZZzz]
XML FormatIn the XML format, this property is represented as an attribute.
2080. ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.inclusive
Definition

Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open).

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
2082. ClinicalDocument.documentationOf.serviceEvent.performer
ShortThe performer participant represents clinicians who actually and principally carry out the serviceEvent. In a transfer of care this represents the healthcare providers involved in the current or pertinent historical care of the patient. Preferably, the patient's key healthcare care team members would be listed, particularly their primary physician and any active consulting physicians, therapists, and counselors.
Comments

This serviceEvent SHOULD contain zero or more [0..*] performer (CONF:4537-14839).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer1
SlicingThis element introduces a set of slices on ClinicalDocument.documentationOf.serviceEvent.performer. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ typeCode
2084. ClinicalDocument.documentationOf.serviceEvent.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
2086. ClinicalDocument.documentationOf.serviceEvent.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
2088. ClinicalDocument.documentationOf.serviceEvent.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
2090. ClinicalDocument.documentationOf.serviceEvent.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
2092. ClinicalDocument.documentationOf.serviceEvent.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
2094. ClinicalDocument.documentationOf.serviceEvent.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
2096. ClinicalDocument.documentationOf.serviceEvent.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
2098. ClinicalDocument.documentationOf.serviceEvent.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
2100. ClinicalDocument.documentationOf.serviceEvent.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
2102. ClinicalDocument.documentationOf.serviceEvent.performer.typeCode
Comments

The performer, if present, SHALL contain exactly one [1..1] @typeCode, which SHALL be selected from ValueSet x_ServiceEventPerformer urn:oid:2.16.840.1.113883.1.11.19601 STATIC (CONF:4537-14840).

Control1..1
BindingThe codes SHALL be taken from x_ServiceEventPerformer
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.
2104. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode
Comments

The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:4537-16818).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
Invariantsshould-us-code: SHOULD contain code (code.exists())
2106. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.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
2108. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.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

The functionCode, if present, SHOULD contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Care Team Member Function urn:oid:2.16.840.1.113762.1.4.1099.30 DYNAMIC (CONF:4537-32889).

Control0..1
BindingThe codes SHOULD be taken from Care Team Member Function
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
2110. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..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.
LabelCode System
2112. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemName
Definition

The common name of the coding system.

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.
LabelCode System Name
2114. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemVersion
Definition

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

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.
LabelCode System Version
2116. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.displayName
Definition

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

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.
LabelDisplay Name
2118. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.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.
2120. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.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.
2122. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.originalText
Definition

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

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
LabelOriginal Text
2124. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.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
2126. ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.translation
Definition

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelTranslation
2128. ClinicalDocument.documentationOf.serviceEvent.performer.time
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

ShortBase for all types and resources
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval)
Is Modifierfalse
Invariantsivl-ts-center: Center cannot co-exist with low or high (center.empty() or (low.empty() and high.empty()))
ivl-value-shall: If a time interval contains @value, then it shall be precise to at least the day. (value.exists() implies value.toString().length() >= 10)
ivl-value-should: If a time interval contains @value, then it SHOULD contain a time component. (value.exists() implies value.toString().length() > 10)
2130. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity
Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Invariantsshould-us-code: SHOULD contain code (code.exists())
2132. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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
2134. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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
2136. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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
2138. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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
2140. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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
2142. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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
2144. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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
2146. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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
2148. ClinicalDocument.documentationOf.serviceEvent.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/cda/stds/core/StructureDefinition/II
2150. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.classCode
Control0..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
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 ValueASSIGNED
2152. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id
Comments

This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-14846).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
2154. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.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
2156. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.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
2158. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.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
2160. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.root
Definition

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

Comments

Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-14847).

Control0..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
Invariantsshould-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6')
2162. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.extension
Definition

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

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.
LabelExtension
2164. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
2166. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code
Comments

This assignedEntity SHOULD 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:4537-14842).

Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
2168. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.addr
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
2170. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.telecom
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
2172. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
2174. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
2176. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcPatient
Control0..1
Typehttp://hl7.org/fhir/StructureDefinition/Base
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namepatient.
2178. ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcPatient.id
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
2180. ClinicalDocument.documentationOf.serviceEvent.performer:performer1
Slice Nameperformer1
ShortThis performer represents clinicians who actually and principally carry out the serviceEvent. Typically, these are clinicians who have surgical privileges in their institutions such as Surgeons, Obstetrician/Gynecologists, and Family Practice Physicians. The performer may also be non-physician providers (NPPs) who have surgical privileges. There may be more than one primary performer in the case of complicated surgeries. There are occasionally co-surgeons. Usually they will be billing separately and will each dictate their own notes. An example may be spinal surgery , where a general surgeon and an orthopedic surgeon both are present and billing off the same Current Procedural Terminology (CPT) codes. Typically two Operative Notes are generated; however, each will list the other as a co-surgeon. Any assistants are identified as a secondary performer (SPRF) in a second performer participant.
Comments

This serviceEvent SHALL contain one or more [1..*] performer (CONF:1198-8489) such that it

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer1
2182. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.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
2184. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.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
2186. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.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
2188. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.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
2190. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.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
2192. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.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
2194. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.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
2196. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.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
2198. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.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
2200. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="PPRF" Primary performer (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1198-8495).

Control1..1
BindingThe codes SHALL be taken from x_ServiceEventPerformer
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 ValuePPRF
2202. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode
Comments

MAY contain zero or one [0..1] functionCode, which SHOULD be selected from ValueSet Care Team Member Function urn:oid:2.16.840.1.113762.1.4.1099.30 DYNAMIC (CONF:1198-32963).

Control0..1
BindingThe codes SHOULD be taken from Care Team Member Function
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
Invariantsshould-us-code: SHOULD contain code (code.exists())
2204. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode.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
2206. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode.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

The functionCode, if present, SHOULD contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Care Team Member Function urn:oid:2.16.840.1.113762.1.4.1099.30 DYNAMIC (CONF:4537-32889).

Control0..1
BindingThe codes SHOULD be taken from Care Team Member Function
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
2208. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..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.
LabelCode System
2210. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode.codeSystemName
Definition

The common name of the coding system.

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.
LabelCode System Name
2212. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode.codeSystemVersion
Definition

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

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.
LabelCode System Version
2214. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode.displayName
Definition

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

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.
LabelDisplay Name
2216. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode.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.
2218. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode.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.
2220. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode.originalText
Definition

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

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
LabelOriginal Text
2222. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode.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
2224. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.functionCode.translation
Definition

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelTranslation
2226. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.time
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

ShortBase for all types and resources
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval)
Is Modifierfalse
Invariantsivl-ts-center: Center cannot co-exist with low or high (center.empty() or (low.empty() and high.empty()))
ivl-value-shall: If a time interval contains @value, then it shall be precise to at least the day. (value.exists() implies value.toString().length() >= 10)
ivl-value-should: If a time interval contains @value, then it SHOULD contain a time component. (value.exists() implies value.toString().length() > 10)
2228. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity
Comments

SHALL contain exactly one [1..1] assignedEntity (CONF:1198-10917).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Invariantsshould-us-code: SHOULD contain code (code.exists())
should-code: SHOULD contain code (code.exists())
2230. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.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
2232. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.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
2234. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.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
2236. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.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
2238. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.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
2240. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.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
2242. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.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
2244. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.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
2246. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.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/cda/stds/core/StructureDefinition/II
2248. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.classCode
Control0..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
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 ValueASSIGNED
2250. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.id
Comments

This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-14846).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
2252. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.id.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
2254. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.id.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
2256. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.id.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
2258. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.id.root
Definition

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

Comments

Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-14847).

Control0..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
Invariantsshould-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6')
2260. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.id.extension
Definition

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

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.
LabelExtension
2262. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
2264. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.code
Comments

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

Control0..1
BindingThe codes SHALL be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
2266. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.addr
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
2268. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.telecom
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
2270. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.assignedPerson
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
2272. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
2274. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.sdtcPatient
Control0..1
Typehttp://hl7.org/fhir/StructureDefinition/Base
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namepatient.
2276. ClinicalDocument.documentationOf.serviceEvent.performer:performer1.assignedEntity.sdtcPatient.id
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
2278. ClinicalDocument.documentationOf.serviceEvent.performer:performer2
Slice Nameperformer2
ShortThis performer represents any assistants
Comments

This serviceEvent MAY contain zero or more [0..*] performer (CONF:1198-32736) such that it

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer1
2280. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.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
2282. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.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
2284. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.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
2286. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.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
2288. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.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
2290. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.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
2292. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.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
2294. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.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
2296. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.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
2298. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="SPRF" Secondary performer (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90) (CONF:1198-32738).

Control1..1
BindingThe codes SHALL be taken from x_ServiceEventPerformer
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 ValueSPRF
2300. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.functionCode
Comments

MAY contain zero or one [0..1] functionCode, which SHOULD be selected from ValueSet Care Team Member Function urn:oid:2.16.840.1.113762.1.4.1099.30 DYNAMIC (CONF:1198-32964).

Control0..1
BindingThe codes SHOULD be taken from Care Team Member Function
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
Invariantsshould-us-code: SHOULD contain code (code.exists())
2302. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.functionCode.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
2304. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.functionCode.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

The functionCode, if present, SHOULD contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Care Team Member Function urn:oid:2.16.840.1.113762.1.4.1099.30 DYNAMIC (CONF:4537-32889).

Control0..1
BindingThe codes SHOULD be taken from Care Team Member Function
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
2306. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.functionCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..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.
LabelCode System
2308. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.functionCode.codeSystemName
Definition

The common name of the coding system.

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.
LabelCode System Name
2310. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.functionCode.codeSystemVersion
Definition

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

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.
LabelCode System Version
2312. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.functionCode.displayName
Definition

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

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.
LabelDisplay Name
2314. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.functionCode.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.
2316. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.functionCode.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.
2318. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.functionCode.originalText
Definition

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

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
LabelOriginal Text
2320. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.functionCode.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
2322. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.functionCode.translation
Definition

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelTranslation
2324. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.time
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

ShortBase for all types and resources
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval)
Is Modifierfalse
Invariantsivl-ts-center: Center cannot co-exist with low or high (center.empty() or (low.empty() and high.empty()))
ivl-value-shall: If a time interval contains @value, then it shall be precise to at least the day. (value.exists() implies value.toString().length() >= 10)
ivl-value-should: If a time interval contains @value, then it SHOULD contain a time component. (value.exists() implies value.toString().length() > 10)
2326. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity
Comments

SHALL contain exactly one [1..1] assignedEntity (CONF:1198-32737).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Invariantsshould-us-code: SHOULD contain code (code.exists())
should-code: SHOULD contain code (code.exists())
2328. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.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
2330. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.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
2332. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.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
2334. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.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
2336. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.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
2338. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.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
2340. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.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
2342. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.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
2344. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.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/cda/stds/core/StructureDefinition/II
2346. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.classCode
Control0..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
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 ValueASSIGNED
2348. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.id
Comments

This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-14846).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
2350. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.id.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
2352. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.id.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
2354. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.id.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
2356. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.id.root
Definition

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

Comments

Such ids SHOULD contain zero or one [0..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4537-14847).

Control0..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
Invariantsshould-npi: SHOULD be NPI ($this = '2.16.840.1.113883.4.6')
2358. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.id.extension
Definition

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

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.
LabelExtension
2360. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
2362. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.code
Comments

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

Control0..1
BindingThe codes SHALL be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
2364. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.addr
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
2366. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.telecom
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
2368. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.assignedPerson
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
2370. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
2372. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.sdtcPatient
Control0..1
Typehttp://hl7.org/fhir/StructureDefinition/Base
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namepatient.
2374. ClinicalDocument.documentationOf.serviceEvent.performer:performer2.assignedEntity.sdtcPatient.id
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.
2376. ClinicalDocument.relatedDocument
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument
2378. ClinicalDocument.authorization
ShortAuthorization represents consent. Consent, if present, shall be represented by authorization/consent.
Comments

MAY contain zero or one [0..1] authorization (CONF:1198-32404).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Authorization
2380. ClinicalDocument.authorization.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
2382. ClinicalDocument.authorization.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
2384. ClinicalDocument.authorization.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
2386. ClinicalDocument.authorization.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
2388. ClinicalDocument.authorization.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
2390. ClinicalDocument.authorization.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
2392. ClinicalDocument.authorization.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
2394. ClinicalDocument.authorization.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
2396. ClinicalDocument.authorization.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
2398. ClinicalDocument.authorization.typeCode
Comments

The authorization, if present, SHALL contain exactly one [1..1] @typeCode="AUTH" authorized by (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1198-32408).

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 ValueAUTH
2400. ClinicalDocument.authorization.consent
Comments

The authorization, if present, SHALL contain exactly one [1..1] consent (CONF:1198-32405).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Consent
2402. ClinicalDocument.authorization.consent.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
2404. ClinicalDocument.authorization.consent.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
2406. ClinicalDocument.authorization.consent.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
2408. ClinicalDocument.authorization.consent.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
2410. ClinicalDocument.authorization.consent.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
2412. ClinicalDocument.authorization.consent.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
2414. ClinicalDocument.authorization.consent.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
2416. ClinicalDocument.authorization.consent.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
2418. ClinicalDocument.authorization.consent.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
2420. ClinicalDocument.authorization.consent.classCode
Comments

This consent SHALL contain exactly one [1..1] @classCode="CONS" consent (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1198-32409).

Control1..1
BindingThe codes SHALL be taken from ActClass
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 ValueCONS
2422. ClinicalDocument.authorization.consent.moodCode
Comments

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

Control1..1
BindingThe codes SHALL be taken from ActMood
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 ValueEVN
2424. ClinicalDocument.authorization.consent.id
Comments

This consent MAY contain zero or more [0..*] id (CONF:4537-16794).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
2426. ClinicalDocument.authorization.consent.code
ShortThe type of consent (e.g., a consent to perform the related serviceEvent) is conveyed in consent/code.
Comments

This consent MAY contain zero or one [0..1] code (CONF:4537-16795).

Control0..1
BindingFor example codes, see v3 Code System ActCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
2428. ClinicalDocument.authorization.consent.statusCode
Comments

This consent SHALL contain exactly one [1..1] statusCode (CONF:1198-32411).

Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
2430. ClinicalDocument.authorization.consent.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
2432. ClinicalDocument.authorization.consent.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="completed" Completed (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:4537-16798).

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 Valuecompleted
2434. ClinicalDocument.authorization.consent.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
2436. ClinicalDocument.authorization.consent.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
2438. ClinicalDocument.authorization.consent.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
2440. ClinicalDocument.authorization.consent.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
2442. ClinicalDocument.authorization.consent.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.
2444. ClinicalDocument.authorization.consent.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.
2446. ClinicalDocument.authorization.consent.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
2448. ClinicalDocument.authorization.consent.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
2450. ClinicalDocument.authorization.consent.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
2452. ClinicalDocument.componentOf
ShortThe encompassing encounter represents the setting of the clinical encounter during which the document act(s) or ServiceEvent(s) occurred. In order to represent providers associated with a specific encounter, they are recorded within the encompassingEncounter as participants. In a CCD, the encompassingEncounter may be used when documenting a specific encounter and its participants. All relevant encounters in a CCD may be listed in the encounters section.
Comments

MAY contain zero or one [0..1] componentOf (CONF:4537-9955).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ComponentOf
2454. ClinicalDocument.componentOf.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
2456. ClinicalDocument.componentOf.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
2458. ClinicalDocument.componentOf.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
2460. ClinicalDocument.componentOf.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
2462. ClinicalDocument.componentOf.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
2464. ClinicalDocument.componentOf.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
2466. ClinicalDocument.componentOf.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
2468. ClinicalDocument.componentOf.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
2470. ClinicalDocument.componentOf.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
2472. ClinicalDocument.componentOf.typeCode
Control0..1
BindingThe codes SHALL be taken from ActRelationshipHasComponent
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 ValueCOMP
2474. ClinicalDocument.componentOf.encompassingEncounter
Comments

The componentOf, if present, SHALL contain exactly one [1..1] encompassingEncounter (CONF:4537-9956).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EncompassingEncounter
Invariantsshould-responsibleParty: SHOULD contain responsibleParty (responsibleParty.exists())
2476. ClinicalDocument.componentOf.encompassingEncounter.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
2478. ClinicalDocument.componentOf.encompassingEncounter.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
2480. ClinicalDocument.componentOf.encompassingEncounter.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
2482. ClinicalDocument.componentOf.encompassingEncounter.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
2484. ClinicalDocument.componentOf.encompassingEncounter.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
2486. ClinicalDocument.componentOf.encompassingEncounter.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
2488. ClinicalDocument.componentOf.encompassingEncounter.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
2490. ClinicalDocument.componentOf.encompassingEncounter.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
2492. ClinicalDocument.componentOf.encompassingEncounter.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
2494. ClinicalDocument.componentOf.encompassingEncounter.classCode
Control0..1
BindingThe codes SHALL be taken from ActClass
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
2496. ClinicalDocument.componentOf.encompassingEncounter.moodCode
Control0..1
BindingThe codes SHALL be taken from ActMood
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 ValueEVN
2498. ClinicalDocument.componentOf.encompassingEncounter.id
Comments

This encompassingEncounter SHALL contain at least one [1..*] id (CONF:4537-9959).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
2500. ClinicalDocument.componentOf.encompassingEncounter.code
Comments

This encompassingEncounter MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Act Encounter Codes urn:oid:2.16.840.1.113762.1.4.1240.5 (CONF:1198-30873).

Control0..1
BindingThe codes SHOULD be taken from Act Encounter Codes
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
2502. ClinicalDocument.componentOf.encompassingEncounter.effectiveTime
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

ShortBase for all types and resources
Comments

This encompassingEncounter SHALL contain exactly one [1..1] US Realm Date and Time (Interval) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:4537-9958).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS(US Realm Date and Time - Interval)
Is Modifierfalse
Invariantsivl-ts-center: Center cannot co-exist with low or high (center.empty() or (low.empty() and high.empty()))
ivl-value-shall: If a time interval contains @value, then it shall be precise to at least the day. (value.exists() implies value.toString().length() >= 10)
ivl-value-should: If a time interval contains @value, then it SHOULD contain a time component. (value.exists() implies value.toString().length() > 10)
2504. ClinicalDocument.componentOf.encompassingEncounter.sdtcAdmissionReferralSourceCode
Definition

This element is a coded concept that represents the type of referral. Its RIM source class is PatientEncounter.

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 nameadmissionReferralSourceCode.
2506. ClinicalDocument.componentOf.encompassingEncounter.dischargeDispositionCode
Control0..1
BindingFor example codes, see USEncounterDischargeDisposition
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
2508. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty
Definition

The responsibleParty participant represents the participant having primary legal responsibility for the encounter. This differs from the legalAuthenticator participant in that the legalAuthenticator may or may not be the responsible party, and is serving a medical records function by signing off on the document, moving it into a completed state.

Comments

This encompassingEncounter SHOULD contain zero or one [0..1] responsibleParty (CONF:1198-8391).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
2510. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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
2512. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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
2514. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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
2516. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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
2518. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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
2520. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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
2522. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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
2524. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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
2526. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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
2528. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeCode
Control0..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 ValueRESP
2530. ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity
Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Invariants1198-32905: This assignedEntity SHALL contain an assignedPerson or a representedOrganization or both (CONF:1198-32905). (assignedPerson.exists() or representedOrganization.exists())
2532. ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EncounterParticipant
2534. ClinicalDocument.componentOf.encompassingEncounter.location
Definition

The location participant (location class) relates a healthcare facility (HealthCareFacility class) to the encounter to indicate where the encounter took place. The entity playing the role of HealthCareFacility is a place (Place class). The entity scoping the HealthCareFacility role is an organization (Organization class).

The setting of an encounter (e.g. cardiology clinic, primary care clinic, rehabilitation hospital, skilled nursing facility) can be expressed in HealthCareFacility.code. Note that setting and physical location are not the same. There is a many-to-many relationship between setting and the physical location where care is delivered. Thus, a particular room can provide the location for cardiology clinic one day, and for primary care clinic another day; and cardiology clinic today might be held in one physical location, but in another physical location tomorrow.

When the location is an organization, this is indicated by the presence of a scoping Organization, without a playing Place.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
2536. ClinicalDocument.componentOf.encompassingEncounter.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
2538. ClinicalDocument.componentOf.encompassingEncounter.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
2540. ClinicalDocument.componentOf.encompassingEncounter.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
2542. ClinicalDocument.componentOf.encompassingEncounter.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
2544. ClinicalDocument.componentOf.encompassingEncounter.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
2546. ClinicalDocument.componentOf.encompassingEncounter.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
2548. ClinicalDocument.componentOf.encompassingEncounter.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
2550. ClinicalDocument.componentOf.encompassingEncounter.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
2552. ClinicalDocument.componentOf.encompassingEncounter.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
2554. ClinicalDocument.componentOf.encompassingEncounter.location.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationTargetLocation
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
2556. ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/HealthCareFacility
2558. ClinicalDocument.component
Comments

SHALL contain exactly one [1..1] component (CONF:1198-9585).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Component
2560. ClinicalDocument.component.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
2562. ClinicalDocument.component.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
2564. ClinicalDocument.component.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
2566. ClinicalDocument.component.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
2568. ClinicalDocument.component.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
2570. ClinicalDocument.component.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
2572. ClinicalDocument.component.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
2574. ClinicalDocument.component.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
2576. ClinicalDocument.component.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
2578. ClinicalDocument.component.typeCode
Control0..1
BindingThe codes SHALL be taken from ActRelationshipHasComponent
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 ValueCOMP
2580. ClinicalDocument.component.contextConductionInd
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.
Fixed Valuetrue
2582. ClinicalDocument.component.nonXMLBody
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/NonXMLBody
2584. ClinicalDocument.component.structuredBody
Comments

This component SHALL contain exactly one [1..1] structuredBody (CONF:1198-30485).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/StructuredBody
2586. ClinicalDocument.component.structuredBody.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
2588. ClinicalDocument.component.structuredBody.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
2590. ClinicalDocument.component.structuredBody.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
2592. ClinicalDocument.component.structuredBody.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
2594. ClinicalDocument.component.structuredBody.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
2596. ClinicalDocument.component.structuredBody.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
2598. ClinicalDocument.component.structuredBody.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
2600. ClinicalDocument.component.structuredBody.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
2602. ClinicalDocument.component.structuredBody.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
2604. ClinicalDocument.component.structuredBody.classCode
Control0..1
BindingThe codes SHALL be taken from ActClassRecordOrganizer
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 ValueDOCBODY
2606. ClinicalDocument.component.structuredBody.moodCode
Control0..1
BindingThe codes SHALL be taken from ActMood
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 ValueEVN
2608. ClinicalDocument.component.structuredBody.confidentialityCode
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
2610. ClinicalDocument.component.structuredBody.languageCode
Control0..1
BindingThe codes SHALL be taken from AllLanguages
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
2612. ClinicalDocument.component.structuredBody.component
Control8..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
SlicingThis element introduces a set of slices on ClinicalDocument.component.structuredBody.component. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ section
2614. ClinicalDocument.component.structuredBody.component.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
2616. ClinicalDocument.component.structuredBody.component.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
2618. ClinicalDocument.component.structuredBody.component.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
2620. ClinicalDocument.component.structuredBody.component.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
2622. ClinicalDocument.component.structuredBody.component.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
2624. ClinicalDocument.component.structuredBody.component.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
2626. ClinicalDocument.component.structuredBody.component.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
2628. ClinicalDocument.component.structuredBody.component.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
2630. ClinicalDocument.component.structuredBody.component.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
2632. ClinicalDocument.component.structuredBody.component.typeCode
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.
Fixed ValueCOMP
2634. ClinicalDocument.component.structuredBody.component.contextConductionInd
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.
Fixed Valuetrue
2636. ClinicalDocument.component.structuredBody.component.section
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section
2638. ClinicalDocument.component.structuredBody.component:component1
Slice Namecomponent1
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30486).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
2640. ClinicalDocument.component.structuredBody.component:component1.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
2642. ClinicalDocument.component.structuredBody.component:component1.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
2644. ClinicalDocument.component.structuredBody.component:component1.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
2646. ClinicalDocument.component.structuredBody.component:component1.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
2648. ClinicalDocument.component.structuredBody.component:component1.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
2650. ClinicalDocument.component.structuredBody.component:component1.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
2652. ClinicalDocument.component.structuredBody.component:component1.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
2654. ClinicalDocument.component.structuredBody.component:component1.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
2656. ClinicalDocument.component.structuredBody.component:component1.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
2658. ClinicalDocument.component.structuredBody.component:component1.typeCode
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.
Fixed ValueCOMP
2660. ClinicalDocument.component.structuredBody.component:component1.contextConductionInd
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.
Fixed Valuetrue
2662. ClinicalDocument.component.structuredBody.component:component1.section
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

This component SHALL contain exactly one [1..1] Anesthesia Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.25:2014-06-09) (CONF:1198-30487).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Anesthesia Section)
Is Modifierfalse
2664. ClinicalDocument.component.structuredBody.component:component2
Slice Namecomponent2
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30488) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
2666. ClinicalDocument.component.structuredBody.component:component2.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
2668. ClinicalDocument.component.structuredBody.component:component2.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
2670. ClinicalDocument.component.structuredBody.component:component2.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
2672. ClinicalDocument.component.structuredBody.component:component2.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
2674. ClinicalDocument.component.structuredBody.component:component2.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
2676. ClinicalDocument.component.structuredBody.component:component2.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
2678. ClinicalDocument.component.structuredBody.component:component2.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
2680. ClinicalDocument.component.structuredBody.component:component2.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
2682. ClinicalDocument.component.structuredBody.component:component2.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
2684. ClinicalDocument.component.structuredBody.component:component2.typeCode
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.
Fixed ValueCOMP
2686. ClinicalDocument.component.structuredBody.component:component2.contextConductionInd
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.
Fixed Valuetrue
2688. ClinicalDocument.component.structuredBody.component:component2.section
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] Complications Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.37:2024-05-01) (CONF:1198-30489).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Complications Section)
Is Modifierfalse
2690. ClinicalDocument.component.structuredBody.component:component3
Slice Namecomponent3
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30490) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
2692. ClinicalDocument.component.structuredBody.component:component3.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
2694. ClinicalDocument.component.structuredBody.component:component3.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
2696. ClinicalDocument.component.structuredBody.component:component3.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
2698. ClinicalDocument.component.structuredBody.component:component3.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
2700. ClinicalDocument.component.structuredBody.component:component3.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
2702. ClinicalDocument.component.structuredBody.component:component3.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
2704. ClinicalDocument.component.structuredBody.component:component3.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
2706. ClinicalDocument.component.structuredBody.component:component3.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
2708. ClinicalDocument.component.structuredBody.component:component3.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
2710. ClinicalDocument.component.structuredBody.component:component3.typeCode
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.
Fixed ValueCOMP
2712. ClinicalDocument.component.structuredBody.component:component3.contextConductionInd
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.
Fixed Valuetrue
2714. ClinicalDocument.component.structuredBody.component:component3.section
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] Preoperative Diagnosis Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.34:2024-05-01) (CONF:1198-30491).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Preoperative Diagnosis Section)
Is Modifierfalse
Invariantsshould-preop-dx: SHOULD contain Preoperative Diagnosis (entry.where(act.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/PreoperativeDiagnosis')))
2716. ClinicalDocument.component.structuredBody.component:component4
Slice Namecomponent4
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30492) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
2718. ClinicalDocument.component.structuredBody.component:component4.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
2720. ClinicalDocument.component.structuredBody.component:component4.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
2722. ClinicalDocument.component.structuredBody.component:component4.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
2724. ClinicalDocument.component.structuredBody.component:component4.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
2726. ClinicalDocument.component.structuredBody.component:component4.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
2728. ClinicalDocument.component.structuredBody.component:component4.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
2730. ClinicalDocument.component.structuredBody.component:component4.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
2732. ClinicalDocument.component.structuredBody.component:component4.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
2734. ClinicalDocument.component.structuredBody.component:component4.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
2736. ClinicalDocument.component.structuredBody.component:component4.typeCode
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.
Fixed ValueCOMP
2738. ClinicalDocument.component.structuredBody.component:component4.contextConductionInd
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.
Fixed Valuetrue
2740. ClinicalDocument.component.structuredBody.component:component4.section
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] Procedure Estimated Blood Loss Section (identifier: urn:oid:2.16.840.1.113883.10.20.18.2.9) (CONF:1198-30493).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Procedure Estimated Blood Loss Section)
Is Modifierfalse
2742. ClinicalDocument.component.structuredBody.component:component5
Slice Namecomponent5
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30494) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
2744. ClinicalDocument.component.structuredBody.component:component5.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
2746. ClinicalDocument.component.structuredBody.component:component5.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
2748. ClinicalDocument.component.structuredBody.component:component5.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
2750. ClinicalDocument.component.structuredBody.component:component5.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
2752. ClinicalDocument.component.structuredBody.component:component5.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
2754. ClinicalDocument.component.structuredBody.component:component5.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
2756. ClinicalDocument.component.structuredBody.component:component5.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
2758. ClinicalDocument.component.structuredBody.component:component5.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
2760. ClinicalDocument.component.structuredBody.component:component5.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
2762. ClinicalDocument.component.structuredBody.component:component5.typeCode
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.
Fixed ValueCOMP
2764. ClinicalDocument.component.structuredBody.component:component5.contextConductionInd
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.
Fixed Valuetrue
2766. ClinicalDocument.component.structuredBody.component:component5.section
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] Procedure Findings Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.28:2024-05-01) (CONF:1198-30495).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Procedure Findings Section)
Is Modifierfalse
2768. ClinicalDocument.component.structuredBody.component:component6
Slice Namecomponent6
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30496) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
2770. ClinicalDocument.component.structuredBody.component:component6.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
2772. ClinicalDocument.component.structuredBody.component:component6.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
2774. ClinicalDocument.component.structuredBody.component:component6.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
2776. ClinicalDocument.component.structuredBody.component:component6.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
2778. ClinicalDocument.component.structuredBody.component:component6.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
2780. ClinicalDocument.component.structuredBody.component:component6.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
2782. ClinicalDocument.component.structuredBody.component:component6.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
2784. ClinicalDocument.component.structuredBody.component:component6.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
2786. ClinicalDocument.component.structuredBody.component:component6.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
2788. ClinicalDocument.component.structuredBody.component:component6.typeCode
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.
Fixed ValueCOMP
2790. ClinicalDocument.component.structuredBody.component:component6.contextConductionInd
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.
Fixed Valuetrue
2792. ClinicalDocument.component.structuredBody.component:component6.section
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] Procedure Specimens Taken Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.31) (CONF:1198-30497).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Procedure Specimens Taken Section)
Is Modifierfalse
2794. ClinicalDocument.component.structuredBody.component:component7
Slice Namecomponent7
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30498) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
2796. ClinicalDocument.component.structuredBody.component:component7.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
2798. ClinicalDocument.component.structuredBody.component:component7.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
2800. ClinicalDocument.component.structuredBody.component:component7.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
2802. ClinicalDocument.component.structuredBody.component:component7.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
2804. ClinicalDocument.component.structuredBody.component:component7.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
2806. ClinicalDocument.component.structuredBody.component:component7.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
2808. ClinicalDocument.component.structuredBody.component:component7.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
2810. ClinicalDocument.component.structuredBody.component:component7.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
2812. ClinicalDocument.component.structuredBody.component:component7.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
2814. ClinicalDocument.component.structuredBody.component:component7.typeCode
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.
Fixed ValueCOMP
2816. ClinicalDocument.component.structuredBody.component:component7.contextConductionInd
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.
Fixed Valuetrue
2818. ClinicalDocument.component.structuredBody.component:component7.section
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] Procedure Description Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.27) (CONF:1198-30499).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Procedure Description Section)
Is Modifierfalse
2820. ClinicalDocument.component.structuredBody.component:component8
Slice Namecomponent8
Comments

This structuredBody SHALL contain exactly one [1..1] component (CONF:1198-30500) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
2822. ClinicalDocument.component.structuredBody.component:component8.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
2824. ClinicalDocument.component.structuredBody.component:component8.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
2826. ClinicalDocument.component.structuredBody.component:component8.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
2828. ClinicalDocument.component.structuredBody.component:component8.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
2830. ClinicalDocument.component.structuredBody.component:component8.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
2832. ClinicalDocument.component.structuredBody.component:component8.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
2834. ClinicalDocument.component.structuredBody.component:component8.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
2836. ClinicalDocument.component.structuredBody.component:component8.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
2838. ClinicalDocument.component.structuredBody.component:component8.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
2840. ClinicalDocument.component.structuredBody.component:component8.typeCode
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.
Fixed ValueCOMP
2842. ClinicalDocument.component.structuredBody.component:component8.contextConductionInd
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.
Fixed Valuetrue
2844. ClinicalDocument.component.structuredBody.component:component8.section
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] Postoperative Diagnosis Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.35) (CONF:1198-30501).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Postoperative Diagnosis Section)
Is Modifierfalse
2846. ClinicalDocument.component.structuredBody.component:component9
Slice Namecomponent9
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30502) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
2848. ClinicalDocument.component.structuredBody.component:component9.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
2850. ClinicalDocument.component.structuredBody.component:component9.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
2852. ClinicalDocument.component.structuredBody.component:component9.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
2854. ClinicalDocument.component.structuredBody.component:component9.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
2856. ClinicalDocument.component.structuredBody.component:component9.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
2858. ClinicalDocument.component.structuredBody.component:component9.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
2860. ClinicalDocument.component.structuredBody.component:component9.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
2862. ClinicalDocument.component.structuredBody.component:component9.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
2864. ClinicalDocument.component.structuredBody.component:component9.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
2866. ClinicalDocument.component.structuredBody.component:component9.typeCode
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.
Fixed ValueCOMP
2868. ClinicalDocument.component.structuredBody.component:component9.contextConductionInd
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.
Fixed Valuetrue
2870. ClinicalDocument.component.structuredBody.component:component9.section
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] Procedure Implants Section (identifier: urn:oid:2.16.840.1.113883.10.20.22.2.40) (CONF:1198-30503).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Procedure Implants Section)
Is Modifierfalse
2872. ClinicalDocument.component.structuredBody.component:component10
Slice Namecomponent10
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30504) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
2874. ClinicalDocument.component.structuredBody.component:component10.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
2876. ClinicalDocument.component.structuredBody.component:component10.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
2878. ClinicalDocument.component.structuredBody.component:component10.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
2880. ClinicalDocument.component.structuredBody.component:component10.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
2882. ClinicalDocument.component.structuredBody.component:component10.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
2884. ClinicalDocument.component.structuredBody.component:component10.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
2886. ClinicalDocument.component.structuredBody.component:component10.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
2888. ClinicalDocument.component.structuredBody.component:component10.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
2890. ClinicalDocument.component.structuredBody.component:component10.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
2892. ClinicalDocument.component.structuredBody.component:component10.typeCode
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.
Fixed ValueCOMP
2894. ClinicalDocument.component.structuredBody.component:component10.contextConductionInd
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.
Fixed Valuetrue
2896. ClinicalDocument.component.structuredBody.component:component10.section
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] Operative Note Fluids Section (identifier: urn:oid:2.16.840.1.113883.10.20.7.12) (CONF:1198-30505).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Operative Note Fluids Section)
Is Modifierfalse
2898. ClinicalDocument.component.structuredBody.component:component11
Slice Namecomponent11
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30506) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
2900. ClinicalDocument.component.structuredBody.component:component11.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
2902. ClinicalDocument.component.structuredBody.component:component11.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
2904. ClinicalDocument.component.structuredBody.component:component11.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
2906. ClinicalDocument.component.structuredBody.component:component11.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
2908. ClinicalDocument.component.structuredBody.component:component11.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
2910. ClinicalDocument.component.structuredBody.component:component11.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
2912. ClinicalDocument.component.structuredBody.component:component11.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
2914. ClinicalDocument.component.structuredBody.component:component11.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
2916. ClinicalDocument.component.structuredBody.component:component11.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
2918. ClinicalDocument.component.structuredBody.component:component11.typeCode
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.
Fixed ValueCOMP
2920. ClinicalDocument.component.structuredBody.component:component11.contextConductionInd
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.
Fixed Valuetrue
2922. ClinicalDocument.component.structuredBody.component:component11.section
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] Operative Note Surgical Procedure Section (identifier: urn:oid:2.16.840.1.113883.10.20.7.14) (CONF:1198-30507).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Operative Note Surgical Procedure Section)
Is Modifierfalse
2924. ClinicalDocument.component.structuredBody.component:component12
Slice Namecomponent12
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30508) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
2926. ClinicalDocument.component.structuredBody.component:component12.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
2928. ClinicalDocument.component.structuredBody.component:component12.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
2930. ClinicalDocument.component.structuredBody.component:component12.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
2932. ClinicalDocument.component.structuredBody.component:component12.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
2934. ClinicalDocument.component.structuredBody.component:component12.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
2936. ClinicalDocument.component.structuredBody.component:component12.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
2938. ClinicalDocument.component.structuredBody.component:component12.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
2940. ClinicalDocument.component.structuredBody.component:component12.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
2942. ClinicalDocument.component.structuredBody.component:component12.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
2944. ClinicalDocument.component.structuredBody.component:component12.typeCode
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.
Fixed ValueCOMP
2946. ClinicalDocument.component.structuredBody.component:component12.contextConductionInd
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.
Fixed Valuetrue
2948. ClinicalDocument.component.structuredBody.component:component12.section
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] Plan of Treatment Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.10:2014-06-09) (CONF:1198-30509).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Plan of Treatment Section)
Is Modifierfalse
2950. ClinicalDocument.component.structuredBody.component:component13
Slice Namecomponent13
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30510) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
2952. ClinicalDocument.component.structuredBody.component:component13.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
2954. ClinicalDocument.component.structuredBody.component:component13.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
2956. ClinicalDocument.component.structuredBody.component:component13.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
2958. ClinicalDocument.component.structuredBody.component:component13.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
2960. ClinicalDocument.component.structuredBody.component:component13.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
2962. ClinicalDocument.component.structuredBody.component:component13.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
2964. ClinicalDocument.component.structuredBody.component:component13.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
2966. ClinicalDocument.component.structuredBody.component:component13.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
2968. ClinicalDocument.component.structuredBody.component:component13.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
2970. ClinicalDocument.component.structuredBody.component:component13.typeCode
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.
Fixed ValueCOMP
2972. ClinicalDocument.component.structuredBody.component:component13.contextConductionInd
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.
Fixed Valuetrue
2974. ClinicalDocument.component.structuredBody.component:component13.section
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] Planned Procedure Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.30:2014-06-09) (CONF:1198-30511).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Planned Procedure Section)
Is Modifierfalse
2976. ClinicalDocument.component.structuredBody.component:component14
Slice Namecomponent14
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30512) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
2978. ClinicalDocument.component.structuredBody.component:component14.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
2980. ClinicalDocument.component.structuredBody.component:component14.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
2982. ClinicalDocument.component.structuredBody.component:component14.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
2984. ClinicalDocument.component.structuredBody.component:component14.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
2986. ClinicalDocument.component.structuredBody.component:component14.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
2988. ClinicalDocument.component.structuredBody.component:component14.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
2990. ClinicalDocument.component.structuredBody.component:component14.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
2992. ClinicalDocument.component.structuredBody.component:component14.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
2994. ClinicalDocument.component.structuredBody.component:component14.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
2996. ClinicalDocument.component.structuredBody.component:component14.typeCode
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.
Fixed ValueCOMP
2998. ClinicalDocument.component.structuredBody.component:component14.contextConductionInd
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.
Fixed Valuetrue
3000. ClinicalDocument.component.structuredBody.component:component14.section
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] Procedure Disposition Section (identifier: urn:oid:2.16.840.1.113883.10.20.18.2.12) (CONF:1198-30513).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Procedure Disposition Section)
Is Modifierfalse
3002. ClinicalDocument.component.structuredBody.component:component15
Slice Namecomponent15
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30514) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
3004. ClinicalDocument.component.structuredBody.component:component15.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
3006. ClinicalDocument.component.structuredBody.component:component15.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
3008. ClinicalDocument.component.structuredBody.component:component15.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
3010. ClinicalDocument.component.structuredBody.component:component15.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
3012. ClinicalDocument.component.structuredBody.component:component15.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
3014. ClinicalDocument.component.structuredBody.component:component15.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
3016. ClinicalDocument.component.structuredBody.component:component15.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
3018. ClinicalDocument.component.structuredBody.component:component15.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
3020. ClinicalDocument.component.structuredBody.component:component15.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
3022. ClinicalDocument.component.structuredBody.component:component15.typeCode
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.
Fixed ValueCOMP
3024. ClinicalDocument.component.structuredBody.component:component15.contextConductionInd
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.
Fixed Valuetrue
3026. ClinicalDocument.component.structuredBody.component:component15.section
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] Procedure Indications Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.29:2014-06-09) (CONF:1198-30515).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Procedure Indications Section)
Is Modifierfalse
3028. ClinicalDocument.component.structuredBody.component:component16
Slice Namecomponent16
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-30516) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
3030. ClinicalDocument.component.structuredBody.component:component16.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
3032. ClinicalDocument.component.structuredBody.component:component16.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
3034. ClinicalDocument.component.structuredBody.component:component16.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
3036. ClinicalDocument.component.structuredBody.component:component16.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
3038. ClinicalDocument.component.structuredBody.component:component16.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
3040. ClinicalDocument.component.structuredBody.component:component16.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
3042. ClinicalDocument.component.structuredBody.component:component16.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
3044. ClinicalDocument.component.structuredBody.component:component16.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
3046. ClinicalDocument.component.structuredBody.component:component16.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
3048. ClinicalDocument.component.structuredBody.component:component16.typeCode
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.
Fixed ValueCOMP
3050. ClinicalDocument.component.structuredBody.component:component16.contextConductionInd
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.
Fixed Valuetrue
3052. ClinicalDocument.component.structuredBody.component:component16.section
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] Surgical Drains Section (identifier: urn:oid:2.16.840.1.113883.10.20.7.13) (CONF:1198-30517).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Surgical Drains Section)
Is Modifierfalse
3054. ClinicalDocument.component.structuredBody.component:component17
Slice Namecomponent17
Comments

This structuredBody MAY contain zero or one [0..1] component (CONF:1198-28942) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
3056. ClinicalDocument.component.structuredBody.component:component17.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
3058. ClinicalDocument.component.structuredBody.component:component17.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
3060. ClinicalDocument.component.structuredBody.component:component17.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
3062. ClinicalDocument.component.structuredBody.component:component17.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
3064. ClinicalDocument.component.structuredBody.component:component17.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
3066. ClinicalDocument.component.structuredBody.component:component17.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
3068. ClinicalDocument.component.structuredBody.component:component17.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
3070. ClinicalDocument.component.structuredBody.component:component17.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
3072. ClinicalDocument.component.structuredBody.component:component17.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
3074. ClinicalDocument.component.structuredBody.component:component17.typeCode
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.
Fixed ValueCOMP
3076. ClinicalDocument.component.structuredBody.component:component17.contextConductionInd
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.
Fixed Valuetrue
3078. ClinicalDocument.component.structuredBody.component:component17.section
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] Advance Directives Section (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.2.21.1:2024-05-01).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Section(Advance Directives Section)
Is Modifierfalse
Invariantsshall-adv-directive-organizer: SHALL contain at least one Advance Directive Organizer (nullFlavor.exists() or entry.where(organizer.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/AdvanceDirectiveOrganizer')))